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 single_display_prop_string_p
P_ ((Lisp_Object
, Lisp_Object
));
658 static int display_prop_string_p
P_ ((Lisp_Object
, Lisp_Object
));
659 static int cursor_row_p
P_ ((struct window
*, struct glyph_row
*));
660 static int redisplay_mode_lines
P_ ((Lisp_Object
, int));
661 static char *decode_mode_spec_coding
P_ ((Lisp_Object
, char *, int));
662 static int invisible_text_between_p
P_ ((struct it
*, int, int));
663 static int next_element_from_ellipsis
P_ ((struct it
*));
664 static void pint2str
P_ ((char *, int, int));
665 static struct text_pos run_window_scroll_functions
P_ ((Lisp_Object
,
667 static void reconsider_clip_changes
P_ ((struct window
*, struct buffer
*));
668 static int text_outside_line_unchanged_p
P_ ((struct window
*, int, int));
669 static void store_frame_title_char
P_ ((char));
670 static int store_frame_title
P_ ((unsigned char *, int, int));
671 static void x_consider_frame_title
P_ ((Lisp_Object
));
672 static void handle_stop
P_ ((struct it
*));
673 static int tool_bar_lines_needed
P_ ((struct frame
*));
674 static int single_display_prop_intangible_p
P_ ((Lisp_Object
));
675 static void ensure_echo_area_buffers
P_ ((void));
676 static struct glyph_row
*row_containing_pos
P_ ((struct window
*, int,
678 struct glyph_row
*));
679 static Lisp_Object unwind_with_echo_area_buffer
P_ ((Lisp_Object
));
680 static Lisp_Object with_echo_area_buffer_unwind_data
P_ ((struct window
*));
681 static int with_echo_area_buffer
P_ ((struct window
*, int,
682 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
683 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
684 static void clear_garbaged_frames
P_ ((void));
685 static int current_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
686 static int truncate_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
687 static int set_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
688 static int display_echo_area
P_ ((struct window
*));
689 static int display_echo_area_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
690 static int resize_mini_window_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
691 static Lisp_Object unwind_redisplay
P_ ((Lisp_Object
));
692 static int string_char_and_length
P_ ((unsigned char *, int, int *));
693 static struct text_pos display_prop_end
P_ ((struct it
*, Lisp_Object
,
695 static int compute_window_start_on_continuation_line
P_ ((struct window
*));
696 static Lisp_Object safe_eval_handler
P_ ((Lisp_Object
));
697 static void insert_left_trunc_glyphs
P_ ((struct it
*));
698 static struct glyph_row
*get_overlay_arrow_glyph_row
P_ ((struct window
*));
699 static void extend_face_to_end_of_line
P_ ((struct it
*));
700 static int append_space
P_ ((struct it
*, int));
701 static void make_cursor_line_fully_visible
P_ ((struct window
*));
702 static int try_scrolling
P_ ((Lisp_Object
, int, int, int, int));
703 static int try_cursor_movement
P_ ((Lisp_Object
, struct text_pos
, int *));
704 static int trailing_whitespace_p
P_ ((int));
705 static int message_log_check_duplicate
P_ ((int, int, int, int));
706 int invisible_p
P_ ((Lisp_Object
, Lisp_Object
));
707 int invisible_ellipsis_p
P_ ((Lisp_Object
, Lisp_Object
));
708 static void push_it
P_ ((struct it
*));
709 static void pop_it
P_ ((struct it
*));
710 static void sync_frame_with_window_matrix_rows
P_ ((struct window
*));
711 static void redisplay_internal
P_ ((int));
712 static int echo_area_display
P_ ((int));
713 static void redisplay_windows
P_ ((Lisp_Object
));
714 static void redisplay_window
P_ ((Lisp_Object
, int));
715 static void update_menu_bar
P_ ((struct frame
*, int));
716 static int try_window_reusing_current_matrix
P_ ((struct window
*));
717 static int try_window_id
P_ ((struct window
*));
718 static int display_line
P_ ((struct it
*));
719 static int display_mode_lines
P_ ((struct window
*));
720 static int display_mode_line
P_ ((struct window
*, enum face_id
, Lisp_Object
));
721 static int display_mode_element
P_ ((struct it
*, int, int, int, Lisp_Object
));
722 static char *decode_mode_spec
P_ ((struct window
*, int, int, int));
723 static void display_menu_bar
P_ ((struct window
*));
724 static int display_count_lines
P_ ((int, int, int, int, int *));
725 static int display_string
P_ ((unsigned char *, Lisp_Object
, Lisp_Object
,
726 int, int, struct it
*, int, int, int, int));
727 static void compute_line_metrics
P_ ((struct it
*));
728 static void run_redisplay_end_trigger_hook
P_ ((struct it
*));
729 static int get_overlay_strings
P_ ((struct it
*));
730 static void next_overlay_string
P_ ((struct it
*));
731 static void reseat
P_ ((struct it
*, struct text_pos
, int));
732 static void reseat_1
P_ ((struct it
*, struct text_pos
, int));
733 static void back_to_previous_visible_line_start
P_ ((struct it
*));
734 static void reseat_at_previous_visible_line_start
P_ ((struct it
*));
735 static void reseat_at_next_visible_line_start
P_ ((struct it
*, int));
736 static int next_element_from_display_vector
P_ ((struct it
*));
737 static int next_element_from_string
P_ ((struct it
*));
738 static int next_element_from_c_string
P_ ((struct it
*));
739 static int next_element_from_buffer
P_ ((struct it
*));
740 static int next_element_from_composition
P_ ((struct it
*));
741 static int next_element_from_image
P_ ((struct it
*));
742 static int next_element_from_stretch
P_ ((struct it
*));
743 static void load_overlay_strings
P_ ((struct it
*));
744 static void init_from_display_pos
P_ ((struct it
*, struct window
*,
745 struct display_pos
*));
746 static void reseat_to_string
P_ ((struct it
*, unsigned char *,
747 Lisp_Object
, int, int, int, int));
748 static enum move_it_result move_it_in_display_line_to
P_ ((struct it
*,
750 void move_it_vertically_backward
P_ ((struct it
*, int));
751 static void init_to_row_start
P_ ((struct it
*, struct window
*,
752 struct glyph_row
*));
753 static void init_to_row_end
P_ ((struct it
*, struct window
*,
754 struct glyph_row
*));
755 static void back_to_previous_line_start
P_ ((struct it
*));
756 static int forward_to_next_line_start
P_ ((struct it
*, int *));
757 static struct text_pos string_pos_nchars_ahead
P_ ((struct text_pos
,
759 static struct text_pos string_pos
P_ ((int, Lisp_Object
));
760 static struct text_pos c_string_pos
P_ ((int, unsigned char *, int));
761 static int number_of_chars
P_ ((unsigned char *, int));
762 static void compute_stop_pos
P_ ((struct it
*));
763 static void compute_string_pos
P_ ((struct text_pos
*, struct text_pos
,
765 static int face_before_or_after_it_pos
P_ ((struct it
*, int));
766 static int next_overlay_change
P_ ((int));
767 static int handle_single_display_prop
P_ ((struct it
*, Lisp_Object
,
768 Lisp_Object
, struct text_pos
*,
770 static int underlying_face_id
P_ ((struct it
*));
772 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
773 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
775 #ifdef HAVE_WINDOW_SYSTEM
777 static void update_tool_bar
P_ ((struct frame
*, int));
778 static void build_desired_tool_bar_string
P_ ((struct frame
*f
));
779 static int redisplay_tool_bar
P_ ((struct frame
*));
780 static void display_tool_bar_line
P_ ((struct it
*));
782 #endif /* HAVE_WINDOW_SYSTEM */
785 /***********************************************************************
786 Window display dimensions
787 ***********************************************************************/
789 /* Return the window-relative maximum y + 1 for glyph rows displaying
790 text in window W. This is the height of W minus the height of a
791 mode line, if any. */
794 window_text_bottom_y (w
)
797 struct frame
*f
= XFRAME (w
->frame
);
798 int height
= XFASTINT (w
->height
) * CANON_Y_UNIT (f
);
800 if (WINDOW_WANTS_MODELINE_P (w
))
801 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
806 /* Return the pixel width of display area AREA of window W. AREA < 0
807 means return the total width of W, not including bitmap areas to
808 the left and right of the window. */
811 window_box_width (w
, area
)
815 struct frame
*f
= XFRAME (w
->frame
);
816 int width
= XFASTINT (w
->width
);
818 if (!w
->pseudo_window_p
)
820 width
-= FRAME_SCROLL_BAR_WIDTH (f
) + FRAME_FLAGS_AREA_COLS (f
);
822 if (area
== TEXT_AREA
)
824 if (INTEGERP (w
->left_margin_width
))
825 width
-= XFASTINT (w
->left_margin_width
);
826 if (INTEGERP (w
->right_margin_width
))
827 width
-= XFASTINT (w
->right_margin_width
);
829 else if (area
== LEFT_MARGIN_AREA
)
830 width
= (INTEGERP (w
->left_margin_width
)
831 ? XFASTINT (w
->left_margin_width
) : 0);
832 else if (area
== RIGHT_MARGIN_AREA
)
833 width
= (INTEGERP (w
->right_margin_width
)
834 ? XFASTINT (w
->right_margin_width
) : 0);
837 return width
* CANON_X_UNIT (f
);
841 /* Return the pixel height of the display area of window W, not
842 including mode lines of W, if any.. */
845 window_box_height (w
)
848 struct frame
*f
= XFRAME (w
->frame
);
849 int height
= XFASTINT (w
->height
) * CANON_Y_UNIT (f
);
851 xassert (height
>= 0);
853 /* Note: the code below that determines the mode-line/header-line
854 height is essentially the same as that contained in the macro
855 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
856 the appropriate glyph row has its `mode_line_p' flag set,
857 and if it doesn't, uses estimate_mode_line_height instead. */
859 if (WINDOW_WANTS_MODELINE_P (w
))
861 struct glyph_row
*ml_row
862 = (w
->current_matrix
&& w
->current_matrix
->rows
863 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
865 if (ml_row
&& ml_row
->mode_line_p
)
866 height
-= ml_row
->height
;
868 height
-= estimate_mode_line_height (f
, MODE_LINE_FACE_ID
);
871 if (WINDOW_WANTS_HEADER_LINE_P (w
))
873 struct glyph_row
*hl_row
874 = (w
->current_matrix
&& w
->current_matrix
->rows
875 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
877 if (hl_row
&& hl_row
->mode_line_p
)
878 height
-= hl_row
->height
;
880 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
887 /* Return the frame-relative coordinate of the left edge of display
888 area AREA of window W. AREA < 0 means return the left edge of the
889 whole window, to the right of any bitmap area at the left side of
893 window_box_left (w
, area
)
897 struct frame
*f
= XFRAME (w
->frame
);
898 int x
= FRAME_INTERNAL_BORDER_WIDTH_SAFE (f
);
900 if (!w
->pseudo_window_p
)
902 x
+= (WINDOW_LEFT_MARGIN (w
) * CANON_X_UNIT (f
)
903 + FRAME_LEFT_FLAGS_AREA_WIDTH (f
));
905 if (area
== TEXT_AREA
)
906 x
+= window_box_width (w
, LEFT_MARGIN_AREA
);
907 else if (area
== RIGHT_MARGIN_AREA
)
908 x
+= (window_box_width (w
, LEFT_MARGIN_AREA
)
909 + window_box_width (w
, TEXT_AREA
));
916 /* Return the frame-relative coordinate of the right edge of display
917 area AREA of window W. AREA < 0 means return the left edge of the
918 whole window, to the left of any bitmap area at the right side of
922 window_box_right (w
, area
)
926 return window_box_left (w
, area
) + window_box_width (w
, area
);
930 /* Get the bounding box of the display area AREA of window W, without
931 mode lines, in frame-relative coordinates. AREA < 0 means the
932 whole window, not including bitmap areas to the left and right of
933 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
934 coordinates of the upper-left corner of the box. Return in
935 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
938 window_box (w
, area
, box_x
, box_y
, box_width
, box_height
)
941 int *box_x
, *box_y
, *box_width
, *box_height
;
943 struct frame
*f
= XFRAME (w
->frame
);
945 *box_width
= window_box_width (w
, area
);
946 *box_height
= window_box_height (w
);
947 *box_x
= window_box_left (w
, area
);
948 *box_y
= (FRAME_INTERNAL_BORDER_WIDTH_SAFE (f
)
949 + XFASTINT (w
->top
) * CANON_Y_UNIT (f
));
950 if (WINDOW_WANTS_HEADER_LINE_P (w
))
951 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
955 /* Get the bounding box of the display area AREA of window W, without
956 mode lines. AREA < 0 means the whole window, not including bitmap
957 areas to the left and right of the window. Return in *TOP_LEFT_X
958 and TOP_LEFT_Y the frame-relative pixel coordinates of the
959 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
960 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
964 window_box_edges (w
, area
, top_left_x
, top_left_y
,
965 bottom_right_x
, bottom_right_y
)
968 int *top_left_x
, *top_left_y
, *bottom_right_x
, *bottom_right_y
;
970 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
972 *bottom_right_x
+= *top_left_x
;
973 *bottom_right_y
+= *top_left_y
;
978 /***********************************************************************
980 ***********************************************************************/
982 /* Return the bottom y-position of the line the iterator IT is in.
983 This can modify IT's settings. */
989 int line_height
= it
->max_ascent
+ it
->max_descent
;
990 int line_top_y
= it
->current_y
;
992 if (line_height
== 0)
995 line_height
= last_height
;
996 else if (IT_CHARPOS (*it
) < ZV
)
998 move_it_by_lines (it
, 1, 1);
999 line_height
= (it
->max_ascent
|| it
->max_descent
1000 ? it
->max_ascent
+ it
->max_descent
1005 struct glyph_row
*row
= it
->glyph_row
;
1007 /* Use the default character height. */
1008 it
->glyph_row
= NULL
;
1009 it
->what
= IT_CHARACTER
;
1012 PRODUCE_GLYPHS (it
);
1013 line_height
= it
->ascent
+ it
->descent
;
1014 it
->glyph_row
= row
;
1018 return line_top_y
+ line_height
;
1022 /* Return 1 if position CHARPOS is visible in window W. Set *FULLY to
1023 1 if POS is visible and the line containing POS is fully visible.
1024 EXACT_MODE_LINE_HEIGHTS_P non-zero means compute exact mode-line
1025 and header-lines heights. */
1028 pos_visible_p (w
, charpos
, fully
, exact_mode_line_heights_p
)
1030 int charpos
, *fully
, exact_mode_line_heights_p
;
1033 struct text_pos top
;
1035 struct buffer
*old_buffer
= NULL
;
1037 if (XBUFFER (w
->buffer
) != current_buffer
)
1039 old_buffer
= current_buffer
;
1040 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1043 *fully
= visible_p
= 0;
1044 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1046 /* Compute exact mode line heights, if requested. */
1047 if (exact_mode_line_heights_p
)
1049 if (WINDOW_WANTS_MODELINE_P (w
))
1050 current_mode_line_height
1051 = display_mode_line (w
, MODE_LINE_FACE_ID
,
1052 current_buffer
->mode_line_format
);
1054 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1055 current_header_line_height
1056 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1057 current_buffer
->header_line_format
);
1060 start_display (&it
, w
, top
);
1061 move_it_to (&it
, charpos
, 0, it
.last_visible_y
, -1,
1062 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
1064 /* Note that we may overshoot because of invisible text. */
1065 if (IT_CHARPOS (it
) >= charpos
)
1067 int top_y
= it
.current_y
;
1068 int bottom_y
= line_bottom_y (&it
);
1069 int window_top_y
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
);
1071 if (top_y
< window_top_y
)
1072 visible_p
= bottom_y
> window_top_y
;
1073 else if (top_y
< it
.last_visible_y
)
1076 *fully
= bottom_y
<= it
.last_visible_y
;
1079 else if (it
.current_y
+ it
.max_ascent
+ it
.max_descent
> it
.last_visible_y
)
1081 move_it_by_lines (&it
, 1, 0);
1082 if (charpos
< IT_CHARPOS (it
))
1090 set_buffer_internal_1 (old_buffer
);
1092 current_header_line_height
= current_mode_line_height
= -1;
1097 /* Return the next character from STR which is MAXLEN bytes long.
1098 Return in *LEN the length of the character. This is like
1099 STRING_CHAR_AND_LENGTH but never returns an invalid character. If
1100 we find one, we return a `?', but with the length of the invalid
1104 string_char_and_length (str
, maxlen
, len
)
1110 c
= STRING_CHAR_AND_LENGTH (str
, maxlen
, *len
);
1111 if (!CHAR_VALID_P (c
, 1))
1112 /* We may not change the length here because other places in Emacs
1113 don't use this function, i.e. they silently accept invalid
1122 /* Given a position POS containing a valid character and byte position
1123 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1125 static struct text_pos
1126 string_pos_nchars_ahead (pos
, string
, nchars
)
1127 struct text_pos pos
;
1131 xassert (STRINGP (string
) && nchars
>= 0);
1133 if (STRING_MULTIBYTE (string
))
1135 int rest
= STRING_BYTES (XSTRING (string
)) - BYTEPOS (pos
);
1136 unsigned char *p
= XSTRING (string
)->data
+ BYTEPOS (pos
);
1141 string_char_and_length (p
, rest
, &len
);
1142 p
+= len
, rest
-= len
;
1143 xassert (rest
>= 0);
1145 BYTEPOS (pos
) += len
;
1149 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1155 /* Value is the text position, i.e. character and byte position,
1156 for character position CHARPOS in STRING. */
1158 static INLINE
struct text_pos
1159 string_pos (charpos
, string
)
1163 struct text_pos pos
;
1164 xassert (STRINGP (string
));
1165 xassert (charpos
>= 0);
1166 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1171 /* Value is a text position, i.e. character and byte position, for
1172 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1173 means recognize multibyte characters. */
1175 static struct text_pos
1176 c_string_pos (charpos
, s
, multibyte_p
)
1181 struct text_pos pos
;
1183 xassert (s
!= NULL
);
1184 xassert (charpos
>= 0);
1188 int rest
= strlen (s
), len
;
1190 SET_TEXT_POS (pos
, 0, 0);
1193 string_char_and_length (s
, rest
, &len
);
1194 s
+= len
, rest
-= len
;
1195 xassert (rest
>= 0);
1197 BYTEPOS (pos
) += len
;
1201 SET_TEXT_POS (pos
, charpos
, charpos
);
1207 /* Value is the number of characters in C string S. MULTIBYTE_P
1208 non-zero means recognize multibyte characters. */
1211 number_of_chars (s
, multibyte_p
)
1219 int rest
= strlen (s
), len
;
1220 unsigned char *p
= (unsigned char *) s
;
1222 for (nchars
= 0; rest
> 0; ++nchars
)
1224 string_char_and_length (p
, rest
, &len
);
1225 rest
-= len
, p
+= len
;
1229 nchars
= strlen (s
);
1235 /* Compute byte position NEWPOS->bytepos corresponding to
1236 NEWPOS->charpos. POS is a known position in string STRING.
1237 NEWPOS->charpos must be >= POS.charpos. */
1240 compute_string_pos (newpos
, pos
, string
)
1241 struct text_pos
*newpos
, pos
;
1244 xassert (STRINGP (string
));
1245 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1247 if (STRING_MULTIBYTE (string
))
1248 *newpos
= string_pos_nchars_ahead (pos
, string
,
1249 CHARPOS (*newpos
) - CHARPOS (pos
));
1251 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1256 /***********************************************************************
1257 Lisp form evaluation
1258 ***********************************************************************/
1260 /* Error handler for safe_eval and safe_call. */
1263 safe_eval_handler (arg
)
1266 add_to_log ("Error during redisplay: %s", arg
, Qnil
);
1271 /* Evaluate SEXPR and return the result, or nil if something went
1278 int count
= BINDING_STACK_SIZE ();
1279 struct gcpro gcpro1
;
1283 specbind (Qinhibit_redisplay
, Qt
);
1284 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
, safe_eval_handler
);
1286 return unbind_to (count
, val
);
1290 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
1291 Return the result, or nil if something went wrong. */
1294 safe_call (nargs
, args
)
1298 int count
= BINDING_STACK_SIZE ();
1300 struct gcpro gcpro1
;
1303 gcpro1
.nvars
= nargs
;
1304 specbind (Qinhibit_redisplay
, Qt
);
1305 val
= internal_condition_case_2 (Ffuncall
, nargs
, args
, Qerror
,
1308 return unbind_to (count
, val
);
1312 /* Call function FN with one argument ARG.
1313 Return the result, or nil if something went wrong. */
1316 safe_call1 (fn
, arg
)
1317 Lisp_Object fn
, arg
;
1319 Lisp_Object args
[2];
1322 return safe_call (2, args
);
1327 /***********************************************************************
1329 ***********************************************************************/
1333 /* Define CHECK_IT to perform sanity checks on iterators.
1334 This is for debugging. It is too slow to do unconditionally. */
1340 if (it
->method
== next_element_from_string
)
1342 xassert (STRINGP (it
->string
));
1343 xassert (IT_STRING_CHARPOS (*it
) >= 0);
1345 else if (it
->method
== next_element_from_buffer
)
1347 /* Check that character and byte positions agree. */
1348 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
1352 xassert (it
->current
.dpvec_index
>= 0);
1354 xassert (it
->current
.dpvec_index
< 0);
1357 #define CHECK_IT(IT) check_it ((IT))
1361 #define CHECK_IT(IT) (void) 0
1368 /* Check that the window end of window W is what we expect it
1369 to be---the last row in the current matrix displaying text. */
1372 check_window_end (w
)
1375 if (!MINI_WINDOW_P (w
)
1376 && !NILP (w
->window_end_valid
))
1378 struct glyph_row
*row
;
1379 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
1380 XFASTINT (w
->window_end_vpos
)),
1382 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
1383 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
1387 #define CHECK_WINDOW_END(W) check_window_end ((W))
1389 #else /* not GLYPH_DEBUG */
1391 #define CHECK_WINDOW_END(W) (void) 0
1393 #endif /* not GLYPH_DEBUG */
1397 /***********************************************************************
1398 Iterator initialization
1399 ***********************************************************************/
1401 /* Initialize IT for displaying current_buffer in window W, starting
1402 at character position CHARPOS. CHARPOS < 0 means that no buffer
1403 position is specified which is useful when the iterator is assigned
1404 a position later. BYTEPOS is the byte position corresponding to
1405 CHARPOS. BYTEPOS <= 0 means compute it from CHARPOS.
1407 If ROW is not null, calls to produce_glyphs with IT as parameter
1408 will produce glyphs in that row.
1410 BASE_FACE_ID is the id of a base face to use. It must be one of
1411 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID or
1412 HEADER_LINE_FACE_ID for displaying mode lines, or TOOL_BAR_FACE_ID for
1413 displaying the tool-bar.
1415 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID or
1416 HEADER_LINE_FACE_ID, the iterator will be initialized to use the
1417 corresponding mode line glyph row of the desired matrix of W. */
1420 init_iterator (it
, w
, charpos
, bytepos
, row
, base_face_id
)
1423 int charpos
, bytepos
;
1424 struct glyph_row
*row
;
1425 enum face_id base_face_id
;
1427 int highlight_region_p
;
1429 /* Some precondition checks. */
1430 xassert (w
!= NULL
&& it
!= NULL
);
1431 xassert (charpos
< 0 || (charpos
> 0 && charpos
<= ZV
));
1433 /* If face attributes have been changed since the last redisplay,
1434 free realized faces now because they depend on face definitions
1435 that might have changed. */
1436 if (face_change_count
)
1438 face_change_count
= 0;
1439 free_all_realized_faces (Qnil
);
1442 /* Use one of the mode line rows of W's desired matrix if
1446 if (base_face_id
== MODE_LINE_FACE_ID
)
1447 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
1448 else if (base_face_id
== HEADER_LINE_FACE_ID
)
1449 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
1453 bzero (it
, sizeof *it
);
1454 it
->current
.overlay_string_index
= -1;
1455 it
->current
.dpvec_index
= -1;
1456 it
->base_face_id
= base_face_id
;
1458 /* The window in which we iterate over current_buffer: */
1459 XSETWINDOW (it
->window
, w
);
1461 it
->f
= XFRAME (w
->frame
);
1463 /* Extra space between lines (on window systems only). */
1464 if (base_face_id
== DEFAULT_FACE_ID
1465 && FRAME_WINDOW_P (it
->f
))
1467 if (NATNUMP (current_buffer
->extra_line_spacing
))
1468 it
->extra_line_spacing
= XFASTINT (current_buffer
->extra_line_spacing
);
1469 else if (it
->f
->extra_line_spacing
> 0)
1470 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
1473 /* If realized faces have been removed, e.g. because of face
1474 attribute changes of named faces, recompute them. When running
1475 in batch mode, the face cache of Vterminal_frame is null. If
1476 we happen to get called, make a dummy face cache. */
1481 FRAME_FACE_CACHE (it
->f
) == NULL
)
1482 init_frame_faces (it
->f
);
1483 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
1484 recompute_basic_faces (it
->f
);
1486 /* Current value of the `space-width', and 'height' properties. */
1487 it
->space_width
= Qnil
;
1488 it
->font_height
= Qnil
;
1490 /* Are control characters displayed as `^C'? */
1491 it
->ctl_arrow_p
= !NILP (current_buffer
->ctl_arrow
);
1493 /* -1 means everything between a CR and the following line end
1494 is invisible. >0 means lines indented more than this value are
1496 it
->selective
= (INTEGERP (current_buffer
->selective_display
)
1497 ? XFASTINT (current_buffer
->selective_display
)
1498 : (!NILP (current_buffer
->selective_display
)
1500 it
->selective_display_ellipsis_p
1501 = !NILP (current_buffer
->selective_display_ellipses
);
1503 /* Display table to use. */
1504 it
->dp
= window_display_table (w
);
1506 /* Are multibyte characters enabled in current_buffer? */
1507 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
1509 /* Non-zero if we should highlight the region. */
1511 = (!NILP (Vtransient_mark_mode
)
1512 && !NILP (current_buffer
->mark_active
)
1513 && XMARKER (current_buffer
->mark
)->buffer
!= 0);
1515 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
1516 start and end of a visible region in window IT->w. Set both to
1517 -1 to indicate no region. */
1518 if (highlight_region_p
1519 /* Maybe highlight only in selected window. */
1520 && (/* Either show region everywhere. */
1521 highlight_nonselected_windows
1522 /* Or show region in the selected window. */
1523 || w
== XWINDOW (selected_window
)
1524 /* Or show the region if we are in the mini-buffer and W is
1525 the window the mini-buffer refers to. */
1526 || (MINI_WINDOW_P (XWINDOW (selected_window
))
1527 && WINDOWP (Vminibuf_scroll_window
)
1528 && w
== XWINDOW (Vminibuf_scroll_window
))))
1530 int charpos
= marker_position (current_buffer
->mark
);
1531 it
->region_beg_charpos
= min (PT
, charpos
);
1532 it
->region_end_charpos
= max (PT
, charpos
);
1535 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
1537 /* Get the position at which the redisplay_end_trigger hook should
1538 be run, if it is to be run at all. */
1539 if (MARKERP (w
->redisplay_end_trigger
)
1540 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
1541 it
->redisplay_end_trigger_charpos
1542 = marker_position (w
->redisplay_end_trigger
);
1543 else if (INTEGERP (w
->redisplay_end_trigger
))
1544 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
1546 /* Correct bogus values of tab_width. */
1547 it
->tab_width
= XINT (current_buffer
->tab_width
);
1548 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
1551 /* Are lines in the display truncated? */
1552 it
->truncate_lines_p
1553 = (base_face_id
!= DEFAULT_FACE_ID
1554 || XINT (it
->w
->hscroll
)
1555 || (truncate_partial_width_windows
1556 && !WINDOW_FULL_WIDTH_P (it
->w
))
1557 || !NILP (current_buffer
->truncate_lines
));
1559 /* Get dimensions of truncation and continuation glyphs. These are
1560 displayed as bitmaps under X, so we don't need them for such
1562 if (!FRAME_WINDOW_P (it
->f
))
1564 if (it
->truncate_lines_p
)
1566 /* We will need the truncation glyph. */
1567 xassert (it
->glyph_row
== NULL
);
1568 produce_special_glyphs (it
, IT_TRUNCATION
);
1569 it
->truncation_pixel_width
= it
->pixel_width
;
1573 /* We will need the continuation glyph. */
1574 xassert (it
->glyph_row
== NULL
);
1575 produce_special_glyphs (it
, IT_CONTINUATION
);
1576 it
->continuation_pixel_width
= it
->pixel_width
;
1579 /* Reset these values to zero becaue the produce_special_glyphs
1580 above has changed them. */
1581 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
1582 it
->phys_ascent
= it
->phys_descent
= 0;
1585 /* Set this after getting the dimensions of truncation and
1586 continuation glyphs, so that we don't produce glyphs when calling
1587 produce_special_glyphs, above. */
1588 it
->glyph_row
= row
;
1589 it
->area
= TEXT_AREA
;
1591 /* Get the dimensions of the display area. The display area
1592 consists of the visible window area plus a horizontally scrolled
1593 part to the left of the window. All x-values are relative to the
1594 start of this total display area. */
1595 if (base_face_id
!= DEFAULT_FACE_ID
)
1597 /* Mode lines, menu bar in terminal frames. */
1598 it
->first_visible_x
= 0;
1599 it
->last_visible_x
= XFASTINT (w
->width
) * CANON_X_UNIT (it
->f
);
1604 = XFASTINT (it
->w
->hscroll
) * CANON_X_UNIT (it
->f
);
1605 it
->last_visible_x
= (it
->first_visible_x
1606 + window_box_width (w
, TEXT_AREA
));
1608 /* If we truncate lines, leave room for the truncator glyph(s) at
1609 the right margin. Otherwise, leave room for the continuation
1610 glyph(s). Truncation and continuation glyphs are not inserted
1611 for window-based redisplay. */
1612 if (!FRAME_WINDOW_P (it
->f
))
1614 if (it
->truncate_lines_p
)
1615 it
->last_visible_x
-= it
->truncation_pixel_width
;
1617 it
->last_visible_x
-= it
->continuation_pixel_width
;
1620 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
1621 it
->current_y
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
1624 /* Leave room for a border glyph. */
1625 if (!FRAME_WINDOW_P (it
->f
)
1626 && !WINDOW_RIGHTMOST_P (it
->w
))
1627 it
->last_visible_x
-= 1;
1629 it
->last_visible_y
= window_text_bottom_y (w
);
1631 /* For mode lines and alike, arrange for the first glyph having a
1632 left box line if the face specifies a box. */
1633 if (base_face_id
!= DEFAULT_FACE_ID
)
1637 it
->face_id
= base_face_id
;
1639 /* If we have a boxed mode line, make the first character appear
1640 with a left box line. */
1641 face
= FACE_FROM_ID (it
->f
, base_face_id
);
1642 if (face
->box
!= FACE_NO_BOX
)
1643 it
->start_of_box_run_p
= 1;
1646 /* If a buffer position was specified, set the iterator there,
1647 getting overlays and face properties from that position. */
1650 it
->end_charpos
= ZV
;
1652 IT_CHARPOS (*it
) = charpos
;
1654 /* Compute byte position if not specified. */
1656 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
1658 IT_BYTEPOS (*it
) = bytepos
;
1660 /* Compute faces etc. */
1661 reseat (it
, it
->current
.pos
, 1);
1668 /* Initialize IT for the display of window W with window start POS. */
1671 start_display (it
, w
, pos
)
1674 struct text_pos pos
;
1676 int start_at_line_beg_p
;
1677 struct glyph_row
*row
;
1678 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
1681 row
= w
->desired_matrix
->rows
+ first_vpos
;
1682 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
1683 first_y
= it
->current_y
;
1685 /* If window start is not at a line start, move back to the line
1686 start. This makes sure that we take continuation lines into
1688 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
1689 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
1690 if (!start_at_line_beg_p
)
1691 reseat_at_previous_visible_line_start (it
);
1693 /* If window start is not at a line start, skip forward to POS to
1694 get the correct continuation_lines_width and current_x. */
1695 if (!start_at_line_beg_p
)
1697 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
1699 /* If lines are continued, this line may end in the middle of a
1700 multi-glyph character (e.g. a control character displayed as
1701 \003, or in the middle of an overlay string). In this case
1702 move_it_to above will not have taken us to the start of
1703 the continuation line but to the end of the continued line. */
1704 if (!it
->truncate_lines_p
)
1706 if (it
->current_x
> 0)
1708 if (it
->current
.dpvec_index
>= 0
1709 || it
->current
.overlay_string_index
>= 0)
1711 set_iterator_to_next (it
, 1);
1712 move_it_in_display_line_to (it
, -1, -1, 0);
1715 it
->continuation_lines_width
+= it
->current_x
;
1718 /* We're starting a new display line, not affected by the
1719 height of the continued line, so clear the appropriate
1720 fields in the iterator structure. */
1721 it
->max_ascent
= it
->max_descent
= 0;
1722 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
1725 it
->current_y
= first_y
;
1727 it
->current_x
= it
->hpos
= 0;
1730 #if 0 /* Don't assert the following because start_display is sometimes
1731 called intentionally with a window start that is not at a
1732 line start. Please leave this code in as a comment. */
1734 /* Window start should be on a line start, now. */
1735 xassert (it
->continuation_lines_width
1736 || IT_CHARPOS (it
) == BEGV
1737 || FETCH_BYTE (IT_BYTEPOS (it
) - 1) == '\n');
1742 /* Initialize IT for stepping through current_buffer in window W,
1743 starting at position POS that includes overlay string and display
1744 vector/ control character translation position information. */
1747 init_from_display_pos (it
, w
, pos
)
1750 struct display_pos
*pos
;
1752 /* Keep in mind: the call to reseat in init_iterator skips invisible
1753 text, so we might end up at a position different from POS. This
1754 is only a problem when POS is a row start after a newline and an
1755 overlay starts there with an after-string, and the overlay has an
1756 invisible property. Since we don't skip invisible text in
1757 display_line and elsewhere immediately after consuming the
1758 newline before the row start, such a POS will not be in a string,
1759 but the call to init_iterator below will move us to the
1761 init_iterator (it
, w
, CHARPOS (pos
->pos
), BYTEPOS (pos
->pos
),
1762 NULL
, DEFAULT_FACE_ID
);
1764 /* If position is within an overlay string, set up IT to
1765 the right overlay string. */
1766 if (pos
->overlay_string_index
>= 0)
1770 /* We already have the first chunk of overlay strings in
1771 IT->overlay_strings. Load more until the one for
1772 pos->overlay_string_index is in IT->overlay_strings. */
1773 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
1775 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
1776 it
->current
.overlay_string_index
= 0;
1779 load_overlay_strings (it
);
1780 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
1784 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
1785 relative_index
= (it
->current
.overlay_string_index
1786 % OVERLAY_STRING_CHUNK_SIZE
);
1787 it
->string
= it
->overlay_strings
[relative_index
];
1788 xassert (STRINGP (it
->string
));
1789 it
->current
.string_pos
= pos
->string_pos
;
1790 it
->method
= next_element_from_string
;
1792 else if (it
->current
.overlay_string_index
>= 0)
1794 /* If POS says we're already after an overlay string ending at
1795 POS, make sure to pop the iterator because it will be in
1796 front of that overlay string. When POS is ZV, we've thereby
1797 also ``processed'' overlay strings at ZV. */
1800 it
->current
.overlay_string_index
= -1;
1801 it
->method
= next_element_from_buffer
;
1802 if (CHARPOS (pos
->pos
) == ZV
)
1803 it
->overlay_strings_at_end_processed_p
= 1;
1806 if (CHARPOS (pos
->string_pos
) >= 0)
1808 /* Recorded position is not in an overlay string, but in another
1809 string. This can only be a string from a `display' property.
1810 IT should already be filled with that string. */
1811 it
->current
.string_pos
= pos
->string_pos
;
1812 xassert (STRINGP (it
->string
));
1815 /* Restore position in display vector translations or control
1816 character translations. */
1817 if (pos
->dpvec_index
>= 0)
1819 /* This fills IT->dpvec. */
1820 get_next_display_element (it
);
1821 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
1822 it
->current
.dpvec_index
= pos
->dpvec_index
;
1829 /* Initialize IT for stepping through current_buffer in window W
1830 starting at ROW->start. */
1833 init_to_row_start (it
, w
, row
)
1836 struct glyph_row
*row
;
1838 init_from_display_pos (it
, w
, &row
->start
);
1839 it
->continuation_lines_width
= row
->continuation_lines_width
;
1844 /* Initialize IT for stepping through current_buffer in window W
1845 starting in the line following ROW, i.e. starting at ROW->end. */
1848 init_to_row_end (it
, w
, row
)
1851 struct glyph_row
*row
;
1853 init_from_display_pos (it
, w
, &row
->end
);
1855 if (row
->continued_p
)
1856 it
->continuation_lines_width
= (row
->continuation_lines_width
1857 + row
->pixel_width
);
1864 /***********************************************************************
1866 ***********************************************************************/
1868 /* Called when IT reaches IT->stop_charpos. Handle text property and
1869 overlay changes. Set IT->stop_charpos to the next position where
1876 enum prop_handled handled
;
1877 int handle_overlay_change_p
= 1;
1881 it
->current
.dpvec_index
= -1;
1885 handled
= HANDLED_NORMALLY
;
1887 /* Call text property handlers. */
1888 for (p
= it_props
; p
->handler
; ++p
)
1890 handled
= p
->handler (it
);
1892 if (handled
== HANDLED_RECOMPUTE_PROPS
)
1894 else if (handled
== HANDLED_RETURN
)
1896 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
1897 handle_overlay_change_p
= 0;
1900 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
1902 /* Don't check for overlay strings below when set to deliver
1903 characters from a display vector. */
1904 if (it
->method
== next_element_from_display_vector
)
1905 handle_overlay_change_p
= 0;
1907 /* Handle overlay changes. */
1908 if (handle_overlay_change_p
)
1909 handled
= handle_overlay_change (it
);
1911 /* Determine where to stop next. */
1912 if (handled
== HANDLED_NORMALLY
)
1913 compute_stop_pos (it
);
1916 while (handled
== HANDLED_RECOMPUTE_PROPS
);
1920 /* Compute IT->stop_charpos from text property and overlay change
1921 information for IT's current position. */
1924 compute_stop_pos (it
)
1927 register INTERVAL iv
, next_iv
;
1928 Lisp_Object object
, limit
, position
;
1930 /* If nowhere else, stop at the end. */
1931 it
->stop_charpos
= it
->end_charpos
;
1933 if (STRINGP (it
->string
))
1935 /* Strings are usually short, so don't limit the search for
1937 object
= it
->string
;
1939 XSETFASTINT (position
, IT_STRING_CHARPOS (*it
));
1945 /* If next overlay change is in front of the current stop pos
1946 (which is IT->end_charpos), stop there. Note: value of
1947 next_overlay_change is point-max if no overlay change
1949 charpos
= next_overlay_change (IT_CHARPOS (*it
));
1950 if (charpos
< it
->stop_charpos
)
1951 it
->stop_charpos
= charpos
;
1953 /* If showing the region, we have to stop at the region
1954 start or end because the face might change there. */
1955 if (it
->region_beg_charpos
> 0)
1957 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
1958 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
1959 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
1960 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
1963 /* Set up variables for computing the stop position from text
1964 property changes. */
1965 XSETBUFFER (object
, current_buffer
);
1966 XSETFASTINT (limit
, IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
1967 XSETFASTINT (position
, IT_CHARPOS (*it
));
1971 /* Get the interval containing IT's position. Value is a null
1972 interval if there isn't such an interval. */
1973 iv
= validate_interval_range (object
, &position
, &position
, 0);
1974 if (!NULL_INTERVAL_P (iv
))
1976 Lisp_Object values_here
[LAST_PROP_IDX
];
1979 /* Get properties here. */
1980 for (p
= it_props
; p
->handler
; ++p
)
1981 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
1983 /* Look for an interval following iv that has different
1985 for (next_iv
= next_interval (iv
);
1986 (!NULL_INTERVAL_P (next_iv
)
1988 || XFASTINT (limit
) > next_iv
->position
));
1989 next_iv
= next_interval (next_iv
))
1991 for (p
= it_props
; p
->handler
; ++p
)
1993 Lisp_Object new_value
;
1995 new_value
= textget (next_iv
->plist
, *p
->name
);
1996 if (!EQ (values_here
[p
->idx
], new_value
))
2004 if (!NULL_INTERVAL_P (next_iv
))
2006 if (INTEGERP (limit
)
2007 && next_iv
->position
>= XFASTINT (limit
))
2008 /* No text property change up to limit. */
2009 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
2011 /* Text properties change in next_iv. */
2012 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
2016 xassert (STRINGP (it
->string
)
2017 || (it
->stop_charpos
>= BEGV
2018 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
2022 /* Return the position of the next overlay change after POS in
2023 current_buffer. Value is point-max if no overlay change
2024 follows. This is like `next-overlay-change' but doesn't use
2028 next_overlay_change (pos
)
2033 Lisp_Object
*overlays
;
2037 /* Get all overlays at the given position. */
2039 overlays
= (Lisp_Object
*) alloca (len
* sizeof *overlays
);
2040 noverlays
= overlays_at (pos
, 0, &overlays
, &len
, &endpos
, NULL
, 1);
2041 if (noverlays
> len
)
2044 overlays
= (Lisp_Object
*) alloca (len
* sizeof *overlays
);
2045 noverlays
= overlays_at (pos
, 0, &overlays
, &len
, &endpos
, NULL
, 1);
2048 /* If any of these overlays ends before endpos,
2049 use its ending point instead. */
2050 for (i
= 0; i
< noverlays
; ++i
)
2055 oend
= OVERLAY_END (overlays
[i
]);
2056 oendpos
= OVERLAY_POSITION (oend
);
2057 endpos
= min (endpos
, oendpos
);
2065 /***********************************************************************
2067 ***********************************************************************/
2069 /* Handle changes in the `fontified' property of the current buffer by
2070 calling hook functions from Qfontification_functions to fontify
2073 static enum prop_handled
2074 handle_fontified_prop (it
)
2077 Lisp_Object prop
, pos
;
2078 enum prop_handled handled
= HANDLED_NORMALLY
;
2080 /* Get the value of the `fontified' property at IT's current buffer
2081 position. (The `fontified' property doesn't have a special
2082 meaning in strings.) If the value is nil, call functions from
2083 Qfontification_functions. */
2084 if (!STRINGP (it
->string
)
2086 && !NILP (Vfontification_functions
)
2087 && !NILP (Vrun_hooks
)
2088 && (pos
= make_number (IT_CHARPOS (*it
)),
2089 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
2092 int count
= BINDING_STACK_SIZE ();
2095 val
= Vfontification_functions
;
2096 specbind (Qfontification_functions
, Qnil
);
2097 specbind (Qafter_change_functions
, Qnil
);
2099 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
2100 safe_call1 (val
, pos
);
2103 Lisp_Object globals
, fn
;
2104 struct gcpro gcpro1
, gcpro2
;
2107 GCPRO2 (val
, globals
);
2109 for (; CONSP (val
); val
= XCDR (val
))
2115 /* A value of t indicates this hook has a local
2116 binding; it means to run the global binding too.
2117 In a global value, t should not occur. If it
2118 does, we must ignore it to avoid an endless
2120 for (globals
= Fdefault_value (Qfontification_functions
);
2122 globals
= XCDR (globals
))
2124 fn
= XCAR (globals
);
2126 safe_call1 (fn
, pos
);
2130 safe_call1 (fn
, pos
);
2136 unbind_to (count
, Qnil
);
2138 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
2139 something. This avoids an endless loop if they failed to
2140 fontify the text for which reason ever. */
2141 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
2142 handled
= HANDLED_RECOMPUTE_PROPS
;
2150 /***********************************************************************
2152 ***********************************************************************/
2154 /* Set up iterator IT from face properties at its current position.
2155 Called from handle_stop. */
2157 static enum prop_handled
2158 handle_face_prop (it
)
2161 int new_face_id
, next_stop
;
2163 if (!STRINGP (it
->string
))
2166 = face_at_buffer_position (it
->w
,
2168 it
->region_beg_charpos
,
2169 it
->region_end_charpos
,
2172 + TEXT_PROP_DISTANCE_LIMIT
),
2175 /* Is this a start of a run of characters with box face?
2176 Caveat: this can be called for a freshly initialized
2177 iterator; face_id is -1 is this case. We know that the new
2178 face will not change until limit, i.e. if the new face has a
2179 box, all characters up to limit will have one. But, as
2180 usual, we don't know whether limit is really the end. */
2181 if (new_face_id
!= it
->face_id
)
2183 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
2185 /* If new face has a box but old face has not, this is
2186 the start of a run of characters with box, i.e. it has
2187 a shadow on the left side. The value of face_id of the
2188 iterator will be -1 if this is the initial call that gets
2189 the face. In this case, we have to look in front of IT's
2190 position and see whether there is a face != new_face_id. */
2191 it
->start_of_box_run_p
2192 = (new_face
->box
!= FACE_NO_BOX
2193 && (it
->face_id
>= 0
2194 || IT_CHARPOS (*it
) == BEG
2195 || new_face_id
!= face_before_it_pos (it
)));
2196 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
2201 int base_face_id
, bufpos
;
2203 if (it
->current
.overlay_string_index
>= 0)
2204 bufpos
= IT_CHARPOS (*it
);
2208 /* For strings from a buffer, i.e. overlay strings or strings
2209 from a `display' property, use the face at IT's current
2210 buffer position as the base face to merge with, so that
2211 overlay strings appear in the same face as surrounding
2212 text, unless they specify their own faces. */
2213 base_face_id
= underlying_face_id (it
);
2215 new_face_id
= face_at_string_position (it
->w
,
2217 IT_STRING_CHARPOS (*it
),
2219 it
->region_beg_charpos
,
2220 it
->region_end_charpos
,
2224 #if 0 /* This shouldn't be neccessary. Let's check it. */
2225 /* If IT is used to display a mode line we would really like to
2226 use the mode line face instead of the frame's default face. */
2227 if (it
->glyph_row
== MATRIX_MODE_LINE_ROW (it
->w
->desired_matrix
)
2228 && new_face_id
== DEFAULT_FACE_ID
)
2229 new_face_id
= MODE_LINE_FACE_ID
;
2232 /* Is this a start of a run of characters with box? Caveat:
2233 this can be called for a freshly allocated iterator; face_id
2234 is -1 is this case. We know that the new face will not
2235 change until the next check pos, i.e. if the new face has a
2236 box, all characters up to that position will have a
2237 box. But, as usual, we don't know whether that position
2238 is really the end. */
2239 if (new_face_id
!= it
->face_id
)
2241 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
2242 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
2244 /* If new face has a box but old face hasn't, this is the
2245 start of a run of characters with box, i.e. it has a
2246 shadow on the left side. */
2247 it
->start_of_box_run_p
2248 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
2249 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
2253 it
->face_id
= new_face_id
;
2254 return HANDLED_NORMALLY
;
2258 /* Return the ID of the face ``underlying'' IT's current position,
2259 which is in a string. If the iterator is associated with a
2260 buffer, return the face at IT's current buffer position.
2261 Otherwise, use the iterator's base_face_id. */
2264 underlying_face_id (it
)
2267 int face_id
= it
->base_face_id
, i
;
2269 xassert (STRINGP (it
->string
));
2271 for (i
= it
->sp
- 1; i
>= 0; --i
)
2272 if (NILP (it
->stack
[i
].string
))
2273 face_id
= it
->stack
[i
].face_id
;
2279 /* Compute the face one character before or after the current position
2280 of IT. BEFORE_P non-zero means get the face in front of IT's
2281 position. Value is the id of the face. */
2284 face_before_or_after_it_pos (it
, before_p
)
2289 int next_check_charpos
;
2290 struct text_pos pos
;
2292 xassert (it
->s
== NULL
);
2294 if (STRINGP (it
->string
))
2296 int bufpos
, base_face_id
;
2298 /* No face change past the end of the string (for the case
2299 we are padding with spaces). No face change before the
2301 if (IT_STRING_CHARPOS (*it
) >= XSTRING (it
->string
)->size
2302 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
2305 /* Set pos to the position before or after IT's current position. */
2307 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
2309 /* For composition, we must check the character after the
2311 pos
= (it
->what
== IT_COMPOSITION
2312 ? string_pos (IT_STRING_CHARPOS (*it
) + it
->cmp_len
, it
->string
)
2313 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
2315 if (it
->current
.overlay_string_index
>= 0)
2316 bufpos
= IT_CHARPOS (*it
);
2320 base_face_id
= underlying_face_id (it
);
2322 /* Get the face for ASCII, or unibyte. */
2323 face_id
= face_at_string_position (it
->w
,
2327 it
->region_beg_charpos
,
2328 it
->region_end_charpos
,
2329 &next_check_charpos
,
2332 /* Correct the face for charsets different from ASCII. Do it
2333 for the multibyte case only. The face returned above is
2334 suitable for unibyte text if IT->string is unibyte. */
2335 if (STRING_MULTIBYTE (it
->string
))
2337 unsigned char *p
= XSTRING (it
->string
)->data
+ BYTEPOS (pos
);
2338 int rest
= STRING_BYTES (XSTRING (it
->string
)) - BYTEPOS (pos
);
2340 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
2342 c
= string_char_and_length (p
, rest
, &len
);
2343 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
);
2348 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
2349 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
2352 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
2353 pos
= it
->current
.pos
;
2356 DEC_TEXT_POS (pos
, it
->multibyte_p
);
2359 if (it
->what
== IT_COMPOSITION
)
2360 /* For composition, we must check the position after the
2362 pos
.charpos
+= it
->cmp_len
, pos
.bytepos
+= it
->len
;
2364 INC_TEXT_POS (pos
, it
->multibyte_p
);
2367 /* Determine face for CHARSET_ASCII, or unibyte. */
2368 face_id
= face_at_buffer_position (it
->w
,
2370 it
->region_beg_charpos
,
2371 it
->region_end_charpos
,
2372 &next_check_charpos
,
2375 /* Correct the face for charsets different from ASCII. Do it
2376 for the multibyte case only. The face returned above is
2377 suitable for unibyte text if current_buffer is unibyte. */
2378 if (it
->multibyte_p
)
2380 int c
= FETCH_MULTIBYTE_CHAR (CHARPOS (pos
));
2381 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
2382 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
);
2391 /***********************************************************************
2393 ***********************************************************************/
2395 /* Set up iterator IT from invisible properties at its current
2396 position. Called from handle_stop. */
2398 static enum prop_handled
2399 handle_invisible_prop (it
)
2402 enum prop_handled handled
= HANDLED_NORMALLY
;
2404 if (STRINGP (it
->string
))
2406 extern Lisp_Object Qinvisible
;
2407 Lisp_Object prop
, end_charpos
, limit
, charpos
;
2409 /* Get the value of the invisible text property at the
2410 current position. Value will be nil if there is no such
2412 XSETFASTINT (charpos
, IT_STRING_CHARPOS (*it
));
2413 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
2416 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
2418 handled
= HANDLED_RECOMPUTE_PROPS
;
2420 /* Get the position at which the next change of the
2421 invisible text property can be found in IT->string.
2422 Value will be nil if the property value is the same for
2423 all the rest of IT->string. */
2424 XSETINT (limit
, XSTRING (it
->string
)->size
);
2425 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
2428 /* Text at current position is invisible. The next
2429 change in the property is at position end_charpos.
2430 Move IT's current position to that position. */
2431 if (INTEGERP (end_charpos
)
2432 && XFASTINT (end_charpos
) < XFASTINT (limit
))
2434 struct text_pos old
;
2435 old
= it
->current
.string_pos
;
2436 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
2437 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
2441 /* The rest of the string is invisible. If this is an
2442 overlay string, proceed with the next overlay string
2443 or whatever comes and return a character from there. */
2444 if (it
->current
.overlay_string_index
>= 0)
2446 next_overlay_string (it
);
2447 /* Don't check for overlay strings when we just
2448 finished processing them. */
2449 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
2453 struct Lisp_String
*s
= XSTRING (it
->string
);
2454 IT_STRING_CHARPOS (*it
) = s
->size
;
2455 IT_STRING_BYTEPOS (*it
) = STRING_BYTES (s
);
2462 int visible_p
, newpos
, next_stop
;
2463 Lisp_Object pos
, prop
;
2465 /* First of all, is there invisible text at this position? */
2466 XSETFASTINT (pos
, IT_CHARPOS (*it
));
2467 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
2469 /* If we are on invisible text, skip over it. */
2470 if (TEXT_PROP_MEANS_INVISIBLE (prop
)
2471 && IT_CHARPOS (*it
) < it
->end_charpos
)
2473 /* Record whether we have to display an ellipsis for the
2475 int display_ellipsis_p
2476 = TEXT_PROP_MEANS_INVISIBLE_WITH_ELLIPSIS (prop
);
2478 handled
= HANDLED_RECOMPUTE_PROPS
;
2480 /* Loop skipping over invisible text. The loop is left at
2481 ZV or with IT on the first char being visible again. */
2484 /* Try to skip some invisible text. Return value is the
2485 position reached which can be equal to IT's position
2486 if there is nothing invisible here. This skips both
2487 over invisible text properties and overlays with
2488 invisible property. */
2489 newpos
= skip_invisible (IT_CHARPOS (*it
),
2490 &next_stop
, ZV
, it
->window
);
2492 /* If we skipped nothing at all we weren't at invisible
2493 text in the first place. If everything to the end of
2494 the buffer was skipped, end the loop. */
2495 if (newpos
== IT_CHARPOS (*it
) || newpos
>= ZV
)
2499 /* We skipped some characters but not necessarily
2500 all there are. Check if we ended up on visible
2501 text. Fget_char_property returns the property of
2502 the char before the given position, i.e. if we
2503 get visible_p = 1, this means that the char at
2504 newpos is visible. */
2505 XSETFASTINT (pos
, newpos
);
2506 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
2507 visible_p
= !TEXT_PROP_MEANS_INVISIBLE (prop
);
2510 /* If we ended up on invisible text, proceed to
2511 skip starting with next_stop. */
2513 IT_CHARPOS (*it
) = next_stop
;
2517 /* The position newpos is now either ZV or on visible text. */
2518 IT_CHARPOS (*it
) = newpos
;
2519 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
2521 /* Maybe return `...' next for the end of the invisible text. */
2522 if (display_ellipsis_p
)
2525 && VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
2527 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
2528 it
->dpvec
= v
->contents
;
2529 it
->dpend
= v
->contents
+ v
->size
;
2533 /* Default `...'. */
2534 it
->dpvec
= default_invis_vector
;
2535 it
->dpend
= default_invis_vector
+ 3;
2538 /* The ellipsis display does not replace the display of
2539 the character at the new position. Indicate this by
2540 setting IT->dpvec_char_len to zero. */
2541 it
->dpvec_char_len
= 0;
2543 it
->current
.dpvec_index
= 0;
2544 it
->method
= next_element_from_display_vector
;
2554 /***********************************************************************
2556 ***********************************************************************/
2558 /* Set up iterator IT from `display' property at its current position.
2559 Called from handle_stop. */
2561 static enum prop_handled
2562 handle_display_prop (it
)
2565 Lisp_Object prop
, object
;
2566 struct text_pos
*position
;
2567 int display_replaced_p
= 0;
2569 if (STRINGP (it
->string
))
2571 object
= it
->string
;
2572 position
= &it
->current
.string_pos
;
2576 object
= it
->w
->buffer
;
2577 position
= &it
->current
.pos
;
2580 /* Reset those iterator values set from display property values. */
2581 it
->font_height
= Qnil
;
2582 it
->space_width
= Qnil
;
2585 /* We don't support recursive `display' properties, i.e. string
2586 values that have a string `display' property, that have a string
2587 `display' property etc. */
2588 if (!it
->string_from_display_prop_p
)
2589 it
->area
= TEXT_AREA
;
2591 prop
= Fget_char_property (make_number (position
->charpos
),
2594 return HANDLED_NORMALLY
;
2597 && CONSP (XCAR (prop
))
2598 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
2600 /* A list of sub-properties. */
2601 for (; CONSP (prop
); prop
= XCDR (prop
))
2603 if (handle_single_display_prop (it
, XCAR (prop
), object
,
2604 position
, display_replaced_p
))
2605 display_replaced_p
= 1;
2608 else if (VECTORP (prop
))
2611 for (i
= 0; i
< ASIZE (prop
); ++i
)
2612 if (handle_single_display_prop (it
, AREF (prop
, i
), object
,
2613 position
, display_replaced_p
))
2614 display_replaced_p
= 1;
2618 if (handle_single_display_prop (it
, prop
, object
, position
, 0))
2619 display_replaced_p
= 1;
2622 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
2626 /* Value is the position of the end of the `display' property starting
2627 at START_POS in OBJECT. */
2629 static struct text_pos
2630 display_prop_end (it
, object
, start_pos
)
2633 struct text_pos start_pos
;
2636 struct text_pos end_pos
;
2638 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
2639 Qdisplay
, object
, Qnil
);
2640 CHARPOS (end_pos
) = XFASTINT (end
);
2641 if (STRINGP (object
))
2642 compute_string_pos (&end_pos
, start_pos
, it
->string
);
2644 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
2650 /* Set up IT from a single `display' sub-property value PROP. OBJECT
2651 is the object in which the `display' property was found. *POSITION
2652 is the position at which it was found. DISPLAY_REPLACED_P non-zero
2653 means that we previously saw a display sub-property which already
2654 replaced text display with something else, for example an image;
2655 ignore such properties after the first one has been processed.
2657 If PROP is a `space' or `image' sub-property, set *POSITION to the
2658 end position of the `display' property.
2660 Value is non-zero something was found which replaces the display
2661 of buffer or string text. */
2664 handle_single_display_prop (it
, prop
, object
, position
,
2665 display_replaced_before_p
)
2669 struct text_pos
*position
;
2670 int display_replaced_before_p
;
2673 int replaces_text_display_p
= 0;
2676 /* If PROP is a list of the form `(when FORM . VALUE)', FORM is
2677 evaluated. If the result is nil, VALUE is ignored. */
2679 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
2688 if (!NILP (form
) && !EQ (form
, Qt
))
2690 struct gcpro gcpro1
;
2691 struct text_pos end_pos
, pt
;
2694 end_pos
= display_prop_end (it
, object
, *position
);
2696 /* Temporarily set point to the end position, and then evaluate
2697 the form. This makes `(eolp)' work as FORM. */
2698 if (BUFFERP (object
))
2701 BYTEPOS (pt
) = PT_BYTE
;
2702 TEMP_SET_PT_BOTH (CHARPOS (end_pos
), BYTEPOS (end_pos
));
2705 form
= safe_eval (form
);
2707 if (BUFFERP (object
))
2708 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
2716 && EQ (XCAR (prop
), Qheight
)
2717 && CONSP (XCDR (prop
)))
2719 if (FRAME_TERMCAP_P (it
->f
) || FRAME_MSDOS_P (it
->f
))
2722 /* `(height HEIGHT)'. */
2723 it
->font_height
= XCAR (XCDR (prop
));
2724 if (!NILP (it
->font_height
))
2726 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
2727 int new_height
= -1;
2729 if (CONSP (it
->font_height
)
2730 && (EQ (XCAR (it
->font_height
), Qplus
)
2731 || EQ (XCAR (it
->font_height
), Qminus
))
2732 && CONSP (XCDR (it
->font_height
))
2733 && INTEGERP (XCAR (XCDR (it
->font_height
))))
2735 /* `(+ N)' or `(- N)' where N is an integer. */
2736 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
2737 if (EQ (XCAR (it
->font_height
), Qplus
))
2739 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
2741 else if (FUNCTIONP (it
->font_height
))
2743 /* Call function with current height as argument.
2744 Value is the new height. */
2746 height
= safe_call1 (it
->font_height
,
2747 face
->lface
[LFACE_HEIGHT_INDEX
]);
2748 if (NUMBERP (height
))
2749 new_height
= XFLOATINT (height
);
2751 else if (NUMBERP (it
->font_height
))
2753 /* Value is a multiple of the canonical char height. */
2756 face
= FACE_FROM_ID (it
->f
, DEFAULT_FACE_ID
);
2757 new_height
= (XFLOATINT (it
->font_height
)
2758 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
2762 /* Evaluate IT->font_height with `height' bound to the
2763 current specified height to get the new height. */
2765 int count
= BINDING_STACK_SIZE ();
2767 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
2768 value
= safe_eval (it
->font_height
);
2769 unbind_to (count
, Qnil
);
2771 if (NUMBERP (value
))
2772 new_height
= XFLOATINT (value
);
2776 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
2779 else if (CONSP (prop
)
2780 && EQ (XCAR (prop
), Qspace_width
)
2781 && CONSP (XCDR (prop
)))
2783 /* `(space_width WIDTH)'. */
2784 if (FRAME_TERMCAP_P (it
->f
) || FRAME_MSDOS_P (it
->f
))
2787 value
= XCAR (XCDR (prop
));
2788 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
2789 it
->space_width
= value
;
2791 else if (CONSP (prop
)
2792 && EQ (XCAR (prop
), Qraise
)
2793 && CONSP (XCDR (prop
)))
2795 /* `(raise FACTOR)'. */
2796 if (FRAME_TERMCAP_P (it
->f
) || FRAME_MSDOS_P (it
->f
))
2799 #ifdef HAVE_WINDOW_SYSTEM
2800 value
= XCAR (XCDR (prop
));
2801 if (NUMBERP (value
))
2803 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
2804 it
->voffset
= - (XFLOATINT (value
)
2805 * (FONT_HEIGHT (face
->font
)));
2807 #endif /* HAVE_WINDOW_SYSTEM */
2809 else if (!it
->string_from_display_prop_p
)
2811 /* `((margin left-margin) VALUE)' or `((margin right-margin)
2812 VALUE) or `((margin nil) VALUE)' or VALUE. */
2813 Lisp_Object location
, value
;
2814 struct text_pos start_pos
;
2817 /* Characters having this form of property are not displayed, so
2818 we have to find the end of the property. */
2819 start_pos
= *position
;
2820 *position
= display_prop_end (it
, object
, start_pos
);
2823 /* Let's stop at the new position and assume that all
2824 text properties change there. */
2825 it
->stop_charpos
= position
->charpos
;
2827 location
= Qunbound
;
2828 if (CONSP (prop
) && CONSP (XCAR (prop
)))
2832 value
= XCDR (prop
);
2834 value
= XCAR (value
);
2837 if (EQ (XCAR (tem
), Qmargin
)
2838 && (tem
= XCDR (tem
),
2839 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
2841 || EQ (tem
, Qleft_margin
)
2842 || EQ (tem
, Qright_margin
))))
2846 if (EQ (location
, Qunbound
))
2852 #ifdef HAVE_WINDOW_SYSTEM
2853 if (FRAME_TERMCAP_P (it
->f
))
2854 valid_p
= STRINGP (value
);
2856 valid_p
= (STRINGP (value
)
2857 || (CONSP (value
) && EQ (XCAR (value
), Qspace
))
2858 || valid_image_p (value
));
2859 #else /* not HAVE_WINDOW_SYSTEM */
2860 valid_p
= STRINGP (value
);
2861 #endif /* not HAVE_WINDOW_SYSTEM */
2863 if ((EQ (location
, Qleft_margin
)
2864 || EQ (location
, Qright_margin
)
2867 && !display_replaced_before_p
)
2869 replaces_text_display_p
= 1;
2871 /* Save current settings of IT so that we can restore them
2872 when we are finished with the glyph property value. */
2875 if (NILP (location
))
2876 it
->area
= TEXT_AREA
;
2877 else if (EQ (location
, Qleft_margin
))
2878 it
->area
= LEFT_MARGIN_AREA
;
2880 it
->area
= RIGHT_MARGIN_AREA
;
2882 if (STRINGP (value
))
2885 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
2886 it
->current
.overlay_string_index
= -1;
2887 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
2888 it
->end_charpos
= it
->string_nchars
2889 = XSTRING (it
->string
)->size
;
2890 it
->method
= next_element_from_string
;
2891 it
->stop_charpos
= 0;
2892 it
->string_from_display_prop_p
= 1;
2893 /* Say that we haven't consumed the characters with
2894 `display' property yet. The call to pop_it in
2895 set_iterator_to_next will clean this up. */
2896 *position
= start_pos
;
2898 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
2900 it
->method
= next_element_from_stretch
;
2902 it
->current
.pos
= it
->position
= start_pos
;
2904 #ifdef HAVE_WINDOW_SYSTEM
2907 it
->what
= IT_IMAGE
;
2908 it
->image_id
= lookup_image (it
->f
, value
);
2909 it
->position
= start_pos
;
2910 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
2911 it
->method
= next_element_from_image
;
2913 /* Say that we haven't consumed the characters with
2914 `display' property yet. The call to pop_it in
2915 set_iterator_to_next will clean this up. */
2916 *position
= start_pos
;
2918 #endif /* HAVE_WINDOW_SYSTEM */
2921 /* Invalid property or property not supported. Restore
2922 the position to what it was before. */
2923 *position
= start_pos
;
2926 return replaces_text_display_p
;
2930 /* Check if PROP is a display sub-property value whose text should be
2931 treated as intangible. */
2934 single_display_prop_intangible_p (prop
)
2937 /* Skip over `when FORM'. */
2938 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
2949 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
2950 we don't need to treat text as intangible. */
2951 if (EQ (XCAR (prop
), Qmargin
))
2959 || EQ (XCAR (prop
), Qleft_margin
)
2960 || EQ (XCAR (prop
), Qright_margin
))
2964 return CONSP (prop
) && EQ (XCAR (prop
), Qimage
);
2968 /* Check if PROP is a display property value whose text should be
2969 treated as intangible. */
2972 display_prop_intangible_p (prop
)
2976 && CONSP (XCAR (prop
))
2977 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
2979 /* A list of sub-properties. */
2980 while (CONSP (prop
))
2982 if (single_display_prop_intangible_p (XCAR (prop
)))
2987 else if (VECTORP (prop
))
2989 /* A vector of sub-properties. */
2991 for (i
= 0; i
< ASIZE (prop
); ++i
)
2992 if (single_display_prop_intangible_p (AREF (prop
, i
)))
2996 return single_display_prop_intangible_p (prop
);
3002 /* Return 1 if PROP is a display sub-property value containing STRING. */
3005 single_display_prop_string_p (prop
, string
)
3006 Lisp_Object prop
, string
;
3008 extern Lisp_Object Qwhen
, Qmargin
;
3010 if (EQ (string
, prop
))
3013 /* Skip over `when FORM'. */
3014 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
3023 /* Skip over `margin LOCATION'. */
3024 if (EQ (XCAR (prop
), Qmargin
))
3035 return CONSP (prop
) && EQ (XCAR (prop
), string
);
3039 /* Return 1 if STRING appears in the `display' property PROP. */
3042 display_prop_string_p (prop
, string
)
3043 Lisp_Object prop
, string
;
3045 extern Lisp_Object Qwhen
, Qmargin
;
3048 && CONSP (XCAR (prop
))
3049 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
3051 /* A list of sub-properties. */
3052 while (CONSP (prop
))
3054 if (single_display_prop_string_p (XCAR (prop
), string
))
3059 else if (VECTORP (prop
))
3061 /* A vector of sub-properties. */
3063 for (i
= 0; i
< ASIZE (prop
); ++i
)
3064 if (single_display_prop_string_p (AREF (prop
, i
), string
))
3068 return single_display_prop_string_p (prop
, string
);
3074 /* Determine from which buffer position in W's buffer STRING comes
3075 from. AROUND_CHARPOS is an approximate position where it could
3076 be from. Value is the buffer position or 0 if it couldn't be
3079 W's buffer must be current.
3081 This function is necessary because we don't record buffer positions
3082 in glyphs generated from strings (to keep struct glyph small).
3083 This function may only use code that doesn't eval because it is
3084 called asynchronously from note_mouse_highlight. */
3087 string_buffer_position (w
, string
, around_charpos
)
3092 Lisp_Object around
= make_number (around_charpos
);
3093 Lisp_Object limit
, prop
, pos
;
3094 const int MAX_DISTANCE
= 1000;
3097 pos
= make_number (around_charpos
);
3098 limit
= make_number (min (XINT (pos
) + MAX_DISTANCE
, ZV
));
3099 while (!found
&& !EQ (pos
, limit
))
3101 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
3102 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
3105 pos
= Fnext_single_property_change (pos
, Qdisplay
, Qnil
, limit
);
3110 pos
= make_number (around_charpos
);
3111 limit
= make_number (max (XINT (pos
) - MAX_DISTANCE
, BEGV
));
3112 while (!found
&& !EQ (pos
, limit
))
3114 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
3115 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
3118 pos
= Fprevious_single_property_change (pos
, Qdisplay
, Qnil
,
3123 return found
? XINT (pos
) : 0;
3128 /***********************************************************************
3129 `composition' property
3130 ***********************************************************************/
3132 /* Set up iterator IT from `composition' property at its current
3133 position. Called from handle_stop. */
3135 static enum prop_handled
3136 handle_composition_prop (it
)
3139 Lisp_Object prop
, string
;
3140 int pos
, pos_byte
, end
;
3141 enum prop_handled handled
= HANDLED_NORMALLY
;
3143 if (STRINGP (it
->string
))
3145 pos
= IT_STRING_CHARPOS (*it
);
3146 pos_byte
= IT_STRING_BYTEPOS (*it
);
3147 string
= it
->string
;
3151 pos
= IT_CHARPOS (*it
);
3152 pos_byte
= IT_BYTEPOS (*it
);
3156 /* If there's a valid composition and point is not inside of the
3157 composition (in the case that the composition is from the current
3158 buffer), draw a glyph composed from the composition components. */
3159 if (find_composition (pos
, -1, &pos
, &end
, &prop
, string
)
3160 && COMPOSITION_VALID_P (pos
, end
, prop
)
3161 && (STRINGP (it
->string
) || (PT
<= pos
|| PT
>= end
)))
3163 int id
= get_composition_id (pos
, pos_byte
, end
- pos
, prop
, string
);
3167 it
->method
= next_element_from_composition
;
3169 it
->cmp_len
= COMPOSITION_LENGTH (prop
);
3170 /* For a terminal, draw only the first character of the
3172 it
->c
= COMPOSITION_GLYPH (composition_table
[id
], 0);
3173 it
->len
= (STRINGP (it
->string
)
3174 ? string_char_to_byte (it
->string
, end
)
3175 : CHAR_TO_BYTE (end
)) - pos_byte
;
3176 it
->stop_charpos
= end
;
3177 handled
= HANDLED_RETURN
;
3186 /***********************************************************************
3188 ***********************************************************************/
3190 /* The following structure is used to record overlay strings for
3191 later sorting in load_overlay_strings. */
3193 struct overlay_entry
3195 Lisp_Object overlay
;
3202 /* Set up iterator IT from overlay strings at its current position.
3203 Called from handle_stop. */
3205 static enum prop_handled
3206 handle_overlay_change (it
)
3209 if (!STRINGP (it
->string
) && get_overlay_strings (it
))
3210 return HANDLED_RECOMPUTE_PROPS
;
3212 return HANDLED_NORMALLY
;
3216 /* Set up the next overlay string for delivery by IT, if there is an
3217 overlay string to deliver. Called by set_iterator_to_next when the
3218 end of the current overlay string is reached. If there are more
3219 overlay strings to display, IT->string and
3220 IT->current.overlay_string_index are set appropriately here.
3221 Otherwise IT->string is set to nil. */
3224 next_overlay_string (it
)
3227 ++it
->current
.overlay_string_index
;
3228 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
3230 /* No more overlay strings. Restore IT's settings to what
3231 they were before overlay strings were processed, and
3232 continue to deliver from current_buffer. */
3234 xassert (it
->stop_charpos
>= BEGV
3235 && it
->stop_charpos
<= it
->end_charpos
);
3237 it
->current
.overlay_string_index
= -1;
3238 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
3239 it
->n_overlay_strings
= 0;
3240 it
->method
= next_element_from_buffer
;
3242 /* If we're at the end of the buffer, record that we have
3243 processed the overlay strings there already, so that
3244 next_element_from_buffer doesn't try it again. */
3245 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
3246 it
->overlay_strings_at_end_processed_p
= 1;
3250 /* There are more overlay strings to process. If
3251 IT->current.overlay_string_index has advanced to a position
3252 where we must load IT->overlay_strings with more strings, do
3254 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
3256 if (it
->current
.overlay_string_index
&& i
== 0)
3257 load_overlay_strings (it
);
3259 /* Initialize IT to deliver display elements from the overlay
3261 it
->string
= it
->overlay_strings
[i
];
3262 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
3263 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
3264 it
->method
= next_element_from_string
;
3265 it
->stop_charpos
= 0;
3272 /* Compare two overlay_entry structures E1 and E2. Used as a
3273 comparison function for qsort in load_overlay_strings. Overlay
3274 strings for the same position are sorted so that
3276 1. All after-strings come in front of before-strings, except
3277 when they come from the same overlay.
3279 2. Within after-strings, strings are sorted so that overlay strings
3280 from overlays with higher priorities come first.
3282 2. Within before-strings, strings are sorted so that overlay
3283 strings from overlays with higher priorities come last.
3285 Value is analogous to strcmp. */
3289 compare_overlay_entries (e1
, e2
)
3292 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
3293 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
3296 if (entry1
->after_string_p
!= entry2
->after_string_p
)
3298 /* Let after-strings appear in front of before-strings if
3299 they come from different overlays. */
3300 if (EQ (entry1
->overlay
, entry2
->overlay
))
3301 result
= entry1
->after_string_p
? 1 : -1;
3303 result
= entry1
->after_string_p
? -1 : 1;
3305 else if (entry1
->after_string_p
)
3306 /* After-strings sorted in order of decreasing priority. */
3307 result
= entry2
->priority
- entry1
->priority
;
3309 /* Before-strings sorted in order of increasing priority. */
3310 result
= entry1
->priority
- entry2
->priority
;
3316 /* Load the vector IT->overlay_strings with overlay strings from IT's
3317 current buffer position. Set IT->n_overlays to the total number of
3318 overlay strings found.
3320 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
3321 a time. On entry into load_overlay_strings,
3322 IT->current.overlay_string_index gives the number of overlay
3323 strings that have already been loaded by previous calls to this
3326 IT->add_overlay_start contains an additional overlay start
3327 position to consider for taking overlay strings from, if non-zero.
3328 This position comes into play when the overlay has an `invisible'
3329 property, and both before and after-strings. When we've skipped to
3330 the end of the overlay, because of its `invisible' property, we
3331 nevertheless want its before-string to appear.
3332 IT->add_overlay_start will contain the overlay start position
3335 Overlay strings are sorted so that after-string strings come in
3336 front of before-string strings. Within before and after-strings,
3337 strings are sorted by overlay priority. See also function
3338 compare_overlay_entries. */
3341 load_overlay_strings (it
)
3344 extern Lisp_Object Qafter_string
, Qbefore_string
, Qwindow
, Qpriority
;
3345 Lisp_Object ov
, overlay
, window
, str
, invisible
;
3348 int n
= 0, i
, j
, invis_p
;
3349 struct overlay_entry
*entries
3350 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
3351 int charpos
= IT_CHARPOS (*it
);
3353 /* Append the overlay string STRING of overlay OVERLAY to vector
3354 `entries' which has size `size' and currently contains `n'
3355 elements. AFTER_P non-zero means STRING is an after-string of
3357 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
3360 Lisp_Object priority; \
3364 int new_size = 2 * size; \
3365 struct overlay_entry *old = entries; \
3367 (struct overlay_entry *) alloca (new_size \
3368 * sizeof *entries); \
3369 bcopy (old, entries, size * sizeof *entries); \
3373 entries[n].string = (STRING); \
3374 entries[n].overlay = (OVERLAY); \
3375 priority = Foverlay_get ((OVERLAY), Qpriority); \
3376 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
3377 entries[n].after_string_p = (AFTER_P); \
3382 /* Process overlay before the overlay center. */
3383 for (ov
= current_buffer
->overlays_before
; CONSP (ov
); ov
= XCDR (ov
))
3385 overlay
= XCAR (ov
);
3386 xassert (OVERLAYP (overlay
));
3387 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3388 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3393 /* Skip this overlay if it doesn't start or end at IT's current
3395 if (end
!= charpos
&& start
!= charpos
)
3398 /* Skip this overlay if it doesn't apply to IT->w. */
3399 window
= Foverlay_get (overlay
, Qwindow
);
3400 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
3403 /* If the text ``under'' the overlay is invisible, both before-
3404 and after-strings from this overlay are visible; start and
3405 end position are indistinguishable. */
3406 invisible
= Foverlay_get (overlay
, Qinvisible
);
3407 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
3409 /* If overlay has a non-empty before-string, record it. */
3410 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
3411 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
3412 && XSTRING (str
)->size
)
3413 RECORD_OVERLAY_STRING (overlay
, str
, 0);
3415 /* If overlay has a non-empty after-string, record it. */
3416 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
3417 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
3418 && XSTRING (str
)->size
)
3419 RECORD_OVERLAY_STRING (overlay
, str
, 1);
3422 /* Process overlays after the overlay center. */
3423 for (ov
= current_buffer
->overlays_after
; CONSP (ov
); ov
= XCDR (ov
))
3425 overlay
= XCAR (ov
);
3426 xassert (OVERLAYP (overlay
));
3427 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3428 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3430 if (start
> charpos
)
3433 /* Skip this overlay if it doesn't start or end at IT's current
3435 if (end
!= charpos
&& start
!= charpos
)
3438 /* Skip this overlay if it doesn't apply to IT->w. */
3439 window
= Foverlay_get (overlay
, Qwindow
);
3440 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
3443 /* If the text ``under'' the overlay is invisible, it has a zero
3444 dimension, and both before- and after-strings apply. */
3445 invisible
= Foverlay_get (overlay
, Qinvisible
);
3446 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
3448 /* If overlay has a non-empty before-string, record it. */
3449 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
3450 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
3451 && XSTRING (str
)->size
)
3452 RECORD_OVERLAY_STRING (overlay
, str
, 0);
3454 /* If overlay has a non-empty after-string, record it. */
3455 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
3456 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
3457 && XSTRING (str
)->size
)
3458 RECORD_OVERLAY_STRING (overlay
, str
, 1);
3461 #undef RECORD_OVERLAY_STRING
3465 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
3467 /* Record the total number of strings to process. */
3468 it
->n_overlay_strings
= n
;
3470 /* IT->current.overlay_string_index is the number of overlay strings
3471 that have already been consumed by IT. Copy some of the
3472 remaining overlay strings to IT->overlay_strings. */
3474 j
= it
->current
.overlay_string_index
;
3475 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
3476 it
->overlay_strings
[i
++] = entries
[j
++].string
;
3482 /* Get the first chunk of overlay strings at IT's current buffer
3483 position. Value is non-zero if at least one overlay string was
3487 get_overlay_strings (it
)
3490 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
3491 process. This fills IT->overlay_strings with strings, and sets
3492 IT->n_overlay_strings to the total number of strings to process.
3493 IT->pos.overlay_string_index has to be set temporarily to zero
3494 because load_overlay_strings needs this; it must be set to -1
3495 when no overlay strings are found because a zero value would
3496 indicate a position in the first overlay string. */
3497 it
->current
.overlay_string_index
= 0;
3498 load_overlay_strings (it
);
3500 /* If we found overlay strings, set up IT to deliver display
3501 elements from the first one. Otherwise set up IT to deliver
3502 from current_buffer. */
3503 if (it
->n_overlay_strings
)
3505 /* Make sure we know settings in current_buffer, so that we can
3506 restore meaningful values when we're done with the overlay
3508 compute_stop_pos (it
);
3509 xassert (it
->face_id
>= 0);
3511 /* Save IT's settings. They are restored after all overlay
3512 strings have been processed. */
3513 xassert (it
->sp
== 0);
3516 /* Set up IT to deliver display elements from the first overlay
3518 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
3519 it
->stop_charpos
= 0;
3520 it
->string
= it
->overlay_strings
[0];
3521 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
3522 xassert (STRINGP (it
->string
));
3523 it
->method
= next_element_from_string
;
3528 it
->current
.overlay_string_index
= -1;
3529 it
->method
= next_element_from_buffer
;
3534 /* Value is non-zero if we found at least one overlay string. */
3535 return STRINGP (it
->string
);
3540 /***********************************************************************
3541 Saving and restoring state
3542 ***********************************************************************/
3544 /* Save current settings of IT on IT->stack. Called, for example,
3545 before setting up IT for an overlay string, to be able to restore
3546 IT's settings to what they were after the overlay string has been
3553 struct iterator_stack_entry
*p
;
3555 xassert (it
->sp
< 2);
3556 p
= it
->stack
+ it
->sp
;
3558 p
->stop_charpos
= it
->stop_charpos
;
3559 xassert (it
->face_id
>= 0);
3560 p
->face_id
= it
->face_id
;
3561 p
->string
= it
->string
;
3562 p
->pos
= it
->current
;
3563 p
->end_charpos
= it
->end_charpos
;
3564 p
->string_nchars
= it
->string_nchars
;
3566 p
->multibyte_p
= it
->multibyte_p
;
3567 p
->space_width
= it
->space_width
;
3568 p
->font_height
= it
->font_height
;
3569 p
->voffset
= it
->voffset
;
3570 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
3575 /* Restore IT's settings from IT->stack. Called, for example, when no
3576 more overlay strings must be processed, and we return to delivering
3577 display elements from a buffer, or when the end of a string from a
3578 `display' property is reached and we return to delivering display
3579 elements from an overlay string, or from a buffer. */
3585 struct iterator_stack_entry
*p
;
3587 xassert (it
->sp
> 0);
3589 p
= it
->stack
+ it
->sp
;
3590 it
->stop_charpos
= p
->stop_charpos
;
3591 it
->face_id
= p
->face_id
;
3592 it
->string
= p
->string
;
3593 it
->current
= p
->pos
;
3594 it
->end_charpos
= p
->end_charpos
;
3595 it
->string_nchars
= p
->string_nchars
;
3597 it
->multibyte_p
= p
->multibyte_p
;
3598 it
->space_width
= p
->space_width
;
3599 it
->font_height
= p
->font_height
;
3600 it
->voffset
= p
->voffset
;
3601 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
3606 /***********************************************************************
3608 ***********************************************************************/
3610 /* Set IT's current position to the previous line start. */
3613 back_to_previous_line_start (it
)
3616 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
3617 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
3621 /* Move IT to the next line start.
3623 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
3624 we skipped over part of the text (as opposed to moving the iterator
3625 continuously over the text). Otherwise, don't change the value
3628 Newlines may come from buffer text, overlay strings, or strings
3629 displayed via the `display' property. That's the reason we can't
3630 simply use find_next_newline_no_quit.
3632 Note that this function may not skip over invisible text that is so
3633 because of text properties and immediately follows a newline. If
3634 it would, function reseat_at_next_visible_line_start, when called
3635 from set_iterator_to_next, would effectively make invisible
3636 characters following a newline part of the wrong glyph row, which
3637 leads to wrong cursor motion. */
3640 forward_to_next_line_start (it
, skipped_p
)
3644 int old_selective
, newline_found_p
, n
;
3645 const int MAX_NEWLINE_DISTANCE
= 500;
3647 /* If already on a newline, just consume it to avoid unintended
3648 skipping over invisible text below. */
3649 if (it
->what
== IT_CHARACTER
3651 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
3653 set_iterator_to_next (it
, 0);
3658 /* Don't handle selective display in the following. It's (a)
3659 unnecessary because it's done by the caller, and (b) leads to an
3660 infinite recursion because next_element_from_ellipsis indirectly
3661 calls this function. */
3662 old_selective
= it
->selective
;
3665 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
3666 from buffer text. */
3667 for (n
= newline_found_p
= 0;
3668 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
3669 n
+= STRINGP (it
->string
) ? 0 : 1)
3671 if (!get_next_display_element (it
))
3673 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
3674 set_iterator_to_next (it
, 0);
3677 /* If we didn't find a newline near enough, see if we can use a
3679 if (n
== MAX_NEWLINE_DISTANCE
)
3681 int start
= IT_CHARPOS (*it
);
3682 int limit
= find_next_newline_no_quit (start
, 1);
3685 xassert (!STRINGP (it
->string
));
3687 /* If there isn't any `display' property in sight, and no
3688 overlays, we can just use the position of the newline in
3690 if (it
->stop_charpos
>= limit
3691 || ((pos
= Fnext_single_property_change (make_number (start
),
3693 Qnil
, make_number (limit
)),
3695 && next_overlay_change (start
) == ZV
))
3697 IT_CHARPOS (*it
) = limit
;
3698 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
3699 *skipped_p
= newline_found_p
= 1;
3703 while (get_next_display_element (it
)
3704 && !newline_found_p
)
3706 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
3707 set_iterator_to_next (it
, 0);
3712 it
->selective
= old_selective
;
3713 return newline_found_p
;
3717 /* Set IT's current position to the previous visible line start. Skip
3718 invisible text that is so either due to text properties or due to
3719 selective display. Caution: this does not change IT->current_x and
3723 back_to_previous_visible_line_start (it
)
3728 /* Go back one newline if not on BEGV already. */
3729 if (IT_CHARPOS (*it
) > BEGV
)
3730 back_to_previous_line_start (it
);
3732 /* Move over lines that are invisible because of selective display
3733 or text properties. */
3734 while (IT_CHARPOS (*it
) > BEGV
3739 /* If selective > 0, then lines indented more than that values
3741 if (it
->selective
> 0
3742 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
3749 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
)),
3750 Qinvisible
, it
->window
);
3751 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
3755 /* Back one more newline if the current one is invisible. */
3757 back_to_previous_line_start (it
);
3760 xassert (IT_CHARPOS (*it
) >= BEGV
);
3761 xassert (IT_CHARPOS (*it
) == BEGV
3762 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
3767 /* Reseat iterator IT at the previous visible line start. Skip
3768 invisible text that is so either due to text properties or due to
3769 selective display. At the end, update IT's overlay information,
3770 face information etc. */
3773 reseat_at_previous_visible_line_start (it
)
3776 back_to_previous_visible_line_start (it
);
3777 reseat (it
, it
->current
.pos
, 1);
3782 /* Reseat iterator IT on the next visible line start in the current
3783 buffer. ON_NEWLINE_P non-zero means position IT on the newline
3784 preceding the line start. Skip over invisible text that is so
3785 because of selective display. Compute faces, overlays etc at the
3786 new position. Note that this function does not skip over text that
3787 is invisible because of text properties. */
3790 reseat_at_next_visible_line_start (it
, on_newline_p
)
3794 int newline_found_p
, skipped_p
= 0;
3796 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
3798 /* Skip over lines that are invisible because they are indented
3799 more than the value of IT->selective. */
3800 if (it
->selective
> 0)
3801 while (IT_CHARPOS (*it
) < ZV
3802 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
3805 xassert (FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
3806 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
3809 /* Position on the newline if that's what's requested. */
3810 if (on_newline_p
&& newline_found_p
)
3812 if (STRINGP (it
->string
))
3814 if (IT_STRING_CHARPOS (*it
) > 0)
3816 --IT_STRING_CHARPOS (*it
);
3817 --IT_STRING_BYTEPOS (*it
);
3820 else if (IT_CHARPOS (*it
) > BEGV
)
3824 reseat (it
, it
->current
.pos
, 0);
3828 reseat (it
, it
->current
.pos
, 0);
3835 /***********************************************************************
3836 Changing an iterator's position
3837 ***********************************************************************/
3839 /* Change IT's current position to POS in current_buffer. If FORCE_P
3840 is non-zero, always check for text properties at the new position.
3841 Otherwise, text properties are only looked up if POS >=
3842 IT->check_charpos of a property. */
3845 reseat (it
, pos
, force_p
)
3847 struct text_pos pos
;
3850 int original_pos
= IT_CHARPOS (*it
);
3852 reseat_1 (it
, pos
, 0);
3854 /* Determine where to check text properties. Avoid doing it
3855 where possible because text property lookup is very expensive. */
3857 || CHARPOS (pos
) > it
->stop_charpos
3858 || CHARPOS (pos
) < original_pos
)
3865 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
3866 IT->stop_pos to POS, also. */
3869 reseat_1 (it
, pos
, set_stop_p
)
3871 struct text_pos pos
;
3874 /* Don't call this function when scanning a C string. */
3875 xassert (it
->s
== NULL
);
3877 /* POS must be a reasonable value. */
3878 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
3880 it
->current
.pos
= it
->position
= pos
;
3881 XSETBUFFER (it
->object
, current_buffer
);
3882 it
->end_charpos
= ZV
;
3884 it
->current
.dpvec_index
= -1;
3885 it
->current
.overlay_string_index
= -1;
3886 IT_STRING_CHARPOS (*it
) = -1;
3887 IT_STRING_BYTEPOS (*it
) = -1;
3889 it
->method
= next_element_from_buffer
;
3891 it
->face_before_selective_p
= 0;
3894 it
->stop_charpos
= CHARPOS (pos
);
3898 /* Set up IT for displaying a string, starting at CHARPOS in window W.
3899 If S is non-null, it is a C string to iterate over. Otherwise,
3900 STRING gives a Lisp string to iterate over.
3902 If PRECISION > 0, don't return more then PRECISION number of
3903 characters from the string.
3905 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
3906 characters have been returned. FIELD_WIDTH < 0 means an infinite
3909 MULTIBYTE = 0 means disable processing of multibyte characters,
3910 MULTIBYTE > 0 means enable it,
3911 MULTIBYTE < 0 means use IT->multibyte_p.
3913 IT must be initialized via a prior call to init_iterator before
3914 calling this function. */
3917 reseat_to_string (it
, s
, string
, charpos
, precision
, field_width
, multibyte
)
3922 int precision
, field_width
, multibyte
;
3924 /* No region in strings. */
3925 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
3927 /* No text property checks performed by default, but see below. */
3928 it
->stop_charpos
= -1;
3930 /* Set iterator position and end position. */
3931 bzero (&it
->current
, sizeof it
->current
);
3932 it
->current
.overlay_string_index
= -1;
3933 it
->current
.dpvec_index
= -1;
3934 xassert (charpos
>= 0);
3936 /* Use the setting of MULTIBYTE if specified. */
3938 it
->multibyte_p
= multibyte
> 0;
3942 xassert (STRINGP (string
));
3943 it
->string
= string
;
3945 it
->end_charpos
= it
->string_nchars
= XSTRING (string
)->size
;
3946 it
->method
= next_element_from_string
;
3947 it
->current
.string_pos
= string_pos (charpos
, string
);
3954 /* Note that we use IT->current.pos, not it->current.string_pos,
3955 for displaying C strings. */
3956 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
3957 if (it
->multibyte_p
)
3959 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
3960 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
3964 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
3965 it
->end_charpos
= it
->string_nchars
= strlen (s
);
3968 it
->method
= next_element_from_c_string
;
3971 /* PRECISION > 0 means don't return more than PRECISION characters
3973 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
3974 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
3976 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
3977 characters have been returned. FIELD_WIDTH == 0 means don't pad,
3978 FIELD_WIDTH < 0 means infinite field width. This is useful for
3979 padding with `-' at the end of a mode line. */
3980 if (field_width
< 0)
3981 field_width
= INFINITY
;
3982 if (field_width
> it
->end_charpos
- charpos
)
3983 it
->end_charpos
= charpos
+ field_width
;
3985 /* Use the standard display table for displaying strings. */
3986 if (DISP_TABLE_P (Vstandard_display_table
))
3987 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
3989 it
->stop_charpos
= charpos
;
3995 /***********************************************************************
3997 ***********************************************************************/
3999 /* Load IT's display element fields with information about the next
4000 display element from the current position of IT. Value is zero if
4001 end of buffer (or C string) is reached. */
4004 get_next_display_element (it
)
4007 /* Non-zero means that we found an display element. Zero means that
4008 we hit the end of what we iterate over. Performance note: the
4009 function pointer `method' used here turns out to be faster than
4010 using a sequence of if-statements. */
4011 int success_p
= (*it
->method
) (it
);
4013 if (it
->what
== IT_CHARACTER
)
4015 /* Map via display table or translate control characters.
4016 IT->c, IT->len etc. have been set to the next character by
4017 the function call above. If we have a display table, and it
4018 contains an entry for IT->c, translate it. Don't do this if
4019 IT->c itself comes from a display table, otherwise we could
4020 end up in an infinite recursion. (An alternative could be to
4021 count the recursion depth of this function and signal an
4022 error when a certain maximum depth is reached.) Is it worth
4024 if (success_p
&& it
->dpvec
== NULL
)
4029 && (dv
= DISP_CHAR_VECTOR (it
->dp
, it
->c
),
4032 struct Lisp_Vector
*v
= XVECTOR (dv
);
4034 /* Return the first character from the display table
4035 entry, if not empty. If empty, don't display the
4036 current character. */
4039 it
->dpvec_char_len
= it
->len
;
4040 it
->dpvec
= v
->contents
;
4041 it
->dpend
= v
->contents
+ v
->size
;
4042 it
->current
.dpvec_index
= 0;
4043 it
->method
= next_element_from_display_vector
;
4044 success_p
= get_next_display_element (it
);
4048 set_iterator_to_next (it
, 0);
4049 success_p
= get_next_display_element (it
);
4053 /* Translate control characters into `\003' or `^C' form.
4054 Control characters coming from a display table entry are
4055 currently not translated because we use IT->dpvec to hold
4056 the translation. This could easily be changed but I
4057 don't believe that it is worth doing.
4059 Non-printable multibyte characters are also translated
4061 else if ((it
->c
< ' '
4062 && (it
->area
!= TEXT_AREA
4063 || (it
->c
!= '\n' && it
->c
!= '\t')))
4066 || !CHAR_PRINTABLE_P (it
->c
))
4068 /* IT->c is a control character which must be displayed
4069 either as '\003' or as `^C' where the '\\' and '^'
4070 can be defined in the display table. Fill
4071 IT->ctl_chars with glyphs for what we have to
4072 display. Then, set IT->dpvec to these glyphs. */
4075 if (it
->c
< 128 && it
->ctl_arrow_p
)
4077 /* Set IT->ctl_chars[0] to the glyph for `^'. */
4079 && INTEGERP (DISP_CTRL_GLYPH (it
->dp
))
4080 && GLYPH_CHAR_VALID_P (XINT (DISP_CTRL_GLYPH (it
->dp
))))
4081 g
= XINT (DISP_CTRL_GLYPH (it
->dp
));
4083 g
= FAST_MAKE_GLYPH ('^', 0);
4084 XSETINT (it
->ctl_chars
[0], g
);
4086 g
= FAST_MAKE_GLYPH (it
->c
^ 0100, 0);
4087 XSETINT (it
->ctl_chars
[1], g
);
4089 /* Set up IT->dpvec and return first character from it. */
4090 it
->dpvec_char_len
= it
->len
;
4091 it
->dpvec
= it
->ctl_chars
;
4092 it
->dpend
= it
->dpvec
+ 2;
4093 it
->current
.dpvec_index
= 0;
4094 it
->method
= next_element_from_display_vector
;
4095 get_next_display_element (it
);
4099 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
4104 /* Set IT->ctl_chars[0] to the glyph for `\\'. */
4106 && INTEGERP (DISP_ESCAPE_GLYPH (it
->dp
))
4107 && GLYPH_CHAR_VALID_P (XFASTINT (DISP_ESCAPE_GLYPH (it
->dp
))))
4108 escape_glyph
= XFASTINT (DISP_ESCAPE_GLYPH (it
->dp
));
4110 escape_glyph
= FAST_MAKE_GLYPH ('\\', 0);
4112 if (SINGLE_BYTE_CHAR_P (it
->c
))
4113 str
[0] = it
->c
, len
= 1;
4115 len
= CHAR_STRING (it
->c
, str
);
4117 for (i
= 0; i
< len
; i
++)
4119 XSETINT (it
->ctl_chars
[i
* 4], escape_glyph
);
4120 /* Insert three more glyphs into IT->ctl_chars for
4121 the octal display of the character. */
4122 g
= FAST_MAKE_GLYPH (((str
[i
] >> 6) & 7) + '0', 0);
4123 XSETINT (it
->ctl_chars
[i
* 4 + 1], g
);
4124 g
= FAST_MAKE_GLYPH (((str
[i
] >> 3) & 7) + '0', 0);
4125 XSETINT (it
->ctl_chars
[i
* 4 + 2], g
);
4126 g
= FAST_MAKE_GLYPH ((str
[i
] & 7) + '0', 0);
4127 XSETINT (it
->ctl_chars
[i
* 4 + 3], g
);
4130 /* Set up IT->dpvec and return the first character
4132 it
->dpvec_char_len
= it
->len
;
4133 it
->dpvec
= it
->ctl_chars
;
4134 it
->dpend
= it
->dpvec
+ len
* 4;
4135 it
->current
.dpvec_index
= 0;
4136 it
->method
= next_element_from_display_vector
;
4137 get_next_display_element (it
);
4142 /* Adjust face id for a multibyte character. There are no
4143 multibyte character in unibyte text. */
4146 && FRAME_WINDOW_P (it
->f
))
4148 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4149 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->c
);
4153 /* Is this character the last one of a run of characters with
4154 box? If yes, set IT->end_of_box_run_p to 1. */
4161 it
->end_of_box_run_p
4162 = ((face_id
= face_after_it_pos (it
),
4163 face_id
!= it
->face_id
)
4164 && (face
= FACE_FROM_ID (it
->f
, face_id
),
4165 face
->box
== FACE_NO_BOX
));
4168 /* Value is 0 if end of buffer or string reached. */
4173 /* Move IT to the next display element.
4175 RESEAT_P non-zero means if called on a newline in buffer text,
4176 skip to the next visible line start.
4178 Functions get_next_display_element and set_iterator_to_next are
4179 separate because I find this arrangement easier to handle than a
4180 get_next_display_element function that also increments IT's
4181 position. The way it is we can first look at an iterator's current
4182 display element, decide whether it fits on a line, and if it does,
4183 increment the iterator position. The other way around we probably
4184 would either need a flag indicating whether the iterator has to be
4185 incremented the next time, or we would have to implement a
4186 decrement position function which would not be easy to write. */
4189 set_iterator_to_next (it
, reseat_p
)
4193 /* Reset flags indicating start and end of a sequence of characters
4194 with box. Reset them at the start of this function because
4195 moving the iterator to a new position might set them. */
4196 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
4198 if (it
->method
== next_element_from_buffer
)
4200 /* The current display element of IT is a character from
4201 current_buffer. Advance in the buffer, and maybe skip over
4202 invisible lines that are so because of selective display. */
4203 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
4204 reseat_at_next_visible_line_start (it
, 0);
4207 xassert (it
->len
!= 0);
4208 IT_BYTEPOS (*it
) += it
->len
;
4209 IT_CHARPOS (*it
) += 1;
4210 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
4213 else if (it
->method
== next_element_from_composition
)
4215 xassert (it
->cmp_id
>= 0 && it
->cmp_id
< n_compositions
);
4216 if (STRINGP (it
->string
))
4218 IT_STRING_BYTEPOS (*it
) += it
->len
;
4219 IT_STRING_CHARPOS (*it
) += it
->cmp_len
;
4220 it
->method
= next_element_from_string
;
4221 goto consider_string_end
;
4225 IT_BYTEPOS (*it
) += it
->len
;
4226 IT_CHARPOS (*it
) += it
->cmp_len
;
4227 it
->method
= next_element_from_buffer
;
4230 else if (it
->method
== next_element_from_c_string
)
4232 /* Current display element of IT is from a C string. */
4233 IT_BYTEPOS (*it
) += it
->len
;
4234 IT_CHARPOS (*it
) += 1;
4236 else if (it
->method
== next_element_from_display_vector
)
4238 /* Current display element of IT is from a display table entry.
4239 Advance in the display table definition. Reset it to null if
4240 end reached, and continue with characters from buffers/
4242 ++it
->current
.dpvec_index
;
4244 /* Restore face of the iterator to what they were before the
4245 display vector entry (these entries may contain faces). */
4246 it
->face_id
= it
->saved_face_id
;
4248 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
4251 it
->method
= next_element_from_c_string
;
4252 else if (STRINGP (it
->string
))
4253 it
->method
= next_element_from_string
;
4255 it
->method
= next_element_from_buffer
;
4258 it
->current
.dpvec_index
= -1;
4260 /* Skip over characters which were displayed via IT->dpvec. */
4261 if (it
->dpvec_char_len
< 0)
4262 reseat_at_next_visible_line_start (it
, 1);
4263 else if (it
->dpvec_char_len
> 0)
4265 it
->len
= it
->dpvec_char_len
;
4266 set_iterator_to_next (it
, reseat_p
);
4270 else if (it
->method
== next_element_from_string
)
4272 /* Current display element is a character from a Lisp string. */
4273 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
4274 IT_STRING_BYTEPOS (*it
) += it
->len
;
4275 IT_STRING_CHARPOS (*it
) += 1;
4277 consider_string_end
:
4279 if (it
->current
.overlay_string_index
>= 0)
4281 /* IT->string is an overlay string. Advance to the
4282 next, if there is one. */
4283 if (IT_STRING_CHARPOS (*it
) >= XSTRING (it
->string
)->size
)
4284 next_overlay_string (it
);
4288 /* IT->string is not an overlay string. If we reached
4289 its end, and there is something on IT->stack, proceed
4290 with what is on the stack. This can be either another
4291 string, this time an overlay string, or a buffer. */
4292 if (IT_STRING_CHARPOS (*it
) == XSTRING (it
->string
)->size
4296 if (!STRINGP (it
->string
))
4297 it
->method
= next_element_from_buffer
;
4301 else if (it
->method
== next_element_from_image
4302 || it
->method
== next_element_from_stretch
)
4304 /* The position etc with which we have to proceed are on
4305 the stack. The position may be at the end of a string,
4306 if the `display' property takes up the whole string. */
4309 if (STRINGP (it
->string
))
4311 it
->method
= next_element_from_string
;
4312 goto consider_string_end
;
4315 it
->method
= next_element_from_buffer
;
4318 /* There are no other methods defined, so this should be a bug. */
4321 xassert (it
->method
!= next_element_from_string
4322 || (STRINGP (it
->string
)
4323 && IT_STRING_CHARPOS (*it
) >= 0));
4327 /* Load IT's display element fields with information about the next
4328 display element which comes from a display table entry or from the
4329 result of translating a control character to one of the forms `^C'
4330 or `\003'. IT->dpvec holds the glyphs to return as characters. */
4333 next_element_from_display_vector (it
)
4337 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
4339 /* Remember the current face id in case glyphs specify faces.
4340 IT's face is restored in set_iterator_to_next. */
4341 it
->saved_face_id
= it
->face_id
;
4343 if (INTEGERP (*it
->dpvec
)
4344 && GLYPH_CHAR_VALID_P (XFASTINT (*it
->dpvec
)))
4349 g
= XFASTINT (it
->dpvec
[it
->current
.dpvec_index
]);
4350 it
->c
= FAST_GLYPH_CHAR (g
);
4351 it
->len
= CHAR_BYTES (it
->c
);
4353 /* The entry may contain a face id to use. Such a face id is
4354 the id of a Lisp face, not a realized face. A face id of
4355 zero means no face is specified. */
4356 lface_id
= FAST_GLYPH_FACE (g
);
4359 /* The function returns -1 if lface_id is invalid. */
4360 int face_id
= ascii_face_of_lisp_face (it
->f
, lface_id
);
4362 it
->face_id
= face_id
;
4366 /* Display table entry is invalid. Return a space. */
4367 it
->c
= ' ', it
->len
= 1;
4369 /* Don't change position and object of the iterator here. They are
4370 still the values of the character that had this display table
4371 entry or was translated, and that's what we want. */
4372 it
->what
= IT_CHARACTER
;
4377 /* Load IT with the next display element from Lisp string IT->string.
4378 IT->current.string_pos is the current position within the string.
4379 If IT->current.overlay_string_index >= 0, the Lisp string is an
4383 next_element_from_string (it
)
4386 struct text_pos position
;
4388 xassert (STRINGP (it
->string
));
4389 xassert (IT_STRING_CHARPOS (*it
) >= 0);
4390 position
= it
->current
.string_pos
;
4392 /* Time to check for invisible text? */
4393 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
4394 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
4398 /* Since a handler may have changed IT->method, we must
4400 return get_next_display_element (it
);
4403 if (it
->current
.overlay_string_index
>= 0)
4405 /* Get the next character from an overlay string. In overlay
4406 strings, There is no field width or padding with spaces to
4408 if (IT_STRING_CHARPOS (*it
) >= XSTRING (it
->string
)->size
)
4413 else if (STRING_MULTIBYTE (it
->string
))
4415 int remaining
= (STRING_BYTES (XSTRING (it
->string
))
4416 - IT_STRING_BYTEPOS (*it
));
4417 unsigned char *s
= (XSTRING (it
->string
)->data
4418 + IT_STRING_BYTEPOS (*it
));
4419 it
->c
= string_char_and_length (s
, remaining
, &it
->len
);
4423 it
->c
= XSTRING (it
->string
)->data
[IT_STRING_BYTEPOS (*it
)];
4429 /* Get the next character from a Lisp string that is not an
4430 overlay string. Such strings come from the mode line, for
4431 example. We may have to pad with spaces, or truncate the
4432 string. See also next_element_from_c_string. */
4433 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
4438 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
4440 /* Pad with spaces. */
4441 it
->c
= ' ', it
->len
= 1;
4442 CHARPOS (position
) = BYTEPOS (position
) = -1;
4444 else if (STRING_MULTIBYTE (it
->string
))
4446 int maxlen
= (STRING_BYTES (XSTRING (it
->string
))
4447 - IT_STRING_BYTEPOS (*it
));
4448 unsigned char *s
= (XSTRING (it
->string
)->data
4449 + IT_STRING_BYTEPOS (*it
));
4450 it
->c
= string_char_and_length (s
, maxlen
, &it
->len
);
4454 it
->c
= XSTRING (it
->string
)->data
[IT_STRING_BYTEPOS (*it
)];
4459 /* Record what we have and where it came from. Note that we store a
4460 buffer position in IT->position although it could arguably be a
4462 it
->what
= IT_CHARACTER
;
4463 it
->object
= it
->string
;
4464 it
->position
= position
;
4469 /* Load IT with next display element from C string IT->s.
4470 IT->string_nchars is the maximum number of characters to return
4471 from the string. IT->end_charpos may be greater than
4472 IT->string_nchars when this function is called, in which case we
4473 may have to return padding spaces. Value is zero if end of string
4474 reached, including padding spaces. */
4477 next_element_from_c_string (it
)
4483 it
->what
= IT_CHARACTER
;
4484 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
4487 /* IT's position can be greater IT->string_nchars in case a field
4488 width or precision has been specified when the iterator was
4490 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
4492 /* End of the game. */
4496 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
4498 /* Pad with spaces. */
4499 it
->c
= ' ', it
->len
= 1;
4500 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
4502 else if (it
->multibyte_p
)
4504 /* Implementation note: The calls to strlen apparently aren't a
4505 performance problem because there is no noticeable performance
4506 difference between Emacs running in unibyte or multibyte mode. */
4507 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
4508 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
),
4512 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
4518 /* Set up IT to return characters from an ellipsis, if appropriate.
4519 The definition of the ellipsis glyphs may come from a display table
4520 entry. This function Fills IT with the first glyph from the
4521 ellipsis if an ellipsis is to be displayed. */
4524 next_element_from_ellipsis (it
)
4527 if (it
->selective_display_ellipsis_p
)
4529 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4531 /* Use the display table definition for `...'. Invalid glyphs
4532 will be handled by the method returning elements from dpvec. */
4533 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4534 it
->dpvec_char_len
= it
->len
;
4535 it
->dpvec
= v
->contents
;
4536 it
->dpend
= v
->contents
+ v
->size
;
4537 it
->current
.dpvec_index
= 0;
4538 it
->method
= next_element_from_display_vector
;
4542 /* Use default `...' which is stored in default_invis_vector. */
4543 it
->dpvec_char_len
= it
->len
;
4544 it
->dpvec
= default_invis_vector
;
4545 it
->dpend
= default_invis_vector
+ 3;
4546 it
->current
.dpvec_index
= 0;
4547 it
->method
= next_element_from_display_vector
;
4552 /* The face at the current position may be different from the
4553 face we find after the invisible text. Remember what it
4554 was in IT->saved_face_id, and signal that it's there by
4555 setting face_before_selective_p. */
4556 it
->saved_face_id
= it
->face_id
;
4557 it
->method
= next_element_from_buffer
;
4558 reseat_at_next_visible_line_start (it
, 1);
4559 it
->face_before_selective_p
= 1;
4562 return get_next_display_element (it
);
4566 /* Deliver an image display element. The iterator IT is already
4567 filled with image information (done in handle_display_prop). Value
4572 next_element_from_image (it
)
4575 it
->what
= IT_IMAGE
;
4580 /* Fill iterator IT with next display element from a stretch glyph
4581 property. IT->object is the value of the text property. Value is
4585 next_element_from_stretch (it
)
4588 it
->what
= IT_STRETCH
;
4593 /* Load IT with the next display element from current_buffer. Value
4594 is zero if end of buffer reached. IT->stop_charpos is the next
4595 position at which to stop and check for text properties or buffer
4599 next_element_from_buffer (it
)
4604 /* Check this assumption, otherwise, we would never enter the
4605 if-statement, below. */
4606 xassert (IT_CHARPOS (*it
) >= BEGV
4607 && IT_CHARPOS (*it
) <= it
->stop_charpos
);
4609 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
4611 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
4613 int overlay_strings_follow_p
;
4615 /* End of the game, except when overlay strings follow that
4616 haven't been returned yet. */
4617 if (it
->overlay_strings_at_end_processed_p
)
4618 overlay_strings_follow_p
= 0;
4621 it
->overlay_strings_at_end_processed_p
= 1;
4622 overlay_strings_follow_p
= get_overlay_strings (it
);
4625 if (overlay_strings_follow_p
)
4626 success_p
= get_next_display_element (it
);
4630 it
->position
= it
->current
.pos
;
4637 return get_next_display_element (it
);
4642 /* No face changes, overlays etc. in sight, so just return a
4643 character from current_buffer. */
4646 /* Maybe run the redisplay end trigger hook. Performance note:
4647 This doesn't seem to cost measurable time. */
4648 if (it
->redisplay_end_trigger_charpos
4650 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
4651 run_redisplay_end_trigger_hook (it
);
4653 /* Get the next character, maybe multibyte. */
4654 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
4655 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
4657 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT_BYTE
? ZV_BYTE
: GPT_BYTE
)
4658 - IT_BYTEPOS (*it
));
4659 it
->c
= string_char_and_length (p
, maxlen
, &it
->len
);
4662 it
->c
= *p
, it
->len
= 1;
4664 /* Record what we have and where it came from. */
4665 it
->what
= IT_CHARACTER
;;
4666 it
->object
= it
->w
->buffer
;
4667 it
->position
= it
->current
.pos
;
4669 /* Normally we return the character found above, except when we
4670 really want to return an ellipsis for selective display. */
4675 /* A value of selective > 0 means hide lines indented more
4676 than that number of columns. */
4677 if (it
->selective
> 0
4678 && IT_CHARPOS (*it
) + 1 < ZV
4679 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
4680 IT_BYTEPOS (*it
) + 1,
4683 success_p
= next_element_from_ellipsis (it
);
4684 it
->dpvec_char_len
= -1;
4687 else if (it
->c
== '\r' && it
->selective
== -1)
4689 /* A value of selective == -1 means that everything from the
4690 CR to the end of the line is invisible, with maybe an
4691 ellipsis displayed for it. */
4692 success_p
= next_element_from_ellipsis (it
);
4693 it
->dpvec_char_len
= -1;
4698 /* Value is zero if end of buffer reached. */
4699 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
4704 /* Run the redisplay end trigger hook for IT. */
4707 run_redisplay_end_trigger_hook (it
)
4710 Lisp_Object args
[3];
4712 /* IT->glyph_row should be non-null, i.e. we should be actually
4713 displaying something, or otherwise we should not run the hook. */
4714 xassert (it
->glyph_row
);
4716 /* Set up hook arguments. */
4717 args
[0] = Qredisplay_end_trigger_functions
;
4718 args
[1] = it
->window
;
4719 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
4720 it
->redisplay_end_trigger_charpos
= 0;
4722 /* Since we are *trying* to run these functions, don't try to run
4723 them again, even if they get an error. */
4724 it
->w
->redisplay_end_trigger
= Qnil
;
4725 Frun_hook_with_args (3, args
);
4727 /* Notice if it changed the face of the character we are on. */
4728 handle_face_prop (it
);
4732 /* Deliver a composition display element. The iterator IT is already
4733 filled with composition information (done in
4734 handle_composition_prop). Value is always 1. */
4737 next_element_from_composition (it
)
4740 it
->what
= IT_COMPOSITION
;
4741 it
->position
= (STRINGP (it
->string
)
4742 ? it
->current
.string_pos
4749 /***********************************************************************
4750 Moving an iterator without producing glyphs
4751 ***********************************************************************/
4753 /* Move iterator IT to a specified buffer or X position within one
4754 line on the display without producing glyphs.
4756 Begin to skip at IT's current position. Skip to TO_CHARPOS or TO_X
4757 whichever is reached first.
4759 TO_CHARPOS <= 0 means no TO_CHARPOS is specified.
4761 TO_X < 0 means that no TO_X is specified. TO_X is normally a value
4762 0 <= TO_X <= IT->last_visible_x. This means in particular, that
4763 TO_X includes the amount by which a window is horizontally
4768 MOVE_POS_MATCH_OR_ZV
4769 - when TO_POS or ZV was reached.
4772 -when TO_X was reached before TO_POS or ZV were reached.
4775 - when we reached the end of the display area and the line must
4779 - when we reached the end of the display area and the line is
4783 - when we stopped at a line end, i.e. a newline or a CR and selective
4786 static enum move_it_result
4787 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
)
4789 int to_charpos
, to_x
, op
;
4791 enum move_it_result result
= MOVE_UNDEFINED
;
4792 struct glyph_row
*saved_glyph_row
;
4794 /* Don't produce glyphs in produce_glyphs. */
4795 saved_glyph_row
= it
->glyph_row
;
4796 it
->glyph_row
= NULL
;
4800 int x
, i
, ascent
= 0, descent
= 0;
4802 /* Stop when ZV or TO_CHARPOS reached. */
4803 if (!get_next_display_element (it
)
4804 || ((op
& MOVE_TO_POS
) != 0
4805 && BUFFERP (it
->object
)
4806 && IT_CHARPOS (*it
) >= to_charpos
))
4808 result
= MOVE_POS_MATCH_OR_ZV
;
4812 /* The call to produce_glyphs will get the metrics of the
4813 display element IT is loaded with. We record in x the
4814 x-position before this display element in case it does not
4818 /* Remember the line height so far in case the next element doesn't
4820 if (!it
->truncate_lines_p
)
4822 ascent
= it
->max_ascent
;
4823 descent
= it
->max_descent
;
4826 PRODUCE_GLYPHS (it
);
4828 if (it
->area
!= TEXT_AREA
)
4830 set_iterator_to_next (it
, 1);
4834 /* The number of glyphs we get back in IT->nglyphs will normally
4835 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
4836 character on a terminal frame, or (iii) a line end. For the
4837 second case, IT->nglyphs - 1 padding glyphs will be present
4838 (on X frames, there is only one glyph produced for a
4839 composite character.
4841 The behavior implemented below means, for continuation lines,
4842 that as many spaces of a TAB as fit on the current line are
4843 displayed there. For terminal frames, as many glyphs of a
4844 multi-glyph character are displayed in the current line, too.
4845 This is what the old redisplay code did, and we keep it that
4846 way. Under X, the whole shape of a complex character must
4847 fit on the line or it will be completely displayed in the
4850 Note that both for tabs and padding glyphs, all glyphs have
4854 /* More than one glyph or glyph doesn't fit on line. All
4855 glyphs have the same width. */
4856 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
4859 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
4861 new_x
= x
+ single_glyph_width
;
4863 /* We want to leave anything reaching TO_X to the caller. */
4864 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
4867 result
= MOVE_X_REACHED
;
4870 else if (/* Lines are continued. */
4871 !it
->truncate_lines_p
4872 && (/* And glyph doesn't fit on the line. */
4873 new_x
> it
->last_visible_x
4874 /* Or it fits exactly and we're on a window
4876 || (new_x
== it
->last_visible_x
4877 && FRAME_WINDOW_P (it
->f
))))
4879 if (/* IT->hpos == 0 means the very first glyph
4880 doesn't fit on the line, e.g. a wide image. */
4882 || (new_x
== it
->last_visible_x
4883 && FRAME_WINDOW_P (it
->f
)))
4886 it
->current_x
= new_x
;
4887 if (i
== it
->nglyphs
- 1)
4888 set_iterator_to_next (it
, 1);
4893 it
->max_ascent
= ascent
;
4894 it
->max_descent
= descent
;
4897 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
4899 result
= MOVE_LINE_CONTINUED
;
4902 else if (new_x
> it
->first_visible_x
)
4904 /* Glyph is visible. Increment number of glyphs that
4905 would be displayed. */
4910 /* Glyph is completely off the left margin of the display
4911 area. Nothing to do. */
4915 if (result
!= MOVE_UNDEFINED
)
4918 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
4920 /* Stop when TO_X specified and reached. This check is
4921 necessary here because of lines consisting of a line end,
4922 only. The line end will not produce any glyphs and we
4923 would never get MOVE_X_REACHED. */
4924 xassert (it
->nglyphs
== 0);
4925 result
= MOVE_X_REACHED
;
4929 /* Is this a line end? If yes, we're done. */
4930 if (ITERATOR_AT_END_OF_LINE_P (it
))
4932 result
= MOVE_NEWLINE_OR_CR
;
4936 /* The current display element has been consumed. Advance
4938 set_iterator_to_next (it
, 1);
4940 /* Stop if lines are truncated and IT's current x-position is
4941 past the right edge of the window now. */
4942 if (it
->truncate_lines_p
4943 && it
->current_x
>= it
->last_visible_x
)
4945 result
= MOVE_LINE_TRUNCATED
;
4950 /* Restore the iterator settings altered at the beginning of this
4952 it
->glyph_row
= saved_glyph_row
;
4957 /* Move IT forward to a specified buffer position TO_CHARPOS, TO_X,
4958 TO_Y, TO_VPOS. OP is a bit-mask that specifies where to stop. See
4959 the description of enum move_operation_enum.
4961 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
4962 screen line, this function will set IT to the next position >
4966 move_it_to (it
, to_charpos
, to_x
, to_y
, to_vpos
, op
)
4968 int to_charpos
, to_x
, to_y
, to_vpos
;
4971 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
4977 if (op
& MOVE_TO_VPOS
)
4979 /* If no TO_CHARPOS and no TO_X specified, stop at the
4980 start of the line TO_VPOS. */
4981 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
4983 if (it
->vpos
== to_vpos
)
4989 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
4993 /* TO_VPOS >= 0 means stop at TO_X in the line at
4994 TO_VPOS, or at TO_POS, whichever comes first. */
4995 if (it
->vpos
== to_vpos
)
5001 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
5003 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
5008 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
5010 /* We have reached TO_X but not in the line we want. */
5011 skip
= move_it_in_display_line_to (it
, to_charpos
,
5013 if (skip
== MOVE_POS_MATCH_OR_ZV
)
5021 else if (op
& MOVE_TO_Y
)
5023 struct it it_backup
;
5025 /* TO_Y specified means stop at TO_X in the line containing
5026 TO_Y---or at TO_CHARPOS if this is reached first. The
5027 problem is that we can't really tell whether the line
5028 contains TO_Y before we have completely scanned it, and
5029 this may skip past TO_X. What we do is to first scan to
5032 If TO_X is not specified, use a TO_X of zero. The reason
5033 is to make the outcome of this function more predictable.
5034 If we didn't use TO_X == 0, we would stop at the end of
5035 the line which is probably not what a caller would expect
5037 skip
= move_it_in_display_line_to (it
, to_charpos
,
5041 | (op
& MOVE_TO_POS
)));
5043 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
5044 if (skip
== MOVE_POS_MATCH_OR_ZV
)
5050 /* If TO_X was reached, we would like to know whether TO_Y
5051 is in the line. This can only be said if we know the
5052 total line height which requires us to scan the rest of
5054 if (skip
== MOVE_X_REACHED
)
5057 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
5058 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
5060 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
5063 /* Now, decide whether TO_Y is in this line. */
5064 line_height
= it
->max_ascent
+ it
->max_descent
;
5065 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
5067 if (to_y
>= it
->current_y
5068 && to_y
< it
->current_y
+ line_height
)
5070 if (skip
== MOVE_X_REACHED
)
5071 /* If TO_Y is in this line and TO_X was reached above,
5072 we scanned too far. We have to restore IT's settings
5073 to the ones before skipping. */
5077 else if (skip
== MOVE_X_REACHED
)
5080 if (skip
== MOVE_POS_MATCH_OR_ZV
)
5088 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
5092 case MOVE_POS_MATCH_OR_ZV
:
5096 case MOVE_NEWLINE_OR_CR
:
5097 set_iterator_to_next (it
, 1);
5098 it
->continuation_lines_width
= 0;
5101 case MOVE_LINE_TRUNCATED
:
5102 it
->continuation_lines_width
= 0;
5103 reseat_at_next_visible_line_start (it
, 0);
5104 if ((op
& MOVE_TO_POS
) != 0
5105 && IT_CHARPOS (*it
) > to_charpos
)
5112 case MOVE_LINE_CONTINUED
:
5113 it
->continuation_lines_width
+= it
->current_x
;
5120 /* Reset/increment for the next run. */
5121 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
5122 it
->current_x
= it
->hpos
= 0;
5123 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
5125 last_height
= it
->max_ascent
+ it
->max_descent
;
5126 last_max_ascent
= it
->max_ascent
;
5127 it
->max_ascent
= it
->max_descent
= 0;
5132 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
5136 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
5138 If DY > 0, move IT backward at least that many pixels. DY = 0
5139 means move IT backward to the preceding line start or BEGV. This
5140 function may move over more than DY pixels if IT->current_y - DY
5141 ends up in the middle of a line; in this case IT->current_y will be
5142 set to the top of the line moved to. */
5145 move_it_vertically_backward (it
, dy
)
5149 int nlines
, h
, line_height
;
5151 int start_pos
= IT_CHARPOS (*it
);
5155 /* Estimate how many newlines we must move back. */
5156 nlines
= max (1, dy
/ CANON_Y_UNIT (it
->f
));
5158 /* Set the iterator's position that many lines back. */
5159 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
5160 back_to_previous_visible_line_start (it
);
5162 /* Reseat the iterator here. When moving backward, we don't want
5163 reseat to skip forward over invisible text, set up the iterator
5164 to deliver from overlay strings at the new position etc. So,
5165 use reseat_1 here. */
5166 reseat_1 (it
, it
->current
.pos
, 1);
5168 /* We are now surely at a line start. */
5169 it
->current_x
= it
->hpos
= 0;
5171 /* Move forward and see what y-distance we moved. First move to the
5172 start of the next line so that we get its height. We need this
5173 height to be able to tell whether we reached the specified
5176 it2
.max_ascent
= it2
.max_descent
= 0;
5177 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
5178 MOVE_TO_POS
| MOVE_TO_VPOS
);
5179 xassert (IT_CHARPOS (*it
) >= BEGV
);
5180 line_height
= it2
.max_ascent
+ it2
.max_descent
;
5182 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
5183 xassert (IT_CHARPOS (*it
) >= BEGV
);
5184 h
= it2
.current_y
- it
->current_y
;
5185 nlines
= it2
.vpos
- it
->vpos
;
5187 /* Correct IT's y and vpos position. */
5193 /* DY == 0 means move to the start of the screen line. The
5194 value of nlines is > 0 if continuation lines were involved. */
5196 move_it_by_lines (it
, nlines
, 1);
5197 xassert (IT_CHARPOS (*it
) <= start_pos
);
5201 /* The y-position we try to reach. Note that h has been
5202 subtracted in front of the if-statement. */
5203 int target_y
= it
->current_y
+ h
- dy
;
5205 /* If we did not reach target_y, try to move further backward if
5206 we can. If we moved too far backward, try to move forward. */
5207 if (target_y
< it
->current_y
5208 && IT_CHARPOS (*it
) > BEGV
)
5210 move_it_vertically (it
, target_y
- it
->current_y
);
5211 xassert (IT_CHARPOS (*it
) >= BEGV
);
5213 else if (target_y
>= it
->current_y
+ line_height
5214 && IT_CHARPOS (*it
) < ZV
)
5216 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
5217 xassert (IT_CHARPOS (*it
) >= BEGV
);
5223 /* Move IT by a specified amount of pixel lines DY. DY negative means
5224 move backwards. DY = 0 means move to start of screen line. At the
5225 end, IT will be on the start of a screen line. */
5228 move_it_vertically (it
, dy
)
5233 move_it_vertically_backward (it
, -dy
);
5236 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
5237 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
5238 MOVE_TO_POS
| MOVE_TO_Y
);
5239 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
5241 /* If buffer ends in ZV without a newline, move to the start of
5242 the line to satisfy the post-condition. */
5243 if (IT_CHARPOS (*it
) == ZV
5244 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
5245 move_it_by_lines (it
, 0, 0);
5250 /* Move iterator IT past the end of the text line it is in. */
5253 move_it_past_eol (it
)
5256 enum move_it_result rc
;
5258 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
5259 if (rc
== MOVE_NEWLINE_OR_CR
)
5260 set_iterator_to_next (it
, 0);
5264 #if 0 /* Currently not used. */
5266 /* Return non-zero if some text between buffer positions START_CHARPOS
5267 and END_CHARPOS is invisible. IT->window is the window for text
5271 invisible_text_between_p (it
, start_charpos
, end_charpos
)
5273 int start_charpos
, end_charpos
;
5275 Lisp_Object prop
, limit
;
5276 int invisible_found_p
;
5278 xassert (it
!= NULL
&& start_charpos
<= end_charpos
);
5280 /* Is text at START invisible? */
5281 prop
= Fget_char_property (make_number (start_charpos
), Qinvisible
,
5283 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5284 invisible_found_p
= 1;
5287 limit
= Fnext_single_char_property_change (make_number (start_charpos
),
5289 make_number (end_charpos
));
5290 invisible_found_p
= XFASTINT (limit
) < end_charpos
;
5293 return invisible_found_p
;
5299 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
5300 negative means move up. DVPOS == 0 means move to the start of the
5301 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
5302 NEED_Y_P is zero, IT->current_y will be left unchanged.
5304 Further optimization ideas: If we would know that IT->f doesn't use
5305 a face with proportional font, we could be faster for
5306 truncate-lines nil. */
5309 move_it_by_lines (it
, dvpos
, need_y_p
)
5311 int dvpos
, need_y_p
;
5313 struct position pos
;
5315 if (!FRAME_WINDOW_P (it
->f
))
5317 struct text_pos textpos
;
5319 /* We can use vmotion on frames without proportional fonts. */
5320 pos
= *vmotion (IT_CHARPOS (*it
), dvpos
, it
->w
);
5321 SET_TEXT_POS (textpos
, pos
.bufpos
, pos
.bytepos
);
5322 reseat (it
, textpos
, 1);
5323 it
->vpos
+= pos
.vpos
;
5324 it
->current_y
+= pos
.vpos
;
5326 else if (dvpos
== 0)
5328 /* DVPOS == 0 means move to the start of the screen line. */
5329 move_it_vertically_backward (it
, 0);
5330 xassert (it
->current_x
== 0 && it
->hpos
== 0);
5333 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
5337 int start_charpos
, i
;
5339 /* Go back -DVPOS visible lines and reseat the iterator there. */
5340 start_charpos
= IT_CHARPOS (*it
);
5341 for (i
= -dvpos
; i
&& IT_CHARPOS (*it
) > BEGV
; --i
)
5342 back_to_previous_visible_line_start (it
);
5343 reseat (it
, it
->current
.pos
, 1);
5344 it
->current_x
= it
->hpos
= 0;
5346 /* Above call may have moved too far if continuation lines
5347 are involved. Scan forward and see if it did. */
5349 it2
.vpos
= it2
.current_y
= 0;
5350 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
5351 it
->vpos
-= it2
.vpos
;
5352 it
->current_y
-= it2
.current_y
;
5353 it
->current_x
= it
->hpos
= 0;
5355 /* If we moved too far, move IT some lines forward. */
5356 if (it2
.vpos
> -dvpos
)
5358 int delta
= it2
.vpos
+ dvpos
;
5359 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
5366 /***********************************************************************
5368 ***********************************************************************/
5371 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
5375 add_to_log (format
, arg1
, arg2
)
5377 Lisp_Object arg1
, arg2
;
5379 Lisp_Object args
[3];
5380 Lisp_Object msg
, fmt
;
5383 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
5386 GCPRO4 (fmt
, msg
, arg1
, arg2
);
5388 args
[0] = fmt
= build_string (format
);
5391 msg
= Fformat (3, args
);
5393 len
= STRING_BYTES (XSTRING (msg
)) + 1;
5394 buffer
= (char *) alloca (len
);
5395 strcpy (buffer
, XSTRING (msg
)->data
);
5397 message_dolog (buffer
, len
- 1, 1, 0);
5402 /* Output a newline in the *Messages* buffer if "needs" one. */
5405 message_log_maybe_newline ()
5407 if (message_log_need_newline
)
5408 message_dolog ("", 0, 1, 0);
5412 /* Add a string M of length NBYTES to the message log, optionally
5413 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
5414 nonzero, means interpret the contents of M as multibyte. This
5415 function calls low-level routines in order to bypass text property
5416 hooks, etc. which might not be safe to run. */
5419 message_dolog (m
, nbytes
, nlflag
, multibyte
)
5421 int nbytes
, nlflag
, multibyte
;
5423 if (!NILP (Vmessage_log_max
))
5425 struct buffer
*oldbuf
;
5426 Lisp_Object oldpoint
, oldbegv
, oldzv
;
5427 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
5428 int point_at_end
= 0;
5430 Lisp_Object old_deactivate_mark
, tem
;
5431 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
5433 old_deactivate_mark
= Vdeactivate_mark
;
5434 oldbuf
= current_buffer
;
5435 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
5436 current_buffer
->undo_list
= Qt
;
5438 oldpoint
= Fpoint_marker ();
5439 oldbegv
= Fpoint_min_marker ();
5440 oldzv
= Fpoint_max_marker ();
5441 GCPRO4 (oldpoint
, oldbegv
, oldzv
, old_deactivate_mark
);
5449 BEGV_BYTE
= BEG_BYTE
;
5452 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
5454 /* Insert the string--maybe converting multibyte to single byte
5455 or vice versa, so that all the text fits the buffer. */
5457 && NILP (current_buffer
->enable_multibyte_characters
))
5459 int i
, c
, char_bytes
;
5460 unsigned char work
[1];
5462 /* Convert a multibyte string to single-byte
5463 for the *Message* buffer. */
5464 for (i
= 0; i
< nbytes
; i
+= nbytes
)
5466 c
= string_char_and_length (m
+ i
, nbytes
- i
, &char_bytes
);
5467 work
[0] = (SINGLE_BYTE_CHAR_P (c
)
5469 : multibyte_char_to_unibyte (c
, Qnil
));
5470 insert_1_both (work
, 1, 1, 1, 0, 0);
5473 else if (! multibyte
5474 && ! NILP (current_buffer
->enable_multibyte_characters
))
5476 int i
, c
, char_bytes
;
5477 unsigned char *msg
= (unsigned char *) m
;
5478 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
5479 /* Convert a single-byte string to multibyte
5480 for the *Message* buffer. */
5481 for (i
= 0; i
< nbytes
; i
++)
5483 c
= unibyte_char_to_multibyte (msg
[i
]);
5484 char_bytes
= CHAR_STRING (c
, str
);
5485 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
5489 insert_1 (m
, nbytes
, 1, 0, 0);
5493 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
5494 insert_1 ("\n", 1, 1, 0, 0);
5496 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
5498 this_bol_byte
= PT_BYTE
;
5502 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
5504 prev_bol_byte
= PT_BYTE
;
5506 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
5507 this_bol
, this_bol_byte
);
5510 del_range_both (prev_bol
, prev_bol_byte
,
5511 this_bol
, this_bol_byte
, 0);
5517 /* If you change this format, don't forget to also
5518 change message_log_check_duplicate. */
5519 sprintf (dupstr
, " [%d times]", dup
);
5520 duplen
= strlen (dupstr
);
5521 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
5522 insert_1 (dupstr
, duplen
, 1, 0, 1);
5527 if (NATNUMP (Vmessage_log_max
))
5529 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
5530 -XFASTINT (Vmessage_log_max
) - 1, 0);
5531 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
5534 BEGV
= XMARKER (oldbegv
)->charpos
;
5535 BEGV_BYTE
= marker_byte_position (oldbegv
);
5544 ZV
= XMARKER (oldzv
)->charpos
;
5545 ZV_BYTE
= marker_byte_position (oldzv
);
5549 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
5551 /* We can't do Fgoto_char (oldpoint) because it will run some
5553 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
5554 XMARKER (oldpoint
)->bytepos
);
5557 free_marker (oldpoint
);
5558 free_marker (oldbegv
);
5559 free_marker (oldzv
);
5561 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
5562 set_buffer_internal (oldbuf
);
5564 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
5565 message_log_need_newline
= !nlflag
;
5566 Vdeactivate_mark
= old_deactivate_mark
;
5571 /* We are at the end of the buffer after just having inserted a newline.
5572 (Note: We depend on the fact we won't be crossing the gap.)
5573 Check to see if the most recent message looks a lot like the previous one.
5574 Return 0 if different, 1 if the new one should just replace it, or a
5575 value N > 1 if we should also append " [N times]". */
5578 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
5579 int prev_bol
, this_bol
;
5580 int prev_bol_byte
, this_bol_byte
;
5583 int len
= Z_BYTE
- 1 - this_bol_byte
;
5585 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
5586 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
5588 for (i
= 0; i
< len
; i
++)
5590 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
5598 if (*p1
++ == ' ' && *p1
++ == '[')
5601 while (*p1
>= '0' && *p1
<= '9')
5602 n
= n
* 10 + *p1
++ - '0';
5603 if (strncmp (p1
, " times]\n", 8) == 0)
5610 /* Display an echo area message M with a specified length of NBYTES
5611 bytes. The string may include null characters. If M is 0, clear
5612 out any existing message, and let the mini-buffer text show
5615 The buffer M must continue to exist until after the echo area gets
5616 cleared or some other message gets displayed there. This means do
5617 not pass text that is stored in a Lisp string; do not pass text in
5618 a buffer that was alloca'd. */
5621 message2 (m
, nbytes
, multibyte
)
5626 /* First flush out any partial line written with print. */
5627 message_log_maybe_newline ();
5629 message_dolog (m
, nbytes
, 1, multibyte
);
5630 message2_nolog (m
, nbytes
, multibyte
);
5634 /* The non-logging counterpart of message2. */
5637 message2_nolog (m
, nbytes
, multibyte
)
5641 struct frame
*sf
= SELECTED_FRAME ();
5642 message_enable_multibyte
= multibyte
;
5646 if (noninteractive_need_newline
)
5647 putc ('\n', stderr
);
5648 noninteractive_need_newline
= 0;
5650 fwrite (m
, nbytes
, 1, stderr
);
5651 if (cursor_in_echo_area
== 0)
5652 fprintf (stderr
, "\n");
5655 /* A null message buffer means that the frame hasn't really been
5656 initialized yet. Error messages get reported properly by
5657 cmd_error, so this must be just an informative message; toss it. */
5658 else if (INTERACTIVE
5659 && sf
->glyphs_initialized_p
5660 && FRAME_MESSAGE_BUF (sf
))
5662 Lisp_Object mini_window
;
5665 /* Get the frame containing the mini-buffer
5666 that the selected frame is using. */
5667 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
5668 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
5670 FRAME_SAMPLE_VISIBILITY (f
);
5671 if (FRAME_VISIBLE_P (sf
)
5672 && ! FRAME_VISIBLE_P (f
))
5673 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
5677 set_message (m
, Qnil
, nbytes
, multibyte
);
5678 if (minibuffer_auto_raise
)
5679 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
5682 clear_message (1, 1);
5684 do_pending_window_change (0);
5685 echo_area_display (1);
5686 do_pending_window_change (0);
5687 if (frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
5688 (*frame_up_to_date_hook
) (f
);
5693 /* Display an echo area message M with a specified length of NBYTES
5694 bytes. The string may include null characters. If M is not a
5695 string, clear out any existing message, and let the mini-buffer
5696 text show through. */
5699 message3 (m
, nbytes
, multibyte
)
5704 struct gcpro gcpro1
;
5708 /* First flush out any partial line written with print. */
5709 message_log_maybe_newline ();
5711 message_dolog (XSTRING (m
)->data
, nbytes
, 1, multibyte
);
5712 message3_nolog (m
, nbytes
, multibyte
);
5718 /* The non-logging version of message3. */
5721 message3_nolog (m
, nbytes
, multibyte
)
5723 int nbytes
, multibyte
;
5725 struct frame
*sf
= SELECTED_FRAME ();
5726 message_enable_multibyte
= multibyte
;
5730 if (noninteractive_need_newline
)
5731 putc ('\n', stderr
);
5732 noninteractive_need_newline
= 0;
5734 fwrite (XSTRING (m
)->data
, nbytes
, 1, stderr
);
5735 if (cursor_in_echo_area
== 0)
5736 fprintf (stderr
, "\n");
5739 /* A null message buffer means that the frame hasn't really been
5740 initialized yet. Error messages get reported properly by
5741 cmd_error, so this must be just an informative message; toss it. */
5742 else if (INTERACTIVE
5743 && sf
->glyphs_initialized_p
5744 && FRAME_MESSAGE_BUF (sf
))
5746 Lisp_Object mini_window
;
5750 /* Get the frame containing the mini-buffer
5751 that the selected frame is using. */
5752 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
5753 frame
= XWINDOW (mini_window
)->frame
;
5756 FRAME_SAMPLE_VISIBILITY (f
);
5757 if (FRAME_VISIBLE_P (sf
)
5758 && !FRAME_VISIBLE_P (f
))
5759 Fmake_frame_visible (frame
);
5761 if (STRINGP (m
) && XSTRING (m
)->size
)
5763 set_message (NULL
, m
, nbytes
, multibyte
);
5764 if (minibuffer_auto_raise
)
5765 Fraise_frame (frame
);
5768 clear_message (1, 1);
5770 do_pending_window_change (0);
5771 echo_area_display (1);
5772 do_pending_window_change (0);
5773 if (frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
5774 (*frame_up_to_date_hook
) (f
);
5779 /* Display a null-terminated echo area message M. If M is 0, clear
5780 out any existing message, and let the mini-buffer text show through.
5782 The buffer M must continue to exist until after the echo area gets
5783 cleared or some other message gets displayed there. Do not pass
5784 text that is stored in a Lisp string. Do not pass text in a buffer
5785 that was alloca'd. */
5791 message2 (m
, (m
? strlen (m
) : 0), 0);
5795 /* The non-logging counterpart of message1. */
5801 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
5804 /* Display a message M which contains a single %s
5805 which gets replaced with STRING. */
5808 message_with_string (m
, string
, log
)
5817 if (noninteractive_need_newline
)
5818 putc ('\n', stderr
);
5819 noninteractive_need_newline
= 0;
5820 fprintf (stderr
, m
, XSTRING (string
)->data
);
5821 if (cursor_in_echo_area
== 0)
5822 fprintf (stderr
, "\n");
5826 else if (INTERACTIVE
)
5828 /* The frame whose minibuffer we're going to display the message on.
5829 It may be larger than the selected frame, so we need
5830 to use its buffer, not the selected frame's buffer. */
5831 Lisp_Object mini_window
;
5832 struct frame
*f
, *sf
= SELECTED_FRAME ();
5834 /* Get the frame containing the minibuffer
5835 that the selected frame is using. */
5836 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
5837 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
5839 /* A null message buffer means that the frame hasn't really been
5840 initialized yet. Error messages get reported properly by
5841 cmd_error, so this must be just an informative message; toss it. */
5842 if (FRAME_MESSAGE_BUF (f
))
5846 a
[0] = (char *) XSTRING (string
)->data
;
5848 len
= doprnt (FRAME_MESSAGE_BUF (f
),
5849 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
5852 message2 (FRAME_MESSAGE_BUF (f
), len
,
5853 STRING_MULTIBYTE (string
));
5855 message2_nolog (FRAME_MESSAGE_BUF (f
), len
,
5856 STRING_MULTIBYTE (string
));
5858 /* Print should start at the beginning of the message
5859 buffer next time. */
5860 message_buf_print
= 0;
5866 /* Dump an informative message to the minibuf. If M is 0, clear out
5867 any existing message, and let the mini-buffer text show through. */
5871 message (m
, a1
, a2
, a3
)
5873 EMACS_INT a1
, a2
, a3
;
5879 if (noninteractive_need_newline
)
5880 putc ('\n', stderr
);
5881 noninteractive_need_newline
= 0;
5882 fprintf (stderr
, m
, a1
, a2
, a3
);
5883 if (cursor_in_echo_area
== 0)
5884 fprintf (stderr
, "\n");
5888 else if (INTERACTIVE
)
5890 /* The frame whose mini-buffer we're going to display the message
5891 on. It may be larger than the selected frame, so we need to
5892 use its buffer, not the selected frame's buffer. */
5893 Lisp_Object mini_window
;
5894 struct frame
*f
, *sf
= SELECTED_FRAME ();
5896 /* Get the frame containing the mini-buffer
5897 that the selected frame is using. */
5898 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
5899 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
5901 /* A null message buffer means that the frame hasn't really been
5902 initialized yet. Error messages get reported properly by
5903 cmd_error, so this must be just an informative message; toss
5905 if (FRAME_MESSAGE_BUF (f
))
5916 len
= doprnt (FRAME_MESSAGE_BUF (f
),
5917 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
5919 len
= doprnt (FRAME_MESSAGE_BUF (f
),
5920 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3,
5922 #endif /* NO_ARG_ARRAY */
5924 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
5929 /* Print should start at the beginning of the message
5930 buffer next time. */
5931 message_buf_print
= 0;
5937 /* The non-logging version of message. */
5940 message_nolog (m
, a1
, a2
, a3
)
5942 EMACS_INT a1
, a2
, a3
;
5944 Lisp_Object old_log_max
;
5945 old_log_max
= Vmessage_log_max
;
5946 Vmessage_log_max
= Qnil
;
5947 message (m
, a1
, a2
, a3
);
5948 Vmessage_log_max
= old_log_max
;
5952 /* Display the current message in the current mini-buffer. This is
5953 only called from error handlers in process.c, and is not time
5959 if (!NILP (echo_area_buffer
[0]))
5962 string
= Fcurrent_message ();
5963 message3 (string
, XSTRING (string
)->size
,
5964 !NILP (current_buffer
->enable_multibyte_characters
));
5969 /* Make sure echo area buffers in echo_buffers[] are life. If they
5970 aren't, make new ones. */
5973 ensure_echo_area_buffers ()
5977 for (i
= 0; i
< 2; ++i
)
5978 if (!BUFFERP (echo_buffer
[i
])
5979 || NILP (XBUFFER (echo_buffer
[i
])->name
))
5982 Lisp_Object old_buffer
;
5985 old_buffer
= echo_buffer
[i
];
5986 sprintf (name
, " *Echo Area %d*", i
);
5987 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
5988 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
5990 for (j
= 0; j
< 2; ++j
)
5991 if (EQ (old_buffer
, echo_area_buffer
[j
]))
5992 echo_area_buffer
[j
] = echo_buffer
[i
];
5997 /* Call FN with args A1..A4 with either the current or last displayed
5998 echo_area_buffer as current buffer.
6000 WHICH zero means use the current message buffer
6001 echo_area_buffer[0]. If that is nil, choose a suitable buffer
6002 from echo_buffer[] and clear it.
6004 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
6005 suitable buffer from echo_buffer[] and clear it.
6007 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
6008 that the current message becomes the last displayed one, make
6009 choose a suitable buffer for echo_area_buffer[0], and clear it.
6011 Value is what FN returns. */
6014 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
)
6017 int (*fn
) P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
6023 int this_one
, the_other
, clear_buffer_p
, rc
;
6024 int count
= BINDING_STACK_SIZE ();
6026 /* If buffers aren't life, make new ones. */
6027 ensure_echo_area_buffers ();
6032 this_one
= 0, the_other
= 1;
6034 this_one
= 1, the_other
= 0;
6037 this_one
= 0, the_other
= 1;
6040 /* We need a fresh one in case the current echo buffer equals
6041 the one containing the last displayed echo area message. */
6042 if (!NILP (echo_area_buffer
[this_one
])
6043 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
6044 echo_area_buffer
[this_one
] = Qnil
;
6047 /* Choose a suitable buffer from echo_buffer[] is we don't
6049 if (NILP (echo_area_buffer
[this_one
]))
6051 echo_area_buffer
[this_one
]
6052 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
6053 ? echo_buffer
[the_other
]
6054 : echo_buffer
[this_one
]);
6058 buffer
= echo_area_buffer
[this_one
];
6060 record_unwind_protect (unwind_with_echo_area_buffer
,
6061 with_echo_area_buffer_unwind_data (w
));
6063 /* Make the echo area buffer current. Note that for display
6064 purposes, it is not necessary that the displayed window's buffer
6065 == current_buffer, except for text property lookup. So, let's
6066 only set that buffer temporarily here without doing a full
6067 Fset_window_buffer. We must also change w->pointm, though,
6068 because otherwise an assertions in unshow_buffer fails, and Emacs
6070 set_buffer_internal_1 (XBUFFER (buffer
));
6074 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
6077 current_buffer
->undo_list
= Qt
;
6078 current_buffer
->read_only
= Qnil
;
6079 specbind (Qinhibit_read_only
, Qt
);
6081 if (clear_buffer_p
&& Z
> BEG
)
6084 xassert (BEGV
>= BEG
);
6085 xassert (ZV
<= Z
&& ZV
>= BEGV
);
6087 rc
= fn (a1
, a2
, a3
, a4
);
6089 xassert (BEGV
>= BEG
);
6090 xassert (ZV
<= Z
&& ZV
>= BEGV
);
6092 unbind_to (count
, Qnil
);
6097 /* Save state that should be preserved around the call to the function
6098 FN called in with_echo_area_buffer. */
6101 with_echo_area_buffer_unwind_data (w
)
6107 /* Reduce consing by keeping one vector in
6108 Vwith_echo_area_save_vector. */
6109 vector
= Vwith_echo_area_save_vector
;
6110 Vwith_echo_area_save_vector
= Qnil
;
6113 vector
= Fmake_vector (make_number (7), Qnil
);
6115 XSETBUFFER (AREF (vector
, i
), current_buffer
); ++i
;
6116 AREF (vector
, i
) = Vdeactivate_mark
, ++i
;
6117 AREF (vector
, i
) = make_number (windows_or_buffers_changed
), ++i
;
6121 XSETWINDOW (AREF (vector
, i
), w
); ++i
;
6122 AREF (vector
, i
) = w
->buffer
; ++i
;
6123 AREF (vector
, i
) = make_number (XMARKER (w
->pointm
)->charpos
); ++i
;
6124 AREF (vector
, i
) = make_number (XMARKER (w
->pointm
)->bytepos
); ++i
;
6129 for (; i
< end
; ++i
)
6130 AREF (vector
, i
) = Qnil
;
6133 xassert (i
== ASIZE (vector
));
6138 /* Restore global state from VECTOR which was created by
6139 with_echo_area_buffer_unwind_data. */
6142 unwind_with_echo_area_buffer (vector
)
6145 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
6146 Vdeactivate_mark
= AREF (vector
, 1);
6147 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
6149 if (WINDOWP (AREF (vector
, 3)))
6152 Lisp_Object buffer
, charpos
, bytepos
;
6154 w
= XWINDOW (AREF (vector
, 3));
6155 buffer
= AREF (vector
, 4);
6156 charpos
= AREF (vector
, 5);
6157 bytepos
= AREF (vector
, 6);
6160 set_marker_both (w
->pointm
, buffer
,
6161 XFASTINT (charpos
), XFASTINT (bytepos
));
6164 Vwith_echo_area_save_vector
= vector
;
6169 /* Set up the echo area for use by print functions. MULTIBYTE_P
6170 non-zero means we will print multibyte. */
6173 setup_echo_area_for_printing (multibyte_p
)
6176 ensure_echo_area_buffers ();
6178 if (!message_buf_print
)
6180 /* A message has been output since the last time we printed.
6181 Choose a fresh echo area buffer. */
6182 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
6183 echo_area_buffer
[0] = echo_buffer
[1];
6185 echo_area_buffer
[0] = echo_buffer
[0];
6187 /* Switch to that buffer and clear it. */
6188 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
6189 current_buffer
->truncate_lines
= Qnil
;
6193 int count
= BINDING_STACK_SIZE ();
6194 specbind (Qinhibit_read_only
, Qt
);
6196 unbind_to (count
, Qnil
);
6198 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
6200 /* Set up the buffer for the multibyteness we need. */
6202 != !NILP (current_buffer
->enable_multibyte_characters
))
6203 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
6205 /* Raise the frame containing the echo area. */
6206 if (minibuffer_auto_raise
)
6208 struct frame
*sf
= SELECTED_FRAME ();
6209 Lisp_Object mini_window
;
6210 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
6211 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
6214 message_log_maybe_newline ();
6215 message_buf_print
= 1;
6219 if (NILP (echo_area_buffer
[0]))
6221 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
6222 echo_area_buffer
[0] = echo_buffer
[1];
6224 echo_area_buffer
[0] = echo_buffer
[0];
6227 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
6229 /* Someone switched buffers between print requests. */
6230 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
6231 current_buffer
->truncate_lines
= Qnil
;
6237 /* Display an echo area message in window W. Value is non-zero if W's
6238 height is changed. If display_last_displayed_message_p is
6239 non-zero, display the message that was last displayed, otherwise
6240 display the current message. */
6243 display_echo_area (w
)
6246 int i
, no_message_p
, window_height_changed_p
, count
;
6248 /* Temporarily disable garbage collections while displaying the echo
6249 area. This is done because a GC can print a message itself.
6250 That message would modify the echo area buffer's contents while a
6251 redisplay of the buffer is going on, and seriously confuse
6253 count
= inhibit_garbage_collection ();
6255 /* If there is no message, we must call display_echo_area_1
6256 nevertheless because it resizes the window. But we will have to
6257 reset the echo_area_buffer in question to nil at the end because
6258 with_echo_area_buffer will sets it to an empty buffer. */
6259 i
= display_last_displayed_message_p
? 1 : 0;
6260 no_message_p
= NILP (echo_area_buffer
[i
]);
6262 window_height_changed_p
6263 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
6264 display_echo_area_1
,
6265 (EMACS_INT
) w
, Qnil
, 0, 0);
6268 echo_area_buffer
[i
] = Qnil
;
6270 unbind_to (count
, Qnil
);
6271 return window_height_changed_p
;
6275 /* Helper for display_echo_area. Display the current buffer which
6276 contains the current echo area message in window W, a mini-window,
6277 a pointer to which is passed in A1. A2..A4 are currently not used.
6278 Change the height of W so that all of the message is displayed.
6279 Value is non-zero if height of W was changed. */
6282 display_echo_area_1 (a1
, a2
, a3
, a4
)
6287 struct window
*w
= (struct window
*) a1
;
6289 struct text_pos start
;
6290 int window_height_changed_p
= 0;
6292 /* Do this before displaying, so that we have a large enough glyph
6293 matrix for the display. */
6294 window_height_changed_p
= resize_mini_window (w
, 0);
6297 clear_glyph_matrix (w
->desired_matrix
);
6298 XSETWINDOW (window
, w
);
6299 SET_TEXT_POS (start
, BEG
, BEG_BYTE
);
6300 try_window (window
, start
);
6302 return window_height_changed_p
;
6306 /* Resize the echo area window to exactly the size needed for the
6307 currently displayed message, if there is one. */
6310 resize_echo_area_axactly ()
6312 if (BUFFERP (echo_area_buffer
[0])
6313 && WINDOWP (echo_area_window
))
6315 struct window
*w
= XWINDOW (echo_area_window
);
6318 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
6319 (EMACS_INT
) w
, Qnil
, 0, 0);
6322 ++windows_or_buffers_changed
;
6323 ++update_mode_lines
;
6324 redisplay_internal (0);
6330 /* Callback function for with_echo_area_buffer, when used from
6331 resize_echo_area_axactly. A1 contains a pointer to the window to
6332 resize, A2 to A4 are not used. Value is what resize_mini_window
6336 resize_mini_window_1 (a1
, a2
, a3
, a4
)
6341 return resize_mini_window ((struct window
*) a1
, 1);
6345 /* Resize mini-window W to fit the size of its contents. EXACT:P
6346 means size the window exactly to the size needed. Otherwise, it's
6347 only enlarged until W's buffer is empty. Value is non-zero if
6348 the window height has been changed. */
6351 resize_mini_window (w
, exact_p
)
6355 struct frame
*f
= XFRAME (w
->frame
);
6356 int window_height_changed_p
= 0;
6358 xassert (MINI_WINDOW_P (w
));
6360 /* Nil means don't try to resize. */
6361 if (NILP (Vresize_mini_windows
)
6362 || (FRAME_X_P (f
) && f
->output_data
.x
== NULL
))
6365 if (!FRAME_MINIBUF_ONLY_P (f
))
6368 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
6369 int total_height
= XFASTINT (root
->height
) + XFASTINT (w
->height
);
6370 int height
, max_height
;
6371 int unit
= CANON_Y_UNIT (f
);
6372 struct text_pos start
;
6373 struct buffer
*old_current_buffer
= NULL
;
6375 if (current_buffer
!= XBUFFER (w
->buffer
))
6377 old_current_buffer
= current_buffer
;
6378 set_buffer_internal (XBUFFER (w
->buffer
));
6381 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
6383 /* Compute the max. number of lines specified by the user. */
6384 if (FLOATP (Vmax_mini_window_height
))
6385 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
6386 else if (INTEGERP (Vmax_mini_window_height
))
6387 max_height
= XINT (Vmax_mini_window_height
);
6389 max_height
= total_height
/ 4;
6391 /* Correct that max. height if it's bogus. */
6392 max_height
= max (1, max_height
);
6393 max_height
= min (total_height
, max_height
);
6395 /* Find out the height of the text in the window. */
6396 if (it
.truncate_lines_p
)
6401 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
6402 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
6403 height
= it
.current_y
+ last_height
;
6405 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
6406 height
-= it
.extra_line_spacing
;
6407 height
= (height
+ unit
- 1) / unit
;
6410 /* Compute a suitable window start. */
6411 if (height
> max_height
)
6413 height
= max_height
;
6414 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
6415 move_it_vertically_backward (&it
, (height
- 1) * unit
);
6416 start
= it
.current
.pos
;
6419 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
6420 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
6422 if (EQ (Vresize_mini_windows
, Qgrow_only
))
6424 /* Let it grow only, until we display an empty message, in which
6425 case the window shrinks again. */
6426 if (height
> XFASTINT (w
->height
))
6428 int old_height
= XFASTINT (w
->height
);
6429 freeze_window_starts (f
, 1);
6430 grow_mini_window (w
, height
- XFASTINT (w
->height
));
6431 window_height_changed_p
= XFASTINT (w
->height
) != old_height
;
6433 else if (height
< XFASTINT (w
->height
)
6434 && (exact_p
|| BEGV
== ZV
))
6436 int old_height
= XFASTINT (w
->height
);
6437 freeze_window_starts (f
, 0);
6438 shrink_mini_window (w
);
6439 window_height_changed_p
= XFASTINT (w
->height
) != old_height
;
6444 /* Always resize to exact size needed. */
6445 if (height
> XFASTINT (w
->height
))
6447 int old_height
= XFASTINT (w
->height
);
6448 freeze_window_starts (f
, 1);
6449 grow_mini_window (w
, height
- XFASTINT (w
->height
));
6450 window_height_changed_p
= XFASTINT (w
->height
) != old_height
;
6452 else if (height
< XFASTINT (w
->height
))
6454 int old_height
= XFASTINT (w
->height
);
6455 freeze_window_starts (f
, 0);
6456 shrink_mini_window (w
);
6460 freeze_window_starts (f
, 1);
6461 grow_mini_window (w
, height
- XFASTINT (w
->height
));
6464 window_height_changed_p
= XFASTINT (w
->height
) != old_height
;
6468 if (old_current_buffer
)
6469 set_buffer_internal (old_current_buffer
);
6472 return window_height_changed_p
;
6476 /* Value is the current message, a string, or nil if there is no
6484 if (NILP (echo_area_buffer
[0]))
6488 with_echo_area_buffer (0, 0, current_message_1
,
6489 (EMACS_INT
) &msg
, Qnil
, 0, 0);
6491 echo_area_buffer
[0] = Qnil
;
6499 current_message_1 (a1
, a2
, a3
, a4
)
6504 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
6507 *msg
= make_buffer_string (BEG
, Z
, 1);
6514 /* Push the current message on Vmessage_stack for later restauration
6515 by restore_message. Value is non-zero if the current message isn't
6516 empty. This is a relatively infrequent operation, so it's not
6517 worth optimizing. */
6523 msg
= current_message ();
6524 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
6525 return STRINGP (msg
);
6529 /* Handler for record_unwind_protect calling pop_message. */
6532 push_message_unwind (dummy
)
6540 /* Restore message display from the top of Vmessage_stack. */
6547 xassert (CONSP (Vmessage_stack
));
6548 msg
= XCAR (Vmessage_stack
);
6550 message3_nolog (msg
, STRING_BYTES (XSTRING (msg
)), STRING_MULTIBYTE (msg
));
6552 message3_nolog (msg
, 0, 0);
6556 /* Pop the top-most entry off Vmessage_stack. */
6561 xassert (CONSP (Vmessage_stack
));
6562 Vmessage_stack
= XCDR (Vmessage_stack
);
6566 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
6567 exits. If the stack is not empty, we have a missing pop_message
6571 check_message_stack ()
6573 if (!NILP (Vmessage_stack
))
6578 /* Truncate to NCHARS what will be displayed in the echo area the next
6579 time we display it---but don't redisplay it now. */
6582 truncate_echo_area (nchars
)
6586 echo_area_buffer
[0] = Qnil
;
6587 /* A null message buffer means that the frame hasn't really been
6588 initialized yet. Error messages get reported properly by
6589 cmd_error, so this must be just an informative message; toss it. */
6590 else if (!noninteractive
6592 && !NILP (echo_area_buffer
[0]))
6594 struct frame
*sf
= SELECTED_FRAME ();
6595 if (FRAME_MESSAGE_BUF (sf
))
6596 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
6601 /* Helper function for truncate_echo_area. Truncate the current
6602 message to at most NCHARS characters. */
6605 truncate_message_1 (nchars
, a2
, a3
, a4
)
6610 if (BEG
+ nchars
< Z
)
6611 del_range (BEG
+ nchars
, Z
);
6613 echo_area_buffer
[0] = Qnil
;
6618 /* Set the current message to a substring of S or STRING.
6620 If STRING is a Lisp string, set the message to the first NBYTES
6621 bytes from STRING. NBYTES zero means use the whole string. If
6622 STRING is multibyte, the message will be displayed multibyte.
6624 If S is not null, set the message to the first LEN bytes of S. LEN
6625 zero means use the whole string. MULTIBYTE_P non-zero means S is
6626 multibyte. Display the message multibyte in that case. */
6629 set_message (s
, string
, nbytes
, multibyte_p
)
6634 message_enable_multibyte
6635 = ((s
&& multibyte_p
)
6636 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
6638 with_echo_area_buffer (0, -1, set_message_1
,
6639 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
6640 message_buf_print
= 0;
6641 help_echo_showing_p
= 0;
6645 /* Helper function for set_message. Arguments have the same meaning
6646 as there, with A1 corresponding to S and A2 corresponding to STRING
6647 This function is called with the echo area buffer being
6651 set_message_1 (a1
, a2
, nbytes
, multibyte_p
)
6654 EMACS_INT nbytes
, multibyte_p
;
6656 char *s
= (char *) a1
;
6657 Lisp_Object string
= a2
;
6661 /* Change multibyteness of the echo buffer appropriately. */
6662 if (message_enable_multibyte
6663 != !NILP (current_buffer
->enable_multibyte_characters
))
6664 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
6666 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
6668 /* Insert new message at BEG. */
6669 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
6671 if (STRINGP (string
))
6676 nbytes
= XSTRING (string
)->size_byte
;
6677 nchars
= string_byte_to_char (string
, nbytes
);
6679 /* This function takes care of single/multibyte conversion. We
6680 just have to ensure that the echo area buffer has the right
6681 setting of enable_multibyte_characters. */
6682 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
6687 nbytes
= strlen (s
);
6689 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
6691 /* Convert from multi-byte to single-byte. */
6693 unsigned char work
[1];
6695 /* Convert a multibyte string to single-byte. */
6696 for (i
= 0; i
< nbytes
; i
+= n
)
6698 c
= string_char_and_length (s
+ i
, nbytes
- i
, &n
);
6699 work
[0] = (SINGLE_BYTE_CHAR_P (c
)
6701 : multibyte_char_to_unibyte (c
, Qnil
));
6702 insert_1_both (work
, 1, 1, 1, 0, 0);
6705 else if (!multibyte_p
6706 && !NILP (current_buffer
->enable_multibyte_characters
))
6708 /* Convert from single-byte to multi-byte. */
6710 unsigned char *msg
= (unsigned char *) s
;
6711 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
6713 /* Convert a single-byte string to multibyte. */
6714 for (i
= 0; i
< nbytes
; i
++)
6716 c
= unibyte_char_to_multibyte (msg
[i
]);
6717 n
= CHAR_STRING (c
, str
);
6718 insert_1_both (str
, 1, n
, 1, 0, 0);
6722 insert_1 (s
, nbytes
, 1, 0, 0);
6729 /* Clear messages. CURRENT_P non-zero means clear the current
6730 message. LAST_DISPLAYED_P non-zero means clear the message
6734 clear_message (current_p
, last_displayed_p
)
6735 int current_p
, last_displayed_p
;
6738 echo_area_buffer
[0] = Qnil
;
6740 if (last_displayed_p
)
6741 echo_area_buffer
[1] = Qnil
;
6743 message_buf_print
= 0;
6746 /* Clear garbaged frames.
6748 This function is used where the old redisplay called
6749 redraw_garbaged_frames which in turn called redraw_frame which in
6750 turn called clear_frame. The call to clear_frame was a source of
6751 flickering. I believe a clear_frame is not necessary. It should
6752 suffice in the new redisplay to invalidate all current matrices,
6753 and ensure a complete redisplay of all windows. */
6756 clear_garbaged_frames ()
6760 Lisp_Object tail
, frame
;
6762 FOR_EACH_FRAME (tail
, frame
)
6764 struct frame
*f
= XFRAME (frame
);
6766 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
6768 clear_current_matrices (f
);
6774 ++windows_or_buffers_changed
;
6779 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
6780 is non-zero update selected_frame. Value is non-zero if the
6781 mini-windows height has been changed. */
6784 echo_area_display (update_frame_p
)
6787 Lisp_Object mini_window
;
6790 int window_height_changed_p
= 0;
6791 struct frame
*sf
= SELECTED_FRAME ();
6793 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
6794 w
= XWINDOW (mini_window
);
6795 f
= XFRAME (WINDOW_FRAME (w
));
6797 /* Don't display if frame is invisible or not yet initialized. */
6798 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
6801 /* The terminal frame is used as the first Emacs frame on the Mac OS. */
6803 #ifdef HAVE_WINDOW_SYSTEM
6804 /* When Emacs starts, selected_frame may be a visible terminal
6805 frame, even if we run under a window system. If we let this
6806 through, a message would be displayed on the terminal. */
6807 if (EQ (selected_frame
, Vterminal_frame
)
6808 && !NILP (Vwindow_system
))
6810 #endif /* HAVE_WINDOW_SYSTEM */
6813 /* Redraw garbaged frames. */
6815 clear_garbaged_frames ();
6817 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
6819 echo_area_window
= mini_window
;
6820 window_height_changed_p
= display_echo_area (w
);
6821 w
->must_be_updated_p
= 1;
6823 /* Update the display, unless called from redisplay_internal.
6824 Also don't update the screen during redisplay itself. The
6825 update will happen at the end of redisplay, and an update
6826 here could cause confusion. */
6827 if (update_frame_p
&& !redisplaying_p
)
6831 /* If the display update has been interrupted by pending
6832 input, update mode lines in the frame. Due to the
6833 pending input, it might have been that redisplay hasn't
6834 been called, so that mode lines above the echo area are
6835 garbaged. This looks odd, so we prevent it here. */
6836 if (!display_completed
)
6837 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
6839 if (window_height_changed_p
6840 /* Don't do this if Emacs is shutting down. Redisplay
6841 needs to run hooks. */
6842 && !NILP (Vrun_hooks
))
6844 /* Must update other windows. Likewise as in other
6845 cases, don't let this update be interrupted by
6847 int count
= BINDING_STACK_SIZE ();
6848 specbind (Qredisplay_dont_pause
, Qt
);
6849 windows_or_buffers_changed
= 1;
6850 redisplay_internal (0);
6851 unbind_to (count
, Qnil
);
6853 else if (FRAME_WINDOW_P (f
) && n
== 0)
6855 /* Window configuration is the same as before.
6856 Can do with a display update of the echo area,
6857 unless we displayed some mode lines. */
6858 update_single_window (w
, 1);
6859 rif
->flush_display (f
);
6862 update_frame (f
, 1, 1);
6864 /* If cursor is in the echo area, make sure that the next
6865 redisplay displays the minibuffer, so that the cursor will
6866 be replaced with what the minibuffer wants. */
6867 if (cursor_in_echo_area
)
6868 ++windows_or_buffers_changed
;
6871 else if (!EQ (mini_window
, selected_window
))
6872 windows_or_buffers_changed
++;
6874 /* Last displayed message is now the current message. */
6875 echo_area_buffer
[1] = echo_area_buffer
[0];
6877 /* Prevent redisplay optimization in redisplay_internal by resetting
6878 this_line_start_pos. This is done because the mini-buffer now
6879 displays the message instead of its buffer text. */
6880 if (EQ (mini_window
, selected_window
))
6881 CHARPOS (this_line_start_pos
) = 0;
6883 return window_height_changed_p
;
6888 /***********************************************************************
6890 ***********************************************************************/
6893 #ifdef HAVE_WINDOW_SYSTEM
6895 /* A buffer for constructing frame titles in it; allocated from the
6896 heap in init_xdisp and resized as needed in store_frame_title_char. */
6898 static char *frame_title_buf
;
6900 /* The buffer's end, and a current output position in it. */
6902 static char *frame_title_buf_end
;
6903 static char *frame_title_ptr
;
6906 /* Store a single character C for the frame title in frame_title_buf.
6907 Re-allocate frame_title_buf if necessary. */
6910 store_frame_title_char (c
)
6913 /* If output position has reached the end of the allocated buffer,
6914 double the buffer's size. */
6915 if (frame_title_ptr
== frame_title_buf_end
)
6917 int len
= frame_title_ptr
- frame_title_buf
;
6918 int new_size
= 2 * len
* sizeof *frame_title_buf
;
6919 frame_title_buf
= (char *) xrealloc (frame_title_buf
, new_size
);
6920 frame_title_buf_end
= frame_title_buf
+ new_size
;
6921 frame_title_ptr
= frame_title_buf
+ len
;
6924 *frame_title_ptr
++ = c
;
6928 /* Store part of a frame title in frame_title_buf, beginning at
6929 frame_title_ptr. STR is the string to store. Do not copy
6930 characters that yield more columns than PRECISION; PRECISION <= 0
6931 means copy the whole string. Pad with spaces until FIELD_WIDTH
6932 number of characters have been copied; FIELD_WIDTH <= 0 means don't
6933 pad. Called from display_mode_element when it is used to build a
6937 store_frame_title (str
, field_width
, precision
)
6939 int field_width
, precision
;
6942 int dummy
, nbytes
, width
;
6944 /* Copy at most PRECISION chars from STR. */
6945 nbytes
= strlen (str
);
6946 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
6948 store_frame_title_char (*str
++);
6950 /* Fill up with spaces until FIELD_WIDTH reached. */
6951 while (field_width
> 0
6954 store_frame_title_char (' ');
6962 /* Set the title of FRAME, if it has changed. The title format is
6963 Vicon_title_format if FRAME is iconified, otherwise it is
6964 frame_title_format. */
6967 x_consider_frame_title (frame
)
6970 struct frame
*f
= XFRAME (frame
);
6972 if (FRAME_WINDOW_P (f
)
6973 || FRAME_MINIBUF_ONLY_P (f
)
6974 || f
->explicit_name
)
6976 /* Do we have more than one visible frame on this X display? */
6979 struct buffer
*obuf
;
6983 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
6985 struct frame
*tf
= XFRAME (XCAR (tail
));
6988 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
6989 && !FRAME_MINIBUF_ONLY_P (tf
)
6990 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
6994 /* Set global variable indicating that multiple frames exist. */
6995 multiple_frames
= CONSP (tail
);
6997 /* Switch to the buffer of selected window of the frame. Set up
6998 frame_title_ptr so that display_mode_element will output into it;
6999 then display the title. */
7000 obuf
= current_buffer
;
7001 Fset_buffer (XWINDOW (f
->selected_window
)->buffer
);
7002 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
7003 frame_title_ptr
= frame_title_buf
;
7004 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
7005 NULL
, DEFAULT_FACE_ID
);
7006 display_mode_element (&it
, 0, -1, -1, fmt
);
7007 len
= frame_title_ptr
- frame_title_buf
;
7008 frame_title_ptr
= NULL
;
7009 set_buffer_internal (obuf
);
7011 /* Set the title only if it's changed. This avoids consing in
7012 the common case where it hasn't. (If it turns out that we've
7013 already wasted too much time by walking through the list with
7014 display_mode_element, then we might need to optimize at a
7015 higher level than this.) */
7016 if (! STRINGP (f
->name
)
7017 || STRING_BYTES (XSTRING (f
->name
)) != len
7018 || bcmp (frame_title_buf
, XSTRING (f
->name
)->data
, len
) != 0)
7019 x_implicitly_set_name (f
, make_string (frame_title_buf
, len
), Qnil
);
7023 #else /* not HAVE_WINDOW_SYSTEM */
7025 #define frame_title_ptr ((char *)0)
7026 #define store_frame_title(str, mincol, maxcol) 0
7028 #endif /* not HAVE_WINDOW_SYSTEM */
7033 /***********************************************************************
7035 ***********************************************************************/
7038 /* Prepare for redisplay by updating menu-bar item lists when
7039 appropriate. This can call eval. */
7042 prepare_menu_bars ()
7045 struct gcpro gcpro1
, gcpro2
;
7047 Lisp_Object tooltip_frame
;
7049 #ifdef HAVE_X_WINDOWS
7050 tooltip_frame
= tip_frame
;
7052 tooltip_frame
= Qnil
;
7055 /* Update all frame titles based on their buffer names, etc. We do
7056 this before the menu bars so that the buffer-menu will show the
7057 up-to-date frame titles. */
7058 #ifdef HAVE_WINDOW_SYSTEM
7059 if (windows_or_buffers_changed
|| update_mode_lines
)
7061 Lisp_Object tail
, frame
;
7063 FOR_EACH_FRAME (tail
, frame
)
7066 if (!EQ (frame
, tooltip_frame
)
7067 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
7068 x_consider_frame_title (frame
);
7071 #endif /* HAVE_WINDOW_SYSTEM */
7073 /* Update the menu bar item lists, if appropriate. This has to be
7074 done before any actual redisplay or generation of display lines. */
7075 all_windows
= (update_mode_lines
7076 || buffer_shared
> 1
7077 || windows_or_buffers_changed
);
7080 Lisp_Object tail
, frame
;
7081 int count
= BINDING_STACK_SIZE ();
7083 record_unwind_protect (Fset_match_data
, Fmatch_data (Qnil
, Qnil
));
7085 FOR_EACH_FRAME (tail
, frame
)
7089 /* Ignore tooltip frame. */
7090 if (EQ (frame
, tooltip_frame
))
7093 /* If a window on this frame changed size, report that to
7094 the user and clear the size-change flag. */
7095 if (FRAME_WINDOW_SIZES_CHANGED (f
))
7097 Lisp_Object functions
;
7099 /* Clear flag first in case we get an error below. */
7100 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
7101 functions
= Vwindow_size_change_functions
;
7102 GCPRO2 (tail
, functions
);
7104 while (CONSP (functions
))
7106 call1 (XCAR (functions
), frame
);
7107 functions
= XCDR (functions
);
7113 update_menu_bar (f
, 0);
7114 #ifdef HAVE_WINDOW_SYSTEM
7115 update_tool_bar (f
, 0);
7120 unbind_to (count
, Qnil
);
7124 struct frame
*sf
= SELECTED_FRAME ();
7125 update_menu_bar (sf
, 1);
7126 #ifdef HAVE_WINDOW_SYSTEM
7127 update_tool_bar (sf
, 1);
7131 /* Motif needs this. See comment in xmenu.c. Turn it off when
7132 pending_menu_activation is not defined. */
7133 #ifdef USE_X_TOOLKIT
7134 pending_menu_activation
= 0;
7139 /* Update the menu bar item list for frame F. This has to be done
7140 before we start to fill in any display lines, because it can call
7143 If SAVE_MATCH_DATA is non-zero, we must save and restore it here. */
7146 update_menu_bar (f
, save_match_data
)
7148 int save_match_data
;
7151 register struct window
*w
;
7153 /* If called recursively during a menu update, do nothing. This can
7154 happen when, for instance, an activate-menubar-hook causes a
7156 if (inhibit_menubar_update
)
7159 window
= FRAME_SELECTED_WINDOW (f
);
7160 w
= XWINDOW (window
);
7162 if (update_mode_lines
)
7163 w
->update_mode_line
= Qt
;
7165 if (FRAME_WINDOW_P (f
)
7167 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (macintosh)
7168 FRAME_EXTERNAL_MENU_BAR (f
)
7170 FRAME_MENU_BAR_LINES (f
) > 0
7172 : FRAME_MENU_BAR_LINES (f
) > 0)
7174 /* If the user has switched buffers or windows, we need to
7175 recompute to reflect the new bindings. But we'll
7176 recompute when update_mode_lines is set too; that means
7177 that people can use force-mode-line-update to request
7178 that the menu bar be recomputed. The adverse effect on
7179 the rest of the redisplay algorithm is about the same as
7180 windows_or_buffers_changed anyway. */
7181 if (windows_or_buffers_changed
7182 || !NILP (w
->update_mode_line
)
7183 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
7184 < BUF_MODIFF (XBUFFER (w
->buffer
)))
7185 != !NILP (w
->last_had_star
))
7186 || ((!NILP (Vtransient_mark_mode
)
7187 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
7188 != !NILP (w
->region_showing
)))
7190 struct buffer
*prev
= current_buffer
;
7191 int count
= BINDING_STACK_SIZE ();
7193 specbind (Qinhibit_menubar_update
, Qt
);
7195 set_buffer_internal_1 (XBUFFER (w
->buffer
));
7196 if (save_match_data
)
7197 record_unwind_protect (Fset_match_data
, Fmatch_data (Qnil
, Qnil
));
7198 if (NILP (Voverriding_local_map_menu_flag
))
7200 specbind (Qoverriding_terminal_local_map
, Qnil
);
7201 specbind (Qoverriding_local_map
, Qnil
);
7204 /* Run the Lucid hook. */
7205 safe_run_hooks (Qactivate_menubar_hook
);
7207 /* If it has changed current-menubar from previous value,
7208 really recompute the menu-bar from the value. */
7209 if (! NILP (Vlucid_menu_bar_dirty_flag
))
7210 call0 (Qrecompute_lucid_menubar
);
7212 safe_run_hooks (Qmenu_bar_update_hook
);
7213 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
7215 /* Redisplay the menu bar in case we changed it. */
7216 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (macintosh)
7217 if (FRAME_WINDOW_P (f
)
7218 #if defined (macintosh)
7219 /* All frames on Mac OS share the same menubar. So only the
7220 selected frame should be allowed to set it. */
7221 && f
== SELECTED_FRAME ()
7224 set_frame_menubar (f
, 0, 0);
7226 /* On a terminal screen, the menu bar is an ordinary screen
7227 line, and this makes it get updated. */
7228 w
->update_mode_line
= Qt
;
7229 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI) */
7230 /* In the non-toolkit version, the menu bar is an ordinary screen
7231 line, and this makes it get updated. */
7232 w
->update_mode_line
= Qt
;
7233 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI) */
7235 unbind_to (count
, Qnil
);
7236 set_buffer_internal_1 (prev
);
7243 /***********************************************************************
7245 ***********************************************************************/
7247 #ifdef HAVE_WINDOW_SYSTEM
7249 /* Update the tool-bar item list for frame F. This has to be done
7250 before we start to fill in any display lines. Called from
7251 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
7252 and restore it here. */
7255 update_tool_bar (f
, save_match_data
)
7257 int save_match_data
;
7259 if (WINDOWP (f
->tool_bar_window
)
7260 && XFASTINT (XWINDOW (f
->tool_bar_window
)->height
) > 0)
7265 window
= FRAME_SELECTED_WINDOW (f
);
7266 w
= XWINDOW (window
);
7268 /* If the user has switched buffers or windows, we need to
7269 recompute to reflect the new bindings. But we'll
7270 recompute when update_mode_lines is set too; that means
7271 that people can use force-mode-line-update to request
7272 that the menu bar be recomputed. The adverse effect on
7273 the rest of the redisplay algorithm is about the same as
7274 windows_or_buffers_changed anyway. */
7275 if (windows_or_buffers_changed
7276 || !NILP (w
->update_mode_line
)
7277 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
7278 < BUF_MODIFF (XBUFFER (w
->buffer
)))
7279 != !NILP (w
->last_had_star
))
7280 || ((!NILP (Vtransient_mark_mode
)
7281 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
7282 != !NILP (w
->region_showing
)))
7284 struct buffer
*prev
= current_buffer
;
7285 int count
= BINDING_STACK_SIZE ();
7287 /* Set current_buffer to the buffer of the selected
7288 window of the frame, so that we get the right local
7290 set_buffer_internal_1 (XBUFFER (w
->buffer
));
7292 /* Save match data, if we must. */
7293 if (save_match_data
)
7294 record_unwind_protect (Fset_match_data
, Fmatch_data (Qnil
, Qnil
));
7296 /* Make sure that we don't accidentally use bogus keymaps. */
7297 if (NILP (Voverriding_local_map_menu_flag
))
7299 specbind (Qoverriding_terminal_local_map
, Qnil
);
7300 specbind (Qoverriding_local_map
, Qnil
);
7303 /* Build desired tool-bar items from keymaps. */
7305 = tool_bar_items (f
->tool_bar_items
, &f
->n_tool_bar_items
);
7307 /* Redisplay the tool-bar in case we changed it. */
7308 w
->update_mode_line
= Qt
;
7310 unbind_to (count
, Qnil
);
7311 set_buffer_internal_1 (prev
);
7317 /* Set F->desired_tool_bar_string to a Lisp string representing frame
7318 F's desired tool-bar contents. F->tool_bar_items must have
7319 been set up previously by calling prepare_menu_bars. */
7322 build_desired_tool_bar_string (f
)
7325 int i
, size
, size_needed
;
7326 struct gcpro gcpro1
, gcpro2
, gcpro3
;
7327 Lisp_Object image
, plist
, props
;
7329 image
= plist
= props
= Qnil
;
7330 GCPRO3 (image
, plist
, props
);
7332 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
7333 Otherwise, make a new string. */
7335 /* The size of the string we might be able to reuse. */
7336 size
= (STRINGP (f
->desired_tool_bar_string
)
7337 ? XSTRING (f
->desired_tool_bar_string
)->size
7340 /* We need one space in the string for each image. */
7341 size_needed
= f
->n_tool_bar_items
;
7343 /* Reuse f->desired_tool_bar_string, if possible. */
7344 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
7345 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
7349 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
7350 Fremove_text_properties (make_number (0), make_number (size
),
7351 props
, f
->desired_tool_bar_string
);
7354 /* Put a `display' property on the string for the images to display,
7355 put a `menu_item' property on tool-bar items with a value that
7356 is the index of the item in F's tool-bar item vector. */
7357 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
7359 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
7361 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7362 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7363 int hmargin
, vmargin
, relief
, idx
, end
;
7364 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
, Qimage
;
7365 extern Lisp_Object Qlaplace
;
7367 /* If image is a vector, choose the image according to the
7369 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
7370 if (VECTORP (image
))
7374 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
7375 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
7378 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
7379 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
7381 xassert (ASIZE (image
) >= idx
);
7382 image
= AREF (image
, idx
);
7387 /* Ignore invalid image specifications. */
7388 if (!valid_image_p (image
))
7391 /* Display the tool-bar button pressed, or depressed. */
7392 plist
= Fcopy_sequence (XCDR (image
));
7394 /* Compute margin and relief to draw. */
7395 relief
= (tool_bar_button_relief
> 0
7396 ? tool_bar_button_relief
7397 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
7398 hmargin
= vmargin
= relief
;
7400 if (INTEGERP (Vtool_bar_button_margin
)
7401 && XINT (Vtool_bar_button_margin
) > 0)
7403 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
7404 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
7406 else if (CONSP (Vtool_bar_button_margin
))
7408 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
7409 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
7410 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
7412 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
7413 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
7414 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
7417 if (auto_raise_tool_bar_buttons_p
)
7419 /* Add a `:relief' property to the image spec if the item is
7423 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
7430 /* If image is selected, display it pressed, i.e. with a
7431 negative relief. If it's not selected, display it with a
7433 plist
= Fplist_put (plist
, QCrelief
,
7435 ? make_number (-relief
)
7436 : make_number (relief
)));
7441 /* Put a margin around the image. */
7442 if (hmargin
|| vmargin
)
7444 if (hmargin
== vmargin
)
7445 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
7447 plist
= Fplist_put (plist
, QCmargin
,
7448 Fcons (make_number (hmargin
),
7449 make_number (vmargin
)));
7452 /* If button is not enabled, and we don't have special images
7453 for the disabled state, make the image appear disabled by
7454 applying an appropriate algorithm to it. */
7455 if (!enabled_p
&& idx
< 0)
7456 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
7458 /* Put a `display' text property on the string for the image to
7459 display. Put a `menu-item' property on the string that gives
7460 the start of this item's properties in the tool-bar items
7462 image
= Fcons (Qimage
, plist
);
7463 props
= list4 (Qdisplay
, image
,
7464 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
7466 /* Let the last image hide all remaining spaces in the tool bar
7467 string. The string can be longer than needed when we reuse a
7469 if (i
+ 1 == f
->n_tool_bar_items
)
7470 end
= XSTRING (f
->desired_tool_bar_string
)->size
;
7473 Fadd_text_properties (make_number (i
), make_number (end
),
7474 props
, f
->desired_tool_bar_string
);
7482 /* Display one line of the tool-bar of frame IT->f. */
7485 display_tool_bar_line (it
)
7488 struct glyph_row
*row
= it
->glyph_row
;
7489 int max_x
= it
->last_visible_x
;
7492 prepare_desired_row (row
);
7493 row
->y
= it
->current_y
;
7495 /* Note that this isn't made use of if the face hasn't a box,
7496 so there's no need to check the face here. */
7497 it
->start_of_box_run_p
= 1;
7499 while (it
->current_x
< max_x
)
7501 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
7503 /* Get the next display element. */
7504 if (!get_next_display_element (it
))
7507 /* Produce glyphs. */
7508 x_before
= it
->current_x
;
7509 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
7510 PRODUCE_GLYPHS (it
);
7512 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
7517 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
7519 if (x
+ glyph
->pixel_width
> max_x
)
7521 /* Glyph doesn't fit on line. */
7522 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
7528 x
+= glyph
->pixel_width
;
7532 /* Stop at line ends. */
7533 if (ITERATOR_AT_END_OF_LINE_P (it
))
7536 set_iterator_to_next (it
, 1);
7541 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
7542 extend_face_to_end_of_line (it
);
7543 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
7544 last
->right_box_line_p
= 1;
7545 if (last
== row
->glyphs
[TEXT_AREA
])
7546 last
->left_box_line_p
= 1;
7547 compute_line_metrics (it
);
7549 /* If line is empty, make it occupy the rest of the tool-bar. */
7550 if (!row
->displays_text_p
)
7552 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
7553 row
->ascent
= row
->phys_ascent
= 0;
7556 row
->full_width_p
= 1;
7557 row
->continued_p
= 0;
7558 row
->truncated_on_left_p
= 0;
7559 row
->truncated_on_right_p
= 0;
7561 it
->current_x
= it
->hpos
= 0;
7562 it
->current_y
+= row
->height
;
7568 /* Value is the number of screen lines needed to make all tool-bar
7569 items of frame F visible. */
7572 tool_bar_lines_needed (f
)
7575 struct window
*w
= XWINDOW (f
->tool_bar_window
);
7578 /* Initialize an iterator for iteration over
7579 F->desired_tool_bar_string in the tool-bar window of frame F. */
7580 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
7581 it
.first_visible_x
= 0;
7582 it
.last_visible_x
= FRAME_WINDOW_WIDTH (f
) * CANON_X_UNIT (f
);
7583 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
7585 while (!ITERATOR_AT_END_P (&it
))
7587 it
.glyph_row
= w
->desired_matrix
->rows
;
7588 clear_glyph_row (it
.glyph_row
);
7589 display_tool_bar_line (&it
);
7592 return (it
.current_y
+ CANON_Y_UNIT (f
) - 1) / CANON_Y_UNIT (f
);
7596 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
7598 "Return the number of lines occupied by the tool bar of FRAME.")
7607 frame
= selected_frame
;
7609 CHECK_FRAME (frame
, 0);
7612 if (WINDOWP (f
->tool_bar_window
)
7613 || (w
= XWINDOW (f
->tool_bar_window
),
7614 XFASTINT (w
->height
) > 0))
7616 update_tool_bar (f
, 1);
7617 if (f
->n_tool_bar_items
)
7619 build_desired_tool_bar_string (f
);
7620 nlines
= tool_bar_lines_needed (f
);
7624 return make_number (nlines
);
7628 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
7629 height should be changed. */
7632 redisplay_tool_bar (f
)
7637 struct glyph_row
*row
;
7638 int change_height_p
= 0;
7640 /* If frame hasn't a tool-bar window or if it is zero-height, don't
7641 do anything. This means you must start with tool-bar-lines
7642 non-zero to get the auto-sizing effect. Or in other words, you
7643 can turn off tool-bars by specifying tool-bar-lines zero. */
7644 if (!WINDOWP (f
->tool_bar_window
)
7645 || (w
= XWINDOW (f
->tool_bar_window
),
7646 XFASTINT (w
->height
) == 0))
7649 /* Set up an iterator for the tool-bar window. */
7650 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
7651 it
.first_visible_x
= 0;
7652 it
.last_visible_x
= FRAME_WINDOW_WIDTH (f
) * CANON_X_UNIT (f
);
7655 /* Build a string that represents the contents of the tool-bar. */
7656 build_desired_tool_bar_string (f
);
7657 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
7659 /* Display as many lines as needed to display all tool-bar items. */
7660 while (it
.current_y
< it
.last_visible_y
)
7661 display_tool_bar_line (&it
);
7663 /* It doesn't make much sense to try scrolling in the tool-bar
7664 window, so don't do it. */
7665 w
->desired_matrix
->no_scrolling_p
= 1;
7666 w
->must_be_updated_p
= 1;
7668 if (auto_resize_tool_bars_p
)
7672 /* If we couldn't display everything, change the tool-bar's
7674 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
7675 change_height_p
= 1;
7677 /* If there are blank lines at the end, except for a partially
7678 visible blank line at the end that is smaller than
7679 CANON_Y_UNIT, change the tool-bar's height. */
7680 row
= it
.glyph_row
- 1;
7681 if (!row
->displays_text_p
7682 && row
->height
>= CANON_Y_UNIT (f
))
7683 change_height_p
= 1;
7685 /* If row displays tool-bar items, but is partially visible,
7686 change the tool-bar's height. */
7687 if (row
->displays_text_p
7688 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
7689 change_height_p
= 1;
7691 /* Resize windows as needed by changing the `tool-bar-lines'
7694 && (nlines
= tool_bar_lines_needed (f
),
7695 nlines
!= XFASTINT (w
->height
)))
7697 extern Lisp_Object Qtool_bar_lines
;
7699 int old_height
= XFASTINT (w
->height
);
7701 XSETFRAME (frame
, f
);
7702 clear_glyph_matrix (w
->desired_matrix
);
7703 Fmodify_frame_parameters (frame
,
7704 Fcons (Fcons (Qtool_bar_lines
,
7705 make_number (nlines
)),
7707 if (XFASTINT (w
->height
) != old_height
)
7708 fonts_changed_p
= 1;
7712 return change_height_p
;
7716 /* Get information about the tool-bar item which is displayed in GLYPH
7717 on frame F. Return in *PROP_IDX the index where tool-bar item
7718 properties start in F->tool_bar_items. Value is zero if
7719 GLYPH doesn't display a tool-bar item. */
7722 tool_bar_item_info (f
, glyph
, prop_idx
)
7724 struct glyph
*glyph
;
7730 /* Get the text property `menu-item' at pos. The value of that
7731 property is the start index of this item's properties in
7732 F->tool_bar_items. */
7733 prop
= Fget_text_property (make_number (glyph
->charpos
),
7734 Qmenu_item
, f
->current_tool_bar_string
);
7735 if (INTEGERP (prop
))
7737 *prop_idx
= XINT (prop
);
7746 #endif /* HAVE_WINDOW_SYSTEM */
7750 /************************************************************************
7751 Horizontal scrolling
7752 ************************************************************************/
7754 static int hscroll_window_tree
P_ ((Lisp_Object
));
7755 static int hscroll_windows
P_ ((Lisp_Object
));
7757 /* For all leaf windows in the window tree rooted at WINDOW, set their
7758 hscroll value so that PT is (i) visible in the window, and (ii) so
7759 that it is not within a certain margin at the window's left and
7760 right border. Value is non-zero if any window's hscroll has been
7764 hscroll_window_tree (window
)
7767 int hscrolled_p
= 0;
7769 while (WINDOWP (window
))
7771 struct window
*w
= XWINDOW (window
);
7773 if (WINDOWP (w
->hchild
))
7774 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
7775 else if (WINDOWP (w
->vchild
))
7776 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
7777 else if (w
->cursor
.vpos
>= 0)
7779 int hscroll_margin
, text_area_x
, text_area_y
;
7780 int text_area_width
, text_area_height
;
7781 struct glyph_row
*current_cursor_row
7782 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
7783 struct glyph_row
*desired_cursor_row
7784 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
7785 struct glyph_row
*cursor_row
7786 = (desired_cursor_row
->enabled_p
7787 ? desired_cursor_row
7788 : current_cursor_row
);
7790 window_box (w
, TEXT_AREA
, &text_area_x
, &text_area_y
,
7791 &text_area_width
, &text_area_height
);
7793 /* Scroll when cursor is inside this scroll margin. */
7794 hscroll_margin
= 5 * CANON_X_UNIT (XFRAME (w
->frame
));
7796 if ((XFASTINT (w
->hscroll
)
7797 && w
->cursor
.x
< hscroll_margin
)
7798 || (cursor_row
->enabled_p
7799 && cursor_row
->truncated_on_right_p
7800 && (w
->cursor
.x
> text_area_width
- hscroll_margin
)))
7804 struct buffer
*saved_current_buffer
;
7807 /* Find point in a display of infinite width. */
7808 saved_current_buffer
= current_buffer
;
7809 current_buffer
= XBUFFER (w
->buffer
);
7811 if (w
== XWINDOW (selected_window
))
7812 pt
= BUF_PT (current_buffer
);
7815 pt
= marker_position (w
->pointm
);
7816 pt
= max (BEGV
, pt
);
7820 /* Move iterator to pt starting at cursor_row->start in
7821 a line with infinite width. */
7822 init_to_row_start (&it
, w
, cursor_row
);
7823 it
.last_visible_x
= INFINITY
;
7824 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
7825 current_buffer
= saved_current_buffer
;
7827 /* Center cursor in window. */
7828 hscroll
= (max (0, it
.current_x
- text_area_width
/ 2)
7829 / CANON_X_UNIT (it
.f
));
7830 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
7832 /* Don't call Fset_window_hscroll if value hasn't
7833 changed because it will prevent redisplay
7835 if (XFASTINT (w
->hscroll
) != hscroll
)
7837 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
7838 w
->hscroll
= make_number (hscroll
);
7847 /* Value is non-zero if hscroll of any leaf window has been changed. */
7852 /* Set hscroll so that cursor is visible and not inside horizontal
7853 scroll margins for all windows in the tree rooted at WINDOW. See
7854 also hscroll_window_tree above. Value is non-zero if any window's
7855 hscroll has been changed. If it has, desired matrices on the frame
7856 of WINDOW are cleared. */
7859 hscroll_windows (window
)
7864 if (automatic_hscrolling_p
)
7866 hscrolled_p
= hscroll_window_tree (window
);
7868 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
7877 /************************************************************************
7879 ************************************************************************/
7881 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
7882 to a non-zero value. This is sometimes handy to have in a debugger
7887 /* First and last unchanged row for try_window_id. */
7889 int debug_first_unchanged_at_end_vpos
;
7890 int debug_last_unchanged_at_beg_vpos
;
7892 /* Delta vpos and y. */
7894 int debug_dvpos
, debug_dy
;
7896 /* Delta in characters and bytes for try_window_id. */
7898 int debug_delta
, debug_delta_bytes
;
7900 /* Values of window_end_pos and window_end_vpos at the end of
7903 int debug_end_pos
, debug_end_vpos
;
7905 /* Append a string to W->desired_matrix->method. FMT is a printf
7906 format string. A1...A9 are a supplement for a variable-length
7907 argument list. If trace_redisplay_p is non-zero also printf the
7908 resulting string to stderr. */
7911 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
7914 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
7917 char *method
= w
->desired_matrix
->method
;
7918 int len
= strlen (method
);
7919 int size
= sizeof w
->desired_matrix
->method
;
7920 int remaining
= size
- len
- 1;
7922 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
7923 if (len
&& remaining
)
7929 strncpy (method
+ len
, buffer
, remaining
);
7931 if (trace_redisplay_p
)
7932 fprintf (stderr
, "%p (%s): %s\n",
7934 ((BUFFERP (w
->buffer
)
7935 && STRINGP (XBUFFER (w
->buffer
)->name
))
7936 ? (char *) XSTRING (XBUFFER (w
->buffer
)->name
)->data
7941 #endif /* GLYPH_DEBUG */
7944 /* This counter is used to clear the face cache every once in a while
7945 in redisplay_internal. It is incremented for each redisplay.
7946 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
7949 #define CLEAR_FACE_CACHE_COUNT 10000
7950 static int clear_face_cache_count
;
7952 /* Record the previous terminal frame we displayed. */
7954 static struct frame
*previous_terminal_frame
;
7956 /* Non-zero while redisplay_internal is in progress. */
7961 /* Value is non-zero if all changes in window W, which displays
7962 current_buffer, are in the text between START and END. START is a
7963 buffer position, END is given as a distance from Z. Used in
7964 redisplay_internal for display optimization. */
7967 text_outside_line_unchanged_p (w
, start
, end
)
7971 int unchanged_p
= 1;
7973 /* If text or overlays have changed, see where. */
7974 if (XFASTINT (w
->last_modified
) < MODIFF
7975 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
7977 /* Gap in the line? */
7978 if (GPT
< start
|| Z
- GPT
< end
)
7981 /* Changes start in front of the line, or end after it? */
7983 && (BEG_UNCHANGED
< start
- 1
7984 || END_UNCHANGED
< end
))
7987 /* If selective display, can't optimize if changes start at the
7988 beginning of the line. */
7990 && INTEGERP (current_buffer
->selective_display
)
7991 && XINT (current_buffer
->selective_display
) > 0
7992 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
8000 /* Do a frame update, taking possible shortcuts into account. This is
8001 the main external entry point for redisplay.
8003 If the last redisplay displayed an echo area message and that message
8004 is no longer requested, we clear the echo area or bring back the
8005 mini-buffer if that is in use. */
8010 redisplay_internal (0);
8013 /* Return 1 if point moved out of or into a composition. Otherwise
8014 return 0. PREV_BUF and PREV_PT are the last point buffer and
8015 position. BUF and PT are the current point buffer and position. */
8018 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
8019 struct buffer
*prev_buf
, *buf
;
8026 XSETBUFFER (buffer
, buf
);
8027 /* Check a composition at the last point if point moved within the
8029 if (prev_buf
== buf
)
8032 /* Point didn't move. */
8035 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
8036 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
8037 && COMPOSITION_VALID_P (start
, end
, prop
)
8038 && start
< prev_pt
&& end
> prev_pt
)
8039 /* The last point was within the composition. Return 1 iff
8040 point moved out of the composition. */
8041 return (pt
<= start
|| pt
>= end
);
8044 /* Check a composition at the current point. */
8045 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
8046 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
8047 && COMPOSITION_VALID_P (start
, end
, prop
)
8048 && start
< pt
&& end
> pt
);
8051 /* Reconsider the setting of B->clip_changed which is displayed
8055 reconsider_clip_changes (w
, b
)
8059 if (b
->prevent_redisplay_optimizations_p
)
8060 b
->clip_changed
= 1;
8061 else if (b
->clip_changed
8062 && !NILP (w
->window_end_valid
)
8063 && w
->current_matrix
->buffer
== b
8064 && w
->current_matrix
->zv
== BUF_ZV (b
)
8065 && w
->current_matrix
->begv
== BUF_BEGV (b
))
8066 b
->clip_changed
= 0;
8068 /* If display wasn't paused, and W is not a tool bar window, see if
8069 point has been moved into or out of a composition. In that case,
8070 we set b->clip_changed to 1 to force updating the screen. If
8071 b->clip_changed has already been set to 1, we can skip this
8073 if (!b
->clip_changed
8074 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
8078 if (w
== XWINDOW (selected_window
))
8079 pt
= BUF_PT (current_buffer
);
8081 pt
= marker_position (w
->pointm
);
8083 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
8084 || pt
!= XINT (w
->last_point
))
8085 && check_point_in_composition (w
->current_matrix
->buffer
,
8086 XINT (w
->last_point
),
8087 XBUFFER (w
->buffer
), pt
))
8088 b
->clip_changed
= 1;
8093 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
8094 response to any user action; therefore, we should preserve the echo
8095 area. (Actually, our caller does that job.) Perhaps in the future
8096 avoid recentering windows if it is not necessary; currently that
8097 causes some problems. */
8100 redisplay_internal (preserve_echo_area
)
8101 int preserve_echo_area
;
8103 struct window
*w
= XWINDOW (selected_window
);
8104 struct frame
*f
= XFRAME (w
->frame
);
8106 int must_finish
= 0;
8107 struct text_pos tlbufpos
, tlendpos
;
8108 int number_of_visible_frames
;
8110 struct frame
*sf
= SELECTED_FRAME ();
8112 /* Non-zero means redisplay has to consider all windows on all
8113 frames. Zero means, only selected_window is considered. */
8114 int consider_all_windows_p
;
8116 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
8118 /* No redisplay if running in batch mode or frame is not yet fully
8119 initialized, or redisplay is explicitly turned off by setting
8120 Vinhibit_redisplay. */
8122 || !NILP (Vinhibit_redisplay
)
8123 || !f
->glyphs_initialized_p
)
8126 /* The flag redisplay_performed_directly_p is set by
8127 direct_output_for_insert when it already did the whole screen
8128 update necessary. */
8129 if (redisplay_performed_directly_p
)
8131 redisplay_performed_directly_p
= 0;
8132 if (!hscroll_windows (selected_window
))
8136 #ifdef USE_X_TOOLKIT
8137 if (popup_activated ())
8141 /* I don't think this happens but let's be paranoid. */
8145 /* Record a function that resets redisplaying_p to its old value
8146 when we leave this function. */
8147 count
= BINDING_STACK_SIZE ();
8148 record_unwind_protect (unwind_redisplay
, make_number (redisplaying_p
));
8153 reconsider_clip_changes (w
, current_buffer
);
8155 /* If new fonts have been loaded that make a glyph matrix adjustment
8156 necessary, do it. */
8157 if (fonts_changed_p
)
8159 adjust_glyphs (NULL
);
8160 ++windows_or_buffers_changed
;
8161 fonts_changed_p
= 0;
8164 /* If face_change_count is non-zero, init_iterator will free all
8165 realized faces, which includes the faces referenced from current
8166 matrices. So, we can't reuse current matrices in this case. */
8167 if (face_change_count
)
8168 ++windows_or_buffers_changed
;
8170 if (! FRAME_WINDOW_P (sf
)
8171 && previous_terminal_frame
!= sf
)
8173 /* Since frames on an ASCII terminal share the same display
8174 area, displaying a different frame means redisplay the whole
8176 windows_or_buffers_changed
++;
8177 SET_FRAME_GARBAGED (sf
);
8178 XSETFRAME (Vterminal_frame
, sf
);
8180 previous_terminal_frame
= sf
;
8182 /* Set the visible flags for all frames. Do this before checking
8183 for resized or garbaged frames; they want to know if their frames
8184 are visible. See the comment in frame.h for
8185 FRAME_SAMPLE_VISIBILITY. */
8187 Lisp_Object tail
, frame
;
8189 number_of_visible_frames
= 0;
8191 FOR_EACH_FRAME (tail
, frame
)
8193 struct frame
*f
= XFRAME (frame
);
8195 FRAME_SAMPLE_VISIBILITY (f
);
8196 if (FRAME_VISIBLE_P (f
))
8197 ++number_of_visible_frames
;
8198 clear_desired_matrices (f
);
8202 /* Notice any pending interrupt request to change frame size. */
8203 do_pending_window_change (1);
8205 /* Clear frames marked as garbaged. */
8207 clear_garbaged_frames ();
8209 /* Build menubar and tool-bar items. */
8210 prepare_menu_bars ();
8212 if (windows_or_buffers_changed
)
8213 update_mode_lines
++;
8215 /* Detect case that we need to write or remove a star in the mode line. */
8216 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
8218 w
->update_mode_line
= Qt
;
8219 if (buffer_shared
> 1)
8220 update_mode_lines
++;
8223 /* If %c is in the mode line, update it if needed. */
8224 if (!NILP (w
->column_number_displayed
)
8225 /* This alternative quickly identifies a common case
8226 where no change is needed. */
8227 && !(PT
== XFASTINT (w
->last_point
)
8228 && XFASTINT (w
->last_modified
) >= MODIFF
8229 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
8230 && XFASTINT (w
->column_number_displayed
) != current_column ())
8231 w
->update_mode_line
= Qt
;
8233 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
8235 /* The variable buffer_shared is set in redisplay_window and
8236 indicates that we redisplay a buffer in different windows. See
8238 consider_all_windows_p
= update_mode_lines
|| buffer_shared
> 1;
8240 /* If specs for an arrow have changed, do thorough redisplay
8241 to ensure we remove any arrow that should no longer exist. */
8242 if (! EQ (COERCE_MARKER (Voverlay_arrow_position
), last_arrow_position
)
8243 || ! EQ (Voverlay_arrow_string
, last_arrow_string
))
8244 consider_all_windows_p
= windows_or_buffers_changed
= 1;
8246 /* Normally the message* functions will have already displayed and
8247 updated the echo area, but the frame may have been trashed, or
8248 the update may have been preempted, so display the echo area
8249 again here. Checking both message buffers captures the case that
8250 the echo area should be cleared. */
8251 if (!NILP (echo_area_buffer
[0]) || !NILP (echo_area_buffer
[1]))
8253 int window_height_changed_p
= echo_area_display (0);
8256 if (fonts_changed_p
)
8258 else if (window_height_changed_p
)
8260 consider_all_windows_p
= 1;
8261 ++update_mode_lines
;
8262 ++windows_or_buffers_changed
;
8264 /* If window configuration was changed, frames may have been
8265 marked garbaged. Clear them or we will experience
8266 surprises wrt scrolling. */
8268 clear_garbaged_frames ();
8271 else if (EQ (selected_window
, minibuf_window
)
8272 && (current_buffer
->clip_changed
8273 || XFASTINT (w
->last_modified
) < MODIFF
8274 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
8275 && resize_mini_window (w
, 0))
8277 /* Resized active mini-window to fit the size of what it is
8278 showing if its contents might have changed. */
8280 consider_all_windows_p
= 1;
8281 ++windows_or_buffers_changed
;
8282 ++update_mode_lines
;
8284 /* If window configuration was changed, frames may have been
8285 marked garbaged. Clear them or we will experience
8286 surprises wrt scrolling. */
8288 clear_garbaged_frames ();
8292 /* If showing the region, and mark has changed, we must redisplay
8293 the whole window. The assignment to this_line_start_pos prevents
8294 the optimization directly below this if-statement. */
8295 if (((!NILP (Vtransient_mark_mode
)
8296 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
8297 != !NILP (w
->region_showing
))
8298 || (!NILP (w
->region_showing
)
8299 && !EQ (w
->region_showing
,
8300 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
8301 CHARPOS (this_line_start_pos
) = 0;
8303 /* Optimize the case that only the line containing the cursor in the
8304 selected window has changed. Variables starting with this_ are
8305 set in display_line and record information about the line
8306 containing the cursor. */
8307 tlbufpos
= this_line_start_pos
;
8308 tlendpos
= this_line_end_pos
;
8309 if (!consider_all_windows_p
8310 && CHARPOS (tlbufpos
) > 0
8311 && NILP (w
->update_mode_line
)
8312 && !current_buffer
->clip_changed
8313 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
8314 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
8315 /* Make sure recorded data applies to current buffer, etc. */
8316 && this_line_buffer
== current_buffer
8317 && current_buffer
== XBUFFER (w
->buffer
)
8318 && NILP (w
->force_start
)
8319 /* Point must be on the line that we have info recorded about. */
8320 && PT
>= CHARPOS (tlbufpos
)
8321 && PT
<= Z
- CHARPOS (tlendpos
)
8322 /* All text outside that line, including its final newline,
8323 must be unchanged */
8324 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
8325 CHARPOS (tlendpos
)))
8327 if (CHARPOS (tlbufpos
) > BEGV
8328 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
8329 && (CHARPOS (tlbufpos
) == ZV
8330 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
8331 /* Former continuation line has disappeared by becoming empty */
8333 else if (XFASTINT (w
->last_modified
) < MODIFF
8334 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
8335 || MINI_WINDOW_P (w
))
8337 /* We have to handle the case of continuation around a
8338 wide-column character (See the comment in indent.c around
8341 For instance, in the following case:
8343 -------- Insert --------
8344 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
8345 J_I_ ==> J_I_ `^^' are cursors.
8349 As we have to redraw the line above, we should goto cancel. */
8352 int line_height_before
= this_line_pixel_height
;
8354 /* Note that start_display will handle the case that the
8355 line starting at tlbufpos is a continuation lines. */
8356 start_display (&it
, w
, tlbufpos
);
8358 /* Implementation note: It this still necessary? */
8359 if (it
.current_x
!= this_line_start_x
)
8362 TRACE ((stderr
, "trying display optimization 1\n"));
8363 w
->cursor
.vpos
= -1;
8364 overlay_arrow_seen
= 0;
8365 it
.vpos
= this_line_vpos
;
8366 it
.current_y
= this_line_y
;
8367 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
8370 /* If line contains point, is not continued,
8371 and ends at same distance from eob as before, we win */
8372 if (w
->cursor
.vpos
>= 0
8373 /* Line is not continued, otherwise this_line_start_pos
8374 would have been set to 0 in display_line. */
8375 && CHARPOS (this_line_start_pos
)
8376 /* Line ends as before. */
8377 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
8378 /* Line has same height as before. Otherwise other lines
8379 would have to be shifted up or down. */
8380 && this_line_pixel_height
== line_height_before
)
8382 /* If this is not the window's last line, we must adjust
8383 the charstarts of the lines below. */
8384 if (it
.current_y
< it
.last_visible_y
)
8386 struct glyph_row
*row
8387 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
8388 int delta
, delta_bytes
;
8390 if (Z
- CHARPOS (tlendpos
) == ZV
)
8392 /* This line ends at end of (accessible part of)
8393 buffer. There is no newline to count. */
8395 - CHARPOS (tlendpos
)
8396 - MATRIX_ROW_START_CHARPOS (row
));
8397 delta_bytes
= (Z_BYTE
8398 - BYTEPOS (tlendpos
)
8399 - MATRIX_ROW_START_BYTEPOS (row
));
8403 /* This line ends in a newline. Must take
8404 account of the newline and the rest of the
8405 text that follows. */
8407 - CHARPOS (tlendpos
)
8408 - MATRIX_ROW_START_CHARPOS (row
));
8409 delta_bytes
= (Z_BYTE
8410 - BYTEPOS (tlendpos
)
8411 - MATRIX_ROW_START_BYTEPOS (row
));
8414 increment_matrix_positions (w
->current_matrix
,
8416 w
->current_matrix
->nrows
,
8417 delta
, delta_bytes
);
8420 /* If this row displays text now but previously didn't,
8421 or vice versa, w->window_end_vpos may have to be
8423 if ((it
.glyph_row
- 1)->displays_text_p
)
8425 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
8426 XSETINT (w
->window_end_vpos
, this_line_vpos
);
8428 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
8429 && this_line_vpos
> 0)
8430 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
8431 w
->window_end_valid
= Qnil
;
8433 /* Update hint: No need to try to scroll in update_window. */
8434 w
->desired_matrix
->no_scrolling_p
= 1;
8437 *w
->desired_matrix
->method
= 0;
8438 debug_method_add (w
, "optimization 1");
8445 else if (/* Cursor position hasn't changed. */
8446 PT
== XFASTINT (w
->last_point
)
8447 /* Make sure the cursor was last displayed
8448 in this window. Otherwise we have to reposition it. */
8449 && 0 <= w
->cursor
.vpos
8450 && XINT (w
->height
) > w
->cursor
.vpos
)
8454 do_pending_window_change (1);
8456 /* We used to always goto end_of_redisplay here, but this
8457 isn't enough if we have a blinking cursor. */
8458 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
8459 goto end_of_redisplay
;
8463 /* If highlighting the region, or if the cursor is in the echo area,
8464 then we can't just move the cursor. */
8465 else if (! (!NILP (Vtransient_mark_mode
)
8466 && !NILP (current_buffer
->mark_active
))
8467 && (EQ (selected_window
, current_buffer
->last_selected_window
)
8468 || highlight_nonselected_windows
)
8469 && NILP (w
->region_showing
)
8470 && NILP (Vshow_trailing_whitespace
)
8471 && !cursor_in_echo_area
)
8474 struct glyph_row
*row
;
8476 /* Skip from tlbufpos to PT and see where it is. Note that
8477 PT may be in invisible text. If so, we will end at the
8478 next visible position. */
8479 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
8480 NULL
, DEFAULT_FACE_ID
);
8481 it
.current_x
= this_line_start_x
;
8482 it
.current_y
= this_line_y
;
8483 it
.vpos
= this_line_vpos
;
8485 /* The call to move_it_to stops in front of PT, but
8486 moves over before-strings. */
8487 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
8489 if (it
.vpos
== this_line_vpos
8490 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
8493 xassert (this_line_vpos
== it
.vpos
);
8494 xassert (this_line_y
== it
.current_y
);
8495 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
8497 *w
->desired_matrix
->method
= 0;
8498 debug_method_add (w
, "optimization 3");
8507 /* Text changed drastically or point moved off of line. */
8508 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
8511 CHARPOS (this_line_start_pos
) = 0;
8512 consider_all_windows_p
|= buffer_shared
> 1;
8513 ++clear_face_cache_count
;
8516 /* Build desired matrices, and update the display. If
8517 consider_all_windows_p is non-zero, do it for all windows on all
8518 frames. Otherwise do it for selected_window, only. */
8520 if (consider_all_windows_p
)
8522 Lisp_Object tail
, frame
;
8523 int i
, n
= 0, size
= 50;
8524 struct frame
**updated
8525 = (struct frame
**) alloca (size
* sizeof *updated
);
8527 /* Clear the face cache eventually. */
8528 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
8530 clear_face_cache (0);
8531 clear_face_cache_count
= 0;
8534 /* Recompute # windows showing selected buffer. This will be
8535 incremented each time such a window is displayed. */
8538 FOR_EACH_FRAME (tail
, frame
)
8540 struct frame
*f
= XFRAME (frame
);
8542 if (FRAME_WINDOW_P (f
) || f
== sf
)
8544 /* Mark all the scroll bars to be removed; we'll redeem
8545 the ones we want when we redisplay their windows. */
8546 if (condemn_scroll_bars_hook
)
8547 condemn_scroll_bars_hook (f
);
8549 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
8550 redisplay_windows (FRAME_ROOT_WINDOW (f
));
8552 /* Any scroll bars which redisplay_windows should have
8553 nuked should now go away. */
8554 if (judge_scroll_bars_hook
)
8555 judge_scroll_bars_hook (f
);
8557 /* If fonts changed, display again. */
8558 if (fonts_changed_p
)
8561 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
8563 /* See if we have to hscroll. */
8564 if (hscroll_windows (f
->root_window
))
8567 /* Prevent various kinds of signals during display
8568 update. stdio is not robust about handling
8569 signals, which can cause an apparent I/O
8571 if (interrupt_input
)
8575 /* Update the display. */
8576 set_window_update_flags (XWINDOW (f
->root_window
), 1);
8577 pause
|= update_frame (f
, 0, 0);
8583 int nbytes
= size
* sizeof *updated
;
8584 struct frame
**p
= (struct frame
**) alloca (2 * nbytes
);
8585 bcopy (updated
, p
, nbytes
);
8594 /* Do the mark_window_display_accurate after all windows have
8595 been redisplayed because this call resets flags in buffers
8596 which are needed for proper redisplay. */
8597 for (i
= 0; i
< n
; ++i
)
8599 struct frame
*f
= updated
[i
];
8600 mark_window_display_accurate (f
->root_window
, 1);
8601 if (frame_up_to_date_hook
)
8602 frame_up_to_date_hook (f
);
8605 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
8607 Lisp_Object mini_window
;
8608 struct frame
*mini_frame
;
8610 redisplay_window (selected_window
, 1);
8612 /* Compare desired and current matrices, perform output. */
8615 /* If fonts changed, display again. */
8616 if (fonts_changed_p
)
8619 /* Prevent various kinds of signals during display update.
8620 stdio is not robust about handling signals,
8621 which can cause an apparent I/O error. */
8622 if (interrupt_input
)
8626 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
8628 if (hscroll_windows (selected_window
))
8631 XWINDOW (selected_window
)->must_be_updated_p
= 1;
8632 pause
= update_frame (sf
, 0, 0);
8635 /* We may have called echo_area_display at the top of this
8636 function. If the echo area is on another frame, that may
8637 have put text on a frame other than the selected one, so the
8638 above call to update_frame would not have caught it. Catch
8640 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8641 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8643 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
8645 XWINDOW (mini_window
)->must_be_updated_p
= 1;
8646 pause
|= update_frame (mini_frame
, 0, 0);
8647 if (!pause
&& hscroll_windows (mini_window
))
8652 /* If display was paused because of pending input, make sure we do a
8653 thorough update the next time. */
8656 /* Prevent the optimization at the beginning of
8657 redisplay_internal that tries a single-line update of the
8658 line containing the cursor in the selected window. */
8659 CHARPOS (this_line_start_pos
) = 0;
8661 /* Let the overlay arrow be updated the next time. */
8662 if (!NILP (last_arrow_position
))
8664 last_arrow_position
= Qt
;
8665 last_arrow_string
= Qt
;
8668 /* If we pause after scrolling, some rows in the current
8669 matrices of some windows are not valid. */
8670 if (!WINDOW_FULL_WIDTH_P (w
)
8671 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
8672 update_mode_lines
= 1;
8675 /* Now text on frame agrees with windows, so put info into the
8676 windows for partial redisplay to follow. */
8679 register struct buffer
*b
= XBUFFER (w
->buffer
);
8681 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
8682 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
8683 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
8684 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
8686 if (consider_all_windows_p
)
8687 mark_window_display_accurate (FRAME_ROOT_WINDOW (sf
), 1);
8690 XSETFASTINT (w
->last_point
, BUF_PT (b
));
8691 w
->last_cursor
= w
->cursor
;
8692 w
->last_cursor_off_p
= w
->cursor_off_p
;
8694 b
->clip_changed
= 0;
8695 b
->prevent_redisplay_optimizations_p
= 0;
8696 w
->update_mode_line
= Qnil
;
8697 XSETFASTINT (w
->last_modified
, BUF_MODIFF (b
));
8698 XSETFASTINT (w
->last_overlay_modified
, BUF_OVERLAY_MODIFF (b
));
8700 = (BUF_MODIFF (XBUFFER (w
->buffer
)) > BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
8703 /* Record if we are showing a region, so can make sure to
8704 update it fully at next redisplay. */
8705 w
->region_showing
= (!NILP (Vtransient_mark_mode
)
8706 && (EQ (selected_window
,
8707 current_buffer
->last_selected_window
)
8708 || highlight_nonselected_windows
)
8709 && !NILP (XBUFFER (w
->buffer
)->mark_active
)
8710 ? Fmarker_position (XBUFFER (w
->buffer
)->mark
)
8713 w
->window_end_valid
= w
->buffer
;
8714 last_arrow_position
= COERCE_MARKER (Voverlay_arrow_position
);
8715 last_arrow_string
= Voverlay_arrow_string
;
8716 if (frame_up_to_date_hook
!= 0)
8717 (*frame_up_to_date_hook
) (sf
);
8719 w
->current_matrix
->buffer
= b
;
8720 w
->current_matrix
->begv
= BUF_BEGV (b
);
8721 w
->current_matrix
->zv
= BUF_ZV (b
);
8724 update_mode_lines
= 0;
8725 windows_or_buffers_changed
= 0;
8728 /* Start SIGIO interrupts coming again. Having them off during the
8729 code above makes it less likely one will discard output, but not
8730 impossible, since there might be stuff in the system buffer here.
8731 But it is much hairier to try to do anything about that. */
8732 if (interrupt_input
)
8736 /* If a frame has become visible which was not before, redisplay
8737 again, so that we display it. Expose events for such a frame
8738 (which it gets when becoming visible) don't call the parts of
8739 redisplay constructing glyphs, so simply exposing a frame won't
8740 display anything in this case. So, we have to display these
8741 frames here explicitly. */
8744 Lisp_Object tail
, frame
;
8747 FOR_EACH_FRAME (tail
, frame
)
8749 int this_is_visible
= 0;
8751 if (XFRAME (frame
)->visible
)
8752 this_is_visible
= 1;
8753 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
8754 if (XFRAME (frame
)->visible
)
8755 this_is_visible
= 1;
8757 if (this_is_visible
)
8761 if (new_count
!= number_of_visible_frames
)
8762 windows_or_buffers_changed
++;
8765 /* Change frame size now if a change is pending. */
8766 do_pending_window_change (1);
8768 /* If we just did a pending size change, or have additional
8769 visible frames, redisplay again. */
8770 if (windows_or_buffers_changed
&& !pause
)
8775 unbind_to (count
, Qnil
);
8779 /* Redisplay, but leave alone any recent echo area message unless
8780 another message has been requested in its place.
8782 This is useful in situations where you need to redisplay but no
8783 user action has occurred, making it inappropriate for the message
8784 area to be cleared. See tracking_off and
8785 wait_reading_process_input for examples of these situations.
8787 FROM_WHERE is an integer saying from where this function was
8788 called. This is useful for debugging. */
8791 redisplay_preserve_echo_area (from_where
)
8794 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
8796 if (!NILP (echo_area_buffer
[1]))
8798 /* We have a previously displayed message, but no current
8799 message. Redisplay the previous message. */
8800 display_last_displayed_message_p
= 1;
8801 redisplay_internal (1);
8802 display_last_displayed_message_p
= 0;
8805 redisplay_internal (1);
8809 /* Function registered with record_unwind_protect in
8810 redisplay_internal. Clears the flag indicating that a redisplay is
8814 unwind_redisplay (old_redisplaying_p
)
8815 Lisp_Object old_redisplaying_p
;
8817 redisplaying_p
= XFASTINT (old_redisplaying_p
);
8822 /* Mark the display of windows in the window tree rooted at WINDOW as
8823 accurate or inaccurate. If FLAG is non-zero mark display of WINDOW
8824 as accurate. If FLAG is zero arrange for WINDOW to be redisplayed
8825 the next time redisplay_internal is called. */
8828 mark_window_display_accurate (window
, accurate_p
)
8834 for (; !NILP (window
); window
= w
->next
)
8836 w
= XWINDOW (window
);
8838 if (BUFFERP (w
->buffer
))
8840 struct buffer
*b
= XBUFFER (w
->buffer
);
8842 XSETFASTINT (w
->last_modified
,
8843 accurate_p
? BUF_MODIFF (b
) : 0);
8844 XSETFASTINT (w
->last_overlay_modified
,
8845 accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
8846 w
->last_had_star
= (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
)
8849 #if 0 /* I don't think this is necessary because display_line does it.
8851 /* Record if we are showing a region, so can make sure to
8852 update it fully at next redisplay. */
8854 = (!NILP (Vtransient_mark_mode
)
8855 && (w
== XWINDOW (current_buffer
->last_selected_window
)
8856 || highlight_nonselected_windows
)
8857 && (!NILP (b
->mark_active
)
8858 ? Fmarker_position (b
->mark
)
8864 b
->clip_changed
= 0;
8865 b
->prevent_redisplay_optimizations_p
= 0;
8866 w
->current_matrix
->buffer
= b
;
8867 w
->current_matrix
->begv
= BUF_BEGV (b
);
8868 w
->current_matrix
->zv
= BUF_ZV (b
);
8869 w
->last_cursor
= w
->cursor
;
8870 w
->last_cursor_off_p
= w
->cursor_off_p
;
8871 if (w
== XWINDOW (selected_window
))
8872 w
->last_point
= make_number (BUF_PT (b
));
8874 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
8878 w
->window_end_valid
= w
->buffer
;
8879 w
->update_mode_line
= Qnil
;
8881 if (!NILP (w
->vchild
))
8882 mark_window_display_accurate (w
->vchild
, accurate_p
);
8883 if (!NILP (w
->hchild
))
8884 mark_window_display_accurate (w
->hchild
, accurate_p
);
8889 last_arrow_position
= COERCE_MARKER (Voverlay_arrow_position
);
8890 last_arrow_string
= Voverlay_arrow_string
;
8894 /* Force a thorough redisplay the next time by setting
8895 last_arrow_position and last_arrow_string to t, which is
8896 unequal to any useful value of Voverlay_arrow_... */
8897 last_arrow_position
= Qt
;
8898 last_arrow_string
= Qt
;
8903 /* Return value in display table DP (Lisp_Char_Table *) for character
8904 C. Since a display table doesn't have any parent, we don't have to
8905 follow parent. Do not call this function directly but use the
8906 macro DISP_CHAR_VECTOR. */
8909 disp_char_vector (dp
, c
)
8910 struct Lisp_Char_Table
*dp
;
8916 if (SINGLE_BYTE_CHAR_P (c
))
8917 return (dp
->contents
[c
]);
8919 SPLIT_CHAR (c
, code
[0], code
[1], code
[2]);
8922 else if (code
[2] < 32)
8925 /* Here, the possible range of code[0] (== charset ID) is
8926 128..max_charset. Since the top level char table contains data
8927 for multibyte characters after 256th element, we must increment
8928 code[0] by 128 to get a correct index. */
8930 code
[3] = -1; /* anchor */
8932 for (i
= 0; code
[i
] >= 0; i
++, dp
= XCHAR_TABLE (val
))
8934 val
= dp
->contents
[code
[i
]];
8935 if (!SUB_CHAR_TABLE_P (val
))
8936 return (NILP (val
) ? dp
->defalt
: val
);
8939 /* Here, val is a sub char table. We return the default value of
8941 return (dp
->defalt
);
8946 /***********************************************************************
8948 ***********************************************************************/
8950 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
8953 redisplay_windows (window
)
8956 while (!NILP (window
))
8958 struct window
*w
= XWINDOW (window
);
8960 if (!NILP (w
->hchild
))
8961 redisplay_windows (w
->hchild
);
8962 else if (!NILP (w
->vchild
))
8963 redisplay_windows (w
->vchild
);
8965 redisplay_window (window
, 0);
8972 /* Set cursor position of W. PT is assumed to be displayed in ROW.
8973 DELTA is the number of bytes by which positions recorded in ROW
8974 differ from current buffer positions. */
8977 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
8979 struct glyph_row
*row
;
8980 struct glyph_matrix
*matrix
;
8981 int delta
, delta_bytes
, dy
, dvpos
;
8983 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
8984 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
8986 int pt_old
= PT
- delta
;
8988 /* Skip over glyphs not having an object at the start of the row.
8989 These are special glyphs like truncation marks on terminal
8991 if (row
->displays_text_p
)
8993 && INTEGERP (glyph
->object
)
8994 && glyph
->charpos
< 0)
8996 x
+= glyph
->pixel_width
;
9001 && !INTEGERP (glyph
->object
)
9002 && (!BUFFERP (glyph
->object
)
9003 || glyph
->charpos
< pt_old
))
9005 x
+= glyph
->pixel_width
;
9009 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
9011 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
9012 w
->cursor
.y
= row
->y
+ dy
;
9014 if (w
== XWINDOW (selected_window
))
9016 if (!row
->continued_p
9017 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
9020 this_line_buffer
= XBUFFER (w
->buffer
);
9022 CHARPOS (this_line_start_pos
)
9023 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
9024 BYTEPOS (this_line_start_pos
)
9025 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
9027 CHARPOS (this_line_end_pos
)
9028 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
9029 BYTEPOS (this_line_end_pos
)
9030 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
9032 this_line_y
= w
->cursor
.y
;
9033 this_line_pixel_height
= row
->height
;
9034 this_line_vpos
= w
->cursor
.vpos
;
9035 this_line_start_x
= row
->x
;
9038 CHARPOS (this_line_start_pos
) = 0;
9043 /* Run window scroll functions, if any, for WINDOW with new window
9044 start STARTP. Sets the window start of WINDOW to that position.
9046 We assume that the window's buffer is really current. */
9048 static INLINE
struct text_pos
9049 run_window_scroll_functions (window
, startp
)
9051 struct text_pos startp
;
9053 struct window
*w
= XWINDOW (window
);
9054 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
9056 if (current_buffer
!= XBUFFER (w
->buffer
))
9059 if (!NILP (Vwindow_scroll_functions
))
9061 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
9062 make_number (CHARPOS (startp
)));
9063 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
9064 /* In case the hook functions switch buffers. */
9065 if (current_buffer
!= XBUFFER (w
->buffer
))
9066 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9073 /* Modify the desired matrix of window W and W->vscroll so that the
9074 line containing the cursor is fully visible. */
9077 make_cursor_line_fully_visible (w
)
9080 struct glyph_matrix
*matrix
;
9081 struct glyph_row
*row
;
9084 /* It's not always possible to find the cursor, e.g, when a window
9085 is full of overlay strings. Don't do anything in that case. */
9086 if (w
->cursor
.vpos
< 0)
9089 matrix
= w
->desired_matrix
;
9090 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
9092 /* If the cursor row is not partially visible, there's nothing
9094 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (row
))
9097 /* If the row the cursor is in is taller than the window's height,
9098 it's not clear what to do, so do nothing. */
9099 window_height
= window_box_height (w
);
9100 if (row
->height
>= window_height
)
9103 if (MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (w
, row
))
9105 int dy
= row
->height
- row
->visible_height
;
9108 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
9110 else /* MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P (w, row)) */
9112 int dy
= - (row
->height
- row
->visible_height
);
9115 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
9118 /* When we change the cursor y-position of the selected window,
9119 change this_line_y as well so that the display optimization for
9120 the cursor line of the selected window in redisplay_internal uses
9121 the correct y-position. */
9122 if (w
== XWINDOW (selected_window
))
9123 this_line_y
= w
->cursor
.y
;
9127 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
9128 non-zero means only WINDOW is redisplayed in redisplay_internal.
9129 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
9130 in redisplay_window to bring a partially visible line into view in
9131 the case that only the cursor has moved.
9135 1 if scrolling succeeded
9137 0 if scrolling didn't find point.
9139 -1 if new fonts have been loaded so that we must interrupt
9140 redisplay, adjust glyph matrices, and try again. */
9143 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
9144 scroll_step
, temp_scroll_step
)
9146 int just_this_one_p
;
9147 int scroll_conservatively
, scroll_step
;
9148 int temp_scroll_step
;
9150 struct window
*w
= XWINDOW (window
);
9151 struct frame
*f
= XFRAME (w
->frame
);
9152 struct text_pos scroll_margin_pos
;
9153 struct text_pos pos
;
9154 struct text_pos startp
;
9156 Lisp_Object window_end
;
9157 int this_scroll_margin
;
9161 int amount_to_scroll
= 0;
9162 Lisp_Object aggressive
;
9166 debug_method_add (w
, "try_scrolling");
9169 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
9171 /* Compute scroll margin height in pixels. We scroll when point is
9172 within this distance from the top or bottom of the window. */
9173 if (scroll_margin
> 0)
9175 this_scroll_margin
= min (scroll_margin
, XINT (w
->height
) / 4);
9176 this_scroll_margin
*= CANON_Y_UNIT (f
);
9179 this_scroll_margin
= 0;
9181 /* Compute how much we should try to scroll maximally to bring point
9183 if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
9184 scroll_max
= max (scroll_step
,
9185 max (scroll_conservatively
, temp_scroll_step
));
9186 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
9187 || NUMBERP (current_buffer
->scroll_up_aggressively
))
9188 /* We're trying to scroll because of aggressive scrolling
9189 but no scroll_step is set. Choose an arbitrary one. Maybe
9190 there should be a variable for this. */
9194 scroll_max
*= CANON_Y_UNIT (f
);
9196 /* Decide whether we have to scroll down. Start at the window end
9197 and move this_scroll_margin up to find the position of the scroll
9199 window_end
= Fwindow_end (window
, Qt
);
9200 CHARPOS (scroll_margin_pos
) = XINT (window_end
);
9201 BYTEPOS (scroll_margin_pos
) = CHAR_TO_BYTE (CHARPOS (scroll_margin_pos
));
9202 if (this_scroll_margin
)
9204 start_display (&it
, w
, scroll_margin_pos
);
9205 move_it_vertically (&it
, - this_scroll_margin
);
9206 scroll_margin_pos
= it
.current
.pos
;
9209 if (PT
>= CHARPOS (scroll_margin_pos
))
9213 /* Point is in the scroll margin at the bottom of the window, or
9214 below. Compute a new window start that makes point visible. */
9216 /* Compute the distance from the scroll margin to PT.
9217 Give up if the distance is greater than scroll_max. */
9218 start_display (&it
, w
, scroll_margin_pos
);
9220 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
9221 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9223 /* With a scroll_margin of 0, scroll_margin_pos is at the window
9224 end, which is one line below the window. The iterator's
9225 current_y will be same as y0 in that case, but we have to
9226 scroll a line to make PT visible. That's the reason why 1 is
9228 dy
= 1 + it
.current_y
- y0
;
9230 if (dy
> scroll_max
)
9233 /* Move the window start down. If scrolling conservatively,
9234 move it just enough down to make point visible. If
9235 scroll_step is set, move it down by scroll_step. */
9236 start_display (&it
, w
, startp
);
9238 if (scroll_conservatively
)
9240 = max (max (dy
, CANON_Y_UNIT (f
)),
9241 CANON_Y_UNIT (f
) * max (scroll_step
, temp_scroll_step
));
9242 else if (scroll_step
|| temp_scroll_step
)
9243 amount_to_scroll
= scroll_max
;
9246 aggressive
= current_buffer
->scroll_down_aggressively
;
9247 height
= (WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE (w
)
9248 - WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
));
9249 if (NUMBERP (aggressive
))
9250 amount_to_scroll
= XFLOATINT (aggressive
) * height
;
9253 if (amount_to_scroll
<= 0)
9256 move_it_vertically (&it
, amount_to_scroll
);
9257 startp
= it
.current
.pos
;
9261 /* See if point is inside the scroll margin at the top of the
9263 scroll_margin_pos
= startp
;
9264 if (this_scroll_margin
)
9266 start_display (&it
, w
, startp
);
9267 move_it_vertically (&it
, this_scroll_margin
);
9268 scroll_margin_pos
= it
.current
.pos
;
9271 if (PT
< CHARPOS (scroll_margin_pos
))
9273 /* Point is in the scroll margin at the top of the window or
9274 above what is displayed in the window. */
9277 /* Compute the vertical distance from PT to the scroll
9278 margin position. Give up if distance is greater than
9280 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
9281 start_display (&it
, w
, pos
);
9283 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
9284 it
.last_visible_y
, -1,
9285 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9286 dy
= it
.current_y
- y0
;
9287 if (dy
> scroll_max
)
9290 /* Compute new window start. */
9291 start_display (&it
, w
, startp
);
9293 if (scroll_conservatively
)
9295 max (dy
, CANON_Y_UNIT (f
) * max (scroll_step
, temp_scroll_step
));
9296 else if (scroll_step
|| temp_scroll_step
)
9297 amount_to_scroll
= scroll_max
;
9300 aggressive
= current_buffer
->scroll_up_aggressively
;
9301 height
= (WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE (w
)
9302 - WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
));
9303 if (NUMBERP (aggressive
))
9304 amount_to_scroll
= XFLOATINT (aggressive
) * height
;
9307 if (amount_to_scroll
<= 0)
9310 move_it_vertically (&it
, - amount_to_scroll
);
9311 startp
= it
.current
.pos
;
9315 /* Run window scroll functions. */
9316 startp
= run_window_scroll_functions (window
, startp
);
9318 /* Display the window. Give up if new fonts are loaded, or if point
9320 if (!try_window (window
, startp
))
9322 else if (w
->cursor
.vpos
< 0)
9324 clear_glyph_matrix (w
->desired_matrix
);
9329 /* Maybe forget recorded base line for line number display. */
9330 if (!just_this_one_p
9331 || current_buffer
->clip_changed
9332 || BEG_UNCHANGED
< CHARPOS (startp
))
9333 w
->base_line_number
= Qnil
;
9335 /* If cursor ends up on a partially visible line, shift display
9336 lines up or down. */
9337 make_cursor_line_fully_visible (w
);
9345 /* Compute a suitable window start for window W if display of W starts
9346 on a continuation line. Value is non-zero if a new window start
9349 The new window start will be computed, based on W's width, starting
9350 from the start of the continued line. It is the start of the
9351 screen line with the minimum distance from the old start W->start. */
9354 compute_window_start_on_continuation_line (w
)
9357 struct text_pos pos
, start_pos
;
9358 int window_start_changed_p
= 0;
9360 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
9362 /* If window start is on a continuation line... Window start may be
9363 < BEGV in case there's invisible text at the start of the
9364 buffer (M-x rmail, for example). */
9365 if (CHARPOS (start_pos
) > BEGV
9366 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
9369 struct glyph_row
*row
;
9371 /* Handle the case that the window start is out of range. */
9372 if (CHARPOS (start_pos
) < BEGV
)
9373 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
9374 else if (CHARPOS (start_pos
) > ZV
)
9375 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
9377 /* Find the start of the continued line. This should be fast
9378 because scan_buffer is fast (newline cache). */
9379 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
9380 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
9381 row
, DEFAULT_FACE_ID
);
9382 reseat_at_previous_visible_line_start (&it
);
9384 /* If the line start is "too far" away from the window start,
9385 say it takes too much time to compute a new window start. */
9386 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
9387 < XFASTINT (w
->height
) * XFASTINT (w
->width
))
9389 int min_distance
, distance
;
9391 /* Move forward by display lines to find the new window
9392 start. If window width was enlarged, the new start can
9393 be expected to be > the old start. If window width was
9394 decreased, the new window start will be < the old start.
9395 So, we're looking for the display line start with the
9396 minimum distance from the old window start. */
9397 pos
= it
.current
.pos
;
9398 min_distance
= INFINITY
;
9399 while ((distance
= abs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
9400 distance
< min_distance
)
9402 min_distance
= distance
;
9403 pos
= it
.current
.pos
;
9404 move_it_by_lines (&it
, 1, 0);
9407 /* Set the window start there. */
9408 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
9409 window_start_changed_p
= 1;
9413 return window_start_changed_p
;
9417 /* Try cursor movement in case text has not changes in window WINDOW,
9418 with window start STARTP. Value is
9422 0 if this method cannot be used
9424 -1 if we know we have to scroll the display. *SCROLL_STEP is
9425 set to 1, under certain circumstances, if we want to scroll as
9426 if scroll-step were set to 1. See the code. */
9429 try_cursor_movement (window
, startp
, scroll_step
)
9431 struct text_pos startp
;
9434 struct window
*w
= XWINDOW (window
);
9435 struct frame
*f
= XFRAME (w
->frame
);
9438 /* Handle case where text has not changed, only point, and it has
9439 not moved off the frame. */
9440 if (/* Point may be in this window. */
9441 PT
>= CHARPOS (startp
)
9442 /* Selective display hasn't changed. */
9443 && !current_buffer
->clip_changed
9444 /* Function force-mode-line-update is used to force a thorough
9445 redisplay. It sets either windows_or_buffers_changed or
9446 update_mode_lines. So don't take a shortcut here for these
9448 && !update_mode_lines
9449 && !windows_or_buffers_changed
9450 /* Can't use this case if highlighting a region. When a
9451 region exists, cursor movement has to do more than just
9453 && !(!NILP (Vtransient_mark_mode
)
9454 && !NILP (current_buffer
->mark_active
))
9455 && NILP (w
->region_showing
)
9456 && NILP (Vshow_trailing_whitespace
)
9457 /* Right after splitting windows, last_point may be nil. */
9458 && INTEGERP (w
->last_point
)
9459 /* This code is not used for mini-buffer for the sake of the case
9460 of redisplaying to replace an echo area message; since in
9461 that case the mini-buffer contents per se are usually
9462 unchanged. This code is of no real use in the mini-buffer
9463 since the handling of this_line_start_pos, etc., in redisplay
9464 handles the same cases. */
9465 && !EQ (window
, minibuf_window
)
9466 /* When splitting windows or for new windows, it happens that
9467 redisplay is called with a nil window_end_vpos or one being
9468 larger than the window. This should really be fixed in
9469 window.c. I don't have this on my list, now, so we do
9470 approximately the same as the old redisplay code. --gerd. */
9471 && INTEGERP (w
->window_end_vpos
)
9472 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
9473 && (FRAME_WINDOW_P (f
)
9474 || !MARKERP (Voverlay_arrow_position
)
9475 || current_buffer
!= XMARKER (Voverlay_arrow_position
)->buffer
))
9477 int this_scroll_margin
;
9478 struct glyph_row
*row
;
9481 debug_method_add (w
, "cursor movement");
9484 /* Scroll if point within this distance from the top or bottom
9485 of the window. This is a pixel value. */
9486 this_scroll_margin
= max (0, scroll_margin
);
9487 this_scroll_margin
= min (this_scroll_margin
, XFASTINT (w
->height
) / 4);
9488 this_scroll_margin
*= CANON_Y_UNIT (f
);
9490 /* Start with the row the cursor was displayed during the last
9491 not paused redisplay. Give up if that row is not valid. */
9492 if (w
->last_cursor
.vpos
< 0
9493 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
9497 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
9498 if (row
->mode_line_p
)
9500 if (!row
->enabled_p
)
9507 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
9509 if (PT
> XFASTINT (w
->last_point
))
9511 /* Point has moved forward. */
9512 while (MATRIX_ROW_END_CHARPOS (row
) < PT
9513 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
9515 xassert (row
->enabled_p
);
9519 /* The end position of a row equals the start position
9520 of the next row. If PT is there, we would rather
9521 display it in the next line. */
9522 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
9523 && MATRIX_ROW_END_CHARPOS (row
) == PT
9524 && !cursor_row_p (w
, row
))
9527 /* If within the scroll margin, scroll. Note that
9528 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
9529 the next line would be drawn, and that
9530 this_scroll_margin can be zero. */
9531 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
9532 || PT
> MATRIX_ROW_END_CHARPOS (row
)
9533 /* Line is completely visible last line in window
9534 and PT is to be set in the next line. */
9535 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
9536 && PT
== MATRIX_ROW_END_CHARPOS (row
)
9537 && !row
->ends_at_zv_p
9538 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
9541 else if (PT
< XFASTINT (w
->last_point
))
9543 /* Cursor has to be moved backward. Note that PT >=
9544 CHARPOS (startp) because of the outer
9546 while (!row
->mode_line_p
9547 && (MATRIX_ROW_START_CHARPOS (row
) > PT
9548 || (MATRIX_ROW_START_CHARPOS (row
) == PT
9549 && MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)))
9550 && (row
->y
> this_scroll_margin
9551 || CHARPOS (startp
) == BEGV
))
9553 xassert (row
->enabled_p
);
9557 /* Consider the following case: Window starts at BEGV,
9558 there is invisible, intangible text at BEGV, so that
9559 display starts at some point START > BEGV. It can
9560 happen that we are called with PT somewhere between
9561 BEGV and START. Try to handle that case. */
9562 if (row
< w
->current_matrix
->rows
9563 || row
->mode_line_p
)
9565 row
= w
->current_matrix
->rows
;
9566 if (row
->mode_line_p
)
9570 /* Due to newlines in overlay strings, we may have to
9571 skip forward over overlay strings. */
9572 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
9573 && MATRIX_ROW_END_CHARPOS (row
) == PT
9574 && !cursor_row_p (w
, row
))
9577 /* If within the scroll margin, scroll. */
9578 if (row
->y
< this_scroll_margin
9579 && CHARPOS (startp
) != BEGV
)
9583 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
9584 || PT
> MATRIX_ROW_END_CHARPOS (row
))
9586 /* if PT is not in the glyph row, give up. */
9589 else if (MATRIX_ROW_PARTIALLY_VISIBLE_P (row
))
9591 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
9592 && !row
->ends_at_zv_p
9593 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
9595 else if (row
->height
> window_box_height (w
))
9597 /* If we end up in a partially visible line, let's
9598 make it fully visible, except when it's taller
9599 than the window, in which case we can't do much
9606 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
9607 try_window (window
, startp
);
9608 make_cursor_line_fully_visible (w
);
9616 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
9626 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
9627 selected_window is redisplayed. */
9630 redisplay_window (window
, just_this_one_p
)
9632 int just_this_one_p
;
9634 struct window
*w
= XWINDOW (window
);
9635 struct frame
*f
= XFRAME (w
->frame
);
9636 struct buffer
*buffer
= XBUFFER (w
->buffer
);
9637 struct buffer
*old
= current_buffer
;
9638 struct text_pos lpoint
, opoint
, startp
;
9639 int update_mode_line
;
9642 /* Record it now because it's overwritten. */
9643 int current_matrix_up_to_date_p
= 0;
9644 int temp_scroll_step
= 0;
9645 int count
= BINDING_STACK_SIZE ();
9648 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
9651 /* W must be a leaf window here. */
9652 xassert (!NILP (w
->buffer
));
9654 *w
->desired_matrix
->method
= 0;
9657 specbind (Qinhibit_point_motion_hooks
, Qt
);
9659 reconsider_clip_changes (w
, buffer
);
9661 /* Has the mode line to be updated? */
9662 update_mode_line
= (!NILP (w
->update_mode_line
)
9663 || update_mode_lines
9664 || buffer
->clip_changed
);
9666 if (MINI_WINDOW_P (w
))
9668 if (w
== XWINDOW (echo_area_window
)
9669 && !NILP (echo_area_buffer
[0]))
9671 if (update_mode_line
)
9672 /* We may have to update a tty frame's menu bar or a
9673 tool-bar. Example `M-x C-h C-h C-g'. */
9674 goto finish_menu_bars
;
9676 /* We've already displayed the echo area glyphs in this window. */
9677 goto finish_scroll_bars
;
9679 else if (w
!= XWINDOW (minibuf_window
))
9681 /* W is a mini-buffer window, but it's not the currently
9682 active one, so clear it. */
9683 int yb
= window_text_bottom_y (w
);
9684 struct glyph_row
*row
;
9687 for (y
= 0, row
= w
->desired_matrix
->rows
;
9689 y
+= row
->height
, ++row
)
9690 blank_row (w
, row
, y
);
9691 goto finish_scroll_bars
;
9695 /* Otherwise set up data on this window; select its buffer and point
9697 /* Really select the buffer, for the sake of buffer-local
9699 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9700 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
9702 current_matrix_up_to_date_p
9703 = (!NILP (w
->window_end_valid
)
9704 && !current_buffer
->clip_changed
9705 && XFASTINT (w
->last_modified
) >= MODIFF
9706 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
9708 /* When windows_or_buffers_changed is non-zero, we can't rely on
9709 the window end being valid, so set it to nil there. */
9710 if (windows_or_buffers_changed
)
9712 /* If window starts on a continuation line, maybe adjust the
9713 window start in case the window's width changed. */
9714 if (XMARKER (w
->start
)->buffer
== current_buffer
)
9715 compute_window_start_on_continuation_line (w
);
9717 w
->window_end_valid
= Qnil
;
9720 /* Some sanity checks. */
9721 CHECK_WINDOW_END (w
);
9722 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
9724 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
9727 /* If %c is in mode line, update it if needed. */
9728 if (!NILP (w
->column_number_displayed
)
9729 /* This alternative quickly identifies a common case
9730 where no change is needed. */
9731 && !(PT
== XFASTINT (w
->last_point
)
9732 && XFASTINT (w
->last_modified
) >= MODIFF
9733 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
9734 && XFASTINT (w
->column_number_displayed
) != current_column ())
9735 update_mode_line
= 1;
9737 /* Count number of windows showing the selected buffer. An indirect
9738 buffer counts as its base buffer. */
9739 if (!just_this_one_p
)
9741 struct buffer
*current_base
, *window_base
;
9742 current_base
= current_buffer
;
9743 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
9744 if (current_base
->base_buffer
)
9745 current_base
= current_base
->base_buffer
;
9746 if (window_base
->base_buffer
)
9747 window_base
= window_base
->base_buffer
;
9748 if (current_base
== window_base
)
9752 /* Point refers normally to the selected window. For any other
9753 window, set up appropriate value. */
9754 if (!EQ (window
, selected_window
))
9756 int new_pt
= XMARKER (w
->pointm
)->charpos
;
9757 int new_pt_byte
= marker_byte_position (w
->pointm
);
9761 new_pt_byte
= BEGV_BYTE
;
9762 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
9764 else if (new_pt
> (ZV
- 1))
9767 new_pt_byte
= ZV_BYTE
;
9768 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
9771 /* We don't use SET_PT so that the point-motion hooks don't run. */
9772 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
9775 /* If any of the character widths specified in the display table
9776 have changed, invalidate the width run cache. It's true that
9777 this may be a bit late to catch such changes, but the rest of
9778 redisplay goes (non-fatally) haywire when the display table is
9779 changed, so why should we worry about doing any better? */
9780 if (current_buffer
->width_run_cache
)
9782 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
9784 if (! disptab_matches_widthtab (disptab
,
9785 XVECTOR (current_buffer
->width_table
)))
9787 invalidate_region_cache (current_buffer
,
9788 current_buffer
->width_run_cache
,
9790 recompute_width_table (current_buffer
, disptab
);
9794 /* If window-start is screwed up, choose a new one. */
9795 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
9798 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
9800 /* If someone specified a new starting point but did not insist,
9801 check whether it can be used. */
9802 if (!NILP (w
->optional_new_start
)
9803 && CHARPOS (startp
) >= BEGV
9804 && CHARPOS (startp
) <= ZV
)
9806 w
->optional_new_start
= Qnil
;
9807 start_display (&it
, w
, startp
);
9808 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
9809 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9810 if (IT_CHARPOS (it
) == PT
)
9811 w
->force_start
= Qt
;
9814 /* Handle case where place to start displaying has been specified,
9815 unless the specified location is outside the accessible range. */
9816 if (!NILP (w
->force_start
)
9817 || w
->frozen_window_start_p
)
9819 w
->force_start
= Qnil
;
9821 w
->window_end_valid
= Qnil
;
9823 /* Forget any recorded base line for line number display. */
9824 if (!current_matrix_up_to_date_p
9825 || current_buffer
->clip_changed
)
9826 w
->base_line_number
= Qnil
;
9828 /* Redisplay the mode line. Select the buffer properly for that.
9829 Also, run the hook window-scroll-functions
9830 because we have scrolled. */
9831 /* Note, we do this after clearing force_start because
9832 if there's an error, it is better to forget about force_start
9833 than to get into an infinite loop calling the hook functions
9834 and having them get more errors. */
9835 if (!update_mode_line
9836 || ! NILP (Vwindow_scroll_functions
))
9838 update_mode_line
= 1;
9839 w
->update_mode_line
= Qt
;
9840 startp
= run_window_scroll_functions (window
, startp
);
9843 XSETFASTINT (w
->last_modified
, 0);
9844 XSETFASTINT (w
->last_overlay_modified
, 0);
9845 if (CHARPOS (startp
) < BEGV
)
9846 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
9847 else if (CHARPOS (startp
) > ZV
)
9848 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
9850 /* Redisplay, then check if cursor has been set during the
9851 redisplay. Give up if new fonts were loaded. */
9852 if (!try_window (window
, startp
))
9854 w
->force_start
= Qt
;
9855 clear_glyph_matrix (w
->desired_matrix
);
9856 goto finish_scroll_bars
;
9859 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
9861 /* If point does not appear, try to move point so it does
9862 appear. The desired matrix has been built above, so we
9865 struct glyph_row
*row
;
9867 window_height
= window_box_height (w
) / 2;
9868 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
9869 while (MATRIX_ROW_BOTTOM_Y (row
) < window_height
)
9872 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
9873 MATRIX_ROW_START_BYTEPOS (row
));
9875 if (w
!= XWINDOW (selected_window
))
9876 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
9877 else if (current_buffer
== old
)
9878 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
9880 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
9882 /* If we are highlighting the region, then we just changed
9883 the region, so redisplay to show it. */
9884 if (!NILP (Vtransient_mark_mode
)
9885 && !NILP (current_buffer
->mark_active
))
9887 clear_glyph_matrix (w
->desired_matrix
);
9888 if (!try_window (window
, startp
))
9889 goto finish_scroll_bars
;
9893 make_cursor_line_fully_visible (w
);
9895 debug_method_add (w
, "forced window start");
9900 /* Handle case where text has not changed, only point, and it has
9901 not moved off the frame. */
9902 if (current_matrix_up_to_date_p
9903 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
9911 /* If current starting point was originally the beginning of a line
9912 but no longer is, find a new starting point. */
9913 else if (!NILP (w
->start_at_line_beg
)
9914 && !(CHARPOS (startp
) <= BEGV
9915 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
9918 debug_method_add (w
, "recenter 1");
9923 /* Try scrolling with try_window_id. */
9924 else if (/* Windows and buffers haven't changed. */
9925 !windows_or_buffers_changed
9926 /* Window must be either use window-based redisplay or
9928 && (FRAME_WINDOW_P (f
)
9929 || (line_ins_del_ok
&& WINDOW_FULL_WIDTH_P (w
)))
9930 && !MINI_WINDOW_P (w
)
9931 /* Point is not known NOT to appear in window. */
9932 && PT
>= CHARPOS (startp
)
9933 && XFASTINT (w
->last_modified
)
9934 /* Window is not hscrolled. */
9935 && XFASTINT (w
->hscroll
) == 0
9936 /* Selective display has not changed. */
9937 && !current_buffer
->clip_changed
9938 /* Current matrix is up to date. */
9939 && !NILP (w
->window_end_valid
)
9940 /* Can't use this case if highlighting a region because
9941 a cursor movement will do more than just set the cursor. */
9942 && !(!NILP (Vtransient_mark_mode
)
9943 && !NILP (current_buffer
->mark_active
))
9944 && NILP (w
->region_showing
)
9945 && NILP (Vshow_trailing_whitespace
)
9946 /* Overlay arrow position and string not changed. */
9947 && EQ (last_arrow_position
, COERCE_MARKER (Voverlay_arrow_position
))
9948 && EQ (last_arrow_string
, Voverlay_arrow_string
)
9949 /* Value is > 0 if update has been done, it is -1 if we
9950 know that the same window start will not work. It is 0
9951 if unsuccessful for some other reason. */
9952 && (tem
= try_window_id (w
)) != 0)
9955 debug_method_add (w
, "try_window_id %d", tem
);
9958 if (fonts_changed_p
)
9959 goto finish_scroll_bars
;
9963 /* Otherwise try_window_id has returned -1 which means that we
9964 don't want the alternative below this comment to execute. */
9966 else if (CHARPOS (startp
) >= BEGV
9967 && CHARPOS (startp
) <= ZV
9968 && PT
>= CHARPOS (startp
)
9969 && (CHARPOS (startp
) < ZV
9970 /* Avoid starting at end of buffer. */
9971 || CHARPOS (startp
) == BEGV
9972 || (XFASTINT (w
->last_modified
) >= MODIFF
9973 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
9976 debug_method_add (w
, "same window start");
9979 /* Try to redisplay starting at same place as before.
9980 If point has not moved off frame, accept the results. */
9981 if (!current_matrix_up_to_date_p
9982 /* Don't use try_window_reusing_current_matrix in this case
9983 because a window scroll function can have changed the
9985 || !NILP (Vwindow_scroll_functions
)
9986 || MINI_WINDOW_P (w
)
9987 || !try_window_reusing_current_matrix (w
))
9989 IF_DEBUG (debug_method_add (w
, "1"));
9990 try_window (window
, startp
);
9993 if (fonts_changed_p
)
9994 goto finish_scroll_bars
;
9996 if (w
->cursor
.vpos
>= 0)
9998 if (!just_this_one_p
9999 || current_buffer
->clip_changed
10000 || BEG_UNCHANGED
< CHARPOS (startp
))
10001 /* Forget any recorded base line for line number display. */
10002 w
->base_line_number
= Qnil
;
10004 make_cursor_line_fully_visible (w
);
10008 clear_glyph_matrix (w
->desired_matrix
);
10013 XSETFASTINT (w
->last_modified
, 0);
10014 XSETFASTINT (w
->last_overlay_modified
, 0);
10016 /* Redisplay the mode line. Select the buffer properly for that. */
10017 if (!update_mode_line
)
10019 update_mode_line
= 1;
10020 w
->update_mode_line
= Qt
;
10023 /* Try to scroll by specified few lines. */
10024 if ((scroll_conservatively
10026 || temp_scroll_step
10027 || NUMBERP (current_buffer
->scroll_up_aggressively
)
10028 || NUMBERP (current_buffer
->scroll_down_aggressively
))
10029 && !current_buffer
->clip_changed
10030 && CHARPOS (startp
) >= BEGV
10031 && CHARPOS (startp
) <= ZV
)
10033 /* The function returns -1 if new fonts were loaded, 1 if
10034 successful, 0 if not successful. */
10035 int rc
= try_scrolling (window
, just_this_one_p
,
10036 scroll_conservatively
,
10042 goto finish_scroll_bars
;
10045 /* Finally, just choose place to start which centers point */
10050 debug_method_add (w
, "recenter");
10053 /* w->vscroll = 0; */
10055 /* Forget any previously recorded base line for line number display. */
10056 if (!current_matrix_up_to_date_p
10057 || current_buffer
->clip_changed
)
10058 w
->base_line_number
= Qnil
;
10060 /* Move backward half the height of the window. */
10061 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
10062 it
.current_y
= it
.last_visible_y
;
10063 move_it_vertically_backward (&it
, it
.last_visible_y
/ 2);
10064 xassert (IT_CHARPOS (it
) >= BEGV
);
10066 /* The function move_it_vertically_backward may move over more
10067 than the specified y-distance. If it->w is small, e.g. a
10068 mini-buffer window, we may end up in front of the window's
10069 display area. Start displaying at the start of the line
10070 containing PT in this case. */
10071 if (it
.current_y
<= 0)
10073 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
10074 move_it_vertically (&it
, 0);
10075 xassert (IT_CHARPOS (it
) <= PT
);
10079 it
.current_x
= it
.hpos
= 0;
10081 /* Set startp here explicitly in case that helps avoid an infinite loop
10082 in case the window-scroll-functions functions get errors. */
10083 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
10085 /* Run scroll hooks. */
10086 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
10088 /* Redisplay the window. */
10089 if (!current_matrix_up_to_date_p
10090 || windows_or_buffers_changed
10091 /* Don't use try_window_reusing_current_matrix in this case
10092 because it can have changed the buffer. */
10093 || !NILP (Vwindow_scroll_functions
)
10094 || !just_this_one_p
10095 || MINI_WINDOW_P (w
)
10096 || !try_window_reusing_current_matrix (w
))
10097 try_window (window
, startp
);
10099 /* If new fonts have been loaded (due to fontsets), give up. We
10100 have to start a new redisplay since we need to re-adjust glyph
10102 if (fonts_changed_p
)
10103 goto finish_scroll_bars
;
10105 /* If cursor did not appear assume that the middle of the window is
10106 in the first line of the window. Do it again with the next line.
10107 (Imagine a window of height 100, displaying two lines of height
10108 60. Moving back 50 from it->last_visible_y will end in the first
10110 if (w
->cursor
.vpos
< 0)
10112 if (!NILP (w
->window_end_valid
)
10113 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
10115 clear_glyph_matrix (w
->desired_matrix
);
10116 move_it_by_lines (&it
, 1, 0);
10117 try_window (window
, it
.current
.pos
);
10119 else if (PT
< IT_CHARPOS (it
))
10121 clear_glyph_matrix (w
->desired_matrix
);
10122 move_it_by_lines (&it
, -1, 0);
10123 try_window (window
, it
.current
.pos
);
10127 /* Not much we can do about it. */
10131 /* Consider the following case: Window starts at BEGV, there is
10132 invisible, intangible text at BEGV, so that display starts at
10133 some point START > BEGV. It can happen that we are called with
10134 PT somewhere between BEGV and START. Try to handle that case. */
10135 if (w
->cursor
.vpos
< 0)
10137 struct glyph_row
*row
= w
->current_matrix
->rows
;
10138 if (row
->mode_line_p
)
10140 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
10143 make_cursor_line_fully_visible (w
);
10147 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
10148 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
10149 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
10152 /* Display the mode line, if we must. */
10153 if ((update_mode_line
10154 /* If window not full width, must redo its mode line
10155 if (a) the window to its side is being redone and
10156 (b) we do a frame-based redisplay. This is a consequence
10157 of how inverted lines are drawn in frame-based redisplay. */
10158 || (!just_this_one_p
10159 && !FRAME_WINDOW_P (f
)
10160 && !WINDOW_FULL_WIDTH_P (w
))
10161 /* Line number to display. */
10162 || INTEGERP (w
->base_line_pos
)
10163 /* Column number is displayed and different from the one displayed. */
10164 || (!NILP (w
->column_number_displayed
)
10165 && XFASTINT (w
->column_number_displayed
) != current_column ()))
10166 /* This means that the window has a mode line. */
10167 && (WINDOW_WANTS_MODELINE_P (w
)
10168 || WINDOW_WANTS_HEADER_LINE_P (w
)))
10170 Lisp_Object old_selected_frame
;
10172 old_selected_frame
= selected_frame
;
10174 XSETFRAME (selected_frame
, f
);
10175 display_mode_lines (w
);
10176 selected_frame
= old_selected_frame
;
10178 /* If mode line height has changed, arrange for a thorough
10179 immediate redisplay using the correct mode line height. */
10180 if (WINDOW_WANTS_MODELINE_P (w
)
10181 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
10183 fonts_changed_p
= 1;
10184 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
10185 = DESIRED_MODE_LINE_HEIGHT (w
);
10188 /* If top line height has changed, arrange for a thorough
10189 immediate redisplay using the correct mode line height. */
10190 if (WINDOW_WANTS_HEADER_LINE_P (w
)
10191 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
10193 fonts_changed_p
= 1;
10194 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
10195 = DESIRED_HEADER_LINE_HEIGHT (w
);
10198 if (fonts_changed_p
)
10199 goto finish_scroll_bars
;
10202 if (!line_number_displayed
10203 && !BUFFERP (w
->base_line_pos
))
10205 w
->base_line_pos
= Qnil
;
10206 w
->base_line_number
= Qnil
;
10211 /* When we reach a frame's selected window, redo the frame's menu bar. */
10212 if (update_mode_line
10213 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
10215 int redisplay_menu_p
= 0;
10217 if (FRAME_WINDOW_P (f
))
10219 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (macintosh)
10220 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
10222 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
10226 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
10228 if (redisplay_menu_p
)
10229 display_menu_bar (w
);
10231 #ifdef HAVE_WINDOW_SYSTEM
10232 if (WINDOWP (f
->tool_bar_window
)
10233 && (FRAME_TOOL_BAR_LINES (f
) > 0
10234 || auto_resize_tool_bars_p
))
10235 redisplay_tool_bar (f
);
10239 finish_scroll_bars
:
10241 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
))
10243 int start
, end
, whole
;
10245 /* Calculate the start and end positions for the current window.
10246 At some point, it would be nice to choose between scrollbars
10247 which reflect the whole buffer size, with special markers
10248 indicating narrowing, and scrollbars which reflect only the
10251 Note that mini-buffers sometimes aren't displaying any text. */
10252 if (!MINI_WINDOW_P (w
)
10253 || (w
== XWINDOW (minibuf_window
)
10254 && NILP (echo_area_buffer
[0])))
10257 start
= marker_position (w
->start
) - BEGV
;
10258 /* I don't think this is guaranteed to be right. For the
10259 moment, we'll pretend it is. */
10260 end
= (Z
- XFASTINT (w
->window_end_pos
)) - BEGV
;
10264 if (whole
< (end
- start
))
10265 whole
= end
- start
;
10268 start
= end
= whole
= 0;
10270 /* Indicate what this scroll bar ought to be displaying now. */
10271 set_vertical_scroll_bar_hook (w
, end
- start
, whole
, start
);
10273 /* Note that we actually used the scroll bar attached to this
10274 window, so it shouldn't be deleted at the end of redisplay. */
10275 redeem_scroll_bar_hook (w
);
10278 /* Restore current_buffer and value of point in it. */
10279 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
10280 set_buffer_internal_1 (old
);
10281 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
10283 unbind_to (count
, Qnil
);
10287 /* Build the complete desired matrix of WINDOW with a window start
10288 buffer position POS. Value is non-zero if successful. It is zero
10289 if fonts were loaded during redisplay which makes re-adjusting
10290 glyph matrices necessary. */
10293 try_window (window
, pos
)
10294 Lisp_Object window
;
10295 struct text_pos pos
;
10297 struct window
*w
= XWINDOW (window
);
10299 struct glyph_row
*last_text_row
= NULL
;
10301 /* Make POS the new window start. */
10302 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
10304 /* Mark cursor position as unknown. No overlay arrow seen. */
10305 w
->cursor
.vpos
= -1;
10306 overlay_arrow_seen
= 0;
10308 /* Initialize iterator and info to start at POS. */
10309 start_display (&it
, w
, pos
);
10311 /* Display all lines of W. */
10312 while (it
.current_y
< it
.last_visible_y
)
10314 if (display_line (&it
))
10315 last_text_row
= it
.glyph_row
- 1;
10316 if (fonts_changed_p
)
10320 /* If bottom moved off end of frame, change mode line percentage. */
10321 if (XFASTINT (w
->window_end_pos
) <= 0
10322 && Z
!= IT_CHARPOS (it
))
10323 w
->update_mode_line
= Qt
;
10325 /* Set window_end_pos to the offset of the last character displayed
10326 on the window from the end of current_buffer. Set
10327 window_end_vpos to its row number. */
10330 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
10331 w
->window_end_bytepos
10332 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
10333 XSETFASTINT (w
->window_end_pos
,
10334 Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
10335 XSETFASTINT (w
->window_end_vpos
,
10336 MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
10337 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
10338 ->displays_text_p
);
10342 w
->window_end_bytepos
= 0;
10343 XSETFASTINT (w
->window_end_pos
, 0);
10344 XSETFASTINT (w
->window_end_vpos
, 0);
10347 /* But that is not valid info until redisplay finishes. */
10348 w
->window_end_valid
= Qnil
;
10354 /************************************************************************
10355 Window redisplay reusing current matrix when buffer has not changed
10356 ************************************************************************/
10358 /* Try redisplay of window W showing an unchanged buffer with a
10359 different window start than the last time it was displayed by
10360 reusing its current matrix. Value is non-zero if successful.
10361 W->start is the new window start. */
10364 try_window_reusing_current_matrix (w
)
10367 struct frame
*f
= XFRAME (w
->frame
);
10368 struct glyph_row
*row
, *bottom_row
;
10371 struct text_pos start
, new_start
;
10372 int nrows_scrolled
, i
;
10373 struct glyph_row
*last_text_row
;
10374 struct glyph_row
*last_reused_text_row
;
10375 struct glyph_row
*start_row
;
10376 int start_vpos
, min_y
, max_y
;
10378 if (/* This function doesn't handle terminal frames. */
10379 !FRAME_WINDOW_P (f
)
10380 /* Don't try to reuse the display if windows have been split
10382 || windows_or_buffers_changed
)
10385 /* Can't do this if region may have changed. */
10386 if ((!NILP (Vtransient_mark_mode
)
10387 && !NILP (current_buffer
->mark_active
))
10388 || !NILP (w
->region_showing
)
10389 || !NILP (Vshow_trailing_whitespace
))
10392 /* If top-line visibility has changed, give up. */
10393 if (WINDOW_WANTS_HEADER_LINE_P (w
)
10394 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
10397 /* Give up if old or new display is scrolled vertically. We could
10398 make this function handle this, but right now it doesn't. */
10399 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
10400 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (start_row
))
10403 /* The variable new_start now holds the new window start. The old
10404 start `start' can be determined from the current matrix. */
10405 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
10406 start
= start_row
->start
.pos
;
10407 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
10409 /* Clear the desired matrix for the display below. */
10410 clear_glyph_matrix (w
->desired_matrix
);
10412 if (CHARPOS (new_start
) <= CHARPOS (start
))
10416 IF_DEBUG (debug_method_add (w
, "twu1"));
10418 /* Display up to a row that can be reused. The variable
10419 last_text_row is set to the last row displayed that displays
10420 text. Note that it.vpos == 0 if or if not there is a
10421 header-line; it's not the same as the MATRIX_ROW_VPOS! */
10422 start_display (&it
, w
, new_start
);
10423 first_row_y
= it
.current_y
;
10424 w
->cursor
.vpos
= -1;
10425 last_text_row
= last_reused_text_row
= NULL
;
10427 while (it
.current_y
< it
.last_visible_y
10428 && IT_CHARPOS (it
) < CHARPOS (start
)
10429 && !fonts_changed_p
)
10430 if (display_line (&it
))
10431 last_text_row
= it
.glyph_row
- 1;
10433 /* A value of current_y < last_visible_y means that we stopped
10434 at the previous window start, which in turn means that we
10435 have at least one reusable row. */
10436 if (it
.current_y
< it
.last_visible_y
)
10438 /* IT.vpos always starts from 0; it counts text lines. */
10439 nrows_scrolled
= it
.vpos
;
10441 /* Find PT if not already found in the lines displayed. */
10442 if (w
->cursor
.vpos
< 0)
10444 int dy
= it
.current_y
- first_row_y
;
10446 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
10447 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
10449 if (PT
>= MATRIX_ROW_START_CHARPOS (row
)
10450 && PT
< MATRIX_ROW_END_CHARPOS (row
))
10452 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
10453 dy
, nrows_scrolled
);
10457 if (MATRIX_ROW_BOTTOM_Y (row
) + dy
>= it
.last_visible_y
)
10463 /* Give up if point was not found. This shouldn't
10464 happen often; not more often than with try_window
10466 if (w
->cursor
.vpos
< 0)
10468 clear_glyph_matrix (w
->desired_matrix
);
10473 /* Scroll the display. Do it before the current matrix is
10474 changed. The problem here is that update has not yet
10475 run, i.e. part of the current matrix is not up to date.
10476 scroll_run_hook will clear the cursor, and use the
10477 current matrix to get the height of the row the cursor is
10479 run
.current_y
= first_row_y
;
10480 run
.desired_y
= it
.current_y
;
10481 run
.height
= it
.last_visible_y
- it
.current_y
;
10483 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
10486 rif
->update_window_begin_hook (w
);
10487 rif
->clear_mouse_face (w
);
10488 rif
->scroll_run_hook (w
, &run
);
10489 rif
->update_window_end_hook (w
, 0, 0);
10493 /* Shift current matrix down by nrows_scrolled lines. */
10494 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
10495 rotate_matrix (w
->current_matrix
,
10497 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
10500 /* Disable lines that must be updated. */
10501 for (i
= 0; i
< it
.vpos
; ++i
)
10502 (start_row
+ i
)->enabled_p
= 0;
10504 /* Re-compute Y positions. */
10505 min_y
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
);
10506 max_y
= it
.last_visible_y
;
10507 for (row
= start_row
+ nrows_scrolled
;
10511 row
->y
= it
.current_y
;
10513 if (row
->y
< min_y
)
10514 row
->visible_height
= row
->height
- (min_y
- row
->y
);
10515 else if (row
->y
+ row
->height
> max_y
)
10516 row
->visible_height
10517 = row
->height
- (row
->y
+ row
->height
- max_y
);
10519 row
->visible_height
= row
->height
;
10521 it
.current_y
+= row
->height
;
10523 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
10524 last_reused_text_row
= row
;
10525 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
10529 /* Disable lines in the current matrix which are now
10530 below the window. */
10531 for (++row
; row
< bottom_row
; ++row
)
10532 row
->enabled_p
= 0;
10535 /* Update window_end_pos etc.; last_reused_text_row is the last
10536 reused row from the current matrix containing text, if any.
10537 The value of last_text_row is the last displayed line
10538 containing text. */
10539 if (last_reused_text_row
)
10541 w
->window_end_bytepos
10542 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
10543 XSETFASTINT (w
->window_end_pos
,
10544 Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
10545 XSETFASTINT (w
->window_end_vpos
,
10546 MATRIX_ROW_VPOS (last_reused_text_row
,
10547 w
->current_matrix
));
10549 else if (last_text_row
)
10551 w
->window_end_bytepos
10552 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
10553 XSETFASTINT (w
->window_end_pos
,
10554 Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
10555 XSETFASTINT (w
->window_end_vpos
,
10556 MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
10560 /* This window must be completely empty. */
10561 w
->window_end_bytepos
= 0;
10562 XSETFASTINT (w
->window_end_pos
, 0);
10563 XSETFASTINT (w
->window_end_vpos
, 0);
10565 w
->window_end_valid
= Qnil
;
10567 /* Update hint: don't try scrolling again in update_window. */
10568 w
->desired_matrix
->no_scrolling_p
= 1;
10571 debug_method_add (w
, "try_window_reusing_current_matrix 1");
10575 else if (CHARPOS (new_start
) > CHARPOS (start
))
10577 struct glyph_row
*pt_row
, *row
;
10578 struct glyph_row
*first_reusable_row
;
10579 struct glyph_row
*first_row_to_display
;
10581 int yb
= window_text_bottom_y (w
);
10583 IF_DEBUG (debug_method_add (w
, "twu2"));
10585 /* Find the row starting at new_start, if there is one. Don't
10586 reuse a partially visible line at the end. */
10587 first_reusable_row
= start_row
;
10588 while (first_reusable_row
->enabled_p
10589 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
10590 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
10591 < CHARPOS (new_start
)))
10592 ++first_reusable_row
;
10594 /* Give up if there is no row to reuse. */
10595 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
10596 || !first_reusable_row
->enabled_p
10597 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
10598 != CHARPOS (new_start
)))
10601 /* We can reuse fully visible rows beginning with
10602 first_reusable_row to the end of the window. Set
10603 first_row_to_display to the first row that cannot be reused.
10604 Set pt_row to the row containing point, if there is any. */
10605 first_row_to_display
= first_reusable_row
;
10607 while (MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
)
10609 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
10610 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
10611 pt_row
= first_row_to_display
;
10613 ++first_row_to_display
;
10616 /* Start displaying at the start of first_row_to_display. */
10617 xassert (first_row_to_display
->y
< yb
);
10618 init_to_row_start (&it
, w
, first_row_to_display
);
10619 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
10621 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
10623 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
10624 + WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
));
10626 /* Display lines beginning with first_row_to_display in the
10627 desired matrix. Set last_text_row to the last row displayed
10628 that displays text. */
10629 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
10630 if (pt_row
== NULL
)
10631 w
->cursor
.vpos
= -1;
10632 last_text_row
= NULL
;
10633 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
10634 if (display_line (&it
))
10635 last_text_row
= it
.glyph_row
- 1;
10637 /* Give up If point isn't in a row displayed or reused. */
10638 if (w
->cursor
.vpos
< 0)
10640 clear_glyph_matrix (w
->desired_matrix
);
10644 /* If point is in a reused row, adjust y and vpos of the cursor
10648 w
->cursor
.vpos
-= MATRIX_ROW_VPOS (first_reusable_row
,
10649 w
->current_matrix
);
10650 w
->cursor
.y
-= first_reusable_row
->y
;
10653 /* Scroll the display. */
10654 run
.current_y
= first_reusable_row
->y
;
10655 run
.desired_y
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
);
10656 run
.height
= it
.last_visible_y
- run
.current_y
;
10657 dy
= run
.current_y
- run
.desired_y
;
10661 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
10663 rif
->update_window_begin_hook (w
);
10664 rif
->clear_mouse_face (w
);
10665 rif
->scroll_run_hook (w
, &run
);
10666 rif
->update_window_end_hook (w
, 0, 0);
10670 /* Adjust Y positions of reused rows. */
10671 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
10672 min_y
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
);
10673 max_y
= it
.last_visible_y
;
10674 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
10677 if (row
->y
< min_y
)
10678 row
->visible_height
= row
->height
- (min_y
- row
->y
);
10679 else if (row
->y
+ row
->height
> max_y
)
10680 row
->visible_height
10681 = row
->height
- (row
->y
+ row
->height
- max_y
);
10683 row
->visible_height
= row
->height
;
10686 /* Disable rows not reused. */
10687 while (row
< bottom_row
)
10689 row
->enabled_p
= 0;
10693 /* Scroll the current matrix. */
10694 xassert (nrows_scrolled
> 0);
10695 rotate_matrix (w
->current_matrix
,
10697 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
10700 /* Adjust window end. A null value of last_text_row means that
10701 the window end is in reused rows which in turn means that
10702 only its vpos can have changed. */
10705 w
->window_end_bytepos
10706 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
10707 XSETFASTINT (w
->window_end_pos
,
10708 Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
10709 XSETFASTINT (w
->window_end_vpos
,
10710 MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
10714 XSETFASTINT (w
->window_end_vpos
,
10715 XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
10718 w
->window_end_valid
= Qnil
;
10719 w
->desired_matrix
->no_scrolling_p
= 1;
10722 debug_method_add (w
, "try_window_reusing_current_matrix 2");
10732 /************************************************************************
10733 Window redisplay reusing current matrix when buffer has changed
10734 ************************************************************************/
10736 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
10737 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
10739 static struct glyph_row
*
10740 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
10741 struct glyph_row
*));
10744 /* Return the last row in MATRIX displaying text. If row START is
10745 non-null, start searching with that row. IT gives the dimensions
10746 of the display. Value is null if matrix is empty; otherwise it is
10747 a pointer to the row found. */
10749 static struct glyph_row
*
10750 find_last_row_displaying_text (matrix
, it
, start
)
10751 struct glyph_matrix
*matrix
;
10753 struct glyph_row
*start
;
10755 struct glyph_row
*row
, *row_found
;
10757 /* Set row_found to the last row in IT->w's current matrix
10758 displaying text. The loop looks funny but think of partially
10761 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
10762 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
10764 xassert (row
->enabled_p
);
10766 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
10775 /* Return the last row in the current matrix of W that is not affected
10776 by changes at the start of current_buffer that occurred since the
10777 last time W was redisplayed. Value is null if no such row exists.
10779 The global variable beg_unchanged has to contain the number of
10780 bytes unchanged at the start of current_buffer. BEG +
10781 beg_unchanged is the buffer position of the first changed byte in
10782 current_buffer. Characters at positions < BEG + beg_unchanged are
10783 at the same buffer positions as they were when the current matrix
10786 static struct glyph_row
*
10787 find_last_unchanged_at_beg_row (w
)
10790 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
10791 struct glyph_row
*row
;
10792 struct glyph_row
*row_found
= NULL
;
10793 int yb
= window_text_bottom_y (w
);
10795 /* Find the last row displaying unchanged text. */
10796 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
10797 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
10798 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
)
10800 if (/* If row ends before first_changed_pos, it is unchanged,
10801 except in some case. */
10802 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
10803 /* When row ends in ZV and we write at ZV it is not
10805 && !row
->ends_at_zv_p
10806 /* When first_changed_pos is the end of a continued line,
10807 row is not unchanged because it may be no longer
10809 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
10810 && row
->continued_p
))
10813 /* Stop if last visible row. */
10814 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
10824 /* Find the first glyph row in the current matrix of W that is not
10825 affected by changes at the end of current_buffer since the last
10826 time the window was redisplayed. Return in *DELTA the number of
10827 chars by which buffer positions in unchanged text at the end of
10828 current_buffer must be adjusted. Return in *DELTA_BYTES the
10829 corresponding number of bytes. Value is null if no such row
10830 exists, i.e. all rows are affected by changes. */
10832 static struct glyph_row
*
10833 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
10835 int *delta
, *delta_bytes
;
10837 struct glyph_row
*row
;
10838 struct glyph_row
*row_found
= NULL
;
10840 *delta
= *delta_bytes
= 0;
10842 /* Display must not have been paused, otherwise the current matrix
10843 is not up to date. */
10844 if (NILP (w
->window_end_valid
))
10847 /* A value of window_end_pos >= END_UNCHANGED means that the window
10848 end is in the range of changed text. If so, there is no
10849 unchanged row at the end of W's current matrix. */
10850 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
10853 /* Set row to the last row in W's current matrix displaying text. */
10854 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
10856 /* If matrix is entirely empty, no unchanged row exists. */
10857 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
10859 /* The value of row is the last glyph row in the matrix having a
10860 meaningful buffer position in it. The end position of row
10861 corresponds to window_end_pos. This allows us to translate
10862 buffer positions in the current matrix to current buffer
10863 positions for characters not in changed text. */
10864 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
10865 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
10866 int last_unchanged_pos
, last_unchanged_pos_old
;
10867 struct glyph_row
*first_text_row
10868 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
10870 *delta
= Z
- Z_old
;
10871 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
10873 /* Set last_unchanged_pos to the buffer position of the last
10874 character in the buffer that has not been changed. Z is the
10875 index + 1 of the last byte in current_buffer, i.e. by
10876 subtracting end_unchanged we get the index of the last
10877 unchanged character, and we have to add BEG to get its buffer
10879 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
10880 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
10882 /* Search backward from ROW for a row displaying a line that
10883 starts at a minimum position >= last_unchanged_pos_old. */
10884 for (; row
> first_text_row
; --row
)
10886 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
10889 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
10894 if (row_found
&& !MATRIX_ROW_DISPLAYS_TEXT_P (row_found
))
10901 /* Make sure that glyph rows in the current matrix of window W
10902 reference the same glyph memory as corresponding rows in the
10903 frame's frame matrix. This function is called after scrolling W's
10904 current matrix on a terminal frame in try_window_id and
10905 try_window_reusing_current_matrix. */
10908 sync_frame_with_window_matrix_rows (w
)
10911 struct frame
*f
= XFRAME (w
->frame
);
10912 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
10914 /* Preconditions: W must be a leaf window and full-width. Its frame
10915 must have a frame matrix. */
10916 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
10917 xassert (WINDOW_FULL_WIDTH_P (w
));
10918 xassert (!FRAME_WINDOW_P (f
));
10920 /* If W is a full-width window, glyph pointers in W's current matrix
10921 have, by definition, to be the same as glyph pointers in the
10922 corresponding frame matrix. */
10923 window_row
= w
->current_matrix
->rows
;
10924 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
10925 frame_row
= f
->current_matrix
->rows
+ XFASTINT (w
->top
);
10926 while (window_row
< window_row_end
)
10930 for (area
= LEFT_MARGIN_AREA
; area
<= LAST_AREA
; ++area
)
10931 frame_row
->glyphs
[area
] = window_row
->glyphs
[area
];
10933 /* Disable frame rows whose corresponding window rows have
10934 been disabled in try_window_id. */
10935 if (!window_row
->enabled_p
)
10936 frame_row
->enabled_p
= 0;
10938 ++window_row
, ++frame_row
;
10943 /* Find the glyph row in window W containing CHARPOS. Consider all
10944 rows between START and END (not inclusive). END null means search
10945 all rows to the end of the display area of W. Value is the row
10946 containing CHARPOS or null. */
10948 static struct glyph_row
*
10949 row_containing_pos (w
, charpos
, start
, end
)
10952 struct glyph_row
*start
, *end
;
10954 struct glyph_row
*row
= start
;
10957 /* If we happen to start on a header-line, skip that. */
10958 if (row
->mode_line_p
)
10961 if ((end
&& row
>= end
) || !row
->enabled_p
)
10964 last_y
= window_text_bottom_y (w
);
10966 while ((end
== NULL
|| row
< end
)
10967 && (MATRIX_ROW_END_CHARPOS (row
) < charpos
10968 /* The end position of a row equals the start
10969 position of the next row. If CHARPOS is there, we
10970 would rather display it in the next line, except
10971 when this line ends in ZV. */
10972 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
10973 && (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)
10974 || !row
->ends_at_zv_p
)))
10975 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
10978 /* Give up if CHARPOS not found. */
10979 if ((end
&& row
>= end
)
10980 || charpos
< MATRIX_ROW_START_CHARPOS (row
)
10981 || charpos
> MATRIX_ROW_END_CHARPOS (row
))
10988 /* Try to redisplay window W by reusing its existing display. W's
10989 current matrix must be up to date when this function is called,
10990 i.e. window_end_valid must not be nil.
10994 1 if display has been updated
10995 0 if otherwise unsuccessful
10996 -1 if redisplay with same window start is known not to succeed
10998 The following steps are performed:
11000 1. Find the last row in the current matrix of W that is not
11001 affected by changes at the start of current_buffer. If no such row
11004 2. Find the first row in W's current matrix that is not affected by
11005 changes at the end of current_buffer. Maybe there is no such row.
11007 3. Display lines beginning with the row + 1 found in step 1 to the
11008 row found in step 2 or, if step 2 didn't find a row, to the end of
11011 4. If cursor is not known to appear on the window, give up.
11013 5. If display stopped at the row found in step 2, scroll the
11014 display and current matrix as needed.
11016 6. Maybe display some lines at the end of W, if we must. This can
11017 happen under various circumstances, like a partially visible line
11018 becoming fully visible, or because newly displayed lines are displayed
11019 in smaller font sizes.
11021 7. Update W's window end information. */
11023 /* Check that window end is what we expect it to be. */
11029 struct frame
*f
= XFRAME (w
->frame
);
11030 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
11031 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
11032 struct glyph_row
*last_unchanged_at_beg_row
;
11033 struct glyph_row
*first_unchanged_at_end_row
;
11034 struct glyph_row
*row
;
11035 struct glyph_row
*bottom_row
;
11038 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
11039 struct text_pos start_pos
;
11041 int first_unchanged_at_end_vpos
= 0;
11042 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
11043 struct text_pos start
;
11045 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
11047 /* Check pre-conditions. Window end must be valid, otherwise
11048 the current matrix would not be up to date. */
11049 xassert (!NILP (w
->window_end_valid
));
11050 xassert (FRAME_WINDOW_P (XFRAME (w
->frame
))
11051 || (line_ins_del_ok
&& WINDOW_FULL_WIDTH_P (w
)));
11053 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
11054 only if buffer has really changed. The reason is that the gap is
11055 initially at Z for freshly visited files. The code below would
11056 set end_unchanged to 0 in that case. */
11057 if (MODIFF
> SAVE_MODIFF
11058 /* This seems to happen sometimes after saving a buffer. */
11059 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
11061 if (GPT
- BEG
< BEG_UNCHANGED
)
11062 BEG_UNCHANGED
= GPT
- BEG
;
11063 if (Z
- GPT
< END_UNCHANGED
)
11064 END_UNCHANGED
= Z
- GPT
;
11067 /* If window starts after a line end, and the last change is in
11068 front of that newline, then changes don't affect the display.
11069 This case happens with stealth-fontification. Note that although
11070 the display is unchanged, glyph positions in the matrix have to
11071 be adjusted, of course. */
11072 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
11073 if (CHARPOS (start
) > BEGV
11074 && Z
- END_UNCHANGED
< CHARPOS (start
) - 1
11075 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n'
11076 && PT
< MATRIX_ROW_END_CHARPOS (row
))
11078 struct glyph_row
*r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
11079 int delta
= CHARPOS (start
) - MATRIX_ROW_START_CHARPOS (r0
);
11083 struct glyph_row
*r1
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
11084 int delta_bytes
= BYTEPOS (start
) - MATRIX_ROW_START_BYTEPOS (r0
);
11086 increment_matrix_positions (w
->current_matrix
,
11087 MATRIX_ROW_VPOS (r0
, current_matrix
),
11088 MATRIX_ROW_VPOS (r1
, current_matrix
),
11089 delta
, delta_bytes
);
11092 #if 0 /* If changes are all in front of the window start, the
11093 distance of the last displayed glyph from Z hasn't
11096 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
11097 w
->window_end_bytepos
11098 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
11101 row
= row_containing_pos (w
, PT
, r0
, NULL
);
11105 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11109 /* Return quickly if changes are all below what is displayed in the
11110 window, and if PT is in the window. */
11111 if (BEG_UNCHANGED
> MATRIX_ROW_END_CHARPOS (row
)
11112 && PT
< MATRIX_ROW_END_CHARPOS (row
))
11114 /* We have to update window end positions because the buffer's
11115 size has changed. */
11117 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
11118 w
->window_end_bytepos
11119 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
11121 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
11122 row
= row_containing_pos (w
, PT
, row
, NULL
);
11123 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11127 /* Check that window start agrees with the start of the first glyph
11128 row in its current matrix. Check this after we know the window
11129 start is not in changed text, otherwise positions would not be
11131 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
11132 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
11135 /* Compute the position at which we have to start displaying new
11136 lines. Some of the lines at the top of the window might be
11137 reusable because they are not displaying changed text. Find the
11138 last row in W's current matrix not affected by changes at the
11139 start of current_buffer. Value is null if changes start in the
11140 first line of window. */
11141 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
11142 if (last_unchanged_at_beg_row
)
11144 /* Avoid starting to display in the moddle of a character, a TAB
11145 for instance. This is easier than to set up the iterator
11146 exactly, and it's not a frequent case, so the additional
11147 effort wouldn't really pay off. */
11148 while (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
11149 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
11150 --last_unchanged_at_beg_row
;
11152 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
11155 init_to_row_end (&it
, w
, last_unchanged_at_beg_row
);
11156 start_pos
= it
.current
.pos
;
11158 /* Start displaying new lines in the desired matrix at the same
11159 vpos we would use in the current matrix, i.e. below
11160 last_unchanged_at_beg_row. */
11161 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
11163 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
11164 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
11166 xassert (it
.hpos
== 0 && it
.current_x
== 0);
11170 /* There are no reusable lines at the start of the window.
11171 Start displaying in the first line. */
11172 start_display (&it
, w
, start
);
11173 start_pos
= it
.current
.pos
;
11176 /* Find the first row that is not affected by changes at the end of
11177 the buffer. Value will be null if there is no unchanged row, in
11178 which case we must redisplay to the end of the window. delta
11179 will be set to the value by which buffer positions beginning with
11180 first_unchanged_at_end_row have to be adjusted due to text
11182 first_unchanged_at_end_row
11183 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
11184 IF_DEBUG (debug_delta
= delta
);
11185 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
11187 /* Set stop_pos to the buffer position up to which we will have to
11188 display new lines. If first_unchanged_at_end_row != NULL, this
11189 is the buffer position of the start of the line displayed in that
11190 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
11191 that we don't stop at a buffer position. */
11193 if (first_unchanged_at_end_row
)
11195 xassert (last_unchanged_at_beg_row
== NULL
11196 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
11198 /* If this is a continuation line, move forward to the next one
11199 that isn't. Changes in lines above affect this line.
11200 Caution: this may move first_unchanged_at_end_row to a row
11201 not displaying text. */
11202 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
11203 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
11204 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
11205 < it
.last_visible_y
))
11206 ++first_unchanged_at_end_row
;
11208 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
11209 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
11210 >= it
.last_visible_y
))
11211 first_unchanged_at_end_row
= NULL
;
11214 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
11216 first_unchanged_at_end_vpos
11217 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
11218 xassert (stop_pos
>= Z
- END_UNCHANGED
);
11221 else if (last_unchanged_at_beg_row
== NULL
)
11227 /* Either there is no unchanged row at the end, or the one we have
11228 now displays text. This is a necessary condition for the window
11229 end pos calculation at the end of this function. */
11230 xassert (first_unchanged_at_end_row
== NULL
11231 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
11233 debug_last_unchanged_at_beg_vpos
11234 = (last_unchanged_at_beg_row
11235 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
11237 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
11239 #endif /* GLYPH_DEBUG != 0 */
11242 /* Display new lines. Set last_text_row to the last new line
11243 displayed which has text on it, i.e. might end up as being the
11244 line where the window_end_vpos is. */
11245 w
->cursor
.vpos
= -1;
11246 last_text_row
= NULL
;
11247 overlay_arrow_seen
= 0;
11248 while (it
.current_y
< it
.last_visible_y
11249 && !fonts_changed_p
11250 && (first_unchanged_at_end_row
== NULL
11251 || IT_CHARPOS (it
) < stop_pos
))
11253 if (display_line (&it
))
11254 last_text_row
= it
.glyph_row
- 1;
11257 if (fonts_changed_p
)
11261 /* Compute differences in buffer positions, y-positions etc. for
11262 lines reused at the bottom of the window. Compute what we can
11264 if (first_unchanged_at_end_row
11265 /* No lines reused because we displayed everything up to the
11266 bottom of the window. */
11267 && it
.current_y
< it
.last_visible_y
)
11270 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
11272 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
11273 run
.current_y
= first_unchanged_at_end_row
->y
;
11274 run
.desired_y
= run
.current_y
+ dy
;
11275 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
11279 delta
= dvpos
= dy
= run
.current_y
= run
.desired_y
= run
.height
= 0;
11280 first_unchanged_at_end_row
= NULL
;
11282 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
11285 /* Find the cursor if not already found. We have to decide whether
11286 PT will appear on this window (it sometimes doesn't, but this is
11287 not a very frequent case.) This decision has to be made before
11288 the current matrix is altered. A value of cursor.vpos < 0 means
11289 that PT is either in one of the lines beginning at
11290 first_unchanged_at_end_row or below the window. Don't care for
11291 lines that might be displayed later at the window end; as
11292 mentioned, this is not a frequent case. */
11293 if (w
->cursor
.vpos
< 0)
11295 /* Cursor in unchanged rows at the top? */
11296 if (PT
< CHARPOS (start_pos
)
11297 && last_unchanged_at_beg_row
)
11299 row
= row_containing_pos (w
, PT
,
11300 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
11301 last_unchanged_at_beg_row
+ 1);
11303 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11306 /* Start from first_unchanged_at_end_row looking for PT. */
11307 else if (first_unchanged_at_end_row
)
11309 row
= row_containing_pos (w
, PT
- delta
,
11310 first_unchanged_at_end_row
, NULL
);
11312 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
11313 delta_bytes
, dy
, dvpos
);
11316 /* Give up if cursor was not found. */
11317 if (w
->cursor
.vpos
< 0)
11319 clear_glyph_matrix (w
->desired_matrix
);
11324 /* Don't let the cursor end in the scroll margins. */
11326 int this_scroll_margin
, cursor_height
;
11328 this_scroll_margin
= max (0, scroll_margin
);
11329 this_scroll_margin
= min (this_scroll_margin
,
11330 XFASTINT (w
->height
) / 4);
11331 this_scroll_margin
*= CANON_Y_UNIT (it
.f
);
11332 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
11334 if ((w
->cursor
.y
< this_scroll_margin
11335 && CHARPOS (start
) > BEGV
)
11336 /* Don't take scroll margin into account at the bottom because
11337 old redisplay didn't do it either. */
11338 || w
->cursor
.y
+ cursor_height
> it
.last_visible_y
)
11340 w
->cursor
.vpos
= -1;
11341 clear_glyph_matrix (w
->desired_matrix
);
11346 /* Scroll the display. Do it before changing the current matrix so
11347 that xterm.c doesn't get confused about where the cursor glyph is
11349 if (dy
&& run
.height
)
11353 if (FRAME_WINDOW_P (f
))
11355 rif
->update_window_begin_hook (w
);
11356 rif
->clear_mouse_face (w
);
11357 rif
->scroll_run_hook (w
, &run
);
11358 rif
->update_window_end_hook (w
, 0, 0);
11362 /* Terminal frame. In this case, dvpos gives the number of
11363 lines to scroll by; dvpos < 0 means scroll up. */
11364 int first_unchanged_at_end_vpos
11365 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
11366 int from
= XFASTINT (w
->top
) + first_unchanged_at_end_vpos
;
11367 int end
= XFASTINT (w
->top
) + window_internal_height (w
);
11369 /* Perform the operation on the screen. */
11372 /* Scroll last_unchanged_at_beg_row to the end of the
11373 window down dvpos lines. */
11374 set_terminal_window (end
);
11376 /* On dumb terminals delete dvpos lines at the end
11377 before inserting dvpos empty lines. */
11378 if (!scroll_region_ok
)
11379 ins_del_lines (end
- dvpos
, -dvpos
);
11381 /* Insert dvpos empty lines in front of
11382 last_unchanged_at_beg_row. */
11383 ins_del_lines (from
, dvpos
);
11385 else if (dvpos
< 0)
11387 /* Scroll up last_unchanged_at_beg_vpos to the end of
11388 the window to last_unchanged_at_beg_vpos - |dvpos|. */
11389 set_terminal_window (end
);
11391 /* Delete dvpos lines in front of
11392 last_unchanged_at_beg_vpos. ins_del_lines will set
11393 the cursor to the given vpos and emit |dvpos| delete
11395 ins_del_lines (from
+ dvpos
, dvpos
);
11397 /* On a dumb terminal insert dvpos empty lines at the
11399 if (!scroll_region_ok
)
11400 ins_del_lines (end
+ dvpos
, -dvpos
);
11403 set_terminal_window (0);
11409 /* Shift reused rows of the current matrix to the right position.
11410 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
11412 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
11413 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
11416 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
11417 bottom_vpos
, dvpos
);
11418 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
11421 else if (dvpos
> 0)
11423 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
11424 bottom_vpos
, dvpos
);
11425 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
11426 first_unchanged_at_end_vpos
+ dvpos
, 0);
11429 /* For frame-based redisplay, make sure that current frame and window
11430 matrix are in sync with respect to glyph memory. */
11431 if (!FRAME_WINDOW_P (f
))
11432 sync_frame_with_window_matrix_rows (w
);
11434 /* Adjust buffer positions in reused rows. */
11436 increment_matrix_positions (current_matrix
,
11437 first_unchanged_at_end_vpos
+ dvpos
,
11438 bottom_vpos
, delta
, delta_bytes
);
11440 /* Adjust Y positions. */
11442 shift_glyph_matrix (w
, current_matrix
,
11443 first_unchanged_at_end_vpos
+ dvpos
,
11446 if (first_unchanged_at_end_row
)
11447 first_unchanged_at_end_row
+= dvpos
;
11449 /* If scrolling up, there may be some lines to display at the end of
11451 last_text_row_at_end
= NULL
;
11454 /* Set last_row to the glyph row in the current matrix where the
11455 window end line is found. It has been moved up or down in
11456 the matrix by dvpos. */
11457 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
11458 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
11460 /* If last_row is the window end line, it should display text. */
11461 xassert (last_row
->displays_text_p
);
11463 /* If window end line was partially visible before, begin
11464 displaying at that line. Otherwise begin displaying with the
11465 line following it. */
11466 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
11468 init_to_row_start (&it
, w
, last_row
);
11469 it
.vpos
= last_vpos
;
11470 it
.current_y
= last_row
->y
;
11474 init_to_row_end (&it
, w
, last_row
);
11475 it
.vpos
= 1 + last_vpos
;
11476 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
11480 /* We may start in a continuation line. If so, we have to get
11481 the right continuation_lines_width and current_x. */
11482 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
11483 it
.hpos
= it
.current_x
= 0;
11485 /* Display the rest of the lines at the window end. */
11486 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
11487 while (it
.current_y
< it
.last_visible_y
11488 && !fonts_changed_p
)
11490 /* Is it always sure that the display agrees with lines in
11491 the current matrix? I don't think so, so we mark rows
11492 displayed invalid in the current matrix by setting their
11493 enabled_p flag to zero. */
11494 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
11495 if (display_line (&it
))
11496 last_text_row_at_end
= it
.glyph_row
- 1;
11500 /* Update window_end_pos and window_end_vpos. */
11501 if (first_unchanged_at_end_row
11502 && first_unchanged_at_end_row
->y
< it
.last_visible_y
11503 && !last_text_row_at_end
)
11505 /* Window end line if one of the preserved rows from the current
11506 matrix. Set row to the last row displaying text in current
11507 matrix starting at first_unchanged_at_end_row, after
11509 xassert (first_unchanged_at_end_row
->displays_text_p
);
11510 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
11511 first_unchanged_at_end_row
);
11512 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
11514 XSETFASTINT (w
->window_end_pos
, Z
- MATRIX_ROW_END_CHARPOS (row
));
11515 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
11516 XSETFASTINT (w
->window_end_vpos
,
11517 MATRIX_ROW_VPOS (row
, w
->current_matrix
));
11519 else if (last_text_row_at_end
)
11521 XSETFASTINT (w
->window_end_pos
,
11522 Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
11523 w
->window_end_bytepos
11524 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
11525 XSETFASTINT (w
->window_end_vpos
,
11526 MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
11528 else if (last_text_row
)
11530 /* We have displayed either to the end of the window or at the
11531 end of the window, i.e. the last row with text is to be found
11532 in the desired matrix. */
11533 XSETFASTINT (w
->window_end_pos
,
11534 Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
11535 w
->window_end_bytepos
11536 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
11537 XSETFASTINT (w
->window_end_vpos
,
11538 MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
11540 else if (first_unchanged_at_end_row
== NULL
11541 && last_text_row
== NULL
11542 && last_text_row_at_end
== NULL
)
11544 /* Displayed to end of window, but no line containing text was
11545 displayed. Lines were deleted at the end of the window. */
11547 int header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
11549 for (vpos
= XFASTINT (w
->window_end_vpos
); vpos
> 0; --vpos
)
11550 if ((w
->desired_matrix
->rows
[vpos
+ header_line_p
].enabled_p
11551 && w
->desired_matrix
->rows
[vpos
+ header_line_p
].displays_text_p
)
11552 || (!w
->desired_matrix
->rows
[vpos
+ header_line_p
].enabled_p
11553 && w
->current_matrix
->rows
[vpos
+ header_line_p
].displays_text_p
))
11556 w
->window_end_vpos
= make_number (vpos
);
11561 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
11562 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
11564 /* Record that display has not been completed. */
11565 w
->window_end_valid
= Qnil
;
11566 w
->desired_matrix
->no_scrolling_p
= 1;
11572 /***********************************************************************
11573 More debugging support
11574 ***********************************************************************/
11578 void dump_glyph_row
P_ ((struct glyph_matrix
*, int, int));
11579 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
11580 void dump_glyph
P_ ((struct glyph_row
*, struct glyph
*, int));
11583 /* Dump the contents of glyph matrix MATRIX on stderr.
11585 GLYPHS 0 means don't show glyph contents.
11586 GLYPHS 1 means show glyphs in short form
11587 GLYPHS > 1 means show glyphs in long form. */
11590 dump_glyph_matrix (matrix
, glyphs
)
11591 struct glyph_matrix
*matrix
;
11595 for (i
= 0; i
< matrix
->nrows
; ++i
)
11596 dump_glyph_row (matrix
, i
, glyphs
);
11600 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
11601 the glyph row and area where the glyph comes from. */
11604 dump_glyph (row
, glyph
, area
)
11605 struct glyph_row
*row
;
11606 struct glyph
*glyph
;
11609 if (glyph
->type
== CHAR_GLYPH
)
11612 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
11613 glyph
- row
->glyphs
[TEXT_AREA
],
11616 (BUFFERP (glyph
->object
)
11618 : (STRINGP (glyph
->object
)
11621 glyph
->pixel_width
,
11623 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
11627 glyph
->left_box_line_p
,
11628 glyph
->right_box_line_p
);
11630 else if (glyph
->type
== STRETCH_GLYPH
)
11633 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
11634 glyph
- row
->glyphs
[TEXT_AREA
],
11637 (BUFFERP (glyph
->object
)
11639 : (STRINGP (glyph
->object
)
11642 glyph
->pixel_width
,
11646 glyph
->left_box_line_p
,
11647 glyph
->right_box_line_p
);
11649 else if (glyph
->type
== IMAGE_GLYPH
)
11652 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
11653 glyph
- row
->glyphs
[TEXT_AREA
],
11656 (BUFFERP (glyph
->object
)
11658 : (STRINGP (glyph
->object
)
11661 glyph
->pixel_width
,
11665 glyph
->left_box_line_p
,
11666 glyph
->right_box_line_p
);
11671 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
11672 GLYPHS 0 means don't show glyph contents.
11673 GLYPHS 1 means show glyphs in short form
11674 GLYPHS > 1 means show glyphs in long form. */
11677 dump_glyph_row (matrix
, vpos
, glyphs
)
11678 struct glyph_matrix
*matrix
;
11681 struct glyph_row
*row
;
11683 if (vpos
< 0 || vpos
>= matrix
->nrows
)
11686 row
= MATRIX_ROW (matrix
, vpos
);
11690 fprintf (stderr
, "Row Start End Used oEI><O\\CTZFesm X Y W H V A P\n");
11691 fprintf (stderr
, "=======================================================================\n");
11693 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d\
11694 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
11695 row
- matrix
->rows
,
11696 MATRIX_ROW_START_CHARPOS (row
),
11697 MATRIX_ROW_END_CHARPOS (row
),
11698 row
->used
[TEXT_AREA
],
11699 row
->contains_overlapping_glyphs_p
,
11702 row
->truncated_on_left_p
,
11703 row
->truncated_on_right_p
,
11704 row
->overlay_arrow_p
,
11706 MATRIX_ROW_CONTINUATION_LINE_P (row
),
11707 row
->displays_text_p
,
11710 row
->ends_in_middle_of_char_p
,
11711 row
->starts_in_middle_of_char_p
,
11717 row
->visible_height
,
11720 fprintf (stderr
, "%9d %5d\n", row
->start
.overlay_string_index
,
11721 row
->end
.overlay_string_index
);
11722 fprintf (stderr
, "%9d %5d\n",
11723 CHARPOS (row
->start
.string_pos
),
11724 CHARPOS (row
->end
.string_pos
));
11725 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
11726 row
->end
.dpvec_index
);
11733 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
11735 struct glyph
*glyph
, *glyph_end
;
11736 glyph
= row
->glyphs
[area
];
11737 glyph_end
= glyph
+ row
->used
[area
];
11739 /* Glyph for a line end in text. */
11740 if (glyph
== glyph_end
&& glyph
->charpos
> 0)
11743 if (glyph
< glyph_end
)
11744 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
11746 for (; glyph
< glyph_end
; ++glyph
)
11747 dump_glyph (row
, glyph
, area
);
11750 else if (glyphs
== 1)
11754 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
11756 char *s
= (char *) alloca (row
->used
[area
] + 1);
11759 for (i
= 0; i
< row
->used
[area
]; ++i
)
11761 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
11762 if (glyph
->type
== CHAR_GLYPH
11763 && glyph
->u
.ch
< 0x80
11764 && glyph
->u
.ch
>= ' ')
11765 s
[i
] = glyph
->u
.ch
;
11771 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
11777 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
11778 Sdump_glyph_matrix
, 0, 1, "p",
11779 "Dump the current matrix of the selected window to stderr.\n\
11780 Shows contents of glyph row structures. With non-nil\n\
11781 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show\n\
11782 glyphs in short form, otherwise show glyphs in long form.")
11784 Lisp_Object glyphs
;
11786 struct window
*w
= XWINDOW (selected_window
);
11787 struct buffer
*buffer
= XBUFFER (w
->buffer
);
11789 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
11790 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
11791 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
11792 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
11793 fprintf (stderr
, "=============================================\n");
11794 dump_glyph_matrix (w
->current_matrix
,
11795 NILP (glyphs
) ? 0 : XINT (glyphs
));
11800 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
11801 "Dump glyph row ROW to stderr.\n\
11802 GLYPH 0 means don't dump glyphs.\n\
11803 GLYPH 1 means dump glyphs in short form.\n\
11804 GLYPH > 1 or omitted means dump glyphs in long form.")
11806 Lisp_Object row
, glyphs
;
11808 CHECK_NUMBER (row
, 0);
11809 dump_glyph_row (XWINDOW (selected_window
)->current_matrix
,
11811 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
11816 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
11817 "Dump glyph row ROW of the tool-bar of the current frame to stderr.\n\
11818 GLYPH 0 means don't dump glyphs.\n\
11819 GLYPH 1 means dump glyphs in short form.\n\
11820 GLYPH > 1 or omitted means dump glyphs in long form.")
11822 Lisp_Object row
, glyphs
;
11824 struct frame
*sf
= SELECTED_FRAME ();
11825 struct glyph_matrix
*m
= (XWINDOW (sf
->tool_bar_window
)->current_matrix
);
11826 dump_glyph_row (m
, XINT (row
), INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
11831 DEFUN ("trace-redisplay-toggle", Ftrace_redisplay_toggle
,
11832 Strace_redisplay_toggle
, 0, 0, "",
11833 "Toggle tracing of redisplay.")
11836 trace_redisplay_p
= !trace_redisplay_p
;
11841 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, 1, "",
11842 "Print STRING to stderr.")
11844 Lisp_Object string
;
11846 CHECK_STRING (string
, 0);
11847 fprintf (stderr
, "%s", XSTRING (string
)->data
);
11851 #endif /* GLYPH_DEBUG */
11855 /***********************************************************************
11856 Building Desired Matrix Rows
11857 ***********************************************************************/
11859 /* Return a temporary glyph row holding the glyphs of an overlay
11860 arrow. Only used for non-window-redisplay windows. */
11862 static struct glyph_row
*
11863 get_overlay_arrow_glyph_row (w
)
11866 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
11867 struct buffer
*buffer
= XBUFFER (w
->buffer
);
11868 struct buffer
*old
= current_buffer
;
11869 unsigned char *arrow_string
= XSTRING (Voverlay_arrow_string
)->data
;
11870 int arrow_len
= XSTRING (Voverlay_arrow_string
)->size
;
11871 unsigned char *arrow_end
= arrow_string
+ arrow_len
;
11875 int n_glyphs_before
;
11877 set_buffer_temp (buffer
);
11878 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
11879 it
.glyph_row
->used
[TEXT_AREA
] = 0;
11880 SET_TEXT_POS (it
.position
, 0, 0);
11882 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
11884 while (p
< arrow_end
)
11886 Lisp_Object face
, ilisp
;
11888 /* Get the next character. */
11890 it
.c
= string_char_and_length (p
, arrow_len
, &it
.len
);
11892 it
.c
= *p
, it
.len
= 1;
11895 /* Get its face. */
11896 XSETFASTINT (ilisp
, p
- arrow_string
);
11897 face
= Fget_text_property (ilisp
, Qface
, Voverlay_arrow_string
);
11898 it
.face_id
= compute_char_face (f
, it
.c
, face
);
11900 /* Compute its width, get its glyphs. */
11901 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
11902 SET_TEXT_POS (it
.position
, -1, -1);
11903 PRODUCE_GLYPHS (&it
);
11905 /* If this character doesn't fit any more in the line, we have
11906 to remove some glyphs. */
11907 if (it
.current_x
> it
.last_visible_x
)
11909 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
11914 set_buffer_temp (old
);
11915 return it
.glyph_row
;
11919 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
11920 glyphs are only inserted for terminal frames since we can't really
11921 win with truncation glyphs when partially visible glyphs are
11922 involved. Which glyphs to insert is determined by
11923 produce_special_glyphs. */
11926 insert_left_trunc_glyphs (it
)
11929 struct it truncate_it
;
11930 struct glyph
*from
, *end
, *to
, *toend
;
11932 xassert (!FRAME_WINDOW_P (it
->f
));
11934 /* Get the truncation glyphs. */
11936 truncate_it
.current_x
= 0;
11937 truncate_it
.face_id
= DEFAULT_FACE_ID
;
11938 truncate_it
.glyph_row
= &scratch_glyph_row
;
11939 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
11940 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
11941 truncate_it
.object
= make_number (0);
11942 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
11944 /* Overwrite glyphs from IT with truncation glyphs. */
11945 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
11946 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
11947 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
11948 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
11953 /* There may be padding glyphs left over. Overwrite them too. */
11954 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
11956 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
11962 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
11966 /* Compute the pixel height and width of IT->glyph_row.
11968 Most of the time, ascent and height of a display line will be equal
11969 to the max_ascent and max_height values of the display iterator
11970 structure. This is not the case if
11972 1. We hit ZV without displaying anything. In this case, max_ascent
11973 and max_height will be zero.
11975 2. We have some glyphs that don't contribute to the line height.
11976 (The glyph row flag contributes_to_line_height_p is for future
11977 pixmap extensions).
11979 The first case is easily covered by using default values because in
11980 these cases, the line height does not really matter, except that it
11981 must not be zero. */
11984 compute_line_metrics (it
)
11987 struct glyph_row
*row
= it
->glyph_row
;
11990 if (FRAME_WINDOW_P (it
->f
))
11992 int i
, header_line_height
;
11994 /* The line may consist of one space only, that was added to
11995 place the cursor on it. If so, the row's height hasn't been
11997 if (row
->height
== 0)
11999 if (it
->max_ascent
+ it
->max_descent
== 0)
12000 it
->max_descent
= it
->max_phys_descent
= CANON_Y_UNIT (it
->f
);
12001 row
->ascent
= it
->max_ascent
;
12002 row
->height
= it
->max_ascent
+ it
->max_descent
;
12003 row
->phys_ascent
= it
->max_phys_ascent
;
12004 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
12007 /* Compute the width of this line. */
12008 row
->pixel_width
= row
->x
;
12009 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
12010 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12012 xassert (row
->pixel_width
>= 0);
12013 xassert (row
->ascent
>= 0 && row
->height
> 0);
12015 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
12016 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
12018 /* If first line's physical ascent is larger than its logical
12019 ascent, use the physical ascent, and make the row taller.
12020 This makes accented characters fully visible. */
12021 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
12022 && row
->phys_ascent
> row
->ascent
)
12024 row
->height
+= row
->phys_ascent
- row
->ascent
;
12025 row
->ascent
= row
->phys_ascent
;
12028 /* Compute how much of the line is visible. */
12029 row
->visible_height
= row
->height
;
12031 header_line_height
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (it
->w
);
12032 if (row
->y
< header_line_height
)
12033 row
->visible_height
-= header_line_height
- row
->y
;
12036 int max_y
= WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE (it
->w
);
12037 if (row
->y
+ row
->height
> max_y
)
12038 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
12043 row
->pixel_width
= row
->used
[TEXT_AREA
];
12044 row
->ascent
= row
->phys_ascent
= 0;
12045 row
->height
= row
->phys_height
= row
->visible_height
= 1;
12048 /* Compute a hash code for this row. */
12050 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
12051 for (i
= 0; i
< row
->used
[area
]; ++i
)
12052 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
12053 + row
->glyphs
[area
][i
].u
.val
12054 + row
->glyphs
[area
][i
].face_id
12055 + row
->glyphs
[area
][i
].padding_p
12056 + (row
->glyphs
[area
][i
].type
<< 2));
12058 it
->max_ascent
= it
->max_descent
= 0;
12059 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
12063 /* Append one space to the glyph row of iterator IT if doing a
12064 window-based redisplay. DEFAULT_FACE_P non-zero means let the
12065 space have the default face, otherwise let it have the same face as
12066 IT->face_id. Value is non-zero if a space was added.
12068 This function is called to make sure that there is always one glyph
12069 at the end of a glyph row that the cursor can be set on under
12070 window-systems. (If there weren't such a glyph we would not know
12071 how wide and tall a box cursor should be displayed).
12073 At the same time this space let's a nicely handle clearing to the
12074 end of the line if the row ends in italic text. */
12077 append_space (it
, default_face_p
)
12079 int default_face_p
;
12081 if (FRAME_WINDOW_P (it
->f
))
12083 int n
= it
->glyph_row
->used
[TEXT_AREA
];
12085 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
12086 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
12088 /* Save some values that must not be changed.
12089 Must save IT->c and IT->len because otherwise
12090 ITERATOR_AT_END_P wouldn't work anymore after
12091 append_space has been called. */
12092 enum display_element_type saved_what
= it
->what
;
12093 int saved_c
= it
->c
, saved_len
= it
->len
;
12094 int saved_x
= it
->current_x
;
12095 int saved_face_id
= it
->face_id
;
12096 struct text_pos saved_pos
;
12097 Lisp_Object saved_object
;
12100 saved_object
= it
->object
;
12101 saved_pos
= it
->position
;
12103 it
->what
= IT_CHARACTER
;
12104 bzero (&it
->position
, sizeof it
->position
);
12105 it
->object
= make_number (0);
12109 if (default_face_p
)
12110 it
->face_id
= DEFAULT_FACE_ID
;
12111 else if (it
->face_before_selective_p
)
12112 it
->face_id
= it
->saved_face_id
;
12113 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
12114 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0);
12116 PRODUCE_GLYPHS (it
);
12118 it
->current_x
= saved_x
;
12119 it
->object
= saved_object
;
12120 it
->position
= saved_pos
;
12121 it
->what
= saved_what
;
12122 it
->face_id
= saved_face_id
;
12123 it
->len
= saved_len
;
12133 /* Extend the face of the last glyph in the text area of IT->glyph_row
12134 to the end of the display line. Called from display_line.
12135 If the glyph row is empty, add a space glyph to it so that we
12136 know the face to draw. Set the glyph row flag fill_line_p. */
12139 extend_face_to_end_of_line (it
)
12143 struct frame
*f
= it
->f
;
12145 /* If line is already filled, do nothing. */
12146 if (it
->current_x
>= it
->last_visible_x
)
12149 /* Face extension extends the background and box of IT->face_id
12150 to the end of the line. If the background equals the background
12151 of the frame, we don't have to do anything. */
12152 if (it
->face_before_selective_p
)
12153 face
= FACE_FROM_ID (it
->f
, it
->saved_face_id
);
12155 face
= FACE_FROM_ID (f
, it
->face_id
);
12157 if (FRAME_WINDOW_P (f
)
12158 && face
->box
== FACE_NO_BOX
12159 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
12163 /* Set the glyph row flag indicating that the face of the last glyph
12164 in the text area has to be drawn to the end of the text area. */
12165 it
->glyph_row
->fill_line_p
= 1;
12167 /* If current character of IT is not ASCII, make sure we have the
12168 ASCII face. This will be automatically undone the next time
12169 get_next_display_element returns a multibyte character. Note
12170 that the character will always be single byte in unibyte text. */
12171 if (!SINGLE_BYTE_CHAR_P (it
->c
))
12173 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0);
12176 if (FRAME_WINDOW_P (f
))
12178 /* If the row is empty, add a space with the current face of IT,
12179 so that we know which face to draw. */
12180 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
12182 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
12183 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
12184 it
->glyph_row
->used
[TEXT_AREA
] = 1;
12189 /* Save some values that must not be changed. */
12190 int saved_x
= it
->current_x
;
12191 struct text_pos saved_pos
;
12192 Lisp_Object saved_object
;
12193 enum display_element_type saved_what
= it
->what
;
12194 int saved_face_id
= it
->face_id
;
12196 saved_object
= it
->object
;
12197 saved_pos
= it
->position
;
12199 it
->what
= IT_CHARACTER
;
12200 bzero (&it
->position
, sizeof it
->position
);
12201 it
->object
= make_number (0);
12204 it
->face_id
= face
->id
;
12206 PRODUCE_GLYPHS (it
);
12208 while (it
->current_x
<= it
->last_visible_x
)
12209 PRODUCE_GLYPHS (it
);
12211 /* Don't count these blanks really. It would let us insert a left
12212 truncation glyph below and make us set the cursor on them, maybe. */
12213 it
->current_x
= saved_x
;
12214 it
->object
= saved_object
;
12215 it
->position
= saved_pos
;
12216 it
->what
= saved_what
;
12217 it
->face_id
= saved_face_id
;
12222 /* Value is non-zero if text starting at CHARPOS in current_buffer is
12223 trailing whitespace. */
12226 trailing_whitespace_p (charpos
)
12229 int bytepos
= CHAR_TO_BYTE (charpos
);
12232 while (bytepos
< ZV_BYTE
12233 && (c
= FETCH_CHAR (bytepos
),
12234 c
== ' ' || c
== '\t'))
12237 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
12239 if (bytepos
!= PT_BYTE
)
12246 /* Highlight trailing whitespace, if any, in ROW. */
12249 highlight_trailing_whitespace (f
, row
)
12251 struct glyph_row
*row
;
12253 int used
= row
->used
[TEXT_AREA
];
12257 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
12258 struct glyph
*glyph
= start
+ used
- 1;
12260 /* Skip over glyphs inserted to display the cursor at the
12261 end of a line, for extending the face of the last glyph
12262 to the end of the line on terminals, and for truncation
12263 and continuation glyphs. */
12264 while (glyph
>= start
12265 && glyph
->type
== CHAR_GLYPH
12266 && INTEGERP (glyph
->object
))
12269 /* If last glyph is a space or stretch, and it's trailing
12270 whitespace, set the face of all trailing whitespace glyphs in
12271 IT->glyph_row to `trailing-whitespace'. */
12273 && BUFFERP (glyph
->object
)
12274 && (glyph
->type
== STRETCH_GLYPH
12275 || (glyph
->type
== CHAR_GLYPH
12276 && glyph
->u
.ch
== ' '))
12277 && trailing_whitespace_p (glyph
->charpos
))
12279 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
12281 while (glyph
>= start
12282 && BUFFERP (glyph
->object
)
12283 && (glyph
->type
== STRETCH_GLYPH
12284 || (glyph
->type
== CHAR_GLYPH
12285 && glyph
->u
.ch
== ' ')))
12286 (glyph
--)->face_id
= face_id
;
12292 /* Value is non-zero if glyph row ROW in window W should be
12293 used to hold the cursor. */
12296 cursor_row_p (w
, row
)
12298 struct glyph_row
*row
;
12300 int cursor_row_p
= 1;
12302 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
12304 /* If the row ends with a newline from a string, we don't want
12305 the cursor there (if the row is continued it doesn't end in a
12307 if (CHARPOS (row
->end
.string_pos
) >= 0
12308 || MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
12309 cursor_row_p
= row
->continued_p
;
12311 /* If the row ends at ZV, display the cursor at the end of that
12312 row instead of at the start of the row below. */
12313 else if (row
->ends_at_zv_p
)
12319 return cursor_row_p
;
12323 /* Construct the glyph row IT->glyph_row in the desired matrix of
12324 IT->w from text at the current position of IT. See dispextern.h
12325 for an overview of struct it. Value is non-zero if
12326 IT->glyph_row displays text, as opposed to a line displaying ZV
12333 struct glyph_row
*row
= it
->glyph_row
;
12335 /* We always start displaying at hpos zero even if hscrolled. */
12336 xassert (it
->hpos
== 0 && it
->current_x
== 0);
12338 /* We must not display in a row that's not a text row. */
12339 xassert (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
12340 < it
->w
->desired_matrix
->nrows
);
12342 /* Is IT->w showing the region? */
12343 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
12345 /* Clear the result glyph row and enable it. */
12346 prepare_desired_row (row
);
12348 row
->y
= it
->current_y
;
12349 row
->start
= it
->current
;
12350 row
->continuation_lines_width
= it
->continuation_lines_width
;
12351 row
->displays_text_p
= 1;
12352 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
12353 it
->starts_in_middle_of_char_p
= 0;
12355 /* Arrange the overlays nicely for our purposes. Usually, we call
12356 display_line on only one line at a time, in which case this
12357 can't really hurt too much, or we call it on lines which appear
12358 one after another in the buffer, in which case all calls to
12359 recenter_overlay_lists but the first will be pretty cheap. */
12360 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
12362 /* Move over display elements that are not visible because we are
12363 hscrolled. This may stop at an x-position < IT->first_visible_x
12364 if the first glyph is partially visible or if we hit a line end. */
12365 if (it
->current_x
< it
->first_visible_x
)
12366 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
12367 MOVE_TO_POS
| MOVE_TO_X
);
12369 /* Get the initial row height. This is either the height of the
12370 text hscrolled, if there is any, or zero. */
12371 row
->ascent
= it
->max_ascent
;
12372 row
->height
= it
->max_ascent
+ it
->max_descent
;
12373 row
->phys_ascent
= it
->max_phys_ascent
;
12374 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
12376 /* Loop generating characters. The loop is left with IT on the next
12377 character to display. */
12380 int n_glyphs_before
, hpos_before
, x_before
;
12382 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
12384 /* Retrieve the next thing to display. Value is zero if end of
12386 if (!get_next_display_element (it
))
12388 /* Maybe add a space at the end of this line that is used to
12389 display the cursor there under X. Set the charpos of the
12390 first glyph of blank lines not corresponding to any text
12392 if ((append_space (it
, 1) && row
->used
[TEXT_AREA
] == 1)
12393 || row
->used
[TEXT_AREA
] == 0)
12395 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
12396 row
->displays_text_p
= 0;
12398 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
))
12399 row
->indicate_empty_line_p
= 1;
12402 it
->continuation_lines_width
= 0;
12403 row
->ends_at_zv_p
= 1;
12407 /* Now, get the metrics of what we want to display. This also
12408 generates glyphs in `row' (which is IT->glyph_row). */
12409 n_glyphs_before
= row
->used
[TEXT_AREA
];
12412 /* Remember the line height so far in case the next element doesn't
12413 fit on the line. */
12414 if (!it
->truncate_lines_p
)
12416 ascent
= it
->max_ascent
;
12417 descent
= it
->max_descent
;
12418 phys_ascent
= it
->max_phys_ascent
;
12419 phys_descent
= it
->max_phys_descent
;
12422 PRODUCE_GLYPHS (it
);
12424 /* If this display element was in marginal areas, continue with
12426 if (it
->area
!= TEXT_AREA
)
12428 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
12429 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
12430 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
12431 row
->phys_height
= max (row
->phys_height
,
12432 it
->max_phys_ascent
+ it
->max_phys_descent
);
12433 set_iterator_to_next (it
, 1);
12437 /* Does the display element fit on the line? If we truncate
12438 lines, we should draw past the right edge of the window. If
12439 we don't truncate, we want to stop so that we can display the
12440 continuation glyph before the right margin. If lines are
12441 continued, there are two possible strategies for characters
12442 resulting in more than 1 glyph (e.g. tabs): Display as many
12443 glyphs as possible in this line and leave the rest for the
12444 continuation line, or display the whole element in the next
12445 line. Original redisplay did the former, so we do it also. */
12446 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12447 hpos_before
= it
->hpos
;
12450 if (/* Not a newline. */
12452 /* Glyphs produced fit entirely in the line. */
12453 && it
->current_x
< it
->last_visible_x
)
12455 it
->hpos
+= nglyphs
;
12456 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
12457 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
12458 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
12459 row
->phys_height
= max (row
->phys_height
,
12460 it
->max_phys_ascent
+ it
->max_phys_descent
);
12461 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
12462 row
->x
= x
- it
->first_visible_x
;
12467 struct glyph
*glyph
;
12469 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
12471 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12472 new_x
= x
+ glyph
->pixel_width
;
12474 if (/* Lines are continued. */
12475 !it
->truncate_lines_p
12476 && (/* Glyph doesn't fit on the line. */
12477 new_x
> it
->last_visible_x
12478 /* Or it fits exactly on a window system frame. */
12479 || (new_x
== it
->last_visible_x
12480 && FRAME_WINDOW_P (it
->f
))))
12482 /* End of a continued line. */
12485 || (new_x
== it
->last_visible_x
12486 && FRAME_WINDOW_P (it
->f
)))
12488 /* Current glyph is the only one on the line or
12489 fits exactly on the line. We must continue
12490 the line because we can't draw the cursor
12491 after the glyph. */
12492 row
->continued_p
= 1;
12493 it
->current_x
= new_x
;
12494 it
->continuation_lines_width
+= new_x
;
12496 if (i
== nglyphs
- 1)
12497 set_iterator_to_next (it
, 1);
12499 else if (CHAR_GLYPH_PADDING_P (*glyph
)
12500 && !FRAME_WINDOW_P (it
->f
))
12502 /* A padding glyph that doesn't fit on this line.
12503 This means the whole character doesn't fit
12505 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12507 /* Fill the rest of the row with continuation
12508 glyphs like in 20.x. */
12509 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
12510 < row
->glyphs
[1 + TEXT_AREA
])
12511 produce_special_glyphs (it
, IT_CONTINUATION
);
12513 row
->continued_p
= 1;
12514 it
->current_x
= x_before
;
12515 it
->continuation_lines_width
+= x_before
;
12517 /* Restore the height to what it was before the
12518 element not fitting on the line. */
12519 it
->max_ascent
= ascent
;
12520 it
->max_descent
= descent
;
12521 it
->max_phys_ascent
= phys_ascent
;
12522 it
->max_phys_descent
= phys_descent
;
12526 /* Display element draws past the right edge of
12527 the window. Restore positions to values
12528 before the element. The next line starts
12529 with current_x before the glyph that could
12530 not be displayed, so that TAB works right. */
12531 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
12533 /* Display continuation glyphs. */
12534 if (!FRAME_WINDOW_P (it
->f
))
12535 produce_special_glyphs (it
, IT_CONTINUATION
);
12536 row
->continued_p
= 1;
12539 it
->continuation_lines_width
+= x
;
12540 if (nglyphs
> 1 && i
> 0)
12542 row
->ends_in_middle_of_char_p
= 1;
12543 it
->starts_in_middle_of_char_p
= 1;
12546 /* Restore the height to what it was before the
12547 element not fitting on the line. */
12548 it
->max_ascent
= ascent
;
12549 it
->max_descent
= descent
;
12550 it
->max_phys_ascent
= phys_ascent
;
12551 it
->max_phys_descent
= phys_descent
;
12556 else if (new_x
> it
->first_visible_x
)
12558 /* Increment number of glyphs actually displayed. */
12561 if (x
< it
->first_visible_x
)
12562 /* Glyph is partially visible, i.e. row starts at
12563 negative X position. */
12564 row
->x
= x
- it
->first_visible_x
;
12568 /* Glyph is completely off the left margin of the
12569 window. This should not happen because of the
12570 move_it_in_display_line at the start of
12576 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
12577 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
12578 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
12579 row
->phys_height
= max (row
->phys_height
,
12580 it
->max_phys_ascent
+ it
->max_phys_descent
);
12582 /* End of this display line if row is continued. */
12583 if (row
->continued_p
)
12587 /* Is this a line end? If yes, we're also done, after making
12588 sure that a non-default face is extended up to the right
12589 margin of the window. */
12590 if (ITERATOR_AT_END_OF_LINE_P (it
))
12592 int used_before
= row
->used
[TEXT_AREA
];
12594 /* Add a space at the end of the line that is used to
12595 display the cursor there. */
12596 append_space (it
, 0);
12598 /* Extend the face to the end of the line. */
12599 extend_face_to_end_of_line (it
);
12601 /* Make sure we have the position. */
12602 if (used_before
== 0)
12603 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
12605 /* Consume the line end. This skips over invisible lines. */
12606 set_iterator_to_next (it
, 1);
12607 it
->continuation_lines_width
= 0;
12611 /* Proceed with next display element. Note that this skips
12612 over lines invisible because of selective display. */
12613 set_iterator_to_next (it
, 1);
12615 /* If we truncate lines, we are done when the last displayed
12616 glyphs reach past the right margin of the window. */
12617 if (it
->truncate_lines_p
12618 && (FRAME_WINDOW_P (it
->f
)
12619 ? (it
->current_x
>= it
->last_visible_x
)
12620 : (it
->current_x
> it
->last_visible_x
)))
12622 /* Maybe add truncation glyphs. */
12623 if (!FRAME_WINDOW_P (it
->f
))
12627 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
12628 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
12631 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
12633 row
->used
[TEXT_AREA
] = i
;
12634 produce_special_glyphs (it
, IT_TRUNCATION
);
12638 row
->truncated_on_right_p
= 1;
12639 it
->continuation_lines_width
= 0;
12640 reseat_at_next_visible_line_start (it
, 0);
12641 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
12642 it
->hpos
= hpos_before
;
12643 it
->current_x
= x_before
;
12648 /* If line is not empty and hscrolled, maybe insert truncation glyphs
12649 at the left window margin. */
12650 if (it
->first_visible_x
12651 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
12653 if (!FRAME_WINDOW_P (it
->f
))
12654 insert_left_trunc_glyphs (it
);
12655 row
->truncated_on_left_p
= 1;
12658 /* If the start of this line is the overlay arrow-position, then
12659 mark this glyph row as the one containing the overlay arrow.
12660 This is clearly a mess with variable size fonts. It would be
12661 better to let it be displayed like cursors under X. */
12662 if (MARKERP (Voverlay_arrow_position
)
12663 && current_buffer
== XMARKER (Voverlay_arrow_position
)->buffer
12664 && (MATRIX_ROW_START_CHARPOS (row
)
12665 == marker_position (Voverlay_arrow_position
))
12666 && STRINGP (Voverlay_arrow_string
)
12667 && ! overlay_arrow_seen
)
12669 /* Overlay arrow in window redisplay is a bitmap. */
12670 if (!FRAME_WINDOW_P (it
->f
))
12672 struct glyph_row
*arrow_row
= get_overlay_arrow_glyph_row (it
->w
);
12673 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
12674 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
12675 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
12676 struct glyph
*p2
, *end
;
12678 /* Copy the arrow glyphs. */
12679 while (glyph
< arrow_end
)
12682 /* Throw away padding glyphs. */
12684 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
12685 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
12691 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
12695 overlay_arrow_seen
= 1;
12696 row
->overlay_arrow_p
= 1;
12699 /* Compute pixel dimensions of this line. */
12700 compute_line_metrics (it
);
12702 /* Remember the position at which this line ends. */
12703 row
->end
= it
->current
;
12705 /* Maybe set the cursor. */
12706 if (it
->w
->cursor
.vpos
< 0
12707 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
12708 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
12709 && cursor_row_p (it
->w
, row
))
12710 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
12712 /* Highlight trailing whitespace. */
12713 if (!NILP (Vshow_trailing_whitespace
))
12714 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
12716 /* Prepare for the next line. This line starts horizontally at (X
12717 HPOS) = (0 0). Vertical positions are incremented. As a
12718 convenience for the caller, IT->glyph_row is set to the next
12720 it
->current_x
= it
->hpos
= 0;
12721 it
->current_y
+= row
->height
;
12724 return row
->displays_text_p
;
12729 /***********************************************************************
12731 ***********************************************************************/
12733 /* Redisplay the menu bar in the frame for window W.
12735 The menu bar of X frames that don't have X toolkit support is
12736 displayed in a special window W->frame->menu_bar_window.
12738 The menu bar of terminal frames is treated specially as far as
12739 glyph matrices are concerned. Menu bar lines are not part of
12740 windows, so the update is done directly on the frame matrix rows
12741 for the menu bar. */
12744 display_menu_bar (w
)
12747 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
12752 /* Don't do all this for graphical frames. */
12754 if (!NILP (Vwindow_system
))
12757 #ifdef USE_X_TOOLKIT
12762 if (FRAME_MAC_P (f
))
12766 #ifdef USE_X_TOOLKIT
12767 xassert (!FRAME_WINDOW_P (f
));
12768 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
12769 it
.first_visible_x
= 0;
12770 it
.last_visible_x
= FRAME_WINDOW_WIDTH (f
) * CANON_X_UNIT (f
);
12771 #else /* not USE_X_TOOLKIT */
12772 if (FRAME_WINDOW_P (f
))
12774 /* Menu bar lines are displayed in the desired matrix of the
12775 dummy window menu_bar_window. */
12776 struct window
*menu_w
;
12777 xassert (WINDOWP (f
->menu_bar_window
));
12778 menu_w
= XWINDOW (f
->menu_bar_window
);
12779 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
12781 it
.first_visible_x
= 0;
12782 it
.last_visible_x
= FRAME_WINDOW_WIDTH (f
) * CANON_X_UNIT (f
);
12786 /* This is a TTY frame, i.e. character hpos/vpos are used as
12788 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
12790 it
.first_visible_x
= 0;
12791 it
.last_visible_x
= FRAME_WIDTH (f
);
12793 #endif /* not USE_X_TOOLKIT */
12795 if (! mode_line_inverse_video
)
12796 /* Force the menu-bar to be displayed in the default face. */
12797 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
12799 /* Clear all rows of the menu bar. */
12800 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
12802 struct glyph_row
*row
= it
.glyph_row
+ i
;
12803 clear_glyph_row (row
);
12804 row
->enabled_p
= 1;
12805 row
->full_width_p
= 1;
12808 /* Display all items of the menu bar. */
12809 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
12810 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
12812 Lisp_Object string
;
12814 /* Stop at nil string. */
12815 string
= AREF (items
, i
+ 1);
12819 /* Remember where item was displayed. */
12820 AREF (items
, i
+ 3) = make_number (it
.hpos
);
12822 /* Display the item, pad with one space. */
12823 if (it
.current_x
< it
.last_visible_x
)
12824 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
12825 XSTRING (string
)->size
+ 1, 0, 0, -1);
12828 /* Fill out the line with spaces. */
12829 if (it
.current_x
< it
.last_visible_x
)
12830 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
12832 /* Compute the total height of the lines. */
12833 compute_line_metrics (&it
);
12838 /***********************************************************************
12840 ***********************************************************************/
12842 /* Redisplay mode lines in the window tree whose root is WINDOW. If
12843 FORCE is non-zero, redisplay mode lines unconditionally.
12844 Otherwise, redisplay only mode lines that are garbaged. Value is
12845 the number of windows whose mode lines were redisplayed. */
12848 redisplay_mode_lines (window
, force
)
12849 Lisp_Object window
;
12854 while (!NILP (window
))
12856 struct window
*w
= XWINDOW (window
);
12858 if (WINDOWP (w
->hchild
))
12859 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
12860 else if (WINDOWP (w
->vchild
))
12861 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
12863 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
12864 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
12866 Lisp_Object old_selected_frame
;
12867 struct text_pos lpoint
;
12868 struct buffer
*old
= current_buffer
;
12870 /* Set the window's buffer for the mode line display. */
12871 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
12872 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12874 /* Point refers normally to the selected window. For any
12875 other window, set up appropriate value. */
12876 if (!EQ (window
, selected_window
))
12878 struct text_pos pt
;
12880 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
12881 if (CHARPOS (pt
) < BEGV
)
12882 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
12883 else if (CHARPOS (pt
) > (ZV
- 1))
12884 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
12886 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
12889 /* Temporarily set up the selected frame. */
12890 old_selected_frame
= selected_frame
;
12891 selected_frame
= w
->frame
;
12893 /* Display mode lines. */
12894 clear_glyph_matrix (w
->desired_matrix
);
12895 if (display_mode_lines (w
))
12898 w
->must_be_updated_p
= 1;
12901 /* Restore old settings. */
12902 selected_frame
= old_selected_frame
;
12903 set_buffer_internal_1 (old
);
12904 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
12914 /* Display the mode and/or top line of window W. Value is the number
12915 of mode lines displayed. */
12918 display_mode_lines (w
)
12923 /* These will be set while the mode line specs are processed. */
12924 line_number_displayed
= 0;
12925 w
->column_number_displayed
= Qnil
;
12927 if (WINDOW_WANTS_MODELINE_P (w
))
12929 display_mode_line (w
, MODE_LINE_FACE_ID
,
12930 current_buffer
->mode_line_format
);
12934 if (WINDOW_WANTS_HEADER_LINE_P (w
))
12936 display_mode_line (w
, HEADER_LINE_FACE_ID
,
12937 current_buffer
->header_line_format
);
12945 /* Display mode or top line of window W. FACE_ID specifies which line
12946 to display; it is either MODE_LINE_FACE_ID or HEADER_LINE_FACE_ID.
12947 FORMAT is the mode line format to display. Value is the pixel
12948 height of the mode line displayed. */
12951 display_mode_line (w
, face_id
, format
)
12953 enum face_id face_id
;
12954 Lisp_Object format
;
12959 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
12960 prepare_desired_row (it
.glyph_row
);
12962 if (! mode_line_inverse_video
)
12963 /* Force the mode-line to be displayed in the default face. */
12964 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
12966 /* Temporarily make frame's keyboard the current kboard so that
12967 kboard-local variables in the mode_line_format will get the right
12969 push_frame_kboard (it
.f
);
12970 display_mode_element (&it
, 0, 0, 0, format
);
12971 pop_frame_kboard ();
12973 /* Fill up with spaces. */
12974 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
12976 compute_line_metrics (&it
);
12977 it
.glyph_row
->full_width_p
= 1;
12978 it
.glyph_row
->mode_line_p
= 1;
12979 it
.glyph_row
->inverse_p
= 0;
12980 it
.glyph_row
->continued_p
= 0;
12981 it
.glyph_row
->truncated_on_left_p
= 0;
12982 it
.glyph_row
->truncated_on_right_p
= 0;
12984 /* Make a 3D mode-line have a shadow at its right end. */
12985 face
= FACE_FROM_ID (it
.f
, face_id
);
12986 extend_face_to_end_of_line (&it
);
12987 if (face
->box
!= FACE_NO_BOX
)
12989 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
12990 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
12991 last
->right_box_line_p
= 1;
12994 return it
.glyph_row
->height
;
12998 /* Contribute ELT to the mode line for window IT->w. How it
12999 translates into text depends on its data type.
13001 IT describes the display environment in which we display, as usual.
13003 DEPTH is the depth in recursion. It is used to prevent
13004 infinite recursion here.
13006 FIELD_WIDTH is the number of characters the display of ELT should
13007 occupy in the mode line, and PRECISION is the maximum number of
13008 characters to display from ELT's representation. See
13009 display_string for details. *
13011 Returns the hpos of the end of the text generated by ELT. */
13014 display_mode_element (it
, depth
, field_width
, precision
, elt
)
13017 int field_width
, precision
;
13020 int n
= 0, field
, prec
;
13028 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
13032 /* A string: output it and check for %-constructs within it. */
13034 unsigned char *this = XSTRING (elt
)->data
;
13035 unsigned char *lisp_string
= this;
13037 while ((precision
<= 0 || n
< precision
)
13039 && (frame_title_ptr
13040 || it
->current_x
< it
->last_visible_x
))
13042 unsigned char *last
= this;
13044 /* Advance to end of string or next format specifier. */
13045 while ((c
= *this++) != '\0' && c
!= '%')
13048 if (this - 1 != last
)
13050 /* Output to end of string or up to '%'. Field width
13051 is length of string. Don't output more than
13052 PRECISION allows us. */
13054 prec
= strwidth (last
, this - last
);
13055 if (precision
> 0 && prec
> precision
- n
)
13056 prec
= precision
- n
;
13058 if (frame_title_ptr
)
13059 n
+= store_frame_title (last
, 0, prec
);
13061 n
+= display_string (NULL
, elt
, Qnil
, 0, last
- lisp_string
,
13062 it
, 0, prec
, 0, -1);
13064 else /* c == '%' */
13066 unsigned char *percent_position
= this;
13068 /* Get the specified minimum width. Zero means
13071 while ((c
= *this++) >= '0' && c
<= '9')
13072 field
= field
* 10 + c
- '0';
13074 /* Don't pad beyond the total padding allowed. */
13075 if (field_width
- n
> 0 && field
> field_width
- n
)
13076 field
= field_width
- n
;
13078 /* Note that either PRECISION <= 0 or N < PRECISION. */
13079 prec
= precision
- n
;
13082 n
+= display_mode_element (it
, depth
, field
, prec
,
13083 Vglobal_mode_string
);
13086 unsigned char *spec
13087 = decode_mode_spec (it
->w
, c
, field
, prec
);
13089 if (frame_title_ptr
)
13090 n
+= store_frame_title (spec
, field
, prec
);
13094 = it
->glyph_row
->used
[TEXT_AREA
];
13096 = percent_position
- XSTRING (elt
)->data
;
13098 = display_string (spec
, Qnil
, elt
, charpos
, 0, it
,
13099 field
, prec
, 0, -1);
13101 /* Assign to the glyphs written above the
13102 string where the `%x' came from, position
13106 struct glyph
*glyph
13107 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
13111 for (i
= 0; i
< nwritten
; ++i
)
13113 glyph
[i
].object
= elt
;
13114 glyph
[i
].charpos
= charpos
;
13127 /* A symbol: process the value of the symbol recursively
13128 as if it appeared here directly. Avoid error if symbol void.
13129 Special case: if value of symbol is a string, output the string
13132 register Lisp_Object tem
;
13133 tem
= Fboundp (elt
);
13136 tem
= Fsymbol_value (elt
);
13137 /* If value is a string, output that string literally:
13138 don't check for % within it. */
13141 prec
= precision
- n
;
13142 if (frame_title_ptr
)
13143 n
+= store_frame_title (XSTRING (tem
)->data
, -1, prec
);
13145 n
+= display_string (NULL
, tem
, Qnil
, 0, 0, it
,
13148 else if (!EQ (tem
, elt
))
13150 /* Give up right away for nil or t. */
13160 register Lisp_Object car
, tem
;
13162 /* A cons cell: three distinct cases.
13163 If first element is a string or a cons, process all the elements
13164 and effectively concatenate them.
13165 If first element is a negative number, truncate displaying cdr to
13166 at most that many characters. If positive, pad (with spaces)
13167 to at least that many characters.
13168 If first element is a symbol, process the cadr or caddr recursively
13169 according to whether the symbol's value is non-nil or nil. */
13171 if (EQ (car
, QCeval
) && CONSP (XCDR (elt
)))
13173 /* An element of the form (:eval FORM) means evaluate FORM
13174 and use the result as mode line elements. */
13175 struct gcpro gcpro1
;
13178 spec
= safe_eval (XCAR (XCDR (elt
)));
13180 n
+= display_mode_element (it
, depth
, field_width
- n
,
13181 precision
- n
, spec
);
13184 else if (SYMBOLP (car
))
13186 tem
= Fboundp (car
);
13190 /* elt is now the cdr, and we know it is a cons cell.
13191 Use its car if CAR has a non-nil value. */
13194 tem
= Fsymbol_value (car
);
13201 /* Symbol's value is nil (or symbol is unbound)
13202 Get the cddr of the original list
13203 and if possible find the caddr and use that. */
13207 else if (!CONSP (elt
))
13212 else if (INTEGERP (car
))
13214 register int lim
= XINT (car
);
13218 /* Negative int means reduce maximum width. */
13219 if (precision
<= 0)
13222 precision
= min (precision
, -lim
);
13226 /* Padding specified. Don't let it be more than
13227 current maximum. */
13229 lim
= min (precision
, lim
);
13231 /* If that's more padding than already wanted, queue it.
13232 But don't reduce padding already specified even if
13233 that is beyond the current truncation point. */
13234 field_width
= max (lim
, field_width
);
13238 else if (STRINGP (car
) || CONSP (car
))
13240 register int limit
= 50;
13241 /* Limit is to protect against circular lists. */
13244 && (precision
<= 0 || n
< precision
))
13246 n
+= display_mode_element (it
, depth
, field_width
- n
,
13247 precision
- n
, XCAR (elt
));
13256 if (frame_title_ptr
)
13257 n
+= store_frame_title ("*invalid*", 0, precision
- n
);
13259 n
+= display_string ("*invalid*", Qnil
, Qnil
, 0, 0, it
, 0,
13260 precision
- n
, 0, 0);
13264 /* Pad to FIELD_WIDTH. */
13265 if (field_width
> 0 && n
< field_width
)
13267 if (frame_title_ptr
)
13268 n
+= store_frame_title ("", field_width
- n
, 0);
13270 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
13278 /* Write a null-terminated, right justified decimal representation of
13279 the positive integer D to BUF using a minimal field width WIDTH. */
13282 pint2str (buf
, width
, d
)
13283 register char *buf
;
13284 register int width
;
13287 register char *p
= buf
;
13295 *p
++ = d
% 10 + '0';
13300 for (width
-= (int) (p
- buf
); width
> 0; --width
)
13311 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
13312 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
13313 type of CODING_SYSTEM. Return updated pointer into BUF. */
13315 static unsigned char invalid_eol_type
[] = "(*invalid*)";
13318 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
13319 Lisp_Object coding_system
;
13320 register char *buf
;
13324 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
13325 unsigned char *eol_str
;
13327 /* The EOL conversion we are using. */
13328 Lisp_Object eoltype
;
13330 val
= Fget (coding_system
, Qcoding_system
);
13333 if (!VECTORP (val
)) /* Not yet decided. */
13338 eoltype
= eol_mnemonic_undecided
;
13339 /* Don't mention EOL conversion if it isn't decided. */
13343 Lisp_Object eolvalue
;
13345 eolvalue
= Fget (coding_system
, Qeol_type
);
13348 *buf
++ = XFASTINT (AREF (val
, 1));
13352 /* The EOL conversion that is normal on this system. */
13354 if (NILP (eolvalue
)) /* Not yet decided. */
13355 eoltype
= eol_mnemonic_undecided
;
13356 else if (VECTORP (eolvalue
)) /* Not yet decided. */
13357 eoltype
= eol_mnemonic_undecided
;
13358 else /* INTEGERP (eolvalue) -- 0:LF, 1:CRLF, 2:CR */
13359 eoltype
= (XFASTINT (eolvalue
) == 0
13360 ? eol_mnemonic_unix
13361 : (XFASTINT (eolvalue
) == 1
13362 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
13368 /* Mention the EOL conversion if it is not the usual one. */
13369 if (STRINGP (eoltype
))
13371 eol_str
= XSTRING (eoltype
)->data
;
13372 eol_str_len
= XSTRING (eoltype
)->size
;
13374 else if (INTEGERP (eoltype
)
13375 && CHAR_VALID_P (XINT (eoltype
), 0))
13377 eol_str
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
13378 eol_str_len
= CHAR_STRING (XINT (eoltype
), eol_str
);
13382 eol_str
= invalid_eol_type
;
13383 eol_str_len
= sizeof (invalid_eol_type
) - 1;
13385 bcopy (eol_str
, buf
, eol_str_len
);
13386 buf
+= eol_str_len
;
13392 /* Return a string for the output of a mode line %-spec for window W,
13393 generated by character C. PRECISION >= 0 means don't return a
13394 string longer than that value. FIELD_WIDTH > 0 means pad the
13395 string returned with spaces to that value. */
13397 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
13400 decode_mode_spec (w
, c
, field_width
, precision
)
13403 int field_width
, precision
;
13406 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
13407 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
13408 struct buffer
*b
= XBUFFER (w
->buffer
);
13415 if (!NILP (b
->read_only
))
13417 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
13422 /* This differs from %* only for a modified read-only buffer. */
13423 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
13425 if (!NILP (b
->read_only
))
13430 /* This differs from %* in ignoring read-only-ness. */
13431 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
13443 if (command_loop_level
> 5)
13445 p
= decode_mode_spec_buf
;
13446 for (i
= 0; i
< command_loop_level
; i
++)
13449 return decode_mode_spec_buf
;
13457 if (command_loop_level
> 5)
13459 p
= decode_mode_spec_buf
;
13460 for (i
= 0; i
< command_loop_level
; i
++)
13463 return decode_mode_spec_buf
;
13470 /* Let lots_of_dashes be a string of infinite length. */
13471 if (field_width
<= 0
13472 || field_width
> sizeof (lots_of_dashes
))
13474 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
13475 decode_mode_spec_buf
[i
] = '-';
13476 decode_mode_spec_buf
[i
] = '\0';
13477 return decode_mode_spec_buf
;
13480 return lots_of_dashes
;
13489 int col
= current_column ();
13490 XSETFASTINT (w
->column_number_displayed
, col
);
13491 pint2str (decode_mode_spec_buf
, field_width
, col
);
13492 return decode_mode_spec_buf
;
13496 /* %F displays the frame name. */
13497 if (!NILP (f
->title
))
13498 return (char *) XSTRING (f
->title
)->data
;
13499 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
13500 return (char *) XSTRING (f
->name
)->data
;
13509 int startpos
= XMARKER (w
->start
)->charpos
;
13510 int startpos_byte
= marker_byte_position (w
->start
);
13511 int line
, linepos
, linepos_byte
, topline
;
13513 int height
= XFASTINT (w
->height
);
13515 /* If we decided that this buffer isn't suitable for line numbers,
13516 don't forget that too fast. */
13517 if (EQ (w
->base_line_pos
, w
->buffer
))
13519 /* But do forget it, if the window shows a different buffer now. */
13520 else if (BUFFERP (w
->base_line_pos
))
13521 w
->base_line_pos
= Qnil
;
13523 /* If the buffer is very big, don't waste time. */
13524 if (INTEGERP (Vline_number_display_limit
)
13525 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
13527 w
->base_line_pos
= Qnil
;
13528 w
->base_line_number
= Qnil
;
13532 if (!NILP (w
->base_line_number
)
13533 && !NILP (w
->base_line_pos
)
13534 && XFASTINT (w
->base_line_pos
) <= startpos
)
13536 line
= XFASTINT (w
->base_line_number
);
13537 linepos
= XFASTINT (w
->base_line_pos
);
13538 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
13543 linepos
= BUF_BEGV (b
);
13544 linepos_byte
= BUF_BEGV_BYTE (b
);
13547 /* Count lines from base line to window start position. */
13548 nlines
= display_count_lines (linepos
, linepos_byte
,
13552 topline
= nlines
+ line
;
13554 /* Determine a new base line, if the old one is too close
13555 or too far away, or if we did not have one.
13556 "Too close" means it's plausible a scroll-down would
13557 go back past it. */
13558 if (startpos
== BUF_BEGV (b
))
13560 XSETFASTINT (w
->base_line_number
, topline
);
13561 XSETFASTINT (w
->base_line_pos
, BUF_BEGV (b
));
13563 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
13564 || linepos
== BUF_BEGV (b
))
13566 int limit
= BUF_BEGV (b
);
13567 int limit_byte
= BUF_BEGV_BYTE (b
);
13569 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
13571 if (startpos
- distance
> limit
)
13573 limit
= startpos
- distance
;
13574 limit_byte
= CHAR_TO_BYTE (limit
);
13577 nlines
= display_count_lines (startpos
, startpos_byte
,
13579 - (height
* 2 + 30),
13581 /* If we couldn't find the lines we wanted within
13582 line_number_display_limit_width chars per line,
13583 give up on line numbers for this window. */
13584 if (position
== limit_byte
&& limit
== startpos
- distance
)
13586 w
->base_line_pos
= w
->buffer
;
13587 w
->base_line_number
= Qnil
;
13591 XSETFASTINT (w
->base_line_number
, topline
- nlines
);
13592 XSETFASTINT (w
->base_line_pos
, BYTE_TO_CHAR (position
));
13595 /* Now count lines from the start pos to point. */
13596 nlines
= display_count_lines (startpos
, startpos_byte
,
13597 PT_BYTE
, PT
, &junk
);
13599 /* Record that we did display the line number. */
13600 line_number_displayed
= 1;
13602 /* Make the string to show. */
13603 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
13604 return decode_mode_spec_buf
;
13607 char* p
= decode_mode_spec_buf
;
13608 int pad
= field_width
- 2;
13614 return decode_mode_spec_buf
;
13620 obj
= b
->mode_name
;
13624 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
13630 int pos
= marker_position (w
->start
);
13631 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
13633 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
13635 if (pos
<= BUF_BEGV (b
))
13640 else if (pos
<= BUF_BEGV (b
))
13644 if (total
> 1000000)
13645 /* Do it differently for a large value, to avoid overflow. */
13646 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
13648 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
13649 /* We can't normally display a 3-digit number,
13650 so get us a 2-digit number that is close. */
13653 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
13654 return decode_mode_spec_buf
;
13658 /* Display percentage of size above the bottom of the screen. */
13661 int toppos
= marker_position (w
->start
);
13662 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
13663 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
13665 if (botpos
>= BUF_ZV (b
))
13667 if (toppos
<= BUF_BEGV (b
))
13674 if (total
> 1000000)
13675 /* Do it differently for a large value, to avoid overflow. */
13676 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
13678 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
13679 /* We can't normally display a 3-digit number,
13680 so get us a 2-digit number that is close. */
13683 if (toppos
<= BUF_BEGV (b
))
13684 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
13686 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
13687 return decode_mode_spec_buf
;
13692 /* status of process */
13693 obj
= Fget_buffer_process (w
->buffer
);
13695 return "no process";
13696 #ifdef subprocesses
13697 obj
= Fsymbol_name (Fprocess_status (obj
));
13701 case 't': /* indicate TEXT or BINARY */
13702 #ifdef MODE_LINE_BINARY_TEXT
13703 return MODE_LINE_BINARY_TEXT (b
);
13709 /* coding-system (not including end-of-line format) */
13711 /* coding-system (including end-of-line type) */
13713 int eol_flag
= (c
== 'Z');
13714 char *p
= decode_mode_spec_buf
;
13716 if (! FRAME_WINDOW_P (f
))
13718 /* No need to mention EOL here--the terminal never needs
13719 to do EOL conversion. */
13720 p
= decode_mode_spec_coding (keyboard_coding
.symbol
, p
, 0);
13721 p
= decode_mode_spec_coding (terminal_coding
.symbol
, p
, 0);
13723 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
13726 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
13727 #ifdef subprocesses
13728 obj
= Fget_buffer_process (Fcurrent_buffer ());
13729 if (PROCESSP (obj
))
13731 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
13733 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
13736 #endif /* subprocesses */
13739 return decode_mode_spec_buf
;
13744 return (char *) XSTRING (obj
)->data
;
13750 /* Count up to COUNT lines starting from START / START_BYTE.
13751 But don't go beyond LIMIT_BYTE.
13752 Return the number of lines thus found (always nonnegative).
13754 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
13757 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
13758 int start
, start_byte
, limit_byte
, count
;
13761 register unsigned char *cursor
;
13762 unsigned char *base
;
13764 register int ceiling
;
13765 register unsigned char *ceiling_addr
;
13766 int orig_count
= count
;
13768 /* If we are not in selective display mode,
13769 check only for newlines. */
13770 int selective_display
= (!NILP (current_buffer
->selective_display
)
13771 && !INTEGERP (current_buffer
->selective_display
));
13775 while (start_byte
< limit_byte
)
13777 ceiling
= BUFFER_CEILING_OF (start_byte
);
13778 ceiling
= min (limit_byte
- 1, ceiling
);
13779 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
13780 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
13783 if (selective_display
)
13784 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
13787 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
13790 if (cursor
!= ceiling_addr
)
13794 start_byte
+= cursor
- base
+ 1;
13795 *byte_pos_ptr
= start_byte
;
13799 if (++cursor
== ceiling_addr
)
13805 start_byte
+= cursor
- base
;
13810 while (start_byte
> limit_byte
)
13812 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
13813 ceiling
= max (limit_byte
, ceiling
);
13814 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
13815 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
13818 if (selective_display
)
13819 while (--cursor
!= ceiling_addr
13820 && *cursor
!= '\n' && *cursor
!= 015)
13823 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
13826 if (cursor
!= ceiling_addr
)
13830 start_byte
+= cursor
- base
+ 1;
13831 *byte_pos_ptr
= start_byte
;
13832 /* When scanning backwards, we should
13833 not count the newline posterior to which we stop. */
13834 return - orig_count
- 1;
13840 /* Here we add 1 to compensate for the last decrement
13841 of CURSOR, which took it past the valid range. */
13842 start_byte
+= cursor
- base
+ 1;
13846 *byte_pos_ptr
= limit_byte
;
13849 return - orig_count
+ count
;
13850 return orig_count
- count
;
13856 /***********************************************************************
13858 ***********************************************************************/
13860 /* Display a NUL-terminated string, starting with index START.
13862 If STRING is non-null, display that C string. Otherwise, the Lisp
13863 string LISP_STRING is displayed.
13865 If FACE_STRING is not nil, FACE_STRING_POS is a position in
13866 FACE_STRING. Display STRING or LISP_STRING with the face at
13867 FACE_STRING_POS in FACE_STRING:
13869 Display the string in the environment given by IT, but use the
13870 standard display table, temporarily.
13872 FIELD_WIDTH is the minimum number of output glyphs to produce.
13873 If STRING has fewer characters than FIELD_WIDTH, pad to the right
13874 with spaces. If STRING has more characters, more than FIELD_WIDTH
13875 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
13877 PRECISION is the maximum number of characters to output from
13878 STRING. PRECISION < 0 means don't truncate the string.
13880 This is roughly equivalent to printf format specifiers:
13882 FIELD_WIDTH PRECISION PRINTF
13883 ----------------------------------------
13889 MULTIBYTE zero means do not display multibyte chars, > 0 means do
13890 display them, and < 0 means obey the current buffer's value of
13891 enable_multibyte_characters.
13893 Value is the number of glyphs produced. */
13896 display_string (string
, lisp_string
, face_string
, face_string_pos
,
13897 start
, it
, field_width
, precision
, max_x
, multibyte
)
13898 unsigned char *string
;
13899 Lisp_Object lisp_string
;
13900 Lisp_Object face_string
;
13901 int face_string_pos
;
13904 int field_width
, precision
, max_x
;
13907 int hpos_at_start
= it
->hpos
;
13908 int saved_face_id
= it
->face_id
;
13909 struct glyph_row
*row
= it
->glyph_row
;
13911 /* Initialize the iterator IT for iteration over STRING beginning
13912 with index START. We assume that IT may be modified here (which
13913 means that display_line has to do something when displaying a
13914 mini-buffer prompt, which it does). */
13915 reseat_to_string (it
, string
, lisp_string
, start
,
13916 precision
, field_width
, multibyte
);
13918 /* If displaying STRING, set up the face of the iterator
13919 from LISP_STRING, if that's given. */
13920 if (STRINGP (face_string
))
13926 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
13927 0, it
->region_beg_charpos
,
13928 it
->region_end_charpos
,
13929 &endptr
, it
->base_face_id
, 0);
13930 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
13931 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
13934 /* Set max_x to the maximum allowed X position. Don't let it go
13935 beyond the right edge of the window. */
13937 max_x
= it
->last_visible_x
;
13939 max_x
= min (max_x
, it
->last_visible_x
);
13941 /* Skip over display elements that are not visible. because IT->w is
13943 if (it
->current_x
< it
->first_visible_x
)
13944 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
13945 MOVE_TO_POS
| MOVE_TO_X
);
13947 row
->ascent
= it
->max_ascent
;
13948 row
->height
= it
->max_ascent
+ it
->max_descent
;
13949 row
->phys_ascent
= it
->max_phys_ascent
;
13950 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
13952 /* This condition is for the case that we are called with current_x
13953 past last_visible_x. */
13954 while (it
->current_x
< max_x
)
13956 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
13958 /* Get the next display element. */
13959 if (!get_next_display_element (it
))
13962 /* Produce glyphs. */
13963 x_before
= it
->current_x
;
13964 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
13965 PRODUCE_GLYPHS (it
);
13967 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
13970 while (i
< nglyphs
)
13972 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
13974 if (!it
->truncate_lines_p
13975 && x
+ glyph
->pixel_width
> max_x
)
13977 /* End of continued line or max_x reached. */
13978 if (CHAR_GLYPH_PADDING_P (*glyph
))
13980 /* A wide character is unbreakable. */
13981 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
13982 it
->current_x
= x_before
;
13986 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
13991 else if (x
+ glyph
->pixel_width
> it
->first_visible_x
)
13993 /* Glyph is at least partially visible. */
13995 if (x
< it
->first_visible_x
)
13996 it
->glyph_row
->x
= x
- it
->first_visible_x
;
14000 /* Glyph is off the left margin of the display area.
14001 Should not happen. */
14005 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
14006 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
14007 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
14008 row
->phys_height
= max (row
->phys_height
,
14009 it
->max_phys_ascent
+ it
->max_phys_descent
);
14010 x
+= glyph
->pixel_width
;
14014 /* Stop if max_x reached. */
14018 /* Stop at line ends. */
14019 if (ITERATOR_AT_END_OF_LINE_P (it
))
14021 it
->continuation_lines_width
= 0;
14025 set_iterator_to_next (it
, 1);
14027 /* Stop if truncating at the right edge. */
14028 if (it
->truncate_lines_p
14029 && it
->current_x
>= it
->last_visible_x
)
14031 /* Add truncation mark, but don't do it if the line is
14032 truncated at a padding space. */
14033 if (IT_CHARPOS (*it
) < it
->string_nchars
)
14035 if (!FRAME_WINDOW_P (it
->f
))
14039 if (it
->current_x
> it
->last_visible_x
)
14041 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
14042 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
14044 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
14046 row
->used
[TEXT_AREA
] = i
;
14047 produce_special_glyphs (it
, IT_TRUNCATION
);
14050 produce_special_glyphs (it
, IT_TRUNCATION
);
14052 it
->glyph_row
->truncated_on_right_p
= 1;
14058 /* Maybe insert a truncation at the left. */
14059 if (it
->first_visible_x
14060 && IT_CHARPOS (*it
) > 0)
14062 if (!FRAME_WINDOW_P (it
->f
))
14063 insert_left_trunc_glyphs (it
);
14064 it
->glyph_row
->truncated_on_left_p
= 1;
14067 it
->face_id
= saved_face_id
;
14069 /* Value is number of columns displayed. */
14070 return it
->hpos
- hpos_at_start
;
14075 /* This is like a combination of memq and assq. Return 1 if PROPVAL
14076 appears as an element of LIST or as the car of an element of LIST.
14077 If PROPVAL is a list, compare each element against LIST in that
14078 way, and return 1 if any element of PROPVAL is found in LIST.
14079 Otherwise return 0. This function cannot quit. */
14082 invisible_p (propval
, list
)
14083 register Lisp_Object propval
;
14086 register Lisp_Object tail
, proptail
;
14088 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
14090 register Lisp_Object tem
;
14092 if (EQ (propval
, tem
))
14094 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
14098 if (CONSP (propval
))
14100 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
14102 Lisp_Object propelt
;
14103 propelt
= XCAR (proptail
);
14104 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
14106 register Lisp_Object tem
;
14108 if (EQ (propelt
, tem
))
14110 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
14120 /* Return 1 if PROPVAL appears as the car of an element of LIST and
14121 the cdr of that element is non-nil. If PROPVAL is a list, check
14122 each element of PROPVAL in that way, and the first time some
14123 element is found, return 1 if the cdr of that element is non-nil.
14124 Otherwise return 0. This function cannot quit. */
14127 invisible_ellipsis_p (propval
, list
)
14128 register Lisp_Object propval
;
14131 register Lisp_Object tail
, proptail
;
14133 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
14135 register Lisp_Object tem
;
14137 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
14138 return ! NILP (XCDR (tem
));
14141 if (CONSP (propval
))
14142 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
14144 Lisp_Object propelt
;
14145 propelt
= XCAR (proptail
);
14146 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
14148 register Lisp_Object tem
;
14150 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
14151 return ! NILP (XCDR (tem
));
14160 /***********************************************************************
14162 ***********************************************************************/
14167 Vwith_echo_area_save_vector
= Qnil
;
14168 staticpro (&Vwith_echo_area_save_vector
);
14170 Vmessage_stack
= Qnil
;
14171 staticpro (&Vmessage_stack
);
14173 Qinhibit_redisplay
= intern ("inhibit-redisplay");
14174 staticpro (&Qinhibit_redisplay
);
14177 defsubr (&Sdump_glyph_matrix
);
14178 defsubr (&Sdump_glyph_row
);
14179 defsubr (&Sdump_tool_bar_row
);
14180 defsubr (&Strace_redisplay_toggle
);
14181 defsubr (&Strace_to_stderr
);
14183 #ifdef HAVE_WINDOW_SYSTEM
14184 defsubr (&Stool_bar_lines_needed
);
14187 staticpro (&Qmenu_bar_update_hook
);
14188 Qmenu_bar_update_hook
= intern ("menu-bar-update-hook");
14190 staticpro (&Qoverriding_terminal_local_map
);
14191 Qoverriding_terminal_local_map
= intern ("overriding-terminal-local-map");
14193 staticpro (&Qoverriding_local_map
);
14194 Qoverriding_local_map
= intern ("overriding-local-map");
14196 staticpro (&Qwindow_scroll_functions
);
14197 Qwindow_scroll_functions
= intern ("window-scroll-functions");
14199 staticpro (&Qredisplay_end_trigger_functions
);
14200 Qredisplay_end_trigger_functions
= intern ("redisplay-end-trigger-functions");
14202 staticpro (&Qinhibit_point_motion_hooks
);
14203 Qinhibit_point_motion_hooks
= intern ("inhibit-point-motion-hooks");
14205 QCdata
= intern (":data");
14206 staticpro (&QCdata
);
14207 Qdisplay
= intern ("display");
14208 staticpro (&Qdisplay
);
14209 Qspace_width
= intern ("space-width");
14210 staticpro (&Qspace_width
);
14211 Qraise
= intern ("raise");
14212 staticpro (&Qraise
);
14213 Qspace
= intern ("space");
14214 staticpro (&Qspace
);
14215 Qmargin
= intern ("margin");
14216 staticpro (&Qmargin
);
14217 Qleft_margin
= intern ("left-margin");
14218 staticpro (&Qleft_margin
);
14219 Qright_margin
= intern ("right-margin");
14220 staticpro (&Qright_margin
);
14221 Qalign_to
= intern ("align-to");
14222 staticpro (&Qalign_to
);
14223 QCalign_to
= intern (":align-to");
14224 staticpro (&QCalign_to
);
14225 Qrelative_width
= intern ("relative-width");
14226 staticpro (&Qrelative_width
);
14227 QCrelative_width
= intern (":relative-width");
14228 staticpro (&QCrelative_width
);
14229 QCrelative_height
= intern (":relative-height");
14230 staticpro (&QCrelative_height
);
14231 QCeval
= intern (":eval");
14232 staticpro (&QCeval
);
14233 Qwhen
= intern ("when");
14234 staticpro (&Qwhen
);
14235 QCfile
= intern (":file");
14236 staticpro (&QCfile
);
14237 Qfontified
= intern ("fontified");
14238 staticpro (&Qfontified
);
14239 Qfontification_functions
= intern ("fontification-functions");
14240 staticpro (&Qfontification_functions
);
14241 Qtrailing_whitespace
= intern ("trailing-whitespace");
14242 staticpro (&Qtrailing_whitespace
);
14243 Qimage
= intern ("image");
14244 staticpro (&Qimage
);
14245 Qmessage_truncate_lines
= intern ("message-truncate-lines");
14246 staticpro (&Qmessage_truncate_lines
);
14247 Qgrow_only
= intern ("grow-only");
14248 staticpro (&Qgrow_only
);
14249 Qinhibit_menubar_update
= intern ("inhibit-menubar-update");
14250 staticpro (&Qinhibit_menubar_update
);
14252 last_arrow_position
= Qnil
;
14253 last_arrow_string
= Qnil
;
14254 staticpro (&last_arrow_position
);
14255 staticpro (&last_arrow_string
);
14257 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
14258 staticpro (&echo_buffer
[0]);
14259 staticpro (&echo_buffer
[1]);
14261 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
14262 staticpro (&echo_area_buffer
[0]);
14263 staticpro (&echo_area_buffer
[1]);
14265 Vmessages_buffer_name
= build_string ("*Messages*");
14266 staticpro (&Vmessages_buffer_name
);
14268 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
14269 "Non-nil means highlight trailing whitespace.\n\
14270 The face used for trailing whitespace is `trailing-whitespace'.");
14271 Vshow_trailing_whitespace
= Qnil
;
14273 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
14274 "Non-nil means don't actually do any redisplay.\n\
14275 This is used for internal purposes.");
14276 Vinhibit_redisplay
= Qnil
;
14278 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
14279 "String (or mode line construct) included (normally) in `mode-line-format'.");
14280 Vglobal_mode_string
= Qnil
;
14282 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
14283 "Marker for where to display an arrow on top of the buffer text.\n\
14284 This must be the beginning of a line in order to work.\n\
14285 See also `overlay-arrow-string'.");
14286 Voverlay_arrow_position
= Qnil
;
14288 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
14289 "String to display as an arrow. See also `overlay-arrow-position'.");
14290 Voverlay_arrow_string
= Qnil
;
14292 DEFVAR_INT ("scroll-step", &scroll_step
,
14293 "*The number of lines to try scrolling a window by when point moves out.\n\
14294 If that fails to bring point back on frame, point is centered instead.\n\
14295 If this is zero, point is always centered after it moves off frame.\n\
14296 If you want scrolling to always be a line at a time, you should set\n\
14297 `scroll-conservatively' to a large value rather than set this to 1.");
14299 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
14300 "*Scroll up to this many lines, to bring point back on screen.\n\
14301 A value of zero means to scroll the text to center point vertically\n\
14303 scroll_conservatively
= 0;
14305 DEFVAR_INT ("scroll-margin", &scroll_margin
,
14306 "*Number of lines of margin at the top and bottom of a window.\n\
14307 Recenter the window whenever point gets within this many lines\n\
14308 of the top or bottom of the window.");
14312 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, "Don't ask");
14315 DEFVAR_BOOL ("truncate-partial-width-windows",
14316 &truncate_partial_width_windows
,
14317 "*Non-nil means truncate lines in all windows less than full frame wide.");
14318 truncate_partial_width_windows
= 1;
14320 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
14321 "nil means display the mode-line/header-line/menu-bar in the default face.\n\
14322 Any other value means to use the appropriate face, `mode-line',\n\
14323 `header-line', or `menu' respectively.\n\
14325 This variable is deprecated; please change the above faces instead.");
14326 mode_line_inverse_video
= 1;
14328 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
14329 "*Maximum buffer size for which line number should be displayed.\n\
14330 If the buffer is bigger than this, the line number does not appear\n\
14331 in the mode line. A value of nil means no limit.");
14332 Vline_number_display_limit
= Qnil
;
14334 DEFVAR_INT ("line-number-display-limit-width",
14335 &line_number_display_limit_width
,
14336 "*Maximum line width (in characters) for line number display.\n\
14337 If the average length of the lines near point is bigger than this, then the\n\
14338 line number may be omitted from the mode line.");
14339 line_number_display_limit_width
= 200;
14341 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
14342 "*Non-nil means highlight region even in nonselected windows.");
14343 highlight_nonselected_windows
= 0;
14345 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
14346 "Non-nil if more than one frame is visible on this display.\n\
14347 Minibuffer-only frames don't count, but iconified frames do.\n\
14348 This variable is not guaranteed to be accurate except while processing\n\
14349 `frame-title-format' and `icon-title-format'.");
14351 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
14352 "Template for displaying the title bar of visible frames.\n\
14353 \(Assuming the window manager supports this feature.)\n\
14354 This variable has the same structure as `mode-line-format' (which see),\n\
14355 and is used only on frames for which no explicit name has been set\n\
14356 \(see `modify-frame-parameters').");
14357 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
14358 "Template for displaying the title bar of an iconified frame.\n\
14359 \(Assuming the window manager supports this feature.)\n\
14360 This variable has the same structure as `mode-line-format' (which see),\n\
14361 and is used only on frames for which no explicit name has been set\n\
14362 \(see `modify-frame-parameters').");
14364 = Vframe_title_format
14365 = Fcons (intern ("multiple-frames"),
14366 Fcons (build_string ("%b"),
14367 Fcons (Fcons (build_string (""),
14368 Fcons (intern ("invocation-name"),
14369 Fcons (build_string ("@"),
14370 Fcons (intern ("system-name"),
14374 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
14375 "Maximum number of lines to keep in the message log buffer.\n\
14376 If nil, disable message logging. If t, log messages but don't truncate\n\
14377 the buffer when it becomes large.");
14378 XSETFASTINT (Vmessage_log_max
, 50);
14380 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
14381 "Functions called before redisplay, if window sizes have changed.\n\
14382 The value should be a list of functions that take one argument.\n\
14383 Just before redisplay, for each frame, if any of its windows have changed\n\
14384 size since the last redisplay, or have been split or deleted,\n\
14385 all the functions in the list are called, with the frame as argument.");
14386 Vwindow_size_change_functions
= Qnil
;
14388 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
14389 "List of Functions to call before redisplaying a window with scrolling.\n\
14390 Each function is called with two arguments, the window\n\
14391 and its new display-start position. Note that the value of `window-end'\n\
14392 is not valid when these functions are called.");
14393 Vwindow_scroll_functions
= Qnil
;
14395 DEFVAR_BOOL ("auto-resize-tool-bars", &auto_resize_tool_bars_p
,
14396 "*Non-nil means automatically resize tool-bars.\n\
14397 This increases a tool-bar's height if not all tool-bar items are visible.\n\
14398 It decreases a tool-bar's height when it would display blank lines\n\
14400 auto_resize_tool_bars_p
= 1;
14402 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
14403 "*Non-nil means raise tool-bar buttons when the mouse moves over them.");
14404 auto_raise_tool_bar_buttons_p
= 1;
14406 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
14407 "*Margin around tool-bar buttons in pixels.\n\
14408 If an integer, use that for both horizontal and vertical margins.\n\
14409 Otherwise, value should be a pair of integers `(HORZ : VERT)' with\n\
14410 HORZ specifying the horizontal margin, and VERT specifying the\n\
14411 vertical margin.");
14412 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
14414 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
14415 "Relief thickness of tool-bar buttons.");
14416 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
14418 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
14419 "List of functions to call to fontify regions of text.\n\
14420 Each function is called with one argument POS. Functions must\n\
14421 fontify a region starting at POS in the current buffer, and give\n\
14422 fontified regions the property `fontified'.\n\
14423 This variable automatically becomes buffer-local when set.");
14424 Vfontification_functions
= Qnil
;
14425 Fmake_variable_buffer_local (Qfontification_functions
);
14427 DEFVAR_BOOL ("unibyte-display-via-language-environment",
14428 &unibyte_display_via_language_environment
,
14429 "*Non-nil means display unibyte text according to language environment.\n\
14430 Specifically this means that unibyte non-ASCII characters\n\
14431 are displayed by converting them to the equivalent multibyte characters\n\
14432 according to the current language environment. As a result, they are\n\
14433 displayed according to the current fontset.");
14434 unibyte_display_via_language_environment
= 0;
14436 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
14437 "*Maximum height for resizing mini-windows.\n\
14438 If a float, it specifies a fraction of the mini-window frame's height.\n\
14439 If an integer, it specifies a number of lines.");
14440 Vmax_mini_window_height
= make_float (0.25);
14442 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
14443 "*How to resize mini-windows.\n\
14444 A value of nil means don't automatically resize mini-windows.\n\
14445 A value of t means resize them to fit the text displayed in them.\n\
14446 A value of `grow-only', the default, means let mini-windows grow\n\
14447 only, until their display becomes empty, at which point the windows\n\
14448 go back to their normal size.");
14449 Vresize_mini_windows
= Qgrow_only
;
14451 DEFVAR_BOOL ("cursor-in-non-selected-windows",
14452 &cursor_in_non_selected_windows
,
14453 "*Non-nil means display a hollow cursor in non-selected windows.\n\
14454 Nil means don't display a cursor there.");
14455 cursor_in_non_selected_windows
= 1;
14457 DEFVAR_BOOL ("automatic-hscrolling", &automatic_hscrolling_p
,
14458 "*Non-nil means scroll the display automatically to make point visible.");
14459 automatic_hscrolling_p
= 1;
14461 DEFVAR_LISP ("image-types", &Vimage_types
,
14462 "List of supported image types.\n\
14463 Each element of the list is a symbol for a supported image type.");
14464 Vimage_types
= Qnil
;
14466 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
14467 "If non-nil, messages are truncated instead of resizing the echo area.\n\
14468 Bind this around calls to `message' to let it take effect.");
14469 message_truncate_lines
= 0;
14471 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
14472 "Normal hook run for clicks on menu bar, before displaying a submenu.\n\
14473 Can be used to update submenus whose contents should vary.");
14474 Vmenu_bar_update_hook
= Qnil
;
14476 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
14477 "Non-nil means don't update menu bars. Internal use only.");
14478 inhibit_menubar_update
= 0;
14482 /* Initialize this module when Emacs starts. */
14487 Lisp_Object root_window
;
14488 struct window
*mini_w
;
14490 current_header_line_height
= current_mode_line_height
= -1;
14492 CHARPOS (this_line_start_pos
) = 0;
14494 mini_w
= XWINDOW (minibuf_window
);
14495 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
14497 if (!noninteractive
)
14499 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
14502 XSETFASTINT (XWINDOW (root_window
)->top
, FRAME_TOP_MARGIN (f
));
14503 set_window_height (root_window
,
14504 FRAME_HEIGHT (f
) - 1 - FRAME_TOP_MARGIN (f
),
14506 XSETFASTINT (mini_w
->top
, FRAME_HEIGHT (f
) - 1);
14507 set_window_height (minibuf_window
, 1, 0);
14509 XSETFASTINT (XWINDOW (root_window
)->width
, FRAME_WIDTH (f
));
14510 XSETFASTINT (mini_w
->width
, FRAME_WIDTH (f
));
14512 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
14513 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
14514 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
14516 /* The default ellipsis glyphs `...'. */
14517 for (i
= 0; i
< 3; ++i
)
14518 XSETFASTINT (default_invis_vector
[i
], '.');
14521 #ifdef HAVE_WINDOW_SYSTEM
14523 /* Allocate the buffer for frame titles. */
14525 frame_title_buf
= (char *) xmalloc (size
);
14526 frame_title_buf_end
= frame_title_buf
+ size
;
14527 frame_title_ptr
= NULL
;
14529 #endif /* HAVE_WINDOW_SYSTEM */
14531 help_echo_showing_p
= 0;