1 /* Display generation from window structure and buffer text.
2 Copyright (C) 1985, 86, 87, 88, 93, 94, 95, 97, 98, 99, 2000, 2001
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 Lisp_Object Vtool_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 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
493 Lisp_Object Qinhibit_menubar_update
;
494 int inhibit_menubar_update
;
496 /* Maximum height for resizing mini-windows. Either a float
497 specifying a fraction of the available height, or an integer
498 specifying a number of lines. */
500 Lisp_Object Vmax_mini_window_height
;
502 /* Non-zero means messages should be displayed with truncated
503 lines instead of being continued. */
505 int message_truncate_lines
;
506 Lisp_Object Qmessage_truncate_lines
;
508 /* Non-zero means we want a hollow cursor in windows that are not
509 selected. Zero means there's no cursor in such windows. */
511 int cursor_in_non_selected_windows
;
513 /* A scratch glyph row with contents used for generating truncation
514 glyphs. Also used in direct_output_for_insert. */
516 #define MAX_SCRATCH_GLYPHS 100
517 struct glyph_row scratch_glyph_row
;
518 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
520 /* Ascent and height of the last line processed by move_it_to. */
522 static int last_max_ascent
, last_height
;
524 /* Non-zero if there's a help-echo in the echo area. */
526 int help_echo_showing_p
;
528 /* If >= 0, computed, exact values of mode-line and header-line height
529 to use in the macros CURRENT_MODE_LINE_HEIGHT and
530 CURRENT_HEADER_LINE_HEIGHT. */
532 int current_mode_line_height
, current_header_line_height
;
534 /* The maximum distance to look ahead for text properties. Values
535 that are too small let us call compute_char_face and similar
536 functions too often which is expensive. Values that are too large
537 let us call compute_char_face and alike too often because we
538 might not be interested in text properties that far away. */
540 #define TEXT_PROP_DISTANCE_LIMIT 100
544 /* Non-zero means print traces of redisplay if compiled with
547 int trace_redisplay_p
;
549 #endif /* GLYPH_DEBUG */
551 #ifdef DEBUG_TRACE_MOVE
552 /* Non-zero means trace with TRACE_MOVE to stderr. */
555 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
557 #define TRACE_MOVE(x) (void) 0
560 /* Non-zero means automatically scroll windows horizontally to make
563 int automatic_hscrolling_p
;
565 /* A list of symbols, one for each supported image type. */
567 Lisp_Object Vimage_types
;
569 /* The variable `resize-mini-windows'. If nil, don't resize
570 mini-windows. If t, always resize them to fit the text they
571 display. If `grow-only', let mini-windows grow only until they
574 Lisp_Object Vresize_mini_windows
;
576 /* Value returned from text property handlers (see below). */
581 HANDLED_RECOMPUTE_PROPS
,
582 HANDLED_OVERLAY_STRING_CONSUMED
,
586 /* A description of text properties that redisplay is interested
591 /* The name of the property. */
594 /* A unique index for the property. */
597 /* A handler function called to set up iterator IT from the property
598 at IT's current position. Value is used to steer handle_stop. */
599 enum prop_handled (*handler
) P_ ((struct it
*it
));
602 static enum prop_handled handle_face_prop
P_ ((struct it
*));
603 static enum prop_handled handle_invisible_prop
P_ ((struct it
*));
604 static enum prop_handled handle_display_prop
P_ ((struct it
*));
605 static enum prop_handled handle_composition_prop
P_ ((struct it
*));
606 static enum prop_handled handle_overlay_change
P_ ((struct it
*));
607 static enum prop_handled handle_fontified_prop
P_ ((struct it
*));
609 /* Properties handled by iterators. */
611 static struct props it_props
[] =
613 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
614 /* Handle `face' before `display' because some sub-properties of
615 `display' need to know the face. */
616 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
617 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
618 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
619 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
623 /* Value is the position described by X. If X is a marker, value is
624 the marker_position of X. Otherwise, value is X. */
626 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
628 /* Enumeration returned by some move_it_.* functions internally. */
632 /* Not used. Undefined value. */
635 /* Move ended at the requested buffer position or ZV. */
636 MOVE_POS_MATCH_OR_ZV
,
638 /* Move ended at the requested X pixel position. */
641 /* Move within a line ended at the end of a line that must be
645 /* Move within a line ended at the end of a line that would
646 be displayed truncated. */
649 /* Move within a line ended at a line end. */
655 /* Function prototypes. */
657 static int cursor_row_p
P_ ((struct window
*, struct glyph_row
*));
658 static int redisplay_mode_lines
P_ ((Lisp_Object
, int));
659 static char *decode_mode_spec_coding
P_ ((Lisp_Object
, char *, int));
660 static int invisible_text_between_p
P_ ((struct it
*, int, int));
661 static int next_element_from_ellipsis
P_ ((struct it
*));
662 static void pint2str
P_ ((char *, int, int));
663 static struct text_pos run_window_scroll_functions
P_ ((Lisp_Object
,
665 static void reconsider_clip_changes
P_ ((struct window
*, struct buffer
*));
666 static int text_outside_line_unchanged_p
P_ ((struct window
*, int, int));
667 static void store_frame_title_char
P_ ((char));
668 static int store_frame_title
P_ ((unsigned char *, int, int));
669 static void x_consider_frame_title
P_ ((Lisp_Object
));
670 static void handle_stop
P_ ((struct it
*));
671 static int tool_bar_lines_needed
P_ ((struct frame
*));
672 static int single_display_prop_intangible_p
P_ ((Lisp_Object
));
673 static void ensure_echo_area_buffers
P_ ((void));
674 static struct glyph_row
*row_containing_pos
P_ ((struct window
*, int,
676 struct glyph_row
*));
677 static Lisp_Object unwind_with_echo_area_buffer
P_ ((Lisp_Object
));
678 static Lisp_Object with_echo_area_buffer_unwind_data
P_ ((struct window
*));
679 static int with_echo_area_buffer
P_ ((struct window
*, int,
680 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
681 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
682 static void clear_garbaged_frames
P_ ((void));
683 static int current_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
684 static int truncate_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
685 static int set_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
686 static int display_echo_area
P_ ((struct window
*));
687 static int display_echo_area_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
688 static int resize_mini_window_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
689 static Lisp_Object unwind_redisplay
P_ ((Lisp_Object
));
690 static int string_char_and_length
P_ ((unsigned char *, int, int *));
691 static struct text_pos display_prop_end
P_ ((struct it
*, Lisp_Object
,
693 static int compute_window_start_on_continuation_line
P_ ((struct window
*));
694 static Lisp_Object safe_eval_handler
P_ ((Lisp_Object
));
695 static void insert_left_trunc_glyphs
P_ ((struct it
*));
696 static struct glyph_row
*get_overlay_arrow_glyph_row
P_ ((struct window
*));
697 static void extend_face_to_end_of_line
P_ ((struct it
*));
698 static int append_space
P_ ((struct it
*, int));
699 static void make_cursor_line_fully_visible
P_ ((struct window
*));
700 static int try_scrolling
P_ ((Lisp_Object
, int, int, int, int));
701 static int try_cursor_movement
P_ ((Lisp_Object
, struct text_pos
, int *));
702 static int trailing_whitespace_p
P_ ((int));
703 static int message_log_check_duplicate
P_ ((int, int, int, int));
704 int invisible_p
P_ ((Lisp_Object
, Lisp_Object
));
705 int invisible_ellipsis_p
P_ ((Lisp_Object
, Lisp_Object
));
706 static void push_it
P_ ((struct it
*));
707 static void pop_it
P_ ((struct it
*));
708 static void sync_frame_with_window_matrix_rows
P_ ((struct window
*));
709 static void redisplay_internal
P_ ((int));
710 static int echo_area_display
P_ ((int));
711 static void redisplay_windows
P_ ((Lisp_Object
));
712 static void redisplay_window
P_ ((Lisp_Object
, int));
713 static void update_menu_bar
P_ ((struct frame
*, int));
714 static int try_window_reusing_current_matrix
P_ ((struct window
*));
715 static int try_window_id
P_ ((struct window
*));
716 static int display_line
P_ ((struct it
*));
717 static int display_mode_lines
P_ ((struct window
*));
718 static int display_mode_line
P_ ((struct window
*, enum face_id
, Lisp_Object
));
719 static int display_mode_element
P_ ((struct it
*, int, int, int, Lisp_Object
));
720 static char *decode_mode_spec
P_ ((struct window
*, int, int, int));
721 static void display_menu_bar
P_ ((struct window
*));
722 static int display_count_lines
P_ ((int, int, int, int, int *));
723 static int display_string
P_ ((unsigned char *, Lisp_Object
, Lisp_Object
,
724 int, int, struct it
*, int, int, int, int));
725 static void compute_line_metrics
P_ ((struct it
*));
726 static void run_redisplay_end_trigger_hook
P_ ((struct it
*));
727 static int get_overlay_strings
P_ ((struct it
*));
728 static void next_overlay_string
P_ ((struct it
*));
729 static void reseat
P_ ((struct it
*, struct text_pos
, int));
730 static void reseat_1
P_ ((struct it
*, struct text_pos
, int));
731 static void back_to_previous_visible_line_start
P_ ((struct it
*));
732 static void reseat_at_previous_visible_line_start
P_ ((struct it
*));
733 static void reseat_at_next_visible_line_start
P_ ((struct it
*, int));
734 static int next_element_from_display_vector
P_ ((struct it
*));
735 static int next_element_from_string
P_ ((struct it
*));
736 static int next_element_from_c_string
P_ ((struct it
*));
737 static int next_element_from_buffer
P_ ((struct it
*));
738 static int next_element_from_composition
P_ ((struct it
*));
739 static int next_element_from_image
P_ ((struct it
*));
740 static int next_element_from_stretch
P_ ((struct it
*));
741 static void load_overlay_strings
P_ ((struct it
*));
742 static void init_from_display_pos
P_ ((struct it
*, struct window
*,
743 struct display_pos
*));
744 static void reseat_to_string
P_ ((struct it
*, unsigned char *,
745 Lisp_Object
, int, int, int, int));
746 static enum move_it_result move_it_in_display_line_to
P_ ((struct it
*,
748 void move_it_vertically_backward
P_ ((struct it
*, int));
749 static void init_to_row_start
P_ ((struct it
*, struct window
*,
750 struct glyph_row
*));
751 static void init_to_row_end
P_ ((struct it
*, struct window
*,
752 struct glyph_row
*));
753 static void back_to_previous_line_start
P_ ((struct it
*));
754 static int forward_to_next_line_start
P_ ((struct it
*, int *));
755 static struct text_pos string_pos_nchars_ahead
P_ ((struct text_pos
,
757 static struct text_pos string_pos
P_ ((int, Lisp_Object
));
758 static struct text_pos c_string_pos
P_ ((int, unsigned char *, int));
759 static int number_of_chars
P_ ((unsigned char *, int));
760 static void compute_stop_pos
P_ ((struct it
*));
761 static void compute_string_pos
P_ ((struct text_pos
*, struct text_pos
,
763 static int face_before_or_after_it_pos
P_ ((struct it
*, int));
764 static int next_overlay_change
P_ ((int));
765 static int handle_single_display_prop
P_ ((struct it
*, Lisp_Object
,
766 Lisp_Object
, struct text_pos
*,
768 static int underlying_face_id
P_ ((struct it
*));
770 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
771 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
773 #ifdef HAVE_WINDOW_SYSTEM
775 static void update_tool_bar
P_ ((struct frame
*, int));
776 static void build_desired_tool_bar_string
P_ ((struct frame
*f
));
777 static int redisplay_tool_bar
P_ ((struct frame
*));
778 static void display_tool_bar_line
P_ ((struct it
*));
780 #endif /* HAVE_WINDOW_SYSTEM */
783 /***********************************************************************
784 Window display dimensions
785 ***********************************************************************/
787 /* Return the window-relative maximum y + 1 for glyph rows displaying
788 text in window W. This is the height of W minus the height of a
789 mode line, if any. */
792 window_text_bottom_y (w
)
795 struct frame
*f
= XFRAME (w
->frame
);
796 int height
= XFASTINT (w
->height
) * CANON_Y_UNIT (f
);
798 if (WINDOW_WANTS_MODELINE_P (w
))
799 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
804 /* Return the pixel width of display area AREA of window W. AREA < 0
805 means return the total width of W, not including bitmap areas to
806 the left and right of the window. */
809 window_box_width (w
, area
)
813 struct frame
*f
= XFRAME (w
->frame
);
814 int width
= XFASTINT (w
->width
);
816 if (!w
->pseudo_window_p
)
818 width
-= FRAME_SCROLL_BAR_WIDTH (f
) + FRAME_FLAGS_AREA_COLS (f
);
820 if (area
== TEXT_AREA
)
822 if (INTEGERP (w
->left_margin_width
))
823 width
-= XFASTINT (w
->left_margin_width
);
824 if (INTEGERP (w
->right_margin_width
))
825 width
-= XFASTINT (w
->right_margin_width
);
827 else if (area
== LEFT_MARGIN_AREA
)
828 width
= (INTEGERP (w
->left_margin_width
)
829 ? XFASTINT (w
->left_margin_width
) : 0);
830 else if (area
== RIGHT_MARGIN_AREA
)
831 width
= (INTEGERP (w
->right_margin_width
)
832 ? XFASTINT (w
->right_margin_width
) : 0);
835 return width
* CANON_X_UNIT (f
);
839 /* Return the pixel height of the display area of window W, not
840 including mode lines of W, if any.. */
843 window_box_height (w
)
846 struct frame
*f
= XFRAME (w
->frame
);
847 int height
= XFASTINT (w
->height
) * CANON_Y_UNIT (f
);
849 xassert (height
>= 0);
851 /* Note: the code below that determines the mode-line/header-line
852 height is essentially the same as that contained in the macro
853 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
854 the appropriate glyph row has its `mode_line_p' flag set,
855 and if it doesn't, uses estimate_mode_line_height instead. */
857 if (WINDOW_WANTS_MODELINE_P (w
))
859 struct glyph_row
*ml_row
860 = (w
->current_matrix
&& w
->current_matrix
->rows
861 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
863 if (ml_row
&& ml_row
->mode_line_p
)
864 height
-= ml_row
->height
;
866 height
-= estimate_mode_line_height (f
, MODE_LINE_FACE_ID
);
869 if (WINDOW_WANTS_HEADER_LINE_P (w
))
871 struct glyph_row
*hl_row
872 = (w
->current_matrix
&& w
->current_matrix
->rows
873 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
875 if (hl_row
&& hl_row
->mode_line_p
)
876 height
-= hl_row
->height
;
878 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
885 /* Return the frame-relative coordinate of the left edge of display
886 area AREA of window W. AREA < 0 means return the left edge of the
887 whole window, to the right of any bitmap area at the left side of
891 window_box_left (w
, area
)
895 struct frame
*f
= XFRAME (w
->frame
);
896 int x
= FRAME_INTERNAL_BORDER_WIDTH_SAFE (f
);
898 if (!w
->pseudo_window_p
)
900 x
+= (WINDOW_LEFT_MARGIN (w
) * CANON_X_UNIT (f
)
901 + FRAME_LEFT_FLAGS_AREA_WIDTH (f
));
903 if (area
== TEXT_AREA
)
904 x
+= window_box_width (w
, LEFT_MARGIN_AREA
);
905 else if (area
== RIGHT_MARGIN_AREA
)
906 x
+= (window_box_width (w
, LEFT_MARGIN_AREA
)
907 + window_box_width (w
, TEXT_AREA
));
914 /* Return the frame-relative coordinate of the right edge of display
915 area AREA of window W. AREA < 0 means return the left edge of the
916 whole window, to the left of any bitmap area at the right side of
920 window_box_right (w
, area
)
924 return window_box_left (w
, area
) + window_box_width (w
, area
);
928 /* Get the bounding box of the display area AREA of window W, without
929 mode lines, in frame-relative coordinates. AREA < 0 means the
930 whole window, not including bitmap areas to the left and right of
931 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
932 coordinates of the upper-left corner of the box. Return in
933 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
936 window_box (w
, area
, box_x
, box_y
, box_width
, box_height
)
939 int *box_x
, *box_y
, *box_width
, *box_height
;
941 struct frame
*f
= XFRAME (w
->frame
);
943 *box_width
= window_box_width (w
, area
);
944 *box_height
= window_box_height (w
);
945 *box_x
= window_box_left (w
, area
);
946 *box_y
= (FRAME_INTERNAL_BORDER_WIDTH_SAFE (f
)
947 + XFASTINT (w
->top
) * CANON_Y_UNIT (f
));
948 if (WINDOW_WANTS_HEADER_LINE_P (w
))
949 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
953 /* Get the bounding box of the display area AREA of window W, without
954 mode lines. AREA < 0 means the whole window, not including bitmap
955 areas to the left and right of the window. Return in *TOP_LEFT_X
956 and TOP_LEFT_Y the frame-relative pixel coordinates of the
957 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
958 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
962 window_box_edges (w
, area
, top_left_x
, top_left_y
,
963 bottom_right_x
, bottom_right_y
)
966 int *top_left_x
, *top_left_y
, *bottom_right_x
, *bottom_right_y
;
968 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
970 *bottom_right_x
+= *top_left_x
;
971 *bottom_right_y
+= *top_left_y
;
976 /***********************************************************************
978 ***********************************************************************/
980 /* Return the bottom y-position of the line the iterator IT is in.
981 This can modify IT's settings. */
987 int line_height
= it
->max_ascent
+ it
->max_descent
;
988 int line_top_y
= it
->current_y
;
990 if (line_height
== 0)
993 line_height
= last_height
;
994 else if (IT_CHARPOS (*it
) < ZV
)
996 move_it_by_lines (it
, 1, 1);
997 line_height
= (it
->max_ascent
|| it
->max_descent
998 ? it
->max_ascent
+ it
->max_descent
1003 struct glyph_row
*row
= it
->glyph_row
;
1005 /* Use the default character height. */
1006 it
->glyph_row
= NULL
;
1007 it
->what
= IT_CHARACTER
;
1010 PRODUCE_GLYPHS (it
);
1011 line_height
= it
->ascent
+ it
->descent
;
1012 it
->glyph_row
= row
;
1016 return line_top_y
+ line_height
;
1020 /* Return 1 if position CHARPOS is visible in window W. Set *FULLY to
1021 1 if POS is visible and the line containing POS is fully visible.
1022 EXACT_MODE_LINE_HEIGHTS_P non-zero means compute exact mode-line
1023 and header-lines heights. */
1026 pos_visible_p (w
, charpos
, fully
, exact_mode_line_heights_p
)
1028 int charpos
, *fully
, exact_mode_line_heights_p
;
1031 struct text_pos top
;
1033 struct buffer
*old_buffer
= NULL
;
1035 if (XBUFFER (w
->buffer
) != current_buffer
)
1037 old_buffer
= current_buffer
;
1038 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1041 *fully
= visible_p
= 0;
1042 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1044 /* Compute exact mode line heights, if requested. */
1045 if (exact_mode_line_heights_p
)
1047 if (WINDOW_WANTS_MODELINE_P (w
))
1048 current_mode_line_height
1049 = display_mode_line (w
, MODE_LINE_FACE_ID
,
1050 current_buffer
->mode_line_format
);
1052 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1053 current_header_line_height
1054 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1055 current_buffer
->header_line_format
);
1058 start_display (&it
, w
, top
);
1059 move_it_to (&it
, charpos
, 0, it
.last_visible_y
, -1,
1060 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
1062 /* Note that we may overshoot because of invisible text. */
1063 if (IT_CHARPOS (it
) >= charpos
)
1065 int top_y
= it
.current_y
;
1066 int bottom_y
= line_bottom_y (&it
);
1067 int window_top_y
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
);
1069 if (top_y
< window_top_y
)
1070 visible_p
= bottom_y
> window_top_y
;
1071 else if (top_y
< it
.last_visible_y
)
1074 *fully
= bottom_y
<= it
.last_visible_y
;
1077 else if (it
.current_y
+ it
.max_ascent
+ it
.max_descent
> it
.last_visible_y
)
1079 move_it_by_lines (&it
, 1, 0);
1080 if (charpos
< IT_CHARPOS (it
))
1088 set_buffer_internal_1 (old_buffer
);
1090 current_header_line_height
= current_mode_line_height
= -1;
1095 /* Return the next character from STR which is MAXLEN bytes long.
1096 Return in *LEN the length of the character. This is like
1097 STRING_CHAR_AND_LENGTH but never returns an invalid character. If
1098 we find one, we return a `?', but with the length of the invalid
1102 string_char_and_length (str
, maxlen
, len
)
1108 c
= STRING_CHAR_AND_LENGTH (str
, maxlen
, *len
);
1109 if (!CHAR_VALID_P (c
, 1))
1110 /* We may not change the length here because other places in Emacs
1111 don't use this function, i.e. they silently accept invalid
1120 /* Given a position POS containing a valid character and byte position
1121 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1123 static struct text_pos
1124 string_pos_nchars_ahead (pos
, string
, nchars
)
1125 struct text_pos pos
;
1129 xassert (STRINGP (string
) && nchars
>= 0);
1131 if (STRING_MULTIBYTE (string
))
1133 int rest
= STRING_BYTES (XSTRING (string
)) - BYTEPOS (pos
);
1134 unsigned char *p
= XSTRING (string
)->data
+ BYTEPOS (pos
);
1139 string_char_and_length (p
, rest
, &len
);
1140 p
+= len
, rest
-= len
;
1141 xassert (rest
>= 0);
1143 BYTEPOS (pos
) += len
;
1147 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1153 /* Value is the text position, i.e. character and byte position,
1154 for character position CHARPOS in STRING. */
1156 static INLINE
struct text_pos
1157 string_pos (charpos
, string
)
1161 struct text_pos pos
;
1162 xassert (STRINGP (string
));
1163 xassert (charpos
>= 0);
1164 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1169 /* Value is a text position, i.e. character and byte position, for
1170 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1171 means recognize multibyte characters. */
1173 static struct text_pos
1174 c_string_pos (charpos
, s
, multibyte_p
)
1179 struct text_pos pos
;
1181 xassert (s
!= NULL
);
1182 xassert (charpos
>= 0);
1186 int rest
= strlen (s
), len
;
1188 SET_TEXT_POS (pos
, 0, 0);
1191 string_char_and_length (s
, rest
, &len
);
1192 s
+= len
, rest
-= len
;
1193 xassert (rest
>= 0);
1195 BYTEPOS (pos
) += len
;
1199 SET_TEXT_POS (pos
, charpos
, charpos
);
1205 /* Value is the number of characters in C string S. MULTIBYTE_P
1206 non-zero means recognize multibyte characters. */
1209 number_of_chars (s
, multibyte_p
)
1217 int rest
= strlen (s
), len
;
1218 unsigned char *p
= (unsigned char *) s
;
1220 for (nchars
= 0; rest
> 0; ++nchars
)
1222 string_char_and_length (p
, rest
, &len
);
1223 rest
-= len
, p
+= len
;
1227 nchars
= strlen (s
);
1233 /* Compute byte position NEWPOS->bytepos corresponding to
1234 NEWPOS->charpos. POS is a known position in string STRING.
1235 NEWPOS->charpos must be >= POS.charpos. */
1238 compute_string_pos (newpos
, pos
, string
)
1239 struct text_pos
*newpos
, pos
;
1242 xassert (STRINGP (string
));
1243 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1245 if (STRING_MULTIBYTE (string
))
1246 *newpos
= string_pos_nchars_ahead (pos
, string
,
1247 CHARPOS (*newpos
) - CHARPOS (pos
));
1249 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1254 /***********************************************************************
1255 Lisp form evaluation
1256 ***********************************************************************/
1258 /* Error handler for safe_eval and safe_call. */
1261 safe_eval_handler (arg
)
1264 add_to_log ("Error during redisplay: %s", arg
, Qnil
);
1269 /* Evaluate SEXPR and return the result, or nil if something went
1276 int count
= BINDING_STACK_SIZE ();
1277 struct gcpro gcpro1
;
1281 specbind (Qinhibit_redisplay
, Qt
);
1282 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
, safe_eval_handler
);
1284 return unbind_to (count
, val
);
1288 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
1289 Return the result, or nil if something went wrong. */
1292 safe_call (nargs
, args
)
1296 int count
= BINDING_STACK_SIZE ();
1298 struct gcpro gcpro1
;
1301 gcpro1
.nvars
= nargs
;
1302 specbind (Qinhibit_redisplay
, Qt
);
1303 val
= internal_condition_case_2 (Ffuncall
, nargs
, args
, Qerror
,
1306 return unbind_to (count
, val
);
1310 /* Call function FN with one argument ARG.
1311 Return the result, or nil if something went wrong. */
1314 safe_call1 (fn
, arg
)
1315 Lisp_Object fn
, arg
;
1317 Lisp_Object args
[2];
1320 return safe_call (2, args
);
1325 /***********************************************************************
1327 ***********************************************************************/
1331 /* Define CHECK_IT to perform sanity checks on iterators.
1332 This is for debugging. It is too slow to do unconditionally. */
1338 if (it
->method
== next_element_from_string
)
1340 xassert (STRINGP (it
->string
));
1341 xassert (IT_STRING_CHARPOS (*it
) >= 0);
1343 else if (it
->method
== next_element_from_buffer
)
1345 /* Check that character and byte positions agree. */
1346 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
1350 xassert (it
->current
.dpvec_index
>= 0);
1352 xassert (it
->current
.dpvec_index
< 0);
1355 #define CHECK_IT(IT) check_it ((IT))
1359 #define CHECK_IT(IT) (void) 0
1366 /* Check that the window end of window W is what we expect it
1367 to be---the last row in the current matrix displaying text. */
1370 check_window_end (w
)
1373 if (!MINI_WINDOW_P (w
)
1374 && !NILP (w
->window_end_valid
))
1376 struct glyph_row
*row
;
1377 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
1378 XFASTINT (w
->window_end_vpos
)),
1380 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
1381 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
1385 #define CHECK_WINDOW_END(W) check_window_end ((W))
1387 #else /* not GLYPH_DEBUG */
1389 #define CHECK_WINDOW_END(W) (void) 0
1391 #endif /* not GLYPH_DEBUG */
1395 /***********************************************************************
1396 Iterator initialization
1397 ***********************************************************************/
1399 /* Initialize IT for displaying current_buffer in window W, starting
1400 at character position CHARPOS. CHARPOS < 0 means that no buffer
1401 position is specified which is useful when the iterator is assigned
1402 a position later. BYTEPOS is the byte position corresponding to
1403 CHARPOS. BYTEPOS <= 0 means compute it from CHARPOS.
1405 If ROW is not null, calls to produce_glyphs with IT as parameter
1406 will produce glyphs in that row.
1408 BASE_FACE_ID is the id of a base face to use. It must be one of
1409 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID or
1410 HEADER_LINE_FACE_ID for displaying mode lines, or TOOL_BAR_FACE_ID for
1411 displaying the tool-bar.
1413 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID or
1414 HEADER_LINE_FACE_ID, the iterator will be initialized to use the
1415 corresponding mode line glyph row of the desired matrix of W. */
1418 init_iterator (it
, w
, charpos
, bytepos
, row
, base_face_id
)
1421 int charpos
, bytepos
;
1422 struct glyph_row
*row
;
1423 enum face_id base_face_id
;
1425 int highlight_region_p
;
1427 /* Some precondition checks. */
1428 xassert (w
!= NULL
&& it
!= NULL
);
1429 xassert (charpos
< 0 || (charpos
> 0 && charpos
<= ZV
));
1431 /* If face attributes have been changed since the last redisplay,
1432 free realized faces now because they depend on face definitions
1433 that might have changed. */
1434 if (face_change_count
)
1436 face_change_count
= 0;
1437 free_all_realized_faces (Qnil
);
1440 /* Use one of the mode line rows of W's desired matrix if
1444 if (base_face_id
== MODE_LINE_FACE_ID
)
1445 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
1446 else if (base_face_id
== HEADER_LINE_FACE_ID
)
1447 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
1451 bzero (it
, sizeof *it
);
1452 it
->current
.overlay_string_index
= -1;
1453 it
->current
.dpvec_index
= -1;
1454 it
->base_face_id
= base_face_id
;
1456 /* The window in which we iterate over current_buffer: */
1457 XSETWINDOW (it
->window
, w
);
1459 it
->f
= XFRAME (w
->frame
);
1461 /* Extra space between lines (on window systems only). */
1462 if (base_face_id
== DEFAULT_FACE_ID
1463 && FRAME_WINDOW_P (it
->f
))
1465 if (NATNUMP (current_buffer
->extra_line_spacing
))
1466 it
->extra_line_spacing
= XFASTINT (current_buffer
->extra_line_spacing
);
1467 else if (it
->f
->extra_line_spacing
> 0)
1468 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
1471 /* If realized faces have been removed, e.g. because of face
1472 attribute changes of named faces, recompute them. When running
1473 in batch mode, the face cache of Vterminal_frame is null. If
1474 we happen to get called, make a dummy face cache. */
1479 FRAME_FACE_CACHE (it
->f
) == NULL
)
1480 init_frame_faces (it
->f
);
1481 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
1482 recompute_basic_faces (it
->f
);
1484 /* Current value of the `space-width', and 'height' properties. */
1485 it
->space_width
= Qnil
;
1486 it
->font_height
= Qnil
;
1488 /* Are control characters displayed as `^C'? */
1489 it
->ctl_arrow_p
= !NILP (current_buffer
->ctl_arrow
);
1491 /* -1 means everything between a CR and the following line end
1492 is invisible. >0 means lines indented more than this value are
1494 it
->selective
= (INTEGERP (current_buffer
->selective_display
)
1495 ? XFASTINT (current_buffer
->selective_display
)
1496 : (!NILP (current_buffer
->selective_display
)
1498 it
->selective_display_ellipsis_p
1499 = !NILP (current_buffer
->selective_display_ellipses
);
1501 /* Display table to use. */
1502 it
->dp
= window_display_table (w
);
1504 /* Are multibyte characters enabled in current_buffer? */
1505 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
1507 /* Non-zero if we should highlight the region. */
1509 = (!NILP (Vtransient_mark_mode
)
1510 && !NILP (current_buffer
->mark_active
)
1511 && XMARKER (current_buffer
->mark
)->buffer
!= 0);
1513 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
1514 start and end of a visible region in window IT->w. Set both to
1515 -1 to indicate no region. */
1516 if (highlight_region_p
1517 /* Maybe highlight only in selected window. */
1518 && (/* Either show region everywhere. */
1519 highlight_nonselected_windows
1520 /* Or show region in the selected window. */
1521 || w
== XWINDOW (selected_window
)
1522 /* Or show the region if we are in the mini-buffer and W is
1523 the window the mini-buffer refers to. */
1524 || (MINI_WINDOW_P (XWINDOW (selected_window
))
1525 && w
== XWINDOW (Vminibuf_scroll_window
))))
1527 int charpos
= marker_position (current_buffer
->mark
);
1528 it
->region_beg_charpos
= min (PT
, charpos
);
1529 it
->region_end_charpos
= max (PT
, charpos
);
1532 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
1534 /* Get the position at which the redisplay_end_trigger hook should
1535 be run, if it is to be run at all. */
1536 if (MARKERP (w
->redisplay_end_trigger
)
1537 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
1538 it
->redisplay_end_trigger_charpos
1539 = marker_position (w
->redisplay_end_trigger
);
1540 else if (INTEGERP (w
->redisplay_end_trigger
))
1541 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
1543 /* Correct bogus values of tab_width. */
1544 it
->tab_width
= XINT (current_buffer
->tab_width
);
1545 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
1548 /* Are lines in the display truncated? */
1549 it
->truncate_lines_p
1550 = (base_face_id
!= DEFAULT_FACE_ID
1551 || XINT (it
->w
->hscroll
)
1552 || (truncate_partial_width_windows
1553 && !WINDOW_FULL_WIDTH_P (it
->w
))
1554 || !NILP (current_buffer
->truncate_lines
));
1556 /* Get dimensions of truncation and continuation glyphs. These are
1557 displayed as bitmaps under X, so we don't need them for such
1559 if (!FRAME_WINDOW_P (it
->f
))
1561 if (it
->truncate_lines_p
)
1563 /* We will need the truncation glyph. */
1564 xassert (it
->glyph_row
== NULL
);
1565 produce_special_glyphs (it
, IT_TRUNCATION
);
1566 it
->truncation_pixel_width
= it
->pixel_width
;
1570 /* We will need the continuation glyph. */
1571 xassert (it
->glyph_row
== NULL
);
1572 produce_special_glyphs (it
, IT_CONTINUATION
);
1573 it
->continuation_pixel_width
= it
->pixel_width
;
1576 /* Reset these values to zero becaue the produce_special_glyphs
1577 above has changed them. */
1578 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
1579 it
->phys_ascent
= it
->phys_descent
= 0;
1582 /* Set this after getting the dimensions of truncation and
1583 continuation glyphs, so that we don't produce glyphs when calling
1584 produce_special_glyphs, above. */
1585 it
->glyph_row
= row
;
1586 it
->area
= TEXT_AREA
;
1588 /* Get the dimensions of the display area. The display area
1589 consists of the visible window area plus a horizontally scrolled
1590 part to the left of the window. All x-values are relative to the
1591 start of this total display area. */
1592 if (base_face_id
!= DEFAULT_FACE_ID
)
1594 /* Mode lines, menu bar in terminal frames. */
1595 it
->first_visible_x
= 0;
1596 it
->last_visible_x
= XFASTINT (w
->width
) * CANON_X_UNIT (it
->f
);
1601 = XFASTINT (it
->w
->hscroll
) * CANON_X_UNIT (it
->f
);
1602 it
->last_visible_x
= (it
->first_visible_x
1603 + window_box_width (w
, TEXT_AREA
));
1605 /* If we truncate lines, leave room for the truncator glyph(s) at
1606 the right margin. Otherwise, leave room for the continuation
1607 glyph(s). Truncation and continuation glyphs are not inserted
1608 for window-based redisplay. */
1609 if (!FRAME_WINDOW_P (it
->f
))
1611 if (it
->truncate_lines_p
)
1612 it
->last_visible_x
-= it
->truncation_pixel_width
;
1614 it
->last_visible_x
-= it
->continuation_pixel_width
;
1617 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
1618 it
->current_y
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
1621 /* Leave room for a border glyph. */
1622 if (!FRAME_WINDOW_P (it
->f
)
1623 && !WINDOW_RIGHTMOST_P (it
->w
))
1624 it
->last_visible_x
-= 1;
1626 it
->last_visible_y
= window_text_bottom_y (w
);
1628 /* For mode lines and alike, arrange for the first glyph having a
1629 left box line if the face specifies a box. */
1630 if (base_face_id
!= DEFAULT_FACE_ID
)
1634 it
->face_id
= base_face_id
;
1636 /* If we have a boxed mode line, make the first character appear
1637 with a left box line. */
1638 face
= FACE_FROM_ID (it
->f
, base_face_id
);
1639 if (face
->box
!= FACE_NO_BOX
)
1640 it
->start_of_box_run_p
= 1;
1643 /* If a buffer position was specified, set the iterator there,
1644 getting overlays and face properties from that position. */
1647 it
->end_charpos
= ZV
;
1649 IT_CHARPOS (*it
) = charpos
;
1651 /* Compute byte position if not specified. */
1653 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
1655 IT_BYTEPOS (*it
) = bytepos
;
1657 /* Compute faces etc. */
1658 reseat (it
, it
->current
.pos
, 1);
1665 /* Initialize IT for the display of window W with window start POS. */
1668 start_display (it
, w
, pos
)
1671 struct text_pos pos
;
1673 int start_at_line_beg_p
;
1674 struct glyph_row
*row
;
1675 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
1678 row
= w
->desired_matrix
->rows
+ first_vpos
;
1679 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
1680 first_y
= it
->current_y
;
1682 /* If window start is not at a line start, move back to the line
1683 start. This makes sure that we take continuation lines into
1685 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
1686 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
1687 if (!start_at_line_beg_p
)
1688 reseat_at_previous_visible_line_start (it
);
1690 /* If window start is not at a line start, skip forward to POS to
1691 get the correct continuation_lines_width and current_x. */
1692 if (!start_at_line_beg_p
)
1694 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
1696 /* If lines are continued, this line may end in the middle of a
1697 multi-glyph character (e.g. a control character displayed as
1698 \003, or in the middle of an overlay string). In this case
1699 move_it_to above will not have taken us to the start of
1700 the continuation line but to the end of the continued line. */
1701 if (!it
->truncate_lines_p
)
1703 if (it
->current_x
> 0)
1705 if (it
->current
.dpvec_index
>= 0
1706 || it
->current
.overlay_string_index
>= 0)
1708 set_iterator_to_next (it
, 1);
1709 move_it_in_display_line_to (it
, -1, -1, 0);
1712 it
->continuation_lines_width
+= it
->current_x
;
1715 /* We're starting a new display line, not affected by the
1716 height of the continued line, so clear the appropriate
1717 fields in the iterator structure. */
1718 it
->max_ascent
= it
->max_descent
= 0;
1719 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
1722 it
->current_y
= first_y
;
1724 it
->current_x
= it
->hpos
= 0;
1727 #if 0 /* Don't assert the following because start_display is sometimes
1728 called intentionally with a window start that is not at a
1729 line start. Please leave this code in as a comment. */
1731 /* Window start should be on a line start, now. */
1732 xassert (it
->continuation_lines_width
1733 || IT_CHARPOS (it
) == BEGV
1734 || FETCH_BYTE (IT_BYTEPOS (it
) - 1) == '\n');
1739 /* Initialize IT for stepping through current_buffer in window W,
1740 starting at position POS that includes overlay string and display
1741 vector/ control character translation position information. */
1744 init_from_display_pos (it
, w
, pos
)
1747 struct display_pos
*pos
;
1749 /* Keep in mind: the call to reseat in init_iterator skips invisible
1750 text, so we might end up at a position different from POS. This
1751 is only a problem when POS is a row start after a newline and an
1752 overlay starts there with an after-string, and the overlay has an
1753 invisible property. Since we don't skip invisible text in
1754 display_line and elsewhere immediately after consuming the
1755 newline before the row start, such a POS will not be in a string,
1756 but the call to init_iterator below will move us to the
1758 init_iterator (it
, w
, CHARPOS (pos
->pos
), BYTEPOS (pos
->pos
),
1759 NULL
, DEFAULT_FACE_ID
);
1761 /* If position is within an overlay string, set up IT to
1762 the right overlay string. */
1763 if (pos
->overlay_string_index
>= 0)
1767 /* We already have the first chunk of overlay strings in
1768 IT->overlay_strings. Load more until the one for
1769 pos->overlay_string_index is in IT->overlay_strings. */
1770 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
1772 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
1773 it
->current
.overlay_string_index
= 0;
1776 load_overlay_strings (it
);
1777 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
1781 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
1782 relative_index
= (it
->current
.overlay_string_index
1783 % OVERLAY_STRING_CHUNK_SIZE
);
1784 it
->string
= it
->overlay_strings
[relative_index
];
1785 xassert (STRINGP (it
->string
));
1786 it
->current
.string_pos
= pos
->string_pos
;
1787 it
->method
= next_element_from_string
;
1789 else if (it
->current
.overlay_string_index
>= 0)
1791 /* If POS says we're already after an overlay string ending at
1792 POS, make sure to pop the iterator because it will be in
1793 front of that overlay string. When POS is ZV, we've thereby
1794 also ``processed'' overlay strings at ZV. */
1797 it
->current
.overlay_string_index
= -1;
1798 it
->method
= next_element_from_buffer
;
1799 if (CHARPOS (pos
->pos
) == ZV
)
1800 it
->overlay_strings_at_end_processed_p
= 1;
1803 if (CHARPOS (pos
->string_pos
) >= 0)
1805 /* Recorded position is not in an overlay string, but in another
1806 string. This can only be a string from a `display' property.
1807 IT should already be filled with that string. */
1808 it
->current
.string_pos
= pos
->string_pos
;
1809 xassert (STRINGP (it
->string
));
1812 /* Restore position in display vector translations or control
1813 character translations. */
1814 if (pos
->dpvec_index
>= 0)
1816 /* This fills IT->dpvec. */
1817 get_next_display_element (it
);
1818 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
1819 it
->current
.dpvec_index
= pos
->dpvec_index
;
1826 /* Initialize IT for stepping through current_buffer in window W
1827 starting at ROW->start. */
1830 init_to_row_start (it
, w
, row
)
1833 struct glyph_row
*row
;
1835 init_from_display_pos (it
, w
, &row
->start
);
1836 it
->continuation_lines_width
= row
->continuation_lines_width
;
1841 /* Initialize IT for stepping through current_buffer in window W
1842 starting in the line following ROW, i.e. starting at ROW->end. */
1845 init_to_row_end (it
, w
, row
)
1848 struct glyph_row
*row
;
1850 init_from_display_pos (it
, w
, &row
->end
);
1852 if (row
->continued_p
)
1853 it
->continuation_lines_width
= (row
->continuation_lines_width
1854 + row
->pixel_width
);
1861 /***********************************************************************
1863 ***********************************************************************/
1865 /* Called when IT reaches IT->stop_charpos. Handle text property and
1866 overlay changes. Set IT->stop_charpos to the next position where
1873 enum prop_handled handled
;
1874 int handle_overlay_change_p
= 1;
1878 it
->current
.dpvec_index
= -1;
1882 handled
= HANDLED_NORMALLY
;
1884 /* Call text property handlers. */
1885 for (p
= it_props
; p
->handler
; ++p
)
1887 handled
= p
->handler (it
);
1889 if (handled
== HANDLED_RECOMPUTE_PROPS
)
1891 else if (handled
== HANDLED_RETURN
)
1893 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
1894 handle_overlay_change_p
= 0;
1897 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
1899 /* Don't check for overlay strings below when set to deliver
1900 characters from a display vector. */
1901 if (it
->method
== next_element_from_display_vector
)
1902 handle_overlay_change_p
= 0;
1904 /* Handle overlay changes. */
1905 if (handle_overlay_change_p
)
1906 handled
= handle_overlay_change (it
);
1908 /* Determine where to stop next. */
1909 if (handled
== HANDLED_NORMALLY
)
1910 compute_stop_pos (it
);
1913 while (handled
== HANDLED_RECOMPUTE_PROPS
);
1917 /* Compute IT->stop_charpos from text property and overlay change
1918 information for IT's current position. */
1921 compute_stop_pos (it
)
1924 register INTERVAL iv
, next_iv
;
1925 Lisp_Object object
, limit
, position
;
1927 /* If nowhere else, stop at the end. */
1928 it
->stop_charpos
= it
->end_charpos
;
1930 if (STRINGP (it
->string
))
1932 /* Strings are usually short, so don't limit the search for
1934 object
= it
->string
;
1936 XSETFASTINT (position
, IT_STRING_CHARPOS (*it
));
1942 /* If next overlay change is in front of the current stop pos
1943 (which is IT->end_charpos), stop there. Note: value of
1944 next_overlay_change is point-max if no overlay change
1946 charpos
= next_overlay_change (IT_CHARPOS (*it
));
1947 if (charpos
< it
->stop_charpos
)
1948 it
->stop_charpos
= charpos
;
1950 /* If showing the region, we have to stop at the region
1951 start or end because the face might change there. */
1952 if (it
->region_beg_charpos
> 0)
1954 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
1955 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
1956 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
1957 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
1960 /* Set up variables for computing the stop position from text
1961 property changes. */
1962 XSETBUFFER (object
, current_buffer
);
1963 XSETFASTINT (limit
, IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
1964 XSETFASTINT (position
, IT_CHARPOS (*it
));
1968 /* Get the interval containing IT's position. Value is a null
1969 interval if there isn't such an interval. */
1970 iv
= validate_interval_range (object
, &position
, &position
, 0);
1971 if (!NULL_INTERVAL_P (iv
))
1973 Lisp_Object values_here
[LAST_PROP_IDX
];
1976 /* Get properties here. */
1977 for (p
= it_props
; p
->handler
; ++p
)
1978 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
1980 /* Look for an interval following iv that has different
1982 for (next_iv
= next_interval (iv
);
1983 (!NULL_INTERVAL_P (next_iv
)
1985 || XFASTINT (limit
) > next_iv
->position
));
1986 next_iv
= next_interval (next_iv
))
1988 for (p
= it_props
; p
->handler
; ++p
)
1990 Lisp_Object new_value
;
1992 new_value
= textget (next_iv
->plist
, *p
->name
);
1993 if (!EQ (values_here
[p
->idx
], new_value
))
2001 if (!NULL_INTERVAL_P (next_iv
))
2003 if (INTEGERP (limit
)
2004 && next_iv
->position
>= XFASTINT (limit
))
2005 /* No text property change up to limit. */
2006 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
2008 /* Text properties change in next_iv. */
2009 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
2013 xassert (STRINGP (it
->string
)
2014 || (it
->stop_charpos
>= BEGV
2015 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
2019 /* Return the position of the next overlay change after POS in
2020 current_buffer. Value is point-max if no overlay change
2021 follows. This is like `next-overlay-change' but doesn't use
2025 next_overlay_change (pos
)
2030 Lisp_Object
*overlays
;
2034 /* Get all overlays at the given position. */
2036 overlays
= (Lisp_Object
*) alloca (len
* sizeof *overlays
);
2037 noverlays
= overlays_at (pos
, 0, &overlays
, &len
, &endpos
, NULL
, 1);
2038 if (noverlays
> len
)
2041 overlays
= (Lisp_Object
*) alloca (len
* sizeof *overlays
);
2042 noverlays
= overlays_at (pos
, 0, &overlays
, &len
, &endpos
, NULL
, 1);
2045 /* If any of these overlays ends before endpos,
2046 use its ending point instead. */
2047 for (i
= 0; i
< noverlays
; ++i
)
2052 oend
= OVERLAY_END (overlays
[i
]);
2053 oendpos
= OVERLAY_POSITION (oend
);
2054 endpos
= min (endpos
, oendpos
);
2062 /***********************************************************************
2064 ***********************************************************************/
2066 /* Handle changes in the `fontified' property of the current buffer by
2067 calling hook functions from Qfontification_functions to fontify
2070 static enum prop_handled
2071 handle_fontified_prop (it
)
2074 Lisp_Object prop
, pos
;
2075 enum prop_handled handled
= HANDLED_NORMALLY
;
2077 /* Get the value of the `fontified' property at IT's current buffer
2078 position. (The `fontified' property doesn't have a special
2079 meaning in strings.) If the value is nil, call functions from
2080 Qfontification_functions. */
2081 if (!STRINGP (it
->string
)
2083 && !NILP (Vfontification_functions
)
2084 && !NILP (Vrun_hooks
)
2085 && (pos
= make_number (IT_CHARPOS (*it
)),
2086 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
2089 int count
= BINDING_STACK_SIZE ();
2092 val
= Vfontification_functions
;
2093 specbind (Qfontification_functions
, Qnil
);
2094 specbind (Qafter_change_functions
, Qnil
);
2096 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
2097 safe_call1 (val
, pos
);
2100 Lisp_Object globals
, fn
;
2101 struct gcpro gcpro1
, gcpro2
;
2104 GCPRO2 (val
, globals
);
2106 for (; CONSP (val
); val
= XCDR (val
))
2112 /* A value of t indicates this hook has a local
2113 binding; it means to run the global binding too.
2114 In a global value, t should not occur. If it
2115 does, we must ignore it to avoid an endless
2117 for (globals
= Fdefault_value (Qfontification_functions
);
2119 globals
= XCDR (globals
))
2121 fn
= XCAR (globals
);
2123 safe_call1 (fn
, pos
);
2127 safe_call1 (fn
, pos
);
2133 unbind_to (count
, Qnil
);
2135 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
2136 something. This avoids an endless loop if they failed to
2137 fontify the text for which reason ever. */
2138 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
2139 handled
= HANDLED_RECOMPUTE_PROPS
;
2147 /***********************************************************************
2149 ***********************************************************************/
2151 /* Set up iterator IT from face properties at its current position.
2152 Called from handle_stop. */
2154 static enum prop_handled
2155 handle_face_prop (it
)
2158 int new_face_id
, next_stop
;
2160 if (!STRINGP (it
->string
))
2163 = face_at_buffer_position (it
->w
,
2165 it
->region_beg_charpos
,
2166 it
->region_end_charpos
,
2169 + TEXT_PROP_DISTANCE_LIMIT
),
2172 /* Is this a start of a run of characters with box face?
2173 Caveat: this can be called for a freshly initialized
2174 iterator; face_id is -1 is this case. We know that the new
2175 face will not change until limit, i.e. if the new face has a
2176 box, all characters up to limit will have one. But, as
2177 usual, we don't know whether limit is really the end. */
2178 if (new_face_id
!= it
->face_id
)
2180 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
2182 /* If new face has a box but old face has not, this is
2183 the start of a run of characters with box, i.e. it has
2184 a shadow on the left side. The value of face_id of the
2185 iterator will be -1 if this is the initial call that gets
2186 the face. In this case, we have to look in front of IT's
2187 position and see whether there is a face != new_face_id. */
2188 it
->start_of_box_run_p
2189 = (new_face
->box
!= FACE_NO_BOX
2190 && (it
->face_id
>= 0
2191 || IT_CHARPOS (*it
) == BEG
2192 || new_face_id
!= face_before_it_pos (it
)));
2193 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
2198 int base_face_id
, bufpos
;
2200 if (it
->current
.overlay_string_index
>= 0)
2201 bufpos
= IT_CHARPOS (*it
);
2205 /* For strings from a buffer, i.e. overlay strings or strings
2206 from a `display' property, use the face at IT's current
2207 buffer position as the base face to merge with, so that
2208 overlay strings appear in the same face as surrounding
2209 text, unless they specify their own faces. */
2210 base_face_id
= underlying_face_id (it
);
2212 new_face_id
= face_at_string_position (it
->w
,
2214 IT_STRING_CHARPOS (*it
),
2216 it
->region_beg_charpos
,
2217 it
->region_end_charpos
,
2221 #if 0 /* This shouldn't be neccessary. Let's check it. */
2222 /* If IT is used to display a mode line we would really like to
2223 use the mode line face instead of the frame's default face. */
2224 if (it
->glyph_row
== MATRIX_MODE_LINE_ROW (it
->w
->desired_matrix
)
2225 && new_face_id
== DEFAULT_FACE_ID
)
2226 new_face_id
= MODE_LINE_FACE_ID
;
2229 /* Is this a start of a run of characters with box? Caveat:
2230 this can be called for a freshly allocated iterator; face_id
2231 is -1 is this case. We know that the new face will not
2232 change until the next check pos, i.e. if the new face has a
2233 box, all characters up to that position will have a
2234 box. But, as usual, we don't know whether that position
2235 is really the end. */
2236 if (new_face_id
!= it
->face_id
)
2238 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
2239 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
2241 /* If new face has a box but old face hasn't, this is the
2242 start of a run of characters with box, i.e. it has a
2243 shadow on the left side. */
2244 it
->start_of_box_run_p
2245 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
2246 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
2250 it
->face_id
= new_face_id
;
2251 return HANDLED_NORMALLY
;
2255 /* Return the ID of the face ``underlying'' IT's current position,
2256 which is in a string. If the iterator is associated with a
2257 buffer, return the face at IT's current buffer position.
2258 Otherwise, use the iterator's base_face_id. */
2261 underlying_face_id (it
)
2264 int face_id
= it
->base_face_id
, i
;
2266 xassert (STRINGP (it
->string
));
2268 for (i
= it
->sp
- 1; i
>= 0; --i
)
2269 if (NILP (it
->stack
[i
].string
))
2270 face_id
= it
->stack
[i
].face_id
;
2276 /* Compute the face one character before or after the current position
2277 of IT. BEFORE_P non-zero means get the face in front of IT's
2278 position. Value is the id of the face. */
2281 face_before_or_after_it_pos (it
, before_p
)
2286 int next_check_charpos
;
2287 struct text_pos pos
;
2289 xassert (it
->s
== NULL
);
2291 if (STRINGP (it
->string
))
2293 int bufpos
, base_face_id
;
2295 /* No face change past the end of the string (for the case
2296 we are padding with spaces). No face change before the
2298 if (IT_STRING_CHARPOS (*it
) >= XSTRING (it
->string
)->size
2299 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
2302 /* Set pos to the position before or after IT's current position. */
2304 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
2306 /* For composition, we must check the character after the
2308 pos
= (it
->what
== IT_COMPOSITION
2309 ? string_pos (IT_STRING_CHARPOS (*it
) + it
->cmp_len
, it
->string
)
2310 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
2312 if (it
->current
.overlay_string_index
>= 0)
2313 bufpos
= IT_CHARPOS (*it
);
2317 base_face_id
= underlying_face_id (it
);
2319 /* Get the face for ASCII, or unibyte. */
2320 face_id
= face_at_string_position (it
->w
,
2324 it
->region_beg_charpos
,
2325 it
->region_end_charpos
,
2326 &next_check_charpos
,
2329 /* Correct the face for charsets different from ASCII. Do it
2330 for the multibyte case only. The face returned above is
2331 suitable for unibyte text if IT->string is unibyte. */
2332 if (STRING_MULTIBYTE (it
->string
))
2334 unsigned char *p
= XSTRING (it
->string
)->data
+ BYTEPOS (pos
);
2335 int rest
= STRING_BYTES (XSTRING (it
->string
)) - BYTEPOS (pos
);
2337 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
2339 c
= string_char_and_length (p
, rest
, &len
);
2340 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
);
2345 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
2346 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
2349 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
2350 pos
= it
->current
.pos
;
2353 DEC_TEXT_POS (pos
, it
->multibyte_p
);
2356 if (it
->what
== IT_COMPOSITION
)
2357 /* For composition, we must check the position after the
2359 pos
.charpos
+= it
->cmp_len
, pos
.bytepos
+= it
->len
;
2361 INC_TEXT_POS (pos
, it
->multibyte_p
);
2364 /* Determine face for CHARSET_ASCII, or unibyte. */
2365 face_id
= face_at_buffer_position (it
->w
,
2367 it
->region_beg_charpos
,
2368 it
->region_end_charpos
,
2369 &next_check_charpos
,
2372 /* Correct the face for charsets different from ASCII. Do it
2373 for the multibyte case only. The face returned above is
2374 suitable for unibyte text if current_buffer is unibyte. */
2375 if (it
->multibyte_p
)
2377 int c
= FETCH_MULTIBYTE_CHAR (CHARPOS (pos
));
2378 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
2379 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
);
2388 /***********************************************************************
2390 ***********************************************************************/
2392 /* Set up iterator IT from invisible properties at its current
2393 position. Called from handle_stop. */
2395 static enum prop_handled
2396 handle_invisible_prop (it
)
2399 enum prop_handled handled
= HANDLED_NORMALLY
;
2401 if (STRINGP (it
->string
))
2403 extern Lisp_Object Qinvisible
;
2404 Lisp_Object prop
, end_charpos
, limit
, charpos
;
2406 /* Get the value of the invisible text property at the
2407 current position. Value will be nil if there is no such
2409 XSETFASTINT (charpos
, IT_STRING_CHARPOS (*it
));
2410 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
2413 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
2415 handled
= HANDLED_RECOMPUTE_PROPS
;
2417 /* Get the position at which the next change of the
2418 invisible text property can be found in IT->string.
2419 Value will be nil if the property value is the same for
2420 all the rest of IT->string. */
2421 XSETINT (limit
, XSTRING (it
->string
)->size
);
2422 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
2425 /* Text at current position is invisible. The next
2426 change in the property is at position end_charpos.
2427 Move IT's current position to that position. */
2428 if (INTEGERP (end_charpos
)
2429 && XFASTINT (end_charpos
) < XFASTINT (limit
))
2431 struct text_pos old
;
2432 old
= it
->current
.string_pos
;
2433 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
2434 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
2438 /* The rest of the string is invisible. If this is an
2439 overlay string, proceed with the next overlay string
2440 or whatever comes and return a character from there. */
2441 if (it
->current
.overlay_string_index
>= 0)
2443 next_overlay_string (it
);
2444 /* Don't check for overlay strings when we just
2445 finished processing them. */
2446 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
2450 struct Lisp_String
*s
= XSTRING (it
->string
);
2451 IT_STRING_CHARPOS (*it
) = s
->size
;
2452 IT_STRING_BYTEPOS (*it
) = STRING_BYTES (s
);
2459 int visible_p
, newpos
, next_stop
;
2460 Lisp_Object pos
, prop
;
2462 /* First of all, is there invisible text at this position? */
2463 XSETFASTINT (pos
, IT_CHARPOS (*it
));
2464 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
2466 /* If we are on invisible text, skip over it. */
2467 if (TEXT_PROP_MEANS_INVISIBLE (prop
)
2468 && IT_CHARPOS (*it
) < it
->end_charpos
)
2470 /* Record whether we have to display an ellipsis for the
2472 int display_ellipsis_p
2473 = TEXT_PROP_MEANS_INVISIBLE_WITH_ELLIPSIS (prop
);
2475 handled
= HANDLED_RECOMPUTE_PROPS
;
2477 /* Loop skipping over invisible text. The loop is left at
2478 ZV or with IT on the first char being visible again. */
2481 /* Try to skip some invisible text. Return value is the
2482 position reached which can be equal to IT's position
2483 if there is nothing invisible here. This skips both
2484 over invisible text properties and overlays with
2485 invisible property. */
2486 newpos
= skip_invisible (IT_CHARPOS (*it
),
2487 &next_stop
, ZV
, it
->window
);
2489 /* If we skipped nothing at all we weren't at invisible
2490 text in the first place. If everything to the end of
2491 the buffer was skipped, end the loop. */
2492 if (newpos
== IT_CHARPOS (*it
) || newpos
>= ZV
)
2496 /* We skipped some characters but not necessarily
2497 all there are. Check if we ended up on visible
2498 text. Fget_char_property returns the property of
2499 the char before the given position, i.e. if we
2500 get visible_p = 1, this means that the char at
2501 newpos is visible. */
2502 XSETFASTINT (pos
, newpos
);
2503 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
2504 visible_p
= !TEXT_PROP_MEANS_INVISIBLE (prop
);
2507 /* If we ended up on invisible text, proceed to
2508 skip starting with next_stop. */
2510 IT_CHARPOS (*it
) = next_stop
;
2514 /* The position newpos is now either ZV or on visible text. */
2515 IT_CHARPOS (*it
) = newpos
;
2516 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
2518 /* Maybe return `...' next for the end of the invisible text. */
2519 if (display_ellipsis_p
)
2522 && VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
2524 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
2525 it
->dpvec
= v
->contents
;
2526 it
->dpend
= v
->contents
+ v
->size
;
2530 /* Default `...'. */
2531 it
->dpvec
= default_invis_vector
;
2532 it
->dpend
= default_invis_vector
+ 3;
2535 /* The ellipsis display does not replace the display of
2536 the character at the new position. Indicate this by
2537 setting IT->dpvec_char_len to zero. */
2538 it
->dpvec_char_len
= 0;
2540 it
->current
.dpvec_index
= 0;
2541 it
->method
= next_element_from_display_vector
;
2551 /***********************************************************************
2553 ***********************************************************************/
2555 /* Set up iterator IT from `display' property at its current position.
2556 Called from handle_stop. */
2558 static enum prop_handled
2559 handle_display_prop (it
)
2562 Lisp_Object prop
, object
;
2563 struct text_pos
*position
;
2564 int display_replaced_p
= 0;
2566 if (STRINGP (it
->string
))
2568 object
= it
->string
;
2569 position
= &it
->current
.string_pos
;
2573 object
= it
->w
->buffer
;
2574 position
= &it
->current
.pos
;
2577 /* Reset those iterator values set from display property values. */
2578 it
->font_height
= Qnil
;
2579 it
->space_width
= Qnil
;
2582 /* We don't support recursive `display' properties, i.e. string
2583 values that have a string `display' property, that have a string
2584 `display' property etc. */
2585 if (!it
->string_from_display_prop_p
)
2586 it
->area
= TEXT_AREA
;
2588 prop
= Fget_char_property (make_number (position
->charpos
),
2591 return HANDLED_NORMALLY
;
2594 && CONSP (XCAR (prop
))
2595 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
2597 /* A list of sub-properties. */
2598 for (; CONSP (prop
); prop
= XCDR (prop
))
2600 if (handle_single_display_prop (it
, XCAR (prop
), object
,
2601 position
, display_replaced_p
))
2602 display_replaced_p
= 1;
2605 else if (VECTORP (prop
))
2608 for (i
= 0; i
< ASIZE (prop
); ++i
)
2609 if (handle_single_display_prop (it
, AREF (prop
, i
), object
,
2610 position
, display_replaced_p
))
2611 display_replaced_p
= 1;
2615 if (handle_single_display_prop (it
, prop
, object
, position
, 0))
2616 display_replaced_p
= 1;
2619 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
2623 /* Value is the position of the end of the `display' property starting
2624 at START_POS in OBJECT. */
2626 static struct text_pos
2627 display_prop_end (it
, object
, start_pos
)
2630 struct text_pos start_pos
;
2633 struct text_pos end_pos
;
2635 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
2636 Qdisplay
, object
, Qnil
);
2637 CHARPOS (end_pos
) = XFASTINT (end
);
2638 if (STRINGP (object
))
2639 compute_string_pos (&end_pos
, start_pos
, it
->string
);
2641 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
2647 /* Set up IT from a single `display' sub-property value PROP. OBJECT
2648 is the object in which the `display' property was found. *POSITION
2649 is the position at which it was found. DISPLAY_REPLACED_P non-zero
2650 means that we previously saw a display sub-property which already
2651 replaced text display with something else, for example an image;
2652 ignore such properties after the first one has been processed.
2654 If PROP is a `space' or `image' sub-property, set *POSITION to the
2655 end position of the `display' property.
2657 Value is non-zero something was found which replaces the display
2658 of buffer or string text. */
2661 handle_single_display_prop (it
, prop
, object
, position
,
2662 display_replaced_before_p
)
2666 struct text_pos
*position
;
2667 int display_replaced_before_p
;
2670 int replaces_text_display_p
= 0;
2673 /* If PROP is a list of the form `(when FORM . VALUE)', FORM is
2674 evaluated. If the result is nil, VALUE is ignored. */
2676 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
2685 if (!NILP (form
) && !EQ (form
, Qt
))
2687 struct gcpro gcpro1
;
2688 struct text_pos end_pos
, pt
;
2691 end_pos
= display_prop_end (it
, object
, *position
);
2693 /* Temporarily set point to the end position, and then evaluate
2694 the form. This makes `(eolp)' work as FORM. */
2695 if (BUFFERP (object
))
2698 BYTEPOS (pt
) = PT_BYTE
;
2699 TEMP_SET_PT_BOTH (CHARPOS (end_pos
), BYTEPOS (end_pos
));
2702 form
= safe_eval (form
);
2704 if (BUFFERP (object
))
2705 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
2713 && EQ (XCAR (prop
), Qheight
)
2714 && CONSP (XCDR (prop
)))
2716 if (FRAME_TERMCAP_P (it
->f
) || FRAME_MSDOS_P (it
->f
))
2719 /* `(height HEIGHT)'. */
2720 it
->font_height
= XCAR (XCDR (prop
));
2721 if (!NILP (it
->font_height
))
2723 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
2724 int new_height
= -1;
2726 if (CONSP (it
->font_height
)
2727 && (EQ (XCAR (it
->font_height
), Qplus
)
2728 || EQ (XCAR (it
->font_height
), Qminus
))
2729 && CONSP (XCDR (it
->font_height
))
2730 && INTEGERP (XCAR (XCDR (it
->font_height
))))
2732 /* `(+ N)' or `(- N)' where N is an integer. */
2733 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
2734 if (EQ (XCAR (it
->font_height
), Qplus
))
2736 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
2738 else if (FUNCTIONP (it
->font_height
))
2740 /* Call function with current height as argument.
2741 Value is the new height. */
2743 height
= safe_call1 (it
->font_height
,
2744 face
->lface
[LFACE_HEIGHT_INDEX
]);
2745 if (NUMBERP (height
))
2746 new_height
= XFLOATINT (height
);
2748 else if (NUMBERP (it
->font_height
))
2750 /* Value is a multiple of the canonical char height. */
2753 face
= FACE_FROM_ID (it
->f
, DEFAULT_FACE_ID
);
2754 new_height
= (XFLOATINT (it
->font_height
)
2755 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
2759 /* Evaluate IT->font_height with `height' bound to the
2760 current specified height to get the new height. */
2762 int count
= BINDING_STACK_SIZE ();
2764 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
2765 value
= safe_eval (it
->font_height
);
2766 unbind_to (count
, Qnil
);
2768 if (NUMBERP (value
))
2769 new_height
= XFLOATINT (value
);
2773 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
2776 else if (CONSP (prop
)
2777 && EQ (XCAR (prop
), Qspace_width
)
2778 && CONSP (XCDR (prop
)))
2780 /* `(space_width WIDTH)'. */
2781 if (FRAME_TERMCAP_P (it
->f
) || FRAME_MSDOS_P (it
->f
))
2784 value
= XCAR (XCDR (prop
));
2785 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
2786 it
->space_width
= value
;
2788 else if (CONSP (prop
)
2789 && EQ (XCAR (prop
), Qraise
)
2790 && CONSP (XCDR (prop
)))
2792 /* `(raise FACTOR)'. */
2793 if (FRAME_TERMCAP_P (it
->f
) || FRAME_MSDOS_P (it
->f
))
2796 #ifdef HAVE_WINDOW_SYSTEM
2797 value
= XCAR (XCDR (prop
));
2798 if (NUMBERP (value
))
2800 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
2801 it
->voffset
= - (XFLOATINT (value
)
2802 * (FONT_HEIGHT (face
->font
)));
2804 #endif /* HAVE_WINDOW_SYSTEM */
2806 else if (!it
->string_from_display_prop_p
)
2808 /* `((margin left-margin) VALUE)' or `((margin right-margin)
2809 VALUE) or `((margin nil) VALUE)' or VALUE. */
2810 Lisp_Object location
, value
;
2811 struct text_pos start_pos
;
2814 /* Characters having this form of property are not displayed, so
2815 we have to find the end of the property. */
2816 start_pos
= *position
;
2817 *position
= display_prop_end (it
, object
, start_pos
);
2820 /* Let's stop at the new position and assume that all
2821 text properties change there. */
2822 it
->stop_charpos
= position
->charpos
;
2824 location
= Qunbound
;
2825 if (CONSP (prop
) && CONSP (XCAR (prop
)))
2829 value
= XCDR (prop
);
2831 value
= XCAR (value
);
2834 if (EQ (XCAR (tem
), Qmargin
)
2835 && (tem
= XCDR (tem
),
2836 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
2838 || EQ (tem
, Qleft_margin
)
2839 || EQ (tem
, Qright_margin
))))
2843 if (EQ (location
, Qunbound
))
2849 #ifdef HAVE_WINDOW_SYSTEM
2850 if (FRAME_TERMCAP_P (it
->f
))
2851 valid_p
= STRINGP (value
);
2853 valid_p
= (STRINGP (value
)
2854 || (CONSP (value
) && EQ (XCAR (value
), Qspace
))
2855 || valid_image_p (value
));
2856 #else /* not HAVE_WINDOW_SYSTEM */
2857 valid_p
= STRINGP (value
);
2858 #endif /* not HAVE_WINDOW_SYSTEM */
2860 if ((EQ (location
, Qleft_margin
)
2861 || EQ (location
, Qright_margin
)
2864 && !display_replaced_before_p
)
2866 replaces_text_display_p
= 1;
2868 /* Save current settings of IT so that we can restore them
2869 when we are finished with the glyph property value. */
2872 if (NILP (location
))
2873 it
->area
= TEXT_AREA
;
2874 else if (EQ (location
, Qleft_margin
))
2875 it
->area
= LEFT_MARGIN_AREA
;
2877 it
->area
= RIGHT_MARGIN_AREA
;
2879 if (STRINGP (value
))
2882 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
2883 it
->current
.overlay_string_index
= -1;
2884 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
2885 it
->end_charpos
= it
->string_nchars
2886 = XSTRING (it
->string
)->size
;
2887 it
->method
= next_element_from_string
;
2888 it
->stop_charpos
= 0;
2889 it
->string_from_display_prop_p
= 1;
2890 /* Say that we haven't consumed the characters with
2891 `display' property yet. The call to pop_it in
2892 set_iterator_to_next will clean this up. */
2893 *position
= start_pos
;
2895 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
2897 it
->method
= next_element_from_stretch
;
2899 it
->current
.pos
= it
->position
= start_pos
;
2901 #ifdef HAVE_WINDOW_SYSTEM
2904 it
->what
= IT_IMAGE
;
2905 it
->image_id
= lookup_image (it
->f
, value
);
2906 it
->position
= start_pos
;
2907 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
2908 it
->method
= next_element_from_image
;
2910 /* Say that we haven't consumed the characters with
2911 `display' property yet. The call to pop_it in
2912 set_iterator_to_next will clean this up. */
2913 *position
= start_pos
;
2915 #endif /* HAVE_WINDOW_SYSTEM */
2918 /* Invalid property or property not supported. Restore
2919 the position to what it was before. */
2920 *position
= start_pos
;
2923 return replaces_text_display_p
;
2927 /* Check if PROP is a display sub-property value whose text should be
2928 treated as intangible. */
2931 single_display_prop_intangible_p (prop
)
2934 /* Skip over `when FORM'. */
2935 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
2946 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
2947 we don't need to treat text as intangible. */
2948 if (EQ (XCAR (prop
), Qmargin
))
2956 || EQ (XCAR (prop
), Qleft_margin
)
2957 || EQ (XCAR (prop
), Qright_margin
))
2961 return CONSP (prop
) && EQ (XCAR (prop
), Qimage
);
2965 /* Check if PROP is a display property value whose text should be
2966 treated as intangible. */
2969 display_prop_intangible_p (prop
)
2973 && CONSP (XCAR (prop
))
2974 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
2976 /* A list of sub-properties. */
2977 while (CONSP (prop
))
2979 if (single_display_prop_intangible_p (XCAR (prop
)))
2984 else if (VECTORP (prop
))
2986 /* A vector of sub-properties. */
2988 for (i
= 0; i
< ASIZE (prop
); ++i
)
2989 if (single_display_prop_intangible_p (AREF (prop
, i
)))
2993 return single_display_prop_intangible_p (prop
);
2999 /***********************************************************************
3000 `composition' property
3001 ***********************************************************************/
3003 /* Set up iterator IT from `composition' property at its current
3004 position. Called from handle_stop. */
3006 static enum prop_handled
3007 handle_composition_prop (it
)
3010 Lisp_Object prop
, string
;
3011 int pos
, pos_byte
, end
;
3012 enum prop_handled handled
= HANDLED_NORMALLY
;
3014 if (STRINGP (it
->string
))
3016 pos
= IT_STRING_CHARPOS (*it
);
3017 pos_byte
= IT_STRING_BYTEPOS (*it
);
3018 string
= it
->string
;
3022 pos
= IT_CHARPOS (*it
);
3023 pos_byte
= IT_BYTEPOS (*it
);
3027 /* If there's a valid composition and point is not inside of the
3028 composition (in the case that the composition is from the current
3029 buffer), draw a glyph composed from the composition components. */
3030 if (find_composition (pos
, -1, &pos
, &end
, &prop
, string
)
3031 && COMPOSITION_VALID_P (pos
, end
, prop
)
3032 && (STRINGP (it
->string
) || (PT
<= pos
|| PT
>= end
)))
3034 int id
= get_composition_id (pos
, pos_byte
, end
- pos
, prop
, string
);
3038 it
->method
= next_element_from_composition
;
3040 it
->cmp_len
= COMPOSITION_LENGTH (prop
);
3041 /* For a terminal, draw only the first character of the
3043 it
->c
= COMPOSITION_GLYPH (composition_table
[id
], 0);
3044 it
->len
= (STRINGP (it
->string
)
3045 ? string_char_to_byte (it
->string
, end
)
3046 : CHAR_TO_BYTE (end
)) - pos_byte
;
3047 it
->stop_charpos
= end
;
3048 handled
= HANDLED_RETURN
;
3057 /***********************************************************************
3059 ***********************************************************************/
3061 /* The following structure is used to record overlay strings for
3062 later sorting in load_overlay_strings. */
3064 struct overlay_entry
3066 Lisp_Object overlay
;
3073 /* Set up iterator IT from overlay strings at its current position.
3074 Called from handle_stop. */
3076 static enum prop_handled
3077 handle_overlay_change (it
)
3080 if (!STRINGP (it
->string
) && get_overlay_strings (it
))
3081 return HANDLED_RECOMPUTE_PROPS
;
3083 return HANDLED_NORMALLY
;
3087 /* Set up the next overlay string for delivery by IT, if there is an
3088 overlay string to deliver. Called by set_iterator_to_next when the
3089 end of the current overlay string is reached. If there are more
3090 overlay strings to display, IT->string and
3091 IT->current.overlay_string_index are set appropriately here.
3092 Otherwise IT->string is set to nil. */
3095 next_overlay_string (it
)
3098 ++it
->current
.overlay_string_index
;
3099 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
3101 /* No more overlay strings. Restore IT's settings to what
3102 they were before overlay strings were processed, and
3103 continue to deliver from current_buffer. */
3105 xassert (it
->stop_charpos
>= BEGV
3106 && it
->stop_charpos
<= it
->end_charpos
);
3108 it
->current
.overlay_string_index
= -1;
3109 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
3110 it
->n_overlay_strings
= 0;
3111 it
->method
= next_element_from_buffer
;
3113 /* If we're at the end of the buffer, record that we have
3114 processed the overlay strings there already, so that
3115 next_element_from_buffer doesn't try it again. */
3116 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
3117 it
->overlay_strings_at_end_processed_p
= 1;
3121 /* There are more overlay strings to process. If
3122 IT->current.overlay_string_index has advanced to a position
3123 where we must load IT->overlay_strings with more strings, do
3125 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
3127 if (it
->current
.overlay_string_index
&& i
== 0)
3128 load_overlay_strings (it
);
3130 /* Initialize IT to deliver display elements from the overlay
3132 it
->string
= it
->overlay_strings
[i
];
3133 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
3134 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
3135 it
->method
= next_element_from_string
;
3136 it
->stop_charpos
= 0;
3143 /* Compare two overlay_entry structures E1 and E2. Used as a
3144 comparison function for qsort in load_overlay_strings. Overlay
3145 strings for the same position are sorted so that
3147 1. All after-strings come in front of before-strings, except
3148 when they come from the same overlay.
3150 2. Within after-strings, strings are sorted so that overlay strings
3151 from overlays with higher priorities come first.
3153 2. Within before-strings, strings are sorted so that overlay
3154 strings from overlays with higher priorities come last.
3156 Value is analogous to strcmp. */
3160 compare_overlay_entries (e1
, e2
)
3163 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
3164 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
3167 if (entry1
->after_string_p
!= entry2
->after_string_p
)
3169 /* Let after-strings appear in front of before-strings if
3170 they come from different overlays. */
3171 if (EQ (entry1
->overlay
, entry2
->overlay
))
3172 result
= entry1
->after_string_p
? 1 : -1;
3174 result
= entry1
->after_string_p
? -1 : 1;
3176 else if (entry1
->after_string_p
)
3177 /* After-strings sorted in order of decreasing priority. */
3178 result
= entry2
->priority
- entry1
->priority
;
3180 /* Before-strings sorted in order of increasing priority. */
3181 result
= entry1
->priority
- entry2
->priority
;
3187 /* Load the vector IT->overlay_strings with overlay strings from IT's
3188 current buffer position. Set IT->n_overlays to the total number of
3189 overlay strings found.
3191 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
3192 a time. On entry into load_overlay_strings,
3193 IT->current.overlay_string_index gives the number of overlay
3194 strings that have already been loaded by previous calls to this
3197 IT->add_overlay_start contains an additional overlay start
3198 position to consider for taking overlay strings from, if non-zero.
3199 This position comes into play when the overlay has an `invisible'
3200 property, and both before and after-strings. When we've skipped to
3201 the end of the overlay, because of its `invisible' property, we
3202 nevertheless want its before-string to appear.
3203 IT->add_overlay_start will contain the overlay start position
3206 Overlay strings are sorted so that after-string strings come in
3207 front of before-string strings. Within before and after-strings,
3208 strings are sorted by overlay priority. See also function
3209 compare_overlay_entries. */
3212 load_overlay_strings (it
)
3215 extern Lisp_Object Qafter_string
, Qbefore_string
, Qwindow
, Qpriority
;
3216 Lisp_Object ov
, overlay
, window
, str
, invisible
;
3219 int n
= 0, i
, j
, invis_p
;
3220 struct overlay_entry
*entries
3221 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
3222 int charpos
= IT_CHARPOS (*it
);
3224 /* Append the overlay string STRING of overlay OVERLAY to vector
3225 `entries' which has size `size' and currently contains `n'
3226 elements. AFTER_P non-zero means STRING is an after-string of
3228 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
3231 Lisp_Object priority; \
3235 int new_size = 2 * size; \
3236 struct overlay_entry *old = entries; \
3238 (struct overlay_entry *) alloca (new_size \
3239 * sizeof *entries); \
3240 bcopy (old, entries, size * sizeof *entries); \
3244 entries[n].string = (STRING); \
3245 entries[n].overlay = (OVERLAY); \
3246 priority = Foverlay_get ((OVERLAY), Qpriority); \
3247 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
3248 entries[n].after_string_p = (AFTER_P); \
3253 /* Process overlay before the overlay center. */
3254 for (ov
= current_buffer
->overlays_before
; CONSP (ov
); ov
= XCDR (ov
))
3256 overlay
= XCAR (ov
);
3257 xassert (OVERLAYP (overlay
));
3258 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3259 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3264 /* Skip this overlay if it doesn't start or end at IT's current
3266 if (end
!= charpos
&& start
!= charpos
)
3269 /* Skip this overlay if it doesn't apply to IT->w. */
3270 window
= Foverlay_get (overlay
, Qwindow
);
3271 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
3274 /* If the text ``under'' the overlay is invisible, both before-
3275 and after-strings from this overlay are visible; start and
3276 end position are indistinguishable. */
3277 invisible
= Foverlay_get (overlay
, Qinvisible
);
3278 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
3280 /* If overlay has a non-empty before-string, record it. */
3281 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
3282 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
3283 && XSTRING (str
)->size
)
3284 RECORD_OVERLAY_STRING (overlay
, str
, 0);
3286 /* If overlay has a non-empty after-string, record it. */
3287 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
3288 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
3289 && XSTRING (str
)->size
)
3290 RECORD_OVERLAY_STRING (overlay
, str
, 1);
3293 /* Process overlays after the overlay center. */
3294 for (ov
= current_buffer
->overlays_after
; CONSP (ov
); ov
= XCDR (ov
))
3296 overlay
= XCAR (ov
);
3297 xassert (OVERLAYP (overlay
));
3298 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3299 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3301 if (start
> charpos
)
3304 /* Skip this overlay if it doesn't start or end at IT's current
3306 if (end
!= charpos
&& start
!= charpos
)
3309 /* Skip this overlay if it doesn't apply to IT->w. */
3310 window
= Foverlay_get (overlay
, Qwindow
);
3311 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
3314 /* If the text ``under'' the overlay is invisible, it has a zero
3315 dimension, and both before- and after-strings apply. */
3316 invisible
= Foverlay_get (overlay
, Qinvisible
);
3317 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
3319 /* If overlay has a non-empty before-string, record it. */
3320 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
3321 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
3322 && XSTRING (str
)->size
)
3323 RECORD_OVERLAY_STRING (overlay
, str
, 0);
3325 /* If overlay has a non-empty after-string, record it. */
3326 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
3327 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
3328 && XSTRING (str
)->size
)
3329 RECORD_OVERLAY_STRING (overlay
, str
, 1);
3332 #undef RECORD_OVERLAY_STRING
3336 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
3338 /* Record the total number of strings to process. */
3339 it
->n_overlay_strings
= n
;
3341 /* IT->current.overlay_string_index is the number of overlay strings
3342 that have already been consumed by IT. Copy some of the
3343 remaining overlay strings to IT->overlay_strings. */
3345 j
= it
->current
.overlay_string_index
;
3346 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
3347 it
->overlay_strings
[i
++] = entries
[j
++].string
;
3353 /* Get the first chunk of overlay strings at IT's current buffer
3354 position. Value is non-zero if at least one overlay string was
3358 get_overlay_strings (it
)
3361 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
3362 process. This fills IT->overlay_strings with strings, and sets
3363 IT->n_overlay_strings to the total number of strings to process.
3364 IT->pos.overlay_string_index has to be set temporarily to zero
3365 because load_overlay_strings needs this; it must be set to -1
3366 when no overlay strings are found because a zero value would
3367 indicate a position in the first overlay string. */
3368 it
->current
.overlay_string_index
= 0;
3369 load_overlay_strings (it
);
3371 /* If we found overlay strings, set up IT to deliver display
3372 elements from the first one. Otherwise set up IT to deliver
3373 from current_buffer. */
3374 if (it
->n_overlay_strings
)
3376 /* Make sure we know settings in current_buffer, so that we can
3377 restore meaningful values when we're done with the overlay
3379 compute_stop_pos (it
);
3380 xassert (it
->face_id
>= 0);
3382 /* Save IT's settings. They are restored after all overlay
3383 strings have been processed. */
3384 xassert (it
->sp
== 0);
3387 /* Set up IT to deliver display elements from the first overlay
3389 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
3390 it
->stop_charpos
= 0;
3391 it
->string
= it
->overlay_strings
[0];
3392 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
3393 xassert (STRINGP (it
->string
));
3394 it
->method
= next_element_from_string
;
3399 it
->current
.overlay_string_index
= -1;
3400 it
->method
= next_element_from_buffer
;
3405 /* Value is non-zero if we found at least one overlay string. */
3406 return STRINGP (it
->string
);
3411 /***********************************************************************
3412 Saving and restoring state
3413 ***********************************************************************/
3415 /* Save current settings of IT on IT->stack. Called, for example,
3416 before setting up IT for an overlay string, to be able to restore
3417 IT's settings to what they were after the overlay string has been
3424 struct iterator_stack_entry
*p
;
3426 xassert (it
->sp
< 2);
3427 p
= it
->stack
+ it
->sp
;
3429 p
->stop_charpos
= it
->stop_charpos
;
3430 xassert (it
->face_id
>= 0);
3431 p
->face_id
= it
->face_id
;
3432 p
->string
= it
->string
;
3433 p
->pos
= it
->current
;
3434 p
->end_charpos
= it
->end_charpos
;
3435 p
->string_nchars
= it
->string_nchars
;
3437 p
->multibyte_p
= it
->multibyte_p
;
3438 p
->space_width
= it
->space_width
;
3439 p
->font_height
= it
->font_height
;
3440 p
->voffset
= it
->voffset
;
3441 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
3446 /* Restore IT's settings from IT->stack. Called, for example, when no
3447 more overlay strings must be processed, and we return to delivering
3448 display elements from a buffer, or when the end of a string from a
3449 `display' property is reached and we return to delivering display
3450 elements from an overlay string, or from a buffer. */
3456 struct iterator_stack_entry
*p
;
3458 xassert (it
->sp
> 0);
3460 p
= it
->stack
+ it
->sp
;
3461 it
->stop_charpos
= p
->stop_charpos
;
3462 it
->face_id
= p
->face_id
;
3463 it
->string
= p
->string
;
3464 it
->current
= p
->pos
;
3465 it
->end_charpos
= p
->end_charpos
;
3466 it
->string_nchars
= p
->string_nchars
;
3468 it
->multibyte_p
= p
->multibyte_p
;
3469 it
->space_width
= p
->space_width
;
3470 it
->font_height
= p
->font_height
;
3471 it
->voffset
= p
->voffset
;
3472 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
3477 /***********************************************************************
3479 ***********************************************************************/
3481 /* Set IT's current position to the previous line start. */
3484 back_to_previous_line_start (it
)
3487 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
3488 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
3492 /* Move IT to the next line start.
3494 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
3495 we skipped over part of the text (as opposed to moving the iterator
3496 continuously over the text). Otherwise, don't change the value
3499 Newlines may come from buffer text, overlay strings, or strings
3500 displayed via the `display' property. That's the reason we can't
3501 simply use find_next_newline_no_quit.
3503 Note that this function may not skip over invisible text that is so
3504 because of text properties and immediately follows a newline. If
3505 it would, function reseat_at_next_visible_line_start, when called
3506 from set_iterator_to_next, would effectively make invisible
3507 characters following a newline part of the wrong glyph row, which
3508 leads to wrong cursor motion. */
3511 forward_to_next_line_start (it
, skipped_p
)
3515 int old_selective
, newline_found_p
, n
;
3516 const int MAX_NEWLINE_DISTANCE
= 500;
3518 /* If already on a newline, just consume it to avoid unintended
3519 skipping over invisible text below. */
3520 if (it
->what
== IT_CHARACTER
3522 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
3524 set_iterator_to_next (it
, 0);
3529 /* Don't handle selective display in the following. It's (a)
3530 unnecessary because it's done by the caller, and (b) leads to an
3531 infinite recursion because next_element_from_ellipsis indirectly
3532 calls this function. */
3533 old_selective
= it
->selective
;
3536 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
3537 from buffer text. */
3538 for (n
= newline_found_p
= 0;
3539 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
3540 n
+= STRINGP (it
->string
) ? 0 : 1)
3542 if (!get_next_display_element (it
))
3544 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
3545 set_iterator_to_next (it
, 0);
3548 /* If we didn't find a newline near enough, see if we can use a
3550 if (n
== MAX_NEWLINE_DISTANCE
)
3552 int start
= IT_CHARPOS (*it
);
3553 int limit
= find_next_newline_no_quit (start
, 1);
3556 xassert (!STRINGP (it
->string
));
3558 /* If there isn't any `display' property in sight, and no
3559 overlays, we can just use the position of the newline in
3561 if (it
->stop_charpos
>= limit
3562 || ((pos
= Fnext_single_property_change (make_number (start
),
3564 Qnil
, make_number (limit
)),
3566 && next_overlay_change (start
) == ZV
))
3568 IT_CHARPOS (*it
) = limit
;
3569 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
3570 *skipped_p
= newline_found_p
= 1;
3574 while (get_next_display_element (it
)
3575 && !newline_found_p
)
3577 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
3578 set_iterator_to_next (it
, 0);
3583 it
->selective
= old_selective
;
3584 return newline_found_p
;
3588 /* Set IT's current position to the previous visible line start. Skip
3589 invisible text that is so either due to text properties or due to
3590 selective display. Caution: this does not change IT->current_x and
3594 back_to_previous_visible_line_start (it
)
3599 /* Go back one newline if not on BEGV already. */
3600 if (IT_CHARPOS (*it
) > BEGV
)
3601 back_to_previous_line_start (it
);
3603 /* Move over lines that are invisible because of selective display
3604 or text properties. */
3605 while (IT_CHARPOS (*it
) > BEGV
3610 /* If selective > 0, then lines indented more than that values
3612 if (it
->selective
> 0
3613 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
3620 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
)),
3621 Qinvisible
, it
->window
);
3622 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
3626 /* Back one more newline if the current one is invisible. */
3628 back_to_previous_line_start (it
);
3631 xassert (IT_CHARPOS (*it
) >= BEGV
);
3632 xassert (IT_CHARPOS (*it
) == BEGV
3633 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
3638 /* Reseat iterator IT at the previous visible line start. Skip
3639 invisible text that is so either due to text properties or due to
3640 selective display. At the end, update IT's overlay information,
3641 face information etc. */
3644 reseat_at_previous_visible_line_start (it
)
3647 back_to_previous_visible_line_start (it
);
3648 reseat (it
, it
->current
.pos
, 1);
3653 /* Reseat iterator IT on the next visible line start in the current
3654 buffer. ON_NEWLINE_P non-zero means position IT on the newline
3655 preceding the line start. Skip over invisible text that is so
3656 because of selective display. Compute faces, overlays etc at the
3657 new position. Note that this function does not skip over text that
3658 is invisible because of text properties. */
3661 reseat_at_next_visible_line_start (it
, on_newline_p
)
3665 int newline_found_p
, skipped_p
= 0;
3667 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
3669 /* Skip over lines that are invisible because they are indented
3670 more than the value of IT->selective. */
3671 if (it
->selective
> 0)
3672 while (IT_CHARPOS (*it
) < ZV
3673 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
3676 xassert (FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
3677 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
3680 /* Position on the newline if that's what's requested. */
3681 if (on_newline_p
&& newline_found_p
)
3683 if (STRINGP (it
->string
))
3685 if (IT_STRING_CHARPOS (*it
) > 0)
3687 --IT_STRING_CHARPOS (*it
);
3688 --IT_STRING_BYTEPOS (*it
);
3691 else if (IT_CHARPOS (*it
) > BEGV
)
3695 reseat (it
, it
->current
.pos
, 0);
3699 reseat (it
, it
->current
.pos
, 0);
3706 /***********************************************************************
3707 Changing an iterator's position
3708 ***********************************************************************/
3710 /* Change IT's current position to POS in current_buffer. If FORCE_P
3711 is non-zero, always check for text properties at the new position.
3712 Otherwise, text properties are only looked up if POS >=
3713 IT->check_charpos of a property. */
3716 reseat (it
, pos
, force_p
)
3718 struct text_pos pos
;
3721 int original_pos
= IT_CHARPOS (*it
);
3723 reseat_1 (it
, pos
, 0);
3725 /* Determine where to check text properties. Avoid doing it
3726 where possible because text property lookup is very expensive. */
3728 || CHARPOS (pos
) > it
->stop_charpos
3729 || CHARPOS (pos
) < original_pos
)
3736 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
3737 IT->stop_pos to POS, also. */
3740 reseat_1 (it
, pos
, set_stop_p
)
3742 struct text_pos pos
;
3745 /* Don't call this function when scanning a C string. */
3746 xassert (it
->s
== NULL
);
3748 /* POS must be a reasonable value. */
3749 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
3751 it
->current
.pos
= it
->position
= pos
;
3752 XSETBUFFER (it
->object
, current_buffer
);
3753 it
->end_charpos
= ZV
;
3755 it
->current
.dpvec_index
= -1;
3756 it
->current
.overlay_string_index
= -1;
3757 IT_STRING_CHARPOS (*it
) = -1;
3758 IT_STRING_BYTEPOS (*it
) = -1;
3760 it
->method
= next_element_from_buffer
;
3762 it
->face_before_selective_p
= 0;
3765 it
->stop_charpos
= CHARPOS (pos
);
3769 /* Set up IT for displaying a string, starting at CHARPOS in window W.
3770 If S is non-null, it is a C string to iterate over. Otherwise,
3771 STRING gives a Lisp string to iterate over.
3773 If PRECISION > 0, don't return more then PRECISION number of
3774 characters from the string.
3776 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
3777 characters have been returned. FIELD_WIDTH < 0 means an infinite
3780 MULTIBYTE = 0 means disable processing of multibyte characters,
3781 MULTIBYTE > 0 means enable it,
3782 MULTIBYTE < 0 means use IT->multibyte_p.
3784 IT must be initialized via a prior call to init_iterator before
3785 calling this function. */
3788 reseat_to_string (it
, s
, string
, charpos
, precision
, field_width
, multibyte
)
3793 int precision
, field_width
, multibyte
;
3795 /* No region in strings. */
3796 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
3798 /* No text property checks performed by default, but see below. */
3799 it
->stop_charpos
= -1;
3801 /* Set iterator position and end position. */
3802 bzero (&it
->current
, sizeof it
->current
);
3803 it
->current
.overlay_string_index
= -1;
3804 it
->current
.dpvec_index
= -1;
3805 xassert (charpos
>= 0);
3807 /* Use the setting of MULTIBYTE if specified. */
3809 it
->multibyte_p
= multibyte
> 0;
3813 xassert (STRINGP (string
));
3814 it
->string
= string
;
3816 it
->end_charpos
= it
->string_nchars
= XSTRING (string
)->size
;
3817 it
->method
= next_element_from_string
;
3818 it
->current
.string_pos
= string_pos (charpos
, string
);
3825 /* Note that we use IT->current.pos, not it->current.string_pos,
3826 for displaying C strings. */
3827 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
3828 if (it
->multibyte_p
)
3830 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
3831 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
3835 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
3836 it
->end_charpos
= it
->string_nchars
= strlen (s
);
3839 it
->method
= next_element_from_c_string
;
3842 /* PRECISION > 0 means don't return more than PRECISION characters
3844 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
3845 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
3847 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
3848 characters have been returned. FIELD_WIDTH == 0 means don't pad,
3849 FIELD_WIDTH < 0 means infinite field width. This is useful for
3850 padding with `-' at the end of a mode line. */
3851 if (field_width
< 0)
3852 field_width
= INFINITY
;
3853 if (field_width
> it
->end_charpos
- charpos
)
3854 it
->end_charpos
= charpos
+ field_width
;
3856 /* Use the standard display table for displaying strings. */
3857 if (DISP_TABLE_P (Vstandard_display_table
))
3858 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
3860 it
->stop_charpos
= charpos
;
3866 /***********************************************************************
3868 ***********************************************************************/
3870 /* Load IT's display element fields with information about the next
3871 display element from the current position of IT. Value is zero if
3872 end of buffer (or C string) is reached. */
3875 get_next_display_element (it
)
3878 /* Non-zero means that we found an display element. Zero means that
3879 we hit the end of what we iterate over. Performance note: the
3880 function pointer `method' used here turns out to be faster than
3881 using a sequence of if-statements. */
3882 int success_p
= (*it
->method
) (it
);
3884 if (it
->what
== IT_CHARACTER
)
3886 /* Map via display table or translate control characters.
3887 IT->c, IT->len etc. have been set to the next character by
3888 the function call above. If we have a display table, and it
3889 contains an entry for IT->c, translate it. Don't do this if
3890 IT->c itself comes from a display table, otherwise we could
3891 end up in an infinite recursion. (An alternative could be to
3892 count the recursion depth of this function and signal an
3893 error when a certain maximum depth is reached.) Is it worth
3895 if (success_p
&& it
->dpvec
== NULL
)
3900 && (dv
= DISP_CHAR_VECTOR (it
->dp
, it
->c
),
3903 struct Lisp_Vector
*v
= XVECTOR (dv
);
3905 /* Return the first character from the display table
3906 entry, if not empty. If empty, don't display the
3907 current character. */
3910 it
->dpvec_char_len
= it
->len
;
3911 it
->dpvec
= v
->contents
;
3912 it
->dpend
= v
->contents
+ v
->size
;
3913 it
->current
.dpvec_index
= 0;
3914 it
->method
= next_element_from_display_vector
;
3915 success_p
= get_next_display_element (it
);
3919 set_iterator_to_next (it
, 0);
3920 success_p
= get_next_display_element (it
);
3924 /* Translate control characters into `\003' or `^C' form.
3925 Control characters coming from a display table entry are
3926 currently not translated because we use IT->dpvec to hold
3927 the translation. This could easily be changed but I
3928 don't believe that it is worth doing.
3930 Non-printable multibyte characters are also translated
3932 else if ((it
->c
< ' '
3933 && (it
->area
!= TEXT_AREA
3934 || (it
->c
!= '\n' && it
->c
!= '\t')))
3937 || !CHAR_PRINTABLE_P (it
->c
))
3939 /* IT->c is a control character which must be displayed
3940 either as '\003' or as `^C' where the '\\' and '^'
3941 can be defined in the display table. Fill
3942 IT->ctl_chars with glyphs for what we have to
3943 display. Then, set IT->dpvec to these glyphs. */
3946 if (it
->c
< 128 && it
->ctl_arrow_p
)
3948 /* Set IT->ctl_chars[0] to the glyph for `^'. */
3950 && INTEGERP (DISP_CTRL_GLYPH (it
->dp
))
3951 && GLYPH_CHAR_VALID_P (XINT (DISP_CTRL_GLYPH (it
->dp
))))
3952 g
= XINT (DISP_CTRL_GLYPH (it
->dp
));
3954 g
= FAST_MAKE_GLYPH ('^', 0);
3955 XSETINT (it
->ctl_chars
[0], g
);
3957 g
= FAST_MAKE_GLYPH (it
->c
^ 0100, 0);
3958 XSETINT (it
->ctl_chars
[1], g
);
3960 /* Set up IT->dpvec and return first character from it. */
3961 it
->dpvec_char_len
= it
->len
;
3962 it
->dpvec
= it
->ctl_chars
;
3963 it
->dpend
= it
->dpvec
+ 2;
3964 it
->current
.dpvec_index
= 0;
3965 it
->method
= next_element_from_display_vector
;
3966 get_next_display_element (it
);
3970 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
3975 /* Set IT->ctl_chars[0] to the glyph for `\\'. */
3977 && INTEGERP (DISP_ESCAPE_GLYPH (it
->dp
))
3978 && GLYPH_CHAR_VALID_P (XFASTINT (DISP_ESCAPE_GLYPH (it
->dp
))))
3979 escape_glyph
= XFASTINT (DISP_ESCAPE_GLYPH (it
->dp
));
3981 escape_glyph
= FAST_MAKE_GLYPH ('\\', 0);
3983 if (SINGLE_BYTE_CHAR_P (it
->c
))
3984 str
[0] = it
->c
, len
= 1;
3986 len
= CHAR_STRING (it
->c
, str
);
3988 for (i
= 0; i
< len
; i
++)
3990 XSETINT (it
->ctl_chars
[i
* 4], escape_glyph
);
3991 /* Insert three more glyphs into IT->ctl_chars for
3992 the octal display of the character. */
3993 g
= FAST_MAKE_GLYPH (((str
[i
] >> 6) & 7) + '0', 0);
3994 XSETINT (it
->ctl_chars
[i
* 4 + 1], g
);
3995 g
= FAST_MAKE_GLYPH (((str
[i
] >> 3) & 7) + '0', 0);
3996 XSETINT (it
->ctl_chars
[i
* 4 + 2], g
);
3997 g
= FAST_MAKE_GLYPH ((str
[i
] & 7) + '0', 0);
3998 XSETINT (it
->ctl_chars
[i
* 4 + 3], g
);
4001 /* Set up IT->dpvec and return the first character
4003 it
->dpvec_char_len
= it
->len
;
4004 it
->dpvec
= it
->ctl_chars
;
4005 it
->dpend
= it
->dpvec
+ len
* 4;
4006 it
->current
.dpvec_index
= 0;
4007 it
->method
= next_element_from_display_vector
;
4008 get_next_display_element (it
);
4013 /* Adjust face id for a multibyte character. There are no
4014 multibyte character in unibyte text. */
4017 && FRAME_WINDOW_P (it
->f
))
4019 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4020 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->c
);
4024 /* Is this character the last one of a run of characters with
4025 box? If yes, set IT->end_of_box_run_p to 1. */
4032 it
->end_of_box_run_p
4033 = ((face_id
= face_after_it_pos (it
),
4034 face_id
!= it
->face_id
)
4035 && (face
= FACE_FROM_ID (it
->f
, face_id
),
4036 face
->box
== FACE_NO_BOX
));
4039 /* Value is 0 if end of buffer or string reached. */
4044 /* Move IT to the next display element.
4046 RESEAT_P non-zero means if called on a newline in buffer text,
4047 skip to the next visible line start.
4049 Functions get_next_display_element and set_iterator_to_next are
4050 separate because I find this arrangement easier to handle than a
4051 get_next_display_element function that also increments IT's
4052 position. The way it is we can first look at an iterator's current
4053 display element, decide whether it fits on a line, and if it does,
4054 increment the iterator position. The other way around we probably
4055 would either need a flag indicating whether the iterator has to be
4056 incremented the next time, or we would have to implement a
4057 decrement position function which would not be easy to write. */
4060 set_iterator_to_next (it
, reseat_p
)
4064 /* Reset flags indicating start and end of a sequence of characters
4065 with box. Reset them at the start of this function because
4066 moving the iterator to a new position might set them. */
4067 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
4069 if (it
->method
== next_element_from_buffer
)
4071 /* The current display element of IT is a character from
4072 current_buffer. Advance in the buffer, and maybe skip over
4073 invisible lines that are so because of selective display. */
4074 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
4075 reseat_at_next_visible_line_start (it
, 0);
4078 xassert (it
->len
!= 0);
4079 IT_BYTEPOS (*it
) += it
->len
;
4080 IT_CHARPOS (*it
) += 1;
4081 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
4084 else if (it
->method
== next_element_from_composition
)
4086 xassert (it
->cmp_id
>= 0 && it
->cmp_id
< n_compositions
);
4087 if (STRINGP (it
->string
))
4089 IT_STRING_BYTEPOS (*it
) += it
->len
;
4090 IT_STRING_CHARPOS (*it
) += it
->cmp_len
;
4091 it
->method
= next_element_from_string
;
4092 goto consider_string_end
;
4096 IT_BYTEPOS (*it
) += it
->len
;
4097 IT_CHARPOS (*it
) += it
->cmp_len
;
4098 it
->method
= next_element_from_buffer
;
4101 else if (it
->method
== next_element_from_c_string
)
4103 /* Current display element of IT is from a C string. */
4104 IT_BYTEPOS (*it
) += it
->len
;
4105 IT_CHARPOS (*it
) += 1;
4107 else if (it
->method
== next_element_from_display_vector
)
4109 /* Current display element of IT is from a display table entry.
4110 Advance in the display table definition. Reset it to null if
4111 end reached, and continue with characters from buffers/
4113 ++it
->current
.dpvec_index
;
4115 /* Restore face of the iterator to what they were before the
4116 display vector entry (these entries may contain faces). */
4117 it
->face_id
= it
->saved_face_id
;
4119 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
4122 it
->method
= next_element_from_c_string
;
4123 else if (STRINGP (it
->string
))
4124 it
->method
= next_element_from_string
;
4126 it
->method
= next_element_from_buffer
;
4129 it
->current
.dpvec_index
= -1;
4131 /* Skip over characters which were displayed via IT->dpvec. */
4132 if (it
->dpvec_char_len
< 0)
4133 reseat_at_next_visible_line_start (it
, 1);
4134 else if (it
->dpvec_char_len
> 0)
4136 it
->len
= it
->dpvec_char_len
;
4137 set_iterator_to_next (it
, reseat_p
);
4141 else if (it
->method
== next_element_from_string
)
4143 /* Current display element is a character from a Lisp string. */
4144 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
4145 IT_STRING_BYTEPOS (*it
) += it
->len
;
4146 IT_STRING_CHARPOS (*it
) += 1;
4148 consider_string_end
:
4150 if (it
->current
.overlay_string_index
>= 0)
4152 /* IT->string is an overlay string. Advance to the
4153 next, if there is one. */
4154 if (IT_STRING_CHARPOS (*it
) >= XSTRING (it
->string
)->size
)
4155 next_overlay_string (it
);
4159 /* IT->string is not an overlay string. If we reached
4160 its end, and there is something on IT->stack, proceed
4161 with what is on the stack. This can be either another
4162 string, this time an overlay string, or a buffer. */
4163 if (IT_STRING_CHARPOS (*it
) == XSTRING (it
->string
)->size
4167 if (!STRINGP (it
->string
))
4168 it
->method
= next_element_from_buffer
;
4172 else if (it
->method
== next_element_from_image
4173 || it
->method
== next_element_from_stretch
)
4175 /* The position etc with which we have to proceed are on
4176 the stack. The position may be at the end of a string,
4177 if the `display' property takes up the whole string. */
4180 if (STRINGP (it
->string
))
4182 it
->method
= next_element_from_string
;
4183 goto consider_string_end
;
4186 it
->method
= next_element_from_buffer
;
4189 /* There are no other methods defined, so this should be a bug. */
4192 xassert (it
->method
!= next_element_from_string
4193 || (STRINGP (it
->string
)
4194 && IT_STRING_CHARPOS (*it
) >= 0));
4198 /* Load IT's display element fields with information about the next
4199 display element which comes from a display table entry or from the
4200 result of translating a control character to one of the forms `^C'
4201 or `\003'. IT->dpvec holds the glyphs to return as characters. */
4204 next_element_from_display_vector (it
)
4208 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
4210 /* Remember the current face id in case glyphs specify faces.
4211 IT's face is restored in set_iterator_to_next. */
4212 it
->saved_face_id
= it
->face_id
;
4214 if (INTEGERP (*it
->dpvec
)
4215 && GLYPH_CHAR_VALID_P (XFASTINT (*it
->dpvec
)))
4220 g
= XFASTINT (it
->dpvec
[it
->current
.dpvec_index
]);
4221 it
->c
= FAST_GLYPH_CHAR (g
);
4222 it
->len
= CHAR_BYTES (it
->c
);
4224 /* The entry may contain a face id to use. Such a face id is
4225 the id of a Lisp face, not a realized face. A face id of
4226 zero means no face is specified. */
4227 lface_id
= FAST_GLYPH_FACE (g
);
4230 /* The function returns -1 if lface_id is invalid. */
4231 int face_id
= ascii_face_of_lisp_face (it
->f
, lface_id
);
4233 it
->face_id
= face_id
;
4237 /* Display table entry is invalid. Return a space. */
4238 it
->c
= ' ', it
->len
= 1;
4240 /* Don't change position and object of the iterator here. They are
4241 still the values of the character that had this display table
4242 entry or was translated, and that's what we want. */
4243 it
->what
= IT_CHARACTER
;
4248 /* Load IT with the next display element from Lisp string IT->string.
4249 IT->current.string_pos is the current position within the string.
4250 If IT->current.overlay_string_index >= 0, the Lisp string is an
4254 next_element_from_string (it
)
4257 struct text_pos position
;
4259 xassert (STRINGP (it
->string
));
4260 xassert (IT_STRING_CHARPOS (*it
) >= 0);
4261 position
= it
->current
.string_pos
;
4263 /* Time to check for invisible text? */
4264 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
4265 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
4269 /* Since a handler may have changed IT->method, we must
4271 return get_next_display_element (it
);
4274 if (it
->current
.overlay_string_index
>= 0)
4276 /* Get the next character from an overlay string. In overlay
4277 strings, There is no field width or padding with spaces to
4279 if (IT_STRING_CHARPOS (*it
) >= XSTRING (it
->string
)->size
)
4284 else if (STRING_MULTIBYTE (it
->string
))
4286 int remaining
= (STRING_BYTES (XSTRING (it
->string
))
4287 - IT_STRING_BYTEPOS (*it
));
4288 unsigned char *s
= (XSTRING (it
->string
)->data
4289 + IT_STRING_BYTEPOS (*it
));
4290 it
->c
= string_char_and_length (s
, remaining
, &it
->len
);
4294 it
->c
= XSTRING (it
->string
)->data
[IT_STRING_BYTEPOS (*it
)];
4300 /* Get the next character from a Lisp string that is not an
4301 overlay string. Such strings come from the mode line, for
4302 example. We may have to pad with spaces, or truncate the
4303 string. See also next_element_from_c_string. */
4304 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
4309 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
4311 /* Pad with spaces. */
4312 it
->c
= ' ', it
->len
= 1;
4313 CHARPOS (position
) = BYTEPOS (position
) = -1;
4315 else if (STRING_MULTIBYTE (it
->string
))
4317 int maxlen
= (STRING_BYTES (XSTRING (it
->string
))
4318 - IT_STRING_BYTEPOS (*it
));
4319 unsigned char *s
= (XSTRING (it
->string
)->data
4320 + IT_STRING_BYTEPOS (*it
));
4321 it
->c
= string_char_and_length (s
, maxlen
, &it
->len
);
4325 it
->c
= XSTRING (it
->string
)->data
[IT_STRING_BYTEPOS (*it
)];
4330 /* Record what we have and where it came from. Note that we store a
4331 buffer position in IT->position although it could arguably be a
4333 it
->what
= IT_CHARACTER
;
4334 it
->object
= it
->string
;
4335 it
->position
= position
;
4340 /* Load IT with next display element from C string IT->s.
4341 IT->string_nchars is the maximum number of characters to return
4342 from the string. IT->end_charpos may be greater than
4343 IT->string_nchars when this function is called, in which case we
4344 may have to return padding spaces. Value is zero if end of string
4345 reached, including padding spaces. */
4348 next_element_from_c_string (it
)
4354 it
->what
= IT_CHARACTER
;
4355 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
4358 /* IT's position can be greater IT->string_nchars in case a field
4359 width or precision has been specified when the iterator was
4361 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
4363 /* End of the game. */
4367 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
4369 /* Pad with spaces. */
4370 it
->c
= ' ', it
->len
= 1;
4371 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
4373 else if (it
->multibyte_p
)
4375 /* Implementation note: The calls to strlen apparently aren't a
4376 performance problem because there is no noticeable performance
4377 difference between Emacs running in unibyte or multibyte mode. */
4378 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
4379 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
),
4383 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
4389 /* Set up IT to return characters from an ellipsis, if appropriate.
4390 The definition of the ellipsis glyphs may come from a display table
4391 entry. This function Fills IT with the first glyph from the
4392 ellipsis if an ellipsis is to be displayed. */
4395 next_element_from_ellipsis (it
)
4398 if (it
->selective_display_ellipsis_p
)
4400 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4402 /* Use the display table definition for `...'. Invalid glyphs
4403 will be handled by the method returning elements from dpvec. */
4404 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4405 it
->dpvec_char_len
= it
->len
;
4406 it
->dpvec
= v
->contents
;
4407 it
->dpend
= v
->contents
+ v
->size
;
4408 it
->current
.dpvec_index
= 0;
4409 it
->method
= next_element_from_display_vector
;
4413 /* Use default `...' which is stored in default_invis_vector. */
4414 it
->dpvec_char_len
= it
->len
;
4415 it
->dpvec
= default_invis_vector
;
4416 it
->dpend
= default_invis_vector
+ 3;
4417 it
->current
.dpvec_index
= 0;
4418 it
->method
= next_element_from_display_vector
;
4423 /* The face at the current position may be different from the
4424 face we find after the invisible text. Remember what it
4425 was in IT->saved_face_id, and signal that it's there by
4426 setting face_before_selective_p. */
4427 it
->saved_face_id
= it
->face_id
;
4428 it
->method
= next_element_from_buffer
;
4429 reseat_at_next_visible_line_start (it
, 1);
4430 it
->face_before_selective_p
= 1;
4433 return get_next_display_element (it
);
4437 /* Deliver an image display element. The iterator IT is already
4438 filled with image information (done in handle_display_prop). Value
4443 next_element_from_image (it
)
4446 it
->what
= IT_IMAGE
;
4451 /* Fill iterator IT with next display element from a stretch glyph
4452 property. IT->object is the value of the text property. Value is
4456 next_element_from_stretch (it
)
4459 it
->what
= IT_STRETCH
;
4464 /* Load IT with the next display element from current_buffer. Value
4465 is zero if end of buffer reached. IT->stop_charpos is the next
4466 position at which to stop and check for text properties or buffer
4470 next_element_from_buffer (it
)
4475 /* Check this assumption, otherwise, we would never enter the
4476 if-statement, below. */
4477 xassert (IT_CHARPOS (*it
) >= BEGV
4478 && IT_CHARPOS (*it
) <= it
->stop_charpos
);
4480 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
4482 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
4484 int overlay_strings_follow_p
;
4486 /* End of the game, except when overlay strings follow that
4487 haven't been returned yet. */
4488 if (it
->overlay_strings_at_end_processed_p
)
4489 overlay_strings_follow_p
= 0;
4492 it
->overlay_strings_at_end_processed_p
= 1;
4493 overlay_strings_follow_p
= get_overlay_strings (it
);
4496 if (overlay_strings_follow_p
)
4497 success_p
= get_next_display_element (it
);
4501 it
->position
= it
->current
.pos
;
4508 return get_next_display_element (it
);
4513 /* No face changes, overlays etc. in sight, so just return a
4514 character from current_buffer. */
4517 /* Maybe run the redisplay end trigger hook. Performance note:
4518 This doesn't seem to cost measurable time. */
4519 if (it
->redisplay_end_trigger_charpos
4521 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
4522 run_redisplay_end_trigger_hook (it
);
4524 /* Get the next character, maybe multibyte. */
4525 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
4526 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
4528 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT_BYTE
? ZV_BYTE
: GPT_BYTE
)
4529 - IT_BYTEPOS (*it
));
4530 it
->c
= string_char_and_length (p
, maxlen
, &it
->len
);
4533 it
->c
= *p
, it
->len
= 1;
4535 /* Record what we have and where it came from. */
4536 it
->what
= IT_CHARACTER
;;
4537 it
->object
= it
->w
->buffer
;
4538 it
->position
= it
->current
.pos
;
4540 /* Normally we return the character found above, except when we
4541 really want to return an ellipsis for selective display. */
4546 /* A value of selective > 0 means hide lines indented more
4547 than that number of columns. */
4548 if (it
->selective
> 0
4549 && IT_CHARPOS (*it
) + 1 < ZV
4550 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
4551 IT_BYTEPOS (*it
) + 1,
4554 success_p
= next_element_from_ellipsis (it
);
4555 it
->dpvec_char_len
= -1;
4558 else if (it
->c
== '\r' && it
->selective
== -1)
4560 /* A value of selective == -1 means that everything from the
4561 CR to the end of the line is invisible, with maybe an
4562 ellipsis displayed for it. */
4563 success_p
= next_element_from_ellipsis (it
);
4564 it
->dpvec_char_len
= -1;
4569 /* Value is zero if end of buffer reached. */
4570 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
4575 /* Run the redisplay end trigger hook for IT. */
4578 run_redisplay_end_trigger_hook (it
)
4581 Lisp_Object args
[3];
4583 /* IT->glyph_row should be non-null, i.e. we should be actually
4584 displaying something, or otherwise we should not run the hook. */
4585 xassert (it
->glyph_row
);
4587 /* Set up hook arguments. */
4588 args
[0] = Qredisplay_end_trigger_functions
;
4589 args
[1] = it
->window
;
4590 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
4591 it
->redisplay_end_trigger_charpos
= 0;
4593 /* Since we are *trying* to run these functions, don't try to run
4594 them again, even if they get an error. */
4595 it
->w
->redisplay_end_trigger
= Qnil
;
4596 Frun_hook_with_args (3, args
);
4598 /* Notice if it changed the face of the character we are on. */
4599 handle_face_prop (it
);
4603 /* Deliver a composition display element. The iterator IT is already
4604 filled with composition information (done in
4605 handle_composition_prop). Value is always 1. */
4608 next_element_from_composition (it
)
4611 it
->what
= IT_COMPOSITION
;
4612 it
->position
= (STRINGP (it
->string
)
4613 ? it
->current
.string_pos
4620 /***********************************************************************
4621 Moving an iterator without producing glyphs
4622 ***********************************************************************/
4624 /* Move iterator IT to a specified buffer or X position within one
4625 line on the display without producing glyphs.
4627 Begin to skip at IT's current position. Skip to TO_CHARPOS or TO_X
4628 whichever is reached first.
4630 TO_CHARPOS <= 0 means no TO_CHARPOS is specified.
4632 TO_X < 0 means that no TO_X is specified. TO_X is normally a value
4633 0 <= TO_X <= IT->last_visible_x. This means in particular, that
4634 TO_X includes the amount by which a window is horizontally
4639 MOVE_POS_MATCH_OR_ZV
4640 - when TO_POS or ZV was reached.
4643 -when TO_X was reached before TO_POS or ZV were reached.
4646 - when we reached the end of the display area and the line must
4650 - when we reached the end of the display area and the line is
4654 - when we stopped at a line end, i.e. a newline or a CR and selective
4657 static enum move_it_result
4658 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
)
4660 int to_charpos
, to_x
, op
;
4662 enum move_it_result result
= MOVE_UNDEFINED
;
4663 struct glyph_row
*saved_glyph_row
;
4665 /* Don't produce glyphs in produce_glyphs. */
4666 saved_glyph_row
= it
->glyph_row
;
4667 it
->glyph_row
= NULL
;
4671 int x
, i
, ascent
= 0, descent
= 0;
4673 /* Stop when ZV or TO_CHARPOS reached. */
4674 if (!get_next_display_element (it
)
4675 || ((op
& MOVE_TO_POS
) != 0
4676 && BUFFERP (it
->object
)
4677 && IT_CHARPOS (*it
) >= to_charpos
))
4679 result
= MOVE_POS_MATCH_OR_ZV
;
4683 /* The call to produce_glyphs will get the metrics of the
4684 display element IT is loaded with. We record in x the
4685 x-position before this display element in case it does not
4689 /* Remember the line height so far in case the next element doesn't
4691 if (!it
->truncate_lines_p
)
4693 ascent
= it
->max_ascent
;
4694 descent
= it
->max_descent
;
4697 PRODUCE_GLYPHS (it
);
4699 if (it
->area
!= TEXT_AREA
)
4701 set_iterator_to_next (it
, 1);
4705 /* The number of glyphs we get back in IT->nglyphs will normally
4706 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
4707 character on a terminal frame, or (iii) a line end. For the
4708 second case, IT->nglyphs - 1 padding glyphs will be present
4709 (on X frames, there is only one glyph produced for a
4710 composite character.
4712 The behavior implemented below means, for continuation lines,
4713 that as many spaces of a TAB as fit on the current line are
4714 displayed there. For terminal frames, as many glyphs of a
4715 multi-glyph character are displayed in the current line, too.
4716 This is what the old redisplay code did, and we keep it that
4717 way. Under X, the whole shape of a complex character must
4718 fit on the line or it will be completely displayed in the
4721 Note that both for tabs and padding glyphs, all glyphs have
4725 /* More than one glyph or glyph doesn't fit on line. All
4726 glyphs have the same width. */
4727 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
4730 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
4732 new_x
= x
+ single_glyph_width
;
4734 /* We want to leave anything reaching TO_X to the caller. */
4735 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
4738 result
= MOVE_X_REACHED
;
4741 else if (/* Lines are continued. */
4742 !it
->truncate_lines_p
4743 && (/* And glyph doesn't fit on the line. */
4744 new_x
> it
->last_visible_x
4745 /* Or it fits exactly and we're on a window
4747 || (new_x
== it
->last_visible_x
4748 && FRAME_WINDOW_P (it
->f
))))
4750 if (/* IT->hpos == 0 means the very first glyph
4751 doesn't fit on the line, e.g. a wide image. */
4753 || (new_x
== it
->last_visible_x
4754 && FRAME_WINDOW_P (it
->f
)))
4757 it
->current_x
= new_x
;
4758 if (i
== it
->nglyphs
- 1)
4759 set_iterator_to_next (it
, 1);
4764 it
->max_ascent
= ascent
;
4765 it
->max_descent
= descent
;
4768 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
4770 result
= MOVE_LINE_CONTINUED
;
4773 else if (new_x
> it
->first_visible_x
)
4775 /* Glyph is visible. Increment number of glyphs that
4776 would be displayed. */
4781 /* Glyph is completely off the left margin of the display
4782 area. Nothing to do. */
4786 if (result
!= MOVE_UNDEFINED
)
4789 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
4791 /* Stop when TO_X specified and reached. This check is
4792 necessary here because of lines consisting of a line end,
4793 only. The line end will not produce any glyphs and we
4794 would never get MOVE_X_REACHED. */
4795 xassert (it
->nglyphs
== 0);
4796 result
= MOVE_X_REACHED
;
4800 /* Is this a line end? If yes, we're done. */
4801 if (ITERATOR_AT_END_OF_LINE_P (it
))
4803 result
= MOVE_NEWLINE_OR_CR
;
4807 /* The current display element has been consumed. Advance
4809 set_iterator_to_next (it
, 1);
4811 /* Stop if lines are truncated and IT's current x-position is
4812 past the right edge of the window now. */
4813 if (it
->truncate_lines_p
4814 && it
->current_x
>= it
->last_visible_x
)
4816 result
= MOVE_LINE_TRUNCATED
;
4821 /* Restore the iterator settings altered at the beginning of this
4823 it
->glyph_row
= saved_glyph_row
;
4828 /* Move IT forward to a specified buffer position TO_CHARPOS, TO_X,
4829 TO_Y, TO_VPOS. OP is a bit-mask that specifies where to stop. See
4830 the description of enum move_operation_enum.
4832 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
4833 screen line, this function will set IT to the next position >
4837 move_it_to (it
, to_charpos
, to_x
, to_y
, to_vpos
, op
)
4839 int to_charpos
, to_x
, to_y
, to_vpos
;
4842 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
4848 if (op
& MOVE_TO_VPOS
)
4850 /* If no TO_CHARPOS and no TO_X specified, stop at the
4851 start of the line TO_VPOS. */
4852 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
4854 if (it
->vpos
== to_vpos
)
4860 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
4864 /* TO_VPOS >= 0 means stop at TO_X in the line at
4865 TO_VPOS, or at TO_POS, whichever comes first. */
4866 if (it
->vpos
== to_vpos
)
4872 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
4874 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
4879 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
4881 /* We have reached TO_X but not in the line we want. */
4882 skip
= move_it_in_display_line_to (it
, to_charpos
,
4884 if (skip
== MOVE_POS_MATCH_OR_ZV
)
4892 else if (op
& MOVE_TO_Y
)
4894 struct it it_backup
;
4896 /* TO_Y specified means stop at TO_X in the line containing
4897 TO_Y---or at TO_CHARPOS if this is reached first. The
4898 problem is that we can't really tell whether the line
4899 contains TO_Y before we have completely scanned it, and
4900 this may skip past TO_X. What we do is to first scan to
4903 If TO_X is not specified, use a TO_X of zero. The reason
4904 is to make the outcome of this function more predictable.
4905 If we didn't use TO_X == 0, we would stop at the end of
4906 the line which is probably not what a caller would expect
4908 skip
= move_it_in_display_line_to (it
, to_charpos
,
4912 | (op
& MOVE_TO_POS
)));
4914 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
4915 if (skip
== MOVE_POS_MATCH_OR_ZV
)
4921 /* If TO_X was reached, we would like to know whether TO_Y
4922 is in the line. This can only be said if we know the
4923 total line height which requires us to scan the rest of
4925 if (skip
== MOVE_X_REACHED
)
4928 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
4929 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
4931 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
4934 /* Now, decide whether TO_Y is in this line. */
4935 line_height
= it
->max_ascent
+ it
->max_descent
;
4936 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
4938 if (to_y
>= it
->current_y
4939 && to_y
< it
->current_y
+ line_height
)
4941 if (skip
== MOVE_X_REACHED
)
4942 /* If TO_Y is in this line and TO_X was reached above,
4943 we scanned too far. We have to restore IT's settings
4944 to the ones before skipping. */
4948 else if (skip
== MOVE_X_REACHED
)
4951 if (skip
== MOVE_POS_MATCH_OR_ZV
)
4959 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
4963 case MOVE_POS_MATCH_OR_ZV
:
4967 case MOVE_NEWLINE_OR_CR
:
4968 set_iterator_to_next (it
, 1);
4969 it
->continuation_lines_width
= 0;
4972 case MOVE_LINE_TRUNCATED
:
4973 it
->continuation_lines_width
= 0;
4974 reseat_at_next_visible_line_start (it
, 0);
4975 if ((op
& MOVE_TO_POS
) != 0
4976 && IT_CHARPOS (*it
) > to_charpos
)
4983 case MOVE_LINE_CONTINUED
:
4984 it
->continuation_lines_width
+= it
->current_x
;
4991 /* Reset/increment for the next run. */
4992 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
4993 it
->current_x
= it
->hpos
= 0;
4994 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
4996 last_height
= it
->max_ascent
+ it
->max_descent
;
4997 last_max_ascent
= it
->max_ascent
;
4998 it
->max_ascent
= it
->max_descent
= 0;
5003 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
5007 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
5009 If DY > 0, move IT backward at least that many pixels. DY = 0
5010 means move IT backward to the preceding line start or BEGV. This
5011 function may move over more than DY pixels if IT->current_y - DY
5012 ends up in the middle of a line; in this case IT->current_y will be
5013 set to the top of the line moved to. */
5016 move_it_vertically_backward (it
, dy
)
5020 int nlines
, h
, line_height
;
5022 int start_pos
= IT_CHARPOS (*it
);
5026 /* Estimate how many newlines we must move back. */
5027 nlines
= max (1, dy
/ CANON_Y_UNIT (it
->f
));
5029 /* Set the iterator's position that many lines back. */
5030 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
5031 back_to_previous_visible_line_start (it
);
5033 /* Reseat the iterator here. When moving backward, we don't want
5034 reseat to skip forward over invisible text, set up the iterator
5035 to deliver from overlay strings at the new position etc. So,
5036 use reseat_1 here. */
5037 reseat_1 (it
, it
->current
.pos
, 1);
5039 /* We are now surely at a line start. */
5040 it
->current_x
= it
->hpos
= 0;
5042 /* Move forward and see what y-distance we moved. First move to the
5043 start of the next line so that we get its height. We need this
5044 height to be able to tell whether we reached the specified
5047 it2
.max_ascent
= it2
.max_descent
= 0;
5048 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
5049 MOVE_TO_POS
| MOVE_TO_VPOS
);
5050 xassert (IT_CHARPOS (*it
) >= BEGV
);
5051 line_height
= it2
.max_ascent
+ it2
.max_descent
;
5053 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
5054 xassert (IT_CHARPOS (*it
) >= BEGV
);
5055 h
= it2
.current_y
- it
->current_y
;
5056 nlines
= it2
.vpos
- it
->vpos
;
5058 /* Correct IT's y and vpos position. */
5064 /* DY == 0 means move to the start of the screen line. The
5065 value of nlines is > 0 if continuation lines were involved. */
5067 move_it_by_lines (it
, nlines
, 1);
5068 xassert (IT_CHARPOS (*it
) <= start_pos
);
5072 /* The y-position we try to reach. Note that h has been
5073 subtracted in front of the if-statement. */
5074 int target_y
= it
->current_y
+ h
- dy
;
5076 /* If we did not reach target_y, try to move further backward if
5077 we can. If we moved too far backward, try to move forward. */
5078 if (target_y
< it
->current_y
5079 && IT_CHARPOS (*it
) > BEGV
)
5081 move_it_vertically (it
, target_y
- it
->current_y
);
5082 xassert (IT_CHARPOS (*it
) >= BEGV
);
5084 else if (target_y
>= it
->current_y
+ line_height
5085 && IT_CHARPOS (*it
) < ZV
)
5087 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
5088 xassert (IT_CHARPOS (*it
) >= BEGV
);
5094 /* Move IT by a specified amount of pixel lines DY. DY negative means
5095 move backwards. DY = 0 means move to start of screen line. At the
5096 end, IT will be on the start of a screen line. */
5099 move_it_vertically (it
, dy
)
5104 move_it_vertically_backward (it
, -dy
);
5107 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
5108 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
5109 MOVE_TO_POS
| MOVE_TO_Y
);
5110 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
5112 /* If buffer ends in ZV without a newline, move to the start of
5113 the line to satisfy the post-condition. */
5114 if (IT_CHARPOS (*it
) == ZV
5115 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
5116 move_it_by_lines (it
, 0, 0);
5121 /* Move iterator IT past the end of the text line it is in. */
5124 move_it_past_eol (it
)
5127 enum move_it_result rc
;
5129 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
5130 if (rc
== MOVE_NEWLINE_OR_CR
)
5131 set_iterator_to_next (it
, 0);
5135 #if 0 /* Currently not used. */
5137 /* Return non-zero if some text between buffer positions START_CHARPOS
5138 and END_CHARPOS is invisible. IT->window is the window for text
5142 invisible_text_between_p (it
, start_charpos
, end_charpos
)
5144 int start_charpos
, end_charpos
;
5146 Lisp_Object prop
, limit
;
5147 int invisible_found_p
;
5149 xassert (it
!= NULL
&& start_charpos
<= end_charpos
);
5151 /* Is text at START invisible? */
5152 prop
= Fget_char_property (make_number (start_charpos
), Qinvisible
,
5154 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5155 invisible_found_p
= 1;
5158 limit
= Fnext_single_char_property_change (make_number (start_charpos
),
5160 make_number (end_charpos
));
5161 invisible_found_p
= XFASTINT (limit
) < end_charpos
;
5164 return invisible_found_p
;
5170 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
5171 negative means move up. DVPOS == 0 means move to the start of the
5172 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
5173 NEED_Y_P is zero, IT->current_y will be left unchanged.
5175 Further optimization ideas: If we would know that IT->f doesn't use
5176 a face with proportional font, we could be faster for
5177 truncate-lines nil. */
5180 move_it_by_lines (it
, dvpos
, need_y_p
)
5182 int dvpos
, need_y_p
;
5184 struct position pos
;
5186 if (!FRAME_WINDOW_P (it
->f
))
5188 struct text_pos textpos
;
5190 /* We can use vmotion on frames without proportional fonts. */
5191 pos
= *vmotion (IT_CHARPOS (*it
), dvpos
, it
->w
);
5192 SET_TEXT_POS (textpos
, pos
.bufpos
, pos
.bytepos
);
5193 reseat (it
, textpos
, 1);
5194 it
->vpos
+= pos
.vpos
;
5195 it
->current_y
+= pos
.vpos
;
5197 else if (dvpos
== 0)
5199 /* DVPOS == 0 means move to the start of the screen line. */
5200 move_it_vertically_backward (it
, 0);
5201 xassert (it
->current_x
== 0 && it
->hpos
== 0);
5204 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
5208 int start_charpos
, i
;
5210 /* Go back -DVPOS visible lines and reseat the iterator there. */
5211 start_charpos
= IT_CHARPOS (*it
);
5212 for (i
= -dvpos
; i
&& IT_CHARPOS (*it
) > BEGV
; --i
)
5213 back_to_previous_visible_line_start (it
);
5214 reseat (it
, it
->current
.pos
, 1);
5215 it
->current_x
= it
->hpos
= 0;
5217 /* Above call may have moved too far if continuation lines
5218 are involved. Scan forward and see if it did. */
5220 it2
.vpos
= it2
.current_y
= 0;
5221 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
5222 it
->vpos
-= it2
.vpos
;
5223 it
->current_y
-= it2
.current_y
;
5224 it
->current_x
= it
->hpos
= 0;
5226 /* If we moved too far, move IT some lines forward. */
5227 if (it2
.vpos
> -dvpos
)
5229 int delta
= it2
.vpos
+ dvpos
;
5230 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
5237 /***********************************************************************
5239 ***********************************************************************/
5242 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
5246 add_to_log (format
, arg1
, arg2
)
5248 Lisp_Object arg1
, arg2
;
5250 Lisp_Object args
[3];
5251 Lisp_Object msg
, fmt
;
5254 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
5257 GCPRO4 (fmt
, msg
, arg1
, arg2
);
5259 args
[0] = fmt
= build_string (format
);
5262 msg
= Fformat (3, args
);
5264 len
= STRING_BYTES (XSTRING (msg
)) + 1;
5265 buffer
= (char *) alloca (len
);
5266 strcpy (buffer
, XSTRING (msg
)->data
);
5268 message_dolog (buffer
, len
- 1, 1, 0);
5273 /* Output a newline in the *Messages* buffer if "needs" one. */
5276 message_log_maybe_newline ()
5278 if (message_log_need_newline
)
5279 message_dolog ("", 0, 1, 0);
5283 /* Add a string M of length NBYTES to the message log, optionally
5284 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
5285 nonzero, means interpret the contents of M as multibyte. This
5286 function calls low-level routines in order to bypass text property
5287 hooks, etc. which might not be safe to run. */
5290 message_dolog (m
, nbytes
, nlflag
, multibyte
)
5292 int nbytes
, nlflag
, multibyte
;
5294 if (!NILP (Vmessage_log_max
))
5296 struct buffer
*oldbuf
;
5297 Lisp_Object oldpoint
, oldbegv
, oldzv
;
5298 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
5299 int point_at_end
= 0;
5301 Lisp_Object old_deactivate_mark
, tem
;
5302 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
5304 old_deactivate_mark
= Vdeactivate_mark
;
5305 oldbuf
= current_buffer
;
5306 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
5307 current_buffer
->undo_list
= Qt
;
5309 oldpoint
= Fpoint_marker ();
5310 oldbegv
= Fpoint_min_marker ();
5311 oldzv
= Fpoint_max_marker ();
5312 GCPRO4 (oldpoint
, oldbegv
, oldzv
, old_deactivate_mark
);
5320 BEGV_BYTE
= BEG_BYTE
;
5323 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
5325 /* Insert the string--maybe converting multibyte to single byte
5326 or vice versa, so that all the text fits the buffer. */
5328 && NILP (current_buffer
->enable_multibyte_characters
))
5330 int i
, c
, char_bytes
;
5331 unsigned char work
[1];
5333 /* Convert a multibyte string to single-byte
5334 for the *Message* buffer. */
5335 for (i
= 0; i
< nbytes
; i
+= nbytes
)
5337 c
= string_char_and_length (m
+ i
, nbytes
- i
, &char_bytes
);
5338 work
[0] = (SINGLE_BYTE_CHAR_P (c
)
5340 : multibyte_char_to_unibyte (c
, Qnil
));
5341 insert_1_both (work
, 1, 1, 1, 0, 0);
5344 else if (! multibyte
5345 && ! NILP (current_buffer
->enable_multibyte_characters
))
5347 int i
, c
, char_bytes
;
5348 unsigned char *msg
= (unsigned char *) m
;
5349 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
5350 /* Convert a single-byte string to multibyte
5351 for the *Message* buffer. */
5352 for (i
= 0; i
< nbytes
; i
++)
5354 c
= unibyte_char_to_multibyte (msg
[i
]);
5355 char_bytes
= CHAR_STRING (c
, str
);
5356 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
5360 insert_1 (m
, nbytes
, 1, 0, 0);
5364 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
5365 insert_1 ("\n", 1, 1, 0, 0);
5367 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
5369 this_bol_byte
= PT_BYTE
;
5373 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
5375 prev_bol_byte
= PT_BYTE
;
5377 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
5378 this_bol
, this_bol_byte
);
5381 del_range_both (prev_bol
, prev_bol_byte
,
5382 this_bol
, this_bol_byte
, 0);
5388 /* If you change this format, don't forget to also
5389 change message_log_check_duplicate. */
5390 sprintf (dupstr
, " [%d times]", dup
);
5391 duplen
= strlen (dupstr
);
5392 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
5393 insert_1 (dupstr
, duplen
, 1, 0, 1);
5398 if (NATNUMP (Vmessage_log_max
))
5400 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
5401 -XFASTINT (Vmessage_log_max
) - 1, 0);
5402 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
5405 BEGV
= XMARKER (oldbegv
)->charpos
;
5406 BEGV_BYTE
= marker_byte_position (oldbegv
);
5415 ZV
= XMARKER (oldzv
)->charpos
;
5416 ZV_BYTE
= marker_byte_position (oldzv
);
5420 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
5422 /* We can't do Fgoto_char (oldpoint) because it will run some
5424 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
5425 XMARKER (oldpoint
)->bytepos
);
5428 free_marker (oldpoint
);
5429 free_marker (oldbegv
);
5430 free_marker (oldzv
);
5432 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
5433 set_buffer_internal (oldbuf
);
5435 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
5436 message_log_need_newline
= !nlflag
;
5437 Vdeactivate_mark
= old_deactivate_mark
;
5442 /* We are at the end of the buffer after just having inserted a newline.
5443 (Note: We depend on the fact we won't be crossing the gap.)
5444 Check to see if the most recent message looks a lot like the previous one.
5445 Return 0 if different, 1 if the new one should just replace it, or a
5446 value N > 1 if we should also append " [N times]". */
5449 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
5450 int prev_bol
, this_bol
;
5451 int prev_bol_byte
, this_bol_byte
;
5454 int len
= Z_BYTE
- 1 - this_bol_byte
;
5456 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
5457 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
5459 for (i
= 0; i
< len
; i
++)
5461 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
5469 if (*p1
++ == ' ' && *p1
++ == '[')
5472 while (*p1
>= '0' && *p1
<= '9')
5473 n
= n
* 10 + *p1
++ - '0';
5474 if (strncmp (p1
, " times]\n", 8) == 0)
5481 /* Display an echo area message M with a specified length of NBYTES
5482 bytes. The string may include null characters. If M is 0, clear
5483 out any existing message, and let the mini-buffer text show
5486 The buffer M must continue to exist until after the echo area gets
5487 cleared or some other message gets displayed there. This means do
5488 not pass text that is stored in a Lisp string; do not pass text in
5489 a buffer that was alloca'd. */
5492 message2 (m
, nbytes
, multibyte
)
5497 /* First flush out any partial line written with print. */
5498 message_log_maybe_newline ();
5500 message_dolog (m
, nbytes
, 1, multibyte
);
5501 message2_nolog (m
, nbytes
, multibyte
);
5505 /* The non-logging counterpart of message2. */
5508 message2_nolog (m
, nbytes
, multibyte
)
5512 struct frame
*sf
= SELECTED_FRAME ();
5513 message_enable_multibyte
= multibyte
;
5517 if (noninteractive_need_newline
)
5518 putc ('\n', stderr
);
5519 noninteractive_need_newline
= 0;
5521 fwrite (m
, nbytes
, 1, stderr
);
5522 if (cursor_in_echo_area
== 0)
5523 fprintf (stderr
, "\n");
5526 /* A null message buffer means that the frame hasn't really been
5527 initialized yet. Error messages get reported properly by
5528 cmd_error, so this must be just an informative message; toss it. */
5529 else if (INTERACTIVE
5530 && sf
->glyphs_initialized_p
5531 && FRAME_MESSAGE_BUF (sf
))
5533 Lisp_Object mini_window
;
5536 /* Get the frame containing the mini-buffer
5537 that the selected frame is using. */
5538 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
5539 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
5541 FRAME_SAMPLE_VISIBILITY (f
);
5542 if (FRAME_VISIBLE_P (sf
)
5543 && ! FRAME_VISIBLE_P (f
))
5544 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
5548 set_message (m
, Qnil
, nbytes
, multibyte
);
5549 if (minibuffer_auto_raise
)
5550 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
5553 clear_message (1, 1);
5555 do_pending_window_change (0);
5556 echo_area_display (1);
5557 do_pending_window_change (0);
5558 if (frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
5559 (*frame_up_to_date_hook
) (f
);
5564 /* Display an echo area message M with a specified length of NBYTES
5565 bytes. The string may include null characters. If M is not a
5566 string, clear out any existing message, and let the mini-buffer
5567 text show through. */
5570 message3 (m
, nbytes
, multibyte
)
5575 struct gcpro gcpro1
;
5579 /* First flush out any partial line written with print. */
5580 message_log_maybe_newline ();
5582 message_dolog (XSTRING (m
)->data
, nbytes
, 1, multibyte
);
5583 message3_nolog (m
, nbytes
, multibyte
);
5589 /* The non-logging version of message3. */
5592 message3_nolog (m
, nbytes
, multibyte
)
5594 int nbytes
, multibyte
;
5596 struct frame
*sf
= SELECTED_FRAME ();
5597 message_enable_multibyte
= multibyte
;
5601 if (noninteractive_need_newline
)
5602 putc ('\n', stderr
);
5603 noninteractive_need_newline
= 0;
5605 fwrite (XSTRING (m
)->data
, nbytes
, 1, stderr
);
5606 if (cursor_in_echo_area
== 0)
5607 fprintf (stderr
, "\n");
5610 /* A null message buffer means that the frame hasn't really been
5611 initialized yet. Error messages get reported properly by
5612 cmd_error, so this must be just an informative message; toss it. */
5613 else if (INTERACTIVE
5614 && sf
->glyphs_initialized_p
5615 && FRAME_MESSAGE_BUF (sf
))
5617 Lisp_Object mini_window
;
5621 /* Get the frame containing the mini-buffer
5622 that the selected frame is using. */
5623 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
5624 frame
= XWINDOW (mini_window
)->frame
;
5627 FRAME_SAMPLE_VISIBILITY (f
);
5628 if (FRAME_VISIBLE_P (sf
)
5629 && !FRAME_VISIBLE_P (f
))
5630 Fmake_frame_visible (frame
);
5632 if (STRINGP (m
) && XSTRING (m
)->size
)
5634 set_message (NULL
, m
, nbytes
, multibyte
);
5635 if (minibuffer_auto_raise
)
5636 Fraise_frame (frame
);
5639 clear_message (1, 1);
5641 do_pending_window_change (0);
5642 echo_area_display (1);
5643 do_pending_window_change (0);
5644 if (frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
5645 (*frame_up_to_date_hook
) (f
);
5650 /* Display a null-terminated echo area message M. If M is 0, clear
5651 out any existing message, and let the mini-buffer text show through.
5653 The buffer M must continue to exist until after the echo area gets
5654 cleared or some other message gets displayed there. Do not pass
5655 text that is stored in a Lisp string. Do not pass text in a buffer
5656 that was alloca'd. */
5662 message2 (m
, (m
? strlen (m
) : 0), 0);
5666 /* The non-logging counterpart of message1. */
5672 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
5675 /* Display a message M which contains a single %s
5676 which gets replaced with STRING. */
5679 message_with_string (m
, string
, log
)
5688 if (noninteractive_need_newline
)
5689 putc ('\n', stderr
);
5690 noninteractive_need_newline
= 0;
5691 fprintf (stderr
, m
, XSTRING (string
)->data
);
5692 if (cursor_in_echo_area
== 0)
5693 fprintf (stderr
, "\n");
5697 else if (INTERACTIVE
)
5699 /* The frame whose minibuffer we're going to display the message on.
5700 It may be larger than the selected frame, so we need
5701 to use its buffer, not the selected frame's buffer. */
5702 Lisp_Object mini_window
;
5703 struct frame
*f
, *sf
= SELECTED_FRAME ();
5705 /* Get the frame containing the minibuffer
5706 that the selected frame is using. */
5707 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
5708 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
5710 /* A null message buffer means that the frame hasn't really been
5711 initialized yet. Error messages get reported properly by
5712 cmd_error, so this must be just an informative message; toss it. */
5713 if (FRAME_MESSAGE_BUF (f
))
5717 a
[0] = (char *) XSTRING (string
)->data
;
5719 len
= doprnt (FRAME_MESSAGE_BUF (f
),
5720 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
5723 message2 (FRAME_MESSAGE_BUF (f
), len
,
5724 STRING_MULTIBYTE (string
));
5726 message2_nolog (FRAME_MESSAGE_BUF (f
), len
,
5727 STRING_MULTIBYTE (string
));
5729 /* Print should start at the beginning of the message
5730 buffer next time. */
5731 message_buf_print
= 0;
5737 /* Dump an informative message to the minibuf. If M is 0, clear out
5738 any existing message, and let the mini-buffer text show through. */
5742 message (m
, a1
, a2
, a3
)
5744 EMACS_INT a1
, a2
, a3
;
5750 if (noninteractive_need_newline
)
5751 putc ('\n', stderr
);
5752 noninteractive_need_newline
= 0;
5753 fprintf (stderr
, m
, a1
, a2
, a3
);
5754 if (cursor_in_echo_area
== 0)
5755 fprintf (stderr
, "\n");
5759 else if (INTERACTIVE
)
5761 /* The frame whose mini-buffer we're going to display the message
5762 on. It may be larger than the selected frame, so we need to
5763 use its buffer, not the selected frame's buffer. */
5764 Lisp_Object mini_window
;
5765 struct frame
*f
, *sf
= SELECTED_FRAME ();
5767 /* Get the frame containing the mini-buffer
5768 that the selected frame is using. */
5769 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
5770 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
5772 /* A null message buffer means that the frame hasn't really been
5773 initialized yet. Error messages get reported properly by
5774 cmd_error, so this must be just an informative message; toss
5776 if (FRAME_MESSAGE_BUF (f
))
5787 len
= doprnt (FRAME_MESSAGE_BUF (f
),
5788 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
5790 len
= doprnt (FRAME_MESSAGE_BUF (f
),
5791 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3,
5793 #endif /* NO_ARG_ARRAY */
5795 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
5800 /* Print should start at the beginning of the message
5801 buffer next time. */
5802 message_buf_print
= 0;
5808 /* The non-logging version of message. */
5811 message_nolog (m
, a1
, a2
, a3
)
5813 EMACS_INT a1
, a2
, a3
;
5815 Lisp_Object old_log_max
;
5816 old_log_max
= Vmessage_log_max
;
5817 Vmessage_log_max
= Qnil
;
5818 message (m
, a1
, a2
, a3
);
5819 Vmessage_log_max
= old_log_max
;
5823 /* Display the current message in the current mini-buffer. This is
5824 only called from error handlers in process.c, and is not time
5830 if (!NILP (echo_area_buffer
[0]))
5833 string
= Fcurrent_message ();
5834 message3 (string
, XSTRING (string
)->size
,
5835 !NILP (current_buffer
->enable_multibyte_characters
));
5840 /* Make sure echo area buffers in echo_buffers[] are life. If they
5841 aren't, make new ones. */
5844 ensure_echo_area_buffers ()
5848 for (i
= 0; i
< 2; ++i
)
5849 if (!BUFFERP (echo_buffer
[i
])
5850 || NILP (XBUFFER (echo_buffer
[i
])->name
))
5853 Lisp_Object old_buffer
;
5856 old_buffer
= echo_buffer
[i
];
5857 sprintf (name
, " *Echo Area %d*", i
);
5858 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
5859 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
5861 for (j
= 0; j
< 2; ++j
)
5862 if (EQ (old_buffer
, echo_area_buffer
[j
]))
5863 echo_area_buffer
[j
] = echo_buffer
[i
];
5868 /* Call FN with args A1..A4 with either the current or last displayed
5869 echo_area_buffer as current buffer.
5871 WHICH zero means use the current message buffer
5872 echo_area_buffer[0]. If that is nil, choose a suitable buffer
5873 from echo_buffer[] and clear it.
5875 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
5876 suitable buffer from echo_buffer[] and clear it.
5878 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
5879 that the current message becomes the last displayed one, make
5880 choose a suitable buffer for echo_area_buffer[0], and clear it.
5882 Value is what FN returns. */
5885 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
)
5888 int (*fn
) P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
5894 int this_one
, the_other
, clear_buffer_p
, rc
;
5895 int count
= BINDING_STACK_SIZE ();
5897 /* If buffers aren't life, make new ones. */
5898 ensure_echo_area_buffers ();
5903 this_one
= 0, the_other
= 1;
5905 this_one
= 1, the_other
= 0;
5908 this_one
= 0, the_other
= 1;
5911 /* We need a fresh one in case the current echo buffer equals
5912 the one containing the last displayed echo area message. */
5913 if (!NILP (echo_area_buffer
[this_one
])
5914 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
5915 echo_area_buffer
[this_one
] = Qnil
;
5918 /* Choose a suitable buffer from echo_buffer[] is we don't
5920 if (NILP (echo_area_buffer
[this_one
]))
5922 echo_area_buffer
[this_one
]
5923 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
5924 ? echo_buffer
[the_other
]
5925 : echo_buffer
[this_one
]);
5929 buffer
= echo_area_buffer
[this_one
];
5931 record_unwind_protect (unwind_with_echo_area_buffer
,
5932 with_echo_area_buffer_unwind_data (w
));
5934 /* Make the echo area buffer current. Note that for display
5935 purposes, it is not necessary that the displayed window's buffer
5936 == current_buffer, except for text property lookup. So, let's
5937 only set that buffer temporarily here without doing a full
5938 Fset_window_buffer. We must also change w->pointm, though,
5939 because otherwise an assertions in unshow_buffer fails, and Emacs
5941 set_buffer_internal_1 (XBUFFER (buffer
));
5945 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
5948 current_buffer
->undo_list
= Qt
;
5949 current_buffer
->read_only
= Qnil
;
5950 specbind (Qinhibit_read_only
, Qt
);
5952 if (clear_buffer_p
&& Z
> BEG
)
5955 xassert (BEGV
>= BEG
);
5956 xassert (ZV
<= Z
&& ZV
>= BEGV
);
5958 rc
= fn (a1
, a2
, a3
, a4
);
5960 xassert (BEGV
>= BEG
);
5961 xassert (ZV
<= Z
&& ZV
>= BEGV
);
5963 unbind_to (count
, Qnil
);
5968 /* Save state that should be preserved around the call to the function
5969 FN called in with_echo_area_buffer. */
5972 with_echo_area_buffer_unwind_data (w
)
5978 /* Reduce consing by keeping one vector in
5979 Vwith_echo_area_save_vector. */
5980 vector
= Vwith_echo_area_save_vector
;
5981 Vwith_echo_area_save_vector
= Qnil
;
5984 vector
= Fmake_vector (make_number (7), Qnil
);
5986 XSETBUFFER (AREF (vector
, i
), current_buffer
); ++i
;
5987 AREF (vector
, i
) = Vdeactivate_mark
, ++i
;
5988 AREF (vector
, i
) = make_number (windows_or_buffers_changed
), ++i
;
5992 XSETWINDOW (AREF (vector
, i
), w
); ++i
;
5993 AREF (vector
, i
) = w
->buffer
; ++i
;
5994 AREF (vector
, i
) = make_number (XMARKER (w
->pointm
)->charpos
); ++i
;
5995 AREF (vector
, i
) = make_number (XMARKER (w
->pointm
)->bytepos
); ++i
;
6000 for (; i
< end
; ++i
)
6001 AREF (vector
, i
) = Qnil
;
6004 xassert (i
== ASIZE (vector
));
6009 /* Restore global state from VECTOR which was created by
6010 with_echo_area_buffer_unwind_data. */
6013 unwind_with_echo_area_buffer (vector
)
6016 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
6017 Vdeactivate_mark
= AREF (vector
, 1);
6018 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
6020 if (WINDOWP (AREF (vector
, 3)))
6023 Lisp_Object buffer
, charpos
, bytepos
;
6025 w
= XWINDOW (AREF (vector
, 3));
6026 buffer
= AREF (vector
, 4);
6027 charpos
= AREF (vector
, 5);
6028 bytepos
= AREF (vector
, 6);
6031 set_marker_both (w
->pointm
, buffer
,
6032 XFASTINT (charpos
), XFASTINT (bytepos
));
6035 Vwith_echo_area_save_vector
= vector
;
6040 /* Set up the echo area for use by print functions. MULTIBYTE_P
6041 non-zero means we will print multibyte. */
6044 setup_echo_area_for_printing (multibyte_p
)
6047 ensure_echo_area_buffers ();
6049 if (!message_buf_print
)
6051 /* A message has been output since the last time we printed.
6052 Choose a fresh echo area buffer. */
6053 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
6054 echo_area_buffer
[0] = echo_buffer
[1];
6056 echo_area_buffer
[0] = echo_buffer
[0];
6058 /* Switch to that buffer and clear it. */
6059 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
6060 current_buffer
->truncate_lines
= Qnil
;
6064 int count
= BINDING_STACK_SIZE ();
6065 specbind (Qinhibit_read_only
, Qt
);
6067 unbind_to (count
, Qnil
);
6069 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
6071 /* Set up the buffer for the multibyteness we need. */
6073 != !NILP (current_buffer
->enable_multibyte_characters
))
6074 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
6076 /* Raise the frame containing the echo area. */
6077 if (minibuffer_auto_raise
)
6079 struct frame
*sf
= SELECTED_FRAME ();
6080 Lisp_Object mini_window
;
6081 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
6082 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
6085 message_log_maybe_newline ();
6086 message_buf_print
= 1;
6090 if (NILP (echo_area_buffer
[0]))
6092 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
6093 echo_area_buffer
[0] = echo_buffer
[1];
6095 echo_area_buffer
[0] = echo_buffer
[0];
6098 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
6100 /* Someone switched buffers between print requests. */
6101 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
6102 current_buffer
->truncate_lines
= Qnil
;
6108 /* Display an echo area message in window W. Value is non-zero if W's
6109 height is changed. If display_last_displayed_message_p is
6110 non-zero, display the message that was last displayed, otherwise
6111 display the current message. */
6114 display_echo_area (w
)
6117 int i
, no_message_p
, window_height_changed_p
, count
;
6119 /* Temporarily disable garbage collections while displaying the echo
6120 area. This is done because a GC can print a message itself.
6121 That message would modify the echo area buffer's contents while a
6122 redisplay of the buffer is going on, and seriously confuse
6124 count
= inhibit_garbage_collection ();
6126 /* If there is no message, we must call display_echo_area_1
6127 nevertheless because it resizes the window. But we will have to
6128 reset the echo_area_buffer in question to nil at the end because
6129 with_echo_area_buffer will sets it to an empty buffer. */
6130 i
= display_last_displayed_message_p
? 1 : 0;
6131 no_message_p
= NILP (echo_area_buffer
[i
]);
6133 window_height_changed_p
6134 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
6135 display_echo_area_1
,
6136 (EMACS_INT
) w
, Qnil
, 0, 0);
6139 echo_area_buffer
[i
] = Qnil
;
6141 unbind_to (count
, Qnil
);
6142 return window_height_changed_p
;
6146 /* Helper for display_echo_area. Display the current buffer which
6147 contains the current echo area message in window W, a mini-window,
6148 a pointer to which is passed in A1. A2..A4 are currently not used.
6149 Change the height of W so that all of the message is displayed.
6150 Value is non-zero if height of W was changed. */
6153 display_echo_area_1 (a1
, a2
, a3
, a4
)
6158 struct window
*w
= (struct window
*) a1
;
6160 struct text_pos start
;
6161 int window_height_changed_p
= 0;
6163 /* Do this before displaying, so that we have a large enough glyph
6164 matrix for the display. */
6165 window_height_changed_p
= resize_mini_window (w
, 0);
6168 clear_glyph_matrix (w
->desired_matrix
);
6169 XSETWINDOW (window
, w
);
6170 SET_TEXT_POS (start
, BEG
, BEG_BYTE
);
6171 try_window (window
, start
);
6173 return window_height_changed_p
;
6177 /* Resize the echo area window to exactly the size needed for the
6178 currently displayed message, if there is one. */
6181 resize_echo_area_axactly ()
6183 if (BUFFERP (echo_area_buffer
[0])
6184 && WINDOWP (echo_area_window
))
6186 struct window
*w
= XWINDOW (echo_area_window
);
6189 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
6190 (EMACS_INT
) w
, Qnil
, 0, 0);
6193 ++windows_or_buffers_changed
;
6194 ++update_mode_lines
;
6195 redisplay_internal (0);
6201 /* Callback function for with_echo_area_buffer, when used from
6202 resize_echo_area_axactly. A1 contains a pointer to the window to
6203 resize, A2 to A4 are not used. Value is what resize_mini_window
6207 resize_mini_window_1 (a1
, a2
, a3
, a4
)
6212 return resize_mini_window ((struct window
*) a1
, 1);
6216 /* Resize mini-window W to fit the size of its contents. EXACT:P
6217 means size the window exactly to the size needed. Otherwise, it's
6218 only enlarged until W's buffer is empty. Value is non-zero if
6219 the window height has been changed. */
6222 resize_mini_window (w
, exact_p
)
6226 struct frame
*f
= XFRAME (w
->frame
);
6227 int window_height_changed_p
= 0;
6229 xassert (MINI_WINDOW_P (w
));
6231 /* Nil means don't try to resize. */
6232 if (NILP (Vresize_mini_windows
)
6233 || (FRAME_X_P (f
) && f
->output_data
.x
== NULL
))
6236 if (!FRAME_MINIBUF_ONLY_P (f
))
6239 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
6240 int total_height
= XFASTINT (root
->height
) + XFASTINT (w
->height
);
6241 int height
, max_height
;
6242 int unit
= CANON_Y_UNIT (f
);
6243 struct text_pos start
;
6244 struct buffer
*old_current_buffer
= NULL
;
6246 if (current_buffer
!= XBUFFER (w
->buffer
))
6248 old_current_buffer
= current_buffer
;
6249 set_buffer_internal (XBUFFER (w
->buffer
));
6252 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
6254 /* Compute the max. number of lines specified by the user. */
6255 if (FLOATP (Vmax_mini_window_height
))
6256 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
6257 else if (INTEGERP (Vmax_mini_window_height
))
6258 max_height
= XINT (Vmax_mini_window_height
);
6260 max_height
= total_height
/ 4;
6262 /* Correct that max. height if it's bogus. */
6263 max_height
= max (1, max_height
);
6264 max_height
= min (total_height
, max_height
);
6266 /* Find out the height of the text in the window. */
6267 if (it
.truncate_lines_p
)
6272 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
6273 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
6274 height
= it
.current_y
+ last_height
;
6276 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
6277 height
-= it
.extra_line_spacing
;
6278 height
= (height
+ unit
- 1) / unit
;
6281 /* Compute a suitable window start. */
6282 if (height
> max_height
)
6284 height
= max_height
;
6285 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
6286 move_it_vertically_backward (&it
, (height
- 1) * unit
);
6287 start
= it
.current
.pos
;
6290 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
6291 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
6293 if (EQ (Vresize_mini_windows
, Qgrow_only
))
6295 /* Let it grow only, until we display an empty message, in which
6296 case the window shrinks again. */
6297 if (height
> XFASTINT (w
->height
))
6299 int old_height
= XFASTINT (w
->height
);
6300 freeze_window_starts (f
, 1);
6301 grow_mini_window (w
, height
- XFASTINT (w
->height
));
6302 window_height_changed_p
= XFASTINT (w
->height
) != old_height
;
6304 else if (height
< XFASTINT (w
->height
)
6305 && (exact_p
|| BEGV
== ZV
))
6307 int old_height
= XFASTINT (w
->height
);
6308 freeze_window_starts (f
, 0);
6309 shrink_mini_window (w
);
6310 window_height_changed_p
= XFASTINT (w
->height
) != old_height
;
6315 /* Always resize to exact size needed. */
6316 if (height
> XFASTINT (w
->height
))
6318 int old_height
= XFASTINT (w
->height
);
6319 freeze_window_starts (f
, 1);
6320 grow_mini_window (w
, height
- XFASTINT (w
->height
));
6321 window_height_changed_p
= XFASTINT (w
->height
) != old_height
;
6323 else if (height
< XFASTINT (w
->height
))
6325 int old_height
= XFASTINT (w
->height
);
6326 freeze_window_starts (f
, 0);
6327 shrink_mini_window (w
);
6331 freeze_window_starts (f
, 1);
6332 grow_mini_window (w
, height
- XFASTINT (w
->height
));
6335 window_height_changed_p
= XFASTINT (w
->height
) != old_height
;
6339 if (old_current_buffer
)
6340 set_buffer_internal (old_current_buffer
);
6343 return window_height_changed_p
;
6347 /* Value is the current message, a string, or nil if there is no
6355 if (NILP (echo_area_buffer
[0]))
6359 with_echo_area_buffer (0, 0, current_message_1
,
6360 (EMACS_INT
) &msg
, Qnil
, 0, 0);
6362 echo_area_buffer
[0] = Qnil
;
6370 current_message_1 (a1
, a2
, a3
, a4
)
6375 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
6378 *msg
= make_buffer_string (BEG
, Z
, 1);
6385 /* Push the current message on Vmessage_stack for later restauration
6386 by restore_message. Value is non-zero if the current message isn't
6387 empty. This is a relatively infrequent operation, so it's not
6388 worth optimizing. */
6394 msg
= current_message ();
6395 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
6396 return STRINGP (msg
);
6400 /* Handler for record_unwind_protect calling pop_message. */
6403 push_message_unwind (dummy
)
6411 /* Restore message display from the top of Vmessage_stack. */
6418 xassert (CONSP (Vmessage_stack
));
6419 msg
= XCAR (Vmessage_stack
);
6421 message3_nolog (msg
, STRING_BYTES (XSTRING (msg
)), STRING_MULTIBYTE (msg
));
6423 message3_nolog (msg
, 0, 0);
6427 /* Pop the top-most entry off Vmessage_stack. */
6432 xassert (CONSP (Vmessage_stack
));
6433 Vmessage_stack
= XCDR (Vmessage_stack
);
6437 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
6438 exits. If the stack is not empty, we have a missing pop_message
6442 check_message_stack ()
6444 if (!NILP (Vmessage_stack
))
6449 /* Truncate to NCHARS what will be displayed in the echo area the next
6450 time we display it---but don't redisplay it now. */
6453 truncate_echo_area (nchars
)
6457 echo_area_buffer
[0] = Qnil
;
6458 /* A null message buffer means that the frame hasn't really been
6459 initialized yet. Error messages get reported properly by
6460 cmd_error, so this must be just an informative message; toss it. */
6461 else if (!noninteractive
6463 && !NILP (echo_area_buffer
[0]))
6465 struct frame
*sf
= SELECTED_FRAME ();
6466 if (FRAME_MESSAGE_BUF (sf
))
6467 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
6472 /* Helper function for truncate_echo_area. Truncate the current
6473 message to at most NCHARS characters. */
6476 truncate_message_1 (nchars
, a2
, a3
, a4
)
6481 if (BEG
+ nchars
< Z
)
6482 del_range (BEG
+ nchars
, Z
);
6484 echo_area_buffer
[0] = Qnil
;
6489 /* Set the current message to a substring of S or STRING.
6491 If STRING is a Lisp string, set the message to the first NBYTES
6492 bytes from STRING. NBYTES zero means use the whole string. If
6493 STRING is multibyte, the message will be displayed multibyte.
6495 If S is not null, set the message to the first LEN bytes of S. LEN
6496 zero means use the whole string. MULTIBYTE_P non-zero means S is
6497 multibyte. Display the message multibyte in that case. */
6500 set_message (s
, string
, nbytes
, multibyte_p
)
6505 message_enable_multibyte
6506 = ((s
&& multibyte_p
)
6507 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
6509 with_echo_area_buffer (0, -1, set_message_1
,
6510 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
6511 message_buf_print
= 0;
6512 help_echo_showing_p
= 0;
6516 /* Helper function for set_message. Arguments have the same meaning
6517 as there, with A1 corresponding to S and A2 corresponding to STRING
6518 This function is called with the echo area buffer being
6522 set_message_1 (a1
, a2
, nbytes
, multibyte_p
)
6525 EMACS_INT nbytes
, multibyte_p
;
6527 char *s
= (char *) a1
;
6528 Lisp_Object string
= a2
;
6532 /* Change multibyteness of the echo buffer appropriately. */
6533 if (message_enable_multibyte
6534 != !NILP (current_buffer
->enable_multibyte_characters
))
6535 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
6537 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
6539 /* Insert new message at BEG. */
6540 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
6542 if (STRINGP (string
))
6547 nbytes
= XSTRING (string
)->size_byte
;
6548 nchars
= string_byte_to_char (string
, nbytes
);
6550 /* This function takes care of single/multibyte conversion. We
6551 just have to ensure that the echo area buffer has the right
6552 setting of enable_multibyte_characters. */
6553 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
6558 nbytes
= strlen (s
);
6560 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
6562 /* Convert from multi-byte to single-byte. */
6564 unsigned char work
[1];
6566 /* Convert a multibyte string to single-byte. */
6567 for (i
= 0; i
< nbytes
; i
+= n
)
6569 c
= string_char_and_length (s
+ i
, nbytes
- i
, &n
);
6570 work
[0] = (SINGLE_BYTE_CHAR_P (c
)
6572 : multibyte_char_to_unibyte (c
, Qnil
));
6573 insert_1_both (work
, 1, 1, 1, 0, 0);
6576 else if (!multibyte_p
6577 && !NILP (current_buffer
->enable_multibyte_characters
))
6579 /* Convert from single-byte to multi-byte. */
6581 unsigned char *msg
= (unsigned char *) s
;
6582 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
6584 /* Convert a single-byte string to multibyte. */
6585 for (i
= 0; i
< nbytes
; i
++)
6587 c
= unibyte_char_to_multibyte (msg
[i
]);
6588 n
= CHAR_STRING (c
, str
);
6589 insert_1_both (str
, 1, n
, 1, 0, 0);
6593 insert_1 (s
, nbytes
, 1, 0, 0);
6600 /* Clear messages. CURRENT_P non-zero means clear the current
6601 message. LAST_DISPLAYED_P non-zero means clear the message
6605 clear_message (current_p
, last_displayed_p
)
6606 int current_p
, last_displayed_p
;
6609 echo_area_buffer
[0] = Qnil
;
6611 if (last_displayed_p
)
6612 echo_area_buffer
[1] = Qnil
;
6614 message_buf_print
= 0;
6617 /* Clear garbaged frames.
6619 This function is used where the old redisplay called
6620 redraw_garbaged_frames which in turn called redraw_frame which in
6621 turn called clear_frame. The call to clear_frame was a source of
6622 flickering. I believe a clear_frame is not necessary. It should
6623 suffice in the new redisplay to invalidate all current matrices,
6624 and ensure a complete redisplay of all windows. */
6627 clear_garbaged_frames ()
6631 Lisp_Object tail
, frame
;
6633 FOR_EACH_FRAME (tail
, frame
)
6635 struct frame
*f
= XFRAME (frame
);
6637 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
6639 clear_current_matrices (f
);
6645 ++windows_or_buffers_changed
;
6650 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
6651 is non-zero update selected_frame. Value is non-zero if the
6652 mini-windows height has been changed. */
6655 echo_area_display (update_frame_p
)
6658 Lisp_Object mini_window
;
6661 int window_height_changed_p
= 0;
6662 struct frame
*sf
= SELECTED_FRAME ();
6664 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
6665 w
= XWINDOW (mini_window
);
6666 f
= XFRAME (WINDOW_FRAME (w
));
6668 /* Don't display if frame is invisible or not yet initialized. */
6669 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
6672 /* The terminal frame is used as the first Emacs frame on the Mac OS. */
6674 #ifdef HAVE_WINDOW_SYSTEM
6675 /* When Emacs starts, selected_frame may be a visible terminal
6676 frame, even if we run under a window system. If we let this
6677 through, a message would be displayed on the terminal. */
6678 if (EQ (selected_frame
, Vterminal_frame
)
6679 && !NILP (Vwindow_system
))
6681 #endif /* HAVE_WINDOW_SYSTEM */
6684 /* Redraw garbaged frames. */
6686 clear_garbaged_frames ();
6688 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
6690 echo_area_window
= mini_window
;
6691 window_height_changed_p
= display_echo_area (w
);
6692 w
->must_be_updated_p
= 1;
6694 /* Update the display, unless called from redisplay_internal.
6695 Also don't update the screen during redisplay itself. The
6696 update will happen at the end of redisplay, and an update
6697 here could cause confusion. */
6698 if (update_frame_p
&& !redisplaying_p
)
6702 /* If the display update has been interrupted by pending
6703 input, update mode lines in the frame. Due to the
6704 pending input, it might have been that redisplay hasn't
6705 been called, so that mode lines above the echo area are
6706 garbaged. This looks odd, so we prevent it here. */
6707 if (!display_completed
)
6708 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
6710 if (window_height_changed_p
6711 /* Don't do this if Emacs is shutting down. Redisplay
6712 needs to run hooks. */
6713 && !NILP (Vrun_hooks
))
6715 /* Must update other windows. Likewise as in other
6716 cases, don't let this update be interrupted by
6718 int count
= BINDING_STACK_SIZE ();
6719 specbind (Qredisplay_dont_pause
, Qt
);
6720 windows_or_buffers_changed
= 1;
6721 redisplay_internal (0);
6722 unbind_to (count
, Qnil
);
6724 else if (FRAME_WINDOW_P (f
) && n
== 0)
6726 /* Window configuration is the same as before.
6727 Can do with a display update of the echo area,
6728 unless we displayed some mode lines. */
6729 update_single_window (w
, 1);
6730 rif
->flush_display (f
);
6733 update_frame (f
, 1, 1);
6735 /* If cursor is in the echo area, make sure that the next
6736 redisplay displays the minibuffer, so that the cursor will
6737 be replaced with what the minibuffer wants. */
6738 if (cursor_in_echo_area
)
6739 ++windows_or_buffers_changed
;
6742 else if (!EQ (mini_window
, selected_window
))
6743 windows_or_buffers_changed
++;
6745 /* Last displayed message is now the current message. */
6746 echo_area_buffer
[1] = echo_area_buffer
[0];
6748 /* Prevent redisplay optimization in redisplay_internal by resetting
6749 this_line_start_pos. This is done because the mini-buffer now
6750 displays the message instead of its buffer text. */
6751 if (EQ (mini_window
, selected_window
))
6752 CHARPOS (this_line_start_pos
) = 0;
6754 return window_height_changed_p
;
6759 /***********************************************************************
6761 ***********************************************************************/
6764 #ifdef HAVE_WINDOW_SYSTEM
6766 /* A buffer for constructing frame titles in it; allocated from the
6767 heap in init_xdisp and resized as needed in store_frame_title_char. */
6769 static char *frame_title_buf
;
6771 /* The buffer's end, and a current output position in it. */
6773 static char *frame_title_buf_end
;
6774 static char *frame_title_ptr
;
6777 /* Store a single character C for the frame title in frame_title_buf.
6778 Re-allocate frame_title_buf if necessary. */
6781 store_frame_title_char (c
)
6784 /* If output position has reached the end of the allocated buffer,
6785 double the buffer's size. */
6786 if (frame_title_ptr
== frame_title_buf_end
)
6788 int len
= frame_title_ptr
- frame_title_buf
;
6789 int new_size
= 2 * len
* sizeof *frame_title_buf
;
6790 frame_title_buf
= (char *) xrealloc (frame_title_buf
, new_size
);
6791 frame_title_buf_end
= frame_title_buf
+ new_size
;
6792 frame_title_ptr
= frame_title_buf
+ len
;
6795 *frame_title_ptr
++ = c
;
6799 /* Store part of a frame title in frame_title_buf, beginning at
6800 frame_title_ptr. STR is the string to store. Do not copy
6801 characters that yield more columns than PRECISION; PRECISION <= 0
6802 means copy the whole string. Pad with spaces until FIELD_WIDTH
6803 number of characters have been copied; FIELD_WIDTH <= 0 means don't
6804 pad. Called from display_mode_element when it is used to build a
6808 store_frame_title (str
, field_width
, precision
)
6810 int field_width
, precision
;
6813 int dummy
, nbytes
, width
;
6815 /* Copy at most PRECISION chars from STR. */
6816 nbytes
= strlen (str
);
6817 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
6819 store_frame_title_char (*str
++);
6821 /* Fill up with spaces until FIELD_WIDTH reached. */
6822 while (field_width
> 0
6825 store_frame_title_char (' ');
6833 /* Set the title of FRAME, if it has changed. The title format is
6834 Vicon_title_format if FRAME is iconified, otherwise it is
6835 frame_title_format. */
6838 x_consider_frame_title (frame
)
6841 struct frame
*f
= XFRAME (frame
);
6843 if (FRAME_WINDOW_P (f
)
6844 || FRAME_MINIBUF_ONLY_P (f
)
6845 || f
->explicit_name
)
6847 /* Do we have more than one visible frame on this X display? */
6850 struct buffer
*obuf
;
6854 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
6856 struct frame
*tf
= XFRAME (XCAR (tail
));
6859 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
6860 && !FRAME_MINIBUF_ONLY_P (tf
)
6861 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
6865 /* Set global variable indicating that multiple frames exist. */
6866 multiple_frames
= CONSP (tail
);
6868 /* Switch to the buffer of selected window of the frame. Set up
6869 frame_title_ptr so that display_mode_element will output into it;
6870 then display the title. */
6871 obuf
= current_buffer
;
6872 Fset_buffer (XWINDOW (f
->selected_window
)->buffer
);
6873 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
6874 frame_title_ptr
= frame_title_buf
;
6875 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
6876 NULL
, DEFAULT_FACE_ID
);
6877 display_mode_element (&it
, 0, -1, -1, fmt
);
6878 len
= frame_title_ptr
- frame_title_buf
;
6879 frame_title_ptr
= NULL
;
6880 set_buffer_internal (obuf
);
6882 /* Set the title only if it's changed. This avoids consing in
6883 the common case where it hasn't. (If it turns out that we've
6884 already wasted too much time by walking through the list with
6885 display_mode_element, then we might need to optimize at a
6886 higher level than this.) */
6887 if (! STRINGP (f
->name
)
6888 || STRING_BYTES (XSTRING (f
->name
)) != len
6889 || bcmp (frame_title_buf
, XSTRING (f
->name
)->data
, len
) != 0)
6890 x_implicitly_set_name (f
, make_string (frame_title_buf
, len
), Qnil
);
6894 #else /* not HAVE_WINDOW_SYSTEM */
6896 #define frame_title_ptr ((char *)0)
6897 #define store_frame_title(str, mincol, maxcol) 0
6899 #endif /* not HAVE_WINDOW_SYSTEM */
6904 /***********************************************************************
6906 ***********************************************************************/
6909 /* Prepare for redisplay by updating menu-bar item lists when
6910 appropriate. This can call eval. */
6913 prepare_menu_bars ()
6916 struct gcpro gcpro1
, gcpro2
;
6918 Lisp_Object tooltip_frame
;
6920 #ifdef HAVE_X_WINDOWS
6921 tooltip_frame
= tip_frame
;
6923 tooltip_frame
= Qnil
;
6926 /* Update all frame titles based on their buffer names, etc. We do
6927 this before the menu bars so that the buffer-menu will show the
6928 up-to-date frame titles. */
6929 #ifdef HAVE_WINDOW_SYSTEM
6930 if (windows_or_buffers_changed
|| update_mode_lines
)
6932 Lisp_Object tail
, frame
;
6934 FOR_EACH_FRAME (tail
, frame
)
6937 if (!EQ (frame
, tooltip_frame
)
6938 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
6939 x_consider_frame_title (frame
);
6942 #endif /* HAVE_WINDOW_SYSTEM */
6944 /* Update the menu bar item lists, if appropriate. This has to be
6945 done before any actual redisplay or generation of display lines. */
6946 all_windows
= (update_mode_lines
6947 || buffer_shared
> 1
6948 || windows_or_buffers_changed
);
6951 Lisp_Object tail
, frame
;
6952 int count
= BINDING_STACK_SIZE ();
6954 record_unwind_protect (Fset_match_data
, Fmatch_data (Qnil
, Qnil
));
6956 FOR_EACH_FRAME (tail
, frame
)
6960 /* Ignore tooltip frame. */
6961 if (EQ (frame
, tooltip_frame
))
6964 /* If a window on this frame changed size, report that to
6965 the user and clear the size-change flag. */
6966 if (FRAME_WINDOW_SIZES_CHANGED (f
))
6968 Lisp_Object functions
;
6970 /* Clear flag first in case we get an error below. */
6971 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
6972 functions
= Vwindow_size_change_functions
;
6973 GCPRO2 (tail
, functions
);
6975 while (CONSP (functions
))
6977 call1 (XCAR (functions
), frame
);
6978 functions
= XCDR (functions
);
6984 update_menu_bar (f
, 0);
6985 #ifdef HAVE_WINDOW_SYSTEM
6986 update_tool_bar (f
, 0);
6991 unbind_to (count
, Qnil
);
6995 struct frame
*sf
= SELECTED_FRAME ();
6996 update_menu_bar (sf
, 1);
6997 #ifdef HAVE_WINDOW_SYSTEM
6998 update_tool_bar (sf
, 1);
7002 /* Motif needs this. See comment in xmenu.c. Turn it off when
7003 pending_menu_activation is not defined. */
7004 #ifdef USE_X_TOOLKIT
7005 pending_menu_activation
= 0;
7010 /* Update the menu bar item list for frame F. This has to be done
7011 before we start to fill in any display lines, because it can call
7014 If SAVE_MATCH_DATA is non-zero, we must save and restore it here. */
7017 update_menu_bar (f
, save_match_data
)
7019 int save_match_data
;
7022 register struct window
*w
;
7024 /* If called recursively during a menu update, do nothing. This can
7025 happen when, for instance, an activate-menubar-hook causes a
7027 if (inhibit_menubar_update
)
7030 window
= FRAME_SELECTED_WINDOW (f
);
7031 w
= XWINDOW (window
);
7033 if (update_mode_lines
)
7034 w
->update_mode_line
= Qt
;
7036 if (FRAME_WINDOW_P (f
)
7038 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (macintosh)
7039 FRAME_EXTERNAL_MENU_BAR (f
)
7041 FRAME_MENU_BAR_LINES (f
) > 0
7043 : FRAME_MENU_BAR_LINES (f
) > 0)
7045 /* If the user has switched buffers or windows, we need to
7046 recompute to reflect the new bindings. But we'll
7047 recompute when update_mode_lines is set too; that means
7048 that people can use force-mode-line-update to request
7049 that the menu bar be recomputed. The adverse effect on
7050 the rest of the redisplay algorithm is about the same as
7051 windows_or_buffers_changed anyway. */
7052 if (windows_or_buffers_changed
7053 || !NILP (w
->update_mode_line
)
7054 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
7055 < BUF_MODIFF (XBUFFER (w
->buffer
)))
7056 != !NILP (w
->last_had_star
))
7057 || ((!NILP (Vtransient_mark_mode
)
7058 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
7059 != !NILP (w
->region_showing
)))
7061 struct buffer
*prev
= current_buffer
;
7062 int count
= BINDING_STACK_SIZE ();
7064 specbind (Qinhibit_menubar_update
, Qt
);
7066 set_buffer_internal_1 (XBUFFER (w
->buffer
));
7067 if (save_match_data
)
7068 record_unwind_protect (Fset_match_data
, Fmatch_data (Qnil
, Qnil
));
7069 if (NILP (Voverriding_local_map_menu_flag
))
7071 specbind (Qoverriding_terminal_local_map
, Qnil
);
7072 specbind (Qoverriding_local_map
, Qnil
);
7075 /* Run the Lucid hook. */
7076 safe_run_hooks (Qactivate_menubar_hook
);
7078 /* If it has changed current-menubar from previous value,
7079 really recompute the menu-bar from the value. */
7080 if (! NILP (Vlucid_menu_bar_dirty_flag
))
7081 call0 (Qrecompute_lucid_menubar
);
7083 safe_run_hooks (Qmenu_bar_update_hook
);
7084 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
7086 /* Redisplay the menu bar in case we changed it. */
7087 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (macintosh)
7088 if (FRAME_WINDOW_P (f
)
7089 #if defined (macintosh)
7090 /* All frames on Mac OS share the same menubar. So only the
7091 selected frame should be allowed to set it. */
7092 && f
== SELECTED_FRAME ()
7095 set_frame_menubar (f
, 0, 0);
7097 /* On a terminal screen, the menu bar is an ordinary screen
7098 line, and this makes it get updated. */
7099 w
->update_mode_line
= Qt
;
7100 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI) */
7101 /* In the non-toolkit version, the menu bar is an ordinary screen
7102 line, and this makes it get updated. */
7103 w
->update_mode_line
= Qt
;
7104 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI) */
7106 unbind_to (count
, Qnil
);
7107 set_buffer_internal_1 (prev
);
7114 /***********************************************************************
7116 ***********************************************************************/
7118 #ifdef HAVE_WINDOW_SYSTEM
7120 /* Update the tool-bar item list for frame F. This has to be done
7121 before we start to fill in any display lines. Called from
7122 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
7123 and restore it here. */
7126 update_tool_bar (f
, save_match_data
)
7128 int save_match_data
;
7130 if (WINDOWP (f
->tool_bar_window
)
7131 && XFASTINT (XWINDOW (f
->tool_bar_window
)->height
) > 0)
7136 window
= FRAME_SELECTED_WINDOW (f
);
7137 w
= XWINDOW (window
);
7139 /* If the user has switched buffers or windows, we need to
7140 recompute to reflect the new bindings. But we'll
7141 recompute when update_mode_lines is set too; that means
7142 that people can use force-mode-line-update to request
7143 that the menu bar be recomputed. The adverse effect on
7144 the rest of the redisplay algorithm is about the same as
7145 windows_or_buffers_changed anyway. */
7146 if (windows_or_buffers_changed
7147 || !NILP (w
->update_mode_line
)
7148 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
7149 < BUF_MODIFF (XBUFFER (w
->buffer
)))
7150 != !NILP (w
->last_had_star
))
7151 || ((!NILP (Vtransient_mark_mode
)
7152 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
7153 != !NILP (w
->region_showing
)))
7155 struct buffer
*prev
= current_buffer
;
7156 int count
= BINDING_STACK_SIZE ();
7158 /* Set current_buffer to the buffer of the selected
7159 window of the frame, so that we get the right local
7161 set_buffer_internal_1 (XBUFFER (w
->buffer
));
7163 /* Save match data, if we must. */
7164 if (save_match_data
)
7165 record_unwind_protect (Fset_match_data
, Fmatch_data (Qnil
, Qnil
));
7167 /* Make sure that we don't accidentally use bogus keymaps. */
7168 if (NILP (Voverriding_local_map_menu_flag
))
7170 specbind (Qoverriding_terminal_local_map
, Qnil
);
7171 specbind (Qoverriding_local_map
, Qnil
);
7174 /* Build desired tool-bar items from keymaps. */
7176 = tool_bar_items (f
->tool_bar_items
, &f
->n_tool_bar_items
);
7178 /* Redisplay the tool-bar in case we changed it. */
7179 w
->update_mode_line
= Qt
;
7181 unbind_to (count
, Qnil
);
7182 set_buffer_internal_1 (prev
);
7188 /* Set F->desired_tool_bar_string to a Lisp string representing frame
7189 F's desired tool-bar contents. F->tool_bar_items must have
7190 been set up previously by calling prepare_menu_bars. */
7193 build_desired_tool_bar_string (f
)
7196 int i
, size
, size_needed
;
7197 struct gcpro gcpro1
, gcpro2
, gcpro3
;
7198 Lisp_Object image
, plist
, props
;
7200 image
= plist
= props
= Qnil
;
7201 GCPRO3 (image
, plist
, props
);
7203 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
7204 Otherwise, make a new string. */
7206 /* The size of the string we might be able to reuse. */
7207 size
= (STRINGP (f
->desired_tool_bar_string
)
7208 ? XSTRING (f
->desired_tool_bar_string
)->size
7211 /* We need one space in the string for each image. */
7212 size_needed
= f
->n_tool_bar_items
;
7214 /* Reuse f->desired_tool_bar_string, if possible. */
7215 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
7216 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
7220 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
7221 Fremove_text_properties (make_number (0), make_number (size
),
7222 props
, f
->desired_tool_bar_string
);
7225 /* Put a `display' property on the string for the images to display,
7226 put a `menu_item' property on tool-bar items with a value that
7227 is the index of the item in F's tool-bar item vector. */
7228 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
7230 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
7232 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7233 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7234 int hmargin
, vmargin
, relief
, idx
, end
;
7235 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
, Qimage
;
7236 extern Lisp_Object Qlaplace
;
7238 /* If image is a vector, choose the image according to the
7240 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
7241 if (VECTORP (image
))
7245 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
7246 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
7249 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
7250 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
7252 xassert (ASIZE (image
) >= idx
);
7253 image
= AREF (image
, idx
);
7258 /* Ignore invalid image specifications. */
7259 if (!valid_image_p (image
))
7262 /* Display the tool-bar button pressed, or depressed. */
7263 plist
= Fcopy_sequence (XCDR (image
));
7265 /* Compute margin and relief to draw. */
7266 relief
= (tool_bar_button_relief
> 0
7267 ? tool_bar_button_relief
7268 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
7269 hmargin
= vmargin
= relief
;
7271 if (INTEGERP (Vtool_bar_button_margin
)
7272 && XINT (Vtool_bar_button_margin
) > 0)
7274 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
7275 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
7277 else if (CONSP (Vtool_bar_button_margin
))
7279 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
7280 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
7281 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
7283 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
7284 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
7285 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
7288 if (auto_raise_tool_bar_buttons_p
)
7290 /* Add a `:relief' property to the image spec if the item is
7294 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
7301 /* If image is selected, display it pressed, i.e. with a
7302 negative relief. If it's not selected, display it with a
7304 plist
= Fplist_put (plist
, QCrelief
,
7306 ? make_number (-relief
)
7307 : make_number (relief
)));
7312 /* Put a margin around the image. */
7313 if (hmargin
|| vmargin
)
7315 if (hmargin
== vmargin
)
7316 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
7318 plist
= Fplist_put (plist
, QCmargin
,
7319 Fcons (make_number (hmargin
),
7320 make_number (vmargin
)));
7323 /* If button is not enabled, and we don't have special images
7324 for the disabled state, make the image appear disabled by
7325 applying an appropriate algorithm to it. */
7326 if (!enabled_p
&& idx
< 0)
7327 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
7329 /* Put a `display' text property on the string for the image to
7330 display. Put a `menu-item' property on the string that gives
7331 the start of this item's properties in the tool-bar items
7333 image
= Fcons (Qimage
, plist
);
7334 props
= list4 (Qdisplay
, image
,
7335 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
7337 /* Let the last image hide all remaining spaces in the tool bar
7338 string. The string can be longer than needed when we reuse a
7340 if (i
+ 1 == f
->n_tool_bar_items
)
7341 end
= XSTRING (f
->desired_tool_bar_string
)->size
;
7344 Fadd_text_properties (make_number (i
), make_number (end
),
7345 props
, f
->desired_tool_bar_string
);
7353 /* Display one line of the tool-bar of frame IT->f. */
7356 display_tool_bar_line (it
)
7359 struct glyph_row
*row
= it
->glyph_row
;
7360 int max_x
= it
->last_visible_x
;
7363 prepare_desired_row (row
);
7364 row
->y
= it
->current_y
;
7366 /* Note that this isn't made use of if the face hasn't a box,
7367 so there's no need to check the face here. */
7368 it
->start_of_box_run_p
= 1;
7370 while (it
->current_x
< max_x
)
7372 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
7374 /* Get the next display element. */
7375 if (!get_next_display_element (it
))
7378 /* Produce glyphs. */
7379 x_before
= it
->current_x
;
7380 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
7381 PRODUCE_GLYPHS (it
);
7383 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
7388 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
7390 if (x
+ glyph
->pixel_width
> max_x
)
7392 /* Glyph doesn't fit on line. */
7393 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
7399 x
+= glyph
->pixel_width
;
7403 /* Stop at line ends. */
7404 if (ITERATOR_AT_END_OF_LINE_P (it
))
7407 set_iterator_to_next (it
, 1);
7412 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
7413 extend_face_to_end_of_line (it
);
7414 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
7415 last
->right_box_line_p
= 1;
7416 if (last
== row
->glyphs
[TEXT_AREA
])
7417 last
->left_box_line_p
= 1;
7418 compute_line_metrics (it
);
7420 /* If line is empty, make it occupy the rest of the tool-bar. */
7421 if (!row
->displays_text_p
)
7423 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
7424 row
->ascent
= row
->phys_ascent
= 0;
7427 row
->full_width_p
= 1;
7428 row
->continued_p
= 0;
7429 row
->truncated_on_left_p
= 0;
7430 row
->truncated_on_right_p
= 0;
7432 it
->current_x
= it
->hpos
= 0;
7433 it
->current_y
+= row
->height
;
7439 /* Value is the number of screen lines needed to make all tool-bar
7440 items of frame F visible. */
7443 tool_bar_lines_needed (f
)
7446 struct window
*w
= XWINDOW (f
->tool_bar_window
);
7449 /* Initialize an iterator for iteration over
7450 F->desired_tool_bar_string in the tool-bar window of frame F. */
7451 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
7452 it
.first_visible_x
= 0;
7453 it
.last_visible_x
= FRAME_WINDOW_WIDTH (f
) * CANON_X_UNIT (f
);
7454 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
7456 while (!ITERATOR_AT_END_P (&it
))
7458 it
.glyph_row
= w
->desired_matrix
->rows
;
7459 clear_glyph_row (it
.glyph_row
);
7460 display_tool_bar_line (&it
);
7463 return (it
.current_y
+ CANON_Y_UNIT (f
) - 1) / CANON_Y_UNIT (f
);
7467 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
7469 "Return the number of lines occupied by the tool bar of FRAME.")
7478 frame
= selected_frame
;
7480 CHECK_FRAME (frame
, 0);
7483 if (WINDOWP (f
->tool_bar_window
)
7484 || (w
= XWINDOW (f
->tool_bar_window
),
7485 XFASTINT (w
->height
) > 0))
7487 update_tool_bar (f
, 1);
7488 if (f
->n_tool_bar_items
)
7490 build_desired_tool_bar_string (f
);
7491 nlines
= tool_bar_lines_needed (f
);
7495 return make_number (nlines
);
7499 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
7500 height should be changed. */
7503 redisplay_tool_bar (f
)
7508 struct glyph_row
*row
;
7509 int change_height_p
= 0;
7511 /* If frame hasn't a tool-bar window or if it is zero-height, don't
7512 do anything. This means you must start with tool-bar-lines
7513 non-zero to get the auto-sizing effect. Or in other words, you
7514 can turn off tool-bars by specifying tool-bar-lines zero. */
7515 if (!WINDOWP (f
->tool_bar_window
)
7516 || (w
= XWINDOW (f
->tool_bar_window
),
7517 XFASTINT (w
->height
) == 0))
7520 /* Set up an iterator for the tool-bar window. */
7521 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
7522 it
.first_visible_x
= 0;
7523 it
.last_visible_x
= FRAME_WINDOW_WIDTH (f
) * CANON_X_UNIT (f
);
7526 /* Build a string that represents the contents of the tool-bar. */
7527 build_desired_tool_bar_string (f
);
7528 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
7530 /* Display as many lines as needed to display all tool-bar items. */
7531 while (it
.current_y
< it
.last_visible_y
)
7532 display_tool_bar_line (&it
);
7534 /* It doesn't make much sense to try scrolling in the tool-bar
7535 window, so don't do it. */
7536 w
->desired_matrix
->no_scrolling_p
= 1;
7537 w
->must_be_updated_p
= 1;
7539 if (auto_resize_tool_bars_p
)
7543 /* If we couldn't display everything, change the tool-bar's
7545 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
7546 change_height_p
= 1;
7548 /* If there are blank lines at the end, except for a partially
7549 visible blank line at the end that is smaller than
7550 CANON_Y_UNIT, change the tool-bar's height. */
7551 row
= it
.glyph_row
- 1;
7552 if (!row
->displays_text_p
7553 && row
->height
>= CANON_Y_UNIT (f
))
7554 change_height_p
= 1;
7556 /* If row displays tool-bar items, but is partially visible,
7557 change the tool-bar's height. */
7558 if (row
->displays_text_p
7559 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
7560 change_height_p
= 1;
7562 /* Resize windows as needed by changing the `tool-bar-lines'
7565 && (nlines
= tool_bar_lines_needed (f
),
7566 nlines
!= XFASTINT (w
->height
)))
7568 extern Lisp_Object Qtool_bar_lines
;
7570 int old_height
= XFASTINT (w
->height
);
7572 XSETFRAME (frame
, f
);
7573 clear_glyph_matrix (w
->desired_matrix
);
7574 Fmodify_frame_parameters (frame
,
7575 Fcons (Fcons (Qtool_bar_lines
,
7576 make_number (nlines
)),
7578 if (XFASTINT (w
->height
) != old_height
)
7579 fonts_changed_p
= 1;
7583 return change_height_p
;
7587 /* Get information about the tool-bar item which is displayed in GLYPH
7588 on frame F. Return in *PROP_IDX the index where tool-bar item
7589 properties start in F->tool_bar_items. Value is zero if
7590 GLYPH doesn't display a tool-bar item. */
7593 tool_bar_item_info (f
, glyph
, prop_idx
)
7595 struct glyph
*glyph
;
7601 /* Get the text property `menu-item' at pos. The value of that
7602 property is the start index of this item's properties in
7603 F->tool_bar_items. */
7604 prop
= Fget_text_property (make_number (glyph
->charpos
),
7605 Qmenu_item
, f
->current_tool_bar_string
);
7606 if (INTEGERP (prop
))
7608 *prop_idx
= XINT (prop
);
7617 #endif /* HAVE_WINDOW_SYSTEM */
7621 /************************************************************************
7622 Horizontal scrolling
7623 ************************************************************************/
7625 static int hscroll_window_tree
P_ ((Lisp_Object
));
7626 static int hscroll_windows
P_ ((Lisp_Object
));
7628 /* For all leaf windows in the window tree rooted at WINDOW, set their
7629 hscroll value so that PT is (i) visible in the window, and (ii) so
7630 that it is not within a certain margin at the window's left and
7631 right border. Value is non-zero if any window's hscroll has been
7635 hscroll_window_tree (window
)
7638 int hscrolled_p
= 0;
7640 while (WINDOWP (window
))
7642 struct window
*w
= XWINDOW (window
);
7644 if (WINDOWP (w
->hchild
))
7645 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
7646 else if (WINDOWP (w
->vchild
))
7647 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
7648 else if (w
->cursor
.vpos
>= 0)
7650 int hscroll_margin
, text_area_x
, text_area_y
;
7651 int text_area_width
, text_area_height
;
7652 struct glyph_row
*current_cursor_row
7653 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
7654 struct glyph_row
*desired_cursor_row
7655 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
7656 struct glyph_row
*cursor_row
7657 = (desired_cursor_row
->enabled_p
7658 ? desired_cursor_row
7659 : current_cursor_row
);
7661 window_box (w
, TEXT_AREA
, &text_area_x
, &text_area_y
,
7662 &text_area_width
, &text_area_height
);
7664 /* Scroll when cursor is inside this scroll margin. */
7665 hscroll_margin
= 5 * CANON_X_UNIT (XFRAME (w
->frame
));
7667 if ((XFASTINT (w
->hscroll
)
7668 && w
->cursor
.x
< hscroll_margin
)
7669 || (cursor_row
->enabled_p
7670 && cursor_row
->truncated_on_right_p
7671 && (w
->cursor
.x
> text_area_width
- hscroll_margin
)))
7675 struct buffer
*saved_current_buffer
;
7678 /* Find point in a display of infinite width. */
7679 saved_current_buffer
= current_buffer
;
7680 current_buffer
= XBUFFER (w
->buffer
);
7682 if (w
== XWINDOW (selected_window
))
7683 pt
= BUF_PT (current_buffer
);
7686 pt
= marker_position (w
->pointm
);
7687 pt
= max (BEGV
, pt
);
7691 /* Move iterator to pt starting at cursor_row->start in
7692 a line with infinite width. */
7693 init_to_row_start (&it
, w
, cursor_row
);
7694 it
.last_visible_x
= INFINITY
;
7695 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
7696 current_buffer
= saved_current_buffer
;
7698 /* Center cursor in window. */
7699 hscroll
= (max (0, it
.current_x
- text_area_width
/ 2)
7700 / CANON_X_UNIT (it
.f
));
7701 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
7703 /* Don't call Fset_window_hscroll if value hasn't
7704 changed because it will prevent redisplay
7706 if (XFASTINT (w
->hscroll
) != hscroll
)
7708 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
7709 w
->hscroll
= make_number (hscroll
);
7718 /* Value is non-zero if hscroll of any leaf window has been changed. */
7723 /* Set hscroll so that cursor is visible and not inside horizontal
7724 scroll margins for all windows in the tree rooted at WINDOW. See
7725 also hscroll_window_tree above. Value is non-zero if any window's
7726 hscroll has been changed. If it has, desired matrices on the frame
7727 of WINDOW are cleared. */
7730 hscroll_windows (window
)
7735 if (automatic_hscrolling_p
)
7737 hscrolled_p
= hscroll_window_tree (window
);
7739 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
7748 /************************************************************************
7750 ************************************************************************/
7752 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
7753 to a non-zero value. This is sometimes handy to have in a debugger
7758 /* First and last unchanged row for try_window_id. */
7760 int debug_first_unchanged_at_end_vpos
;
7761 int debug_last_unchanged_at_beg_vpos
;
7763 /* Delta vpos and y. */
7765 int debug_dvpos
, debug_dy
;
7767 /* Delta in characters and bytes for try_window_id. */
7769 int debug_delta
, debug_delta_bytes
;
7771 /* Values of window_end_pos and window_end_vpos at the end of
7774 int debug_end_pos
, debug_end_vpos
;
7776 /* Append a string to W->desired_matrix->method. FMT is a printf
7777 format string. A1...A9 are a supplement for a variable-length
7778 argument list. If trace_redisplay_p is non-zero also printf the
7779 resulting string to stderr. */
7782 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
7785 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
7788 char *method
= w
->desired_matrix
->method
;
7789 int len
= strlen (method
);
7790 int size
= sizeof w
->desired_matrix
->method
;
7791 int remaining
= size
- len
- 1;
7793 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
7794 if (len
&& remaining
)
7800 strncpy (method
+ len
, buffer
, remaining
);
7802 if (trace_redisplay_p
)
7803 fprintf (stderr
, "%p (%s): %s\n",
7805 ((BUFFERP (w
->buffer
)
7806 && STRINGP (XBUFFER (w
->buffer
)->name
))
7807 ? (char *) XSTRING (XBUFFER (w
->buffer
)->name
)->data
7812 #endif /* GLYPH_DEBUG */
7815 /* This counter is used to clear the face cache every once in a while
7816 in redisplay_internal. It is incremented for each redisplay.
7817 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
7820 #define CLEAR_FACE_CACHE_COUNT 10000
7821 static int clear_face_cache_count
;
7823 /* Record the previous terminal frame we displayed. */
7825 static struct frame
*previous_terminal_frame
;
7827 /* Non-zero while redisplay_internal is in progress. */
7832 /* Value is non-zero if all changes in window W, which displays
7833 current_buffer, are in the text between START and END. START is a
7834 buffer position, END is given as a distance from Z. Used in
7835 redisplay_internal for display optimization. */
7838 text_outside_line_unchanged_p (w
, start
, end
)
7842 int unchanged_p
= 1;
7844 /* If text or overlays have changed, see where. */
7845 if (XFASTINT (w
->last_modified
) < MODIFF
7846 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
7848 /* Gap in the line? */
7849 if (GPT
< start
|| Z
- GPT
< end
)
7852 /* Changes start in front of the line, or end after it? */
7854 && (BEG_UNCHANGED
< start
- 1
7855 || END_UNCHANGED
< end
))
7858 /* If selective display, can't optimize if changes start at the
7859 beginning of the line. */
7861 && INTEGERP (current_buffer
->selective_display
)
7862 && XINT (current_buffer
->selective_display
) > 0
7863 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
7871 /* Do a frame update, taking possible shortcuts into account. This is
7872 the main external entry point for redisplay.
7874 If the last redisplay displayed an echo area message and that message
7875 is no longer requested, we clear the echo area or bring back the
7876 mini-buffer if that is in use. */
7881 redisplay_internal (0);
7884 /* Return 1 if point moved out of or into a composition. Otherwise
7885 return 0. PREV_BUF and PREV_PT are the last point buffer and
7886 position. BUF and PT are the current point buffer and position. */
7889 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
7890 struct buffer
*prev_buf
, *buf
;
7897 XSETBUFFER (buffer
, buf
);
7898 /* Check a composition at the last point if point moved within the
7900 if (prev_buf
== buf
)
7903 /* Point didn't move. */
7906 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
7907 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
7908 && COMPOSITION_VALID_P (start
, end
, prop
)
7909 && start
< prev_pt
&& end
> prev_pt
)
7910 /* The last point was within the composition. Return 1 iff
7911 point moved out of the composition. */
7912 return (pt
<= start
|| pt
>= end
);
7915 /* Check a composition at the current point. */
7916 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
7917 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
7918 && COMPOSITION_VALID_P (start
, end
, prop
)
7919 && start
< pt
&& end
> pt
);
7922 /* Reconsider the setting of B->clip_changed which is displayed
7926 reconsider_clip_changes (w
, b
)
7930 if (b
->prevent_redisplay_optimizations_p
)
7931 b
->clip_changed
= 1;
7932 else if (b
->clip_changed
7933 && !NILP (w
->window_end_valid
)
7934 && w
->current_matrix
->buffer
== b
7935 && w
->current_matrix
->zv
== BUF_ZV (b
)
7936 && w
->current_matrix
->begv
== BUF_BEGV (b
))
7937 b
->clip_changed
= 0;
7939 /* If display wasn't paused, and W is not a tool bar window, see if
7940 point has been moved into or out of a composition. In that case,
7941 we set b->clip_changed to 1 to force updating the screen. If
7942 b->clip_changed has already been set to 1, we can skip this
7944 if (!b
->clip_changed
7945 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
7949 if (w
== XWINDOW (selected_window
))
7950 pt
= BUF_PT (current_buffer
);
7952 pt
= marker_position (w
->pointm
);
7954 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
7955 || pt
!= XINT (w
->last_point
))
7956 && check_point_in_composition (w
->current_matrix
->buffer
,
7957 XINT (w
->last_point
),
7958 XBUFFER (w
->buffer
), pt
))
7959 b
->clip_changed
= 1;
7964 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
7965 response to any user action; therefore, we should preserve the echo
7966 area. (Actually, our caller does that job.) Perhaps in the future
7967 avoid recentering windows if it is not necessary; currently that
7968 causes some problems. */
7971 redisplay_internal (preserve_echo_area
)
7972 int preserve_echo_area
;
7974 struct window
*w
= XWINDOW (selected_window
);
7975 struct frame
*f
= XFRAME (w
->frame
);
7977 int must_finish
= 0;
7978 struct text_pos tlbufpos
, tlendpos
;
7979 int number_of_visible_frames
;
7981 struct frame
*sf
= SELECTED_FRAME ();
7983 /* Non-zero means redisplay has to consider all windows on all
7984 frames. Zero means, only selected_window is considered. */
7985 int consider_all_windows_p
;
7987 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
7989 /* No redisplay if running in batch mode or frame is not yet fully
7990 initialized, or redisplay is explicitly turned off by setting
7991 Vinhibit_redisplay. */
7993 || !NILP (Vinhibit_redisplay
)
7994 || !f
->glyphs_initialized_p
)
7997 /* The flag redisplay_performed_directly_p is set by
7998 direct_output_for_insert when it already did the whole screen
7999 update necessary. */
8000 if (redisplay_performed_directly_p
)
8002 redisplay_performed_directly_p
= 0;
8003 if (!hscroll_windows (selected_window
))
8007 #ifdef USE_X_TOOLKIT
8008 if (popup_activated ())
8012 /* I don't think this happens but let's be paranoid. */
8016 /* Record a function that resets redisplaying_p to its old value
8017 when we leave this function. */
8018 count
= BINDING_STACK_SIZE ();
8019 record_unwind_protect (unwind_redisplay
, make_number (redisplaying_p
));
8024 reconsider_clip_changes (w
, current_buffer
);
8026 /* If new fonts have been loaded that make a glyph matrix adjustment
8027 necessary, do it. */
8028 if (fonts_changed_p
)
8030 adjust_glyphs (NULL
);
8031 ++windows_or_buffers_changed
;
8032 fonts_changed_p
= 0;
8035 /* If face_change_count is non-zero, init_iterator will free all
8036 realized faces, which includes the faces referenced from current
8037 matrices. So, we can't reuse current matrices in this case. */
8038 if (face_change_count
)
8039 ++windows_or_buffers_changed
;
8041 if (! FRAME_WINDOW_P (sf
)
8042 && previous_terminal_frame
!= sf
)
8044 /* Since frames on an ASCII terminal share the same display
8045 area, displaying a different frame means redisplay the whole
8047 windows_or_buffers_changed
++;
8048 SET_FRAME_GARBAGED (sf
);
8049 XSETFRAME (Vterminal_frame
, sf
);
8051 previous_terminal_frame
= sf
;
8053 /* Set the visible flags for all frames. Do this before checking
8054 for resized or garbaged frames; they want to know if their frames
8055 are visible. See the comment in frame.h for
8056 FRAME_SAMPLE_VISIBILITY. */
8058 Lisp_Object tail
, frame
;
8060 number_of_visible_frames
= 0;
8062 FOR_EACH_FRAME (tail
, frame
)
8064 struct frame
*f
= XFRAME (frame
);
8066 FRAME_SAMPLE_VISIBILITY (f
);
8067 if (FRAME_VISIBLE_P (f
))
8068 ++number_of_visible_frames
;
8069 clear_desired_matrices (f
);
8073 /* Notice any pending interrupt request to change frame size. */
8074 do_pending_window_change (1);
8076 /* Clear frames marked as garbaged. */
8078 clear_garbaged_frames ();
8080 /* Build menubar and tool-bar items. */
8081 prepare_menu_bars ();
8083 if (windows_or_buffers_changed
)
8084 update_mode_lines
++;
8086 /* Detect case that we need to write or remove a star in the mode line. */
8087 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
8089 w
->update_mode_line
= Qt
;
8090 if (buffer_shared
> 1)
8091 update_mode_lines
++;
8094 /* If %c is in the mode line, update it if needed. */
8095 if (!NILP (w
->column_number_displayed
)
8096 /* This alternative quickly identifies a common case
8097 where no change is needed. */
8098 && !(PT
== XFASTINT (w
->last_point
)
8099 && XFASTINT (w
->last_modified
) >= MODIFF
8100 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
8101 && XFASTINT (w
->column_number_displayed
) != current_column ())
8102 w
->update_mode_line
= Qt
;
8104 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
8106 /* The variable buffer_shared is set in redisplay_window and
8107 indicates that we redisplay a buffer in different windows. See
8109 consider_all_windows_p
= update_mode_lines
|| buffer_shared
> 1;
8111 /* If specs for an arrow have changed, do thorough redisplay
8112 to ensure we remove any arrow that should no longer exist. */
8113 if (! EQ (COERCE_MARKER (Voverlay_arrow_position
), last_arrow_position
)
8114 || ! EQ (Voverlay_arrow_string
, last_arrow_string
))
8115 consider_all_windows_p
= windows_or_buffers_changed
= 1;
8117 /* Normally the message* functions will have already displayed and
8118 updated the echo area, but the frame may have been trashed, or
8119 the update may have been preempted, so display the echo area
8120 again here. Checking both message buffers captures the case that
8121 the echo area should be cleared. */
8122 if (!NILP (echo_area_buffer
[0]) || !NILP (echo_area_buffer
[1]))
8124 int window_height_changed_p
= echo_area_display (0);
8127 if (fonts_changed_p
)
8129 else if (window_height_changed_p
)
8131 consider_all_windows_p
= 1;
8132 ++update_mode_lines
;
8133 ++windows_or_buffers_changed
;
8135 /* If window configuration was changed, frames may have been
8136 marked garbaged. Clear them or we will experience
8137 surprises wrt scrolling. */
8139 clear_garbaged_frames ();
8142 else if (EQ (selected_window
, minibuf_window
)
8143 && (current_buffer
->clip_changed
8144 || XFASTINT (w
->last_modified
) < MODIFF
8145 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
8146 && resize_mini_window (w
, 0))
8148 /* Resized active mini-window to fit the size of what it is
8149 showing if its contents might have changed. */
8151 consider_all_windows_p
= 1;
8152 ++windows_or_buffers_changed
;
8153 ++update_mode_lines
;
8155 /* If window configuration was changed, frames may have been
8156 marked garbaged. Clear them or we will experience
8157 surprises wrt scrolling. */
8159 clear_garbaged_frames ();
8163 /* If showing the region, and mark has changed, we must redisplay
8164 the whole window. The assignment to this_line_start_pos prevents
8165 the optimization directly below this if-statement. */
8166 if (((!NILP (Vtransient_mark_mode
)
8167 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
8168 != !NILP (w
->region_showing
))
8169 || (!NILP (w
->region_showing
)
8170 && !EQ (w
->region_showing
,
8171 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
8172 CHARPOS (this_line_start_pos
) = 0;
8174 /* Optimize the case that only the line containing the cursor in the
8175 selected window has changed. Variables starting with this_ are
8176 set in display_line and record information about the line
8177 containing the cursor. */
8178 tlbufpos
= this_line_start_pos
;
8179 tlendpos
= this_line_end_pos
;
8180 if (!consider_all_windows_p
8181 && CHARPOS (tlbufpos
) > 0
8182 && NILP (w
->update_mode_line
)
8183 && !current_buffer
->clip_changed
8184 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
8185 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
8186 /* Make sure recorded data applies to current buffer, etc. */
8187 && this_line_buffer
== current_buffer
8188 && current_buffer
== XBUFFER (w
->buffer
)
8189 && NILP (w
->force_start
)
8190 /* Point must be on the line that we have info recorded about. */
8191 && PT
>= CHARPOS (tlbufpos
)
8192 && PT
<= Z
- CHARPOS (tlendpos
)
8193 /* All text outside that line, including its final newline,
8194 must be unchanged */
8195 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
8196 CHARPOS (tlendpos
)))
8198 if (CHARPOS (tlbufpos
) > BEGV
8199 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
8200 && (CHARPOS (tlbufpos
) == ZV
8201 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
8202 /* Former continuation line has disappeared by becoming empty */
8204 else if (XFASTINT (w
->last_modified
) < MODIFF
8205 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
8206 || MINI_WINDOW_P (w
))
8208 /* We have to handle the case of continuation around a
8209 wide-column character (See the comment in indent.c around
8212 For instance, in the following case:
8214 -------- Insert --------
8215 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
8216 J_I_ ==> J_I_ `^^' are cursors.
8220 As we have to redraw the line above, we should goto cancel. */
8223 int line_height_before
= this_line_pixel_height
;
8225 /* Note that start_display will handle the case that the
8226 line starting at tlbufpos is a continuation lines. */
8227 start_display (&it
, w
, tlbufpos
);
8229 /* Implementation note: It this still necessary? */
8230 if (it
.current_x
!= this_line_start_x
)
8233 TRACE ((stderr
, "trying display optimization 1\n"));
8234 w
->cursor
.vpos
= -1;
8235 overlay_arrow_seen
= 0;
8236 it
.vpos
= this_line_vpos
;
8237 it
.current_y
= this_line_y
;
8238 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
8241 /* If line contains point, is not continued,
8242 and ends at same distance from eob as before, we win */
8243 if (w
->cursor
.vpos
>= 0
8244 /* Line is not continued, otherwise this_line_start_pos
8245 would have been set to 0 in display_line. */
8246 && CHARPOS (this_line_start_pos
)
8247 /* Line ends as before. */
8248 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
8249 /* Line has same height as before. Otherwise other lines
8250 would have to be shifted up or down. */
8251 && this_line_pixel_height
== line_height_before
)
8253 /* If this is not the window's last line, we must adjust
8254 the charstarts of the lines below. */
8255 if (it
.current_y
< it
.last_visible_y
)
8257 struct glyph_row
*row
8258 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
8259 int delta
, delta_bytes
;
8261 if (Z
- CHARPOS (tlendpos
) == ZV
)
8263 /* This line ends at end of (accessible part of)
8264 buffer. There is no newline to count. */
8266 - CHARPOS (tlendpos
)
8267 - MATRIX_ROW_START_CHARPOS (row
));
8268 delta_bytes
= (Z_BYTE
8269 - BYTEPOS (tlendpos
)
8270 - MATRIX_ROW_START_BYTEPOS (row
));
8274 /* This line ends in a newline. Must take
8275 account of the newline and the rest of the
8276 text that follows. */
8278 - CHARPOS (tlendpos
)
8279 - MATRIX_ROW_START_CHARPOS (row
));
8280 delta_bytes
= (Z_BYTE
8281 - BYTEPOS (tlendpos
)
8282 - MATRIX_ROW_START_BYTEPOS (row
));
8285 increment_matrix_positions (w
->current_matrix
,
8287 w
->current_matrix
->nrows
,
8288 delta
, delta_bytes
);
8291 /* If this row displays text now but previously didn't,
8292 or vice versa, w->window_end_vpos may have to be
8294 if ((it
.glyph_row
- 1)->displays_text_p
)
8296 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
8297 XSETINT (w
->window_end_vpos
, this_line_vpos
);
8299 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
8300 && this_line_vpos
> 0)
8301 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
8302 w
->window_end_valid
= Qnil
;
8304 /* Update hint: No need to try to scroll in update_window. */
8305 w
->desired_matrix
->no_scrolling_p
= 1;
8308 *w
->desired_matrix
->method
= 0;
8309 debug_method_add (w
, "optimization 1");
8316 else if (/* Cursor position hasn't changed. */
8317 PT
== XFASTINT (w
->last_point
)
8318 /* Make sure the cursor was last displayed
8319 in this window. Otherwise we have to reposition it. */
8320 && 0 <= w
->cursor
.vpos
8321 && XINT (w
->height
) > w
->cursor
.vpos
)
8325 do_pending_window_change (1);
8327 /* We used to always goto end_of_redisplay here, but this
8328 isn't enough if we have a blinking cursor. */
8329 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
8330 goto end_of_redisplay
;
8334 /* If highlighting the region, or if the cursor is in the echo area,
8335 then we can't just move the cursor. */
8336 else if (! (!NILP (Vtransient_mark_mode
)
8337 && !NILP (current_buffer
->mark_active
))
8338 && (EQ (selected_window
, current_buffer
->last_selected_window
)
8339 || highlight_nonselected_windows
)
8340 && NILP (w
->region_showing
)
8341 && NILP (Vshow_trailing_whitespace
)
8342 && !cursor_in_echo_area
)
8345 struct glyph_row
*row
;
8347 /* Skip from tlbufpos to PT and see where it is. Note that
8348 PT may be in invisible text. If so, we will end at the
8349 next visible position. */
8350 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
8351 NULL
, DEFAULT_FACE_ID
);
8352 it
.current_x
= this_line_start_x
;
8353 it
.current_y
= this_line_y
;
8354 it
.vpos
= this_line_vpos
;
8356 /* The call to move_it_to stops in front of PT, but
8357 moves over before-strings. */
8358 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
8360 if (it
.vpos
== this_line_vpos
8361 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
8364 xassert (this_line_vpos
== it
.vpos
);
8365 xassert (this_line_y
== it
.current_y
);
8366 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
8374 /* Text changed drastically or point moved off of line. */
8375 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
8378 CHARPOS (this_line_start_pos
) = 0;
8379 consider_all_windows_p
|= buffer_shared
> 1;
8380 ++clear_face_cache_count
;
8383 /* Build desired matrices, and update the display. If
8384 consider_all_windows_p is non-zero, do it for all windows on all
8385 frames. Otherwise do it for selected_window, only. */
8387 if (consider_all_windows_p
)
8389 Lisp_Object tail
, frame
;
8390 int i
, n
= 0, size
= 50;
8391 struct frame
**updated
8392 = (struct frame
**) alloca (size
* sizeof *updated
);
8394 /* Clear the face cache eventually. */
8395 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
8397 clear_face_cache (0);
8398 clear_face_cache_count
= 0;
8401 /* Recompute # windows showing selected buffer. This will be
8402 incremented each time such a window is displayed. */
8405 FOR_EACH_FRAME (tail
, frame
)
8407 struct frame
*f
= XFRAME (frame
);
8409 if (FRAME_WINDOW_P (f
) || f
== sf
)
8411 /* Mark all the scroll bars to be removed; we'll redeem
8412 the ones we want when we redisplay their windows. */
8413 if (condemn_scroll_bars_hook
)
8414 condemn_scroll_bars_hook (f
);
8416 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
8417 redisplay_windows (FRAME_ROOT_WINDOW (f
));
8419 /* Any scroll bars which redisplay_windows should have
8420 nuked should now go away. */
8421 if (judge_scroll_bars_hook
)
8422 judge_scroll_bars_hook (f
);
8424 /* If fonts changed, display again. */
8425 if (fonts_changed_p
)
8428 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
8430 /* See if we have to hscroll. */
8431 if (hscroll_windows (f
->root_window
))
8434 /* Prevent various kinds of signals during display
8435 update. stdio is not robust about handling
8436 signals, which can cause an apparent I/O
8438 if (interrupt_input
)
8442 /* Update the display. */
8443 set_window_update_flags (XWINDOW (f
->root_window
), 1);
8444 pause
|= update_frame (f
, 0, 0);
8450 int nbytes
= size
* sizeof *updated
;
8451 struct frame
**p
= (struct frame
**) alloca (2 * nbytes
);
8452 bcopy (updated
, p
, nbytes
);
8461 /* Do the mark_window_display_accurate after all windows have
8462 been redisplayed because this call resets flags in buffers
8463 which are needed for proper redisplay. */
8464 for (i
= 0; i
< n
; ++i
)
8466 struct frame
*f
= updated
[i
];
8467 mark_window_display_accurate (f
->root_window
, 1);
8468 if (frame_up_to_date_hook
)
8469 frame_up_to_date_hook (f
);
8472 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
8474 Lisp_Object mini_window
;
8475 struct frame
*mini_frame
;
8477 redisplay_window (selected_window
, 1);
8479 /* Compare desired and current matrices, perform output. */
8482 /* If fonts changed, display again. */
8483 if (fonts_changed_p
)
8486 /* Prevent various kinds of signals during display update.
8487 stdio is not robust about handling signals,
8488 which can cause an apparent I/O error. */
8489 if (interrupt_input
)
8493 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
8495 if (hscroll_windows (selected_window
))
8498 XWINDOW (selected_window
)->must_be_updated_p
= 1;
8499 pause
= update_frame (sf
, 0, 0);
8502 /* We may have called echo_area_display at the top of this
8503 function. If the echo area is on another frame, that may
8504 have put text on a frame other than the selected one, so the
8505 above call to update_frame would not have caught it. Catch
8507 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8508 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8510 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
8512 XWINDOW (mini_window
)->must_be_updated_p
= 1;
8513 pause
|= update_frame (mini_frame
, 0, 0);
8514 if (!pause
&& hscroll_windows (mini_window
))
8519 /* If display was paused because of pending input, make sure we do a
8520 thorough update the next time. */
8523 /* Prevent the optimization at the beginning of
8524 redisplay_internal that tries a single-line update of the
8525 line containing the cursor in the selected window. */
8526 CHARPOS (this_line_start_pos
) = 0;
8528 /* Let the overlay arrow be updated the next time. */
8529 if (!NILP (last_arrow_position
))
8531 last_arrow_position
= Qt
;
8532 last_arrow_string
= Qt
;
8535 /* If we pause after scrolling, some rows in the current
8536 matrices of some windows are not valid. */
8537 if (!WINDOW_FULL_WIDTH_P (w
)
8538 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
8539 update_mode_lines
= 1;
8542 /* Now text on frame agrees with windows, so put info into the
8543 windows for partial redisplay to follow. */
8546 register struct buffer
*b
= XBUFFER (w
->buffer
);
8548 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
8549 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
8550 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
8551 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
8553 if (consider_all_windows_p
)
8554 mark_window_display_accurate (FRAME_ROOT_WINDOW (sf
), 1);
8557 XSETFASTINT (w
->last_point
, BUF_PT (b
));
8558 w
->last_cursor
= w
->cursor
;
8559 w
->last_cursor_off_p
= w
->cursor_off_p
;
8561 b
->clip_changed
= 0;
8562 b
->prevent_redisplay_optimizations_p
= 0;
8563 w
->update_mode_line
= Qnil
;
8564 XSETFASTINT (w
->last_modified
, BUF_MODIFF (b
));
8565 XSETFASTINT (w
->last_overlay_modified
, BUF_OVERLAY_MODIFF (b
));
8567 = (BUF_MODIFF (XBUFFER (w
->buffer
)) > BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
8570 /* Record if we are showing a region, so can make sure to
8571 update it fully at next redisplay. */
8572 w
->region_showing
= (!NILP (Vtransient_mark_mode
)
8573 && (EQ (selected_window
,
8574 current_buffer
->last_selected_window
)
8575 || highlight_nonselected_windows
)
8576 && !NILP (XBUFFER (w
->buffer
)->mark_active
)
8577 ? Fmarker_position (XBUFFER (w
->buffer
)->mark
)
8580 w
->window_end_valid
= w
->buffer
;
8581 last_arrow_position
= COERCE_MARKER (Voverlay_arrow_position
);
8582 last_arrow_string
= Voverlay_arrow_string
;
8583 if (frame_up_to_date_hook
!= 0)
8584 (*frame_up_to_date_hook
) (sf
);
8586 w
->current_matrix
->buffer
= b
;
8587 w
->current_matrix
->begv
= BUF_BEGV (b
);
8588 w
->current_matrix
->zv
= BUF_ZV (b
);
8591 update_mode_lines
= 0;
8592 windows_or_buffers_changed
= 0;
8595 /* Start SIGIO interrupts coming again. Having them off during the
8596 code above makes it less likely one will discard output, but not
8597 impossible, since there might be stuff in the system buffer here.
8598 But it is much hairier to try to do anything about that. */
8599 if (interrupt_input
)
8603 /* If a frame has become visible which was not before, redisplay
8604 again, so that we display it. Expose events for such a frame
8605 (which it gets when becoming visible) don't call the parts of
8606 redisplay constructing glyphs, so simply exposing a frame won't
8607 display anything in this case. So, we have to display these
8608 frames here explicitly. */
8611 Lisp_Object tail
, frame
;
8614 FOR_EACH_FRAME (tail
, frame
)
8616 int this_is_visible
= 0;
8618 if (XFRAME (frame
)->visible
)
8619 this_is_visible
= 1;
8620 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
8621 if (XFRAME (frame
)->visible
)
8622 this_is_visible
= 1;
8624 if (this_is_visible
)
8628 if (new_count
!= number_of_visible_frames
)
8629 windows_or_buffers_changed
++;
8632 /* Change frame size now if a change is pending. */
8633 do_pending_window_change (1);
8635 /* If we just did a pending size change, or have additional
8636 visible frames, redisplay again. */
8637 if (windows_or_buffers_changed
&& !pause
)
8642 unbind_to (count
, Qnil
);
8646 /* Redisplay, but leave alone any recent echo area message unless
8647 another message has been requested in its place.
8649 This is useful in situations where you need to redisplay but no
8650 user action has occurred, making it inappropriate for the message
8651 area to be cleared. See tracking_off and
8652 wait_reading_process_input for examples of these situations.
8654 FROM_WHERE is an integer saying from where this function was
8655 called. This is useful for debugging. */
8658 redisplay_preserve_echo_area (from_where
)
8661 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
8663 if (!NILP (echo_area_buffer
[1]))
8665 /* We have a previously displayed message, but no current
8666 message. Redisplay the previous message. */
8667 display_last_displayed_message_p
= 1;
8668 redisplay_internal (1);
8669 display_last_displayed_message_p
= 0;
8672 redisplay_internal (1);
8676 /* Function registered with record_unwind_protect in
8677 redisplay_internal. Clears the flag indicating that a redisplay is
8681 unwind_redisplay (old_redisplaying_p
)
8682 Lisp_Object old_redisplaying_p
;
8684 redisplaying_p
= XFASTINT (old_redisplaying_p
);
8689 /* Mark the display of windows in the window tree rooted at WINDOW as
8690 accurate or inaccurate. If FLAG is non-zero mark display of WINDOW
8691 as accurate. If FLAG is zero arrange for WINDOW to be redisplayed
8692 the next time redisplay_internal is called. */
8695 mark_window_display_accurate (window
, accurate_p
)
8701 for (; !NILP (window
); window
= w
->next
)
8703 w
= XWINDOW (window
);
8705 if (BUFFERP (w
->buffer
))
8707 struct buffer
*b
= XBUFFER (w
->buffer
);
8709 XSETFASTINT (w
->last_modified
,
8710 accurate_p
? BUF_MODIFF (b
) : 0);
8711 XSETFASTINT (w
->last_overlay_modified
,
8712 accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
8713 w
->last_had_star
= (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
)
8716 #if 0 /* I don't think this is necessary because display_line does it.
8718 /* Record if we are showing a region, so can make sure to
8719 update it fully at next redisplay. */
8721 = (!NILP (Vtransient_mark_mode
)
8722 && (w
== XWINDOW (current_buffer
->last_selected_window
)
8723 || highlight_nonselected_windows
)
8724 && (!NILP (b
->mark_active
)
8725 ? Fmarker_position (b
->mark
)
8731 b
->clip_changed
= 0;
8732 b
->prevent_redisplay_optimizations_p
= 0;
8733 w
->current_matrix
->buffer
= b
;
8734 w
->current_matrix
->begv
= BUF_BEGV (b
);
8735 w
->current_matrix
->zv
= BUF_ZV (b
);
8736 w
->last_cursor
= w
->cursor
;
8737 w
->last_cursor_off_p
= w
->cursor_off_p
;
8738 if (w
== XWINDOW (selected_window
))
8739 w
->last_point
= make_number (BUF_PT (b
));
8741 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
8745 w
->window_end_valid
= w
->buffer
;
8746 w
->update_mode_line
= Qnil
;
8748 if (!NILP (w
->vchild
))
8749 mark_window_display_accurate (w
->vchild
, accurate_p
);
8750 if (!NILP (w
->hchild
))
8751 mark_window_display_accurate (w
->hchild
, accurate_p
);
8756 last_arrow_position
= COERCE_MARKER (Voverlay_arrow_position
);
8757 last_arrow_string
= Voverlay_arrow_string
;
8761 /* Force a thorough redisplay the next time by setting
8762 last_arrow_position and last_arrow_string to t, which is
8763 unequal to any useful value of Voverlay_arrow_... */
8764 last_arrow_position
= Qt
;
8765 last_arrow_string
= Qt
;
8770 /* Return value in display table DP (Lisp_Char_Table *) for character
8771 C. Since a display table doesn't have any parent, we don't have to
8772 follow parent. Do not call this function directly but use the
8773 macro DISP_CHAR_VECTOR. */
8776 disp_char_vector (dp
, c
)
8777 struct Lisp_Char_Table
*dp
;
8783 if (SINGLE_BYTE_CHAR_P (c
))
8784 return (dp
->contents
[c
]);
8786 SPLIT_CHAR (c
, code
[0], code
[1], code
[2]);
8789 else if (code
[2] < 32)
8792 /* Here, the possible range of code[0] (== charset ID) is
8793 128..max_charset. Since the top level char table contains data
8794 for multibyte characters after 256th element, we must increment
8795 code[0] by 128 to get a correct index. */
8797 code
[3] = -1; /* anchor */
8799 for (i
= 0; code
[i
] >= 0; i
++, dp
= XCHAR_TABLE (val
))
8801 val
= dp
->contents
[code
[i
]];
8802 if (!SUB_CHAR_TABLE_P (val
))
8803 return (NILP (val
) ? dp
->defalt
: val
);
8806 /* Here, val is a sub char table. We return the default value of
8808 return (dp
->defalt
);
8813 /***********************************************************************
8815 ***********************************************************************/
8817 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
8820 redisplay_windows (window
)
8823 while (!NILP (window
))
8825 struct window
*w
= XWINDOW (window
);
8827 if (!NILP (w
->hchild
))
8828 redisplay_windows (w
->hchild
);
8829 else if (!NILP (w
->vchild
))
8830 redisplay_windows (w
->vchild
);
8832 redisplay_window (window
, 0);
8839 /* Set cursor position of W. PT is assumed to be displayed in ROW.
8840 DELTA is the number of bytes by which positions recorded in ROW
8841 differ from current buffer positions. */
8844 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
8846 struct glyph_row
*row
;
8847 struct glyph_matrix
*matrix
;
8848 int delta
, delta_bytes
, dy
, dvpos
;
8850 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
8851 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
8853 int pt_old
= PT
- delta
;
8855 /* Skip over glyphs not having an object at the start of the row.
8856 These are special glyphs like truncation marks on terminal
8858 if (row
->displays_text_p
)
8860 && INTEGERP (glyph
->object
)
8861 && glyph
->charpos
< 0)
8863 x
+= glyph
->pixel_width
;
8868 && !INTEGERP (glyph
->object
)
8869 && (!BUFFERP (glyph
->object
)
8870 || glyph
->charpos
< pt_old
))
8872 x
+= glyph
->pixel_width
;
8876 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
8878 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
8879 w
->cursor
.y
= row
->y
+ dy
;
8881 if (w
== XWINDOW (selected_window
))
8883 if (!row
->continued_p
8884 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
8887 this_line_buffer
= XBUFFER (w
->buffer
);
8889 CHARPOS (this_line_start_pos
)
8890 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
8891 BYTEPOS (this_line_start_pos
)
8892 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
8894 CHARPOS (this_line_end_pos
)
8895 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
8896 BYTEPOS (this_line_end_pos
)
8897 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
8899 this_line_y
= w
->cursor
.y
;
8900 this_line_pixel_height
= row
->height
;
8901 this_line_vpos
= w
->cursor
.vpos
;
8902 this_line_start_x
= row
->x
;
8905 CHARPOS (this_line_start_pos
) = 0;
8910 /* Run window scroll functions, if any, for WINDOW with new window
8911 start STARTP. Sets the window start of WINDOW to that position.
8913 We assume that the window's buffer is really current. */
8915 static INLINE
struct text_pos
8916 run_window_scroll_functions (window
, startp
)
8918 struct text_pos startp
;
8920 struct window
*w
= XWINDOW (window
);
8921 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
8923 if (current_buffer
!= XBUFFER (w
->buffer
))
8926 if (!NILP (Vwindow_scroll_functions
))
8928 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
8929 make_number (CHARPOS (startp
)));
8930 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
8931 /* In case the hook functions switch buffers. */
8932 if (current_buffer
!= XBUFFER (w
->buffer
))
8933 set_buffer_internal_1 (XBUFFER (w
->buffer
));
8940 /* Modify the desired matrix of window W and W->vscroll so that the
8941 line containing the cursor is fully visible. */
8944 make_cursor_line_fully_visible (w
)
8947 struct glyph_matrix
*matrix
;
8948 struct glyph_row
*row
;
8951 /* It's not always possible to find the cursor, e.g, when a window
8952 is full of overlay strings. Don't do anything in that case. */
8953 if (w
->cursor
.vpos
< 0)
8956 matrix
= w
->desired_matrix
;
8957 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
8959 /* If the cursor row is not partially visible, there's nothing
8961 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (row
))
8964 /* If the row the cursor is in is taller than the window's height,
8965 it's not clear what to do, so do nothing. */
8966 window_height
= window_box_height (w
);
8967 if (row
->height
>= window_height
)
8970 if (MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (w
, row
))
8972 int dy
= row
->height
- row
->visible_height
;
8975 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
8977 else /* MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P (w, row)) */
8979 int dy
= - (row
->height
- row
->visible_height
);
8982 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
8985 /* When we change the cursor y-position of the selected window,
8986 change this_line_y as well so that the display optimization for
8987 the cursor line of the selected window in redisplay_internal uses
8988 the correct y-position. */
8989 if (w
== XWINDOW (selected_window
))
8990 this_line_y
= w
->cursor
.y
;
8994 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
8995 non-zero means only WINDOW is redisplayed in redisplay_internal.
8996 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
8997 in redisplay_window to bring a partially visible line into view in
8998 the case that only the cursor has moved.
9002 1 if scrolling succeeded
9004 0 if scrolling didn't find point.
9006 -1 if new fonts have been loaded so that we must interrupt
9007 redisplay, adjust glyph matrices, and try again. */
9010 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
9011 scroll_step
, temp_scroll_step
)
9013 int just_this_one_p
;
9014 int scroll_conservatively
, scroll_step
;
9015 int temp_scroll_step
;
9017 struct window
*w
= XWINDOW (window
);
9018 struct frame
*f
= XFRAME (w
->frame
);
9019 struct text_pos scroll_margin_pos
;
9020 struct text_pos pos
;
9021 struct text_pos startp
;
9023 Lisp_Object window_end
;
9024 int this_scroll_margin
;
9028 int amount_to_scroll
= 0;
9029 Lisp_Object aggressive
;
9033 debug_method_add (w
, "try_scrolling");
9036 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
9038 /* Compute scroll margin height in pixels. We scroll when point is
9039 within this distance from the top or bottom of the window. */
9040 if (scroll_margin
> 0)
9042 this_scroll_margin
= min (scroll_margin
, XINT (w
->height
) / 4);
9043 this_scroll_margin
*= CANON_Y_UNIT (f
);
9046 this_scroll_margin
= 0;
9048 /* Compute how much we should try to scroll maximally to bring point
9050 if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
9051 scroll_max
= max (scroll_step
,
9052 max (scroll_conservatively
, temp_scroll_step
));
9053 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
9054 || NUMBERP (current_buffer
->scroll_up_aggressively
))
9055 /* We're trying to scroll because of aggressive scrolling
9056 but no scroll_step is set. Choose an arbitrary one. Maybe
9057 there should be a variable for this. */
9061 scroll_max
*= CANON_Y_UNIT (f
);
9063 /* Decide whether we have to scroll down. Start at the window end
9064 and move this_scroll_margin up to find the position of the scroll
9066 window_end
= Fwindow_end (window
, Qt
);
9067 CHARPOS (scroll_margin_pos
) = XINT (window_end
);
9068 BYTEPOS (scroll_margin_pos
) = CHAR_TO_BYTE (CHARPOS (scroll_margin_pos
));
9069 if (this_scroll_margin
)
9071 start_display (&it
, w
, scroll_margin_pos
);
9072 move_it_vertically (&it
, - this_scroll_margin
);
9073 scroll_margin_pos
= it
.current
.pos
;
9076 if (PT
>= CHARPOS (scroll_margin_pos
))
9080 /* Point is in the scroll margin at the bottom of the window, or
9081 below. Compute a new window start that makes point visible. */
9083 /* Compute the distance from the scroll margin to PT.
9084 Give up if the distance is greater than scroll_max. */
9085 start_display (&it
, w
, scroll_margin_pos
);
9087 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
9088 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9090 /* With a scroll_margin of 0, scroll_margin_pos is at the window
9091 end, which is one line below the window. The iterator's
9092 current_y will be same as y0 in that case, but we have to
9093 scroll a line to make PT visible. That's the reason why 1 is
9095 dy
= 1 + it
.current_y
- y0
;
9097 if (dy
> scroll_max
)
9100 /* Move the window start down. If scrolling conservatively,
9101 move it just enough down to make point visible. If
9102 scroll_step is set, move it down by scroll_step. */
9103 start_display (&it
, w
, startp
);
9105 if (scroll_conservatively
)
9107 = max (max (dy
, CANON_Y_UNIT (f
)),
9108 CANON_Y_UNIT (f
) * max (scroll_step
, temp_scroll_step
));
9109 else if (scroll_step
|| temp_scroll_step
)
9110 amount_to_scroll
= scroll_max
;
9113 aggressive
= current_buffer
->scroll_down_aggressively
;
9114 height
= (WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE (w
)
9115 - WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
));
9116 if (NUMBERP (aggressive
))
9117 amount_to_scroll
= XFLOATINT (aggressive
) * height
;
9120 if (amount_to_scroll
<= 0)
9123 move_it_vertically (&it
, amount_to_scroll
);
9124 startp
= it
.current
.pos
;
9128 /* See if point is inside the scroll margin at the top of the
9130 scroll_margin_pos
= startp
;
9131 if (this_scroll_margin
)
9133 start_display (&it
, w
, startp
);
9134 move_it_vertically (&it
, this_scroll_margin
);
9135 scroll_margin_pos
= it
.current
.pos
;
9138 if (PT
< CHARPOS (scroll_margin_pos
))
9140 /* Point is in the scroll margin at the top of the window or
9141 above what is displayed in the window. */
9144 /* Compute the vertical distance from PT to the scroll
9145 margin position. Give up if distance is greater than
9147 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
9148 start_display (&it
, w
, pos
);
9150 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
9151 it
.last_visible_y
, -1,
9152 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9153 dy
= it
.current_y
- y0
;
9154 if (dy
> scroll_max
)
9157 /* Compute new window start. */
9158 start_display (&it
, w
, startp
);
9160 if (scroll_conservatively
)
9162 max (dy
, CANON_Y_UNIT (f
) * max (scroll_step
, temp_scroll_step
));
9163 else if (scroll_step
|| temp_scroll_step
)
9164 amount_to_scroll
= scroll_max
;
9167 aggressive
= current_buffer
->scroll_up_aggressively
;
9168 height
= (WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE (w
)
9169 - WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
));
9170 if (NUMBERP (aggressive
))
9171 amount_to_scroll
= XFLOATINT (aggressive
) * height
;
9174 if (amount_to_scroll
<= 0)
9177 move_it_vertically (&it
, - amount_to_scroll
);
9178 startp
= it
.current
.pos
;
9182 /* Run window scroll functions. */
9183 startp
= run_window_scroll_functions (window
, startp
);
9185 /* Display the window. Give up if new fonts are loaded, or if point
9187 if (!try_window (window
, startp
))
9189 else if (w
->cursor
.vpos
< 0)
9191 clear_glyph_matrix (w
->desired_matrix
);
9196 /* Maybe forget recorded base line for line number display. */
9197 if (!just_this_one_p
9198 || current_buffer
->clip_changed
9199 || BEG_UNCHANGED
< CHARPOS (startp
))
9200 w
->base_line_number
= Qnil
;
9202 /* If cursor ends up on a partially visible line, shift display
9203 lines up or down. */
9204 make_cursor_line_fully_visible (w
);
9212 /* Compute a suitable window start for window W if display of W starts
9213 on a continuation line. Value is non-zero if a new window start
9216 The new window start will be computed, based on W's width, starting
9217 from the start of the continued line. It is the start of the
9218 screen line with the minimum distance from the old start W->start. */
9221 compute_window_start_on_continuation_line (w
)
9224 struct text_pos pos
, start_pos
;
9225 int window_start_changed_p
= 0;
9227 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
9229 /* If window start is on a continuation line... Window start may be
9230 < BEGV in case there's invisible text at the start of the
9231 buffer (M-x rmail, for example). */
9232 if (CHARPOS (start_pos
) > BEGV
9233 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
9236 struct glyph_row
*row
;
9238 /* Handle the case that the window start is out of range. */
9239 if (CHARPOS (start_pos
) < BEGV
)
9240 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
9241 else if (CHARPOS (start_pos
) > ZV
)
9242 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
9244 /* Find the start of the continued line. This should be fast
9245 because scan_buffer is fast (newline cache). */
9246 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
9247 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
9248 row
, DEFAULT_FACE_ID
);
9249 reseat_at_previous_visible_line_start (&it
);
9251 /* If the line start is "too far" away from the window start,
9252 say it takes too much time to compute a new window start. */
9253 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
9254 < XFASTINT (w
->height
) * XFASTINT (w
->width
))
9256 int min_distance
, distance
;
9258 /* Move forward by display lines to find the new window
9259 start. If window width was enlarged, the new start can
9260 be expected to be > the old start. If window width was
9261 decreased, the new window start will be < the old start.
9262 So, we're looking for the display line start with the
9263 minimum distance from the old window start. */
9264 pos
= it
.current
.pos
;
9265 min_distance
= INFINITY
;
9266 while ((distance
= abs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
9267 distance
< min_distance
)
9269 min_distance
= distance
;
9270 pos
= it
.current
.pos
;
9271 move_it_by_lines (&it
, 1, 0);
9274 /* Set the window start there. */
9275 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
9276 window_start_changed_p
= 1;
9280 return window_start_changed_p
;
9284 /* Try cursor movement in case text has not changes in window WINDOW,
9285 with window start STARTP. Value is
9289 0 if this method cannot be used
9291 -1 if we know we have to scroll the display. *SCROLL_STEP is
9292 set to 1, under certain circumstances, if we want to scroll as
9293 if scroll-step were set to 1. See the code. */
9296 try_cursor_movement (window
, startp
, scroll_step
)
9298 struct text_pos startp
;
9301 struct window
*w
= XWINDOW (window
);
9302 struct frame
*f
= XFRAME (w
->frame
);
9305 /* Handle case where text has not changed, only point, and it has
9306 not moved off the frame. */
9307 if (/* Point may be in this window. */
9308 PT
>= CHARPOS (startp
)
9309 /* Selective display hasn't changed. */
9310 && !current_buffer
->clip_changed
9311 /* Function force-mode-line-update is used to force a thorough
9312 redisplay. It sets either windows_or_buffers_changed or
9313 update_mode_lines. So don't take a shortcut here for these
9315 && !update_mode_lines
9316 && !windows_or_buffers_changed
9317 /* Can't use this case if highlighting a region. When a
9318 region exists, cursor movement has to do more than just
9320 && !(!NILP (Vtransient_mark_mode
)
9321 && !NILP (current_buffer
->mark_active
))
9322 && NILP (w
->region_showing
)
9323 && NILP (Vshow_trailing_whitespace
)
9324 /* Right after splitting windows, last_point may be nil. */
9325 && INTEGERP (w
->last_point
)
9326 /* This code is not used for mini-buffer for the sake of the case
9327 of redisplaying to replace an echo area message; since in
9328 that case the mini-buffer contents per se are usually
9329 unchanged. This code is of no real use in the mini-buffer
9330 since the handling of this_line_start_pos, etc., in redisplay
9331 handles the same cases. */
9332 && !EQ (window
, minibuf_window
)
9333 /* When splitting windows or for new windows, it happens that
9334 redisplay is called with a nil window_end_vpos or one being
9335 larger than the window. This should really be fixed in
9336 window.c. I don't have this on my list, now, so we do
9337 approximately the same as the old redisplay code. --gerd. */
9338 && INTEGERP (w
->window_end_vpos
)
9339 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
9340 && (FRAME_WINDOW_P (f
)
9341 || !MARKERP (Voverlay_arrow_position
)
9342 || current_buffer
!= XMARKER (Voverlay_arrow_position
)->buffer
))
9344 int this_scroll_margin
;
9345 struct glyph_row
*row
;
9348 debug_method_add (w
, "cursor movement");
9351 /* Scroll if point within this distance from the top or bottom
9352 of the window. This is a pixel value. */
9353 this_scroll_margin
= max (0, scroll_margin
);
9354 this_scroll_margin
= min (this_scroll_margin
, XFASTINT (w
->height
) / 4);
9355 this_scroll_margin
*= CANON_Y_UNIT (f
);
9357 /* Start with the row the cursor was displayed during the last
9358 not paused redisplay. Give up if that row is not valid. */
9359 if (w
->last_cursor
.vpos
< 0
9360 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
9364 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
9365 if (row
->mode_line_p
)
9367 if (!row
->enabled_p
)
9374 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
9376 if (PT
> XFASTINT (w
->last_point
))
9378 /* Point has moved forward. */
9379 while (MATRIX_ROW_END_CHARPOS (row
) < PT
9380 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
9382 xassert (row
->enabled_p
);
9386 /* The end position of a row equals the start position
9387 of the next row. If PT is there, we would rather
9388 display it in the next line. */
9389 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
9390 && MATRIX_ROW_END_CHARPOS (row
) == PT
9391 && !cursor_row_p (w
, row
))
9394 /* If within the scroll margin, scroll. Note that
9395 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
9396 the next line would be drawn, and that
9397 this_scroll_margin can be zero. */
9398 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
9399 || PT
> MATRIX_ROW_END_CHARPOS (row
)
9400 /* Line is completely visible last line in window
9401 and PT is to be set in the next line. */
9402 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
9403 && PT
== MATRIX_ROW_END_CHARPOS (row
)
9404 && !row
->ends_at_zv_p
9405 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
9408 else if (PT
< XFASTINT (w
->last_point
))
9410 /* Cursor has to be moved backward. Note that PT >=
9411 CHARPOS (startp) because of the outer
9413 while (!row
->mode_line_p
9414 && (MATRIX_ROW_START_CHARPOS (row
) > PT
9415 || (MATRIX_ROW_START_CHARPOS (row
) == PT
9416 && MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)))
9417 && (row
->y
> this_scroll_margin
9418 || CHARPOS (startp
) == BEGV
))
9420 xassert (row
->enabled_p
);
9424 /* Consider the following case: Window starts at BEGV,
9425 there is invisible, intangible text at BEGV, so that
9426 display starts at some point START > BEGV. It can
9427 happen that we are called with PT somewhere between
9428 BEGV and START. Try to handle that case. */
9429 if (row
< w
->current_matrix
->rows
9430 || row
->mode_line_p
)
9432 row
= w
->current_matrix
->rows
;
9433 if (row
->mode_line_p
)
9437 /* Due to newlines in overlay strings, we may have to
9438 skip forward over overlay strings. */
9439 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
9440 && MATRIX_ROW_END_CHARPOS (row
) == PT
9441 && !cursor_row_p (w
, row
))
9444 /* If within the scroll margin, scroll. */
9445 if (row
->y
< this_scroll_margin
9446 && CHARPOS (startp
) != BEGV
)
9450 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
9451 || PT
> MATRIX_ROW_END_CHARPOS (row
))
9453 /* if PT is not in the glyph row, give up. */
9456 else if (MATRIX_ROW_PARTIALLY_VISIBLE_P (row
))
9458 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
9459 && !row
->ends_at_zv_p
9460 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
9462 else if (row
->height
> window_box_height (w
))
9464 /* If we end up in a partially visible line, let's
9465 make it fully visible, except when it's taller
9466 than the window, in which case we can't do much
9473 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
9474 try_window (window
, startp
);
9475 make_cursor_line_fully_visible (w
);
9483 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
9493 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
9494 selected_window is redisplayed. */
9497 redisplay_window (window
, just_this_one_p
)
9499 int just_this_one_p
;
9501 struct window
*w
= XWINDOW (window
);
9502 struct frame
*f
= XFRAME (w
->frame
);
9503 struct buffer
*buffer
= XBUFFER (w
->buffer
);
9504 struct buffer
*old
= current_buffer
;
9505 struct text_pos lpoint
, opoint
, startp
;
9506 int update_mode_line
;
9509 /* Record it now because it's overwritten. */
9510 int current_matrix_up_to_date_p
= 0;
9511 int temp_scroll_step
= 0;
9512 int count
= BINDING_STACK_SIZE ();
9515 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
9518 /* W must be a leaf window here. */
9519 xassert (!NILP (w
->buffer
));
9521 *w
->desired_matrix
->method
= 0;
9524 specbind (Qinhibit_point_motion_hooks
, Qt
);
9526 reconsider_clip_changes (w
, buffer
);
9528 /* Has the mode line to be updated? */
9529 update_mode_line
= (!NILP (w
->update_mode_line
)
9530 || update_mode_lines
9531 || buffer
->clip_changed
);
9533 if (MINI_WINDOW_P (w
))
9535 if (w
== XWINDOW (echo_area_window
)
9536 && !NILP (echo_area_buffer
[0]))
9538 if (update_mode_line
)
9539 /* We may have to update a tty frame's menu bar or a
9540 tool-bar. Example `M-x C-h C-h C-g'. */
9541 goto finish_menu_bars
;
9543 /* We've already displayed the echo area glyphs in this window. */
9544 goto finish_scroll_bars
;
9546 else if (w
!= XWINDOW (minibuf_window
))
9548 /* W is a mini-buffer window, but it's not the currently
9549 active one, so clear it. */
9550 int yb
= window_text_bottom_y (w
);
9551 struct glyph_row
*row
;
9554 for (y
= 0, row
= w
->desired_matrix
->rows
;
9556 y
+= row
->height
, ++row
)
9557 blank_row (w
, row
, y
);
9558 goto finish_scroll_bars
;
9562 /* Otherwise set up data on this window; select its buffer and point
9564 /* Really select the buffer, for the sake of buffer-local
9566 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9567 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
9569 current_matrix_up_to_date_p
9570 = (!NILP (w
->window_end_valid
)
9571 && !current_buffer
->clip_changed
9572 && XFASTINT (w
->last_modified
) >= MODIFF
9573 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
9575 /* When windows_or_buffers_changed is non-zero, we can't rely on
9576 the window end being valid, so set it to nil there. */
9577 if (windows_or_buffers_changed
)
9579 /* If window starts on a continuation line, maybe adjust the
9580 window start in case the window's width changed. */
9581 if (XMARKER (w
->start
)->buffer
== current_buffer
)
9582 compute_window_start_on_continuation_line (w
);
9584 w
->window_end_valid
= Qnil
;
9587 /* Some sanity checks. */
9588 CHECK_WINDOW_END (w
);
9589 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
9591 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
9594 /* If %c is in mode line, update it if needed. */
9595 if (!NILP (w
->column_number_displayed
)
9596 /* This alternative quickly identifies a common case
9597 where no change is needed. */
9598 && !(PT
== XFASTINT (w
->last_point
)
9599 && XFASTINT (w
->last_modified
) >= MODIFF
9600 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
9601 && XFASTINT (w
->column_number_displayed
) != current_column ())
9602 update_mode_line
= 1;
9604 /* Count number of windows showing the selected buffer. An indirect
9605 buffer counts as its base buffer. */
9606 if (!just_this_one_p
)
9608 struct buffer
*current_base
, *window_base
;
9609 current_base
= current_buffer
;
9610 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
9611 if (current_base
->base_buffer
)
9612 current_base
= current_base
->base_buffer
;
9613 if (window_base
->base_buffer
)
9614 window_base
= window_base
->base_buffer
;
9615 if (current_base
== window_base
)
9619 /* Point refers normally to the selected window. For any other
9620 window, set up appropriate value. */
9621 if (!EQ (window
, selected_window
))
9623 int new_pt
= XMARKER (w
->pointm
)->charpos
;
9624 int new_pt_byte
= marker_byte_position (w
->pointm
);
9628 new_pt_byte
= BEGV_BYTE
;
9629 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
9631 else if (new_pt
> (ZV
- 1))
9634 new_pt_byte
= ZV_BYTE
;
9635 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
9638 /* We don't use SET_PT so that the point-motion hooks don't run. */
9639 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
9642 /* If any of the character widths specified in the display table
9643 have changed, invalidate the width run cache. It's true that
9644 this may be a bit late to catch such changes, but the rest of
9645 redisplay goes (non-fatally) haywire when the display table is
9646 changed, so why should we worry about doing any better? */
9647 if (current_buffer
->width_run_cache
)
9649 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
9651 if (! disptab_matches_widthtab (disptab
,
9652 XVECTOR (current_buffer
->width_table
)))
9654 invalidate_region_cache (current_buffer
,
9655 current_buffer
->width_run_cache
,
9657 recompute_width_table (current_buffer
, disptab
);
9661 /* If window-start is screwed up, choose a new one. */
9662 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
9665 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
9667 /* If someone specified a new starting point but did not insist,
9668 check whether it can be used. */
9669 if (!NILP (w
->optional_new_start
)
9670 && CHARPOS (startp
) >= BEGV
9671 && CHARPOS (startp
) <= ZV
)
9673 w
->optional_new_start
= Qnil
;
9674 start_display (&it
, w
, startp
);
9675 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
9676 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9677 if (IT_CHARPOS (it
) == PT
)
9678 w
->force_start
= Qt
;
9681 /* Handle case where place to start displaying has been specified,
9682 unless the specified location is outside the accessible range. */
9683 if (!NILP (w
->force_start
)
9684 || w
->frozen_window_start_p
)
9686 w
->force_start
= Qnil
;
9688 w
->window_end_valid
= Qnil
;
9690 /* Forget any recorded base line for line number display. */
9691 if (!current_matrix_up_to_date_p
9692 || current_buffer
->clip_changed
)
9693 w
->base_line_number
= Qnil
;
9695 /* Redisplay the mode line. Select the buffer properly for that.
9696 Also, run the hook window-scroll-functions
9697 because we have scrolled. */
9698 /* Note, we do this after clearing force_start because
9699 if there's an error, it is better to forget about force_start
9700 than to get into an infinite loop calling the hook functions
9701 and having them get more errors. */
9702 if (!update_mode_line
9703 || ! NILP (Vwindow_scroll_functions
))
9705 update_mode_line
= 1;
9706 w
->update_mode_line
= Qt
;
9707 startp
= run_window_scroll_functions (window
, startp
);
9710 XSETFASTINT (w
->last_modified
, 0);
9711 XSETFASTINT (w
->last_overlay_modified
, 0);
9712 if (CHARPOS (startp
) < BEGV
)
9713 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
9714 else if (CHARPOS (startp
) > ZV
)
9715 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
9717 /* Redisplay, then check if cursor has been set during the
9718 redisplay. Give up if new fonts were loaded. */
9719 if (!try_window (window
, startp
))
9721 w
->force_start
= Qt
;
9722 clear_glyph_matrix (w
->desired_matrix
);
9723 goto finish_scroll_bars
;
9726 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
9728 /* If point does not appear, try to move point so it does
9729 appear. The desired matrix has been built above, so we
9732 struct glyph_row
*row
;
9734 window_height
= window_box_height (w
) / 2;
9735 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
9736 while (MATRIX_ROW_BOTTOM_Y (row
) < window_height
)
9739 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
9740 MATRIX_ROW_START_BYTEPOS (row
));
9742 if (w
!= XWINDOW (selected_window
))
9743 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
9744 else if (current_buffer
== old
)
9745 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
9747 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
9749 /* If we are highlighting the region, then we just changed
9750 the region, so redisplay to show it. */
9751 if (!NILP (Vtransient_mark_mode
)
9752 && !NILP (current_buffer
->mark_active
))
9754 clear_glyph_matrix (w
->desired_matrix
);
9755 if (!try_window (window
, startp
))
9756 goto finish_scroll_bars
;
9760 make_cursor_line_fully_visible (w
);
9762 debug_method_add (w
, "forced window start");
9767 /* Handle case where text has not changed, only point, and it has
9768 not moved off the frame. */
9769 if (current_matrix_up_to_date_p
9770 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
9778 /* If current starting point was originally the beginning of a line
9779 but no longer is, find a new starting point. */
9780 else if (!NILP (w
->start_at_line_beg
)
9781 && !(CHARPOS (startp
) <= BEGV
9782 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
9785 debug_method_add (w
, "recenter 1");
9790 /* Try scrolling with try_window_id. */
9791 else if (/* Windows and buffers haven't changed. */
9792 !windows_or_buffers_changed
9793 /* Window must be either use window-based redisplay or
9795 && (FRAME_WINDOW_P (f
)
9796 || (line_ins_del_ok
&& WINDOW_FULL_WIDTH_P (w
)))
9797 && !MINI_WINDOW_P (w
)
9798 /* Point is not known NOT to appear in window. */
9799 && PT
>= CHARPOS (startp
)
9800 && XFASTINT (w
->last_modified
)
9801 /* Window is not hscrolled. */
9802 && XFASTINT (w
->hscroll
) == 0
9803 /* Selective display has not changed. */
9804 && !current_buffer
->clip_changed
9805 /* Current matrix is up to date. */
9806 && !NILP (w
->window_end_valid
)
9807 /* Can't use this case if highlighting a region because
9808 a cursor movement will do more than just set the cursor. */
9809 && !(!NILP (Vtransient_mark_mode
)
9810 && !NILP (current_buffer
->mark_active
))
9811 && NILP (w
->region_showing
)
9812 && NILP (Vshow_trailing_whitespace
)
9813 /* Overlay arrow position and string not changed. */
9814 && EQ (last_arrow_position
, COERCE_MARKER (Voverlay_arrow_position
))
9815 && EQ (last_arrow_string
, Voverlay_arrow_string
)
9816 /* Value is > 0 if update has been done, it is -1 if we
9817 know that the same window start will not work. It is 0
9818 if unsuccessful for some other reason. */
9819 && (tem
= try_window_id (w
)) != 0)
9822 debug_method_add (w
, "try_window_id %d", tem
);
9825 if (fonts_changed_p
)
9826 goto finish_scroll_bars
;
9830 /* Otherwise try_window_id has returned -1 which means that we
9831 don't want the alternative below this comment to execute. */
9833 else if (CHARPOS (startp
) >= BEGV
9834 && CHARPOS (startp
) <= ZV
9835 && PT
>= CHARPOS (startp
)
9836 && (CHARPOS (startp
) < ZV
9837 /* Avoid starting at end of buffer. */
9838 || CHARPOS (startp
) == BEGV
9839 || (XFASTINT (w
->last_modified
) >= MODIFF
9840 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
9843 debug_method_add (w
, "same window start");
9846 /* Try to redisplay starting at same place as before.
9847 If point has not moved off frame, accept the results. */
9848 if (!current_matrix_up_to_date_p
9849 /* Don't use try_window_reusing_current_matrix in this case
9850 because a window scroll function can have changed the
9852 || !NILP (Vwindow_scroll_functions
)
9853 || MINI_WINDOW_P (w
)
9854 || !try_window_reusing_current_matrix (w
))
9856 IF_DEBUG (debug_method_add (w
, "1"));
9857 try_window (window
, startp
);
9860 if (fonts_changed_p
)
9861 goto finish_scroll_bars
;
9863 if (w
->cursor
.vpos
>= 0)
9865 if (!just_this_one_p
9866 || current_buffer
->clip_changed
9867 || BEG_UNCHANGED
< CHARPOS (startp
))
9868 /* Forget any recorded base line for line number display. */
9869 w
->base_line_number
= Qnil
;
9871 make_cursor_line_fully_visible (w
);
9875 clear_glyph_matrix (w
->desired_matrix
);
9880 XSETFASTINT (w
->last_modified
, 0);
9881 XSETFASTINT (w
->last_overlay_modified
, 0);
9883 /* Redisplay the mode line. Select the buffer properly for that. */
9884 if (!update_mode_line
)
9886 update_mode_line
= 1;
9887 w
->update_mode_line
= Qt
;
9890 /* Try to scroll by specified few lines. */
9891 if ((scroll_conservatively
9894 || NUMBERP (current_buffer
->scroll_up_aggressively
)
9895 || NUMBERP (current_buffer
->scroll_down_aggressively
))
9896 && !current_buffer
->clip_changed
9897 && CHARPOS (startp
) >= BEGV
9898 && CHARPOS (startp
) <= ZV
)
9900 /* The function returns -1 if new fonts were loaded, 1 if
9901 successful, 0 if not successful. */
9902 int rc
= try_scrolling (window
, just_this_one_p
,
9903 scroll_conservatively
,
9909 goto finish_scroll_bars
;
9912 /* Finally, just choose place to start which centers point */
9917 debug_method_add (w
, "recenter");
9920 /* w->vscroll = 0; */
9922 /* Forget any previously recorded base line for line number display. */
9923 if (!current_matrix_up_to_date_p
9924 || current_buffer
->clip_changed
)
9925 w
->base_line_number
= Qnil
;
9927 /* Move backward half the height of the window. */
9928 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
9929 it
.current_y
= it
.last_visible_y
;
9930 move_it_vertically_backward (&it
, it
.last_visible_y
/ 2);
9931 xassert (IT_CHARPOS (it
) >= BEGV
);
9933 /* The function move_it_vertically_backward may move over more
9934 than the specified y-distance. If it->w is small, e.g. a
9935 mini-buffer window, we may end up in front of the window's
9936 display area. Start displaying at the start of the line
9937 containing PT in this case. */
9938 if (it
.current_y
<= 0)
9940 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
9941 move_it_vertically (&it
, 0);
9942 xassert (IT_CHARPOS (it
) <= PT
);
9946 it
.current_x
= it
.hpos
= 0;
9948 /* Set startp here explicitly in case that helps avoid an infinite loop
9949 in case the window-scroll-functions functions get errors. */
9950 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
9952 /* Run scroll hooks. */
9953 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
9955 /* Redisplay the window. */
9956 if (!current_matrix_up_to_date_p
9957 || windows_or_buffers_changed
9958 /* Don't use try_window_reusing_current_matrix in this case
9959 because it can have changed the buffer. */
9960 || !NILP (Vwindow_scroll_functions
)
9962 || MINI_WINDOW_P (w
)
9963 || !try_window_reusing_current_matrix (w
))
9964 try_window (window
, startp
);
9966 /* If new fonts have been loaded (due to fontsets), give up. We
9967 have to start a new redisplay since we need to re-adjust glyph
9969 if (fonts_changed_p
)
9970 goto finish_scroll_bars
;
9972 /* If cursor did not appear assume that the middle of the window is
9973 in the first line of the window. Do it again with the next line.
9974 (Imagine a window of height 100, displaying two lines of height
9975 60. Moving back 50 from it->last_visible_y will end in the first
9977 if (w
->cursor
.vpos
< 0)
9979 if (!NILP (w
->window_end_valid
)
9980 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
9982 clear_glyph_matrix (w
->desired_matrix
);
9983 move_it_by_lines (&it
, 1, 0);
9984 try_window (window
, it
.current
.pos
);
9986 else if (PT
< IT_CHARPOS (it
))
9988 clear_glyph_matrix (w
->desired_matrix
);
9989 move_it_by_lines (&it
, -1, 0);
9990 try_window (window
, it
.current
.pos
);
9994 /* Not much we can do about it. */
9998 /* Consider the following case: Window starts at BEGV, there is
9999 invisible, intangible text at BEGV, so that display starts at
10000 some point START > BEGV. It can happen that we are called with
10001 PT somewhere between BEGV and START. Try to handle that case. */
10002 if (w
->cursor
.vpos
< 0)
10004 struct glyph_row
*row
= w
->current_matrix
->rows
;
10005 if (row
->mode_line_p
)
10007 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
10010 make_cursor_line_fully_visible (w
);
10014 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
10015 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
10016 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
10019 /* Display the mode line, if we must. */
10020 if ((update_mode_line
10021 /* If window not full width, must redo its mode line
10022 if (a) the window to its side is being redone and
10023 (b) we do a frame-based redisplay. This is a consequence
10024 of how inverted lines are drawn in frame-based redisplay. */
10025 || (!just_this_one_p
10026 && !FRAME_WINDOW_P (f
)
10027 && !WINDOW_FULL_WIDTH_P (w
))
10028 /* Line number to display. */
10029 || INTEGERP (w
->base_line_pos
)
10030 /* Column number is displayed and different from the one displayed. */
10031 || (!NILP (w
->column_number_displayed
)
10032 && XFASTINT (w
->column_number_displayed
) != current_column ()))
10033 /* This means that the window has a mode line. */
10034 && (WINDOW_WANTS_MODELINE_P (w
)
10035 || WINDOW_WANTS_HEADER_LINE_P (w
)))
10037 Lisp_Object old_selected_frame
;
10039 old_selected_frame
= selected_frame
;
10041 XSETFRAME (selected_frame
, f
);
10042 display_mode_lines (w
);
10043 selected_frame
= old_selected_frame
;
10045 /* If mode line height has changed, arrange for a thorough
10046 immediate redisplay using the correct mode line height. */
10047 if (WINDOW_WANTS_MODELINE_P (w
)
10048 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
10050 fonts_changed_p
= 1;
10051 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
10052 = DESIRED_MODE_LINE_HEIGHT (w
);
10055 /* If top line height has changed, arrange for a thorough
10056 immediate redisplay using the correct mode line height. */
10057 if (WINDOW_WANTS_HEADER_LINE_P (w
)
10058 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
10060 fonts_changed_p
= 1;
10061 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
10062 = DESIRED_HEADER_LINE_HEIGHT (w
);
10065 if (fonts_changed_p
)
10066 goto finish_scroll_bars
;
10069 if (!line_number_displayed
10070 && !BUFFERP (w
->base_line_pos
))
10072 w
->base_line_pos
= Qnil
;
10073 w
->base_line_number
= Qnil
;
10078 /* When we reach a frame's selected window, redo the frame's menu bar. */
10079 if (update_mode_line
10080 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
10082 int redisplay_menu_p
= 0;
10084 if (FRAME_WINDOW_P (f
))
10086 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (macintosh)
10087 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
10089 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
10093 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
10095 if (redisplay_menu_p
)
10096 display_menu_bar (w
);
10098 #ifdef HAVE_WINDOW_SYSTEM
10099 if (WINDOWP (f
->tool_bar_window
)
10100 && (FRAME_TOOL_BAR_LINES (f
) > 0
10101 || auto_resize_tool_bars_p
))
10102 redisplay_tool_bar (f
);
10106 finish_scroll_bars
:
10108 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
))
10110 int start
, end
, whole
;
10112 /* Calculate the start and end positions for the current window.
10113 At some point, it would be nice to choose between scrollbars
10114 which reflect the whole buffer size, with special markers
10115 indicating narrowing, and scrollbars which reflect only the
10118 Note that mini-buffers sometimes aren't displaying any text. */
10119 if (!MINI_WINDOW_P (w
)
10120 || (w
== XWINDOW (minibuf_window
)
10121 && NILP (echo_area_buffer
[0])))
10124 start
= marker_position (w
->start
) - BEGV
;
10125 /* I don't think this is guaranteed to be right. For the
10126 moment, we'll pretend it is. */
10127 end
= (Z
- XFASTINT (w
->window_end_pos
)) - BEGV
;
10131 if (whole
< (end
- start
))
10132 whole
= end
- start
;
10135 start
= end
= whole
= 0;
10137 /* Indicate what this scroll bar ought to be displaying now. */
10138 set_vertical_scroll_bar_hook (w
, end
- start
, whole
, start
);
10140 /* Note that we actually used the scroll bar attached to this
10141 window, so it shouldn't be deleted at the end of redisplay. */
10142 redeem_scroll_bar_hook (w
);
10145 /* Restore current_buffer and value of point in it. */
10146 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
10147 set_buffer_internal_1 (old
);
10148 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
10150 unbind_to (count
, Qnil
);
10154 /* Build the complete desired matrix of WINDOW with a window start
10155 buffer position POS. Value is non-zero if successful. It is zero
10156 if fonts were loaded during redisplay which makes re-adjusting
10157 glyph matrices necessary. */
10160 try_window (window
, pos
)
10161 Lisp_Object window
;
10162 struct text_pos pos
;
10164 struct window
*w
= XWINDOW (window
);
10166 struct glyph_row
*last_text_row
= NULL
;
10168 /* Make POS the new window start. */
10169 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
10171 /* Mark cursor position as unknown. No overlay arrow seen. */
10172 w
->cursor
.vpos
= -1;
10173 overlay_arrow_seen
= 0;
10175 /* Initialize iterator and info to start at POS. */
10176 start_display (&it
, w
, pos
);
10178 /* Display all lines of W. */
10179 while (it
.current_y
< it
.last_visible_y
)
10181 if (display_line (&it
))
10182 last_text_row
= it
.glyph_row
- 1;
10183 if (fonts_changed_p
)
10187 /* If bottom moved off end of frame, change mode line percentage. */
10188 if (XFASTINT (w
->window_end_pos
) <= 0
10189 && Z
!= IT_CHARPOS (it
))
10190 w
->update_mode_line
= Qt
;
10192 /* Set window_end_pos to the offset of the last character displayed
10193 on the window from the end of current_buffer. Set
10194 window_end_vpos to its row number. */
10197 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
10198 w
->window_end_bytepos
10199 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
10200 XSETFASTINT (w
->window_end_pos
,
10201 Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
10202 XSETFASTINT (w
->window_end_vpos
,
10203 MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
10204 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
10205 ->displays_text_p
);
10209 w
->window_end_bytepos
= 0;
10210 XSETFASTINT (w
->window_end_pos
, 0);
10211 XSETFASTINT (w
->window_end_vpos
, 0);
10214 /* But that is not valid info until redisplay finishes. */
10215 w
->window_end_valid
= Qnil
;
10221 /************************************************************************
10222 Window redisplay reusing current matrix when buffer has not changed
10223 ************************************************************************/
10225 /* Try redisplay of window W showing an unchanged buffer with a
10226 different window start than the last time it was displayed by
10227 reusing its current matrix. Value is non-zero if successful.
10228 W->start is the new window start. */
10231 try_window_reusing_current_matrix (w
)
10234 struct frame
*f
= XFRAME (w
->frame
);
10235 struct glyph_row
*row
, *bottom_row
;
10238 struct text_pos start
, new_start
;
10239 int nrows_scrolled
, i
;
10240 struct glyph_row
*last_text_row
;
10241 struct glyph_row
*last_reused_text_row
;
10242 struct glyph_row
*start_row
;
10243 int start_vpos
, min_y
, max_y
;
10245 if (/* This function doesn't handle terminal frames. */
10246 !FRAME_WINDOW_P (f
)
10247 /* Don't try to reuse the display if windows have been split
10249 || windows_or_buffers_changed
)
10252 /* Can't do this if region may have changed. */
10253 if ((!NILP (Vtransient_mark_mode
)
10254 && !NILP (current_buffer
->mark_active
))
10255 || !NILP (w
->region_showing
)
10256 || !NILP (Vshow_trailing_whitespace
))
10259 /* If top-line visibility has changed, give up. */
10260 if (WINDOW_WANTS_HEADER_LINE_P (w
)
10261 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
10264 /* Give up if old or new display is scrolled vertically. We could
10265 make this function handle this, but right now it doesn't. */
10266 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
10267 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (start_row
))
10270 /* The variable new_start now holds the new window start. The old
10271 start `start' can be determined from the current matrix. */
10272 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
10273 start
= start_row
->start
.pos
;
10274 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
10276 /* Clear the desired matrix for the display below. */
10277 clear_glyph_matrix (w
->desired_matrix
);
10279 if (CHARPOS (new_start
) <= CHARPOS (start
))
10283 IF_DEBUG (debug_method_add (w
, "twu1"));
10285 /* Display up to a row that can be reused. The variable
10286 last_text_row is set to the last row displayed that displays
10287 text. Note that it.vpos == 0 if or if not there is a
10288 header-line; it's not the same as the MATRIX_ROW_VPOS! */
10289 start_display (&it
, w
, new_start
);
10290 first_row_y
= it
.current_y
;
10291 w
->cursor
.vpos
= -1;
10292 last_text_row
= last_reused_text_row
= NULL
;
10294 while (it
.current_y
< it
.last_visible_y
10295 && IT_CHARPOS (it
) < CHARPOS (start
)
10296 && !fonts_changed_p
)
10297 if (display_line (&it
))
10298 last_text_row
= it
.glyph_row
- 1;
10300 /* A value of current_y < last_visible_y means that we stopped
10301 at the previous window start, which in turn means that we
10302 have at least one reusable row. */
10303 if (it
.current_y
< it
.last_visible_y
)
10305 /* IT.vpos always starts from 0; it counts text lines. */
10306 nrows_scrolled
= it
.vpos
;
10308 /* Find PT if not already found in the lines displayed. */
10309 if (w
->cursor
.vpos
< 0)
10311 int dy
= it
.current_y
- first_row_y
;
10313 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
10314 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
10316 if (PT
>= MATRIX_ROW_START_CHARPOS (row
)
10317 && PT
< MATRIX_ROW_END_CHARPOS (row
))
10319 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
10320 dy
, nrows_scrolled
);
10324 if (MATRIX_ROW_BOTTOM_Y (row
) + dy
>= it
.last_visible_y
)
10330 /* Give up if point was not found. This shouldn't
10331 happen often; not more often than with try_window
10333 if (w
->cursor
.vpos
< 0)
10335 clear_glyph_matrix (w
->desired_matrix
);
10340 /* Scroll the display. Do it before the current matrix is
10341 changed. The problem here is that update has not yet
10342 run, i.e. part of the current matrix is not up to date.
10343 scroll_run_hook will clear the cursor, and use the
10344 current matrix to get the height of the row the cursor is
10346 run
.current_y
= first_row_y
;
10347 run
.desired_y
= it
.current_y
;
10348 run
.height
= it
.last_visible_y
- it
.current_y
;
10350 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
10353 rif
->update_window_begin_hook (w
);
10354 rif
->clear_mouse_face (w
);
10355 rif
->scroll_run_hook (w
, &run
);
10356 rif
->update_window_end_hook (w
, 0, 0);
10360 /* Shift current matrix down by nrows_scrolled lines. */
10361 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
10362 rotate_matrix (w
->current_matrix
,
10364 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
10367 /* Disable lines that must be updated. */
10368 for (i
= 0; i
< it
.vpos
; ++i
)
10369 (start_row
+ i
)->enabled_p
= 0;
10371 /* Re-compute Y positions. */
10372 min_y
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
);
10373 max_y
= it
.last_visible_y
;
10374 for (row
= start_row
+ nrows_scrolled
;
10378 row
->y
= it
.current_y
;
10380 if (row
->y
< min_y
)
10381 row
->visible_height
= row
->height
- (min_y
- row
->y
);
10382 else if (row
->y
+ row
->height
> max_y
)
10383 row
->visible_height
10384 = row
->height
- (row
->y
+ row
->height
- max_y
);
10386 row
->visible_height
= row
->height
;
10388 it
.current_y
+= row
->height
;
10390 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
10391 last_reused_text_row
= row
;
10392 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
10396 /* Disable lines in the current matrix which are now
10397 below the window. */
10398 for (++row
; row
< bottom_row
; ++row
)
10399 row
->enabled_p
= 0;
10402 /* Update window_end_pos etc.; last_reused_text_row is the last
10403 reused row from the current matrix containing text, if any.
10404 The value of last_text_row is the last displayed line
10405 containing text. */
10406 if (last_reused_text_row
)
10408 w
->window_end_bytepos
10409 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
10410 XSETFASTINT (w
->window_end_pos
,
10411 Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
10412 XSETFASTINT (w
->window_end_vpos
,
10413 MATRIX_ROW_VPOS (last_reused_text_row
,
10414 w
->current_matrix
));
10416 else if (last_text_row
)
10418 w
->window_end_bytepos
10419 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
10420 XSETFASTINT (w
->window_end_pos
,
10421 Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
10422 XSETFASTINT (w
->window_end_vpos
,
10423 MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
10427 /* This window must be completely empty. */
10428 w
->window_end_bytepos
= 0;
10429 XSETFASTINT (w
->window_end_pos
, 0);
10430 XSETFASTINT (w
->window_end_vpos
, 0);
10432 w
->window_end_valid
= Qnil
;
10434 /* Update hint: don't try scrolling again in update_window. */
10435 w
->desired_matrix
->no_scrolling_p
= 1;
10438 debug_method_add (w
, "try_window_reusing_current_matrix 1");
10442 else if (CHARPOS (new_start
) > CHARPOS (start
))
10444 struct glyph_row
*pt_row
, *row
;
10445 struct glyph_row
*first_reusable_row
;
10446 struct glyph_row
*first_row_to_display
;
10448 int yb
= window_text_bottom_y (w
);
10450 IF_DEBUG (debug_method_add (w
, "twu2"));
10452 /* Find the row starting at new_start, if there is one. Don't
10453 reuse a partially visible line at the end. */
10454 first_reusable_row
= start_row
;
10455 while (first_reusable_row
->enabled_p
10456 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
10457 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
10458 < CHARPOS (new_start
)))
10459 ++first_reusable_row
;
10461 /* Give up if there is no row to reuse. */
10462 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
10463 || !first_reusable_row
->enabled_p
10464 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
10465 != CHARPOS (new_start
)))
10468 /* We can reuse fully visible rows beginning with
10469 first_reusable_row to the end of the window. Set
10470 first_row_to_display to the first row that cannot be reused.
10471 Set pt_row to the row containing point, if there is any. */
10472 first_row_to_display
= first_reusable_row
;
10474 while (MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
)
10476 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
10477 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
10478 pt_row
= first_row_to_display
;
10480 ++first_row_to_display
;
10483 /* Start displaying at the start of first_row_to_display. */
10484 xassert (first_row_to_display
->y
< yb
);
10485 init_to_row_start (&it
, w
, first_row_to_display
);
10486 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
10488 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
10490 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
10491 + WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
));
10493 /* Display lines beginning with first_row_to_display in the
10494 desired matrix. Set last_text_row to the last row displayed
10495 that displays text. */
10496 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
10497 if (pt_row
== NULL
)
10498 w
->cursor
.vpos
= -1;
10499 last_text_row
= NULL
;
10500 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
10501 if (display_line (&it
))
10502 last_text_row
= it
.glyph_row
- 1;
10504 /* Give up If point isn't in a row displayed or reused. */
10505 if (w
->cursor
.vpos
< 0)
10507 clear_glyph_matrix (w
->desired_matrix
);
10511 /* If point is in a reused row, adjust y and vpos of the cursor
10515 w
->cursor
.vpos
-= MATRIX_ROW_VPOS (first_reusable_row
,
10516 w
->current_matrix
);
10517 w
->cursor
.y
-= first_reusable_row
->y
;
10520 /* Scroll the display. */
10521 run
.current_y
= first_reusable_row
->y
;
10522 run
.desired_y
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
);
10523 run
.height
= it
.last_visible_y
- run
.current_y
;
10524 dy
= run
.current_y
- run
.desired_y
;
10528 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
10530 rif
->update_window_begin_hook (w
);
10531 rif
->clear_mouse_face (w
);
10532 rif
->scroll_run_hook (w
, &run
);
10533 rif
->update_window_end_hook (w
, 0, 0);
10537 /* Adjust Y positions of reused rows. */
10538 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
10539 min_y
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
);
10540 max_y
= it
.last_visible_y
;
10541 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
10544 if (row
->y
< min_y
)
10545 row
->visible_height
= row
->height
- (min_y
- row
->y
);
10546 else if (row
->y
+ row
->height
> max_y
)
10547 row
->visible_height
10548 = row
->height
- (row
->y
+ row
->height
- max_y
);
10550 row
->visible_height
= row
->height
;
10553 /* Disable rows not reused. */
10554 while (row
< bottom_row
)
10556 row
->enabled_p
= 0;
10560 /* Scroll the current matrix. */
10561 xassert (nrows_scrolled
> 0);
10562 rotate_matrix (w
->current_matrix
,
10564 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
10567 /* Adjust window end. A null value of last_text_row means that
10568 the window end is in reused rows which in turn means that
10569 only its vpos can have changed. */
10572 w
->window_end_bytepos
10573 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
10574 XSETFASTINT (w
->window_end_pos
,
10575 Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
10576 XSETFASTINT (w
->window_end_vpos
,
10577 MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
10581 XSETFASTINT (w
->window_end_vpos
,
10582 XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
10585 w
->window_end_valid
= Qnil
;
10586 w
->desired_matrix
->no_scrolling_p
= 1;
10589 debug_method_add (w
, "try_window_reusing_current_matrix 2");
10599 /************************************************************************
10600 Window redisplay reusing current matrix when buffer has changed
10601 ************************************************************************/
10603 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
10604 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
10606 static struct glyph_row
*
10607 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
10608 struct glyph_row
*));
10611 /* Return the last row in MATRIX displaying text. If row START is
10612 non-null, start searching with that row. IT gives the dimensions
10613 of the display. Value is null if matrix is empty; otherwise it is
10614 a pointer to the row found. */
10616 static struct glyph_row
*
10617 find_last_row_displaying_text (matrix
, it
, start
)
10618 struct glyph_matrix
*matrix
;
10620 struct glyph_row
*start
;
10622 struct glyph_row
*row
, *row_found
;
10624 /* Set row_found to the last row in IT->w's current matrix
10625 displaying text. The loop looks funny but think of partially
10628 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
10629 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
10631 xassert (row
->enabled_p
);
10633 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
10642 /* Return the last row in the current matrix of W that is not affected
10643 by changes at the start of current_buffer that occurred since the
10644 last time W was redisplayed. Value is null if no such row exists.
10646 The global variable beg_unchanged has to contain the number of
10647 bytes unchanged at the start of current_buffer. BEG +
10648 beg_unchanged is the buffer position of the first changed byte in
10649 current_buffer. Characters at positions < BEG + beg_unchanged are
10650 at the same buffer positions as they were when the current matrix
10653 static struct glyph_row
*
10654 find_last_unchanged_at_beg_row (w
)
10657 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
10658 struct glyph_row
*row
;
10659 struct glyph_row
*row_found
= NULL
;
10660 int yb
= window_text_bottom_y (w
);
10662 /* Find the last row displaying unchanged text. */
10663 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
10664 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
10665 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
)
10667 if (/* If row ends before first_changed_pos, it is unchanged,
10668 except in some case. */
10669 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
10670 /* When row ends in ZV and we write at ZV it is not
10672 && !row
->ends_at_zv_p
10673 /* When first_changed_pos is the end of a continued line,
10674 row is not unchanged because it may be no longer
10676 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
10677 && row
->continued_p
))
10680 /* Stop if last visible row. */
10681 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
10691 /* Find the first glyph row in the current matrix of W that is not
10692 affected by changes at the end of current_buffer since the last
10693 time the window was redisplayed. Return in *DELTA the number of
10694 chars by which buffer positions in unchanged text at the end of
10695 current_buffer must be adjusted. Return in *DELTA_BYTES the
10696 corresponding number of bytes. Value is null if no such row
10697 exists, i.e. all rows are affected by changes. */
10699 static struct glyph_row
*
10700 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
10702 int *delta
, *delta_bytes
;
10704 struct glyph_row
*row
;
10705 struct glyph_row
*row_found
= NULL
;
10707 *delta
= *delta_bytes
= 0;
10709 /* Display must not have been paused, otherwise the current matrix
10710 is not up to date. */
10711 if (NILP (w
->window_end_valid
))
10714 /* A value of window_end_pos >= END_UNCHANGED means that the window
10715 end is in the range of changed text. If so, there is no
10716 unchanged row at the end of W's current matrix. */
10717 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
10720 /* Set row to the last row in W's current matrix displaying text. */
10721 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
10723 /* If matrix is entirely empty, no unchanged row exists. */
10724 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
10726 /* The value of row is the last glyph row in the matrix having a
10727 meaningful buffer position in it. The end position of row
10728 corresponds to window_end_pos. This allows us to translate
10729 buffer positions in the current matrix to current buffer
10730 positions for characters not in changed text. */
10731 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
10732 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
10733 int last_unchanged_pos
, last_unchanged_pos_old
;
10734 struct glyph_row
*first_text_row
10735 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
10737 *delta
= Z
- Z_old
;
10738 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
10740 /* Set last_unchanged_pos to the buffer position of the last
10741 character in the buffer that has not been changed. Z is the
10742 index + 1 of the last byte in current_buffer, i.e. by
10743 subtracting end_unchanged we get the index of the last
10744 unchanged character, and we have to add BEG to get its buffer
10746 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
10747 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
10749 /* Search backward from ROW for a row displaying a line that
10750 starts at a minimum position >= last_unchanged_pos_old. */
10751 for (; row
> first_text_row
; --row
)
10753 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
10756 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
10761 if (row_found
&& !MATRIX_ROW_DISPLAYS_TEXT_P (row_found
))
10768 /* Make sure that glyph rows in the current matrix of window W
10769 reference the same glyph memory as corresponding rows in the
10770 frame's frame matrix. This function is called after scrolling W's
10771 current matrix on a terminal frame in try_window_id and
10772 try_window_reusing_current_matrix. */
10775 sync_frame_with_window_matrix_rows (w
)
10778 struct frame
*f
= XFRAME (w
->frame
);
10779 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
10781 /* Preconditions: W must be a leaf window and full-width. Its frame
10782 must have a frame matrix. */
10783 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
10784 xassert (WINDOW_FULL_WIDTH_P (w
));
10785 xassert (!FRAME_WINDOW_P (f
));
10787 /* If W is a full-width window, glyph pointers in W's current matrix
10788 have, by definition, to be the same as glyph pointers in the
10789 corresponding frame matrix. */
10790 window_row
= w
->current_matrix
->rows
;
10791 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
10792 frame_row
= f
->current_matrix
->rows
+ XFASTINT (w
->top
);
10793 while (window_row
< window_row_end
)
10797 for (area
= LEFT_MARGIN_AREA
; area
<= LAST_AREA
; ++area
)
10798 frame_row
->glyphs
[area
] = window_row
->glyphs
[area
];
10800 /* Disable frame rows whose corresponding window rows have
10801 been disabled in try_window_id. */
10802 if (!window_row
->enabled_p
)
10803 frame_row
->enabled_p
= 0;
10805 ++window_row
, ++frame_row
;
10810 /* Find the glyph row in window W containing CHARPOS. Consider all
10811 rows between START and END (not inclusive). END null means search
10812 all rows to the end of the display area of W. Value is the row
10813 containing CHARPOS or null. */
10815 static struct glyph_row
*
10816 row_containing_pos (w
, charpos
, start
, end
)
10819 struct glyph_row
*start
, *end
;
10821 struct glyph_row
*row
= start
;
10824 /* If we happen to start on a header-line, skip that. */
10825 if (row
->mode_line_p
)
10828 if ((end
&& row
>= end
) || !row
->enabled_p
)
10831 last_y
= window_text_bottom_y (w
);
10833 while ((end
== NULL
|| row
< end
)
10834 && (MATRIX_ROW_END_CHARPOS (row
) < charpos
10835 /* The end position of a row equals the start
10836 position of the next row. If CHARPOS is there, we
10837 would rather display it in the next line, except
10838 when this line ends in ZV. */
10839 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
10840 && (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)
10841 || !row
->ends_at_zv_p
)))
10842 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
10845 /* Give up if CHARPOS not found. */
10846 if ((end
&& row
>= end
)
10847 || charpos
< MATRIX_ROW_START_CHARPOS (row
)
10848 || charpos
> MATRIX_ROW_END_CHARPOS (row
))
10855 /* Try to redisplay window W by reusing its existing display. W's
10856 current matrix must be up to date when this function is called,
10857 i.e. window_end_valid must not be nil.
10861 1 if display has been updated
10862 0 if otherwise unsuccessful
10863 -1 if redisplay with same window start is known not to succeed
10865 The following steps are performed:
10867 1. Find the last row in the current matrix of W that is not
10868 affected by changes at the start of current_buffer. If no such row
10871 2. Find the first row in W's current matrix that is not affected by
10872 changes at the end of current_buffer. Maybe there is no such row.
10874 3. Display lines beginning with the row + 1 found in step 1 to the
10875 row found in step 2 or, if step 2 didn't find a row, to the end of
10878 4. If cursor is not known to appear on the window, give up.
10880 5. If display stopped at the row found in step 2, scroll the
10881 display and current matrix as needed.
10883 6. Maybe display some lines at the end of W, if we must. This can
10884 happen under various circumstances, like a partially visible line
10885 becoming fully visible, or because newly displayed lines are displayed
10886 in smaller font sizes.
10888 7. Update W's window end information. */
10890 /* Check that window end is what we expect it to be. */
10896 struct frame
*f
= XFRAME (w
->frame
);
10897 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
10898 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
10899 struct glyph_row
*last_unchanged_at_beg_row
;
10900 struct glyph_row
*first_unchanged_at_end_row
;
10901 struct glyph_row
*row
;
10902 struct glyph_row
*bottom_row
;
10905 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
10906 struct text_pos start_pos
;
10908 int first_unchanged_at_end_vpos
= 0;
10909 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
10910 struct text_pos start
;
10912 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10914 /* Check pre-conditions. Window end must be valid, otherwise
10915 the current matrix would not be up to date. */
10916 xassert (!NILP (w
->window_end_valid
));
10917 xassert (FRAME_WINDOW_P (XFRAME (w
->frame
))
10918 || (line_ins_del_ok
&& WINDOW_FULL_WIDTH_P (w
)));
10920 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
10921 only if buffer has really changed. The reason is that the gap is
10922 initially at Z for freshly visited files. The code below would
10923 set end_unchanged to 0 in that case. */
10924 if (MODIFF
> SAVE_MODIFF
10925 /* This seems to happen sometimes after saving a buffer. */
10926 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
10928 if (GPT
- BEG
< BEG_UNCHANGED
)
10929 BEG_UNCHANGED
= GPT
- BEG
;
10930 if (Z
- GPT
< END_UNCHANGED
)
10931 END_UNCHANGED
= Z
- GPT
;
10934 /* If window starts after a line end, and the last change is in
10935 front of that newline, then changes don't affect the display.
10936 This case happens with stealth-fontification. Note that although
10937 the display is unchanged, glyph positions in the matrix have to
10938 be adjusted, of course. */
10939 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
10940 if (CHARPOS (start
) > BEGV
10941 && Z
- END_UNCHANGED
< CHARPOS (start
) - 1
10942 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n'
10943 && PT
< MATRIX_ROW_END_CHARPOS (row
))
10945 struct glyph_row
*r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
10946 int delta
= CHARPOS (start
) - MATRIX_ROW_START_CHARPOS (r0
);
10950 struct glyph_row
*r1
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
10951 int delta_bytes
= BYTEPOS (start
) - MATRIX_ROW_START_BYTEPOS (r0
);
10953 increment_matrix_positions (w
->current_matrix
,
10954 MATRIX_ROW_VPOS (r0
, current_matrix
),
10955 MATRIX_ROW_VPOS (r1
, current_matrix
),
10956 delta
, delta_bytes
);
10959 #if 0 /* If changes are all in front of the window start, the
10960 distance of the last displayed glyph from Z hasn't
10963 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
10964 w
->window_end_bytepos
10965 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
10968 row
= row_containing_pos (w
, PT
, r0
, NULL
);
10972 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
10976 /* Return quickly if changes are all below what is displayed in the
10977 window, and if PT is in the window. */
10978 if (BEG_UNCHANGED
> MATRIX_ROW_END_CHARPOS (row
)
10979 && PT
< MATRIX_ROW_END_CHARPOS (row
))
10981 /* We have to update window end positions because the buffer's
10982 size has changed. */
10984 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
10985 w
->window_end_bytepos
10986 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
10988 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
10989 row
= row_containing_pos (w
, PT
, row
, NULL
);
10990 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
10994 /* Check that window start agrees with the start of the first glyph
10995 row in its current matrix. Check this after we know the window
10996 start is not in changed text, otherwise positions would not be
10998 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
10999 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
11002 /* Compute the position at which we have to start displaying new
11003 lines. Some of the lines at the top of the window might be
11004 reusable because they are not displaying changed text. Find the
11005 last row in W's current matrix not affected by changes at the
11006 start of current_buffer. Value is null if changes start in the
11007 first line of window. */
11008 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
11009 if (last_unchanged_at_beg_row
)
11011 /* Avoid starting to display in the moddle of a character, a TAB
11012 for instance. This is easier than to set up the iterator
11013 exactly, and it's not a frequent case, so the additional
11014 effort wouldn't really pay off. */
11015 while (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
11016 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
11017 --last_unchanged_at_beg_row
;
11019 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
11022 init_to_row_end (&it
, w
, last_unchanged_at_beg_row
);
11023 start_pos
= it
.current
.pos
;
11025 /* Start displaying new lines in the desired matrix at the same
11026 vpos we would use in the current matrix, i.e. below
11027 last_unchanged_at_beg_row. */
11028 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
11030 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
11031 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
11033 xassert (it
.hpos
== 0 && it
.current_x
== 0);
11037 /* There are no reusable lines at the start of the window.
11038 Start displaying in the first line. */
11039 start_display (&it
, w
, start
);
11040 start_pos
= it
.current
.pos
;
11043 /* Find the first row that is not affected by changes at the end of
11044 the buffer. Value will be null if there is no unchanged row, in
11045 which case we must redisplay to the end of the window. delta
11046 will be set to the value by which buffer positions beginning with
11047 first_unchanged_at_end_row have to be adjusted due to text
11049 first_unchanged_at_end_row
11050 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
11051 IF_DEBUG (debug_delta
= delta
);
11052 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
11054 /* Set stop_pos to the buffer position up to which we will have to
11055 display new lines. If first_unchanged_at_end_row != NULL, this
11056 is the buffer position of the start of the line displayed in that
11057 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
11058 that we don't stop at a buffer position. */
11060 if (first_unchanged_at_end_row
)
11062 xassert (last_unchanged_at_beg_row
== NULL
11063 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
11065 /* If this is a continuation line, move forward to the next one
11066 that isn't. Changes in lines above affect this line.
11067 Caution: this may move first_unchanged_at_end_row to a row
11068 not displaying text. */
11069 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
11070 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
11071 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
11072 < it
.last_visible_y
))
11073 ++first_unchanged_at_end_row
;
11075 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
11076 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
11077 >= it
.last_visible_y
))
11078 first_unchanged_at_end_row
= NULL
;
11081 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
11083 first_unchanged_at_end_vpos
11084 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
11085 xassert (stop_pos
>= Z
- END_UNCHANGED
);
11088 else if (last_unchanged_at_beg_row
== NULL
)
11094 /* Either there is no unchanged row at the end, or the one we have
11095 now displays text. This is a necessary condition for the window
11096 end pos calculation at the end of this function. */
11097 xassert (first_unchanged_at_end_row
== NULL
11098 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
11100 debug_last_unchanged_at_beg_vpos
11101 = (last_unchanged_at_beg_row
11102 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
11104 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
11106 #endif /* GLYPH_DEBUG != 0 */
11109 /* Display new lines. Set last_text_row to the last new line
11110 displayed which has text on it, i.e. might end up as being the
11111 line where the window_end_vpos is. */
11112 w
->cursor
.vpos
= -1;
11113 last_text_row
= NULL
;
11114 overlay_arrow_seen
= 0;
11115 while (it
.current_y
< it
.last_visible_y
11116 && !fonts_changed_p
11117 && (first_unchanged_at_end_row
== NULL
11118 || IT_CHARPOS (it
) < stop_pos
))
11120 if (display_line (&it
))
11121 last_text_row
= it
.glyph_row
- 1;
11124 if (fonts_changed_p
)
11128 /* Compute differences in buffer positions, y-positions etc. for
11129 lines reused at the bottom of the window. Compute what we can
11131 if (first_unchanged_at_end_row
11132 /* No lines reused because we displayed everything up to the
11133 bottom of the window. */
11134 && it
.current_y
< it
.last_visible_y
)
11137 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
11139 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
11140 run
.current_y
= first_unchanged_at_end_row
->y
;
11141 run
.desired_y
= run
.current_y
+ dy
;
11142 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
11146 delta
= dvpos
= dy
= run
.current_y
= run
.desired_y
= run
.height
= 0;
11147 first_unchanged_at_end_row
= NULL
;
11149 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
11152 /* Find the cursor if not already found. We have to decide whether
11153 PT will appear on this window (it sometimes doesn't, but this is
11154 not a very frequent case.) This decision has to be made before
11155 the current matrix is altered. A value of cursor.vpos < 0 means
11156 that PT is either in one of the lines beginning at
11157 first_unchanged_at_end_row or below the window. Don't care for
11158 lines that might be displayed later at the window end; as
11159 mentioned, this is not a frequent case. */
11160 if (w
->cursor
.vpos
< 0)
11162 /* Cursor in unchanged rows at the top? */
11163 if (PT
< CHARPOS (start_pos
)
11164 && last_unchanged_at_beg_row
)
11166 row
= row_containing_pos (w
, PT
,
11167 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
11168 last_unchanged_at_beg_row
+ 1);
11170 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11173 /* Start from first_unchanged_at_end_row looking for PT. */
11174 else if (first_unchanged_at_end_row
)
11176 row
= row_containing_pos (w
, PT
- delta
,
11177 first_unchanged_at_end_row
, NULL
);
11179 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
11180 delta_bytes
, dy
, dvpos
);
11183 /* Give up if cursor was not found. */
11184 if (w
->cursor
.vpos
< 0)
11186 clear_glyph_matrix (w
->desired_matrix
);
11191 /* Don't let the cursor end in the scroll margins. */
11193 int this_scroll_margin
, cursor_height
;
11195 this_scroll_margin
= max (0, scroll_margin
);
11196 this_scroll_margin
= min (this_scroll_margin
,
11197 XFASTINT (w
->height
) / 4);
11198 this_scroll_margin
*= CANON_Y_UNIT (it
.f
);
11199 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
11201 if ((w
->cursor
.y
< this_scroll_margin
11202 && CHARPOS (start
) > BEGV
)
11203 /* Don't take scroll margin into account at the bottom because
11204 old redisplay didn't do it either. */
11205 || w
->cursor
.y
+ cursor_height
> it
.last_visible_y
)
11207 w
->cursor
.vpos
= -1;
11208 clear_glyph_matrix (w
->desired_matrix
);
11213 /* Scroll the display. Do it before changing the current matrix so
11214 that xterm.c doesn't get confused about where the cursor glyph is
11216 if (dy
&& run
.height
)
11220 if (FRAME_WINDOW_P (f
))
11222 rif
->update_window_begin_hook (w
);
11223 rif
->clear_mouse_face (w
);
11224 rif
->scroll_run_hook (w
, &run
);
11225 rif
->update_window_end_hook (w
, 0, 0);
11229 /* Terminal frame. In this case, dvpos gives the number of
11230 lines to scroll by; dvpos < 0 means scroll up. */
11231 int first_unchanged_at_end_vpos
11232 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
11233 int from
= XFASTINT (w
->top
) + first_unchanged_at_end_vpos
;
11234 int end
= XFASTINT (w
->top
) + window_internal_height (w
);
11236 /* Perform the operation on the screen. */
11239 /* Scroll last_unchanged_at_beg_row to the end of the
11240 window down dvpos lines. */
11241 set_terminal_window (end
);
11243 /* On dumb terminals delete dvpos lines at the end
11244 before inserting dvpos empty lines. */
11245 if (!scroll_region_ok
)
11246 ins_del_lines (end
- dvpos
, -dvpos
);
11248 /* Insert dvpos empty lines in front of
11249 last_unchanged_at_beg_row. */
11250 ins_del_lines (from
, dvpos
);
11252 else if (dvpos
< 0)
11254 /* Scroll up last_unchanged_at_beg_vpos to the end of
11255 the window to last_unchanged_at_beg_vpos - |dvpos|. */
11256 set_terminal_window (end
);
11258 /* Delete dvpos lines in front of
11259 last_unchanged_at_beg_vpos. ins_del_lines will set
11260 the cursor to the given vpos and emit |dvpos| delete
11262 ins_del_lines (from
+ dvpos
, dvpos
);
11264 /* On a dumb terminal insert dvpos empty lines at the
11266 if (!scroll_region_ok
)
11267 ins_del_lines (end
+ dvpos
, -dvpos
);
11270 set_terminal_window (0);
11276 /* Shift reused rows of the current matrix to the right position.
11277 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
11279 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
11280 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
11283 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
11284 bottom_vpos
, dvpos
);
11285 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
11288 else if (dvpos
> 0)
11290 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
11291 bottom_vpos
, dvpos
);
11292 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
11293 first_unchanged_at_end_vpos
+ dvpos
, 0);
11296 /* For frame-based redisplay, make sure that current frame and window
11297 matrix are in sync with respect to glyph memory. */
11298 if (!FRAME_WINDOW_P (f
))
11299 sync_frame_with_window_matrix_rows (w
);
11301 /* Adjust buffer positions in reused rows. */
11303 increment_matrix_positions (current_matrix
,
11304 first_unchanged_at_end_vpos
+ dvpos
,
11305 bottom_vpos
, delta
, delta_bytes
);
11307 /* Adjust Y positions. */
11309 shift_glyph_matrix (w
, current_matrix
,
11310 first_unchanged_at_end_vpos
+ dvpos
,
11313 if (first_unchanged_at_end_row
)
11314 first_unchanged_at_end_row
+= dvpos
;
11316 /* If scrolling up, there may be some lines to display at the end of
11318 last_text_row_at_end
= NULL
;
11321 /* Set last_row to the glyph row in the current matrix where the
11322 window end line is found. It has been moved up or down in
11323 the matrix by dvpos. */
11324 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
11325 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
11327 /* If last_row is the window end line, it should display text. */
11328 xassert (last_row
->displays_text_p
);
11330 /* If window end line was partially visible before, begin
11331 displaying at that line. Otherwise begin displaying with the
11332 line following it. */
11333 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
11335 init_to_row_start (&it
, w
, last_row
);
11336 it
.vpos
= last_vpos
;
11337 it
.current_y
= last_row
->y
;
11341 init_to_row_end (&it
, w
, last_row
);
11342 it
.vpos
= 1 + last_vpos
;
11343 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
11347 /* We may start in a continuation line. If so, we have to get
11348 the right continuation_lines_width and current_x. */
11349 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
11350 it
.hpos
= it
.current_x
= 0;
11352 /* Display the rest of the lines at the window end. */
11353 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
11354 while (it
.current_y
< it
.last_visible_y
11355 && !fonts_changed_p
)
11357 /* Is it always sure that the display agrees with lines in
11358 the current matrix? I don't think so, so we mark rows
11359 displayed invalid in the current matrix by setting their
11360 enabled_p flag to zero. */
11361 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
11362 if (display_line (&it
))
11363 last_text_row_at_end
= it
.glyph_row
- 1;
11367 /* Update window_end_pos and window_end_vpos. */
11368 if (first_unchanged_at_end_row
11369 && first_unchanged_at_end_row
->y
< it
.last_visible_y
11370 && !last_text_row_at_end
)
11372 /* Window end line if one of the preserved rows from the current
11373 matrix. Set row to the last row displaying text in current
11374 matrix starting at first_unchanged_at_end_row, after
11376 xassert (first_unchanged_at_end_row
->displays_text_p
);
11377 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
11378 first_unchanged_at_end_row
);
11379 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
11381 XSETFASTINT (w
->window_end_pos
, Z
- MATRIX_ROW_END_CHARPOS (row
));
11382 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
11383 XSETFASTINT (w
->window_end_vpos
,
11384 MATRIX_ROW_VPOS (row
, w
->current_matrix
));
11386 else if (last_text_row_at_end
)
11388 XSETFASTINT (w
->window_end_pos
,
11389 Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
11390 w
->window_end_bytepos
11391 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
11392 XSETFASTINT (w
->window_end_vpos
,
11393 MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
11395 else if (last_text_row
)
11397 /* We have displayed either to the end of the window or at the
11398 end of the window, i.e. the last row with text is to be found
11399 in the desired matrix. */
11400 XSETFASTINT (w
->window_end_pos
,
11401 Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
11402 w
->window_end_bytepos
11403 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
11404 XSETFASTINT (w
->window_end_vpos
,
11405 MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
11407 else if (first_unchanged_at_end_row
== NULL
11408 && last_text_row
== NULL
11409 && last_text_row_at_end
== NULL
)
11411 /* Displayed to end of window, but no line containing text was
11412 displayed. Lines were deleted at the end of the window. */
11414 int header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
11416 for (vpos
= XFASTINT (w
->window_end_vpos
); vpos
> 0; --vpos
)
11417 if ((w
->desired_matrix
->rows
[vpos
+ header_line_p
].enabled_p
11418 && w
->desired_matrix
->rows
[vpos
+ header_line_p
].displays_text_p
)
11419 || (!w
->desired_matrix
->rows
[vpos
+ header_line_p
].enabled_p
11420 && w
->current_matrix
->rows
[vpos
+ header_line_p
].displays_text_p
))
11423 w
->window_end_vpos
= make_number (vpos
);
11428 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
11429 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
11431 /* Record that display has not been completed. */
11432 w
->window_end_valid
= Qnil
;
11433 w
->desired_matrix
->no_scrolling_p
= 1;
11439 /***********************************************************************
11440 More debugging support
11441 ***********************************************************************/
11445 void dump_glyph_row
P_ ((struct glyph_matrix
*, int, int));
11446 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
11447 void dump_glyph
P_ ((struct glyph_row
*, struct glyph
*, int));
11450 /* Dump the contents of glyph matrix MATRIX on stderr.
11452 GLYPHS 0 means don't show glyph contents.
11453 GLYPHS 1 means show glyphs in short form
11454 GLYPHS > 1 means show glyphs in long form. */
11457 dump_glyph_matrix (matrix
, glyphs
)
11458 struct glyph_matrix
*matrix
;
11462 for (i
= 0; i
< matrix
->nrows
; ++i
)
11463 dump_glyph_row (matrix
, i
, glyphs
);
11467 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
11468 the glyph row and area where the glyph comes from. */
11471 dump_glyph (row
, glyph
, area
)
11472 struct glyph_row
*row
;
11473 struct glyph
*glyph
;
11476 if (glyph
->type
== CHAR_GLYPH
)
11479 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
11480 glyph
- row
->glyphs
[TEXT_AREA
],
11483 (BUFFERP (glyph
->object
)
11485 : (STRINGP (glyph
->object
)
11488 glyph
->pixel_width
,
11490 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
11494 glyph
->left_box_line_p
,
11495 glyph
->right_box_line_p
);
11497 else if (glyph
->type
== STRETCH_GLYPH
)
11500 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
11501 glyph
- row
->glyphs
[TEXT_AREA
],
11504 (BUFFERP (glyph
->object
)
11506 : (STRINGP (glyph
->object
)
11509 glyph
->pixel_width
,
11513 glyph
->left_box_line_p
,
11514 glyph
->right_box_line_p
);
11516 else if (glyph
->type
== IMAGE_GLYPH
)
11519 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
11520 glyph
- row
->glyphs
[TEXT_AREA
],
11523 (BUFFERP (glyph
->object
)
11525 : (STRINGP (glyph
->object
)
11528 glyph
->pixel_width
,
11532 glyph
->left_box_line_p
,
11533 glyph
->right_box_line_p
);
11538 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
11539 GLYPHS 0 means don't show glyph contents.
11540 GLYPHS 1 means show glyphs in short form
11541 GLYPHS > 1 means show glyphs in long form. */
11544 dump_glyph_row (matrix
, vpos
, glyphs
)
11545 struct glyph_matrix
*matrix
;
11548 struct glyph_row
*row
;
11550 if (vpos
< 0 || vpos
>= matrix
->nrows
)
11553 row
= MATRIX_ROW (matrix
, vpos
);
11557 fprintf (stderr
, "Row Start End Used oEI><O\\CTZFesm X Y W H V A P\n");
11558 fprintf (stderr
, "=======================================================================\n");
11560 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d\
11561 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
11562 row
- matrix
->rows
,
11563 MATRIX_ROW_START_CHARPOS (row
),
11564 MATRIX_ROW_END_CHARPOS (row
),
11565 row
->used
[TEXT_AREA
],
11566 row
->contains_overlapping_glyphs_p
,
11569 row
->truncated_on_left_p
,
11570 row
->truncated_on_right_p
,
11571 row
->overlay_arrow_p
,
11573 MATRIX_ROW_CONTINUATION_LINE_P (row
),
11574 row
->displays_text_p
,
11577 row
->ends_in_middle_of_char_p
,
11578 row
->starts_in_middle_of_char_p
,
11584 row
->visible_height
,
11587 fprintf (stderr
, "%9d %5d\n", row
->start
.overlay_string_index
,
11588 row
->end
.overlay_string_index
);
11589 fprintf (stderr
, "%9d %5d\n",
11590 CHARPOS (row
->start
.string_pos
),
11591 CHARPOS (row
->end
.string_pos
));
11592 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
11593 row
->end
.dpvec_index
);
11600 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
11602 struct glyph
*glyph
, *glyph_end
;
11603 glyph
= row
->glyphs
[area
];
11604 glyph_end
= glyph
+ row
->used
[area
];
11606 /* Glyph for a line end in text. */
11607 if (glyph
== glyph_end
&& glyph
->charpos
> 0)
11610 if (glyph
< glyph_end
)
11611 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
11613 for (; glyph
< glyph_end
; ++glyph
)
11614 dump_glyph (row
, glyph
, area
);
11617 else if (glyphs
== 1)
11621 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
11623 char *s
= (char *) alloca (row
->used
[area
] + 1);
11626 for (i
= 0; i
< row
->used
[area
]; ++i
)
11628 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
11629 if (glyph
->type
== CHAR_GLYPH
11630 && glyph
->u
.ch
< 0x80
11631 && glyph
->u
.ch
>= ' ')
11632 s
[i
] = glyph
->u
.ch
;
11638 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
11644 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
11645 Sdump_glyph_matrix
, 0, 1, "p",
11646 "Dump the current matrix of the selected window to stderr.\n\
11647 Shows contents of glyph row structures. With non-nil\n\
11648 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show\n\
11649 glyphs in short form, otherwise show glyphs in long form.")
11651 Lisp_Object glyphs
;
11653 struct window
*w
= XWINDOW (selected_window
);
11654 struct buffer
*buffer
= XBUFFER (w
->buffer
);
11656 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
11657 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
11658 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
11659 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
11660 fprintf (stderr
, "=============================================\n");
11661 dump_glyph_matrix (w
->current_matrix
,
11662 NILP (glyphs
) ? 0 : XINT (glyphs
));
11667 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
11668 "Dump glyph row ROW to stderr.\n\
11669 GLYPH 0 means don't dump glyphs.\n\
11670 GLYPH 1 means dump glyphs in short form.\n\
11671 GLYPH > 1 or omitted means dump glyphs in long form.")
11673 Lisp_Object row
, glyphs
;
11675 CHECK_NUMBER (row
, 0);
11676 dump_glyph_row (XWINDOW (selected_window
)->current_matrix
,
11678 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
11683 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
11684 "Dump glyph row ROW of the tool-bar of the current frame to stderr.\n\
11685 GLYPH 0 means don't dump glyphs.\n\
11686 GLYPH 1 means dump glyphs in short form.\n\
11687 GLYPH > 1 or omitted means dump glyphs in long form.")
11689 Lisp_Object row
, glyphs
;
11691 struct frame
*sf
= SELECTED_FRAME ();
11692 struct glyph_matrix
*m
= (XWINDOW (sf
->tool_bar_window
)->current_matrix
);
11693 dump_glyph_row (m
, XINT (row
), INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
11698 DEFUN ("trace-redisplay-toggle", Ftrace_redisplay_toggle
,
11699 Strace_redisplay_toggle
, 0, 0, "",
11700 "Toggle tracing of redisplay.")
11703 trace_redisplay_p
= !trace_redisplay_p
;
11708 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, 1, "",
11709 "Print STRING to stderr.")
11711 Lisp_Object string
;
11713 CHECK_STRING (string
, 0);
11714 fprintf (stderr
, "%s", XSTRING (string
)->data
);
11718 #endif /* GLYPH_DEBUG */
11722 /***********************************************************************
11723 Building Desired Matrix Rows
11724 ***********************************************************************/
11726 /* Return a temporary glyph row holding the glyphs of an overlay
11727 arrow. Only used for non-window-redisplay windows. */
11729 static struct glyph_row
*
11730 get_overlay_arrow_glyph_row (w
)
11733 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
11734 struct buffer
*buffer
= XBUFFER (w
->buffer
);
11735 struct buffer
*old
= current_buffer
;
11736 unsigned char *arrow_string
= XSTRING (Voverlay_arrow_string
)->data
;
11737 int arrow_len
= XSTRING (Voverlay_arrow_string
)->size
;
11738 unsigned char *arrow_end
= arrow_string
+ arrow_len
;
11742 int n_glyphs_before
;
11744 set_buffer_temp (buffer
);
11745 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
11746 it
.glyph_row
->used
[TEXT_AREA
] = 0;
11747 SET_TEXT_POS (it
.position
, 0, 0);
11749 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
11751 while (p
< arrow_end
)
11753 Lisp_Object face
, ilisp
;
11755 /* Get the next character. */
11757 it
.c
= string_char_and_length (p
, arrow_len
, &it
.len
);
11759 it
.c
= *p
, it
.len
= 1;
11762 /* Get its face. */
11763 XSETFASTINT (ilisp
, p
- arrow_string
);
11764 face
= Fget_text_property (ilisp
, Qface
, Voverlay_arrow_string
);
11765 it
.face_id
= compute_char_face (f
, it
.c
, face
);
11767 /* Compute its width, get its glyphs. */
11768 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
11769 SET_TEXT_POS (it
.position
, -1, -1);
11770 PRODUCE_GLYPHS (&it
);
11772 /* If this character doesn't fit any more in the line, we have
11773 to remove some glyphs. */
11774 if (it
.current_x
> it
.last_visible_x
)
11776 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
11781 set_buffer_temp (old
);
11782 return it
.glyph_row
;
11786 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
11787 glyphs are only inserted for terminal frames since we can't really
11788 win with truncation glyphs when partially visible glyphs are
11789 involved. Which glyphs to insert is determined by
11790 produce_special_glyphs. */
11793 insert_left_trunc_glyphs (it
)
11796 struct it truncate_it
;
11797 struct glyph
*from
, *end
, *to
, *toend
;
11799 xassert (!FRAME_WINDOW_P (it
->f
));
11801 /* Get the truncation glyphs. */
11803 truncate_it
.current_x
= 0;
11804 truncate_it
.face_id
= DEFAULT_FACE_ID
;
11805 truncate_it
.glyph_row
= &scratch_glyph_row
;
11806 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
11807 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
11808 truncate_it
.object
= make_number (0);
11809 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
11811 /* Overwrite glyphs from IT with truncation glyphs. */
11812 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
11813 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
11814 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
11815 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
11820 /* There may be padding glyphs left over. Overwrite them too. */
11821 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
11823 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
11829 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
11833 /* Compute the pixel height and width of IT->glyph_row.
11835 Most of the time, ascent and height of a display line will be equal
11836 to the max_ascent and max_height values of the display iterator
11837 structure. This is not the case if
11839 1. We hit ZV without displaying anything. In this case, max_ascent
11840 and max_height will be zero.
11842 2. We have some glyphs that don't contribute to the line height.
11843 (The glyph row flag contributes_to_line_height_p is for future
11844 pixmap extensions).
11846 The first case is easily covered by using default values because in
11847 these cases, the line height does not really matter, except that it
11848 must not be zero. */
11851 compute_line_metrics (it
)
11854 struct glyph_row
*row
= it
->glyph_row
;
11857 if (FRAME_WINDOW_P (it
->f
))
11859 int i
, header_line_height
;
11861 /* The line may consist of one space only, that was added to
11862 place the cursor on it. If so, the row's height hasn't been
11864 if (row
->height
== 0)
11866 if (it
->max_ascent
+ it
->max_descent
== 0)
11867 it
->max_descent
= it
->max_phys_descent
= CANON_Y_UNIT (it
->f
);
11868 row
->ascent
= it
->max_ascent
;
11869 row
->height
= it
->max_ascent
+ it
->max_descent
;
11870 row
->phys_ascent
= it
->max_phys_ascent
;
11871 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
11874 /* Compute the width of this line. */
11875 row
->pixel_width
= row
->x
;
11876 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
11877 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
11879 xassert (row
->pixel_width
>= 0);
11880 xassert (row
->ascent
>= 0 && row
->height
> 0);
11882 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
11883 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
11885 /* If first line's physical ascent is larger than its logical
11886 ascent, use the physical ascent, and make the row taller.
11887 This makes accented characters fully visible. */
11888 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
11889 && row
->phys_ascent
> row
->ascent
)
11891 row
->height
+= row
->phys_ascent
- row
->ascent
;
11892 row
->ascent
= row
->phys_ascent
;
11895 /* Compute how much of the line is visible. */
11896 row
->visible_height
= row
->height
;
11898 header_line_height
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (it
->w
);
11899 if (row
->y
< header_line_height
)
11900 row
->visible_height
-= header_line_height
- row
->y
;
11903 int max_y
= WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE (it
->w
);
11904 if (row
->y
+ row
->height
> max_y
)
11905 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
11910 row
->pixel_width
= row
->used
[TEXT_AREA
];
11911 row
->ascent
= row
->phys_ascent
= 0;
11912 row
->height
= row
->phys_height
= row
->visible_height
= 1;
11915 /* Compute a hash code for this row. */
11917 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
11918 for (i
= 0; i
< row
->used
[area
]; ++i
)
11919 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
11920 + row
->glyphs
[area
][i
].u
.val
11921 + row
->glyphs
[area
][i
].face_id
11922 + row
->glyphs
[area
][i
].padding_p
11923 + (row
->glyphs
[area
][i
].type
<< 2));
11925 it
->max_ascent
= it
->max_descent
= 0;
11926 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
11930 /* Append one space to the glyph row of iterator IT if doing a
11931 window-based redisplay. DEFAULT_FACE_P non-zero means let the
11932 space have the default face, otherwise let it have the same face as
11933 IT->face_id. Value is non-zero if a space was added.
11935 This function is called to make sure that there is always one glyph
11936 at the end of a glyph row that the cursor can be set on under
11937 window-systems. (If there weren't such a glyph we would not know
11938 how wide and tall a box cursor should be displayed).
11940 At the same time this space let's a nicely handle clearing to the
11941 end of the line if the row ends in italic text. */
11944 append_space (it
, default_face_p
)
11946 int default_face_p
;
11948 if (FRAME_WINDOW_P (it
->f
))
11950 int n
= it
->glyph_row
->used
[TEXT_AREA
];
11952 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
11953 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
11955 /* Save some values that must not be changed.
11956 Must save IT->c and IT->len because otherwise
11957 ITERATOR_AT_END_P wouldn't work anymore after
11958 append_space has been called. */
11959 enum display_element_type saved_what
= it
->what
;
11960 int saved_c
= it
->c
, saved_len
= it
->len
;
11961 int saved_x
= it
->current_x
;
11962 int saved_face_id
= it
->face_id
;
11963 struct text_pos saved_pos
;
11964 Lisp_Object saved_object
;
11967 saved_object
= it
->object
;
11968 saved_pos
= it
->position
;
11970 it
->what
= IT_CHARACTER
;
11971 bzero (&it
->position
, sizeof it
->position
);
11972 it
->object
= make_number (0);
11976 if (default_face_p
)
11977 it
->face_id
= DEFAULT_FACE_ID
;
11978 else if (it
->face_before_selective_p
)
11979 it
->face_id
= it
->saved_face_id
;
11980 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
11981 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0);
11983 PRODUCE_GLYPHS (it
);
11985 it
->current_x
= saved_x
;
11986 it
->object
= saved_object
;
11987 it
->position
= saved_pos
;
11988 it
->what
= saved_what
;
11989 it
->face_id
= saved_face_id
;
11990 it
->len
= saved_len
;
12000 /* Extend the face of the last glyph in the text area of IT->glyph_row
12001 to the end of the display line. Called from display_line.
12002 If the glyph row is empty, add a space glyph to it so that we
12003 know the face to draw. Set the glyph row flag fill_line_p. */
12006 extend_face_to_end_of_line (it
)
12010 struct frame
*f
= it
->f
;
12012 /* If line is already filled, do nothing. */
12013 if (it
->current_x
>= it
->last_visible_x
)
12016 /* Face extension extends the background and box of IT->face_id
12017 to the end of the line. If the background equals the background
12018 of the frame, we don't have to do anything. */
12019 if (it
->face_before_selective_p
)
12020 face
= FACE_FROM_ID (it
->f
, it
->saved_face_id
);
12022 face
= FACE_FROM_ID (f
, it
->face_id
);
12024 if (FRAME_WINDOW_P (f
)
12025 && face
->box
== FACE_NO_BOX
12026 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
12030 /* Set the glyph row flag indicating that the face of the last glyph
12031 in the text area has to be drawn to the end of the text area. */
12032 it
->glyph_row
->fill_line_p
= 1;
12034 /* If current character of IT is not ASCII, make sure we have the
12035 ASCII face. This will be automatically undone the next time
12036 get_next_display_element returns a multibyte character. Note
12037 that the character will always be single byte in unibyte text. */
12038 if (!SINGLE_BYTE_CHAR_P (it
->c
))
12040 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0);
12043 if (FRAME_WINDOW_P (f
))
12045 /* If the row is empty, add a space with the current face of IT,
12046 so that we know which face to draw. */
12047 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
12049 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
12050 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
12051 it
->glyph_row
->used
[TEXT_AREA
] = 1;
12056 /* Save some values that must not be changed. */
12057 int saved_x
= it
->current_x
;
12058 struct text_pos saved_pos
;
12059 Lisp_Object saved_object
;
12060 enum display_element_type saved_what
= it
->what
;
12061 int saved_face_id
= it
->face_id
;
12063 saved_object
= it
->object
;
12064 saved_pos
= it
->position
;
12066 it
->what
= IT_CHARACTER
;
12067 bzero (&it
->position
, sizeof it
->position
);
12068 it
->object
= make_number (0);
12071 it
->face_id
= face
->id
;
12073 PRODUCE_GLYPHS (it
);
12075 while (it
->current_x
<= it
->last_visible_x
)
12076 PRODUCE_GLYPHS (it
);
12078 /* Don't count these blanks really. It would let us insert a left
12079 truncation glyph below and make us set the cursor on them, maybe. */
12080 it
->current_x
= saved_x
;
12081 it
->object
= saved_object
;
12082 it
->position
= saved_pos
;
12083 it
->what
= saved_what
;
12084 it
->face_id
= saved_face_id
;
12089 /* Value is non-zero if text starting at CHARPOS in current_buffer is
12090 trailing whitespace. */
12093 trailing_whitespace_p (charpos
)
12096 int bytepos
= CHAR_TO_BYTE (charpos
);
12099 while (bytepos
< ZV_BYTE
12100 && (c
= FETCH_CHAR (bytepos
),
12101 c
== ' ' || c
== '\t'))
12104 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
12106 if (bytepos
!= PT_BYTE
)
12113 /* Highlight trailing whitespace, if any, in ROW. */
12116 highlight_trailing_whitespace (f
, row
)
12118 struct glyph_row
*row
;
12120 int used
= row
->used
[TEXT_AREA
];
12124 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
12125 struct glyph
*glyph
= start
+ used
- 1;
12127 /* Skip over the space glyph inserted to display the
12128 cursor at the end of a line. */
12129 if (glyph
->type
== CHAR_GLYPH
12130 && glyph
->u
.ch
== ' '
12131 && INTEGERP (glyph
->object
))
12134 /* If last glyph is a space or stretch, and it's trailing
12135 whitespace, set the face of all trailing whitespace glyphs in
12136 IT->glyph_row to `trailing-whitespace'. */
12138 && BUFFERP (glyph
->object
)
12139 && (glyph
->type
== STRETCH_GLYPH
12140 || (glyph
->type
== CHAR_GLYPH
12141 && glyph
->u
.ch
== ' '))
12142 && trailing_whitespace_p (glyph
->charpos
))
12144 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
12146 while (glyph
>= start
12147 && BUFFERP (glyph
->object
)
12148 && (glyph
->type
== STRETCH_GLYPH
12149 || (glyph
->type
== CHAR_GLYPH
12150 && glyph
->u
.ch
== ' ')))
12151 (glyph
--)->face_id
= face_id
;
12157 /* Value is non-zero if glyph row ROW in window W should be
12158 used to hold the cursor. */
12161 cursor_row_p (w
, row
)
12163 struct glyph_row
*row
;
12165 int cursor_row_p
= 1;
12167 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
12169 /* If the row ends with a newline from a string, we don't want
12170 the cursor there (if the row is continued it doesn't end in a
12172 if (CHARPOS (row
->end
.string_pos
) >= 0
12173 || MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
12174 cursor_row_p
= row
->continued_p
;
12176 /* If the row ends at ZV, display the cursor at the end of that
12177 row instead of at the start of the row below. */
12178 else if (row
->ends_at_zv_p
)
12184 return cursor_row_p
;
12188 /* Construct the glyph row IT->glyph_row in the desired matrix of
12189 IT->w from text at the current position of IT. See dispextern.h
12190 for an overview of struct it. Value is non-zero if
12191 IT->glyph_row displays text, as opposed to a line displaying ZV
12198 struct glyph_row
*row
= it
->glyph_row
;
12200 /* We always start displaying at hpos zero even if hscrolled. */
12201 xassert (it
->hpos
== 0 && it
->current_x
== 0);
12203 /* We must not display in a row that's not a text row. */
12204 xassert (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
12205 < it
->w
->desired_matrix
->nrows
);
12207 /* Is IT->w showing the region? */
12208 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
12210 /* Clear the result glyph row and enable it. */
12211 prepare_desired_row (row
);
12213 row
->y
= it
->current_y
;
12214 row
->start
= it
->current
;
12215 row
->continuation_lines_width
= it
->continuation_lines_width
;
12216 row
->displays_text_p
= 1;
12217 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
12218 it
->starts_in_middle_of_char_p
= 0;
12220 /* Arrange the overlays nicely for our purposes. Usually, we call
12221 display_line on only one line at a time, in which case this
12222 can't really hurt too much, or we call it on lines which appear
12223 one after another in the buffer, in which case all calls to
12224 recenter_overlay_lists but the first will be pretty cheap. */
12225 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
12227 /* Move over display elements that are not visible because we are
12228 hscrolled. This may stop at an x-position < IT->first_visible_x
12229 if the first glyph is partially visible or if we hit a line end. */
12230 if (it
->current_x
< it
->first_visible_x
)
12231 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
12232 MOVE_TO_POS
| MOVE_TO_X
);
12234 /* Get the initial row height. This is either the height of the
12235 text hscrolled, if there is any, or zero. */
12236 row
->ascent
= it
->max_ascent
;
12237 row
->height
= it
->max_ascent
+ it
->max_descent
;
12238 row
->phys_ascent
= it
->max_phys_ascent
;
12239 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
12241 /* Loop generating characters. The loop is left with IT on the next
12242 character to display. */
12245 int n_glyphs_before
, hpos_before
, x_before
;
12247 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
12249 /* Retrieve the next thing to display. Value is zero if end of
12251 if (!get_next_display_element (it
))
12253 /* Maybe add a space at the end of this line that is used to
12254 display the cursor there under X. Set the charpos of the
12255 first glyph of blank lines not corresponding to any text
12257 if ((append_space (it
, 1) && row
->used
[TEXT_AREA
] == 1)
12258 || row
->used
[TEXT_AREA
] == 0)
12260 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
12261 row
->displays_text_p
= 0;
12263 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
))
12264 row
->indicate_empty_line_p
= 1;
12267 it
->continuation_lines_width
= 0;
12268 row
->ends_at_zv_p
= 1;
12272 /* Now, get the metrics of what we want to display. This also
12273 generates glyphs in `row' (which is IT->glyph_row). */
12274 n_glyphs_before
= row
->used
[TEXT_AREA
];
12277 /* Remember the line height so far in case the next element doesn't
12278 fit on the line. */
12279 if (!it
->truncate_lines_p
)
12281 ascent
= it
->max_ascent
;
12282 descent
= it
->max_descent
;
12283 phys_ascent
= it
->max_phys_ascent
;
12284 phys_descent
= it
->max_phys_descent
;
12287 PRODUCE_GLYPHS (it
);
12289 /* If this display element was in marginal areas, continue with
12291 if (it
->area
!= TEXT_AREA
)
12293 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
12294 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
12295 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
12296 row
->phys_height
= max (row
->phys_height
,
12297 it
->max_phys_ascent
+ it
->max_phys_descent
);
12298 set_iterator_to_next (it
, 1);
12302 /* Does the display element fit on the line? If we truncate
12303 lines, we should draw past the right edge of the window. If
12304 we don't truncate, we want to stop so that we can display the
12305 continuation glyph before the right margin. If lines are
12306 continued, there are two possible strategies for characters
12307 resulting in more than 1 glyph (e.g. tabs): Display as many
12308 glyphs as possible in this line and leave the rest for the
12309 continuation line, or display the whole element in the next
12310 line. Original redisplay did the former, so we do it also. */
12311 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12312 hpos_before
= it
->hpos
;
12315 if (/* Not a newline. */
12317 /* Glyphs produced fit entirely in the line. */
12318 && it
->current_x
< it
->last_visible_x
)
12320 it
->hpos
+= nglyphs
;
12321 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
12322 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
12323 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
12324 row
->phys_height
= max (row
->phys_height
,
12325 it
->max_phys_ascent
+ it
->max_phys_descent
);
12326 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
12327 row
->x
= x
- it
->first_visible_x
;
12332 struct glyph
*glyph
;
12334 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
12336 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12337 new_x
= x
+ glyph
->pixel_width
;
12339 if (/* Lines are continued. */
12340 !it
->truncate_lines_p
12341 && (/* Glyph doesn't fit on the line. */
12342 new_x
> it
->last_visible_x
12343 /* Or it fits exactly on a window system frame. */
12344 || (new_x
== it
->last_visible_x
12345 && FRAME_WINDOW_P (it
->f
))))
12347 /* End of a continued line. */
12350 || (new_x
== it
->last_visible_x
12351 && FRAME_WINDOW_P (it
->f
)))
12353 /* Current glyph is the only one on the line or
12354 fits exactly on the line. We must continue
12355 the line because we can't draw the cursor
12356 after the glyph. */
12357 row
->continued_p
= 1;
12358 it
->current_x
= new_x
;
12359 it
->continuation_lines_width
+= new_x
;
12361 if (i
== nglyphs
- 1)
12362 set_iterator_to_next (it
, 1);
12364 else if (CHAR_GLYPH_PADDING_P (*glyph
)
12365 && !FRAME_WINDOW_P (it
->f
))
12367 /* A padding glyph that doesn't fit on this line.
12368 This means the whole character doesn't fit
12370 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12372 /* Fill the rest of the row with continuation
12373 glyphs like in 20.x. */
12374 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
12375 < row
->glyphs
[1 + TEXT_AREA
])
12376 produce_special_glyphs (it
, IT_CONTINUATION
);
12378 row
->continued_p
= 1;
12379 it
->current_x
= x_before
;
12380 it
->continuation_lines_width
+= x_before
;
12382 /* Restore the height to what it was before the
12383 element not fitting on the line. */
12384 it
->max_ascent
= ascent
;
12385 it
->max_descent
= descent
;
12386 it
->max_phys_ascent
= phys_ascent
;
12387 it
->max_phys_descent
= phys_descent
;
12391 /* Display element draws past the right edge of
12392 the window. Restore positions to values
12393 before the element. The next line starts
12394 with current_x before the glyph that could
12395 not be displayed, so that TAB works right. */
12396 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
12398 /* Display continuation glyphs. */
12399 if (!FRAME_WINDOW_P (it
->f
))
12400 produce_special_glyphs (it
, IT_CONTINUATION
);
12401 row
->continued_p
= 1;
12404 it
->continuation_lines_width
+= x
;
12405 if (nglyphs
> 1 && i
> 0)
12407 row
->ends_in_middle_of_char_p
= 1;
12408 it
->starts_in_middle_of_char_p
= 1;
12411 /* Restore the height to what it was before the
12412 element not fitting on the line. */
12413 it
->max_ascent
= ascent
;
12414 it
->max_descent
= descent
;
12415 it
->max_phys_ascent
= phys_ascent
;
12416 it
->max_phys_descent
= phys_descent
;
12421 else if (new_x
> it
->first_visible_x
)
12423 /* Increment number of glyphs actually displayed. */
12426 if (x
< it
->first_visible_x
)
12427 /* Glyph is partially visible, i.e. row starts at
12428 negative X position. */
12429 row
->x
= x
- it
->first_visible_x
;
12433 /* Glyph is completely off the left margin of the
12434 window. This should not happen because of the
12435 move_it_in_display_line at the start of
12441 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
12442 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
12443 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
12444 row
->phys_height
= max (row
->phys_height
,
12445 it
->max_phys_ascent
+ it
->max_phys_descent
);
12447 /* End of this display line if row is continued. */
12448 if (row
->continued_p
)
12452 /* Is this a line end? If yes, we're also done, after making
12453 sure that a non-default face is extended up to the right
12454 margin of the window. */
12455 if (ITERATOR_AT_END_OF_LINE_P (it
))
12457 int used_before
= row
->used
[TEXT_AREA
];
12459 /* Add a space at the end of the line that is used to
12460 display the cursor there. */
12461 append_space (it
, 0);
12463 /* Extend the face to the end of the line. */
12464 extend_face_to_end_of_line (it
);
12466 /* Make sure we have the position. */
12467 if (used_before
== 0)
12468 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
12470 /* Consume the line end. This skips over invisible lines. */
12471 set_iterator_to_next (it
, 1);
12472 it
->continuation_lines_width
= 0;
12476 /* Proceed with next display element. Note that this skips
12477 over lines invisible because of selective display. */
12478 set_iterator_to_next (it
, 1);
12480 /* If we truncate lines, we are done when the last displayed
12481 glyphs reach past the right margin of the window. */
12482 if (it
->truncate_lines_p
12483 && (FRAME_WINDOW_P (it
->f
)
12484 ? (it
->current_x
>= it
->last_visible_x
)
12485 : (it
->current_x
> it
->last_visible_x
)))
12487 /* Maybe add truncation glyphs. */
12488 if (!FRAME_WINDOW_P (it
->f
))
12492 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
12493 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
12496 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
12498 row
->used
[TEXT_AREA
] = i
;
12499 produce_special_glyphs (it
, IT_TRUNCATION
);
12503 row
->truncated_on_right_p
= 1;
12504 it
->continuation_lines_width
= 0;
12505 reseat_at_next_visible_line_start (it
, 0);
12506 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
12507 it
->hpos
= hpos_before
;
12508 it
->current_x
= x_before
;
12513 /* If line is not empty and hscrolled, maybe insert truncation glyphs
12514 at the left window margin. */
12515 if (it
->first_visible_x
12516 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
12518 if (!FRAME_WINDOW_P (it
->f
))
12519 insert_left_trunc_glyphs (it
);
12520 row
->truncated_on_left_p
= 1;
12523 /* If the start of this line is the overlay arrow-position, then
12524 mark this glyph row as the one containing the overlay arrow.
12525 This is clearly a mess with variable size fonts. It would be
12526 better to let it be displayed like cursors under X. */
12527 if (MARKERP (Voverlay_arrow_position
)
12528 && current_buffer
== XMARKER (Voverlay_arrow_position
)->buffer
12529 && (MATRIX_ROW_START_CHARPOS (row
)
12530 == marker_position (Voverlay_arrow_position
))
12531 && STRINGP (Voverlay_arrow_string
)
12532 && ! overlay_arrow_seen
)
12534 /* Overlay arrow in window redisplay is a bitmap. */
12535 if (!FRAME_WINDOW_P (it
->f
))
12537 struct glyph_row
*arrow_row
= get_overlay_arrow_glyph_row (it
->w
);
12538 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
12539 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
12540 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
12541 struct glyph
*p2
, *end
;
12543 /* Copy the arrow glyphs. */
12544 while (glyph
< arrow_end
)
12547 /* Throw away padding glyphs. */
12549 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
12550 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
12556 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
12560 overlay_arrow_seen
= 1;
12561 row
->overlay_arrow_p
= 1;
12564 /* Compute pixel dimensions of this line. */
12565 compute_line_metrics (it
);
12567 /* Remember the position at which this line ends. */
12568 row
->end
= it
->current
;
12570 /* Maybe set the cursor. */
12571 if (it
->w
->cursor
.vpos
< 0
12572 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
12573 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
12574 && cursor_row_p (it
->w
, row
))
12575 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
12577 /* Highlight trailing whitespace. */
12578 if (!NILP (Vshow_trailing_whitespace
))
12579 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
12581 /* Prepare for the next line. This line starts horizontally at (X
12582 HPOS) = (0 0). Vertical positions are incremented. As a
12583 convenience for the caller, IT->glyph_row is set to the next
12585 it
->current_x
= it
->hpos
= 0;
12586 it
->current_y
+= row
->height
;
12589 return row
->displays_text_p
;
12594 /***********************************************************************
12596 ***********************************************************************/
12598 /* Redisplay the menu bar in the frame for window W.
12600 The menu bar of X frames that don't have X toolkit support is
12601 displayed in a special window W->frame->menu_bar_window.
12603 The menu bar of terminal frames is treated specially as far as
12604 glyph matrices are concerned. Menu bar lines are not part of
12605 windows, so the update is done directly on the frame matrix rows
12606 for the menu bar. */
12609 display_menu_bar (w
)
12612 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
12617 /* Don't do all this for graphical frames. */
12619 if (!NILP (Vwindow_system
))
12622 #ifdef USE_X_TOOLKIT
12627 if (FRAME_MAC_P (f
))
12631 #ifdef USE_X_TOOLKIT
12632 xassert (!FRAME_WINDOW_P (f
));
12633 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
12634 it
.first_visible_x
= 0;
12635 it
.last_visible_x
= FRAME_WINDOW_WIDTH (f
) * CANON_X_UNIT (f
);
12636 #else /* not USE_X_TOOLKIT */
12637 if (FRAME_WINDOW_P (f
))
12639 /* Menu bar lines are displayed in the desired matrix of the
12640 dummy window menu_bar_window. */
12641 struct window
*menu_w
;
12642 xassert (WINDOWP (f
->menu_bar_window
));
12643 menu_w
= XWINDOW (f
->menu_bar_window
);
12644 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
12646 it
.first_visible_x
= 0;
12647 it
.last_visible_x
= FRAME_WINDOW_WIDTH (f
) * CANON_X_UNIT (f
);
12651 /* This is a TTY frame, i.e. character hpos/vpos are used as
12653 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
12655 it
.first_visible_x
= 0;
12656 it
.last_visible_x
= FRAME_WIDTH (f
);
12658 #endif /* not USE_X_TOOLKIT */
12660 if (! mode_line_inverse_video
)
12661 /* Force the menu-bar to be displayed in the default face. */
12662 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
12664 /* Clear all rows of the menu bar. */
12665 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
12667 struct glyph_row
*row
= it
.glyph_row
+ i
;
12668 clear_glyph_row (row
);
12669 row
->enabled_p
= 1;
12670 row
->full_width_p
= 1;
12673 /* Display all items of the menu bar. */
12674 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
12675 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
12677 Lisp_Object string
;
12679 /* Stop at nil string. */
12680 string
= AREF (items
, i
+ 1);
12684 /* Remember where item was displayed. */
12685 AREF (items
, i
+ 3) = make_number (it
.hpos
);
12687 /* Display the item, pad with one space. */
12688 if (it
.current_x
< it
.last_visible_x
)
12689 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
12690 XSTRING (string
)->size
+ 1, 0, 0, -1);
12693 /* Fill out the line with spaces. */
12694 if (it
.current_x
< it
.last_visible_x
)
12695 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
12697 /* Compute the total height of the lines. */
12698 compute_line_metrics (&it
);
12703 /***********************************************************************
12705 ***********************************************************************/
12707 /* Redisplay mode lines in the window tree whose root is WINDOW. If
12708 FORCE is non-zero, redisplay mode lines unconditionally.
12709 Otherwise, redisplay only mode lines that are garbaged. Value is
12710 the number of windows whose mode lines were redisplayed. */
12713 redisplay_mode_lines (window
, force
)
12714 Lisp_Object window
;
12719 while (!NILP (window
))
12721 struct window
*w
= XWINDOW (window
);
12723 if (WINDOWP (w
->hchild
))
12724 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
12725 else if (WINDOWP (w
->vchild
))
12726 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
12728 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
12729 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
12731 Lisp_Object old_selected_frame
;
12732 struct text_pos lpoint
;
12733 struct buffer
*old
= current_buffer
;
12735 /* Set the window's buffer for the mode line display. */
12736 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
12737 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12739 /* Point refers normally to the selected window. For any
12740 other window, set up appropriate value. */
12741 if (!EQ (window
, selected_window
))
12743 struct text_pos pt
;
12745 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
12746 if (CHARPOS (pt
) < BEGV
)
12747 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
12748 else if (CHARPOS (pt
) > (ZV
- 1))
12749 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
12751 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
12754 /* Temporarily set up the selected frame. */
12755 old_selected_frame
= selected_frame
;
12756 selected_frame
= w
->frame
;
12758 /* Display mode lines. */
12759 clear_glyph_matrix (w
->desired_matrix
);
12760 if (display_mode_lines (w
))
12763 w
->must_be_updated_p
= 1;
12766 /* Restore old settings. */
12767 selected_frame
= old_selected_frame
;
12768 set_buffer_internal_1 (old
);
12769 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
12779 /* Display the mode and/or top line of window W. Value is the number
12780 of mode lines displayed. */
12783 display_mode_lines (w
)
12788 /* These will be set while the mode line specs are processed. */
12789 line_number_displayed
= 0;
12790 w
->column_number_displayed
= Qnil
;
12792 if (WINDOW_WANTS_MODELINE_P (w
))
12794 display_mode_line (w
, MODE_LINE_FACE_ID
,
12795 current_buffer
->mode_line_format
);
12799 if (WINDOW_WANTS_HEADER_LINE_P (w
))
12801 display_mode_line (w
, HEADER_LINE_FACE_ID
,
12802 current_buffer
->header_line_format
);
12810 /* Display mode or top line of window W. FACE_ID specifies which line
12811 to display; it is either MODE_LINE_FACE_ID or HEADER_LINE_FACE_ID.
12812 FORMAT is the mode line format to display. Value is the pixel
12813 height of the mode line displayed. */
12816 display_mode_line (w
, face_id
, format
)
12818 enum face_id face_id
;
12819 Lisp_Object format
;
12824 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
12825 prepare_desired_row (it
.glyph_row
);
12827 if (! mode_line_inverse_video
)
12828 /* Force the mode-line to be displayed in the default face. */
12829 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
12831 /* Temporarily make frame's keyboard the current kboard so that
12832 kboard-local variables in the mode_line_format will get the right
12834 push_frame_kboard (it
.f
);
12835 display_mode_element (&it
, 0, 0, 0, format
);
12836 pop_frame_kboard ();
12838 /* Fill up with spaces. */
12839 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
12841 compute_line_metrics (&it
);
12842 it
.glyph_row
->full_width_p
= 1;
12843 it
.glyph_row
->mode_line_p
= 1;
12844 it
.glyph_row
->inverse_p
= 0;
12845 it
.glyph_row
->continued_p
= 0;
12846 it
.glyph_row
->truncated_on_left_p
= 0;
12847 it
.glyph_row
->truncated_on_right_p
= 0;
12849 /* Make a 3D mode-line have a shadow at its right end. */
12850 face
= FACE_FROM_ID (it
.f
, face_id
);
12851 extend_face_to_end_of_line (&it
);
12852 if (face
->box
!= FACE_NO_BOX
)
12854 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
12855 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
12856 last
->right_box_line_p
= 1;
12859 return it
.glyph_row
->height
;
12863 /* Contribute ELT to the mode line for window IT->w. How it
12864 translates into text depends on its data type.
12866 IT describes the display environment in which we display, as usual.
12868 DEPTH is the depth in recursion. It is used to prevent
12869 infinite recursion here.
12871 FIELD_WIDTH is the number of characters the display of ELT should
12872 occupy in the mode line, and PRECISION is the maximum number of
12873 characters to display from ELT's representation. See
12874 display_string for details. *
12876 Returns the hpos of the end of the text generated by ELT. */
12879 display_mode_element (it
, depth
, field_width
, precision
, elt
)
12882 int field_width
, precision
;
12885 int n
= 0, field
, prec
;
12893 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
12897 /* A string: output it and check for %-constructs within it. */
12899 unsigned char *this = XSTRING (elt
)->data
;
12900 unsigned char *lisp_string
= this;
12902 while ((precision
<= 0 || n
< precision
)
12904 && (frame_title_ptr
12905 || it
->current_x
< it
->last_visible_x
))
12907 unsigned char *last
= this;
12909 /* Advance to end of string or next format specifier. */
12910 while ((c
= *this++) != '\0' && c
!= '%')
12913 if (this - 1 != last
)
12915 /* Output to end of string or up to '%'. Field width
12916 is length of string. Don't output more than
12917 PRECISION allows us. */
12919 prec
= strwidth (last
, this - last
);
12920 if (precision
> 0 && prec
> precision
- n
)
12921 prec
= precision
- n
;
12923 if (frame_title_ptr
)
12924 n
+= store_frame_title (last
, 0, prec
);
12926 n
+= display_string (NULL
, elt
, Qnil
, 0, last
- lisp_string
,
12927 it
, 0, prec
, 0, -1);
12929 else /* c == '%' */
12931 unsigned char *percent_position
= this;
12933 /* Get the specified minimum width. Zero means
12936 while ((c
= *this++) >= '0' && c
<= '9')
12937 field
= field
* 10 + c
- '0';
12939 /* Don't pad beyond the total padding allowed. */
12940 if (field_width
- n
> 0 && field
> field_width
- n
)
12941 field
= field_width
- n
;
12943 /* Note that either PRECISION <= 0 or N < PRECISION. */
12944 prec
= precision
- n
;
12947 n
+= display_mode_element (it
, depth
, field
, prec
,
12948 Vglobal_mode_string
);
12951 unsigned char *spec
12952 = decode_mode_spec (it
->w
, c
, field
, prec
);
12954 if (frame_title_ptr
)
12955 n
+= store_frame_title (spec
, field
, prec
);
12959 = it
->glyph_row
->used
[TEXT_AREA
];
12961 = percent_position
- XSTRING (elt
)->data
;
12963 = display_string (spec
, Qnil
, elt
, charpos
, 0, it
,
12964 field
, prec
, 0, -1);
12966 /* Assign to the glyphs written above the
12967 string where the `%x' came from, position
12971 struct glyph
*glyph
12972 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
12976 for (i
= 0; i
< nwritten
; ++i
)
12978 glyph
[i
].object
= elt
;
12979 glyph
[i
].charpos
= charpos
;
12992 /* A symbol: process the value of the symbol recursively
12993 as if it appeared here directly. Avoid error if symbol void.
12994 Special case: if value of symbol is a string, output the string
12997 register Lisp_Object tem
;
12998 tem
= Fboundp (elt
);
13001 tem
= Fsymbol_value (elt
);
13002 /* If value is a string, output that string literally:
13003 don't check for % within it. */
13006 prec
= precision
- n
;
13007 if (frame_title_ptr
)
13008 n
+= store_frame_title (XSTRING (tem
)->data
, -1, prec
);
13010 n
+= display_string (NULL
, tem
, Qnil
, 0, 0, it
,
13013 else if (!EQ (tem
, elt
))
13015 /* Give up right away for nil or t. */
13025 register Lisp_Object car
, tem
;
13027 /* A cons cell: three distinct cases.
13028 If first element is a string or a cons, process all the elements
13029 and effectively concatenate them.
13030 If first element is a negative number, truncate displaying cdr to
13031 at most that many characters. If positive, pad (with spaces)
13032 to at least that many characters.
13033 If first element is a symbol, process the cadr or caddr recursively
13034 according to whether the symbol's value is non-nil or nil. */
13036 if (EQ (car
, QCeval
) && CONSP (XCDR (elt
)))
13038 /* An element of the form (:eval FORM) means evaluate FORM
13039 and use the result as mode line elements. */
13040 struct gcpro gcpro1
;
13043 spec
= safe_eval (XCAR (XCDR (elt
)));
13045 n
+= display_mode_element (it
, depth
, field_width
- n
,
13046 precision
- n
, spec
);
13049 else if (SYMBOLP (car
))
13051 tem
= Fboundp (car
);
13055 /* elt is now the cdr, and we know it is a cons cell.
13056 Use its car if CAR has a non-nil value. */
13059 tem
= Fsymbol_value (car
);
13066 /* Symbol's value is nil (or symbol is unbound)
13067 Get the cddr of the original list
13068 and if possible find the caddr and use that. */
13072 else if (!CONSP (elt
))
13077 else if (INTEGERP (car
))
13079 register int lim
= XINT (car
);
13083 /* Negative int means reduce maximum width. */
13084 if (precision
<= 0)
13087 precision
= min (precision
, -lim
);
13091 /* Padding specified. Don't let it be more than
13092 current maximum. */
13094 lim
= min (precision
, lim
);
13096 /* If that's more padding than already wanted, queue it.
13097 But don't reduce padding already specified even if
13098 that is beyond the current truncation point. */
13099 field_width
= max (lim
, field_width
);
13103 else if (STRINGP (car
) || CONSP (car
))
13105 register int limit
= 50;
13106 /* Limit is to protect against circular lists. */
13109 && (precision
<= 0 || n
< precision
))
13111 n
+= display_mode_element (it
, depth
, field_width
- n
,
13112 precision
- n
, XCAR (elt
));
13121 if (frame_title_ptr
)
13122 n
+= store_frame_title ("*invalid*", 0, precision
- n
);
13124 n
+= display_string ("*invalid*", Qnil
, Qnil
, 0, 0, it
, 0,
13125 precision
- n
, 0, 0);
13129 /* Pad to FIELD_WIDTH. */
13130 if (field_width
> 0 && n
< field_width
)
13132 if (frame_title_ptr
)
13133 n
+= store_frame_title ("", field_width
- n
, 0);
13135 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
13143 /* Write a null-terminated, right justified decimal representation of
13144 the positive integer D to BUF using a minimal field width WIDTH. */
13147 pint2str (buf
, width
, d
)
13148 register char *buf
;
13149 register int width
;
13152 register char *p
= buf
;
13160 *p
++ = d
% 10 + '0';
13165 for (width
-= (int) (p
- buf
); width
> 0; --width
)
13176 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
13177 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
13178 type of CODING_SYSTEM. Return updated pointer into BUF. */
13180 static unsigned char invalid_eol_type
[] = "(*invalid*)";
13183 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
13184 Lisp_Object coding_system
;
13185 register char *buf
;
13189 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
13190 unsigned char *eol_str
;
13192 /* The EOL conversion we are using. */
13193 Lisp_Object eoltype
;
13195 val
= Fget (coding_system
, Qcoding_system
);
13198 if (!VECTORP (val
)) /* Not yet decided. */
13203 eoltype
= eol_mnemonic_undecided
;
13204 /* Don't mention EOL conversion if it isn't decided. */
13208 Lisp_Object eolvalue
;
13210 eolvalue
= Fget (coding_system
, Qeol_type
);
13213 *buf
++ = XFASTINT (AREF (val
, 1));
13217 /* The EOL conversion that is normal on this system. */
13219 if (NILP (eolvalue
)) /* Not yet decided. */
13220 eoltype
= eol_mnemonic_undecided
;
13221 else if (VECTORP (eolvalue
)) /* Not yet decided. */
13222 eoltype
= eol_mnemonic_undecided
;
13223 else /* INTEGERP (eolvalue) -- 0:LF, 1:CRLF, 2:CR */
13224 eoltype
= (XFASTINT (eolvalue
) == 0
13225 ? eol_mnemonic_unix
13226 : (XFASTINT (eolvalue
) == 1
13227 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
13233 /* Mention the EOL conversion if it is not the usual one. */
13234 if (STRINGP (eoltype
))
13236 eol_str
= XSTRING (eoltype
)->data
;
13237 eol_str_len
= XSTRING (eoltype
)->size
;
13239 else if (INTEGERP (eoltype
)
13240 && CHAR_VALID_P (XINT (eoltype
), 0))
13242 eol_str
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
13243 eol_str_len
= CHAR_STRING (XINT (eoltype
), eol_str
);
13247 eol_str
= invalid_eol_type
;
13248 eol_str_len
= sizeof (invalid_eol_type
) - 1;
13250 bcopy (eol_str
, buf
, eol_str_len
);
13251 buf
+= eol_str_len
;
13257 /* Return a string for the output of a mode line %-spec for window W,
13258 generated by character C. PRECISION >= 0 means don't return a
13259 string longer than that value. FIELD_WIDTH > 0 means pad the
13260 string returned with spaces to that value. */
13262 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
13265 decode_mode_spec (w
, c
, field_width
, precision
)
13268 int field_width
, precision
;
13271 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
13272 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
13273 struct buffer
*b
= XBUFFER (w
->buffer
);
13280 if (!NILP (b
->read_only
))
13282 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
13287 /* This differs from %* only for a modified read-only buffer. */
13288 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
13290 if (!NILP (b
->read_only
))
13295 /* This differs from %* in ignoring read-only-ness. */
13296 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
13308 if (command_loop_level
> 5)
13310 p
= decode_mode_spec_buf
;
13311 for (i
= 0; i
< command_loop_level
; i
++)
13314 return decode_mode_spec_buf
;
13322 if (command_loop_level
> 5)
13324 p
= decode_mode_spec_buf
;
13325 for (i
= 0; i
< command_loop_level
; i
++)
13328 return decode_mode_spec_buf
;
13335 /* Let lots_of_dashes be a string of infinite length. */
13336 if (field_width
<= 0
13337 || field_width
> sizeof (lots_of_dashes
))
13339 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
13340 decode_mode_spec_buf
[i
] = '-';
13341 decode_mode_spec_buf
[i
] = '\0';
13342 return decode_mode_spec_buf
;
13345 return lots_of_dashes
;
13354 int col
= current_column ();
13355 XSETFASTINT (w
->column_number_displayed
, col
);
13356 pint2str (decode_mode_spec_buf
, field_width
, col
);
13357 return decode_mode_spec_buf
;
13361 /* %F displays the frame name. */
13362 if (!NILP (f
->title
))
13363 return (char *) XSTRING (f
->title
)->data
;
13364 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
13365 return (char *) XSTRING (f
->name
)->data
;
13374 int startpos
= XMARKER (w
->start
)->charpos
;
13375 int startpos_byte
= marker_byte_position (w
->start
);
13376 int line
, linepos
, linepos_byte
, topline
;
13378 int height
= XFASTINT (w
->height
);
13380 /* If we decided that this buffer isn't suitable for line numbers,
13381 don't forget that too fast. */
13382 if (EQ (w
->base_line_pos
, w
->buffer
))
13384 /* But do forget it, if the window shows a different buffer now. */
13385 else if (BUFFERP (w
->base_line_pos
))
13386 w
->base_line_pos
= Qnil
;
13388 /* If the buffer is very big, don't waste time. */
13389 if (INTEGERP (Vline_number_display_limit
)
13390 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
13392 w
->base_line_pos
= Qnil
;
13393 w
->base_line_number
= Qnil
;
13397 if (!NILP (w
->base_line_number
)
13398 && !NILP (w
->base_line_pos
)
13399 && XFASTINT (w
->base_line_pos
) <= startpos
)
13401 line
= XFASTINT (w
->base_line_number
);
13402 linepos
= XFASTINT (w
->base_line_pos
);
13403 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
13408 linepos
= BUF_BEGV (b
);
13409 linepos_byte
= BUF_BEGV_BYTE (b
);
13412 /* Count lines from base line to window start position. */
13413 nlines
= display_count_lines (linepos
, linepos_byte
,
13417 topline
= nlines
+ line
;
13419 /* Determine a new base line, if the old one is too close
13420 or too far away, or if we did not have one.
13421 "Too close" means it's plausible a scroll-down would
13422 go back past it. */
13423 if (startpos
== BUF_BEGV (b
))
13425 XSETFASTINT (w
->base_line_number
, topline
);
13426 XSETFASTINT (w
->base_line_pos
, BUF_BEGV (b
));
13428 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
13429 || linepos
== BUF_BEGV (b
))
13431 int limit
= BUF_BEGV (b
);
13432 int limit_byte
= BUF_BEGV_BYTE (b
);
13434 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
13436 if (startpos
- distance
> limit
)
13438 limit
= startpos
- distance
;
13439 limit_byte
= CHAR_TO_BYTE (limit
);
13442 nlines
= display_count_lines (startpos
, startpos_byte
,
13444 - (height
* 2 + 30),
13446 /* If we couldn't find the lines we wanted within
13447 line_number_display_limit_width chars per line,
13448 give up on line numbers for this window. */
13449 if (position
== limit_byte
&& limit
== startpos
- distance
)
13451 w
->base_line_pos
= w
->buffer
;
13452 w
->base_line_number
= Qnil
;
13456 XSETFASTINT (w
->base_line_number
, topline
- nlines
);
13457 XSETFASTINT (w
->base_line_pos
, BYTE_TO_CHAR (position
));
13460 /* Now count lines from the start pos to point. */
13461 nlines
= display_count_lines (startpos
, startpos_byte
,
13462 PT_BYTE
, PT
, &junk
);
13464 /* Record that we did display the line number. */
13465 line_number_displayed
= 1;
13467 /* Make the string to show. */
13468 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
13469 return decode_mode_spec_buf
;
13472 char* p
= decode_mode_spec_buf
;
13473 int pad
= field_width
- 2;
13479 return decode_mode_spec_buf
;
13485 obj
= b
->mode_name
;
13489 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
13495 int pos
= marker_position (w
->start
);
13496 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
13498 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
13500 if (pos
<= BUF_BEGV (b
))
13505 else if (pos
<= BUF_BEGV (b
))
13509 if (total
> 1000000)
13510 /* Do it differently for a large value, to avoid overflow. */
13511 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
13513 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
13514 /* We can't normally display a 3-digit number,
13515 so get us a 2-digit number that is close. */
13518 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
13519 return decode_mode_spec_buf
;
13523 /* Display percentage of size above the bottom of the screen. */
13526 int toppos
= marker_position (w
->start
);
13527 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
13528 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
13530 if (botpos
>= BUF_ZV (b
))
13532 if (toppos
<= BUF_BEGV (b
))
13539 if (total
> 1000000)
13540 /* Do it differently for a large value, to avoid overflow. */
13541 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
13543 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
13544 /* We can't normally display a 3-digit number,
13545 so get us a 2-digit number that is close. */
13548 if (toppos
<= BUF_BEGV (b
))
13549 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
13551 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
13552 return decode_mode_spec_buf
;
13557 /* status of process */
13558 obj
= Fget_buffer_process (w
->buffer
);
13560 return "no process";
13561 #ifdef subprocesses
13562 obj
= Fsymbol_name (Fprocess_status (obj
));
13566 case 't': /* indicate TEXT or BINARY */
13567 #ifdef MODE_LINE_BINARY_TEXT
13568 return MODE_LINE_BINARY_TEXT (b
);
13574 /* coding-system (not including end-of-line format) */
13576 /* coding-system (including end-of-line type) */
13578 int eol_flag
= (c
== 'Z');
13579 char *p
= decode_mode_spec_buf
;
13581 if (! FRAME_WINDOW_P (f
))
13583 /* No need to mention EOL here--the terminal never needs
13584 to do EOL conversion. */
13585 p
= decode_mode_spec_coding (keyboard_coding
.symbol
, p
, 0);
13586 p
= decode_mode_spec_coding (terminal_coding
.symbol
, p
, 0);
13588 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
13591 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
13592 #ifdef subprocesses
13593 obj
= Fget_buffer_process (Fcurrent_buffer ());
13594 if (PROCESSP (obj
))
13596 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
13598 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
13601 #endif /* subprocesses */
13604 return decode_mode_spec_buf
;
13609 return (char *) XSTRING (obj
)->data
;
13615 /* Count up to COUNT lines starting from START / START_BYTE.
13616 But don't go beyond LIMIT_BYTE.
13617 Return the number of lines thus found (always nonnegative).
13619 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
13622 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
13623 int start
, start_byte
, limit_byte
, count
;
13626 register unsigned char *cursor
;
13627 unsigned char *base
;
13629 register int ceiling
;
13630 register unsigned char *ceiling_addr
;
13631 int orig_count
= count
;
13633 /* If we are not in selective display mode,
13634 check only for newlines. */
13635 int selective_display
= (!NILP (current_buffer
->selective_display
)
13636 && !INTEGERP (current_buffer
->selective_display
));
13640 while (start_byte
< limit_byte
)
13642 ceiling
= BUFFER_CEILING_OF (start_byte
);
13643 ceiling
= min (limit_byte
- 1, ceiling
);
13644 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
13645 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
13648 if (selective_display
)
13649 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
13652 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
13655 if (cursor
!= ceiling_addr
)
13659 start_byte
+= cursor
- base
+ 1;
13660 *byte_pos_ptr
= start_byte
;
13664 if (++cursor
== ceiling_addr
)
13670 start_byte
+= cursor
- base
;
13675 while (start_byte
> limit_byte
)
13677 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
13678 ceiling
= max (limit_byte
, ceiling
);
13679 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
13680 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
13683 if (selective_display
)
13684 while (--cursor
!= ceiling_addr
13685 && *cursor
!= '\n' && *cursor
!= 015)
13688 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
13691 if (cursor
!= ceiling_addr
)
13695 start_byte
+= cursor
- base
+ 1;
13696 *byte_pos_ptr
= start_byte
;
13697 /* When scanning backwards, we should
13698 not count the newline posterior to which we stop. */
13699 return - orig_count
- 1;
13705 /* Here we add 1 to compensate for the last decrement
13706 of CURSOR, which took it past the valid range. */
13707 start_byte
+= cursor
- base
+ 1;
13711 *byte_pos_ptr
= limit_byte
;
13714 return - orig_count
+ count
;
13715 return orig_count
- count
;
13721 /***********************************************************************
13723 ***********************************************************************/
13725 /* Display a NUL-terminated string, starting with index START.
13727 If STRING is non-null, display that C string. Otherwise, the Lisp
13728 string LISP_STRING is displayed.
13730 If FACE_STRING is not nil, FACE_STRING_POS is a position in
13731 FACE_STRING. Display STRING or LISP_STRING with the face at
13732 FACE_STRING_POS in FACE_STRING:
13734 Display the string in the environment given by IT, but use the
13735 standard display table, temporarily.
13737 FIELD_WIDTH is the minimum number of output glyphs to produce.
13738 If STRING has fewer characters than FIELD_WIDTH, pad to the right
13739 with spaces. If STRING has more characters, more than FIELD_WIDTH
13740 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
13742 PRECISION is the maximum number of characters to output from
13743 STRING. PRECISION < 0 means don't truncate the string.
13745 This is roughly equivalent to printf format specifiers:
13747 FIELD_WIDTH PRECISION PRINTF
13748 ----------------------------------------
13754 MULTIBYTE zero means do not display multibyte chars, > 0 means do
13755 display them, and < 0 means obey the current buffer's value of
13756 enable_multibyte_characters.
13758 Value is the number of glyphs produced. */
13761 display_string (string
, lisp_string
, face_string
, face_string_pos
,
13762 start
, it
, field_width
, precision
, max_x
, multibyte
)
13763 unsigned char *string
;
13764 Lisp_Object lisp_string
;
13765 Lisp_Object face_string
;
13766 int face_string_pos
;
13769 int field_width
, precision
, max_x
;
13772 int hpos_at_start
= it
->hpos
;
13773 int saved_face_id
= it
->face_id
;
13774 struct glyph_row
*row
= it
->glyph_row
;
13776 /* Initialize the iterator IT for iteration over STRING beginning
13777 with index START. We assume that IT may be modified here (which
13778 means that display_line has to do something when displaying a
13779 mini-buffer prompt, which it does). */
13780 reseat_to_string (it
, string
, lisp_string
, start
,
13781 precision
, field_width
, multibyte
);
13783 /* If displaying STRING, set up the face of the iterator
13784 from LISP_STRING, if that's given. */
13785 if (STRINGP (face_string
))
13791 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
13792 0, it
->region_beg_charpos
,
13793 it
->region_end_charpos
,
13794 &endptr
, it
->base_face_id
, 0);
13795 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
13796 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
13799 /* Set max_x to the maximum allowed X position. Don't let it go
13800 beyond the right edge of the window. */
13802 max_x
= it
->last_visible_x
;
13804 max_x
= min (max_x
, it
->last_visible_x
);
13806 /* Skip over display elements that are not visible. because IT->w is
13808 if (it
->current_x
< it
->first_visible_x
)
13809 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
13810 MOVE_TO_POS
| MOVE_TO_X
);
13812 row
->ascent
= it
->max_ascent
;
13813 row
->height
= it
->max_ascent
+ it
->max_descent
;
13814 row
->phys_ascent
= it
->max_phys_ascent
;
13815 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
13817 /* This condition is for the case that we are called with current_x
13818 past last_visible_x. */
13819 while (it
->current_x
< max_x
)
13821 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
13823 /* Get the next display element. */
13824 if (!get_next_display_element (it
))
13827 /* Produce glyphs. */
13828 x_before
= it
->current_x
;
13829 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
13830 PRODUCE_GLYPHS (it
);
13832 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
13835 while (i
< nglyphs
)
13837 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
13839 if (!it
->truncate_lines_p
13840 && x
+ glyph
->pixel_width
> max_x
)
13842 /* End of continued line or max_x reached. */
13843 if (CHAR_GLYPH_PADDING_P (*glyph
))
13845 /* A wide character is unbreakable. */
13846 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
13847 it
->current_x
= x_before
;
13851 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
13856 else if (x
+ glyph
->pixel_width
> it
->first_visible_x
)
13858 /* Glyph is at least partially visible. */
13860 if (x
< it
->first_visible_x
)
13861 it
->glyph_row
->x
= x
- it
->first_visible_x
;
13865 /* Glyph is off the left margin of the display area.
13866 Should not happen. */
13870 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
13871 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
13872 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
13873 row
->phys_height
= max (row
->phys_height
,
13874 it
->max_phys_ascent
+ it
->max_phys_descent
);
13875 x
+= glyph
->pixel_width
;
13879 /* Stop if max_x reached. */
13883 /* Stop at line ends. */
13884 if (ITERATOR_AT_END_OF_LINE_P (it
))
13886 it
->continuation_lines_width
= 0;
13890 set_iterator_to_next (it
, 1);
13892 /* Stop if truncating at the right edge. */
13893 if (it
->truncate_lines_p
13894 && it
->current_x
>= it
->last_visible_x
)
13896 /* Add truncation mark, but don't do it if the line is
13897 truncated at a padding space. */
13898 if (IT_CHARPOS (*it
) < it
->string_nchars
)
13900 if (!FRAME_WINDOW_P (it
->f
))
13904 if (it
->current_x
> it
->last_visible_x
)
13906 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
13907 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
13909 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
13911 row
->used
[TEXT_AREA
] = i
;
13912 produce_special_glyphs (it
, IT_TRUNCATION
);
13915 produce_special_glyphs (it
, IT_TRUNCATION
);
13917 it
->glyph_row
->truncated_on_right_p
= 1;
13923 /* Maybe insert a truncation at the left. */
13924 if (it
->first_visible_x
13925 && IT_CHARPOS (*it
) > 0)
13927 if (!FRAME_WINDOW_P (it
->f
))
13928 insert_left_trunc_glyphs (it
);
13929 it
->glyph_row
->truncated_on_left_p
= 1;
13932 it
->face_id
= saved_face_id
;
13934 /* Value is number of columns displayed. */
13935 return it
->hpos
- hpos_at_start
;
13940 /* This is like a combination of memq and assq. Return 1 if PROPVAL
13941 appears as an element of LIST or as the car of an element of LIST.
13942 If PROPVAL is a list, compare each element against LIST in that
13943 way, and return 1 if any element of PROPVAL is found in LIST.
13944 Otherwise return 0. This function cannot quit. */
13947 invisible_p (propval
, list
)
13948 register Lisp_Object propval
;
13951 register Lisp_Object tail
, proptail
;
13953 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
13955 register Lisp_Object tem
;
13957 if (EQ (propval
, tem
))
13959 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
13963 if (CONSP (propval
))
13965 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
13967 Lisp_Object propelt
;
13968 propelt
= XCAR (proptail
);
13969 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
13971 register Lisp_Object tem
;
13973 if (EQ (propelt
, tem
))
13975 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
13985 /* Return 1 if PROPVAL appears as the car of an element of LIST and
13986 the cdr of that element is non-nil. If PROPVAL is a list, check
13987 each element of PROPVAL in that way, and the first time some
13988 element is found, return 1 if the cdr of that element is non-nil.
13989 Otherwise return 0. This function cannot quit. */
13992 invisible_ellipsis_p (propval
, list
)
13993 register Lisp_Object propval
;
13996 register Lisp_Object tail
, proptail
;
13998 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
14000 register Lisp_Object tem
;
14002 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
14003 return ! NILP (XCDR (tem
));
14006 if (CONSP (propval
))
14007 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
14009 Lisp_Object propelt
;
14010 propelt
= XCAR (proptail
);
14011 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
14013 register Lisp_Object tem
;
14015 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
14016 return ! NILP (XCDR (tem
));
14025 /***********************************************************************
14027 ***********************************************************************/
14032 Vwith_echo_area_save_vector
= Qnil
;
14033 staticpro (&Vwith_echo_area_save_vector
);
14035 Vmessage_stack
= Qnil
;
14036 staticpro (&Vmessage_stack
);
14038 Qinhibit_redisplay
= intern ("inhibit-redisplay");
14039 staticpro (&Qinhibit_redisplay
);
14042 defsubr (&Sdump_glyph_matrix
);
14043 defsubr (&Sdump_glyph_row
);
14044 defsubr (&Sdump_tool_bar_row
);
14045 defsubr (&Strace_redisplay_toggle
);
14046 defsubr (&Strace_to_stderr
);
14048 #ifdef HAVE_WINDOW_SYSTEM
14049 defsubr (&Stool_bar_lines_needed
);
14052 staticpro (&Qmenu_bar_update_hook
);
14053 Qmenu_bar_update_hook
= intern ("menu-bar-update-hook");
14055 staticpro (&Qoverriding_terminal_local_map
);
14056 Qoverriding_terminal_local_map
= intern ("overriding-terminal-local-map");
14058 staticpro (&Qoverriding_local_map
);
14059 Qoverriding_local_map
= intern ("overriding-local-map");
14061 staticpro (&Qwindow_scroll_functions
);
14062 Qwindow_scroll_functions
= intern ("window-scroll-functions");
14064 staticpro (&Qredisplay_end_trigger_functions
);
14065 Qredisplay_end_trigger_functions
= intern ("redisplay-end-trigger-functions");
14067 staticpro (&Qinhibit_point_motion_hooks
);
14068 Qinhibit_point_motion_hooks
= intern ("inhibit-point-motion-hooks");
14070 QCdata
= intern (":data");
14071 staticpro (&QCdata
);
14072 Qdisplay
= intern ("display");
14073 staticpro (&Qdisplay
);
14074 Qspace_width
= intern ("space-width");
14075 staticpro (&Qspace_width
);
14076 Qraise
= intern ("raise");
14077 staticpro (&Qraise
);
14078 Qspace
= intern ("space");
14079 staticpro (&Qspace
);
14080 Qmargin
= intern ("margin");
14081 staticpro (&Qmargin
);
14082 Qleft_margin
= intern ("left-margin");
14083 staticpro (&Qleft_margin
);
14084 Qright_margin
= intern ("right-margin");
14085 staticpro (&Qright_margin
);
14086 Qalign_to
= intern ("align-to");
14087 staticpro (&Qalign_to
);
14088 QCalign_to
= intern (":align-to");
14089 staticpro (&QCalign_to
);
14090 Qrelative_width
= intern ("relative-width");
14091 staticpro (&Qrelative_width
);
14092 QCrelative_width
= intern (":relative-width");
14093 staticpro (&QCrelative_width
);
14094 QCrelative_height
= intern (":relative-height");
14095 staticpro (&QCrelative_height
);
14096 QCeval
= intern (":eval");
14097 staticpro (&QCeval
);
14098 Qwhen
= intern ("when");
14099 staticpro (&Qwhen
);
14100 QCfile
= intern (":file");
14101 staticpro (&QCfile
);
14102 Qfontified
= intern ("fontified");
14103 staticpro (&Qfontified
);
14104 Qfontification_functions
= intern ("fontification-functions");
14105 staticpro (&Qfontification_functions
);
14106 Qtrailing_whitespace
= intern ("trailing-whitespace");
14107 staticpro (&Qtrailing_whitespace
);
14108 Qimage
= intern ("image");
14109 staticpro (&Qimage
);
14110 Qmessage_truncate_lines
= intern ("message-truncate-lines");
14111 staticpro (&Qmessage_truncate_lines
);
14112 Qgrow_only
= intern ("grow-only");
14113 staticpro (&Qgrow_only
);
14114 Qinhibit_menubar_update
= intern ("inhibit-menubar-update");
14115 staticpro (&Qinhibit_menubar_update
);
14117 last_arrow_position
= Qnil
;
14118 last_arrow_string
= Qnil
;
14119 staticpro (&last_arrow_position
);
14120 staticpro (&last_arrow_string
);
14122 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
14123 staticpro (&echo_buffer
[0]);
14124 staticpro (&echo_buffer
[1]);
14126 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
14127 staticpro (&echo_area_buffer
[0]);
14128 staticpro (&echo_area_buffer
[1]);
14130 Vmessages_buffer_name
= build_string ("*Messages*");
14131 staticpro (&Vmessages_buffer_name
);
14133 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
14134 "Non-nil means highlight trailing whitespace.\n\
14135 The face used for trailing whitespace is `trailing-whitespace'.");
14136 Vshow_trailing_whitespace
= Qnil
;
14138 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
14139 "Non-nil means don't actually do any redisplay.\n\
14140 This is used for internal purposes.");
14141 Vinhibit_redisplay
= Qnil
;
14143 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
14144 "String (or mode line construct) included (normally) in `mode-line-format'.");
14145 Vglobal_mode_string
= Qnil
;
14147 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
14148 "Marker for where to display an arrow on top of the buffer text.\n\
14149 This must be the beginning of a line in order to work.\n\
14150 See also `overlay-arrow-string'.");
14151 Voverlay_arrow_position
= Qnil
;
14153 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
14154 "String to display as an arrow. See also `overlay-arrow-position'.");
14155 Voverlay_arrow_string
= Qnil
;
14157 DEFVAR_INT ("scroll-step", &scroll_step
,
14158 "*The number of lines to try scrolling a window by when point moves out.\n\
14159 If that fails to bring point back on frame, point is centered instead.\n\
14160 If this is zero, point is always centered after it moves off frame.\n\
14161 If you want scrolling to always be a line at a time, you should set\n\
14162 `scroll-conservatively' to a large value rather than set this to 1.");
14164 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
14165 "*Scroll up to this many lines, to bring point back on screen.\n\
14166 A value of zero means to scroll the text to center point vertically\n\
14168 scroll_conservatively
= 0;
14170 DEFVAR_INT ("scroll-margin", &scroll_margin
,
14171 "*Number of lines of margin at the top and bottom of a window.\n\
14172 Recenter the window whenever point gets within this many lines\n\
14173 of the top or bottom of the window.");
14177 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, "Don't ask");
14180 DEFVAR_BOOL ("truncate-partial-width-windows",
14181 &truncate_partial_width_windows
,
14182 "*Non-nil means truncate lines in all windows less than full frame wide.");
14183 truncate_partial_width_windows
= 1;
14185 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
14186 "nil means display the mode-line/header-line/menu-bar in the default face.\n\
14187 Any other value means to use the appropriate face, `mode-line',\n\
14188 `header-line', or `menu' respectively.\n\
14190 This variable is deprecated; please change the above faces instead.");
14191 mode_line_inverse_video
= 1;
14193 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
14194 "*Maximum buffer size for which line number should be displayed.\n\
14195 If the buffer is bigger than this, the line number does not appear\n\
14196 in the mode line. A value of nil means no limit.");
14197 Vline_number_display_limit
= Qnil
;
14199 DEFVAR_INT ("line-number-display-limit-width",
14200 &line_number_display_limit_width
,
14201 "*Maximum line width (in characters) for line number display.\n\
14202 If the average length of the lines near point is bigger than this, then the\n\
14203 line number may be omitted from the mode line.");
14204 line_number_display_limit_width
= 200;
14206 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
14207 "*Non-nil means highlight region even in nonselected windows.");
14208 highlight_nonselected_windows
= 0;
14210 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
14211 "Non-nil if more than one frame is visible on this display.\n\
14212 Minibuffer-only frames don't count, but iconified frames do.\n\
14213 This variable is not guaranteed to be accurate except while processing\n\
14214 `frame-title-format' and `icon-title-format'.");
14216 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
14217 "Template for displaying the title bar of visible frames.\n\
14218 \(Assuming the window manager supports this feature.)\n\
14219 This variable has the same structure as `mode-line-format' (which see),\n\
14220 and is used only on frames for which no explicit name has been set\n\
14221 \(see `modify-frame-parameters').");
14222 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
14223 "Template for displaying the title bar of an iconified frame.\n\
14224 \(Assuming the window manager supports this feature.)\n\
14225 This variable has the same structure as `mode-line-format' (which see),\n\
14226 and is used only on frames for which no explicit name has been set\n\
14227 \(see `modify-frame-parameters').");
14229 = Vframe_title_format
14230 = Fcons (intern ("multiple-frames"),
14231 Fcons (build_string ("%b"),
14232 Fcons (Fcons (build_string (""),
14233 Fcons (intern ("invocation-name"),
14234 Fcons (build_string ("@"),
14235 Fcons (intern ("system-name"),
14239 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
14240 "Maximum number of lines to keep in the message log buffer.\n\
14241 If nil, disable message logging. If t, log messages but don't truncate\n\
14242 the buffer when it becomes large.");
14243 XSETFASTINT (Vmessage_log_max
, 50);
14245 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
14246 "Functions called before redisplay, if window sizes have changed.\n\
14247 The value should be a list of functions that take one argument.\n\
14248 Just before redisplay, for each frame, if any of its windows have changed\n\
14249 size since the last redisplay, or have been split or deleted,\n\
14250 all the functions in the list are called, with the frame as argument.");
14251 Vwindow_size_change_functions
= Qnil
;
14253 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
14254 "List of Functions to call before redisplaying a window with scrolling.\n\
14255 Each function is called with two arguments, the window\n\
14256 and its new display-start position. Note that the value of `window-end'\n\
14257 is not valid when these functions are called.");
14258 Vwindow_scroll_functions
= Qnil
;
14260 DEFVAR_BOOL ("auto-resize-tool-bars", &auto_resize_tool_bars_p
,
14261 "*Non-nil means automatically resize tool-bars.\n\
14262 This increases a tool-bar's height if not all tool-bar items are visible.\n\
14263 It decreases a tool-bar's height when it would display blank lines\n\
14265 auto_resize_tool_bars_p
= 1;
14267 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
14268 "*Non-nil means raise tool-bar buttons when the mouse moves over them.");
14269 auto_raise_tool_bar_buttons_p
= 1;
14271 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
14272 "*Margin around tool-bar buttons in pixels.\n\
14273 If an integer, use that for both horizontal and vertical margins.\n\
14274 Otherwise, value should be a pair of integers `(HORZ : VERT)' with\n\
14275 HORZ specifying the horizontal margin, and VERT specifying the\n\
14276 vertical margin.");
14277 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
14279 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
14280 "Relief thickness of tool-bar buttons.");
14281 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
14283 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
14284 "List of functions to call to fontify regions of text.\n\
14285 Each function is called with one argument POS. Functions must\n\
14286 fontify a region starting at POS in the current buffer, and give\n\
14287 fontified regions the property `fontified'.\n\
14288 This variable automatically becomes buffer-local when set.");
14289 Vfontification_functions
= Qnil
;
14290 Fmake_variable_buffer_local (Qfontification_functions
);
14292 DEFVAR_BOOL ("unibyte-display-via-language-environment",
14293 &unibyte_display_via_language_environment
,
14294 "*Non-nil means display unibyte text according to language environment.\n\
14295 Specifically this means that unibyte non-ASCII characters\n\
14296 are displayed by converting them to the equivalent multibyte characters\n\
14297 according to the current language environment. As a result, they are\n\
14298 displayed according to the current fontset.");
14299 unibyte_display_via_language_environment
= 0;
14301 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
14302 "*Maximum height for resizing mini-windows.\n\
14303 If a float, it specifies a fraction of the mini-window frame's height.\n\
14304 If an integer, it specifies a number of lines.");
14305 Vmax_mini_window_height
= make_float (0.25);
14307 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
14308 "*How to resize mini-windows.\n\
14309 A value of nil means don't automatically resize mini-windows.\n\
14310 A value of t means resize them to fit the text displayed in them.\n\
14311 A value of `grow-only', the default, means let mini-windows grow\n\
14312 only, until their display becomes empty, at which point the windows\n\
14313 go back to their normal size.");
14314 Vresize_mini_windows
= Qgrow_only
;
14316 DEFVAR_BOOL ("cursor-in-non-selected-windows",
14317 &cursor_in_non_selected_windows
,
14318 "*Non-nil means display a hollow cursor in non-selected windows.\n\
14319 Nil means don't display a cursor there.");
14320 cursor_in_non_selected_windows
= 1;
14322 DEFVAR_BOOL ("automatic-hscrolling", &automatic_hscrolling_p
,
14323 "*Non-nil means scroll the display automatically to make point visible.");
14324 automatic_hscrolling_p
= 1;
14326 DEFVAR_LISP ("image-types", &Vimage_types
,
14327 "List of supported image types.\n\
14328 Each element of the list is a symbol for a supported image type.");
14329 Vimage_types
= Qnil
;
14331 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
14332 "If non-nil, messages are truncated instead of resizing the echo area.\n\
14333 Bind this around calls to `message' to let it take effect.");
14334 message_truncate_lines
= 0;
14336 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
14337 "Normal hook run for clicks on menu bar, before displaying a submenu.\n\
14338 Can be used to update submenus whose contents should vary.");
14339 Vmenu_bar_update_hook
= Qnil
;
14341 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
14342 "Non-nil means don't update menu bars. Internal use only.");
14343 inhibit_menubar_update
= 0;
14347 /* Initialize this module when Emacs starts. */
14352 Lisp_Object root_window
;
14353 struct window
*mini_w
;
14355 current_header_line_height
= current_mode_line_height
= -1;
14357 CHARPOS (this_line_start_pos
) = 0;
14359 mini_w
= XWINDOW (minibuf_window
);
14360 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
14362 if (!noninteractive
)
14364 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
14367 XSETFASTINT (XWINDOW (root_window
)->top
, FRAME_TOP_MARGIN (f
));
14368 set_window_height (root_window
,
14369 FRAME_HEIGHT (f
) - 1 - FRAME_TOP_MARGIN (f
),
14371 XSETFASTINT (mini_w
->top
, FRAME_HEIGHT (f
) - 1);
14372 set_window_height (minibuf_window
, 1, 0);
14374 XSETFASTINT (XWINDOW (root_window
)->width
, FRAME_WIDTH (f
));
14375 XSETFASTINT (mini_w
->width
, FRAME_WIDTH (f
));
14377 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
14378 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
14379 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
14381 /* The default ellipsis glyphs `...'. */
14382 for (i
= 0; i
< 3; ++i
)
14383 XSETFASTINT (default_invis_vector
[i
], '.');
14386 #ifdef HAVE_WINDOW_SYSTEM
14388 /* Allocate the buffer for frame titles. */
14390 frame_title_buf
= (char *) xmalloc (size
);
14391 frame_title_buf_end
= frame_title_buf
+ size
;
14392 frame_title_ptr
= NULL
;
14394 #endif /* HAVE_WINDOW_SYSTEM */
14396 help_echo_showing_p
= 0;