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
;
229 Lisp_Object Qinhibit_eval_during_redisplay
;
231 /* Functions called to fontify regions of text. */
233 Lisp_Object Vfontification_functions
;
234 Lisp_Object Qfontification_functions
;
236 /* Non-zero means draw tool bar buttons raised when the mouse moves
239 int auto_raise_tool_bar_buttons_p
;
241 /* Margin around tool bar buttons in pixels. */
243 Lisp_Object Vtool_bar_button_margin
;
245 /* Thickness of shadow to draw around tool bar buttons. */
247 int tool_bar_button_relief
;
249 /* Non-zero means automatically resize tool-bars so that all tool-bar
250 items are visible, and no blank lines remain. */
252 int auto_resize_tool_bars_p
;
254 /* Non-nil means don't actually do any redisplay. */
256 Lisp_Object Vinhibit_redisplay
, Qinhibit_redisplay
;
258 /* Non-zero means Lisp evaluation during redisplay is inhibited. */
260 int inhibit_eval_during_redisplay
;
262 /* Names of text properties relevant for redisplay. */
264 Lisp_Object Qdisplay
, Qrelative_width
, Qalign_to
;
265 extern Lisp_Object Qface
, Qinvisible
, Qimage
, Qwidth
;
267 /* Symbols used in text property values. */
269 Lisp_Object Qspace
, QCalign_to
, QCrelative_width
, QCrelative_height
;
270 Lisp_Object Qleft_margin
, Qright_margin
, Qspace_width
, Qraise
;
272 extern Lisp_Object Qheight
;
274 /* Non-nil means highlight trailing whitespace. */
276 Lisp_Object Vshow_trailing_whitespace
;
278 /* Name of the face used to highlight trailing whitespace. */
280 Lisp_Object Qtrailing_whitespace
;
282 /* The symbol `image' which is the car of the lists used to represent
287 /* Non-zero means print newline to stdout before next mini-buffer
290 int noninteractive_need_newline
;
292 /* Non-zero means print newline to message log before next message. */
294 static int message_log_need_newline
;
297 /* The buffer position of the first character appearing entirely or
298 partially on the line of the selected window which contains the
299 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
300 redisplay optimization in redisplay_internal. */
302 static struct text_pos this_line_start_pos
;
304 /* Number of characters past the end of the line above, including the
305 terminating newline. */
307 static struct text_pos this_line_end_pos
;
309 /* The vertical positions and the height of this line. */
311 static int this_line_vpos
;
312 static int this_line_y
;
313 static int this_line_pixel_height
;
315 /* X position at which this display line starts. Usually zero;
316 negative if first character is partially visible. */
318 static int this_line_start_x
;
320 /* Buffer that this_line_.* variables are referring to. */
322 static struct buffer
*this_line_buffer
;
324 /* Nonzero means truncate lines in all windows less wide than the
327 int truncate_partial_width_windows
;
329 /* A flag to control how to display unibyte 8-bit character. */
331 int unibyte_display_via_language_environment
;
333 /* Nonzero means we have more than one non-mini-buffer-only frame.
334 Not guaranteed to be accurate except while parsing
335 frame-title-format. */
339 Lisp_Object Vglobal_mode_string
;
341 /* Marker for where to display an arrow on top of the buffer text. */
343 Lisp_Object Voverlay_arrow_position
;
345 /* String to display for the arrow. Only used on terminal frames. */
347 Lisp_Object Voverlay_arrow_string
;
349 /* Values of those variables at last redisplay. However, if
350 Voverlay_arrow_position is a marker, last_arrow_position is its
351 numerical position. */
353 static Lisp_Object last_arrow_position
, last_arrow_string
;
355 /* Like mode-line-format, but for the title bar on a visible frame. */
357 Lisp_Object Vframe_title_format
;
359 /* Like mode-line-format, but for the title bar on an iconified frame. */
361 Lisp_Object Vicon_title_format
;
363 /* List of functions to call when a window's size changes. These
364 functions get one arg, a frame on which one or more windows' sizes
367 static Lisp_Object Vwindow_size_change_functions
;
369 Lisp_Object Qmenu_bar_update_hook
, Vmenu_bar_update_hook
;
371 /* Nonzero if overlay arrow has been displayed once in this window. */
373 static int overlay_arrow_seen
;
375 /* Nonzero means highlight the region even in nonselected windows. */
377 int highlight_nonselected_windows
;
379 /* If cursor motion alone moves point off frame, try scrolling this
380 many lines up or down if that will bring it back. */
382 static int scroll_step
;
384 /* Non-0 means scroll just far enough to bring point back on the
385 screen, when appropriate. */
387 static int scroll_conservatively
;
389 /* Recenter the window whenever point gets within this many lines of
390 the top or bottom of the window. This value is translated into a
391 pixel value by multiplying it with CANON_Y_UNIT, which means that
392 there is really a fixed pixel height scroll margin. */
396 /* Number of windows showing the buffer of the selected window (or
397 another buffer with the same base buffer). keyboard.c refers to
402 /* Vector containing glyphs for an ellipsis `...'. */
404 static Lisp_Object default_invis_vector
[3];
406 /* Zero means display the mode-line/header-line/menu-bar in the default face
407 (this slightly odd definition is for compatibility with previous versions
408 of emacs), non-zero means display them using their respective faces.
410 This variable is deprecated. */
412 int mode_line_inverse_video
;
414 /* Prompt to display in front of the mini-buffer contents. */
416 Lisp_Object minibuf_prompt
;
418 /* Width of current mini-buffer prompt. Only set after display_line
419 of the line that contains the prompt. */
421 int minibuf_prompt_width
;
422 int minibuf_prompt_pixel_width
;
424 /* This is the window where the echo area message was displayed. It
425 is always a mini-buffer window, but it may not be the same window
426 currently active as a mini-buffer. */
428 Lisp_Object echo_area_window
;
430 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
431 pushes the current message and the value of
432 message_enable_multibyte on the stack, the function restore_message
433 pops the stack and displays MESSAGE again. */
435 Lisp_Object Vmessage_stack
;
437 /* Nonzero means multibyte characters were enabled when the echo area
438 message was specified. */
440 int message_enable_multibyte
;
442 /* True if we should redraw the mode lines on the next redisplay. */
444 int update_mode_lines
;
446 /* Nonzero if window sizes or contents have changed since last
447 redisplay that finished */
449 int windows_or_buffers_changed
;
451 /* Nonzero after display_mode_line if %l was used and it displayed a
454 int line_number_displayed
;
456 /* Maximum buffer size for which to display line numbers. */
458 Lisp_Object Vline_number_display_limit
;
460 /* line width to consider when repostioning for line number display */
462 static int line_number_display_limit_width
;
464 /* Number of lines to keep in the message log buffer. t means
465 infinite. nil means don't log at all. */
467 Lisp_Object Vmessage_log_max
;
469 /* The name of the *Messages* buffer, a string. */
471 static Lisp_Object Vmessages_buffer_name
;
473 /* Current, index 0, and last displayed echo area message. Either
474 buffers from echo_buffers, or nil to indicate no message. */
476 Lisp_Object echo_area_buffer
[2];
478 /* The buffers referenced from echo_area_buffer. */
480 static Lisp_Object echo_buffer
[2];
482 /* A vector saved used in with_area_buffer to reduce consing. */
484 static Lisp_Object Vwith_echo_area_save_vector
;
486 /* Non-zero means display_echo_area should display the last echo area
487 message again. Set by redisplay_preserve_echo_area. */
489 static int display_last_displayed_message_p
;
491 /* Nonzero if echo area is being used by print; zero if being used by
494 int message_buf_print
;
496 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
498 Lisp_Object Qinhibit_menubar_update
;
499 int inhibit_menubar_update
;
501 /* Maximum height for resizing mini-windows. Either a float
502 specifying a fraction of the available height, or an integer
503 specifying a number of lines. */
505 Lisp_Object Vmax_mini_window_height
;
507 /* Non-zero means messages should be displayed with truncated
508 lines instead of being continued. */
510 int message_truncate_lines
;
511 Lisp_Object Qmessage_truncate_lines
;
513 /* Non-zero means we want a hollow cursor in windows that are not
514 selected. Zero means there's no cursor in such windows. */
516 int cursor_in_non_selected_windows
;
518 /* A scratch glyph row with contents used for generating truncation
519 glyphs. Also used in direct_output_for_insert. */
521 #define MAX_SCRATCH_GLYPHS 100
522 struct glyph_row scratch_glyph_row
;
523 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
525 /* Ascent and height of the last line processed by move_it_to. */
527 static int last_max_ascent
, last_height
;
529 /* Non-zero if there's a help-echo in the echo area. */
531 int help_echo_showing_p
;
533 /* If >= 0, computed, exact values of mode-line and header-line height
534 to use in the macros CURRENT_MODE_LINE_HEIGHT and
535 CURRENT_HEADER_LINE_HEIGHT. */
537 int current_mode_line_height
, current_header_line_height
;
539 /* The maximum distance to look ahead for text properties. Values
540 that are too small let us call compute_char_face and similar
541 functions too often which is expensive. Values that are too large
542 let us call compute_char_face and alike too often because we
543 might not be interested in text properties that far away. */
545 #define TEXT_PROP_DISTANCE_LIMIT 100
549 /* Non-zero means print traces of redisplay if compiled with
552 int trace_redisplay_p
;
554 #endif /* GLYPH_DEBUG */
556 #ifdef DEBUG_TRACE_MOVE
557 /* Non-zero means trace with TRACE_MOVE to stderr. */
560 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
562 #define TRACE_MOVE(x) (void) 0
565 /* Non-zero means automatically scroll windows horizontally to make
568 int automatic_hscrolling_p
;
570 /* A list of symbols, one for each supported image type. */
572 Lisp_Object Vimage_types
;
574 /* The variable `resize-mini-windows'. If nil, don't resize
575 mini-windows. If t, always resize them to fit the text they
576 display. If `grow-only', let mini-windows grow only until they
579 Lisp_Object Vresize_mini_windows
;
581 /* Value returned from text property handlers (see below). */
586 HANDLED_RECOMPUTE_PROPS
,
587 HANDLED_OVERLAY_STRING_CONSUMED
,
591 /* A description of text properties that redisplay is interested
596 /* The name of the property. */
599 /* A unique index for the property. */
602 /* A handler function called to set up iterator IT from the property
603 at IT's current position. Value is used to steer handle_stop. */
604 enum prop_handled (*handler
) P_ ((struct it
*it
));
607 static enum prop_handled handle_face_prop
P_ ((struct it
*));
608 static enum prop_handled handle_invisible_prop
P_ ((struct it
*));
609 static enum prop_handled handle_display_prop
P_ ((struct it
*));
610 static enum prop_handled handle_composition_prop
P_ ((struct it
*));
611 static enum prop_handled handle_overlay_change
P_ ((struct it
*));
612 static enum prop_handled handle_fontified_prop
P_ ((struct it
*));
614 /* Properties handled by iterators. */
616 static struct props it_props
[] =
618 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
619 /* Handle `face' before `display' because some sub-properties of
620 `display' need to know the face. */
621 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
622 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
623 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
624 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
628 /* Value is the position described by X. If X is a marker, value is
629 the marker_position of X. Otherwise, value is X. */
631 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
633 /* Enumeration returned by some move_it_.* functions internally. */
637 /* Not used. Undefined value. */
640 /* Move ended at the requested buffer position or ZV. */
641 MOVE_POS_MATCH_OR_ZV
,
643 /* Move ended at the requested X pixel position. */
646 /* Move within a line ended at the end of a line that must be
650 /* Move within a line ended at the end of a line that would
651 be displayed truncated. */
654 /* Move within a line ended at a line end. */
660 /* Function prototypes. */
662 static void mark_window_display_accurate_1
P_ ((struct window
*, int));
663 static int single_display_prop_string_p
P_ ((Lisp_Object
, Lisp_Object
));
664 static int display_prop_string_p
P_ ((Lisp_Object
, Lisp_Object
));
665 static int cursor_row_p
P_ ((struct window
*, struct glyph_row
*));
666 static int redisplay_mode_lines
P_ ((Lisp_Object
, int));
667 static char *decode_mode_spec_coding
P_ ((Lisp_Object
, char *, int));
668 static int invisible_text_between_p
P_ ((struct it
*, int, int));
669 static int next_element_from_ellipsis
P_ ((struct it
*));
670 static void pint2str
P_ ((char *, int, int));
671 static struct text_pos run_window_scroll_functions
P_ ((Lisp_Object
,
673 static void reconsider_clip_changes
P_ ((struct window
*, struct buffer
*));
674 static int text_outside_line_unchanged_p
P_ ((struct window
*, int, int));
675 static void store_frame_title_char
P_ ((char));
676 static int store_frame_title
P_ ((unsigned char *, int, int));
677 static void x_consider_frame_title
P_ ((Lisp_Object
));
678 static void handle_stop
P_ ((struct it
*));
679 static int tool_bar_lines_needed
P_ ((struct frame
*));
680 static int single_display_prop_intangible_p
P_ ((Lisp_Object
));
681 static void ensure_echo_area_buffers
P_ ((void));
682 static struct glyph_row
*row_containing_pos
P_ ((struct window
*, int,
684 struct glyph_row
*));
685 static Lisp_Object unwind_with_echo_area_buffer
P_ ((Lisp_Object
));
686 static Lisp_Object with_echo_area_buffer_unwind_data
P_ ((struct window
*));
687 static int with_echo_area_buffer
P_ ((struct window
*, int,
688 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
689 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
690 static void clear_garbaged_frames
P_ ((void));
691 static int current_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
692 static int truncate_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
693 static int set_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
694 static int display_echo_area
P_ ((struct window
*));
695 static int display_echo_area_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
696 static int resize_mini_window_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
697 static Lisp_Object unwind_redisplay
P_ ((Lisp_Object
));
698 static int string_char_and_length
P_ ((unsigned char *, int, int *));
699 static struct text_pos display_prop_end
P_ ((struct it
*, Lisp_Object
,
701 static int compute_window_start_on_continuation_line
P_ ((struct window
*));
702 static Lisp_Object safe_eval_handler
P_ ((Lisp_Object
));
703 static void insert_left_trunc_glyphs
P_ ((struct it
*));
704 static struct glyph_row
*get_overlay_arrow_glyph_row
P_ ((struct window
*));
705 static void extend_face_to_end_of_line
P_ ((struct it
*));
706 static int append_space
P_ ((struct it
*, int));
707 static void make_cursor_line_fully_visible
P_ ((struct window
*));
708 static int try_scrolling
P_ ((Lisp_Object
, int, int, int, int));
709 static int try_cursor_movement
P_ ((Lisp_Object
, struct text_pos
, int *));
710 static int trailing_whitespace_p
P_ ((int));
711 static int message_log_check_duplicate
P_ ((int, int, int, int));
712 int invisible_p
P_ ((Lisp_Object
, Lisp_Object
));
713 int invisible_ellipsis_p
P_ ((Lisp_Object
, Lisp_Object
));
714 static void push_it
P_ ((struct it
*));
715 static void pop_it
P_ ((struct it
*));
716 static void sync_frame_with_window_matrix_rows
P_ ((struct window
*));
717 static void redisplay_internal
P_ ((int));
718 static int echo_area_display
P_ ((int));
719 static void redisplay_windows
P_ ((Lisp_Object
));
720 static void redisplay_window
P_ ((Lisp_Object
, int));
721 static void update_menu_bar
P_ ((struct frame
*, int));
722 static int try_window_reusing_current_matrix
P_ ((struct window
*));
723 static int try_window_id
P_ ((struct window
*));
724 static int display_line
P_ ((struct it
*));
725 static int display_mode_lines
P_ ((struct window
*));
726 static int display_mode_line
P_ ((struct window
*, enum face_id
, Lisp_Object
));
727 static int display_mode_element
P_ ((struct it
*, int, int, int, Lisp_Object
));
728 static char *decode_mode_spec
P_ ((struct window
*, int, int, int));
729 static void display_menu_bar
P_ ((struct window
*));
730 static int display_count_lines
P_ ((int, int, int, int, int *));
731 static int display_string
P_ ((unsigned char *, Lisp_Object
, Lisp_Object
,
732 int, int, struct it
*, int, int, int, int));
733 static void compute_line_metrics
P_ ((struct it
*));
734 static void run_redisplay_end_trigger_hook
P_ ((struct it
*));
735 static int get_overlay_strings
P_ ((struct it
*));
736 static void next_overlay_string
P_ ((struct it
*));
737 static void reseat
P_ ((struct it
*, struct text_pos
, int));
738 static void reseat_1
P_ ((struct it
*, struct text_pos
, int));
739 static void back_to_previous_visible_line_start
P_ ((struct it
*));
740 static void reseat_at_previous_visible_line_start
P_ ((struct it
*));
741 static void reseat_at_next_visible_line_start
P_ ((struct it
*, int));
742 static int next_element_from_display_vector
P_ ((struct it
*));
743 static int next_element_from_string
P_ ((struct it
*));
744 static int next_element_from_c_string
P_ ((struct it
*));
745 static int next_element_from_buffer
P_ ((struct it
*));
746 static int next_element_from_composition
P_ ((struct it
*));
747 static int next_element_from_image
P_ ((struct it
*));
748 static int next_element_from_stretch
P_ ((struct it
*));
749 static void load_overlay_strings
P_ ((struct it
*));
750 static void init_from_display_pos
P_ ((struct it
*, struct window
*,
751 struct display_pos
*));
752 static void reseat_to_string
P_ ((struct it
*, unsigned char *,
753 Lisp_Object
, int, int, int, int));
754 static enum move_it_result move_it_in_display_line_to
P_ ((struct it
*,
756 void move_it_vertically_backward
P_ ((struct it
*, int));
757 static void init_to_row_start
P_ ((struct it
*, struct window
*,
758 struct glyph_row
*));
759 static void init_to_row_end
P_ ((struct it
*, struct window
*,
760 struct glyph_row
*));
761 static void back_to_previous_line_start
P_ ((struct it
*));
762 static int forward_to_next_line_start
P_ ((struct it
*, int *));
763 static struct text_pos string_pos_nchars_ahead
P_ ((struct text_pos
,
765 static struct text_pos string_pos
P_ ((int, Lisp_Object
));
766 static struct text_pos c_string_pos
P_ ((int, unsigned char *, int));
767 static int number_of_chars
P_ ((unsigned char *, int));
768 static void compute_stop_pos
P_ ((struct it
*));
769 static void compute_string_pos
P_ ((struct text_pos
*, struct text_pos
,
771 static int face_before_or_after_it_pos
P_ ((struct it
*, int));
772 static int next_overlay_change
P_ ((int));
773 static int handle_single_display_prop
P_ ((struct it
*, Lisp_Object
,
774 Lisp_Object
, struct text_pos
*,
776 static int underlying_face_id
P_ ((struct it
*));
777 static int in_ellipses_for_invisible_text_p
P_ ((struct display_pos
*,
780 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
781 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
783 #ifdef HAVE_WINDOW_SYSTEM
785 static void update_tool_bar
P_ ((struct frame
*, int));
786 static void build_desired_tool_bar_string
P_ ((struct frame
*f
));
787 static int redisplay_tool_bar
P_ ((struct frame
*));
788 static void display_tool_bar_line
P_ ((struct it
*));
790 #endif /* HAVE_WINDOW_SYSTEM */
793 /***********************************************************************
794 Window display dimensions
795 ***********************************************************************/
797 /* Return the window-relative maximum y + 1 for glyph rows displaying
798 text in window W. This is the height of W minus the height of a
799 mode line, if any. */
802 window_text_bottom_y (w
)
805 struct frame
*f
= XFRAME (w
->frame
);
806 int height
= XFASTINT (w
->height
) * CANON_Y_UNIT (f
);
808 if (WINDOW_WANTS_MODELINE_P (w
))
809 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
814 /* Return the pixel width of display area AREA of window W. AREA < 0
815 means return the total width of W, not including bitmap areas to
816 the left and right of the window. */
819 window_box_width (w
, area
)
823 struct frame
*f
= XFRAME (w
->frame
);
824 int width
= XFASTINT (w
->width
);
826 if (!w
->pseudo_window_p
)
828 width
-= FRAME_SCROLL_BAR_WIDTH (f
) + FRAME_FLAGS_AREA_COLS (f
);
830 if (area
== TEXT_AREA
)
832 if (INTEGERP (w
->left_margin_width
))
833 width
-= XFASTINT (w
->left_margin_width
);
834 if (INTEGERP (w
->right_margin_width
))
835 width
-= XFASTINT (w
->right_margin_width
);
837 else if (area
== LEFT_MARGIN_AREA
)
838 width
= (INTEGERP (w
->left_margin_width
)
839 ? XFASTINT (w
->left_margin_width
) : 0);
840 else if (area
== RIGHT_MARGIN_AREA
)
841 width
= (INTEGERP (w
->right_margin_width
)
842 ? XFASTINT (w
->right_margin_width
) : 0);
845 return width
* CANON_X_UNIT (f
);
849 /* Return the pixel height of the display area of window W, not
850 including mode lines of W, if any.. */
853 window_box_height (w
)
856 struct frame
*f
= XFRAME (w
->frame
);
857 int height
= XFASTINT (w
->height
) * CANON_Y_UNIT (f
);
859 xassert (height
>= 0);
861 /* Note: the code below that determines the mode-line/header-line
862 height is essentially the same as that contained in the macro
863 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
864 the appropriate glyph row has its `mode_line_p' flag set,
865 and if it doesn't, uses estimate_mode_line_height instead. */
867 if (WINDOW_WANTS_MODELINE_P (w
))
869 struct glyph_row
*ml_row
870 = (w
->current_matrix
&& w
->current_matrix
->rows
871 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
873 if (ml_row
&& ml_row
->mode_line_p
)
874 height
-= ml_row
->height
;
876 height
-= estimate_mode_line_height (f
, MODE_LINE_FACE_ID
);
879 if (WINDOW_WANTS_HEADER_LINE_P (w
))
881 struct glyph_row
*hl_row
882 = (w
->current_matrix
&& w
->current_matrix
->rows
883 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
885 if (hl_row
&& hl_row
->mode_line_p
)
886 height
-= hl_row
->height
;
888 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
895 /* Return the frame-relative coordinate of the left edge of display
896 area AREA of window W. AREA < 0 means return the left edge of the
897 whole window, to the right of any bitmap area at the left side of
901 window_box_left (w
, area
)
905 struct frame
*f
= XFRAME (w
->frame
);
906 int x
= FRAME_INTERNAL_BORDER_WIDTH_SAFE (f
);
908 if (!w
->pseudo_window_p
)
910 x
+= (WINDOW_LEFT_MARGIN (w
) * CANON_X_UNIT (f
)
911 + FRAME_LEFT_FLAGS_AREA_WIDTH (f
));
913 if (area
== TEXT_AREA
)
914 x
+= window_box_width (w
, LEFT_MARGIN_AREA
);
915 else if (area
== RIGHT_MARGIN_AREA
)
916 x
+= (window_box_width (w
, LEFT_MARGIN_AREA
)
917 + window_box_width (w
, TEXT_AREA
));
924 /* Return the frame-relative coordinate of the right edge of display
925 area AREA of window W. AREA < 0 means return the left edge of the
926 whole window, to the left of any bitmap area at the right side of
930 window_box_right (w
, area
)
934 return window_box_left (w
, area
) + window_box_width (w
, area
);
938 /* Get the bounding box of the display area AREA of window W, without
939 mode lines, in frame-relative coordinates. AREA < 0 means the
940 whole window, not including bitmap areas to the left and right of
941 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
942 coordinates of the upper-left corner of the box. Return in
943 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
946 window_box (w
, area
, box_x
, box_y
, box_width
, box_height
)
949 int *box_x
, *box_y
, *box_width
, *box_height
;
951 struct frame
*f
= XFRAME (w
->frame
);
953 *box_width
= window_box_width (w
, area
);
954 *box_height
= window_box_height (w
);
955 *box_x
= window_box_left (w
, area
);
956 *box_y
= (FRAME_INTERNAL_BORDER_WIDTH_SAFE (f
)
957 + XFASTINT (w
->top
) * CANON_Y_UNIT (f
));
958 if (WINDOW_WANTS_HEADER_LINE_P (w
))
959 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
963 /* Get the bounding box of the display area AREA of window W, without
964 mode lines. AREA < 0 means the whole window, not including bitmap
965 areas to the left and right of the window. Return in *TOP_LEFT_X
966 and TOP_LEFT_Y the frame-relative pixel coordinates of the
967 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
968 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
972 window_box_edges (w
, area
, top_left_x
, top_left_y
,
973 bottom_right_x
, bottom_right_y
)
976 int *top_left_x
, *top_left_y
, *bottom_right_x
, *bottom_right_y
;
978 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
980 *bottom_right_x
+= *top_left_x
;
981 *bottom_right_y
+= *top_left_y
;
986 /***********************************************************************
988 ***********************************************************************/
990 /* Return the bottom y-position of the line the iterator IT is in.
991 This can modify IT's settings. */
997 int line_height
= it
->max_ascent
+ it
->max_descent
;
998 int line_top_y
= it
->current_y
;
1000 if (line_height
== 0)
1003 line_height
= last_height
;
1004 else if (IT_CHARPOS (*it
) < ZV
)
1006 move_it_by_lines (it
, 1, 1);
1007 line_height
= (it
->max_ascent
|| it
->max_descent
1008 ? it
->max_ascent
+ it
->max_descent
1013 struct glyph_row
*row
= it
->glyph_row
;
1015 /* Use the default character height. */
1016 it
->glyph_row
= NULL
;
1017 it
->what
= IT_CHARACTER
;
1020 PRODUCE_GLYPHS (it
);
1021 line_height
= it
->ascent
+ it
->descent
;
1022 it
->glyph_row
= row
;
1026 return line_top_y
+ line_height
;
1030 /* Return 1 if position CHARPOS is visible in window W. Set *FULLY to
1031 1 if POS is visible and the line containing POS is fully visible.
1032 EXACT_MODE_LINE_HEIGHTS_P non-zero means compute exact mode-line
1033 and header-lines heights. */
1036 pos_visible_p (w
, charpos
, fully
, exact_mode_line_heights_p
)
1038 int charpos
, *fully
, exact_mode_line_heights_p
;
1041 struct text_pos top
;
1043 struct buffer
*old_buffer
= NULL
;
1045 if (XBUFFER (w
->buffer
) != current_buffer
)
1047 old_buffer
= current_buffer
;
1048 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1051 *fully
= visible_p
= 0;
1052 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1054 /* Compute exact mode line heights, if requested. */
1055 if (exact_mode_line_heights_p
)
1057 if (WINDOW_WANTS_MODELINE_P (w
))
1058 current_mode_line_height
1059 = display_mode_line (w
, MODE_LINE_FACE_ID
,
1060 current_buffer
->mode_line_format
);
1062 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1063 current_header_line_height
1064 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1065 current_buffer
->header_line_format
);
1068 start_display (&it
, w
, top
);
1069 move_it_to (&it
, charpos
, 0, it
.last_visible_y
, -1,
1070 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
1072 /* Note that we may overshoot because of invisible text. */
1073 if (IT_CHARPOS (it
) >= charpos
)
1075 int top_y
= it
.current_y
;
1076 int bottom_y
= line_bottom_y (&it
);
1077 int window_top_y
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
);
1079 if (top_y
< window_top_y
)
1080 visible_p
= bottom_y
> window_top_y
;
1081 else if (top_y
< it
.last_visible_y
)
1084 *fully
= bottom_y
<= it
.last_visible_y
;
1087 else if (it
.current_y
+ it
.max_ascent
+ it
.max_descent
> it
.last_visible_y
)
1089 move_it_by_lines (&it
, 1, 0);
1090 if (charpos
< IT_CHARPOS (it
))
1098 set_buffer_internal_1 (old_buffer
);
1100 current_header_line_height
= current_mode_line_height
= -1;
1105 /* Return the next character from STR which is MAXLEN bytes long.
1106 Return in *LEN the length of the character. This is like
1107 STRING_CHAR_AND_LENGTH but never returns an invalid character. If
1108 we find one, we return a `?', but with the length of the invalid
1112 string_char_and_length (str
, maxlen
, len
)
1118 c
= STRING_CHAR_AND_LENGTH (str
, maxlen
, *len
);
1119 if (!CHAR_VALID_P (c
, 1))
1120 /* We may not change the length here because other places in Emacs
1121 don't use this function, i.e. they silently accept invalid
1130 /* Given a position POS containing a valid character and byte position
1131 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1133 static struct text_pos
1134 string_pos_nchars_ahead (pos
, string
, nchars
)
1135 struct text_pos pos
;
1139 xassert (STRINGP (string
) && nchars
>= 0);
1141 if (STRING_MULTIBYTE (string
))
1143 int rest
= STRING_BYTES (XSTRING (string
)) - BYTEPOS (pos
);
1144 unsigned char *p
= XSTRING (string
)->data
+ BYTEPOS (pos
);
1149 string_char_and_length (p
, rest
, &len
);
1150 p
+= len
, rest
-= len
;
1151 xassert (rest
>= 0);
1153 BYTEPOS (pos
) += len
;
1157 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1163 /* Value is the text position, i.e. character and byte position,
1164 for character position CHARPOS in STRING. */
1166 static INLINE
struct text_pos
1167 string_pos (charpos
, string
)
1171 struct text_pos pos
;
1172 xassert (STRINGP (string
));
1173 xassert (charpos
>= 0);
1174 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1179 /* Value is a text position, i.e. character and byte position, for
1180 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1181 means recognize multibyte characters. */
1183 static struct text_pos
1184 c_string_pos (charpos
, s
, multibyte_p
)
1189 struct text_pos pos
;
1191 xassert (s
!= NULL
);
1192 xassert (charpos
>= 0);
1196 int rest
= strlen (s
), len
;
1198 SET_TEXT_POS (pos
, 0, 0);
1201 string_char_and_length (s
, rest
, &len
);
1202 s
+= len
, rest
-= len
;
1203 xassert (rest
>= 0);
1205 BYTEPOS (pos
) += len
;
1209 SET_TEXT_POS (pos
, charpos
, charpos
);
1215 /* Value is the number of characters in C string S. MULTIBYTE_P
1216 non-zero means recognize multibyte characters. */
1219 number_of_chars (s
, multibyte_p
)
1227 int rest
= strlen (s
), len
;
1228 unsigned char *p
= (unsigned char *) s
;
1230 for (nchars
= 0; rest
> 0; ++nchars
)
1232 string_char_and_length (p
, rest
, &len
);
1233 rest
-= len
, p
+= len
;
1237 nchars
= strlen (s
);
1243 /* Compute byte position NEWPOS->bytepos corresponding to
1244 NEWPOS->charpos. POS is a known position in string STRING.
1245 NEWPOS->charpos must be >= POS.charpos. */
1248 compute_string_pos (newpos
, pos
, string
)
1249 struct text_pos
*newpos
, pos
;
1252 xassert (STRINGP (string
));
1253 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1255 if (STRING_MULTIBYTE (string
))
1256 *newpos
= string_pos_nchars_ahead (pos
, string
,
1257 CHARPOS (*newpos
) - CHARPOS (pos
));
1259 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1264 /***********************************************************************
1265 Lisp form evaluation
1266 ***********************************************************************/
1268 /* Error handler for safe_eval and safe_call. */
1271 safe_eval_handler (arg
)
1274 add_to_log ("Error during redisplay: %s", arg
, Qnil
);
1279 /* Evaluate SEXPR and return the result, or nil if something went
1288 if (inhibit_eval_during_redisplay
)
1292 int count
= BINDING_STACK_SIZE ();
1293 struct gcpro gcpro1
;
1296 specbind (Qinhibit_redisplay
, Qt
);
1297 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
1300 val
= unbind_to (count
, val
);
1307 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
1308 Return the result, or nil if something went wrong. */
1311 safe_call (nargs
, args
)
1317 if (inhibit_eval_during_redisplay
)
1321 int count
= BINDING_STACK_SIZE ();
1322 struct gcpro gcpro1
;
1325 gcpro1
.nvars
= nargs
;
1326 specbind (Qinhibit_redisplay
, Qt
);
1327 val
= internal_condition_case_2 (Ffuncall
, nargs
, args
, Qerror
,
1330 val
= unbind_to (count
, val
);
1337 /* Call function FN with one argument ARG.
1338 Return the result, or nil if something went wrong. */
1341 safe_call1 (fn
, arg
)
1342 Lisp_Object fn
, arg
;
1344 Lisp_Object args
[2];
1347 return safe_call (2, args
);
1352 /***********************************************************************
1354 ***********************************************************************/
1358 /* Define CHECK_IT to perform sanity checks on iterators.
1359 This is for debugging. It is too slow to do unconditionally. */
1365 if (it
->method
== next_element_from_string
)
1367 xassert (STRINGP (it
->string
));
1368 xassert (IT_STRING_CHARPOS (*it
) >= 0);
1370 else if (it
->method
== next_element_from_buffer
)
1372 /* Check that character and byte positions agree. */
1373 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
1377 xassert (it
->current
.dpvec_index
>= 0);
1379 xassert (it
->current
.dpvec_index
< 0);
1382 #define CHECK_IT(IT) check_it ((IT))
1386 #define CHECK_IT(IT) (void) 0
1393 /* Check that the window end of window W is what we expect it
1394 to be---the last row in the current matrix displaying text. */
1397 check_window_end (w
)
1400 if (!MINI_WINDOW_P (w
)
1401 && !NILP (w
->window_end_valid
))
1403 struct glyph_row
*row
;
1404 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
1405 XFASTINT (w
->window_end_vpos
)),
1407 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
1408 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
1412 #define CHECK_WINDOW_END(W) check_window_end ((W))
1414 #else /* not GLYPH_DEBUG */
1416 #define CHECK_WINDOW_END(W) (void) 0
1418 #endif /* not GLYPH_DEBUG */
1422 /***********************************************************************
1423 Iterator initialization
1424 ***********************************************************************/
1426 /* Initialize IT for displaying current_buffer in window W, starting
1427 at character position CHARPOS. CHARPOS < 0 means that no buffer
1428 position is specified which is useful when the iterator is assigned
1429 a position later. BYTEPOS is the byte position corresponding to
1430 CHARPOS. BYTEPOS <= 0 means compute it from CHARPOS.
1432 If ROW is not null, calls to produce_glyphs with IT as parameter
1433 will produce glyphs in that row.
1435 BASE_FACE_ID is the id of a base face to use. It must be one of
1436 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID or
1437 HEADER_LINE_FACE_ID for displaying mode lines, or TOOL_BAR_FACE_ID for
1438 displaying the tool-bar.
1440 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID or
1441 HEADER_LINE_FACE_ID, the iterator will be initialized to use the
1442 corresponding mode line glyph row of the desired matrix of W. */
1445 init_iterator (it
, w
, charpos
, bytepos
, row
, base_face_id
)
1448 int charpos
, bytepos
;
1449 struct glyph_row
*row
;
1450 enum face_id base_face_id
;
1452 int highlight_region_p
;
1454 /* Some precondition checks. */
1455 xassert (w
!= NULL
&& it
!= NULL
);
1456 xassert (charpos
< 0 || (charpos
> 0 && charpos
<= ZV
));
1458 /* If face attributes have been changed since the last redisplay,
1459 free realized faces now because they depend on face definitions
1460 that might have changed. */
1461 if (face_change_count
)
1463 face_change_count
= 0;
1464 free_all_realized_faces (Qnil
);
1467 /* Use one of the mode line rows of W's desired matrix if
1471 if (base_face_id
== MODE_LINE_FACE_ID
)
1472 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
1473 else if (base_face_id
== HEADER_LINE_FACE_ID
)
1474 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
1478 bzero (it
, sizeof *it
);
1479 it
->current
.overlay_string_index
= -1;
1480 it
->current
.dpvec_index
= -1;
1481 it
->base_face_id
= base_face_id
;
1483 /* The window in which we iterate over current_buffer: */
1484 XSETWINDOW (it
->window
, w
);
1486 it
->f
= XFRAME (w
->frame
);
1488 /* Extra space between lines (on window systems only). */
1489 if (base_face_id
== DEFAULT_FACE_ID
1490 && FRAME_WINDOW_P (it
->f
))
1492 if (NATNUMP (current_buffer
->extra_line_spacing
))
1493 it
->extra_line_spacing
= XFASTINT (current_buffer
->extra_line_spacing
);
1494 else if (it
->f
->extra_line_spacing
> 0)
1495 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
1498 /* If realized faces have been removed, e.g. because of face
1499 attribute changes of named faces, recompute them. When running
1500 in batch mode, the face cache of Vterminal_frame is null. If
1501 we happen to get called, make a dummy face cache. */
1506 FRAME_FACE_CACHE (it
->f
) == NULL
)
1507 init_frame_faces (it
->f
);
1508 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
1509 recompute_basic_faces (it
->f
);
1511 /* Current value of the `space-width', and 'height' properties. */
1512 it
->space_width
= Qnil
;
1513 it
->font_height
= Qnil
;
1515 /* Are control characters displayed as `^C'? */
1516 it
->ctl_arrow_p
= !NILP (current_buffer
->ctl_arrow
);
1518 /* -1 means everything between a CR and the following line end
1519 is invisible. >0 means lines indented more than this value are
1521 it
->selective
= (INTEGERP (current_buffer
->selective_display
)
1522 ? XFASTINT (current_buffer
->selective_display
)
1523 : (!NILP (current_buffer
->selective_display
)
1525 it
->selective_display_ellipsis_p
1526 = !NILP (current_buffer
->selective_display_ellipses
);
1528 /* Display table to use. */
1529 it
->dp
= window_display_table (w
);
1531 /* Are multibyte characters enabled in current_buffer? */
1532 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
1534 /* Non-zero if we should highlight the region. */
1536 = (!NILP (Vtransient_mark_mode
)
1537 && !NILP (current_buffer
->mark_active
)
1538 && XMARKER (current_buffer
->mark
)->buffer
!= 0);
1540 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
1541 start and end of a visible region in window IT->w. Set both to
1542 -1 to indicate no region. */
1543 if (highlight_region_p
1544 /* Maybe highlight only in selected window. */
1545 && (/* Either show region everywhere. */
1546 highlight_nonselected_windows
1547 /* Or show region in the selected window. */
1548 || w
== XWINDOW (selected_window
)
1549 /* Or show the region if we are in the mini-buffer and W is
1550 the window the mini-buffer refers to. */
1551 || (MINI_WINDOW_P (XWINDOW (selected_window
))
1552 && WINDOWP (Vminibuf_scroll_window
)
1553 && w
== XWINDOW (Vminibuf_scroll_window
))))
1555 int charpos
= marker_position (current_buffer
->mark
);
1556 it
->region_beg_charpos
= min (PT
, charpos
);
1557 it
->region_end_charpos
= max (PT
, charpos
);
1560 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
1562 /* Get the position at which the redisplay_end_trigger hook should
1563 be run, if it is to be run at all. */
1564 if (MARKERP (w
->redisplay_end_trigger
)
1565 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
1566 it
->redisplay_end_trigger_charpos
1567 = marker_position (w
->redisplay_end_trigger
);
1568 else if (INTEGERP (w
->redisplay_end_trigger
))
1569 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
1571 /* Correct bogus values of tab_width. */
1572 it
->tab_width
= XINT (current_buffer
->tab_width
);
1573 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
1576 /* Are lines in the display truncated? */
1577 it
->truncate_lines_p
1578 = (base_face_id
!= DEFAULT_FACE_ID
1579 || XINT (it
->w
->hscroll
)
1580 || (truncate_partial_width_windows
1581 && !WINDOW_FULL_WIDTH_P (it
->w
))
1582 || !NILP (current_buffer
->truncate_lines
));
1584 /* Get dimensions of truncation and continuation glyphs. These are
1585 displayed as bitmaps under X, so we don't need them for such
1587 if (!FRAME_WINDOW_P (it
->f
))
1589 if (it
->truncate_lines_p
)
1591 /* We will need the truncation glyph. */
1592 xassert (it
->glyph_row
== NULL
);
1593 produce_special_glyphs (it
, IT_TRUNCATION
);
1594 it
->truncation_pixel_width
= it
->pixel_width
;
1598 /* We will need the continuation glyph. */
1599 xassert (it
->glyph_row
== NULL
);
1600 produce_special_glyphs (it
, IT_CONTINUATION
);
1601 it
->continuation_pixel_width
= it
->pixel_width
;
1604 /* Reset these values to zero becaue the produce_special_glyphs
1605 above has changed them. */
1606 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
1607 it
->phys_ascent
= it
->phys_descent
= 0;
1610 /* Set this after getting the dimensions of truncation and
1611 continuation glyphs, so that we don't produce glyphs when calling
1612 produce_special_glyphs, above. */
1613 it
->glyph_row
= row
;
1614 it
->area
= TEXT_AREA
;
1616 /* Get the dimensions of the display area. The display area
1617 consists of the visible window area plus a horizontally scrolled
1618 part to the left of the window. All x-values are relative to the
1619 start of this total display area. */
1620 if (base_face_id
!= DEFAULT_FACE_ID
)
1622 /* Mode lines, menu bar in terminal frames. */
1623 it
->first_visible_x
= 0;
1624 it
->last_visible_x
= XFASTINT (w
->width
) * CANON_X_UNIT (it
->f
);
1629 = XFASTINT (it
->w
->hscroll
) * CANON_X_UNIT (it
->f
);
1630 it
->last_visible_x
= (it
->first_visible_x
1631 + window_box_width (w
, TEXT_AREA
));
1633 /* If we truncate lines, leave room for the truncator glyph(s) at
1634 the right margin. Otherwise, leave room for the continuation
1635 glyph(s). Truncation and continuation glyphs are not inserted
1636 for window-based redisplay. */
1637 if (!FRAME_WINDOW_P (it
->f
))
1639 if (it
->truncate_lines_p
)
1640 it
->last_visible_x
-= it
->truncation_pixel_width
;
1642 it
->last_visible_x
-= it
->continuation_pixel_width
;
1645 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
1646 it
->current_y
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
1649 /* Leave room for a border glyph. */
1650 if (!FRAME_WINDOW_P (it
->f
)
1651 && !WINDOW_RIGHTMOST_P (it
->w
))
1652 it
->last_visible_x
-= 1;
1654 it
->last_visible_y
= window_text_bottom_y (w
);
1656 /* For mode lines and alike, arrange for the first glyph having a
1657 left box line if the face specifies a box. */
1658 if (base_face_id
!= DEFAULT_FACE_ID
)
1662 it
->face_id
= base_face_id
;
1664 /* If we have a boxed mode line, make the first character appear
1665 with a left box line. */
1666 face
= FACE_FROM_ID (it
->f
, base_face_id
);
1667 if (face
->box
!= FACE_NO_BOX
)
1668 it
->start_of_box_run_p
= 1;
1671 /* If a buffer position was specified, set the iterator there,
1672 getting overlays and face properties from that position. */
1675 it
->end_charpos
= ZV
;
1677 IT_CHARPOS (*it
) = charpos
;
1679 /* Compute byte position if not specified. */
1681 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
1683 IT_BYTEPOS (*it
) = bytepos
;
1685 /* Compute faces etc. */
1686 reseat (it
, it
->current
.pos
, 1);
1693 /* Initialize IT for the display of window W with window start POS. */
1696 start_display (it
, w
, pos
)
1699 struct text_pos pos
;
1701 int start_at_line_beg_p
;
1702 struct glyph_row
*row
;
1703 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
1706 row
= w
->desired_matrix
->rows
+ first_vpos
;
1707 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
1708 first_y
= it
->current_y
;
1710 /* If window start is not at a line start, move back to the line
1711 start. This makes sure that we take continuation lines into
1713 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
1714 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
1715 if (!start_at_line_beg_p
)
1716 reseat_at_previous_visible_line_start (it
);
1718 /* If window start is not at a line start, skip forward to POS to
1719 get the correct continuation_lines_width and current_x. */
1720 if (!start_at_line_beg_p
)
1722 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
1724 /* If lines are continued, this line may end in the middle of a
1725 multi-glyph character (e.g. a control character displayed as
1726 \003, or in the middle of an overlay string). In this case
1727 move_it_to above will not have taken us to the start of
1728 the continuation line but to the end of the continued line. */
1729 if (!it
->truncate_lines_p
)
1731 if (it
->current_x
> 0)
1733 if (it
->current
.dpvec_index
>= 0
1734 || it
->current
.overlay_string_index
>= 0)
1736 set_iterator_to_next (it
, 1);
1737 move_it_in_display_line_to (it
, -1, -1, 0);
1740 it
->continuation_lines_width
+= it
->current_x
;
1743 /* We're starting a new display line, not affected by the
1744 height of the continued line, so clear the appropriate
1745 fields in the iterator structure. */
1746 it
->max_ascent
= it
->max_descent
= 0;
1747 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
1750 it
->current_y
= first_y
;
1752 it
->current_x
= it
->hpos
= 0;
1755 #if 0 /* Don't assert the following because start_display is sometimes
1756 called intentionally with a window start that is not at a
1757 line start. Please leave this code in as a comment. */
1759 /* Window start should be on a line start, now. */
1760 xassert (it
->continuation_lines_width
1761 || IT_CHARPOS (it
) == BEGV
1762 || FETCH_BYTE (IT_BYTEPOS (it
) - 1) == '\n');
1767 /* Return 1 if POS is a position in ellipses displayed for invisible
1768 text. W is the window we display, for text property lookup. */
1771 in_ellipses_for_invisible_text_p (pos
, w
)
1772 struct display_pos
*pos
;
1775 Lisp_Object prop
, window
;
1777 int charpos
= CHARPOS (pos
->pos
);
1779 /* If POS specifies a position in a display vector, this might
1780 be for an ellipsis displayed for invisible text. We won't
1781 get the iterator set up for delivering that ellipsis unless
1782 we make sure that it gets aware of the invisible text. */
1783 if (pos
->dpvec_index
>= 0
1784 && pos
->overlay_string_index
< 0
1785 && CHARPOS (pos
->string_pos
) < 0
1787 && (XSETWINDOW (window
, w
),
1788 prop
= Fget_char_property (make_number (charpos
),
1789 Qinvisible
, window
),
1790 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
1792 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
1794 if (TEXT_PROP_MEANS_INVISIBLE (prop
)
1795 && TEXT_PROP_MEANS_INVISIBLE_WITH_ELLIPSIS (prop
))
1803 /* Initialize IT for stepping through current_buffer in window W,
1804 starting at position POS that includes overlay string and display
1805 vector/ control character translation position information. */
1808 init_from_display_pos (it
, w
, pos
)
1811 struct display_pos
*pos
;
1813 int charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
1815 /* If POS specifies a position in a display vector, this might
1816 be for an ellipsis displayed for invisible text. We won't
1817 get the iterator set up for delivering that ellipsis unless
1818 we make sure that it gets aware of the invisible text. */
1819 if (in_ellipses_for_invisible_text_p (pos
, w
))
1825 /* Keep in mind: the call to reseat in init_iterator skips invisible
1826 text, so we might end up at a position different from POS. This
1827 is only a problem when POS is a row start after a newline and an
1828 overlay starts there with an after-string, and the overlay has an
1829 invisible property. Since we don't skip invisible text in
1830 display_line and elsewhere immediately after consuming the
1831 newline before the row start, such a POS will not be in a string,
1832 but the call to init_iterator below will move us to the
1834 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
1836 /* If position is within an overlay string, set up IT to
1837 the right overlay string. */
1838 if (pos
->overlay_string_index
>= 0)
1842 /* We already have the first chunk of overlay strings in
1843 IT->overlay_strings. Load more until the one for
1844 pos->overlay_string_index is in IT->overlay_strings. */
1845 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
1847 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
1848 it
->current
.overlay_string_index
= 0;
1851 load_overlay_strings (it
);
1852 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
1856 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
1857 relative_index
= (it
->current
.overlay_string_index
1858 % OVERLAY_STRING_CHUNK_SIZE
);
1859 it
->string
= it
->overlay_strings
[relative_index
];
1860 xassert (STRINGP (it
->string
));
1861 it
->current
.string_pos
= pos
->string_pos
;
1862 it
->method
= next_element_from_string
;
1864 else if (it
->current
.overlay_string_index
>= 0)
1866 /* If POS says we're already after an overlay string ending at
1867 POS, make sure to pop the iterator because it will be in
1868 front of that overlay string. When POS is ZV, we've thereby
1869 also ``processed'' overlay strings at ZV. */
1872 it
->current
.overlay_string_index
= -1;
1873 it
->method
= next_element_from_buffer
;
1874 if (CHARPOS (pos
->pos
) == ZV
)
1875 it
->overlay_strings_at_end_processed_p
= 1;
1878 if (CHARPOS (pos
->string_pos
) >= 0)
1880 /* Recorded position is not in an overlay string, but in another
1881 string. This can only be a string from a `display' property.
1882 IT should already be filled with that string. */
1883 it
->current
.string_pos
= pos
->string_pos
;
1884 xassert (STRINGP (it
->string
));
1887 /* Restore position in display vector translations, control
1888 character translations or ellipses. */
1889 if (pos
->dpvec_index
>= 0)
1891 if (it
->dpvec
== NULL
)
1892 get_next_display_element (it
);
1893 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
1894 it
->current
.dpvec_index
= pos
->dpvec_index
;
1901 /* Initialize IT for stepping through current_buffer in window W
1902 starting at ROW->start. */
1905 init_to_row_start (it
, w
, row
)
1908 struct glyph_row
*row
;
1910 init_from_display_pos (it
, w
, &row
->start
);
1911 it
->continuation_lines_width
= row
->continuation_lines_width
;
1916 /* Initialize IT for stepping through current_buffer in window W
1917 starting in the line following ROW, i.e. starting at ROW->end. */
1920 init_to_row_end (it
, w
, row
)
1923 struct glyph_row
*row
;
1925 init_from_display_pos (it
, w
, &row
->end
);
1927 if (row
->continued_p
)
1928 it
->continuation_lines_width
= (row
->continuation_lines_width
1929 + row
->pixel_width
);
1936 /***********************************************************************
1938 ***********************************************************************/
1940 /* Called when IT reaches IT->stop_charpos. Handle text property and
1941 overlay changes. Set IT->stop_charpos to the next position where
1948 enum prop_handled handled
;
1949 int handle_overlay_change_p
= 1;
1953 it
->current
.dpvec_index
= -1;
1957 handled
= HANDLED_NORMALLY
;
1959 /* Call text property handlers. */
1960 for (p
= it_props
; p
->handler
; ++p
)
1962 handled
= p
->handler (it
);
1964 if (handled
== HANDLED_RECOMPUTE_PROPS
)
1966 else if (handled
== HANDLED_RETURN
)
1968 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
1969 handle_overlay_change_p
= 0;
1972 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
1974 /* Don't check for overlay strings below when set to deliver
1975 characters from a display vector. */
1976 if (it
->method
== next_element_from_display_vector
)
1977 handle_overlay_change_p
= 0;
1979 /* Handle overlay changes. */
1980 if (handle_overlay_change_p
)
1981 handled
= handle_overlay_change (it
);
1983 /* Determine where to stop next. */
1984 if (handled
== HANDLED_NORMALLY
)
1985 compute_stop_pos (it
);
1988 while (handled
== HANDLED_RECOMPUTE_PROPS
);
1992 /* Compute IT->stop_charpos from text property and overlay change
1993 information for IT's current position. */
1996 compute_stop_pos (it
)
1999 register INTERVAL iv
, next_iv
;
2000 Lisp_Object object
, limit
, position
;
2002 /* If nowhere else, stop at the end. */
2003 it
->stop_charpos
= it
->end_charpos
;
2005 if (STRINGP (it
->string
))
2007 /* Strings are usually short, so don't limit the search for
2009 object
= it
->string
;
2011 position
= make_number (IT_STRING_CHARPOS (*it
));
2017 /* If next overlay change is in front of the current stop pos
2018 (which is IT->end_charpos), stop there. Note: value of
2019 next_overlay_change is point-max if no overlay change
2021 charpos
= next_overlay_change (IT_CHARPOS (*it
));
2022 if (charpos
< it
->stop_charpos
)
2023 it
->stop_charpos
= charpos
;
2025 /* If showing the region, we have to stop at the region
2026 start or end because the face might change there. */
2027 if (it
->region_beg_charpos
> 0)
2029 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
2030 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
2031 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
2032 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
2035 /* Set up variables for computing the stop position from text
2036 property changes. */
2037 XSETBUFFER (object
, current_buffer
);
2038 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
2039 position
= make_number (IT_CHARPOS (*it
));
2043 /* Get the interval containing IT's position. Value is a null
2044 interval if there isn't such an interval. */
2045 iv
= validate_interval_range (object
, &position
, &position
, 0);
2046 if (!NULL_INTERVAL_P (iv
))
2048 Lisp_Object values_here
[LAST_PROP_IDX
];
2051 /* Get properties here. */
2052 for (p
= it_props
; p
->handler
; ++p
)
2053 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
2055 /* Look for an interval following iv that has different
2057 for (next_iv
= next_interval (iv
);
2058 (!NULL_INTERVAL_P (next_iv
)
2060 || XFASTINT (limit
) > next_iv
->position
));
2061 next_iv
= next_interval (next_iv
))
2063 for (p
= it_props
; p
->handler
; ++p
)
2065 Lisp_Object new_value
;
2067 new_value
= textget (next_iv
->plist
, *p
->name
);
2068 if (!EQ (values_here
[p
->idx
], new_value
))
2076 if (!NULL_INTERVAL_P (next_iv
))
2078 if (INTEGERP (limit
)
2079 && next_iv
->position
>= XFASTINT (limit
))
2080 /* No text property change up to limit. */
2081 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
2083 /* Text properties change in next_iv. */
2084 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
2088 xassert (STRINGP (it
->string
)
2089 || (it
->stop_charpos
>= BEGV
2090 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
2094 /* Return the position of the next overlay change after POS in
2095 current_buffer. Value is point-max if no overlay change
2096 follows. This is like `next-overlay-change' but doesn't use
2100 next_overlay_change (pos
)
2105 Lisp_Object
*overlays
;
2109 /* Get all overlays at the given position. */
2111 overlays
= (Lisp_Object
*) alloca (len
* sizeof *overlays
);
2112 noverlays
= overlays_at (pos
, 0, &overlays
, &len
, &endpos
, NULL
, 1);
2113 if (noverlays
> len
)
2116 overlays
= (Lisp_Object
*) alloca (len
* sizeof *overlays
);
2117 noverlays
= overlays_at (pos
, 0, &overlays
, &len
, &endpos
, NULL
, 1);
2120 /* If any of these overlays ends before endpos,
2121 use its ending point instead. */
2122 for (i
= 0; i
< noverlays
; ++i
)
2127 oend
= OVERLAY_END (overlays
[i
]);
2128 oendpos
= OVERLAY_POSITION (oend
);
2129 endpos
= min (endpos
, oendpos
);
2137 /***********************************************************************
2139 ***********************************************************************/
2141 /* Handle changes in the `fontified' property of the current buffer by
2142 calling hook functions from Qfontification_functions to fontify
2145 static enum prop_handled
2146 handle_fontified_prop (it
)
2149 Lisp_Object prop
, pos
;
2150 enum prop_handled handled
= HANDLED_NORMALLY
;
2152 /* Get the value of the `fontified' property at IT's current buffer
2153 position. (The `fontified' property doesn't have a special
2154 meaning in strings.) If the value is nil, call functions from
2155 Qfontification_functions. */
2156 if (!STRINGP (it
->string
)
2158 && !NILP (Vfontification_functions
)
2159 && !NILP (Vrun_hooks
)
2160 && (pos
= make_number (IT_CHARPOS (*it
)),
2161 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
2164 int count
= BINDING_STACK_SIZE ();
2167 val
= Vfontification_functions
;
2168 specbind (Qfontification_functions
, Qnil
);
2169 specbind (Qafter_change_functions
, Qnil
);
2171 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
2172 safe_call1 (val
, pos
);
2175 Lisp_Object globals
, fn
;
2176 struct gcpro gcpro1
, gcpro2
;
2179 GCPRO2 (val
, globals
);
2181 for (; CONSP (val
); val
= XCDR (val
))
2187 /* A value of t indicates this hook has a local
2188 binding; it means to run the global binding too.
2189 In a global value, t should not occur. If it
2190 does, we must ignore it to avoid an endless
2192 for (globals
= Fdefault_value (Qfontification_functions
);
2194 globals
= XCDR (globals
))
2196 fn
= XCAR (globals
);
2198 safe_call1 (fn
, pos
);
2202 safe_call1 (fn
, pos
);
2208 unbind_to (count
, Qnil
);
2210 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
2211 something. This avoids an endless loop if they failed to
2212 fontify the text for which reason ever. */
2213 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
2214 handled
= HANDLED_RECOMPUTE_PROPS
;
2222 /***********************************************************************
2224 ***********************************************************************/
2226 /* Set up iterator IT from face properties at its current position.
2227 Called from handle_stop. */
2229 static enum prop_handled
2230 handle_face_prop (it
)
2233 int new_face_id
, next_stop
;
2235 if (!STRINGP (it
->string
))
2238 = face_at_buffer_position (it
->w
,
2240 it
->region_beg_charpos
,
2241 it
->region_end_charpos
,
2244 + TEXT_PROP_DISTANCE_LIMIT
),
2247 /* Is this a start of a run of characters with box face?
2248 Caveat: this can be called for a freshly initialized
2249 iterator; face_id is -1 is this case. We know that the new
2250 face will not change until limit, i.e. if the new face has a
2251 box, all characters up to limit will have one. But, as
2252 usual, we don't know whether limit is really the end. */
2253 if (new_face_id
!= it
->face_id
)
2255 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
2257 /* If new face has a box but old face has not, this is
2258 the start of a run of characters with box, i.e. it has
2259 a shadow on the left side. The value of face_id of the
2260 iterator will be -1 if this is the initial call that gets
2261 the face. In this case, we have to look in front of IT's
2262 position and see whether there is a face != new_face_id. */
2263 it
->start_of_box_run_p
2264 = (new_face
->box
!= FACE_NO_BOX
2265 && (it
->face_id
>= 0
2266 || IT_CHARPOS (*it
) == BEG
2267 || new_face_id
!= face_before_it_pos (it
)));
2268 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
2273 int base_face_id
, bufpos
;
2275 if (it
->current
.overlay_string_index
>= 0)
2276 bufpos
= IT_CHARPOS (*it
);
2280 /* For strings from a buffer, i.e. overlay strings or strings
2281 from a `display' property, use the face at IT's current
2282 buffer position as the base face to merge with, so that
2283 overlay strings appear in the same face as surrounding
2284 text, unless they specify their own faces. */
2285 base_face_id
= underlying_face_id (it
);
2287 new_face_id
= face_at_string_position (it
->w
,
2289 IT_STRING_CHARPOS (*it
),
2291 it
->region_beg_charpos
,
2292 it
->region_end_charpos
,
2296 #if 0 /* This shouldn't be neccessary. Let's check it. */
2297 /* If IT is used to display a mode line we would really like to
2298 use the mode line face instead of the frame's default face. */
2299 if (it
->glyph_row
== MATRIX_MODE_LINE_ROW (it
->w
->desired_matrix
)
2300 && new_face_id
== DEFAULT_FACE_ID
)
2301 new_face_id
= MODE_LINE_FACE_ID
;
2304 /* Is this a start of a run of characters with box? Caveat:
2305 this can be called for a freshly allocated iterator; face_id
2306 is -1 is this case. We know that the new face will not
2307 change until the next check pos, i.e. if the new face has a
2308 box, all characters up to that position will have a
2309 box. But, as usual, we don't know whether that position
2310 is really the end. */
2311 if (new_face_id
!= it
->face_id
)
2313 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
2314 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
2316 /* If new face has a box but old face hasn't, this is the
2317 start of a run of characters with box, i.e. it has a
2318 shadow on the left side. */
2319 it
->start_of_box_run_p
2320 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
2321 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
2325 it
->face_id
= new_face_id
;
2326 return HANDLED_NORMALLY
;
2330 /* Return the ID of the face ``underlying'' IT's current position,
2331 which is in a string. If the iterator is associated with a
2332 buffer, return the face at IT's current buffer position.
2333 Otherwise, use the iterator's base_face_id. */
2336 underlying_face_id (it
)
2339 int face_id
= it
->base_face_id
, i
;
2341 xassert (STRINGP (it
->string
));
2343 for (i
= it
->sp
- 1; i
>= 0; --i
)
2344 if (NILP (it
->stack
[i
].string
))
2345 face_id
= it
->stack
[i
].face_id
;
2351 /* Compute the face one character before or after the current position
2352 of IT. BEFORE_P non-zero means get the face in front of IT's
2353 position. Value is the id of the face. */
2356 face_before_or_after_it_pos (it
, before_p
)
2361 int next_check_charpos
;
2362 struct text_pos pos
;
2364 xassert (it
->s
== NULL
);
2366 if (STRINGP (it
->string
))
2368 int bufpos
, base_face_id
;
2370 /* No face change past the end of the string (for the case
2371 we are padding with spaces). No face change before the
2373 if (IT_STRING_CHARPOS (*it
) >= XSTRING (it
->string
)->size
2374 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
2377 /* Set pos to the position before or after IT's current position. */
2379 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
2381 /* For composition, we must check the character after the
2383 pos
= (it
->what
== IT_COMPOSITION
2384 ? string_pos (IT_STRING_CHARPOS (*it
) + it
->cmp_len
, it
->string
)
2385 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
2387 if (it
->current
.overlay_string_index
>= 0)
2388 bufpos
= IT_CHARPOS (*it
);
2392 base_face_id
= underlying_face_id (it
);
2394 /* Get the face for ASCII, or unibyte. */
2395 face_id
= face_at_string_position (it
->w
,
2399 it
->region_beg_charpos
,
2400 it
->region_end_charpos
,
2401 &next_check_charpos
,
2404 /* Correct the face for charsets different from ASCII. Do it
2405 for the multibyte case only. The face returned above is
2406 suitable for unibyte text if IT->string is unibyte. */
2407 if (STRING_MULTIBYTE (it
->string
))
2409 unsigned char *p
= XSTRING (it
->string
)->data
+ BYTEPOS (pos
);
2410 int rest
= STRING_BYTES (XSTRING (it
->string
)) - BYTEPOS (pos
);
2412 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
2414 c
= string_char_and_length (p
, rest
, &len
);
2415 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
);
2420 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
2421 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
2424 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
2425 pos
= it
->current
.pos
;
2428 DEC_TEXT_POS (pos
, it
->multibyte_p
);
2431 if (it
->what
== IT_COMPOSITION
)
2432 /* For composition, we must check the position after the
2434 pos
.charpos
+= it
->cmp_len
, pos
.bytepos
+= it
->len
;
2436 INC_TEXT_POS (pos
, it
->multibyte_p
);
2439 /* Determine face for CHARSET_ASCII, or unibyte. */
2440 face_id
= face_at_buffer_position (it
->w
,
2442 it
->region_beg_charpos
,
2443 it
->region_end_charpos
,
2444 &next_check_charpos
,
2447 /* Correct the face for charsets different from ASCII. Do it
2448 for the multibyte case only. The face returned above is
2449 suitable for unibyte text if current_buffer is unibyte. */
2450 if (it
->multibyte_p
)
2452 int c
= FETCH_MULTIBYTE_CHAR (CHARPOS (pos
));
2453 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
2454 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
);
2463 /***********************************************************************
2465 ***********************************************************************/
2467 /* Set up iterator IT from invisible properties at its current
2468 position. Called from handle_stop. */
2470 static enum prop_handled
2471 handle_invisible_prop (it
)
2474 enum prop_handled handled
= HANDLED_NORMALLY
;
2476 if (STRINGP (it
->string
))
2478 extern Lisp_Object Qinvisible
;
2479 Lisp_Object prop
, end_charpos
, limit
, charpos
;
2481 /* Get the value of the invisible text property at the
2482 current position. Value will be nil if there is no such
2484 charpos
= make_number (IT_STRING_CHARPOS (*it
));
2485 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
2488 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
2490 handled
= HANDLED_RECOMPUTE_PROPS
;
2492 /* Get the position at which the next change of the
2493 invisible text property can be found in IT->string.
2494 Value will be nil if the property value is the same for
2495 all the rest of IT->string. */
2496 XSETINT (limit
, XSTRING (it
->string
)->size
);
2497 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
2500 /* Text at current position is invisible. The next
2501 change in the property is at position end_charpos.
2502 Move IT's current position to that position. */
2503 if (INTEGERP (end_charpos
)
2504 && XFASTINT (end_charpos
) < XFASTINT (limit
))
2506 struct text_pos old
;
2507 old
= it
->current
.string_pos
;
2508 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
2509 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
2513 /* The rest of the string is invisible. If this is an
2514 overlay string, proceed with the next overlay string
2515 or whatever comes and return a character from there. */
2516 if (it
->current
.overlay_string_index
>= 0)
2518 next_overlay_string (it
);
2519 /* Don't check for overlay strings when we just
2520 finished processing them. */
2521 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
2525 struct Lisp_String
*s
= XSTRING (it
->string
);
2526 IT_STRING_CHARPOS (*it
) = s
->size
;
2527 IT_STRING_BYTEPOS (*it
) = STRING_BYTES (s
);
2534 int visible_p
, newpos
, next_stop
;
2535 Lisp_Object pos
, prop
;
2537 /* First of all, is there invisible text at this position? */
2538 pos
= make_number (IT_CHARPOS (*it
));
2539 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
2541 /* If we are on invisible text, skip over it. */
2542 if (TEXT_PROP_MEANS_INVISIBLE (prop
)
2543 && IT_CHARPOS (*it
) < it
->end_charpos
)
2545 /* Record whether we have to display an ellipsis for the
2547 int display_ellipsis_p
2548 = TEXT_PROP_MEANS_INVISIBLE_WITH_ELLIPSIS (prop
);
2550 handled
= HANDLED_RECOMPUTE_PROPS
;
2552 /* Loop skipping over invisible text. The loop is left at
2553 ZV or with IT on the first char being visible again. */
2556 /* Try to skip some invisible text. Return value is the
2557 position reached which can be equal to IT's position
2558 if there is nothing invisible here. This skips both
2559 over invisible text properties and overlays with
2560 invisible property. */
2561 newpos
= skip_invisible (IT_CHARPOS (*it
),
2562 &next_stop
, ZV
, it
->window
);
2564 /* If we skipped nothing at all we weren't at invisible
2565 text in the first place. If everything to the end of
2566 the buffer was skipped, end the loop. */
2567 if (newpos
== IT_CHARPOS (*it
) || newpos
>= ZV
)
2571 /* We skipped some characters but not necessarily
2572 all there are. Check if we ended up on visible
2573 text. Fget_char_property returns the property of
2574 the char before the given position, i.e. if we
2575 get visible_p = 1, this means that the char at
2576 newpos is visible. */
2577 pos
= make_number (newpos
);
2578 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
2579 visible_p
= !TEXT_PROP_MEANS_INVISIBLE (prop
);
2582 /* If we ended up on invisible text, proceed to
2583 skip starting with next_stop. */
2585 IT_CHARPOS (*it
) = next_stop
;
2589 /* The position newpos is now either ZV or on visible text. */
2590 IT_CHARPOS (*it
) = newpos
;
2591 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
2593 /* Maybe return `...' next for the end of the invisible text. */
2594 if (display_ellipsis_p
)
2597 && VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
2599 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
2600 it
->dpvec
= v
->contents
;
2601 it
->dpend
= v
->contents
+ v
->size
;
2605 /* Default `...'. */
2606 it
->dpvec
= default_invis_vector
;
2607 it
->dpend
= default_invis_vector
+ 3;
2610 /* The ellipsis display does not replace the display of
2611 the character at the new position. Indicate this by
2612 setting IT->dpvec_char_len to zero. */
2613 it
->dpvec_char_len
= 0;
2615 it
->current
.dpvec_index
= 0;
2616 it
->method
= next_element_from_display_vector
;
2626 /***********************************************************************
2628 ***********************************************************************/
2630 /* Set up iterator IT from `display' property at its current position.
2631 Called from handle_stop. */
2633 static enum prop_handled
2634 handle_display_prop (it
)
2637 Lisp_Object prop
, object
;
2638 struct text_pos
*position
;
2639 int display_replaced_p
= 0;
2641 if (STRINGP (it
->string
))
2643 object
= it
->string
;
2644 position
= &it
->current
.string_pos
;
2648 object
= it
->w
->buffer
;
2649 position
= &it
->current
.pos
;
2652 /* Reset those iterator values set from display property values. */
2653 it
->font_height
= Qnil
;
2654 it
->space_width
= Qnil
;
2657 /* We don't support recursive `display' properties, i.e. string
2658 values that have a string `display' property, that have a string
2659 `display' property etc. */
2660 if (!it
->string_from_display_prop_p
)
2661 it
->area
= TEXT_AREA
;
2663 prop
= Fget_char_property (make_number (position
->charpos
),
2666 return HANDLED_NORMALLY
;
2669 /* Simple properties. */
2670 && !EQ (XCAR (prop
), Qimage
)
2671 && !EQ (XCAR (prop
), Qspace
)
2672 && !EQ (XCAR (prop
), Qwhen
)
2673 && !EQ (XCAR (prop
), Qspace_width
)
2674 && !EQ (XCAR (prop
), Qheight
)
2675 && !EQ (XCAR (prop
), Qraise
)
2676 /* Marginal area specifications. */
2677 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
2678 && !NILP (XCAR (prop
)))
2680 for (; CONSP (prop
); prop
= XCDR (prop
))
2682 if (handle_single_display_prop (it
, XCAR (prop
), object
,
2683 position
, display_replaced_p
))
2684 display_replaced_p
= 1;
2687 else if (VECTORP (prop
))
2690 for (i
= 0; i
< ASIZE (prop
); ++i
)
2691 if (handle_single_display_prop (it
, AREF (prop
, i
), object
,
2692 position
, display_replaced_p
))
2693 display_replaced_p
= 1;
2697 if (handle_single_display_prop (it
, prop
, object
, position
, 0))
2698 display_replaced_p
= 1;
2701 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
2705 /* Value is the position of the end of the `display' property starting
2706 at START_POS in OBJECT. */
2708 static struct text_pos
2709 display_prop_end (it
, object
, start_pos
)
2712 struct text_pos start_pos
;
2715 struct text_pos end_pos
;
2717 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
2718 Qdisplay
, object
, Qnil
);
2719 CHARPOS (end_pos
) = XFASTINT (end
);
2720 if (STRINGP (object
))
2721 compute_string_pos (&end_pos
, start_pos
, it
->string
);
2723 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
2729 /* Set up IT from a single `display' sub-property value PROP. OBJECT
2730 is the object in which the `display' property was found. *POSITION
2731 is the position at which it was found. DISPLAY_REPLACED_P non-zero
2732 means that we previously saw a display sub-property which already
2733 replaced text display with something else, for example an image;
2734 ignore such properties after the first one has been processed.
2736 If PROP is a `space' or `image' sub-property, set *POSITION to the
2737 end position of the `display' property.
2739 Value is non-zero something was found which replaces the display
2740 of buffer or string text. */
2743 handle_single_display_prop (it
, prop
, object
, position
,
2744 display_replaced_before_p
)
2748 struct text_pos
*position
;
2749 int display_replaced_before_p
;
2752 int replaces_text_display_p
= 0;
2755 /* If PROP is a list of the form `(when FORM . VALUE)', FORM is
2756 evaluated. If the result is nil, VALUE is ignored. */
2758 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
2767 if (!NILP (form
) && !EQ (form
, Qt
))
2769 struct gcpro gcpro1
;
2770 struct text_pos end_pos
, pt
;
2773 end_pos
= display_prop_end (it
, object
, *position
);
2775 /* Temporarily set point to the end position, and then evaluate
2776 the form. This makes `(eolp)' work as FORM. */
2777 if (BUFFERP (object
))
2780 BYTEPOS (pt
) = PT_BYTE
;
2781 TEMP_SET_PT_BOTH (CHARPOS (end_pos
), BYTEPOS (end_pos
));
2784 form
= safe_eval (form
);
2786 if (BUFFERP (object
))
2787 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
2795 && EQ (XCAR (prop
), Qheight
)
2796 && CONSP (XCDR (prop
)))
2798 if (FRAME_TERMCAP_P (it
->f
) || FRAME_MSDOS_P (it
->f
))
2801 /* `(height HEIGHT)'. */
2802 it
->font_height
= XCAR (XCDR (prop
));
2803 if (!NILP (it
->font_height
))
2805 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
2806 int new_height
= -1;
2808 if (CONSP (it
->font_height
)
2809 && (EQ (XCAR (it
->font_height
), Qplus
)
2810 || EQ (XCAR (it
->font_height
), Qminus
))
2811 && CONSP (XCDR (it
->font_height
))
2812 && INTEGERP (XCAR (XCDR (it
->font_height
))))
2814 /* `(+ N)' or `(- N)' where N is an integer. */
2815 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
2816 if (EQ (XCAR (it
->font_height
), Qplus
))
2818 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
2820 else if (FUNCTIONP (it
->font_height
))
2822 /* Call function with current height as argument.
2823 Value is the new height. */
2825 height
= safe_call1 (it
->font_height
,
2826 face
->lface
[LFACE_HEIGHT_INDEX
]);
2827 if (NUMBERP (height
))
2828 new_height
= XFLOATINT (height
);
2830 else if (NUMBERP (it
->font_height
))
2832 /* Value is a multiple of the canonical char height. */
2835 face
= FACE_FROM_ID (it
->f
, DEFAULT_FACE_ID
);
2836 new_height
= (XFLOATINT (it
->font_height
)
2837 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
2841 /* Evaluate IT->font_height with `height' bound to the
2842 current specified height to get the new height. */
2844 int count
= BINDING_STACK_SIZE ();
2846 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
2847 value
= safe_eval (it
->font_height
);
2848 unbind_to (count
, Qnil
);
2850 if (NUMBERP (value
))
2851 new_height
= XFLOATINT (value
);
2855 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
2858 else if (CONSP (prop
)
2859 && EQ (XCAR (prop
), Qspace_width
)
2860 && CONSP (XCDR (prop
)))
2862 /* `(space_width WIDTH)'. */
2863 if (FRAME_TERMCAP_P (it
->f
) || FRAME_MSDOS_P (it
->f
))
2866 value
= XCAR (XCDR (prop
));
2867 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
2868 it
->space_width
= value
;
2870 else if (CONSP (prop
)
2871 && EQ (XCAR (prop
), Qraise
)
2872 && CONSP (XCDR (prop
)))
2874 /* `(raise FACTOR)'. */
2875 if (FRAME_TERMCAP_P (it
->f
) || FRAME_MSDOS_P (it
->f
))
2878 #ifdef HAVE_WINDOW_SYSTEM
2879 value
= XCAR (XCDR (prop
));
2880 if (NUMBERP (value
))
2882 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
2883 it
->voffset
= - (XFLOATINT (value
)
2884 * (FONT_HEIGHT (face
->font
)));
2886 #endif /* HAVE_WINDOW_SYSTEM */
2888 else if (!it
->string_from_display_prop_p
)
2890 /* `((margin left-margin) VALUE)' or `((margin right-margin)
2891 VALUE) or `((margin nil) VALUE)' or VALUE. */
2892 Lisp_Object location
, value
;
2893 struct text_pos start_pos
;
2896 /* Characters having this form of property are not displayed, so
2897 we have to find the end of the property. */
2898 start_pos
= *position
;
2899 *position
= display_prop_end (it
, object
, start_pos
);
2902 /* Let's stop at the new position and assume that all
2903 text properties change there. */
2904 it
->stop_charpos
= position
->charpos
;
2906 location
= Qunbound
;
2907 if (CONSP (prop
) && CONSP (XCAR (prop
)))
2911 value
= XCDR (prop
);
2913 value
= XCAR (value
);
2916 if (EQ (XCAR (tem
), Qmargin
)
2917 && (tem
= XCDR (tem
),
2918 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
2920 || EQ (tem
, Qleft_margin
)
2921 || EQ (tem
, Qright_margin
))))
2925 if (EQ (location
, Qunbound
))
2931 #ifdef HAVE_WINDOW_SYSTEM
2932 if (FRAME_TERMCAP_P (it
->f
))
2933 valid_p
= STRINGP (value
);
2935 valid_p
= (STRINGP (value
)
2936 || (CONSP (value
) && EQ (XCAR (value
), Qspace
))
2937 || valid_image_p (value
));
2938 #else /* not HAVE_WINDOW_SYSTEM */
2939 valid_p
= STRINGP (value
);
2940 #endif /* not HAVE_WINDOW_SYSTEM */
2942 if ((EQ (location
, Qleft_margin
)
2943 || EQ (location
, Qright_margin
)
2946 && !display_replaced_before_p
)
2948 replaces_text_display_p
= 1;
2950 /* Save current settings of IT so that we can restore them
2951 when we are finished with the glyph property value. */
2954 if (NILP (location
))
2955 it
->area
= TEXT_AREA
;
2956 else if (EQ (location
, Qleft_margin
))
2957 it
->area
= LEFT_MARGIN_AREA
;
2959 it
->area
= RIGHT_MARGIN_AREA
;
2961 if (STRINGP (value
))
2964 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
2965 it
->current
.overlay_string_index
= -1;
2966 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
2967 it
->end_charpos
= it
->string_nchars
2968 = XSTRING (it
->string
)->size
;
2969 it
->method
= next_element_from_string
;
2970 it
->stop_charpos
= 0;
2971 it
->string_from_display_prop_p
= 1;
2972 /* Say that we haven't consumed the characters with
2973 `display' property yet. The call to pop_it in
2974 set_iterator_to_next will clean this up. */
2975 *position
= start_pos
;
2977 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
2979 it
->method
= next_element_from_stretch
;
2981 it
->current
.pos
= it
->position
= start_pos
;
2983 #ifdef HAVE_WINDOW_SYSTEM
2986 it
->what
= IT_IMAGE
;
2987 it
->image_id
= lookup_image (it
->f
, value
);
2988 it
->position
= start_pos
;
2989 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
2990 it
->method
= next_element_from_image
;
2992 /* Say that we haven't consumed the characters with
2993 `display' property yet. The call to pop_it in
2994 set_iterator_to_next will clean this up. */
2995 *position
= start_pos
;
2997 #endif /* HAVE_WINDOW_SYSTEM */
3000 /* Invalid property or property not supported. Restore
3001 the position to what it was before. */
3002 *position
= start_pos
;
3005 return replaces_text_display_p
;
3009 /* Check if PROP is a display sub-property value whose text should be
3010 treated as intangible. */
3013 single_display_prop_intangible_p (prop
)
3016 /* Skip over `when FORM'. */
3017 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
3028 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
3029 we don't need to treat text as intangible. */
3030 if (EQ (XCAR (prop
), Qmargin
))
3038 || EQ (XCAR (prop
), Qleft_margin
)
3039 || EQ (XCAR (prop
), Qright_margin
))
3043 return CONSP (prop
) && EQ (XCAR (prop
), Qimage
);
3047 /* Check if PROP is a display property value whose text should be
3048 treated as intangible. */
3051 display_prop_intangible_p (prop
)
3055 && CONSP (XCAR (prop
))
3056 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
3058 /* A list of sub-properties. */
3059 while (CONSP (prop
))
3061 if (single_display_prop_intangible_p (XCAR (prop
)))
3066 else if (VECTORP (prop
))
3068 /* A vector of sub-properties. */
3070 for (i
= 0; i
< ASIZE (prop
); ++i
)
3071 if (single_display_prop_intangible_p (AREF (prop
, i
)))
3075 return single_display_prop_intangible_p (prop
);
3081 /* Return 1 if PROP is a display sub-property value containing STRING. */
3084 single_display_prop_string_p (prop
, string
)
3085 Lisp_Object prop
, string
;
3087 extern Lisp_Object Qwhen
, Qmargin
;
3089 if (EQ (string
, prop
))
3092 /* Skip over `when FORM'. */
3093 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
3102 /* Skip over `margin LOCATION'. */
3103 if (EQ (XCAR (prop
), Qmargin
))
3114 return CONSP (prop
) && EQ (XCAR (prop
), string
);
3118 /* Return 1 if STRING appears in the `display' property PROP. */
3121 display_prop_string_p (prop
, string
)
3122 Lisp_Object prop
, string
;
3124 extern Lisp_Object Qwhen
, Qmargin
;
3127 && CONSP (XCAR (prop
))
3128 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
3130 /* A list of sub-properties. */
3131 while (CONSP (prop
))
3133 if (single_display_prop_string_p (XCAR (prop
), string
))
3138 else if (VECTORP (prop
))
3140 /* A vector of sub-properties. */
3142 for (i
= 0; i
< ASIZE (prop
); ++i
)
3143 if (single_display_prop_string_p (AREF (prop
, i
), string
))
3147 return single_display_prop_string_p (prop
, string
);
3153 /* Determine from which buffer position in W's buffer STRING comes
3154 from. AROUND_CHARPOS is an approximate position where it could
3155 be from. Value is the buffer position or 0 if it couldn't be
3158 W's buffer must be current.
3160 This function is necessary because we don't record buffer positions
3161 in glyphs generated from strings (to keep struct glyph small).
3162 This function may only use code that doesn't eval because it is
3163 called asynchronously from note_mouse_highlight. */
3166 string_buffer_position (w
, string
, around_charpos
)
3171 Lisp_Object around
= make_number (around_charpos
);
3172 Lisp_Object limit
, prop
, pos
;
3173 const int MAX_DISTANCE
= 1000;
3176 pos
= make_number (around_charpos
);
3177 limit
= make_number (min (XINT (pos
) + MAX_DISTANCE
, ZV
));
3178 while (!found
&& !EQ (pos
, limit
))
3180 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
3181 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
3184 pos
= Fnext_single_property_change (pos
, Qdisplay
, Qnil
, limit
);
3189 pos
= make_number (around_charpos
);
3190 limit
= make_number (max (XINT (pos
) - MAX_DISTANCE
, BEGV
));
3191 while (!found
&& !EQ (pos
, limit
))
3193 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
3194 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
3197 pos
= Fprevious_single_property_change (pos
, Qdisplay
, Qnil
,
3202 return found
? XINT (pos
) : 0;
3207 /***********************************************************************
3208 `composition' property
3209 ***********************************************************************/
3211 /* Set up iterator IT from `composition' property at its current
3212 position. Called from handle_stop. */
3214 static enum prop_handled
3215 handle_composition_prop (it
)
3218 Lisp_Object prop
, string
;
3219 int pos
, pos_byte
, end
;
3220 enum prop_handled handled
= HANDLED_NORMALLY
;
3222 if (STRINGP (it
->string
))
3224 pos
= IT_STRING_CHARPOS (*it
);
3225 pos_byte
= IT_STRING_BYTEPOS (*it
);
3226 string
= it
->string
;
3230 pos
= IT_CHARPOS (*it
);
3231 pos_byte
= IT_BYTEPOS (*it
);
3235 /* If there's a valid composition and point is not inside of the
3236 composition (in the case that the composition is from the current
3237 buffer), draw a glyph composed from the composition components. */
3238 if (find_composition (pos
, -1, &pos
, &end
, &prop
, string
)
3239 && COMPOSITION_VALID_P (pos
, end
, prop
)
3240 && (STRINGP (it
->string
) || (PT
<= pos
|| PT
>= end
)))
3242 int id
= get_composition_id (pos
, pos_byte
, end
- pos
, prop
, string
);
3246 it
->method
= next_element_from_composition
;
3248 it
->cmp_len
= COMPOSITION_LENGTH (prop
);
3249 /* For a terminal, draw only the first character of the
3251 it
->c
= COMPOSITION_GLYPH (composition_table
[id
], 0);
3252 it
->len
= (STRINGP (it
->string
)
3253 ? string_char_to_byte (it
->string
, end
)
3254 : CHAR_TO_BYTE (end
)) - pos_byte
;
3255 it
->stop_charpos
= end
;
3256 handled
= HANDLED_RETURN
;
3265 /***********************************************************************
3267 ***********************************************************************/
3269 /* The following structure is used to record overlay strings for
3270 later sorting in load_overlay_strings. */
3272 struct overlay_entry
3274 Lisp_Object overlay
;
3281 /* Set up iterator IT from overlay strings at its current position.
3282 Called from handle_stop. */
3284 static enum prop_handled
3285 handle_overlay_change (it
)
3288 if (!STRINGP (it
->string
) && get_overlay_strings (it
))
3289 return HANDLED_RECOMPUTE_PROPS
;
3291 return HANDLED_NORMALLY
;
3295 /* Set up the next overlay string for delivery by IT, if there is an
3296 overlay string to deliver. Called by set_iterator_to_next when the
3297 end of the current overlay string is reached. If there are more
3298 overlay strings to display, IT->string and
3299 IT->current.overlay_string_index are set appropriately here.
3300 Otherwise IT->string is set to nil. */
3303 next_overlay_string (it
)
3306 ++it
->current
.overlay_string_index
;
3307 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
3309 /* No more overlay strings. Restore IT's settings to what
3310 they were before overlay strings were processed, and
3311 continue to deliver from current_buffer. */
3313 xassert (it
->stop_charpos
>= BEGV
3314 && it
->stop_charpos
<= it
->end_charpos
);
3316 it
->current
.overlay_string_index
= -1;
3317 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
3318 it
->n_overlay_strings
= 0;
3319 it
->method
= next_element_from_buffer
;
3321 /* If we're at the end of the buffer, record that we have
3322 processed the overlay strings there already, so that
3323 next_element_from_buffer doesn't try it again. */
3324 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
3325 it
->overlay_strings_at_end_processed_p
= 1;
3329 /* There are more overlay strings to process. If
3330 IT->current.overlay_string_index has advanced to a position
3331 where we must load IT->overlay_strings with more strings, do
3333 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
3335 if (it
->current
.overlay_string_index
&& i
== 0)
3336 load_overlay_strings (it
);
3338 /* Initialize IT to deliver display elements from the overlay
3340 it
->string
= it
->overlay_strings
[i
];
3341 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
3342 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
3343 it
->method
= next_element_from_string
;
3344 it
->stop_charpos
= 0;
3351 /* Compare two overlay_entry structures E1 and E2. Used as a
3352 comparison function for qsort in load_overlay_strings. Overlay
3353 strings for the same position are sorted so that
3355 1. All after-strings come in front of before-strings, except
3356 when they come from the same overlay.
3358 2. Within after-strings, strings are sorted so that overlay strings
3359 from overlays with higher priorities come first.
3361 2. Within before-strings, strings are sorted so that overlay
3362 strings from overlays with higher priorities come last.
3364 Value is analogous to strcmp. */
3368 compare_overlay_entries (e1
, e2
)
3371 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
3372 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
3375 if (entry1
->after_string_p
!= entry2
->after_string_p
)
3377 /* Let after-strings appear in front of before-strings if
3378 they come from different overlays. */
3379 if (EQ (entry1
->overlay
, entry2
->overlay
))
3380 result
= entry1
->after_string_p
? 1 : -1;
3382 result
= entry1
->after_string_p
? -1 : 1;
3384 else if (entry1
->after_string_p
)
3385 /* After-strings sorted in order of decreasing priority. */
3386 result
= entry2
->priority
- entry1
->priority
;
3388 /* Before-strings sorted in order of increasing priority. */
3389 result
= entry1
->priority
- entry2
->priority
;
3395 /* Load the vector IT->overlay_strings with overlay strings from IT's
3396 current buffer position. Set IT->n_overlays to the total number of
3397 overlay strings found.
3399 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
3400 a time. On entry into load_overlay_strings,
3401 IT->current.overlay_string_index gives the number of overlay
3402 strings that have already been loaded by previous calls to this
3405 IT->add_overlay_start contains an additional overlay start
3406 position to consider for taking overlay strings from, if non-zero.
3407 This position comes into play when the overlay has an `invisible'
3408 property, and both before and after-strings. When we've skipped to
3409 the end of the overlay, because of its `invisible' property, we
3410 nevertheless want its before-string to appear.
3411 IT->add_overlay_start will contain the overlay start position
3414 Overlay strings are sorted so that after-string strings come in
3415 front of before-string strings. Within before and after-strings,
3416 strings are sorted by overlay priority. See also function
3417 compare_overlay_entries. */
3420 load_overlay_strings (it
)
3423 extern Lisp_Object Qafter_string
, Qbefore_string
, Qwindow
, Qpriority
;
3424 Lisp_Object ov
, overlay
, window
, str
, invisible
;
3427 int n
= 0, i
, j
, invis_p
;
3428 struct overlay_entry
*entries
3429 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
3430 int charpos
= IT_CHARPOS (*it
);
3432 /* Append the overlay string STRING of overlay OVERLAY to vector
3433 `entries' which has size `size' and currently contains `n'
3434 elements. AFTER_P non-zero means STRING is an after-string of
3436 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
3439 Lisp_Object priority; \
3443 int new_size = 2 * size; \
3444 struct overlay_entry *old = entries; \
3446 (struct overlay_entry *) alloca (new_size \
3447 * sizeof *entries); \
3448 bcopy (old, entries, size * sizeof *entries); \
3452 entries[n].string = (STRING); \
3453 entries[n].overlay = (OVERLAY); \
3454 priority = Foverlay_get ((OVERLAY), Qpriority); \
3455 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
3456 entries[n].after_string_p = (AFTER_P); \
3461 /* Process overlay before the overlay center. */
3462 for (ov
= current_buffer
->overlays_before
; CONSP (ov
); ov
= XCDR (ov
))
3464 overlay
= XCAR (ov
);
3465 xassert (OVERLAYP (overlay
));
3466 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3467 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3472 /* Skip this overlay if it doesn't start or end at IT's current
3474 if (end
!= charpos
&& start
!= charpos
)
3477 /* Skip this overlay if it doesn't apply to IT->w. */
3478 window
= Foverlay_get (overlay
, Qwindow
);
3479 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
3482 /* If the text ``under'' the overlay is invisible, both before-
3483 and after-strings from this overlay are visible; start and
3484 end position are indistinguishable. */
3485 invisible
= Foverlay_get (overlay
, Qinvisible
);
3486 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
3488 /* If overlay has a non-empty before-string, record it. */
3489 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
3490 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
3491 && XSTRING (str
)->size
)
3492 RECORD_OVERLAY_STRING (overlay
, str
, 0);
3494 /* If overlay has a non-empty after-string, record it. */
3495 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
3496 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
3497 && XSTRING (str
)->size
)
3498 RECORD_OVERLAY_STRING (overlay
, str
, 1);
3501 /* Process overlays after the overlay center. */
3502 for (ov
= current_buffer
->overlays_after
; CONSP (ov
); ov
= XCDR (ov
))
3504 overlay
= XCAR (ov
);
3505 xassert (OVERLAYP (overlay
));
3506 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3507 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3509 if (start
> charpos
)
3512 /* Skip this overlay if it doesn't start or end at IT's current
3514 if (end
!= charpos
&& start
!= charpos
)
3517 /* Skip this overlay if it doesn't apply to IT->w. */
3518 window
= Foverlay_get (overlay
, Qwindow
);
3519 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
3522 /* If the text ``under'' the overlay is invisible, it has a zero
3523 dimension, and both before- and after-strings apply. */
3524 invisible
= Foverlay_get (overlay
, Qinvisible
);
3525 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
3527 /* If overlay has a non-empty before-string, record it. */
3528 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
3529 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
3530 && XSTRING (str
)->size
)
3531 RECORD_OVERLAY_STRING (overlay
, str
, 0);
3533 /* If overlay has a non-empty after-string, record it. */
3534 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
3535 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
3536 && XSTRING (str
)->size
)
3537 RECORD_OVERLAY_STRING (overlay
, str
, 1);
3540 #undef RECORD_OVERLAY_STRING
3544 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
3546 /* Record the total number of strings to process. */
3547 it
->n_overlay_strings
= n
;
3549 /* IT->current.overlay_string_index is the number of overlay strings
3550 that have already been consumed by IT. Copy some of the
3551 remaining overlay strings to IT->overlay_strings. */
3553 j
= it
->current
.overlay_string_index
;
3554 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
3555 it
->overlay_strings
[i
++] = entries
[j
++].string
;
3561 /* Get the first chunk of overlay strings at IT's current buffer
3562 position. Value is non-zero if at least one overlay string was
3566 get_overlay_strings (it
)
3569 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
3570 process. This fills IT->overlay_strings with strings, and sets
3571 IT->n_overlay_strings to the total number of strings to process.
3572 IT->pos.overlay_string_index has to be set temporarily to zero
3573 because load_overlay_strings needs this; it must be set to -1
3574 when no overlay strings are found because a zero value would
3575 indicate a position in the first overlay string. */
3576 it
->current
.overlay_string_index
= 0;
3577 load_overlay_strings (it
);
3579 /* If we found overlay strings, set up IT to deliver display
3580 elements from the first one. Otherwise set up IT to deliver
3581 from current_buffer. */
3582 if (it
->n_overlay_strings
)
3584 /* Make sure we know settings in current_buffer, so that we can
3585 restore meaningful values when we're done with the overlay
3587 compute_stop_pos (it
);
3588 xassert (it
->face_id
>= 0);
3590 /* Save IT's settings. They are restored after all overlay
3591 strings have been processed. */
3592 xassert (it
->sp
== 0);
3595 /* Set up IT to deliver display elements from the first overlay
3597 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
3598 it
->string
= it
->overlay_strings
[0];
3599 it
->stop_charpos
= 0;
3600 it
->end_charpos
= XSTRING (it
->string
)->size
;
3601 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
3602 xassert (STRINGP (it
->string
));
3603 it
->method
= next_element_from_string
;
3608 it
->current
.overlay_string_index
= -1;
3609 it
->method
= next_element_from_buffer
;
3614 /* Value is non-zero if we found at least one overlay string. */
3615 return STRINGP (it
->string
);
3620 /***********************************************************************
3621 Saving and restoring state
3622 ***********************************************************************/
3624 /* Save current settings of IT on IT->stack. Called, for example,
3625 before setting up IT for an overlay string, to be able to restore
3626 IT's settings to what they were after the overlay string has been
3633 struct iterator_stack_entry
*p
;
3635 xassert (it
->sp
< 2);
3636 p
= it
->stack
+ it
->sp
;
3638 p
->stop_charpos
= it
->stop_charpos
;
3639 xassert (it
->face_id
>= 0);
3640 p
->face_id
= it
->face_id
;
3641 p
->string
= it
->string
;
3642 p
->pos
= it
->current
;
3643 p
->end_charpos
= it
->end_charpos
;
3644 p
->string_nchars
= it
->string_nchars
;
3646 p
->multibyte_p
= it
->multibyte_p
;
3647 p
->space_width
= it
->space_width
;
3648 p
->font_height
= it
->font_height
;
3649 p
->voffset
= it
->voffset
;
3650 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
3655 /* Restore IT's settings from IT->stack. Called, for example, when no
3656 more overlay strings must be processed, and we return to delivering
3657 display elements from a buffer, or when the end of a string from a
3658 `display' property is reached and we return to delivering display
3659 elements from an overlay string, or from a buffer. */
3665 struct iterator_stack_entry
*p
;
3667 xassert (it
->sp
> 0);
3669 p
= it
->stack
+ it
->sp
;
3670 it
->stop_charpos
= p
->stop_charpos
;
3671 it
->face_id
= p
->face_id
;
3672 it
->string
= p
->string
;
3673 it
->current
= p
->pos
;
3674 it
->end_charpos
= p
->end_charpos
;
3675 it
->string_nchars
= p
->string_nchars
;
3677 it
->multibyte_p
= p
->multibyte_p
;
3678 it
->space_width
= p
->space_width
;
3679 it
->font_height
= p
->font_height
;
3680 it
->voffset
= p
->voffset
;
3681 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
3686 /***********************************************************************
3688 ***********************************************************************/
3690 /* Set IT's current position to the previous line start. */
3693 back_to_previous_line_start (it
)
3696 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
3697 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
3701 /* Move IT to the next line start.
3703 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
3704 we skipped over part of the text (as opposed to moving the iterator
3705 continuously over the text). Otherwise, don't change the value
3708 Newlines may come from buffer text, overlay strings, or strings
3709 displayed via the `display' property. That's the reason we can't
3710 simply use find_next_newline_no_quit.
3712 Note that this function may not skip over invisible text that is so
3713 because of text properties and immediately follows a newline. If
3714 it would, function reseat_at_next_visible_line_start, when called
3715 from set_iterator_to_next, would effectively make invisible
3716 characters following a newline part of the wrong glyph row, which
3717 leads to wrong cursor motion. */
3720 forward_to_next_line_start (it
, skipped_p
)
3724 int old_selective
, newline_found_p
, n
;
3725 const int MAX_NEWLINE_DISTANCE
= 500;
3727 /* If already on a newline, just consume it to avoid unintended
3728 skipping over invisible text below. */
3729 if (it
->what
== IT_CHARACTER
3731 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
3733 set_iterator_to_next (it
, 0);
3738 /* Don't handle selective display in the following. It's (a)
3739 unnecessary because it's done by the caller, and (b) leads to an
3740 infinite recursion because next_element_from_ellipsis indirectly
3741 calls this function. */
3742 old_selective
= it
->selective
;
3745 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
3746 from buffer text. */
3747 for (n
= newline_found_p
= 0;
3748 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
3749 n
+= STRINGP (it
->string
) ? 0 : 1)
3751 if (!get_next_display_element (it
))
3753 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
3754 set_iterator_to_next (it
, 0);
3757 /* If we didn't find a newline near enough, see if we can use a
3759 if (n
== MAX_NEWLINE_DISTANCE
)
3761 int start
= IT_CHARPOS (*it
);
3762 int limit
= find_next_newline_no_quit (start
, 1);
3765 xassert (!STRINGP (it
->string
));
3767 /* If there isn't any `display' property in sight, and no
3768 overlays, we can just use the position of the newline in
3770 if (it
->stop_charpos
>= limit
3771 || ((pos
= Fnext_single_property_change (make_number (start
),
3773 Qnil
, make_number (limit
)),
3775 && next_overlay_change (start
) == ZV
))
3777 IT_CHARPOS (*it
) = limit
;
3778 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
3779 *skipped_p
= newline_found_p
= 1;
3783 while (get_next_display_element (it
)
3784 && !newline_found_p
)
3786 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
3787 set_iterator_to_next (it
, 0);
3792 it
->selective
= old_selective
;
3793 return newline_found_p
;
3797 /* Set IT's current position to the previous visible line start. Skip
3798 invisible text that is so either due to text properties or due to
3799 selective display. Caution: this does not change IT->current_x and
3803 back_to_previous_visible_line_start (it
)
3808 /* Go back one newline if not on BEGV already. */
3809 if (IT_CHARPOS (*it
) > BEGV
)
3810 back_to_previous_line_start (it
);
3812 /* Move over lines that are invisible because of selective display
3813 or text properties. */
3814 while (IT_CHARPOS (*it
) > BEGV
3819 /* If selective > 0, then lines indented more than that values
3821 if (it
->selective
> 0
3822 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
3829 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
)),
3830 Qinvisible
, it
->window
);
3831 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
3835 /* Back one more newline if the current one is invisible. */
3837 back_to_previous_line_start (it
);
3840 xassert (IT_CHARPOS (*it
) >= BEGV
);
3841 xassert (IT_CHARPOS (*it
) == BEGV
3842 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
3847 /* Reseat iterator IT at the previous visible line start. Skip
3848 invisible text that is so either due to text properties or due to
3849 selective display. At the end, update IT's overlay information,
3850 face information etc. */
3853 reseat_at_previous_visible_line_start (it
)
3856 back_to_previous_visible_line_start (it
);
3857 reseat (it
, it
->current
.pos
, 1);
3862 /* Reseat iterator IT on the next visible line start in the current
3863 buffer. ON_NEWLINE_P non-zero means position IT on the newline
3864 preceding the line start. Skip over invisible text that is so
3865 because of selective display. Compute faces, overlays etc at the
3866 new position. Note that this function does not skip over text that
3867 is invisible because of text properties. */
3870 reseat_at_next_visible_line_start (it
, on_newline_p
)
3874 int newline_found_p
, skipped_p
= 0;
3876 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
3878 /* Skip over lines that are invisible because they are indented
3879 more than the value of IT->selective. */
3880 if (it
->selective
> 0)
3881 while (IT_CHARPOS (*it
) < ZV
3882 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
3885 xassert (FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
3886 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
3889 /* Position on the newline if that's what's requested. */
3890 if (on_newline_p
&& newline_found_p
)
3892 if (STRINGP (it
->string
))
3894 if (IT_STRING_CHARPOS (*it
) > 0)
3896 --IT_STRING_CHARPOS (*it
);
3897 --IT_STRING_BYTEPOS (*it
);
3900 else if (IT_CHARPOS (*it
) > BEGV
)
3904 reseat (it
, it
->current
.pos
, 0);
3908 reseat (it
, it
->current
.pos
, 0);
3915 /***********************************************************************
3916 Changing an iterator's position
3917 ***********************************************************************/
3919 /* Change IT's current position to POS in current_buffer. If FORCE_P
3920 is non-zero, always check for text properties at the new position.
3921 Otherwise, text properties are only looked up if POS >=
3922 IT->check_charpos of a property. */
3925 reseat (it
, pos
, force_p
)
3927 struct text_pos pos
;
3930 int original_pos
= IT_CHARPOS (*it
);
3932 reseat_1 (it
, pos
, 0);
3934 /* Determine where to check text properties. Avoid doing it
3935 where possible because text property lookup is very expensive. */
3937 || CHARPOS (pos
) > it
->stop_charpos
3938 || CHARPOS (pos
) < original_pos
)
3945 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
3946 IT->stop_pos to POS, also. */
3949 reseat_1 (it
, pos
, set_stop_p
)
3951 struct text_pos pos
;
3954 /* Don't call this function when scanning a C string. */
3955 xassert (it
->s
== NULL
);
3957 /* POS must be a reasonable value. */
3958 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
3960 it
->current
.pos
= it
->position
= pos
;
3961 XSETBUFFER (it
->object
, current_buffer
);
3962 it
->end_charpos
= ZV
;
3964 it
->current
.dpvec_index
= -1;
3965 it
->current
.overlay_string_index
= -1;
3966 IT_STRING_CHARPOS (*it
) = -1;
3967 IT_STRING_BYTEPOS (*it
) = -1;
3969 it
->method
= next_element_from_buffer
;
3971 it
->face_before_selective_p
= 0;
3974 it
->stop_charpos
= CHARPOS (pos
);
3978 /* Set up IT for displaying a string, starting at CHARPOS in window W.
3979 If S is non-null, it is a C string to iterate over. Otherwise,
3980 STRING gives a Lisp string to iterate over.
3982 If PRECISION > 0, don't return more then PRECISION number of
3983 characters from the string.
3985 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
3986 characters have been returned. FIELD_WIDTH < 0 means an infinite
3989 MULTIBYTE = 0 means disable processing of multibyte characters,
3990 MULTIBYTE > 0 means enable it,
3991 MULTIBYTE < 0 means use IT->multibyte_p.
3993 IT must be initialized via a prior call to init_iterator before
3994 calling this function. */
3997 reseat_to_string (it
, s
, string
, charpos
, precision
, field_width
, multibyte
)
4002 int precision
, field_width
, multibyte
;
4004 /* No region in strings. */
4005 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
4007 /* No text property checks performed by default, but see below. */
4008 it
->stop_charpos
= -1;
4010 /* Set iterator position and end position. */
4011 bzero (&it
->current
, sizeof it
->current
);
4012 it
->current
.overlay_string_index
= -1;
4013 it
->current
.dpvec_index
= -1;
4014 xassert (charpos
>= 0);
4016 /* If STRING is specified, use its multibyteness, otherwise use the
4017 setting of MULTIBYTE, if specified. */
4019 it
->multibyte_p
= multibyte
> 0;
4023 xassert (STRINGP (string
));
4024 it
->string
= string
;
4026 it
->end_charpos
= it
->string_nchars
= XSTRING (string
)->size
;
4027 it
->method
= next_element_from_string
;
4028 it
->current
.string_pos
= string_pos (charpos
, string
);
4035 /* Note that we use IT->current.pos, not it->current.string_pos,
4036 for displaying C strings. */
4037 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
4038 if (it
->multibyte_p
)
4040 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
4041 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
4045 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
4046 it
->end_charpos
= it
->string_nchars
= strlen (s
);
4049 it
->method
= next_element_from_c_string
;
4052 /* PRECISION > 0 means don't return more than PRECISION characters
4054 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
4055 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
4057 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
4058 characters have been returned. FIELD_WIDTH == 0 means don't pad,
4059 FIELD_WIDTH < 0 means infinite field width. This is useful for
4060 padding with `-' at the end of a mode line. */
4061 if (field_width
< 0)
4062 field_width
= INFINITY
;
4063 if (field_width
> it
->end_charpos
- charpos
)
4064 it
->end_charpos
= charpos
+ field_width
;
4066 /* Use the standard display table for displaying strings. */
4067 if (DISP_TABLE_P (Vstandard_display_table
))
4068 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
4070 it
->stop_charpos
= charpos
;
4076 /***********************************************************************
4078 ***********************************************************************/
4080 /* Load IT's display element fields with information about the next
4081 display element from the current position of IT. Value is zero if
4082 end of buffer (or C string) is reached. */
4085 get_next_display_element (it
)
4088 /* Non-zero means that we found an display element. Zero means that
4089 we hit the end of what we iterate over. Performance note: the
4090 function pointer `method' used here turns out to be faster than
4091 using a sequence of if-statements. */
4092 int success_p
= (*it
->method
) (it
);
4094 if (it
->what
== IT_CHARACTER
)
4096 /* Map via display table or translate control characters.
4097 IT->c, IT->len etc. have been set to the next character by
4098 the function call above. If we have a display table, and it
4099 contains an entry for IT->c, translate it. Don't do this if
4100 IT->c itself comes from a display table, otherwise we could
4101 end up in an infinite recursion. (An alternative could be to
4102 count the recursion depth of this function and signal an
4103 error when a certain maximum depth is reached.) Is it worth
4105 if (success_p
&& it
->dpvec
== NULL
)
4110 && (dv
= DISP_CHAR_VECTOR (it
->dp
, it
->c
),
4113 struct Lisp_Vector
*v
= XVECTOR (dv
);
4115 /* Return the first character from the display table
4116 entry, if not empty. If empty, don't display the
4117 current character. */
4120 it
->dpvec_char_len
= it
->len
;
4121 it
->dpvec
= v
->contents
;
4122 it
->dpend
= v
->contents
+ v
->size
;
4123 it
->current
.dpvec_index
= 0;
4124 it
->method
= next_element_from_display_vector
;
4125 success_p
= get_next_display_element (it
);
4129 set_iterator_to_next (it
, 0);
4130 success_p
= get_next_display_element (it
);
4134 /* Translate control characters into `\003' or `^C' form.
4135 Control characters coming from a display table entry are
4136 currently not translated because we use IT->dpvec to hold
4137 the translation. This could easily be changed but I
4138 don't believe that it is worth doing.
4140 Non-printable multibyte characters are also translated
4142 else if ((it
->c
< ' '
4143 && (it
->area
!= TEXT_AREA
4144 || (it
->c
!= '\n' && it
->c
!= '\t')))
4147 || !CHAR_PRINTABLE_P (it
->c
))
4149 /* IT->c is a control character which must be displayed
4150 either as '\003' or as `^C' where the '\\' and '^'
4151 can be defined in the display table. Fill
4152 IT->ctl_chars with glyphs for what we have to
4153 display. Then, set IT->dpvec to these glyphs. */
4156 if (it
->c
< 128 && it
->ctl_arrow_p
)
4158 /* Set IT->ctl_chars[0] to the glyph for `^'. */
4160 && INTEGERP (DISP_CTRL_GLYPH (it
->dp
))
4161 && GLYPH_CHAR_VALID_P (XINT (DISP_CTRL_GLYPH (it
->dp
))))
4162 g
= XINT (DISP_CTRL_GLYPH (it
->dp
));
4164 g
= FAST_MAKE_GLYPH ('^', 0);
4165 XSETINT (it
->ctl_chars
[0], g
);
4167 g
= FAST_MAKE_GLYPH (it
->c
^ 0100, 0);
4168 XSETINT (it
->ctl_chars
[1], g
);
4170 /* Set up IT->dpvec and return first character from it. */
4171 it
->dpvec_char_len
= it
->len
;
4172 it
->dpvec
= it
->ctl_chars
;
4173 it
->dpend
= it
->dpvec
+ 2;
4174 it
->current
.dpvec_index
= 0;
4175 it
->method
= next_element_from_display_vector
;
4176 get_next_display_element (it
);
4180 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
4185 /* Set IT->ctl_chars[0] to the glyph for `\\'. */
4187 && INTEGERP (DISP_ESCAPE_GLYPH (it
->dp
))
4188 && GLYPH_CHAR_VALID_P (XFASTINT (DISP_ESCAPE_GLYPH (it
->dp
))))
4189 escape_glyph
= XFASTINT (DISP_ESCAPE_GLYPH (it
->dp
));
4191 escape_glyph
= FAST_MAKE_GLYPH ('\\', 0);
4193 if (SINGLE_BYTE_CHAR_P (it
->c
))
4194 str
[0] = it
->c
, len
= 1;
4196 len
= CHAR_STRING (it
->c
, str
);
4198 for (i
= 0; i
< len
; i
++)
4200 XSETINT (it
->ctl_chars
[i
* 4], escape_glyph
);
4201 /* Insert three more glyphs into IT->ctl_chars for
4202 the octal display of the character. */
4203 g
= FAST_MAKE_GLYPH (((str
[i
] >> 6) & 7) + '0', 0);
4204 XSETINT (it
->ctl_chars
[i
* 4 + 1], g
);
4205 g
= FAST_MAKE_GLYPH (((str
[i
] >> 3) & 7) + '0', 0);
4206 XSETINT (it
->ctl_chars
[i
* 4 + 2], g
);
4207 g
= FAST_MAKE_GLYPH ((str
[i
] & 7) + '0', 0);
4208 XSETINT (it
->ctl_chars
[i
* 4 + 3], g
);
4211 /* Set up IT->dpvec and return the first character
4213 it
->dpvec_char_len
= it
->len
;
4214 it
->dpvec
= it
->ctl_chars
;
4215 it
->dpend
= it
->dpvec
+ len
* 4;
4216 it
->current
.dpvec_index
= 0;
4217 it
->method
= next_element_from_display_vector
;
4218 get_next_display_element (it
);
4223 /* Adjust face id for a multibyte character. There are no
4224 multibyte character in unibyte text. */
4227 && FRAME_WINDOW_P (it
->f
))
4229 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4230 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->c
);
4234 /* Is this character the last one of a run of characters with
4235 box? If yes, set IT->end_of_box_run_p to 1. */
4242 it
->end_of_box_run_p
4243 = ((face_id
= face_after_it_pos (it
),
4244 face_id
!= it
->face_id
)
4245 && (face
= FACE_FROM_ID (it
->f
, face_id
),
4246 face
->box
== FACE_NO_BOX
));
4249 /* Value is 0 if end of buffer or string reached. */
4254 /* Move IT to the next display element.
4256 RESEAT_P non-zero means if called on a newline in buffer text,
4257 skip to the next visible line start.
4259 Functions get_next_display_element and set_iterator_to_next are
4260 separate because I find this arrangement easier to handle than a
4261 get_next_display_element function that also increments IT's
4262 position. The way it is we can first look at an iterator's current
4263 display element, decide whether it fits on a line, and if it does,
4264 increment the iterator position. The other way around we probably
4265 would either need a flag indicating whether the iterator has to be
4266 incremented the next time, or we would have to implement a
4267 decrement position function which would not be easy to write. */
4270 set_iterator_to_next (it
, reseat_p
)
4274 /* Reset flags indicating start and end of a sequence of characters
4275 with box. Reset them at the start of this function because
4276 moving the iterator to a new position might set them. */
4277 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
4279 if (it
->method
== next_element_from_buffer
)
4281 /* The current display element of IT is a character from
4282 current_buffer. Advance in the buffer, and maybe skip over
4283 invisible lines that are so because of selective display. */
4284 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
4285 reseat_at_next_visible_line_start (it
, 0);
4288 xassert (it
->len
!= 0);
4289 IT_BYTEPOS (*it
) += it
->len
;
4290 IT_CHARPOS (*it
) += 1;
4291 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
4294 else if (it
->method
== next_element_from_composition
)
4296 xassert (it
->cmp_id
>= 0 && it
->cmp_id
< n_compositions
);
4297 if (STRINGP (it
->string
))
4299 IT_STRING_BYTEPOS (*it
) += it
->len
;
4300 IT_STRING_CHARPOS (*it
) += it
->cmp_len
;
4301 it
->method
= next_element_from_string
;
4302 goto consider_string_end
;
4306 IT_BYTEPOS (*it
) += it
->len
;
4307 IT_CHARPOS (*it
) += it
->cmp_len
;
4308 it
->method
= next_element_from_buffer
;
4311 else if (it
->method
== next_element_from_c_string
)
4313 /* Current display element of IT is from a C string. */
4314 IT_BYTEPOS (*it
) += it
->len
;
4315 IT_CHARPOS (*it
) += 1;
4317 else if (it
->method
== next_element_from_display_vector
)
4319 /* Current display element of IT is from a display table entry.
4320 Advance in the display table definition. Reset it to null if
4321 end reached, and continue with characters from buffers/
4323 ++it
->current
.dpvec_index
;
4325 /* Restore face of the iterator to what they were before the
4326 display vector entry (these entries may contain faces). */
4327 it
->face_id
= it
->saved_face_id
;
4329 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
4332 it
->method
= next_element_from_c_string
;
4333 else if (STRINGP (it
->string
))
4334 it
->method
= next_element_from_string
;
4336 it
->method
= next_element_from_buffer
;
4339 it
->current
.dpvec_index
= -1;
4341 /* Skip over characters which were displayed via IT->dpvec. */
4342 if (it
->dpvec_char_len
< 0)
4343 reseat_at_next_visible_line_start (it
, 1);
4344 else if (it
->dpvec_char_len
> 0)
4346 it
->len
= it
->dpvec_char_len
;
4347 set_iterator_to_next (it
, reseat_p
);
4351 else if (it
->method
== next_element_from_string
)
4353 /* Current display element is a character from a Lisp string. */
4354 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
4355 IT_STRING_BYTEPOS (*it
) += it
->len
;
4356 IT_STRING_CHARPOS (*it
) += 1;
4358 consider_string_end
:
4360 if (it
->current
.overlay_string_index
>= 0)
4362 /* IT->string is an overlay string. Advance to the
4363 next, if there is one. */
4364 if (IT_STRING_CHARPOS (*it
) >= XSTRING (it
->string
)->size
)
4365 next_overlay_string (it
);
4369 /* IT->string is not an overlay string. If we reached
4370 its end, and there is something on IT->stack, proceed
4371 with what is on the stack. This can be either another
4372 string, this time an overlay string, or a buffer. */
4373 if (IT_STRING_CHARPOS (*it
) == XSTRING (it
->string
)->size
4377 if (!STRINGP (it
->string
))
4378 it
->method
= next_element_from_buffer
;
4380 goto consider_string_end
;
4384 else if (it
->method
== next_element_from_image
4385 || it
->method
== next_element_from_stretch
)
4387 /* The position etc with which we have to proceed are on
4388 the stack. The position may be at the end of a string,
4389 if the `display' property takes up the whole string. */
4392 if (STRINGP (it
->string
))
4394 it
->method
= next_element_from_string
;
4395 goto consider_string_end
;
4398 it
->method
= next_element_from_buffer
;
4401 /* There are no other methods defined, so this should be a bug. */
4404 xassert (it
->method
!= next_element_from_string
4405 || (STRINGP (it
->string
)
4406 && IT_STRING_CHARPOS (*it
) >= 0));
4410 /* Load IT's display element fields with information about the next
4411 display element which comes from a display table entry or from the
4412 result of translating a control character to one of the forms `^C'
4413 or `\003'. IT->dpvec holds the glyphs to return as characters. */
4416 next_element_from_display_vector (it
)
4420 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
4422 /* Remember the current face id in case glyphs specify faces.
4423 IT's face is restored in set_iterator_to_next. */
4424 it
->saved_face_id
= it
->face_id
;
4426 if (INTEGERP (*it
->dpvec
)
4427 && GLYPH_CHAR_VALID_P (XFASTINT (*it
->dpvec
)))
4432 g
= XFASTINT (it
->dpvec
[it
->current
.dpvec_index
]);
4433 it
->c
= FAST_GLYPH_CHAR (g
);
4434 it
->len
= CHAR_BYTES (it
->c
);
4436 /* The entry may contain a face id to use. Such a face id is
4437 the id of a Lisp face, not a realized face. A face id of
4438 zero means no face is specified. */
4439 lface_id
= FAST_GLYPH_FACE (g
);
4442 /* The function returns -1 if lface_id is invalid. */
4443 int face_id
= ascii_face_of_lisp_face (it
->f
, lface_id
);
4445 it
->face_id
= face_id
;
4449 /* Display table entry is invalid. Return a space. */
4450 it
->c
= ' ', it
->len
= 1;
4452 /* Don't change position and object of the iterator here. They are
4453 still the values of the character that had this display table
4454 entry or was translated, and that's what we want. */
4455 it
->what
= IT_CHARACTER
;
4460 /* Load IT with the next display element from Lisp string IT->string.
4461 IT->current.string_pos is the current position within the string.
4462 If IT->current.overlay_string_index >= 0, the Lisp string is an
4466 next_element_from_string (it
)
4469 struct text_pos position
;
4471 xassert (STRINGP (it
->string
));
4472 xassert (IT_STRING_CHARPOS (*it
) >= 0);
4473 position
= it
->current
.string_pos
;
4475 /* Time to check for invisible text? */
4476 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
4477 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
4481 /* Since a handler may have changed IT->method, we must
4483 return get_next_display_element (it
);
4486 if (it
->current
.overlay_string_index
>= 0)
4488 /* Get the next character from an overlay string. In overlay
4489 strings, There is no field width or padding with spaces to
4491 if (IT_STRING_CHARPOS (*it
) >= XSTRING (it
->string
)->size
)
4496 else if (STRING_MULTIBYTE (it
->string
))
4498 int remaining
= (STRING_BYTES (XSTRING (it
->string
))
4499 - IT_STRING_BYTEPOS (*it
));
4500 unsigned char *s
= (XSTRING (it
->string
)->data
4501 + IT_STRING_BYTEPOS (*it
));
4502 it
->c
= string_char_and_length (s
, remaining
, &it
->len
);
4506 it
->c
= XSTRING (it
->string
)->data
[IT_STRING_BYTEPOS (*it
)];
4512 /* Get the next character from a Lisp string that is not an
4513 overlay string. Such strings come from the mode line, for
4514 example. We may have to pad with spaces, or truncate the
4515 string. See also next_element_from_c_string. */
4516 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
4521 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
4523 /* Pad with spaces. */
4524 it
->c
= ' ', it
->len
= 1;
4525 CHARPOS (position
) = BYTEPOS (position
) = -1;
4527 else if (STRING_MULTIBYTE (it
->string
))
4529 int maxlen
= (STRING_BYTES (XSTRING (it
->string
))
4530 - IT_STRING_BYTEPOS (*it
));
4531 unsigned char *s
= (XSTRING (it
->string
)->data
4532 + IT_STRING_BYTEPOS (*it
));
4533 it
->c
= string_char_and_length (s
, maxlen
, &it
->len
);
4537 it
->c
= XSTRING (it
->string
)->data
[IT_STRING_BYTEPOS (*it
)];
4542 /* Record what we have and where it came from. Note that we store a
4543 buffer position in IT->position although it could arguably be a
4545 it
->what
= IT_CHARACTER
;
4546 it
->object
= it
->string
;
4547 it
->position
= position
;
4552 /* Load IT with next display element from C string IT->s.
4553 IT->string_nchars is the maximum number of characters to return
4554 from the string. IT->end_charpos may be greater than
4555 IT->string_nchars when this function is called, in which case we
4556 may have to return padding spaces. Value is zero if end of string
4557 reached, including padding spaces. */
4560 next_element_from_c_string (it
)
4566 it
->what
= IT_CHARACTER
;
4567 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
4570 /* IT's position can be greater IT->string_nchars in case a field
4571 width or precision has been specified when the iterator was
4573 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
4575 /* End of the game. */
4579 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
4581 /* Pad with spaces. */
4582 it
->c
= ' ', it
->len
= 1;
4583 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
4585 else if (it
->multibyte_p
)
4587 /* Implementation note: The calls to strlen apparently aren't a
4588 performance problem because there is no noticeable performance
4589 difference between Emacs running in unibyte or multibyte mode. */
4590 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
4591 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
),
4595 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
4601 /* Set up IT to return characters from an ellipsis, if appropriate.
4602 The definition of the ellipsis glyphs may come from a display table
4603 entry. This function Fills IT with the first glyph from the
4604 ellipsis if an ellipsis is to be displayed. */
4607 next_element_from_ellipsis (it
)
4610 if (it
->selective_display_ellipsis_p
)
4612 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4614 /* Use the display table definition for `...'. Invalid glyphs
4615 will be handled by the method returning elements from dpvec. */
4616 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4617 it
->dpvec_char_len
= it
->len
;
4618 it
->dpvec
= v
->contents
;
4619 it
->dpend
= v
->contents
+ v
->size
;
4620 it
->current
.dpvec_index
= 0;
4621 it
->method
= next_element_from_display_vector
;
4625 /* Use default `...' which is stored in default_invis_vector. */
4626 it
->dpvec_char_len
= it
->len
;
4627 it
->dpvec
= default_invis_vector
;
4628 it
->dpend
= default_invis_vector
+ 3;
4629 it
->current
.dpvec_index
= 0;
4630 it
->method
= next_element_from_display_vector
;
4635 /* The face at the current position may be different from the
4636 face we find after the invisible text. Remember what it
4637 was in IT->saved_face_id, and signal that it's there by
4638 setting face_before_selective_p. */
4639 it
->saved_face_id
= it
->face_id
;
4640 it
->method
= next_element_from_buffer
;
4641 reseat_at_next_visible_line_start (it
, 1);
4642 it
->face_before_selective_p
= 1;
4645 return get_next_display_element (it
);
4649 /* Deliver an image display element. The iterator IT is already
4650 filled with image information (done in handle_display_prop). Value
4655 next_element_from_image (it
)
4658 it
->what
= IT_IMAGE
;
4663 /* Fill iterator IT with next display element from a stretch glyph
4664 property. IT->object is the value of the text property. Value is
4668 next_element_from_stretch (it
)
4671 it
->what
= IT_STRETCH
;
4676 /* Load IT with the next display element from current_buffer. Value
4677 is zero if end of buffer reached. IT->stop_charpos is the next
4678 position at which to stop and check for text properties or buffer
4682 next_element_from_buffer (it
)
4687 /* Check this assumption, otherwise, we would never enter the
4688 if-statement, below. */
4689 xassert (IT_CHARPOS (*it
) >= BEGV
4690 && IT_CHARPOS (*it
) <= it
->stop_charpos
);
4692 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
4694 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
4696 int overlay_strings_follow_p
;
4698 /* End of the game, except when overlay strings follow that
4699 haven't been returned yet. */
4700 if (it
->overlay_strings_at_end_processed_p
)
4701 overlay_strings_follow_p
= 0;
4704 it
->overlay_strings_at_end_processed_p
= 1;
4705 overlay_strings_follow_p
= get_overlay_strings (it
);
4708 if (overlay_strings_follow_p
)
4709 success_p
= get_next_display_element (it
);
4713 it
->position
= it
->current
.pos
;
4720 return get_next_display_element (it
);
4725 /* No face changes, overlays etc. in sight, so just return a
4726 character from current_buffer. */
4729 /* Maybe run the redisplay end trigger hook. Performance note:
4730 This doesn't seem to cost measurable time. */
4731 if (it
->redisplay_end_trigger_charpos
4733 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
4734 run_redisplay_end_trigger_hook (it
);
4736 /* Get the next character, maybe multibyte. */
4737 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
4738 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
4740 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT_BYTE
? ZV_BYTE
: GPT_BYTE
)
4741 - IT_BYTEPOS (*it
));
4742 it
->c
= string_char_and_length (p
, maxlen
, &it
->len
);
4745 it
->c
= *p
, it
->len
= 1;
4747 /* Record what we have and where it came from. */
4748 it
->what
= IT_CHARACTER
;;
4749 it
->object
= it
->w
->buffer
;
4750 it
->position
= it
->current
.pos
;
4752 /* Normally we return the character found above, except when we
4753 really want to return an ellipsis for selective display. */
4758 /* A value of selective > 0 means hide lines indented more
4759 than that number of columns. */
4760 if (it
->selective
> 0
4761 && IT_CHARPOS (*it
) + 1 < ZV
4762 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
4763 IT_BYTEPOS (*it
) + 1,
4766 success_p
= next_element_from_ellipsis (it
);
4767 it
->dpvec_char_len
= -1;
4770 else if (it
->c
== '\r' && it
->selective
== -1)
4772 /* A value of selective == -1 means that everything from the
4773 CR to the end of the line is invisible, with maybe an
4774 ellipsis displayed for it. */
4775 success_p
= next_element_from_ellipsis (it
);
4776 it
->dpvec_char_len
= -1;
4781 /* Value is zero if end of buffer reached. */
4782 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
4787 /* Run the redisplay end trigger hook for IT. */
4790 run_redisplay_end_trigger_hook (it
)
4793 Lisp_Object args
[3];
4795 /* IT->glyph_row should be non-null, i.e. we should be actually
4796 displaying something, or otherwise we should not run the hook. */
4797 xassert (it
->glyph_row
);
4799 /* Set up hook arguments. */
4800 args
[0] = Qredisplay_end_trigger_functions
;
4801 args
[1] = it
->window
;
4802 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
4803 it
->redisplay_end_trigger_charpos
= 0;
4805 /* Since we are *trying* to run these functions, don't try to run
4806 them again, even if they get an error. */
4807 it
->w
->redisplay_end_trigger
= Qnil
;
4808 Frun_hook_with_args (3, args
);
4810 /* Notice if it changed the face of the character we are on. */
4811 handle_face_prop (it
);
4815 /* Deliver a composition display element. The iterator IT is already
4816 filled with composition information (done in
4817 handle_composition_prop). Value is always 1. */
4820 next_element_from_composition (it
)
4823 it
->what
= IT_COMPOSITION
;
4824 it
->position
= (STRINGP (it
->string
)
4825 ? it
->current
.string_pos
4832 /***********************************************************************
4833 Moving an iterator without producing glyphs
4834 ***********************************************************************/
4836 /* Move iterator IT to a specified buffer or X position within one
4837 line on the display without producing glyphs.
4839 Begin to skip at IT's current position. Skip to TO_CHARPOS or TO_X
4840 whichever is reached first.
4842 TO_CHARPOS <= 0 means no TO_CHARPOS is specified.
4844 TO_X < 0 means that no TO_X is specified. TO_X is normally a value
4845 0 <= TO_X <= IT->last_visible_x. This means in particular, that
4846 TO_X includes the amount by which a window is horizontally
4851 MOVE_POS_MATCH_OR_ZV
4852 - when TO_POS or ZV was reached.
4855 -when TO_X was reached before TO_POS or ZV were reached.
4858 - when we reached the end of the display area and the line must
4862 - when we reached the end of the display area and the line is
4866 - when we stopped at a line end, i.e. a newline or a CR and selective
4869 static enum move_it_result
4870 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
)
4872 int to_charpos
, to_x
, op
;
4874 enum move_it_result result
= MOVE_UNDEFINED
;
4875 struct glyph_row
*saved_glyph_row
;
4877 /* Don't produce glyphs in produce_glyphs. */
4878 saved_glyph_row
= it
->glyph_row
;
4879 it
->glyph_row
= NULL
;
4883 int x
, i
, ascent
= 0, descent
= 0;
4885 /* Stop when ZV or TO_CHARPOS reached. */
4886 if (!get_next_display_element (it
)
4887 || ((op
& MOVE_TO_POS
) != 0
4888 && BUFFERP (it
->object
)
4889 && IT_CHARPOS (*it
) >= to_charpos
))
4891 result
= MOVE_POS_MATCH_OR_ZV
;
4895 /* The call to produce_glyphs will get the metrics of the
4896 display element IT is loaded with. We record in x the
4897 x-position before this display element in case it does not
4901 /* Remember the line height so far in case the next element doesn't
4903 if (!it
->truncate_lines_p
)
4905 ascent
= it
->max_ascent
;
4906 descent
= it
->max_descent
;
4909 PRODUCE_GLYPHS (it
);
4911 if (it
->area
!= TEXT_AREA
)
4913 set_iterator_to_next (it
, 1);
4917 /* The number of glyphs we get back in IT->nglyphs will normally
4918 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
4919 character on a terminal frame, or (iii) a line end. For the
4920 second case, IT->nglyphs - 1 padding glyphs will be present
4921 (on X frames, there is only one glyph produced for a
4922 composite character.
4924 The behavior implemented below means, for continuation lines,
4925 that as many spaces of a TAB as fit on the current line are
4926 displayed there. For terminal frames, as many glyphs of a
4927 multi-glyph character are displayed in the current line, too.
4928 This is what the old redisplay code did, and we keep it that
4929 way. Under X, the whole shape of a complex character must
4930 fit on the line or it will be completely displayed in the
4933 Note that both for tabs and padding glyphs, all glyphs have
4937 /* More than one glyph or glyph doesn't fit on line. All
4938 glyphs have the same width. */
4939 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
4942 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
4944 new_x
= x
+ single_glyph_width
;
4946 /* We want to leave anything reaching TO_X to the caller. */
4947 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
4950 result
= MOVE_X_REACHED
;
4953 else if (/* Lines are continued. */
4954 !it
->truncate_lines_p
4955 && (/* And glyph doesn't fit on the line. */
4956 new_x
> it
->last_visible_x
4957 /* Or it fits exactly and we're on a window
4959 || (new_x
== it
->last_visible_x
4960 && FRAME_WINDOW_P (it
->f
))))
4962 if (/* IT->hpos == 0 means the very first glyph
4963 doesn't fit on the line, e.g. a wide image. */
4965 || (new_x
== it
->last_visible_x
4966 && FRAME_WINDOW_P (it
->f
)))
4969 it
->current_x
= new_x
;
4970 if (i
== it
->nglyphs
- 1)
4971 set_iterator_to_next (it
, 1);
4976 it
->max_ascent
= ascent
;
4977 it
->max_descent
= descent
;
4980 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
4982 result
= MOVE_LINE_CONTINUED
;
4985 else if (new_x
> it
->first_visible_x
)
4987 /* Glyph is visible. Increment number of glyphs that
4988 would be displayed. */
4993 /* Glyph is completely off the left margin of the display
4994 area. Nothing to do. */
4998 if (result
!= MOVE_UNDEFINED
)
5001 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
5003 /* Stop when TO_X specified and reached. This check is
5004 necessary here because of lines consisting of a line end,
5005 only. The line end will not produce any glyphs and we
5006 would never get MOVE_X_REACHED. */
5007 xassert (it
->nglyphs
== 0);
5008 result
= MOVE_X_REACHED
;
5012 /* Is this a line end? If yes, we're done. */
5013 if (ITERATOR_AT_END_OF_LINE_P (it
))
5015 result
= MOVE_NEWLINE_OR_CR
;
5019 /* The current display element has been consumed. Advance
5021 set_iterator_to_next (it
, 1);
5023 /* Stop if lines are truncated and IT's current x-position is
5024 past the right edge of the window now. */
5025 if (it
->truncate_lines_p
5026 && it
->current_x
>= it
->last_visible_x
)
5028 result
= MOVE_LINE_TRUNCATED
;
5033 /* Restore the iterator settings altered at the beginning of this
5035 it
->glyph_row
= saved_glyph_row
;
5040 /* Move IT forward to a specified buffer position TO_CHARPOS, TO_X,
5041 TO_Y, TO_VPOS. OP is a bit-mask that specifies where to stop. See
5042 the description of enum move_operation_enum.
5044 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
5045 screen line, this function will set IT to the next position >
5049 move_it_to (it
, to_charpos
, to_x
, to_y
, to_vpos
, op
)
5051 int to_charpos
, to_x
, to_y
, to_vpos
;
5054 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
5060 if (op
& MOVE_TO_VPOS
)
5062 /* If no TO_CHARPOS and no TO_X specified, stop at the
5063 start of the line TO_VPOS. */
5064 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
5066 if (it
->vpos
== to_vpos
)
5072 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
5076 /* TO_VPOS >= 0 means stop at TO_X in the line at
5077 TO_VPOS, or at TO_POS, whichever comes first. */
5078 if (it
->vpos
== to_vpos
)
5084 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
5086 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
5091 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
5093 /* We have reached TO_X but not in the line we want. */
5094 skip
= move_it_in_display_line_to (it
, to_charpos
,
5096 if (skip
== MOVE_POS_MATCH_OR_ZV
)
5104 else if (op
& MOVE_TO_Y
)
5106 struct it it_backup
;
5108 /* TO_Y specified means stop at TO_X in the line containing
5109 TO_Y---or at TO_CHARPOS if this is reached first. The
5110 problem is that we can't really tell whether the line
5111 contains TO_Y before we have completely scanned it, and
5112 this may skip past TO_X. What we do is to first scan to
5115 If TO_X is not specified, use a TO_X of zero. The reason
5116 is to make the outcome of this function more predictable.
5117 If we didn't use TO_X == 0, we would stop at the end of
5118 the line which is probably not what a caller would expect
5120 skip
= move_it_in_display_line_to (it
, to_charpos
,
5124 | (op
& MOVE_TO_POS
)));
5126 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
5127 if (skip
== MOVE_POS_MATCH_OR_ZV
)
5133 /* If TO_X was reached, we would like to know whether TO_Y
5134 is in the line. This can only be said if we know the
5135 total line height which requires us to scan the rest of
5137 if (skip
== MOVE_X_REACHED
)
5140 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
5141 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
5143 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
5146 /* Now, decide whether TO_Y is in this line. */
5147 line_height
= it
->max_ascent
+ it
->max_descent
;
5148 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
5150 if (to_y
>= it
->current_y
5151 && to_y
< it
->current_y
+ line_height
)
5153 if (skip
== MOVE_X_REACHED
)
5154 /* If TO_Y is in this line and TO_X was reached above,
5155 we scanned too far. We have to restore IT's settings
5156 to the ones before skipping. */
5160 else if (skip
== MOVE_X_REACHED
)
5163 if (skip
== MOVE_POS_MATCH_OR_ZV
)
5171 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
5175 case MOVE_POS_MATCH_OR_ZV
:
5179 case MOVE_NEWLINE_OR_CR
:
5180 set_iterator_to_next (it
, 1);
5181 it
->continuation_lines_width
= 0;
5184 case MOVE_LINE_TRUNCATED
:
5185 it
->continuation_lines_width
= 0;
5186 reseat_at_next_visible_line_start (it
, 0);
5187 if ((op
& MOVE_TO_POS
) != 0
5188 && IT_CHARPOS (*it
) > to_charpos
)
5195 case MOVE_LINE_CONTINUED
:
5196 it
->continuation_lines_width
+= it
->current_x
;
5203 /* Reset/increment for the next run. */
5204 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
5205 it
->current_x
= it
->hpos
= 0;
5206 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
5208 last_height
= it
->max_ascent
+ it
->max_descent
;
5209 last_max_ascent
= it
->max_ascent
;
5210 it
->max_ascent
= it
->max_descent
= 0;
5215 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
5219 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
5221 If DY > 0, move IT backward at least that many pixels. DY = 0
5222 means move IT backward to the preceding line start or BEGV. This
5223 function may move over more than DY pixels if IT->current_y - DY
5224 ends up in the middle of a line; in this case IT->current_y will be
5225 set to the top of the line moved to. */
5228 move_it_vertically_backward (it
, dy
)
5232 int nlines
, h
, line_height
;
5234 int start_pos
= IT_CHARPOS (*it
);
5238 /* Estimate how many newlines we must move back. */
5239 nlines
= max (1, dy
/ CANON_Y_UNIT (it
->f
));
5241 /* Set the iterator's position that many lines back. */
5242 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
5243 back_to_previous_visible_line_start (it
);
5245 /* Reseat the iterator here. When moving backward, we don't want
5246 reseat to skip forward over invisible text, set up the iterator
5247 to deliver from overlay strings at the new position etc. So,
5248 use reseat_1 here. */
5249 reseat_1 (it
, it
->current
.pos
, 1);
5251 /* We are now surely at a line start. */
5252 it
->current_x
= it
->hpos
= 0;
5254 /* Move forward and see what y-distance we moved. First move to the
5255 start of the next line so that we get its height. We need this
5256 height to be able to tell whether we reached the specified
5259 it2
.max_ascent
= it2
.max_descent
= 0;
5260 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
5261 MOVE_TO_POS
| MOVE_TO_VPOS
);
5262 xassert (IT_CHARPOS (*it
) >= BEGV
);
5263 line_height
= it2
.max_ascent
+ it2
.max_descent
;
5265 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
5266 xassert (IT_CHARPOS (*it
) >= BEGV
);
5267 h
= it2
.current_y
- it
->current_y
;
5268 nlines
= it2
.vpos
- it
->vpos
;
5270 /* Correct IT's y and vpos position. */
5276 /* DY == 0 means move to the start of the screen line. The
5277 value of nlines is > 0 if continuation lines were involved. */
5279 move_it_by_lines (it
, nlines
, 1);
5280 xassert (IT_CHARPOS (*it
) <= start_pos
);
5284 /* The y-position we try to reach. Note that h has been
5285 subtracted in front of the if-statement. */
5286 int target_y
= it
->current_y
+ h
- dy
;
5288 /* If we did not reach target_y, try to move further backward if
5289 we can. If we moved too far backward, try to move forward. */
5290 if (target_y
< it
->current_y
5291 && IT_CHARPOS (*it
) > BEGV
)
5293 move_it_vertically (it
, target_y
- it
->current_y
);
5294 xassert (IT_CHARPOS (*it
) >= BEGV
);
5296 else if (target_y
>= it
->current_y
+ line_height
5297 && IT_CHARPOS (*it
) < ZV
)
5299 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
5300 xassert (IT_CHARPOS (*it
) >= BEGV
);
5306 /* Move IT by a specified amount of pixel lines DY. DY negative means
5307 move backwards. DY = 0 means move to start of screen line. At the
5308 end, IT will be on the start of a screen line. */
5311 move_it_vertically (it
, dy
)
5316 move_it_vertically_backward (it
, -dy
);
5319 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
5320 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
5321 MOVE_TO_POS
| MOVE_TO_Y
);
5322 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
5324 /* If buffer ends in ZV without a newline, move to the start of
5325 the line to satisfy the post-condition. */
5326 if (IT_CHARPOS (*it
) == ZV
5327 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
5328 move_it_by_lines (it
, 0, 0);
5333 /* Move iterator IT past the end of the text line it is in. */
5336 move_it_past_eol (it
)
5339 enum move_it_result rc
;
5341 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
5342 if (rc
== MOVE_NEWLINE_OR_CR
)
5343 set_iterator_to_next (it
, 0);
5347 #if 0 /* Currently not used. */
5349 /* Return non-zero if some text between buffer positions START_CHARPOS
5350 and END_CHARPOS is invisible. IT->window is the window for text
5354 invisible_text_between_p (it
, start_charpos
, end_charpos
)
5356 int start_charpos
, end_charpos
;
5358 Lisp_Object prop
, limit
;
5359 int invisible_found_p
;
5361 xassert (it
!= NULL
&& start_charpos
<= end_charpos
);
5363 /* Is text at START invisible? */
5364 prop
= Fget_char_property (make_number (start_charpos
), Qinvisible
,
5366 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5367 invisible_found_p
= 1;
5370 limit
= Fnext_single_char_property_change (make_number (start_charpos
),
5372 make_number (end_charpos
));
5373 invisible_found_p
= XFASTINT (limit
) < end_charpos
;
5376 return invisible_found_p
;
5382 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
5383 negative means move up. DVPOS == 0 means move to the start of the
5384 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
5385 NEED_Y_P is zero, IT->current_y will be left unchanged.
5387 Further optimization ideas: If we would know that IT->f doesn't use
5388 a face with proportional font, we could be faster for
5389 truncate-lines nil. */
5392 move_it_by_lines (it
, dvpos
, need_y_p
)
5394 int dvpos
, need_y_p
;
5396 struct position pos
;
5398 if (!FRAME_WINDOW_P (it
->f
))
5400 struct text_pos textpos
;
5402 /* We can use vmotion on frames without proportional fonts. */
5403 pos
= *vmotion (IT_CHARPOS (*it
), dvpos
, it
->w
);
5404 SET_TEXT_POS (textpos
, pos
.bufpos
, pos
.bytepos
);
5405 reseat (it
, textpos
, 1);
5406 it
->vpos
+= pos
.vpos
;
5407 it
->current_y
+= pos
.vpos
;
5409 else if (dvpos
== 0)
5411 /* DVPOS == 0 means move to the start of the screen line. */
5412 move_it_vertically_backward (it
, 0);
5413 xassert (it
->current_x
== 0 && it
->hpos
== 0);
5416 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
5420 int start_charpos
, i
;
5422 /* Go back -DVPOS visible lines and reseat the iterator there. */
5423 start_charpos
= IT_CHARPOS (*it
);
5424 for (i
= -dvpos
; i
&& IT_CHARPOS (*it
) > BEGV
; --i
)
5425 back_to_previous_visible_line_start (it
);
5426 reseat (it
, it
->current
.pos
, 1);
5427 it
->current_x
= it
->hpos
= 0;
5429 /* Above call may have moved too far if continuation lines
5430 are involved. Scan forward and see if it did. */
5432 it2
.vpos
= it2
.current_y
= 0;
5433 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
5434 it
->vpos
-= it2
.vpos
;
5435 it
->current_y
-= it2
.current_y
;
5436 it
->current_x
= it
->hpos
= 0;
5438 /* If we moved too far, move IT some lines forward. */
5439 if (it2
.vpos
> -dvpos
)
5441 int delta
= it2
.vpos
+ dvpos
;
5442 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
5449 /***********************************************************************
5451 ***********************************************************************/
5454 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
5458 add_to_log (format
, arg1
, arg2
)
5460 Lisp_Object arg1
, arg2
;
5462 Lisp_Object args
[3];
5463 Lisp_Object msg
, fmt
;
5466 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
5469 GCPRO4 (fmt
, msg
, arg1
, arg2
);
5471 args
[0] = fmt
= build_string (format
);
5474 msg
= Fformat (3, args
);
5476 len
= STRING_BYTES (XSTRING (msg
)) + 1;
5477 buffer
= (char *) alloca (len
);
5478 strcpy (buffer
, XSTRING (msg
)->data
);
5480 message_dolog (buffer
, len
- 1, 1, 0);
5485 /* Output a newline in the *Messages* buffer if "needs" one. */
5488 message_log_maybe_newline ()
5490 if (message_log_need_newline
)
5491 message_dolog ("", 0, 1, 0);
5495 /* Add a string M of length NBYTES to the message log, optionally
5496 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
5497 nonzero, means interpret the contents of M as multibyte. This
5498 function calls low-level routines in order to bypass text property
5499 hooks, etc. which might not be safe to run. */
5502 message_dolog (m
, nbytes
, nlflag
, multibyte
)
5504 int nbytes
, nlflag
, multibyte
;
5506 if (!NILP (Vmessage_log_max
))
5508 struct buffer
*oldbuf
;
5509 Lisp_Object oldpoint
, oldbegv
, oldzv
;
5510 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
5511 int point_at_end
= 0;
5513 Lisp_Object old_deactivate_mark
, tem
;
5514 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
5516 old_deactivate_mark
= Vdeactivate_mark
;
5517 oldbuf
= current_buffer
;
5518 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
5519 current_buffer
->undo_list
= Qt
;
5521 oldpoint
= Fpoint_marker ();
5522 oldbegv
= Fpoint_min_marker ();
5523 oldzv
= Fpoint_max_marker ();
5524 GCPRO4 (oldpoint
, oldbegv
, oldzv
, old_deactivate_mark
);
5532 BEGV_BYTE
= BEG_BYTE
;
5535 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
5537 /* Insert the string--maybe converting multibyte to single byte
5538 or vice versa, so that all the text fits the buffer. */
5540 && NILP (current_buffer
->enable_multibyte_characters
))
5542 int i
, c
, char_bytes
;
5543 unsigned char work
[1];
5545 /* Convert a multibyte string to single-byte
5546 for the *Message* buffer. */
5547 for (i
= 0; i
< nbytes
; i
+= nbytes
)
5549 c
= string_char_and_length (m
+ i
, nbytes
- i
, &char_bytes
);
5550 work
[0] = (SINGLE_BYTE_CHAR_P (c
)
5552 : multibyte_char_to_unibyte (c
, Qnil
));
5553 insert_1_both (work
, 1, 1, 1, 0, 0);
5556 else if (! multibyte
5557 && ! NILP (current_buffer
->enable_multibyte_characters
))
5559 int i
, c
, char_bytes
;
5560 unsigned char *msg
= (unsigned char *) m
;
5561 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
5562 /* Convert a single-byte string to multibyte
5563 for the *Message* buffer. */
5564 for (i
= 0; i
< nbytes
; i
++)
5566 c
= unibyte_char_to_multibyte (msg
[i
]);
5567 char_bytes
= CHAR_STRING (c
, str
);
5568 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
5572 insert_1 (m
, nbytes
, 1, 0, 0);
5576 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
5577 insert_1 ("\n", 1, 1, 0, 0);
5579 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
5581 this_bol_byte
= PT_BYTE
;
5585 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
5587 prev_bol_byte
= PT_BYTE
;
5589 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
5590 this_bol
, this_bol_byte
);
5593 del_range_both (prev_bol
, prev_bol_byte
,
5594 this_bol
, this_bol_byte
, 0);
5600 /* If you change this format, don't forget to also
5601 change message_log_check_duplicate. */
5602 sprintf (dupstr
, " [%d times]", dup
);
5603 duplen
= strlen (dupstr
);
5604 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
5605 insert_1 (dupstr
, duplen
, 1, 0, 1);
5610 if (NATNUMP (Vmessage_log_max
))
5612 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
5613 -XFASTINT (Vmessage_log_max
) - 1, 0);
5614 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
5617 BEGV
= XMARKER (oldbegv
)->charpos
;
5618 BEGV_BYTE
= marker_byte_position (oldbegv
);
5627 ZV
= XMARKER (oldzv
)->charpos
;
5628 ZV_BYTE
= marker_byte_position (oldzv
);
5632 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
5634 /* We can't do Fgoto_char (oldpoint) because it will run some
5636 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
5637 XMARKER (oldpoint
)->bytepos
);
5640 free_marker (oldpoint
);
5641 free_marker (oldbegv
);
5642 free_marker (oldzv
);
5644 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
5645 set_buffer_internal (oldbuf
);
5647 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
5648 message_log_need_newline
= !nlflag
;
5649 Vdeactivate_mark
= old_deactivate_mark
;
5654 /* We are at the end of the buffer after just having inserted a newline.
5655 (Note: We depend on the fact we won't be crossing the gap.)
5656 Check to see if the most recent message looks a lot like the previous one.
5657 Return 0 if different, 1 if the new one should just replace it, or a
5658 value N > 1 if we should also append " [N times]". */
5661 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
5662 int prev_bol
, this_bol
;
5663 int prev_bol_byte
, this_bol_byte
;
5666 int len
= Z_BYTE
- 1 - this_bol_byte
;
5668 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
5669 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
5671 for (i
= 0; i
< len
; i
++)
5673 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
5681 if (*p1
++ == ' ' && *p1
++ == '[')
5684 while (*p1
>= '0' && *p1
<= '9')
5685 n
= n
* 10 + *p1
++ - '0';
5686 if (strncmp (p1
, " times]\n", 8) == 0)
5693 /* Display an echo area message M with a specified length of NBYTES
5694 bytes. The string may include null characters. If M is 0, clear
5695 out any existing message, and let the mini-buffer text show
5698 The buffer M must continue to exist until after the echo area gets
5699 cleared or some other message gets displayed there. This means do
5700 not pass text that is stored in a Lisp string; do not pass text in
5701 a buffer that was alloca'd. */
5704 message2 (m
, nbytes
, multibyte
)
5709 /* First flush out any partial line written with print. */
5710 message_log_maybe_newline ();
5712 message_dolog (m
, nbytes
, 1, multibyte
);
5713 message2_nolog (m
, nbytes
, multibyte
);
5717 /* The non-logging counterpart of message2. */
5720 message2_nolog (m
, nbytes
, multibyte
)
5724 struct frame
*sf
= SELECTED_FRAME ();
5725 message_enable_multibyte
= multibyte
;
5729 if (noninteractive_need_newline
)
5730 putc ('\n', stderr
);
5731 noninteractive_need_newline
= 0;
5733 fwrite (m
, nbytes
, 1, stderr
);
5734 if (cursor_in_echo_area
== 0)
5735 fprintf (stderr
, "\n");
5738 /* A null message buffer means that the frame hasn't really been
5739 initialized yet. Error messages get reported properly by
5740 cmd_error, so this must be just an informative message; toss it. */
5741 else if (INTERACTIVE
5742 && sf
->glyphs_initialized_p
5743 && FRAME_MESSAGE_BUF (sf
))
5745 Lisp_Object mini_window
;
5748 /* Get the frame containing the mini-buffer
5749 that the selected frame is using. */
5750 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
5751 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
5753 FRAME_SAMPLE_VISIBILITY (f
);
5754 if (FRAME_VISIBLE_P (sf
)
5755 && ! FRAME_VISIBLE_P (f
))
5756 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
5760 set_message (m
, Qnil
, nbytes
, multibyte
);
5761 if (minibuffer_auto_raise
)
5762 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
5765 clear_message (1, 1);
5767 do_pending_window_change (0);
5768 echo_area_display (1);
5769 do_pending_window_change (0);
5770 if (frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
5771 (*frame_up_to_date_hook
) (f
);
5776 /* Display an echo area message M with a specified length of NBYTES
5777 bytes. The string may include null characters. If M is not a
5778 string, clear out any existing message, and let the mini-buffer
5779 text show through. */
5782 message3 (m
, nbytes
, multibyte
)
5787 struct gcpro gcpro1
;
5791 /* First flush out any partial line written with print. */
5792 message_log_maybe_newline ();
5794 message_dolog (XSTRING (m
)->data
, nbytes
, 1, multibyte
);
5795 message3_nolog (m
, nbytes
, multibyte
);
5801 /* The non-logging version of message3. */
5804 message3_nolog (m
, nbytes
, multibyte
)
5806 int nbytes
, multibyte
;
5808 struct frame
*sf
= SELECTED_FRAME ();
5809 message_enable_multibyte
= multibyte
;
5813 if (noninteractive_need_newline
)
5814 putc ('\n', stderr
);
5815 noninteractive_need_newline
= 0;
5817 fwrite (XSTRING (m
)->data
, nbytes
, 1, stderr
);
5818 if (cursor_in_echo_area
== 0)
5819 fprintf (stderr
, "\n");
5822 /* A null message buffer means that the frame hasn't really been
5823 initialized yet. Error messages get reported properly by
5824 cmd_error, so this must be just an informative message; toss it. */
5825 else if (INTERACTIVE
5826 && sf
->glyphs_initialized_p
5827 && FRAME_MESSAGE_BUF (sf
))
5829 Lisp_Object mini_window
;
5833 /* Get the frame containing the mini-buffer
5834 that the selected frame is using. */
5835 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
5836 frame
= XWINDOW (mini_window
)->frame
;
5839 FRAME_SAMPLE_VISIBILITY (f
);
5840 if (FRAME_VISIBLE_P (sf
)
5841 && !FRAME_VISIBLE_P (f
))
5842 Fmake_frame_visible (frame
);
5844 if (STRINGP (m
) && XSTRING (m
)->size
)
5846 set_message (NULL
, m
, nbytes
, multibyte
);
5847 if (minibuffer_auto_raise
)
5848 Fraise_frame (frame
);
5851 clear_message (1, 1);
5853 do_pending_window_change (0);
5854 echo_area_display (1);
5855 do_pending_window_change (0);
5856 if (frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
5857 (*frame_up_to_date_hook
) (f
);
5862 /* Display a null-terminated echo area message M. If M is 0, clear
5863 out any existing message, and let the mini-buffer text show through.
5865 The buffer M must continue to exist until after the echo area gets
5866 cleared or some other message gets displayed there. Do not pass
5867 text that is stored in a Lisp string. Do not pass text in a buffer
5868 that was alloca'd. */
5874 message2 (m
, (m
? strlen (m
) : 0), 0);
5878 /* The non-logging counterpart of message1. */
5884 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
5887 /* Display a message M which contains a single %s
5888 which gets replaced with STRING. */
5891 message_with_string (m
, string
, log
)
5900 if (noninteractive_need_newline
)
5901 putc ('\n', stderr
);
5902 noninteractive_need_newline
= 0;
5903 fprintf (stderr
, m
, XSTRING (string
)->data
);
5904 if (cursor_in_echo_area
== 0)
5905 fprintf (stderr
, "\n");
5909 else if (INTERACTIVE
)
5911 /* The frame whose minibuffer we're going to display the message on.
5912 It may be larger than the selected frame, so we need
5913 to use its buffer, not the selected frame's buffer. */
5914 Lisp_Object mini_window
;
5915 struct frame
*f
, *sf
= SELECTED_FRAME ();
5917 /* Get the frame containing the minibuffer
5918 that the selected frame is using. */
5919 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
5920 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
5922 /* A null message buffer means that the frame hasn't really been
5923 initialized yet. Error messages get reported properly by
5924 cmd_error, so this must be just an informative message; toss it. */
5925 if (FRAME_MESSAGE_BUF (f
))
5929 a
[0] = (char *) XSTRING (string
)->data
;
5931 len
= doprnt (FRAME_MESSAGE_BUF (f
),
5932 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
5935 message2 (FRAME_MESSAGE_BUF (f
), len
,
5936 STRING_MULTIBYTE (string
));
5938 message2_nolog (FRAME_MESSAGE_BUF (f
), len
,
5939 STRING_MULTIBYTE (string
));
5941 /* Print should start at the beginning of the message
5942 buffer next time. */
5943 message_buf_print
= 0;
5949 /* Dump an informative message to the minibuf. If M is 0, clear out
5950 any existing message, and let the mini-buffer text show through. */
5954 message (m
, a1
, a2
, a3
)
5956 EMACS_INT a1
, a2
, a3
;
5962 if (noninteractive_need_newline
)
5963 putc ('\n', stderr
);
5964 noninteractive_need_newline
= 0;
5965 fprintf (stderr
, m
, a1
, a2
, a3
);
5966 if (cursor_in_echo_area
== 0)
5967 fprintf (stderr
, "\n");
5971 else if (INTERACTIVE
)
5973 /* The frame whose mini-buffer we're going to display the message
5974 on. It may be larger than the selected frame, so we need to
5975 use its buffer, not the selected frame's buffer. */
5976 Lisp_Object mini_window
;
5977 struct frame
*f
, *sf
= SELECTED_FRAME ();
5979 /* Get the frame containing the mini-buffer
5980 that the selected frame is using. */
5981 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
5982 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
5984 /* A null message buffer means that the frame hasn't really been
5985 initialized yet. Error messages get reported properly by
5986 cmd_error, so this must be just an informative message; toss
5988 if (FRAME_MESSAGE_BUF (f
))
5999 len
= doprnt (FRAME_MESSAGE_BUF (f
),
6000 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
6002 len
= doprnt (FRAME_MESSAGE_BUF (f
),
6003 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3,
6005 #endif /* NO_ARG_ARRAY */
6007 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
6012 /* Print should start at the beginning of the message
6013 buffer next time. */
6014 message_buf_print
= 0;
6020 /* The non-logging version of message. */
6023 message_nolog (m
, a1
, a2
, a3
)
6025 EMACS_INT a1
, a2
, a3
;
6027 Lisp_Object old_log_max
;
6028 old_log_max
= Vmessage_log_max
;
6029 Vmessage_log_max
= Qnil
;
6030 message (m
, a1
, a2
, a3
);
6031 Vmessage_log_max
= old_log_max
;
6035 /* Display the current message in the current mini-buffer. This is
6036 only called from error handlers in process.c, and is not time
6042 if (!NILP (echo_area_buffer
[0]))
6045 string
= Fcurrent_message ();
6046 message3 (string
, XSTRING (string
)->size
,
6047 !NILP (current_buffer
->enable_multibyte_characters
));
6052 /* Make sure echo area buffers in echo_buffers[] are life. If they
6053 aren't, make new ones. */
6056 ensure_echo_area_buffers ()
6060 for (i
= 0; i
< 2; ++i
)
6061 if (!BUFFERP (echo_buffer
[i
])
6062 || NILP (XBUFFER (echo_buffer
[i
])->name
))
6065 Lisp_Object old_buffer
;
6068 old_buffer
= echo_buffer
[i
];
6069 sprintf (name
, " *Echo Area %d*", i
);
6070 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
6071 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
6073 for (j
= 0; j
< 2; ++j
)
6074 if (EQ (old_buffer
, echo_area_buffer
[j
]))
6075 echo_area_buffer
[j
] = echo_buffer
[i
];
6080 /* Call FN with args A1..A4 with either the current or last displayed
6081 echo_area_buffer as current buffer.
6083 WHICH zero means use the current message buffer
6084 echo_area_buffer[0]. If that is nil, choose a suitable buffer
6085 from echo_buffer[] and clear it.
6087 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
6088 suitable buffer from echo_buffer[] and clear it.
6090 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
6091 that the current message becomes the last displayed one, make
6092 choose a suitable buffer for echo_area_buffer[0], and clear it.
6094 Value is what FN returns. */
6097 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
)
6100 int (*fn
) P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
6106 int this_one
, the_other
, clear_buffer_p
, rc
;
6107 int count
= BINDING_STACK_SIZE ();
6109 /* If buffers aren't life, make new ones. */
6110 ensure_echo_area_buffers ();
6115 this_one
= 0, the_other
= 1;
6117 this_one
= 1, the_other
= 0;
6120 this_one
= 0, the_other
= 1;
6123 /* We need a fresh one in case the current echo buffer equals
6124 the one containing the last displayed echo area message. */
6125 if (!NILP (echo_area_buffer
[this_one
])
6126 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
6127 echo_area_buffer
[this_one
] = Qnil
;
6130 /* Choose a suitable buffer from echo_buffer[] is we don't
6132 if (NILP (echo_area_buffer
[this_one
]))
6134 echo_area_buffer
[this_one
]
6135 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
6136 ? echo_buffer
[the_other
]
6137 : echo_buffer
[this_one
]);
6141 buffer
= echo_area_buffer
[this_one
];
6143 /* Don't get confused by reusing the buffer used for echoing
6144 for a different purpose. */
6145 if (!echoing
&& EQ (buffer
, echo_message_buffer
))
6148 record_unwind_protect (unwind_with_echo_area_buffer
,
6149 with_echo_area_buffer_unwind_data (w
));
6151 /* Make the echo area buffer current. Note that for display
6152 purposes, it is not necessary that the displayed window's buffer
6153 == current_buffer, except for text property lookup. So, let's
6154 only set that buffer temporarily here without doing a full
6155 Fset_window_buffer. We must also change w->pointm, though,
6156 because otherwise an assertions in unshow_buffer fails, and Emacs
6158 set_buffer_internal_1 (XBUFFER (buffer
));
6162 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
6165 current_buffer
->undo_list
= Qt
;
6166 current_buffer
->read_only
= Qnil
;
6167 specbind (Qinhibit_read_only
, Qt
);
6169 if (clear_buffer_p
&& Z
> BEG
)
6172 xassert (BEGV
>= BEG
);
6173 xassert (ZV
<= Z
&& ZV
>= BEGV
);
6175 rc
= fn (a1
, a2
, a3
, a4
);
6177 xassert (BEGV
>= BEG
);
6178 xassert (ZV
<= Z
&& ZV
>= BEGV
);
6180 unbind_to (count
, Qnil
);
6185 /* Save state that should be preserved around the call to the function
6186 FN called in with_echo_area_buffer. */
6189 with_echo_area_buffer_unwind_data (w
)
6195 /* Reduce consing by keeping one vector in
6196 Vwith_echo_area_save_vector. */
6197 vector
= Vwith_echo_area_save_vector
;
6198 Vwith_echo_area_save_vector
= Qnil
;
6201 vector
= Fmake_vector (make_number (7), Qnil
);
6203 XSETBUFFER (AREF (vector
, i
), current_buffer
); ++i
;
6204 AREF (vector
, i
) = Vdeactivate_mark
, ++i
;
6205 AREF (vector
, i
) = make_number (windows_or_buffers_changed
), ++i
;
6209 XSETWINDOW (AREF (vector
, i
), w
); ++i
;
6210 AREF (vector
, i
) = w
->buffer
; ++i
;
6211 AREF (vector
, i
) = make_number (XMARKER (w
->pointm
)->charpos
); ++i
;
6212 AREF (vector
, i
) = make_number (XMARKER (w
->pointm
)->bytepos
); ++i
;
6217 for (; i
< end
; ++i
)
6218 AREF (vector
, i
) = Qnil
;
6221 xassert (i
== ASIZE (vector
));
6226 /* Restore global state from VECTOR which was created by
6227 with_echo_area_buffer_unwind_data. */
6230 unwind_with_echo_area_buffer (vector
)
6233 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
6234 Vdeactivate_mark
= AREF (vector
, 1);
6235 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
6237 if (WINDOWP (AREF (vector
, 3)))
6240 Lisp_Object buffer
, charpos
, bytepos
;
6242 w
= XWINDOW (AREF (vector
, 3));
6243 buffer
= AREF (vector
, 4);
6244 charpos
= AREF (vector
, 5);
6245 bytepos
= AREF (vector
, 6);
6248 set_marker_both (w
->pointm
, buffer
,
6249 XFASTINT (charpos
), XFASTINT (bytepos
));
6252 Vwith_echo_area_save_vector
= vector
;
6257 /* Set up the echo area for use by print functions. MULTIBYTE_P
6258 non-zero means we will print multibyte. */
6261 setup_echo_area_for_printing (multibyte_p
)
6264 ensure_echo_area_buffers ();
6266 if (!message_buf_print
)
6268 /* A message has been output since the last time we printed.
6269 Choose a fresh echo area buffer. */
6270 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
6271 echo_area_buffer
[0] = echo_buffer
[1];
6273 echo_area_buffer
[0] = echo_buffer
[0];
6275 /* Switch to that buffer and clear it. */
6276 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
6277 current_buffer
->truncate_lines
= Qnil
;
6281 int count
= BINDING_STACK_SIZE ();
6282 specbind (Qinhibit_read_only
, Qt
);
6284 unbind_to (count
, Qnil
);
6286 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
6288 /* Set up the buffer for the multibyteness we need. */
6290 != !NILP (current_buffer
->enable_multibyte_characters
))
6291 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
6293 /* Raise the frame containing the echo area. */
6294 if (minibuffer_auto_raise
)
6296 struct frame
*sf
= SELECTED_FRAME ();
6297 Lisp_Object mini_window
;
6298 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
6299 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
6302 message_log_maybe_newline ();
6303 message_buf_print
= 1;
6307 if (NILP (echo_area_buffer
[0]))
6309 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
6310 echo_area_buffer
[0] = echo_buffer
[1];
6312 echo_area_buffer
[0] = echo_buffer
[0];
6315 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
6317 /* Someone switched buffers between print requests. */
6318 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
6319 current_buffer
->truncate_lines
= Qnil
;
6325 /* Display an echo area message in window W. Value is non-zero if W's
6326 height is changed. If display_last_displayed_message_p is
6327 non-zero, display the message that was last displayed, otherwise
6328 display the current message. */
6331 display_echo_area (w
)
6334 int i
, no_message_p
, window_height_changed_p
, count
;
6336 /* Temporarily disable garbage collections while displaying the echo
6337 area. This is done because a GC can print a message itself.
6338 That message would modify the echo area buffer's contents while a
6339 redisplay of the buffer is going on, and seriously confuse
6341 count
= inhibit_garbage_collection ();
6343 /* If there is no message, we must call display_echo_area_1
6344 nevertheless because it resizes the window. But we will have to
6345 reset the echo_area_buffer in question to nil at the end because
6346 with_echo_area_buffer will sets it to an empty buffer. */
6347 i
= display_last_displayed_message_p
? 1 : 0;
6348 no_message_p
= NILP (echo_area_buffer
[i
]);
6350 window_height_changed_p
6351 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
6352 display_echo_area_1
,
6353 (EMACS_INT
) w
, Qnil
, 0, 0);
6356 echo_area_buffer
[i
] = Qnil
;
6358 unbind_to (count
, Qnil
);
6359 return window_height_changed_p
;
6363 /* Helper for display_echo_area. Display the current buffer which
6364 contains the current echo area message in window W, a mini-window,
6365 a pointer to which is passed in A1. A2..A4 are currently not used.
6366 Change the height of W so that all of the message is displayed.
6367 Value is non-zero if height of W was changed. */
6370 display_echo_area_1 (a1
, a2
, a3
, a4
)
6375 struct window
*w
= (struct window
*) a1
;
6377 struct text_pos start
;
6378 int window_height_changed_p
= 0;
6380 /* Do this before displaying, so that we have a large enough glyph
6381 matrix for the display. */
6382 window_height_changed_p
= resize_mini_window (w
, 0);
6385 clear_glyph_matrix (w
->desired_matrix
);
6386 XSETWINDOW (window
, w
);
6387 SET_TEXT_POS (start
, BEG
, BEG_BYTE
);
6388 try_window (window
, start
);
6390 return window_height_changed_p
;
6394 /* Resize the echo area window to exactly the size needed for the
6395 currently displayed message, if there is one. */
6398 resize_echo_area_axactly ()
6400 if (BUFFERP (echo_area_buffer
[0])
6401 && WINDOWP (echo_area_window
))
6403 struct window
*w
= XWINDOW (echo_area_window
);
6406 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
6407 (EMACS_INT
) w
, Qnil
, 0, 0);
6410 ++windows_or_buffers_changed
;
6411 ++update_mode_lines
;
6412 redisplay_internal (0);
6418 /* Callback function for with_echo_area_buffer, when used from
6419 resize_echo_area_axactly. A1 contains a pointer to the window to
6420 resize, A2 to A4 are not used. Value is what resize_mini_window
6424 resize_mini_window_1 (a1
, a2
, a3
, a4
)
6429 return resize_mini_window ((struct window
*) a1
, 1);
6433 /* Resize mini-window W to fit the size of its contents. EXACT:P
6434 means size the window exactly to the size needed. Otherwise, it's
6435 only enlarged until W's buffer is empty. Value is non-zero if
6436 the window height has been changed. */
6439 resize_mini_window (w
, exact_p
)
6443 struct frame
*f
= XFRAME (w
->frame
);
6444 int window_height_changed_p
= 0;
6446 xassert (MINI_WINDOW_P (w
));
6448 /* Nil means don't try to resize. */
6449 if (NILP (Vresize_mini_windows
)
6450 || (FRAME_X_P (f
) && f
->output_data
.x
== NULL
))
6453 if (!FRAME_MINIBUF_ONLY_P (f
))
6456 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
6457 int total_height
= XFASTINT (root
->height
) + XFASTINT (w
->height
);
6458 int height
, max_height
;
6459 int unit
= CANON_Y_UNIT (f
);
6460 struct text_pos start
;
6461 struct buffer
*old_current_buffer
= NULL
;
6463 if (current_buffer
!= XBUFFER (w
->buffer
))
6465 old_current_buffer
= current_buffer
;
6466 set_buffer_internal (XBUFFER (w
->buffer
));
6469 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
6471 /* Compute the max. number of lines specified by the user. */
6472 if (FLOATP (Vmax_mini_window_height
))
6473 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
6474 else if (INTEGERP (Vmax_mini_window_height
))
6475 max_height
= XINT (Vmax_mini_window_height
);
6477 max_height
= total_height
/ 4;
6479 /* Correct that max. height if it's bogus. */
6480 max_height
= max (1, max_height
);
6481 max_height
= min (total_height
, max_height
);
6483 /* Find out the height of the text in the window. */
6484 if (it
.truncate_lines_p
)
6489 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
6490 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
6491 height
= it
.current_y
+ last_height
;
6493 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
6494 height
-= it
.extra_line_spacing
;
6495 height
= (height
+ unit
- 1) / unit
;
6498 /* Compute a suitable window start. */
6499 if (height
> max_height
)
6501 height
= max_height
;
6502 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
6503 move_it_vertically_backward (&it
, (height
- 1) * unit
);
6504 start
= it
.current
.pos
;
6507 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
6508 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
6510 if (EQ (Vresize_mini_windows
, Qgrow_only
))
6512 /* Let it grow only, until we display an empty message, in which
6513 case the window shrinks again. */
6514 if (height
> XFASTINT (w
->height
))
6516 int old_height
= XFASTINT (w
->height
);
6517 freeze_window_starts (f
, 1);
6518 grow_mini_window (w
, height
- XFASTINT (w
->height
));
6519 window_height_changed_p
= XFASTINT (w
->height
) != old_height
;
6521 else if (height
< XFASTINT (w
->height
)
6522 && (exact_p
|| BEGV
== ZV
))
6524 int old_height
= XFASTINT (w
->height
);
6525 freeze_window_starts (f
, 0);
6526 shrink_mini_window (w
);
6527 window_height_changed_p
= XFASTINT (w
->height
) != old_height
;
6532 /* Always resize to exact size needed. */
6533 if (height
> XFASTINT (w
->height
))
6535 int old_height
= XFASTINT (w
->height
);
6536 freeze_window_starts (f
, 1);
6537 grow_mini_window (w
, height
- XFASTINT (w
->height
));
6538 window_height_changed_p
= XFASTINT (w
->height
) != old_height
;
6540 else if (height
< XFASTINT (w
->height
))
6542 int old_height
= XFASTINT (w
->height
);
6543 freeze_window_starts (f
, 0);
6544 shrink_mini_window (w
);
6548 freeze_window_starts (f
, 1);
6549 grow_mini_window (w
, height
- XFASTINT (w
->height
));
6552 window_height_changed_p
= XFASTINT (w
->height
) != old_height
;
6556 if (old_current_buffer
)
6557 set_buffer_internal (old_current_buffer
);
6560 return window_height_changed_p
;
6564 /* Value is the current message, a string, or nil if there is no
6572 if (NILP (echo_area_buffer
[0]))
6576 with_echo_area_buffer (0, 0, current_message_1
,
6577 (EMACS_INT
) &msg
, Qnil
, 0, 0);
6579 echo_area_buffer
[0] = Qnil
;
6587 current_message_1 (a1
, a2
, a3
, a4
)
6592 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
6595 *msg
= make_buffer_string (BEG
, Z
, 1);
6602 /* Push the current message on Vmessage_stack for later restauration
6603 by restore_message. Value is non-zero if the current message isn't
6604 empty. This is a relatively infrequent operation, so it's not
6605 worth optimizing. */
6611 msg
= current_message ();
6612 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
6613 return STRINGP (msg
);
6617 /* Handler for record_unwind_protect calling pop_message. */
6620 push_message_unwind (dummy
)
6628 /* Restore message display from the top of Vmessage_stack. */
6635 xassert (CONSP (Vmessage_stack
));
6636 msg
= XCAR (Vmessage_stack
);
6638 message3_nolog (msg
, STRING_BYTES (XSTRING (msg
)), STRING_MULTIBYTE (msg
));
6640 message3_nolog (msg
, 0, 0);
6644 /* Pop the top-most entry off Vmessage_stack. */
6649 xassert (CONSP (Vmessage_stack
));
6650 Vmessage_stack
= XCDR (Vmessage_stack
);
6654 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
6655 exits. If the stack is not empty, we have a missing pop_message
6659 check_message_stack ()
6661 if (!NILP (Vmessage_stack
))
6666 /* Truncate to NCHARS what will be displayed in the echo area the next
6667 time we display it---but don't redisplay it now. */
6670 truncate_echo_area (nchars
)
6674 echo_area_buffer
[0] = Qnil
;
6675 /* A null message buffer means that the frame hasn't really been
6676 initialized yet. Error messages get reported properly by
6677 cmd_error, so this must be just an informative message; toss it. */
6678 else if (!noninteractive
6680 && !NILP (echo_area_buffer
[0]))
6682 struct frame
*sf
= SELECTED_FRAME ();
6683 if (FRAME_MESSAGE_BUF (sf
))
6684 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
6689 /* Helper function for truncate_echo_area. Truncate the current
6690 message to at most NCHARS characters. */
6693 truncate_message_1 (nchars
, a2
, a3
, a4
)
6698 if (BEG
+ nchars
< Z
)
6699 del_range (BEG
+ nchars
, Z
);
6701 echo_area_buffer
[0] = Qnil
;
6706 /* Set the current message to a substring of S or STRING.
6708 If STRING is a Lisp string, set the message to the first NBYTES
6709 bytes from STRING. NBYTES zero means use the whole string. If
6710 STRING is multibyte, the message will be displayed multibyte.
6712 If S is not null, set the message to the first LEN bytes of S. LEN
6713 zero means use the whole string. MULTIBYTE_P non-zero means S is
6714 multibyte. Display the message multibyte in that case. */
6717 set_message (s
, string
, nbytes
, multibyte_p
)
6722 message_enable_multibyte
6723 = ((s
&& multibyte_p
)
6724 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
6726 with_echo_area_buffer (0, -1, set_message_1
,
6727 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
6728 message_buf_print
= 0;
6729 help_echo_showing_p
= 0;
6733 /* Helper function for set_message. Arguments have the same meaning
6734 as there, with A1 corresponding to S and A2 corresponding to STRING
6735 This function is called with the echo area buffer being
6739 set_message_1 (a1
, a2
, nbytes
, multibyte_p
)
6742 EMACS_INT nbytes
, multibyte_p
;
6744 char *s
= (char *) a1
;
6745 Lisp_Object string
= a2
;
6749 /* Change multibyteness of the echo buffer appropriately. */
6750 if (message_enable_multibyte
6751 != !NILP (current_buffer
->enable_multibyte_characters
))
6752 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
6754 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
6756 /* Insert new message at BEG. */
6757 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
6759 if (STRINGP (string
))
6764 nbytes
= XSTRING (string
)->size_byte
;
6765 nchars
= string_byte_to_char (string
, nbytes
);
6767 /* This function takes care of single/multibyte conversion. We
6768 just have to ensure that the echo area buffer has the right
6769 setting of enable_multibyte_characters. */
6770 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
6775 nbytes
= strlen (s
);
6777 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
6779 /* Convert from multi-byte to single-byte. */
6781 unsigned char work
[1];
6783 /* Convert a multibyte string to single-byte. */
6784 for (i
= 0; i
< nbytes
; i
+= n
)
6786 c
= string_char_and_length (s
+ i
, nbytes
- i
, &n
);
6787 work
[0] = (SINGLE_BYTE_CHAR_P (c
)
6789 : multibyte_char_to_unibyte (c
, Qnil
));
6790 insert_1_both (work
, 1, 1, 1, 0, 0);
6793 else if (!multibyte_p
6794 && !NILP (current_buffer
->enable_multibyte_characters
))
6796 /* Convert from single-byte to multi-byte. */
6798 unsigned char *msg
= (unsigned char *) s
;
6799 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
6801 /* Convert a single-byte string to multibyte. */
6802 for (i
= 0; i
< nbytes
; i
++)
6804 c
= unibyte_char_to_multibyte (msg
[i
]);
6805 n
= CHAR_STRING (c
, str
);
6806 insert_1_both (str
, 1, n
, 1, 0, 0);
6810 insert_1 (s
, nbytes
, 1, 0, 0);
6817 /* Clear messages. CURRENT_P non-zero means clear the current
6818 message. LAST_DISPLAYED_P non-zero means clear the message
6822 clear_message (current_p
, last_displayed_p
)
6823 int current_p
, last_displayed_p
;
6826 echo_area_buffer
[0] = Qnil
;
6828 if (last_displayed_p
)
6829 echo_area_buffer
[1] = Qnil
;
6831 message_buf_print
= 0;
6834 /* Clear garbaged frames.
6836 This function is used where the old redisplay called
6837 redraw_garbaged_frames which in turn called redraw_frame which in
6838 turn called clear_frame. The call to clear_frame was a source of
6839 flickering. I believe a clear_frame is not necessary. It should
6840 suffice in the new redisplay to invalidate all current matrices,
6841 and ensure a complete redisplay of all windows. */
6844 clear_garbaged_frames ()
6848 Lisp_Object tail
, frame
;
6850 FOR_EACH_FRAME (tail
, frame
)
6852 struct frame
*f
= XFRAME (frame
);
6854 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
6856 clear_current_matrices (f
);
6862 ++windows_or_buffers_changed
;
6867 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
6868 is non-zero update selected_frame. Value is non-zero if the
6869 mini-windows height has been changed. */
6872 echo_area_display (update_frame_p
)
6875 Lisp_Object mini_window
;
6878 int window_height_changed_p
= 0;
6879 struct frame
*sf
= SELECTED_FRAME ();
6881 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
6882 w
= XWINDOW (mini_window
);
6883 f
= XFRAME (WINDOW_FRAME (w
));
6885 /* Don't display if frame is invisible or not yet initialized. */
6886 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
6889 /* The terminal frame is used as the first Emacs frame on the Mac OS. */
6891 #ifdef HAVE_WINDOW_SYSTEM
6892 /* When Emacs starts, selected_frame may be a visible terminal
6893 frame, even if we run under a window system. If we let this
6894 through, a message would be displayed on the terminal. */
6895 if (EQ (selected_frame
, Vterminal_frame
)
6896 && !NILP (Vwindow_system
))
6898 #endif /* HAVE_WINDOW_SYSTEM */
6901 /* Redraw garbaged frames. */
6903 clear_garbaged_frames ();
6905 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
6907 echo_area_window
= mini_window
;
6908 window_height_changed_p
= display_echo_area (w
);
6909 w
->must_be_updated_p
= 1;
6911 /* Update the display, unless called from redisplay_internal.
6912 Also don't update the screen during redisplay itself. The
6913 update will happen at the end of redisplay, and an update
6914 here could cause confusion. */
6915 if (update_frame_p
&& !redisplaying_p
)
6919 /* If the display update has been interrupted by pending
6920 input, update mode lines in the frame. Due to the
6921 pending input, it might have been that redisplay hasn't
6922 been called, so that mode lines above the echo area are
6923 garbaged. This looks odd, so we prevent it here. */
6924 if (!display_completed
)
6925 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
6927 if (window_height_changed_p
6928 /* Don't do this if Emacs is shutting down. Redisplay
6929 needs to run hooks. */
6930 && !NILP (Vrun_hooks
))
6932 /* Must update other windows. Likewise as in other
6933 cases, don't let this update be interrupted by
6935 int count
= BINDING_STACK_SIZE ();
6936 specbind (Qredisplay_dont_pause
, Qt
);
6937 windows_or_buffers_changed
= 1;
6938 redisplay_internal (0);
6939 unbind_to (count
, Qnil
);
6941 else if (FRAME_WINDOW_P (f
) && n
== 0)
6943 /* Window configuration is the same as before.
6944 Can do with a display update of the echo area,
6945 unless we displayed some mode lines. */
6946 update_single_window (w
, 1);
6947 rif
->flush_display (f
);
6950 update_frame (f
, 1, 1);
6952 /* If cursor is in the echo area, make sure that the next
6953 redisplay displays the minibuffer, so that the cursor will
6954 be replaced with what the minibuffer wants. */
6955 if (cursor_in_echo_area
)
6956 ++windows_or_buffers_changed
;
6959 else if (!EQ (mini_window
, selected_window
))
6960 windows_or_buffers_changed
++;
6962 /* Last displayed message is now the current message. */
6963 echo_area_buffer
[1] = echo_area_buffer
[0];
6965 /* Prevent redisplay optimization in redisplay_internal by resetting
6966 this_line_start_pos. This is done because the mini-buffer now
6967 displays the message instead of its buffer text. */
6968 if (EQ (mini_window
, selected_window
))
6969 CHARPOS (this_line_start_pos
) = 0;
6971 return window_height_changed_p
;
6976 /***********************************************************************
6978 ***********************************************************************/
6981 #ifdef HAVE_WINDOW_SYSTEM
6983 /* A buffer for constructing frame titles in it; allocated from the
6984 heap in init_xdisp and resized as needed in store_frame_title_char. */
6986 static char *frame_title_buf
;
6988 /* The buffer's end, and a current output position in it. */
6990 static char *frame_title_buf_end
;
6991 static char *frame_title_ptr
;
6994 /* Store a single character C for the frame title in frame_title_buf.
6995 Re-allocate frame_title_buf if necessary. */
6998 store_frame_title_char (c
)
7001 /* If output position has reached the end of the allocated buffer,
7002 double the buffer's size. */
7003 if (frame_title_ptr
== frame_title_buf_end
)
7005 int len
= frame_title_ptr
- frame_title_buf
;
7006 int new_size
= 2 * len
* sizeof *frame_title_buf
;
7007 frame_title_buf
= (char *) xrealloc (frame_title_buf
, new_size
);
7008 frame_title_buf_end
= frame_title_buf
+ new_size
;
7009 frame_title_ptr
= frame_title_buf
+ len
;
7012 *frame_title_ptr
++ = c
;
7016 /* Store part of a frame title in frame_title_buf, beginning at
7017 frame_title_ptr. STR is the string to store. Do not copy
7018 characters that yield more columns than PRECISION; PRECISION <= 0
7019 means copy the whole string. Pad with spaces until FIELD_WIDTH
7020 number of characters have been copied; FIELD_WIDTH <= 0 means don't
7021 pad. Called from display_mode_element when it is used to build a
7025 store_frame_title (str
, field_width
, precision
)
7027 int field_width
, precision
;
7030 int dummy
, nbytes
, width
;
7032 /* Copy at most PRECISION chars from STR. */
7033 nbytes
= strlen (str
);
7034 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
7036 store_frame_title_char (*str
++);
7038 /* Fill up with spaces until FIELD_WIDTH reached. */
7039 while (field_width
> 0
7042 store_frame_title_char (' ');
7050 /* Set the title of FRAME, if it has changed. The title format is
7051 Vicon_title_format if FRAME is iconified, otherwise it is
7052 frame_title_format. */
7055 x_consider_frame_title (frame
)
7058 struct frame
*f
= XFRAME (frame
);
7060 if (FRAME_WINDOW_P (f
)
7061 || FRAME_MINIBUF_ONLY_P (f
)
7062 || f
->explicit_name
)
7064 /* Do we have more than one visible frame on this X display? */
7067 struct buffer
*obuf
;
7071 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
7073 struct frame
*tf
= XFRAME (XCAR (tail
));
7076 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
7077 && !FRAME_MINIBUF_ONLY_P (tf
)
7078 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
7082 /* Set global variable indicating that multiple frames exist. */
7083 multiple_frames
= CONSP (tail
);
7085 /* Switch to the buffer of selected window of the frame. Set up
7086 frame_title_ptr so that display_mode_element will output into it;
7087 then display the title. */
7088 obuf
= current_buffer
;
7089 Fset_buffer (XWINDOW (f
->selected_window
)->buffer
);
7090 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
7091 frame_title_ptr
= frame_title_buf
;
7092 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
7093 NULL
, DEFAULT_FACE_ID
);
7094 display_mode_element (&it
, 0, -1, -1, fmt
);
7095 len
= frame_title_ptr
- frame_title_buf
;
7096 frame_title_ptr
= NULL
;
7097 set_buffer_internal (obuf
);
7099 /* Set the title only if it's changed. This avoids consing in
7100 the common case where it hasn't. (If it turns out that we've
7101 already wasted too much time by walking through the list with
7102 display_mode_element, then we might need to optimize at a
7103 higher level than this.) */
7104 if (! STRINGP (f
->name
)
7105 || STRING_BYTES (XSTRING (f
->name
)) != len
7106 || bcmp (frame_title_buf
, XSTRING (f
->name
)->data
, len
) != 0)
7107 x_implicitly_set_name (f
, make_string (frame_title_buf
, len
), Qnil
);
7111 #else /* not HAVE_WINDOW_SYSTEM */
7113 #define frame_title_ptr ((char *)0)
7114 #define store_frame_title(str, mincol, maxcol) 0
7116 #endif /* not HAVE_WINDOW_SYSTEM */
7121 /***********************************************************************
7123 ***********************************************************************/
7126 /* Prepare for redisplay by updating menu-bar item lists when
7127 appropriate. This can call eval. */
7130 prepare_menu_bars ()
7133 struct gcpro gcpro1
, gcpro2
;
7135 Lisp_Object tooltip_frame
;
7137 #ifdef HAVE_X_WINDOWS
7138 tooltip_frame
= tip_frame
;
7140 tooltip_frame
= Qnil
;
7143 /* Update all frame titles based on their buffer names, etc. We do
7144 this before the menu bars so that the buffer-menu will show the
7145 up-to-date frame titles. */
7146 #ifdef HAVE_WINDOW_SYSTEM
7147 if (windows_or_buffers_changed
|| update_mode_lines
)
7149 Lisp_Object tail
, frame
;
7151 FOR_EACH_FRAME (tail
, frame
)
7154 if (!EQ (frame
, tooltip_frame
)
7155 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
7156 x_consider_frame_title (frame
);
7159 #endif /* HAVE_WINDOW_SYSTEM */
7161 /* Update the menu bar item lists, if appropriate. This has to be
7162 done before any actual redisplay or generation of display lines. */
7163 all_windows
= (update_mode_lines
7164 || buffer_shared
> 1
7165 || windows_or_buffers_changed
);
7168 Lisp_Object tail
, frame
;
7169 int count
= BINDING_STACK_SIZE ();
7171 record_unwind_protect (Fset_match_data
, Fmatch_data (Qnil
, Qnil
));
7173 FOR_EACH_FRAME (tail
, frame
)
7177 /* Ignore tooltip frame. */
7178 if (EQ (frame
, tooltip_frame
))
7181 /* If a window on this frame changed size, report that to
7182 the user and clear the size-change flag. */
7183 if (FRAME_WINDOW_SIZES_CHANGED (f
))
7185 Lisp_Object functions
;
7187 /* Clear flag first in case we get an error below. */
7188 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
7189 functions
= Vwindow_size_change_functions
;
7190 GCPRO2 (tail
, functions
);
7192 while (CONSP (functions
))
7194 call1 (XCAR (functions
), frame
);
7195 functions
= XCDR (functions
);
7201 update_menu_bar (f
, 0);
7202 #ifdef HAVE_WINDOW_SYSTEM
7203 update_tool_bar (f
, 0);
7208 unbind_to (count
, Qnil
);
7212 struct frame
*sf
= SELECTED_FRAME ();
7213 update_menu_bar (sf
, 1);
7214 #ifdef HAVE_WINDOW_SYSTEM
7215 update_tool_bar (sf
, 1);
7219 /* Motif needs this. See comment in xmenu.c. Turn it off when
7220 pending_menu_activation is not defined. */
7221 #ifdef USE_X_TOOLKIT
7222 pending_menu_activation
= 0;
7227 /* Update the menu bar item list for frame F. This has to be done
7228 before we start to fill in any display lines, because it can call
7231 If SAVE_MATCH_DATA is non-zero, we must save and restore it here. */
7234 update_menu_bar (f
, save_match_data
)
7236 int save_match_data
;
7239 register struct window
*w
;
7241 /* If called recursively during a menu update, do nothing. This can
7242 happen when, for instance, an activate-menubar-hook causes a
7244 if (inhibit_menubar_update
)
7247 window
= FRAME_SELECTED_WINDOW (f
);
7248 w
= XWINDOW (window
);
7250 if (update_mode_lines
)
7251 w
->update_mode_line
= Qt
;
7253 if (FRAME_WINDOW_P (f
)
7255 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (macintosh)
7256 FRAME_EXTERNAL_MENU_BAR (f
)
7258 FRAME_MENU_BAR_LINES (f
) > 0
7260 : FRAME_MENU_BAR_LINES (f
) > 0)
7262 /* If the user has switched buffers or windows, we need to
7263 recompute to reflect the new bindings. But we'll
7264 recompute when update_mode_lines is set too; that means
7265 that people can use force-mode-line-update to request
7266 that the menu bar be recomputed. The adverse effect on
7267 the rest of the redisplay algorithm is about the same as
7268 windows_or_buffers_changed anyway. */
7269 if (windows_or_buffers_changed
7270 || !NILP (w
->update_mode_line
)
7271 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
7272 < BUF_MODIFF (XBUFFER (w
->buffer
)))
7273 != !NILP (w
->last_had_star
))
7274 || ((!NILP (Vtransient_mark_mode
)
7275 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
7276 != !NILP (w
->region_showing
)))
7278 struct buffer
*prev
= current_buffer
;
7279 int count
= BINDING_STACK_SIZE ();
7281 specbind (Qinhibit_menubar_update
, Qt
);
7283 set_buffer_internal_1 (XBUFFER (w
->buffer
));
7284 if (save_match_data
)
7285 record_unwind_protect (Fset_match_data
, Fmatch_data (Qnil
, Qnil
));
7286 if (NILP (Voverriding_local_map_menu_flag
))
7288 specbind (Qoverriding_terminal_local_map
, Qnil
);
7289 specbind (Qoverriding_local_map
, Qnil
);
7292 /* Run the Lucid hook. */
7293 safe_run_hooks (Qactivate_menubar_hook
);
7295 /* If it has changed current-menubar from previous value,
7296 really recompute the menu-bar from the value. */
7297 if (! NILP (Vlucid_menu_bar_dirty_flag
))
7298 call0 (Qrecompute_lucid_menubar
);
7300 safe_run_hooks (Qmenu_bar_update_hook
);
7301 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
7303 /* Redisplay the menu bar in case we changed it. */
7304 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (macintosh)
7305 if (FRAME_WINDOW_P (f
)
7306 #if defined (macintosh)
7307 /* All frames on Mac OS share the same menubar. So only the
7308 selected frame should be allowed to set it. */
7309 && f
== SELECTED_FRAME ()
7312 set_frame_menubar (f
, 0, 0);
7314 /* On a terminal screen, the menu bar is an ordinary screen
7315 line, and this makes it get updated. */
7316 w
->update_mode_line
= Qt
;
7317 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI) */
7318 /* In the non-toolkit version, the menu bar is an ordinary screen
7319 line, and this makes it get updated. */
7320 w
->update_mode_line
= Qt
;
7321 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI) */
7323 unbind_to (count
, Qnil
);
7324 set_buffer_internal_1 (prev
);
7331 /***********************************************************************
7333 ***********************************************************************/
7335 #ifdef HAVE_WINDOW_SYSTEM
7337 /* Update the tool-bar item list for frame F. This has to be done
7338 before we start to fill in any display lines. Called from
7339 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
7340 and restore it here. */
7343 update_tool_bar (f
, save_match_data
)
7345 int save_match_data
;
7347 if (WINDOWP (f
->tool_bar_window
)
7348 && XFASTINT (XWINDOW (f
->tool_bar_window
)->height
) > 0)
7353 window
= FRAME_SELECTED_WINDOW (f
);
7354 w
= XWINDOW (window
);
7356 /* If the user has switched buffers or windows, we need to
7357 recompute to reflect the new bindings. But we'll
7358 recompute when update_mode_lines is set too; that means
7359 that people can use force-mode-line-update to request
7360 that the menu bar be recomputed. The adverse effect on
7361 the rest of the redisplay algorithm is about the same as
7362 windows_or_buffers_changed anyway. */
7363 if (windows_or_buffers_changed
7364 || !NILP (w
->update_mode_line
)
7365 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
7366 < BUF_MODIFF (XBUFFER (w
->buffer
)))
7367 != !NILP (w
->last_had_star
))
7368 || ((!NILP (Vtransient_mark_mode
)
7369 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
7370 != !NILP (w
->region_showing
)))
7372 struct buffer
*prev
= current_buffer
;
7373 int count
= BINDING_STACK_SIZE ();
7375 /* Set current_buffer to the buffer of the selected
7376 window of the frame, so that we get the right local
7378 set_buffer_internal_1 (XBUFFER (w
->buffer
));
7380 /* Save match data, if we must. */
7381 if (save_match_data
)
7382 record_unwind_protect (Fset_match_data
, Fmatch_data (Qnil
, Qnil
));
7384 /* Make sure that we don't accidentally use bogus keymaps. */
7385 if (NILP (Voverriding_local_map_menu_flag
))
7387 specbind (Qoverriding_terminal_local_map
, Qnil
);
7388 specbind (Qoverriding_local_map
, Qnil
);
7391 /* Build desired tool-bar items from keymaps. */
7393 = tool_bar_items (f
->tool_bar_items
, &f
->n_tool_bar_items
);
7395 /* Redisplay the tool-bar in case we changed it. */
7396 w
->update_mode_line
= Qt
;
7398 unbind_to (count
, Qnil
);
7399 set_buffer_internal_1 (prev
);
7405 /* Set F->desired_tool_bar_string to a Lisp string representing frame
7406 F's desired tool-bar contents. F->tool_bar_items must have
7407 been set up previously by calling prepare_menu_bars. */
7410 build_desired_tool_bar_string (f
)
7413 int i
, size
, size_needed
;
7414 struct gcpro gcpro1
, gcpro2
, gcpro3
;
7415 Lisp_Object image
, plist
, props
;
7417 image
= plist
= props
= Qnil
;
7418 GCPRO3 (image
, plist
, props
);
7420 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
7421 Otherwise, make a new string. */
7423 /* The size of the string we might be able to reuse. */
7424 size
= (STRINGP (f
->desired_tool_bar_string
)
7425 ? XSTRING (f
->desired_tool_bar_string
)->size
7428 /* We need one space in the string for each image. */
7429 size_needed
= f
->n_tool_bar_items
;
7431 /* Reuse f->desired_tool_bar_string, if possible. */
7432 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
7433 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
7437 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
7438 Fremove_text_properties (make_number (0), make_number (size
),
7439 props
, f
->desired_tool_bar_string
);
7442 /* Put a `display' property on the string for the images to display,
7443 put a `menu_item' property on tool-bar items with a value that
7444 is the index of the item in F's tool-bar item vector. */
7445 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
7447 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
7449 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7450 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7451 int hmargin
, vmargin
, relief
, idx
, end
;
7452 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
, Qimage
;
7453 extern Lisp_Object Qlaplace
;
7455 /* If image is a vector, choose the image according to the
7457 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
7458 if (VECTORP (image
))
7462 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
7463 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
7466 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
7467 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
7469 xassert (ASIZE (image
) >= idx
);
7470 image
= AREF (image
, idx
);
7475 /* Ignore invalid image specifications. */
7476 if (!valid_image_p (image
))
7479 /* Display the tool-bar button pressed, or depressed. */
7480 plist
= Fcopy_sequence (XCDR (image
));
7482 /* Compute margin and relief to draw. */
7483 relief
= (tool_bar_button_relief
> 0
7484 ? tool_bar_button_relief
7485 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
7486 hmargin
= vmargin
= relief
;
7488 if (INTEGERP (Vtool_bar_button_margin
)
7489 && XINT (Vtool_bar_button_margin
) > 0)
7491 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
7492 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
7494 else if (CONSP (Vtool_bar_button_margin
))
7496 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
7497 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
7498 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
7500 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
7501 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
7502 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
7505 if (auto_raise_tool_bar_buttons_p
)
7507 /* Add a `:relief' property to the image spec if the item is
7511 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
7518 /* If image is selected, display it pressed, i.e. with a
7519 negative relief. If it's not selected, display it with a
7521 plist
= Fplist_put (plist
, QCrelief
,
7523 ? make_number (-relief
)
7524 : make_number (relief
)));
7529 /* Put a margin around the image. */
7530 if (hmargin
|| vmargin
)
7532 if (hmargin
== vmargin
)
7533 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
7535 plist
= Fplist_put (plist
, QCmargin
,
7536 Fcons (make_number (hmargin
),
7537 make_number (vmargin
)));
7540 /* If button is not enabled, and we don't have special images
7541 for the disabled state, make the image appear disabled by
7542 applying an appropriate algorithm to it. */
7543 if (!enabled_p
&& idx
< 0)
7544 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
7546 /* Put a `display' text property on the string for the image to
7547 display. Put a `menu-item' property on the string that gives
7548 the start of this item's properties in the tool-bar items
7550 image
= Fcons (Qimage
, plist
);
7551 props
= list4 (Qdisplay
, image
,
7552 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
7554 /* Let the last image hide all remaining spaces in the tool bar
7555 string. The string can be longer than needed when we reuse a
7557 if (i
+ 1 == f
->n_tool_bar_items
)
7558 end
= XSTRING (f
->desired_tool_bar_string
)->size
;
7561 Fadd_text_properties (make_number (i
), make_number (end
),
7562 props
, f
->desired_tool_bar_string
);
7570 /* Display one line of the tool-bar of frame IT->f. */
7573 display_tool_bar_line (it
)
7576 struct glyph_row
*row
= it
->glyph_row
;
7577 int max_x
= it
->last_visible_x
;
7580 prepare_desired_row (row
);
7581 row
->y
= it
->current_y
;
7583 /* Note that this isn't made use of if the face hasn't a box,
7584 so there's no need to check the face here. */
7585 it
->start_of_box_run_p
= 1;
7587 while (it
->current_x
< max_x
)
7589 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
7591 /* Get the next display element. */
7592 if (!get_next_display_element (it
))
7595 /* Produce glyphs. */
7596 x_before
= it
->current_x
;
7597 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
7598 PRODUCE_GLYPHS (it
);
7600 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
7605 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
7607 if (x
+ glyph
->pixel_width
> max_x
)
7609 /* Glyph doesn't fit on line. */
7610 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
7616 x
+= glyph
->pixel_width
;
7620 /* Stop at line ends. */
7621 if (ITERATOR_AT_END_OF_LINE_P (it
))
7624 set_iterator_to_next (it
, 1);
7629 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
7630 extend_face_to_end_of_line (it
);
7631 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
7632 last
->right_box_line_p
= 1;
7633 if (last
== row
->glyphs
[TEXT_AREA
])
7634 last
->left_box_line_p
= 1;
7635 compute_line_metrics (it
);
7637 /* If line is empty, make it occupy the rest of the tool-bar. */
7638 if (!row
->displays_text_p
)
7640 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
7641 row
->ascent
= row
->phys_ascent
= 0;
7644 row
->full_width_p
= 1;
7645 row
->continued_p
= 0;
7646 row
->truncated_on_left_p
= 0;
7647 row
->truncated_on_right_p
= 0;
7649 it
->current_x
= it
->hpos
= 0;
7650 it
->current_y
+= row
->height
;
7656 /* Value is the number of screen lines needed to make all tool-bar
7657 items of frame F visible. */
7660 tool_bar_lines_needed (f
)
7663 struct window
*w
= XWINDOW (f
->tool_bar_window
);
7666 /* Initialize an iterator for iteration over
7667 F->desired_tool_bar_string in the tool-bar window of frame F. */
7668 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
7669 it
.first_visible_x
= 0;
7670 it
.last_visible_x
= FRAME_WINDOW_WIDTH (f
) * CANON_X_UNIT (f
);
7671 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
7673 while (!ITERATOR_AT_END_P (&it
))
7675 it
.glyph_row
= w
->desired_matrix
->rows
;
7676 clear_glyph_row (it
.glyph_row
);
7677 display_tool_bar_line (&it
);
7680 return (it
.current_y
+ CANON_Y_UNIT (f
) - 1) / CANON_Y_UNIT (f
);
7684 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
7686 "Return the number of lines occupied by the tool bar of FRAME.")
7695 frame
= selected_frame
;
7697 CHECK_FRAME (frame
, 0);
7700 if (WINDOWP (f
->tool_bar_window
)
7701 || (w
= XWINDOW (f
->tool_bar_window
),
7702 XFASTINT (w
->height
) > 0))
7704 update_tool_bar (f
, 1);
7705 if (f
->n_tool_bar_items
)
7707 build_desired_tool_bar_string (f
);
7708 nlines
= tool_bar_lines_needed (f
);
7712 return make_number (nlines
);
7716 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
7717 height should be changed. */
7720 redisplay_tool_bar (f
)
7725 struct glyph_row
*row
;
7726 int change_height_p
= 0;
7728 /* If frame hasn't a tool-bar window or if it is zero-height, don't
7729 do anything. This means you must start with tool-bar-lines
7730 non-zero to get the auto-sizing effect. Or in other words, you
7731 can turn off tool-bars by specifying tool-bar-lines zero. */
7732 if (!WINDOWP (f
->tool_bar_window
)
7733 || (w
= XWINDOW (f
->tool_bar_window
),
7734 XFASTINT (w
->height
) == 0))
7737 /* Set up an iterator for the tool-bar window. */
7738 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
7739 it
.first_visible_x
= 0;
7740 it
.last_visible_x
= FRAME_WINDOW_WIDTH (f
) * CANON_X_UNIT (f
);
7743 /* Build a string that represents the contents of the tool-bar. */
7744 build_desired_tool_bar_string (f
);
7745 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
7747 /* Display as many lines as needed to display all tool-bar items. */
7748 while (it
.current_y
< it
.last_visible_y
)
7749 display_tool_bar_line (&it
);
7751 /* It doesn't make much sense to try scrolling in the tool-bar
7752 window, so don't do it. */
7753 w
->desired_matrix
->no_scrolling_p
= 1;
7754 w
->must_be_updated_p
= 1;
7756 if (auto_resize_tool_bars_p
)
7760 /* If we couldn't display everything, change the tool-bar's
7762 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
7763 change_height_p
= 1;
7765 /* If there are blank lines at the end, except for a partially
7766 visible blank line at the end that is smaller than
7767 CANON_Y_UNIT, change the tool-bar's height. */
7768 row
= it
.glyph_row
- 1;
7769 if (!row
->displays_text_p
7770 && row
->height
>= CANON_Y_UNIT (f
))
7771 change_height_p
= 1;
7773 /* If row displays tool-bar items, but is partially visible,
7774 change the tool-bar's height. */
7775 if (row
->displays_text_p
7776 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
7777 change_height_p
= 1;
7779 /* Resize windows as needed by changing the `tool-bar-lines'
7782 && (nlines
= tool_bar_lines_needed (f
),
7783 nlines
!= XFASTINT (w
->height
)))
7785 extern Lisp_Object Qtool_bar_lines
;
7787 int old_height
= XFASTINT (w
->height
);
7789 XSETFRAME (frame
, f
);
7790 clear_glyph_matrix (w
->desired_matrix
);
7791 Fmodify_frame_parameters (frame
,
7792 Fcons (Fcons (Qtool_bar_lines
,
7793 make_number (nlines
)),
7795 if (XFASTINT (w
->height
) != old_height
)
7796 fonts_changed_p
= 1;
7800 return change_height_p
;
7804 /* Get information about the tool-bar item which is displayed in GLYPH
7805 on frame F. Return in *PROP_IDX the index where tool-bar item
7806 properties start in F->tool_bar_items. Value is zero if
7807 GLYPH doesn't display a tool-bar item. */
7810 tool_bar_item_info (f
, glyph
, prop_idx
)
7812 struct glyph
*glyph
;
7818 /* Get the text property `menu-item' at pos. The value of that
7819 property is the start index of this item's properties in
7820 F->tool_bar_items. */
7821 prop
= Fget_text_property (make_number (glyph
->charpos
),
7822 Qmenu_item
, f
->current_tool_bar_string
);
7823 if (INTEGERP (prop
))
7825 *prop_idx
= XINT (prop
);
7834 #endif /* HAVE_WINDOW_SYSTEM */
7838 /************************************************************************
7839 Horizontal scrolling
7840 ************************************************************************/
7842 static int hscroll_window_tree
P_ ((Lisp_Object
));
7843 static int hscroll_windows
P_ ((Lisp_Object
));
7845 /* For all leaf windows in the window tree rooted at WINDOW, set their
7846 hscroll value so that PT is (i) visible in the window, and (ii) so
7847 that it is not within a certain margin at the window's left and
7848 right border. Value is non-zero if any window's hscroll has been
7852 hscroll_window_tree (window
)
7855 int hscrolled_p
= 0;
7857 while (WINDOWP (window
))
7859 struct window
*w
= XWINDOW (window
);
7861 if (WINDOWP (w
->hchild
))
7862 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
7863 else if (WINDOWP (w
->vchild
))
7864 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
7865 else if (w
->cursor
.vpos
>= 0)
7867 int hscroll_margin
, text_area_x
, text_area_y
;
7868 int text_area_width
, text_area_height
;
7869 struct glyph_row
*current_cursor_row
7870 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
7871 struct glyph_row
*desired_cursor_row
7872 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
7873 struct glyph_row
*cursor_row
7874 = (desired_cursor_row
->enabled_p
7875 ? desired_cursor_row
7876 : current_cursor_row
);
7878 window_box (w
, TEXT_AREA
, &text_area_x
, &text_area_y
,
7879 &text_area_width
, &text_area_height
);
7881 /* Scroll when cursor is inside this scroll margin. */
7882 hscroll_margin
= 5 * CANON_X_UNIT (XFRAME (w
->frame
));
7884 if ((XFASTINT (w
->hscroll
)
7885 && w
->cursor
.x
< hscroll_margin
)
7886 || (cursor_row
->enabled_p
7887 && cursor_row
->truncated_on_right_p
7888 && (w
->cursor
.x
> text_area_width
- hscroll_margin
)))
7892 struct buffer
*saved_current_buffer
;
7895 /* Find point in a display of infinite width. */
7896 saved_current_buffer
= current_buffer
;
7897 current_buffer
= XBUFFER (w
->buffer
);
7899 if (w
== XWINDOW (selected_window
))
7900 pt
= BUF_PT (current_buffer
);
7903 pt
= marker_position (w
->pointm
);
7904 pt
= max (BEGV
, pt
);
7908 /* Move iterator to pt starting at cursor_row->start in
7909 a line with infinite width. */
7910 init_to_row_start (&it
, w
, cursor_row
);
7911 it
.last_visible_x
= INFINITY
;
7912 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
7913 current_buffer
= saved_current_buffer
;
7915 /* Center cursor in window. */
7916 hscroll
= (max (0, it
.current_x
- text_area_width
/ 2)
7917 / CANON_X_UNIT (it
.f
));
7918 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
7920 /* Don't call Fset_window_hscroll if value hasn't
7921 changed because it will prevent redisplay
7923 if (XFASTINT (w
->hscroll
) != hscroll
)
7925 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
7926 w
->hscroll
= make_number (hscroll
);
7935 /* Value is non-zero if hscroll of any leaf window has been changed. */
7940 /* Set hscroll so that cursor is visible and not inside horizontal
7941 scroll margins for all windows in the tree rooted at WINDOW. See
7942 also hscroll_window_tree above. Value is non-zero if any window's
7943 hscroll has been changed. If it has, desired matrices on the frame
7944 of WINDOW are cleared. */
7947 hscroll_windows (window
)
7952 if (automatic_hscrolling_p
)
7954 hscrolled_p
= hscroll_window_tree (window
);
7956 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
7965 /************************************************************************
7967 ************************************************************************/
7969 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
7970 to a non-zero value. This is sometimes handy to have in a debugger
7975 /* First and last unchanged row for try_window_id. */
7977 int debug_first_unchanged_at_end_vpos
;
7978 int debug_last_unchanged_at_beg_vpos
;
7980 /* Delta vpos and y. */
7982 int debug_dvpos
, debug_dy
;
7984 /* Delta in characters and bytes for try_window_id. */
7986 int debug_delta
, debug_delta_bytes
;
7988 /* Values of window_end_pos and window_end_vpos at the end of
7991 int debug_end_pos
, debug_end_vpos
;
7993 /* Append a string to W->desired_matrix->method. FMT is a printf
7994 format string. A1...A9 are a supplement for a variable-length
7995 argument list. If trace_redisplay_p is non-zero also printf the
7996 resulting string to stderr. */
7999 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
8002 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
8005 char *method
= w
->desired_matrix
->method
;
8006 int len
= strlen (method
);
8007 int size
= sizeof w
->desired_matrix
->method
;
8008 int remaining
= size
- len
- 1;
8010 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
8011 if (len
&& remaining
)
8017 strncpy (method
+ len
, buffer
, remaining
);
8019 if (trace_redisplay_p
)
8020 fprintf (stderr
, "%p (%s): %s\n",
8022 ((BUFFERP (w
->buffer
)
8023 && STRINGP (XBUFFER (w
->buffer
)->name
))
8024 ? (char *) XSTRING (XBUFFER (w
->buffer
)->name
)->data
8029 #endif /* GLYPH_DEBUG */
8032 /* This counter is used to clear the face cache every once in a while
8033 in redisplay_internal. It is incremented for each redisplay.
8034 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
8037 #define CLEAR_FACE_CACHE_COUNT 10000
8038 static int clear_face_cache_count
;
8040 /* Record the previous terminal frame we displayed. */
8042 static struct frame
*previous_terminal_frame
;
8044 /* Non-zero while redisplay_internal is in progress. */
8049 /* Value is non-zero if all changes in window W, which displays
8050 current_buffer, are in the text between START and END. START is a
8051 buffer position, END is given as a distance from Z. Used in
8052 redisplay_internal for display optimization. */
8055 text_outside_line_unchanged_p (w
, start
, end
)
8059 int unchanged_p
= 1;
8061 /* If text or overlays have changed, see where. */
8062 if (XFASTINT (w
->last_modified
) < MODIFF
8063 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
8065 /* Gap in the line? */
8066 if (GPT
< start
|| Z
- GPT
< end
)
8069 /* Changes start in front of the line, or end after it? */
8071 && (BEG_UNCHANGED
< start
- 1
8072 || END_UNCHANGED
< end
))
8075 /* If selective display, can't optimize if changes start at the
8076 beginning of the line. */
8078 && INTEGERP (current_buffer
->selective_display
)
8079 && XINT (current_buffer
->selective_display
) > 0
8080 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
8088 /* Do a frame update, taking possible shortcuts into account. This is
8089 the main external entry point for redisplay.
8091 If the last redisplay displayed an echo area message and that message
8092 is no longer requested, we clear the echo area or bring back the
8093 mini-buffer if that is in use. */
8098 redisplay_internal (0);
8101 /* Return 1 if point moved out of or into a composition. Otherwise
8102 return 0. PREV_BUF and PREV_PT are the last point buffer and
8103 position. BUF and PT are the current point buffer and position. */
8106 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
8107 struct buffer
*prev_buf
, *buf
;
8114 XSETBUFFER (buffer
, buf
);
8115 /* Check a composition at the last point if point moved within the
8117 if (prev_buf
== buf
)
8120 /* Point didn't move. */
8123 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
8124 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
8125 && COMPOSITION_VALID_P (start
, end
, prop
)
8126 && start
< prev_pt
&& end
> prev_pt
)
8127 /* The last point was within the composition. Return 1 iff
8128 point moved out of the composition. */
8129 return (pt
<= start
|| pt
>= end
);
8132 /* Check a composition at the current point. */
8133 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
8134 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
8135 && COMPOSITION_VALID_P (start
, end
, prop
)
8136 && start
< pt
&& end
> pt
);
8139 /* Reconsider the setting of B->clip_changed which is displayed
8143 reconsider_clip_changes (w
, b
)
8147 if (b
->prevent_redisplay_optimizations_p
)
8148 b
->clip_changed
= 1;
8149 else if (b
->clip_changed
8150 && !NILP (w
->window_end_valid
)
8151 && w
->current_matrix
->buffer
== b
8152 && w
->current_matrix
->zv
== BUF_ZV (b
)
8153 && w
->current_matrix
->begv
== BUF_BEGV (b
))
8154 b
->clip_changed
= 0;
8156 /* If display wasn't paused, and W is not a tool bar window, see if
8157 point has been moved into or out of a composition. In that case,
8158 we set b->clip_changed to 1 to force updating the screen. If
8159 b->clip_changed has already been set to 1, we can skip this
8161 if (!b
->clip_changed
8162 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
8166 if (w
== XWINDOW (selected_window
))
8167 pt
= BUF_PT (current_buffer
);
8169 pt
= marker_position (w
->pointm
);
8171 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
8172 || pt
!= XINT (w
->last_point
))
8173 && check_point_in_composition (w
->current_matrix
->buffer
,
8174 XINT (w
->last_point
),
8175 XBUFFER (w
->buffer
), pt
))
8176 b
->clip_changed
= 1;
8181 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
8182 response to any user action; therefore, we should preserve the echo
8183 area. (Actually, our caller does that job.) Perhaps in the future
8184 avoid recentering windows if it is not necessary; currently that
8185 causes some problems. */
8188 redisplay_internal (preserve_echo_area
)
8189 int preserve_echo_area
;
8191 struct window
*w
= XWINDOW (selected_window
);
8192 struct frame
*f
= XFRAME (w
->frame
);
8194 int must_finish
= 0;
8195 struct text_pos tlbufpos
, tlendpos
;
8196 int number_of_visible_frames
;
8198 struct frame
*sf
= SELECTED_FRAME ();
8200 /* Non-zero means redisplay has to consider all windows on all
8201 frames. Zero means, only selected_window is considered. */
8202 int consider_all_windows_p
;
8204 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
8206 /* No redisplay if running in batch mode or frame is not yet fully
8207 initialized, or redisplay is explicitly turned off by setting
8208 Vinhibit_redisplay. */
8210 || !NILP (Vinhibit_redisplay
)
8211 || !f
->glyphs_initialized_p
)
8214 /* The flag redisplay_performed_directly_p is set by
8215 direct_output_for_insert when it already did the whole screen
8216 update necessary. */
8217 if (redisplay_performed_directly_p
)
8219 redisplay_performed_directly_p
= 0;
8220 if (!hscroll_windows (selected_window
))
8224 #ifdef USE_X_TOOLKIT
8225 if (popup_activated ())
8229 /* I don't think this happens but let's be paranoid. */
8233 /* Record a function that resets redisplaying_p to its old value
8234 when we leave this function. */
8235 count
= BINDING_STACK_SIZE ();
8236 record_unwind_protect (unwind_redisplay
, make_number (redisplaying_p
));
8241 reconsider_clip_changes (w
, current_buffer
);
8243 /* If new fonts have been loaded that make a glyph matrix adjustment
8244 necessary, do it. */
8245 if (fonts_changed_p
)
8247 adjust_glyphs (NULL
);
8248 ++windows_or_buffers_changed
;
8249 fonts_changed_p
= 0;
8252 /* If face_change_count is non-zero, init_iterator will free all
8253 realized faces, which includes the faces referenced from current
8254 matrices. So, we can't reuse current matrices in this case. */
8255 if (face_change_count
)
8256 ++windows_or_buffers_changed
;
8258 if (! FRAME_WINDOW_P (sf
)
8259 && previous_terminal_frame
!= sf
)
8261 /* Since frames on an ASCII terminal share the same display
8262 area, displaying a different frame means redisplay the whole
8264 windows_or_buffers_changed
++;
8265 SET_FRAME_GARBAGED (sf
);
8266 XSETFRAME (Vterminal_frame
, sf
);
8268 previous_terminal_frame
= sf
;
8270 /* Set the visible flags for all frames. Do this before checking
8271 for resized or garbaged frames; they want to know if their frames
8272 are visible. See the comment in frame.h for
8273 FRAME_SAMPLE_VISIBILITY. */
8275 Lisp_Object tail
, frame
;
8277 number_of_visible_frames
= 0;
8279 FOR_EACH_FRAME (tail
, frame
)
8281 struct frame
*f
= XFRAME (frame
);
8283 FRAME_SAMPLE_VISIBILITY (f
);
8284 if (FRAME_VISIBLE_P (f
))
8285 ++number_of_visible_frames
;
8286 clear_desired_matrices (f
);
8290 /* Notice any pending interrupt request to change frame size. */
8291 do_pending_window_change (1);
8293 /* Clear frames marked as garbaged. */
8295 clear_garbaged_frames ();
8297 /* Build menubar and tool-bar items. */
8298 prepare_menu_bars ();
8300 if (windows_or_buffers_changed
)
8301 update_mode_lines
++;
8303 /* Detect case that we need to write or remove a star in the mode line. */
8304 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
8306 w
->update_mode_line
= Qt
;
8307 if (buffer_shared
> 1)
8308 update_mode_lines
++;
8311 /* If %c is in the mode line, update it if needed. */
8312 if (!NILP (w
->column_number_displayed
)
8313 /* This alternative quickly identifies a common case
8314 where no change is needed. */
8315 && !(PT
== XFASTINT (w
->last_point
)
8316 && XFASTINT (w
->last_modified
) >= MODIFF
8317 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
8318 && XFASTINT (w
->column_number_displayed
) != current_column ())
8319 w
->update_mode_line
= Qt
;
8321 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
8323 /* The variable buffer_shared is set in redisplay_window and
8324 indicates that we redisplay a buffer in different windows. See
8326 consider_all_windows_p
= update_mode_lines
|| buffer_shared
> 1;
8328 /* If specs for an arrow have changed, do thorough redisplay
8329 to ensure we remove any arrow that should no longer exist. */
8330 if (! EQ (COERCE_MARKER (Voverlay_arrow_position
), last_arrow_position
)
8331 || ! EQ (Voverlay_arrow_string
, last_arrow_string
))
8332 consider_all_windows_p
= windows_or_buffers_changed
= 1;
8334 /* Normally the message* functions will have already displayed and
8335 updated the echo area, but the frame may have been trashed, or
8336 the update may have been preempted, so display the echo area
8337 again here. Checking both message buffers captures the case that
8338 the echo area should be cleared. */
8339 if (!NILP (echo_area_buffer
[0]) || !NILP (echo_area_buffer
[1]))
8341 int window_height_changed_p
= echo_area_display (0);
8344 if (fonts_changed_p
)
8346 else if (window_height_changed_p
)
8348 consider_all_windows_p
= 1;
8349 ++update_mode_lines
;
8350 ++windows_or_buffers_changed
;
8352 /* If window configuration was changed, frames may have been
8353 marked garbaged. Clear them or we will experience
8354 surprises wrt scrolling. */
8356 clear_garbaged_frames ();
8359 else if (EQ (selected_window
, minibuf_window
)
8360 && (current_buffer
->clip_changed
8361 || XFASTINT (w
->last_modified
) < MODIFF
8362 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
8363 && resize_mini_window (w
, 0))
8365 /* Resized active mini-window to fit the size of what it is
8366 showing if its contents might have changed. */
8368 consider_all_windows_p
= 1;
8369 ++windows_or_buffers_changed
;
8370 ++update_mode_lines
;
8372 /* If window configuration was changed, frames may have been
8373 marked garbaged. Clear them or we will experience
8374 surprises wrt scrolling. */
8376 clear_garbaged_frames ();
8380 /* If showing the region, and mark has changed, we must redisplay
8381 the whole window. The assignment to this_line_start_pos prevents
8382 the optimization directly below this if-statement. */
8383 if (((!NILP (Vtransient_mark_mode
)
8384 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
8385 != !NILP (w
->region_showing
))
8386 || (!NILP (w
->region_showing
)
8387 && !EQ (w
->region_showing
,
8388 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
8389 CHARPOS (this_line_start_pos
) = 0;
8391 /* Optimize the case that only the line containing the cursor in the
8392 selected window has changed. Variables starting with this_ are
8393 set in display_line and record information about the line
8394 containing the cursor. */
8395 tlbufpos
= this_line_start_pos
;
8396 tlendpos
= this_line_end_pos
;
8397 if (!consider_all_windows_p
8398 && CHARPOS (tlbufpos
) > 0
8399 && NILP (w
->update_mode_line
)
8400 && !current_buffer
->clip_changed
8401 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
8402 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
8403 /* Make sure recorded data applies to current buffer, etc. */
8404 && this_line_buffer
== current_buffer
8405 && current_buffer
== XBUFFER (w
->buffer
)
8406 && NILP (w
->force_start
)
8407 /* Point must be on the line that we have info recorded about. */
8408 && PT
>= CHARPOS (tlbufpos
)
8409 && PT
<= Z
- CHARPOS (tlendpos
)
8410 /* All text outside that line, including its final newline,
8411 must be unchanged */
8412 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
8413 CHARPOS (tlendpos
)))
8415 if (CHARPOS (tlbufpos
) > BEGV
8416 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
8417 && (CHARPOS (tlbufpos
) == ZV
8418 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
8419 /* Former continuation line has disappeared by becoming empty */
8421 else if (XFASTINT (w
->last_modified
) < MODIFF
8422 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
8423 || MINI_WINDOW_P (w
))
8425 /* We have to handle the case of continuation around a
8426 wide-column character (See the comment in indent.c around
8429 For instance, in the following case:
8431 -------- Insert --------
8432 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
8433 J_I_ ==> J_I_ `^^' are cursors.
8437 As we have to redraw the line above, we should goto cancel. */
8440 int line_height_before
= this_line_pixel_height
;
8442 /* Note that start_display will handle the case that the
8443 line starting at tlbufpos is a continuation lines. */
8444 start_display (&it
, w
, tlbufpos
);
8446 /* Implementation note: It this still necessary? */
8447 if (it
.current_x
!= this_line_start_x
)
8450 TRACE ((stderr
, "trying display optimization 1\n"));
8451 w
->cursor
.vpos
= -1;
8452 overlay_arrow_seen
= 0;
8453 it
.vpos
= this_line_vpos
;
8454 it
.current_y
= this_line_y
;
8455 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
8458 /* If line contains point, is not continued,
8459 and ends at same distance from eob as before, we win */
8460 if (w
->cursor
.vpos
>= 0
8461 /* Line is not continued, otherwise this_line_start_pos
8462 would have been set to 0 in display_line. */
8463 && CHARPOS (this_line_start_pos
)
8464 /* Line ends as before. */
8465 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
8466 /* Line has same height as before. Otherwise other lines
8467 would have to be shifted up or down. */
8468 && this_line_pixel_height
== line_height_before
)
8470 /* If this is not the window's last line, we must adjust
8471 the charstarts of the lines below. */
8472 if (it
.current_y
< it
.last_visible_y
)
8474 struct glyph_row
*row
8475 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
8476 int delta
, delta_bytes
;
8478 if (Z
- CHARPOS (tlendpos
) == ZV
)
8480 /* This line ends at end of (accessible part of)
8481 buffer. There is no newline to count. */
8483 - CHARPOS (tlendpos
)
8484 - MATRIX_ROW_START_CHARPOS (row
));
8485 delta_bytes
= (Z_BYTE
8486 - BYTEPOS (tlendpos
)
8487 - MATRIX_ROW_START_BYTEPOS (row
));
8491 /* This line ends in a newline. Must take
8492 account of the newline and the rest of the
8493 text that follows. */
8495 - CHARPOS (tlendpos
)
8496 - MATRIX_ROW_START_CHARPOS (row
));
8497 delta_bytes
= (Z_BYTE
8498 - BYTEPOS (tlendpos
)
8499 - MATRIX_ROW_START_BYTEPOS (row
));
8502 increment_matrix_positions (w
->current_matrix
,
8504 w
->current_matrix
->nrows
,
8505 delta
, delta_bytes
);
8508 /* If this row displays text now but previously didn't,
8509 or vice versa, w->window_end_vpos may have to be
8511 if ((it
.glyph_row
- 1)->displays_text_p
)
8513 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
8514 XSETINT (w
->window_end_vpos
, this_line_vpos
);
8516 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
8517 && this_line_vpos
> 0)
8518 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
8519 w
->window_end_valid
= Qnil
;
8521 /* Update hint: No need to try to scroll in update_window. */
8522 w
->desired_matrix
->no_scrolling_p
= 1;
8525 *w
->desired_matrix
->method
= 0;
8526 debug_method_add (w
, "optimization 1");
8533 else if (/* Cursor position hasn't changed. */
8534 PT
== XFASTINT (w
->last_point
)
8535 /* Make sure the cursor was last displayed
8536 in this window. Otherwise we have to reposition it. */
8537 && 0 <= w
->cursor
.vpos
8538 && XINT (w
->height
) > w
->cursor
.vpos
)
8542 do_pending_window_change (1);
8544 /* We used to always goto end_of_redisplay here, but this
8545 isn't enough if we have a blinking cursor. */
8546 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
8547 goto end_of_redisplay
;
8551 /* If highlighting the region, or if the cursor is in the echo area,
8552 then we can't just move the cursor. */
8553 else if (! (!NILP (Vtransient_mark_mode
)
8554 && !NILP (current_buffer
->mark_active
))
8555 && (EQ (selected_window
, current_buffer
->last_selected_window
)
8556 || highlight_nonselected_windows
)
8557 && NILP (w
->region_showing
)
8558 && NILP (Vshow_trailing_whitespace
)
8559 && !cursor_in_echo_area
)
8562 struct glyph_row
*row
;
8564 /* Skip from tlbufpos to PT and see where it is. Note that
8565 PT may be in invisible text. If so, we will end at the
8566 next visible position. */
8567 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
8568 NULL
, DEFAULT_FACE_ID
);
8569 it
.current_x
= this_line_start_x
;
8570 it
.current_y
= this_line_y
;
8571 it
.vpos
= this_line_vpos
;
8573 /* The call to move_it_to stops in front of PT, but
8574 moves over before-strings. */
8575 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
8577 if (it
.vpos
== this_line_vpos
8578 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
8581 xassert (this_line_vpos
== it
.vpos
);
8582 xassert (this_line_y
== it
.current_y
);
8583 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
8585 *w
->desired_matrix
->method
= 0;
8586 debug_method_add (w
, "optimization 3");
8595 /* Text changed drastically or point moved off of line. */
8596 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
8599 CHARPOS (this_line_start_pos
) = 0;
8600 consider_all_windows_p
|= buffer_shared
> 1;
8601 ++clear_face_cache_count
;
8604 /* Build desired matrices, and update the display. If
8605 consider_all_windows_p is non-zero, do it for all windows on all
8606 frames. Otherwise do it for selected_window, only. */
8608 if (consider_all_windows_p
)
8610 Lisp_Object tail
, frame
;
8611 int i
, n
= 0, size
= 50;
8612 struct frame
**updated
8613 = (struct frame
**) alloca (size
* sizeof *updated
);
8615 /* Clear the face cache eventually. */
8616 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
8618 clear_face_cache (0);
8619 clear_face_cache_count
= 0;
8622 /* Recompute # windows showing selected buffer. This will be
8623 incremented each time such a window is displayed. */
8626 FOR_EACH_FRAME (tail
, frame
)
8628 struct frame
*f
= XFRAME (frame
);
8630 if (FRAME_WINDOW_P (f
) || f
== sf
)
8632 /* Mark all the scroll bars to be removed; we'll redeem
8633 the ones we want when we redisplay their windows. */
8634 if (condemn_scroll_bars_hook
)
8635 condemn_scroll_bars_hook (f
);
8637 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
8638 redisplay_windows (FRAME_ROOT_WINDOW (f
));
8640 /* Any scroll bars which redisplay_windows should have
8641 nuked should now go away. */
8642 if (judge_scroll_bars_hook
)
8643 judge_scroll_bars_hook (f
);
8645 /* If fonts changed, display again. */
8646 if (fonts_changed_p
)
8649 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
8651 /* See if we have to hscroll. */
8652 if (hscroll_windows (f
->root_window
))
8655 /* Prevent various kinds of signals during display
8656 update. stdio is not robust about handling
8657 signals, which can cause an apparent I/O
8659 if (interrupt_input
)
8663 /* Update the display. */
8664 set_window_update_flags (XWINDOW (f
->root_window
), 1);
8665 pause
|= update_frame (f
, 0, 0);
8671 int nbytes
= size
* sizeof *updated
;
8672 struct frame
**p
= (struct frame
**) alloca (2 * nbytes
);
8673 bcopy (updated
, p
, nbytes
);
8682 /* Do the mark_window_display_accurate after all windows have
8683 been redisplayed because this call resets flags in buffers
8684 which are needed for proper redisplay. */
8685 for (i
= 0; i
< n
; ++i
)
8687 struct frame
*f
= updated
[i
];
8688 mark_window_display_accurate (f
->root_window
, 1);
8689 if (frame_up_to_date_hook
)
8690 frame_up_to_date_hook (f
);
8693 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
8695 Lisp_Object mini_window
;
8696 struct frame
*mini_frame
;
8698 redisplay_window (selected_window
, 1);
8700 /* Compare desired and current matrices, perform output. */
8703 /* If fonts changed, display again. */
8704 if (fonts_changed_p
)
8707 /* Prevent various kinds of signals during display update.
8708 stdio is not robust about handling signals,
8709 which can cause an apparent I/O error. */
8710 if (interrupt_input
)
8714 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
8716 if (hscroll_windows (selected_window
))
8719 XWINDOW (selected_window
)->must_be_updated_p
= 1;
8720 pause
= update_frame (sf
, 0, 0);
8723 /* We may have called echo_area_display at the top of this
8724 function. If the echo area is on another frame, that may
8725 have put text on a frame other than the selected one, so the
8726 above call to update_frame would not have caught it. Catch
8728 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8729 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8731 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
8733 XWINDOW (mini_window
)->must_be_updated_p
= 1;
8734 pause
|= update_frame (mini_frame
, 0, 0);
8735 if (!pause
&& hscroll_windows (mini_window
))
8740 /* If display was paused because of pending input, make sure we do a
8741 thorough update the next time. */
8744 /* Prevent the optimization at the beginning of
8745 redisplay_internal that tries a single-line update of the
8746 line containing the cursor in the selected window. */
8747 CHARPOS (this_line_start_pos
) = 0;
8749 /* Let the overlay arrow be updated the next time. */
8750 if (!NILP (last_arrow_position
))
8752 last_arrow_position
= Qt
;
8753 last_arrow_string
= Qt
;
8756 /* If we pause after scrolling, some rows in the current
8757 matrices of some windows are not valid. */
8758 if (!WINDOW_FULL_WIDTH_P (w
)
8759 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
8760 update_mode_lines
= 1;
8764 if (!consider_all_windows_p
)
8766 /* This has already been done above if
8767 consider_all_windows_p is set. */
8768 mark_window_display_accurate_1 (w
, 1);
8770 last_arrow_position
= COERCE_MARKER (Voverlay_arrow_position
);
8771 last_arrow_string
= Voverlay_arrow_string
;
8773 if (frame_up_to_date_hook
!= 0)
8774 frame_up_to_date_hook (sf
);
8777 update_mode_lines
= 0;
8778 windows_or_buffers_changed
= 0;
8781 /* Start SIGIO interrupts coming again. Having them off during the
8782 code above makes it less likely one will discard output, but not
8783 impossible, since there might be stuff in the system buffer here.
8784 But it is much hairier to try to do anything about that. */
8785 if (interrupt_input
)
8789 /* If a frame has become visible which was not before, redisplay
8790 again, so that we display it. Expose events for such a frame
8791 (which it gets when becoming visible) don't call the parts of
8792 redisplay constructing glyphs, so simply exposing a frame won't
8793 display anything in this case. So, we have to display these
8794 frames here explicitly. */
8797 Lisp_Object tail
, frame
;
8800 FOR_EACH_FRAME (tail
, frame
)
8802 int this_is_visible
= 0;
8804 if (XFRAME (frame
)->visible
)
8805 this_is_visible
= 1;
8806 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
8807 if (XFRAME (frame
)->visible
)
8808 this_is_visible
= 1;
8810 if (this_is_visible
)
8814 if (new_count
!= number_of_visible_frames
)
8815 windows_or_buffers_changed
++;
8818 /* Change frame size now if a change is pending. */
8819 do_pending_window_change (1);
8821 /* If we just did a pending size change, or have additional
8822 visible frames, redisplay again. */
8823 if (windows_or_buffers_changed
&& !pause
)
8828 unbind_to (count
, Qnil
);
8832 /* Redisplay, but leave alone any recent echo area message unless
8833 another message has been requested in its place.
8835 This is useful in situations where you need to redisplay but no
8836 user action has occurred, making it inappropriate for the message
8837 area to be cleared. See tracking_off and
8838 wait_reading_process_input for examples of these situations.
8840 FROM_WHERE is an integer saying from where this function was
8841 called. This is useful for debugging. */
8844 redisplay_preserve_echo_area (from_where
)
8847 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
8849 if (!NILP (echo_area_buffer
[1]))
8851 /* We have a previously displayed message, but no current
8852 message. Redisplay the previous message. */
8853 display_last_displayed_message_p
= 1;
8854 redisplay_internal (1);
8855 display_last_displayed_message_p
= 0;
8858 redisplay_internal (1);
8862 /* Function registered with record_unwind_protect in
8863 redisplay_internal. Clears the flag indicating that a redisplay is
8867 unwind_redisplay (old_redisplaying_p
)
8868 Lisp_Object old_redisplaying_p
;
8870 redisplaying_p
= XFASTINT (old_redisplaying_p
);
8875 /* Mark the display of window W as accurate or inaccurate. If
8876 ACCURATE_P is non-zero mark display of W as accurate. If
8877 ACCURATE_P is zero, arrange for W to be redisplayed the next time
8878 redisplay_internal is called. */
8881 mark_window_display_accurate_1 (w
, accurate_p
)
8885 if (BUFFERP (w
->buffer
))
8887 struct buffer
*b
= XBUFFER (w
->buffer
);
8890 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
8891 w
->last_overlay_modified
8892 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
8894 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
8898 b
->clip_changed
= 0;
8899 b
->prevent_redisplay_optimizations_p
= 0;
8901 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
8902 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
8903 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
8904 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
8906 w
->current_matrix
->buffer
= b
;
8907 w
->current_matrix
->begv
= BUF_BEGV (b
);
8908 w
->current_matrix
->zv
= BUF_ZV (b
);
8910 w
->last_cursor
= w
->cursor
;
8911 w
->last_cursor_off_p
= w
->cursor_off_p
;
8913 if (w
== XWINDOW (selected_window
))
8914 w
->last_point
= make_number (BUF_PT (b
));
8916 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
8922 w
->window_end_valid
= w
->buffer
;
8923 w
->update_mode_line
= Qnil
;
8928 /* Mark the display of windows in the window tree rooted at WINDOW as
8929 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
8930 windows as accurate. If ACCURATE_P is zero, arrange for windows to
8931 be redisplayed the next time redisplay_internal is called. */
8934 mark_window_display_accurate (window
, accurate_p
)
8940 for (; !NILP (window
); window
= w
->next
)
8942 w
= XWINDOW (window
);
8943 mark_window_display_accurate_1 (w
, accurate_p
);
8945 if (!NILP (w
->vchild
))
8946 mark_window_display_accurate (w
->vchild
, accurate_p
);
8947 if (!NILP (w
->hchild
))
8948 mark_window_display_accurate (w
->hchild
, accurate_p
);
8953 last_arrow_position
= COERCE_MARKER (Voverlay_arrow_position
);
8954 last_arrow_string
= Voverlay_arrow_string
;
8958 /* Force a thorough redisplay the next time by setting
8959 last_arrow_position and last_arrow_string to t, which is
8960 unequal to any useful value of Voverlay_arrow_... */
8961 last_arrow_position
= Qt
;
8962 last_arrow_string
= Qt
;
8967 /* Return value in display table DP (Lisp_Char_Table *) for character
8968 C. Since a display table doesn't have any parent, we don't have to
8969 follow parent. Do not call this function directly but use the
8970 macro DISP_CHAR_VECTOR. */
8973 disp_char_vector (dp
, c
)
8974 struct Lisp_Char_Table
*dp
;
8980 if (SINGLE_BYTE_CHAR_P (c
))
8981 return (dp
->contents
[c
]);
8983 SPLIT_CHAR (c
, code
[0], code
[1], code
[2]);
8986 else if (code
[2] < 32)
8989 /* Here, the possible range of code[0] (== charset ID) is
8990 128..max_charset. Since the top level char table contains data
8991 for multibyte characters after 256th element, we must increment
8992 code[0] by 128 to get a correct index. */
8994 code
[3] = -1; /* anchor */
8996 for (i
= 0; code
[i
] >= 0; i
++, dp
= XCHAR_TABLE (val
))
8998 val
= dp
->contents
[code
[i
]];
8999 if (!SUB_CHAR_TABLE_P (val
))
9000 return (NILP (val
) ? dp
->defalt
: val
);
9003 /* Here, val is a sub char table. We return the default value of
9005 return (dp
->defalt
);
9010 /***********************************************************************
9012 ***********************************************************************/
9014 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
9017 redisplay_windows (window
)
9020 while (!NILP (window
))
9022 struct window
*w
= XWINDOW (window
);
9024 if (!NILP (w
->hchild
))
9025 redisplay_windows (w
->hchild
);
9026 else if (!NILP (w
->vchild
))
9027 redisplay_windows (w
->vchild
);
9029 redisplay_window (window
, 0);
9036 /* Set cursor position of W. PT is assumed to be displayed in ROW.
9037 DELTA is the number of bytes by which positions recorded in ROW
9038 differ from current buffer positions. */
9041 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
9043 struct glyph_row
*row
;
9044 struct glyph_matrix
*matrix
;
9045 int delta
, delta_bytes
, dy
, dvpos
;
9047 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
9048 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
9050 int pt_old
= PT
- delta
;
9052 /* Skip over glyphs not having an object at the start of the row.
9053 These are special glyphs like truncation marks on terminal
9055 if (row
->displays_text_p
)
9057 && INTEGERP (glyph
->object
)
9058 && glyph
->charpos
< 0)
9060 x
+= glyph
->pixel_width
;
9065 && !INTEGERP (glyph
->object
)
9066 && (!BUFFERP (glyph
->object
)
9067 || glyph
->charpos
< pt_old
))
9069 x
+= glyph
->pixel_width
;
9073 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
9075 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
9076 w
->cursor
.y
= row
->y
+ dy
;
9078 if (w
== XWINDOW (selected_window
))
9080 if (!row
->continued_p
9081 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
9084 this_line_buffer
= XBUFFER (w
->buffer
);
9086 CHARPOS (this_line_start_pos
)
9087 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
9088 BYTEPOS (this_line_start_pos
)
9089 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
9091 CHARPOS (this_line_end_pos
)
9092 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
9093 BYTEPOS (this_line_end_pos
)
9094 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
9096 this_line_y
= w
->cursor
.y
;
9097 this_line_pixel_height
= row
->height
;
9098 this_line_vpos
= w
->cursor
.vpos
;
9099 this_line_start_x
= row
->x
;
9102 CHARPOS (this_line_start_pos
) = 0;
9107 /* Run window scroll functions, if any, for WINDOW with new window
9108 start STARTP. Sets the window start of WINDOW to that position.
9110 We assume that the window's buffer is really current. */
9112 static INLINE
struct text_pos
9113 run_window_scroll_functions (window
, startp
)
9115 struct text_pos startp
;
9117 struct window
*w
= XWINDOW (window
);
9118 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
9120 if (current_buffer
!= XBUFFER (w
->buffer
))
9123 if (!NILP (Vwindow_scroll_functions
))
9125 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
9126 make_number (CHARPOS (startp
)));
9127 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
9128 /* In case the hook functions switch buffers. */
9129 if (current_buffer
!= XBUFFER (w
->buffer
))
9130 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9137 /* Modify the desired matrix of window W and W->vscroll so that the
9138 line containing the cursor is fully visible. */
9141 make_cursor_line_fully_visible (w
)
9144 struct glyph_matrix
*matrix
;
9145 struct glyph_row
*row
;
9148 /* It's not always possible to find the cursor, e.g, when a window
9149 is full of overlay strings. Don't do anything in that case. */
9150 if (w
->cursor
.vpos
< 0)
9153 matrix
= w
->desired_matrix
;
9154 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
9156 /* If the cursor row is not partially visible, there's nothing
9158 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (row
))
9161 /* If the row the cursor is in is taller than the window's height,
9162 it's not clear what to do, so do nothing. */
9163 window_height
= window_box_height (w
);
9164 if (row
->height
>= window_height
)
9167 if (MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (w
, row
))
9169 int dy
= row
->height
- row
->visible_height
;
9172 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
9174 else /* MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P (w, row)) */
9176 int dy
= - (row
->height
- row
->visible_height
);
9179 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
9182 /* When we change the cursor y-position of the selected window,
9183 change this_line_y as well so that the display optimization for
9184 the cursor line of the selected window in redisplay_internal uses
9185 the correct y-position. */
9186 if (w
== XWINDOW (selected_window
))
9187 this_line_y
= w
->cursor
.y
;
9191 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
9192 non-zero means only WINDOW is redisplayed in redisplay_internal.
9193 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
9194 in redisplay_window to bring a partially visible line into view in
9195 the case that only the cursor has moved.
9199 1 if scrolling succeeded
9201 0 if scrolling didn't find point.
9203 -1 if new fonts have been loaded so that we must interrupt
9204 redisplay, adjust glyph matrices, and try again. */
9207 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
9208 scroll_step
, temp_scroll_step
)
9210 int just_this_one_p
;
9211 int scroll_conservatively
, scroll_step
;
9212 int temp_scroll_step
;
9214 struct window
*w
= XWINDOW (window
);
9215 struct frame
*f
= XFRAME (w
->frame
);
9216 struct text_pos scroll_margin_pos
;
9217 struct text_pos pos
;
9218 struct text_pos startp
;
9220 Lisp_Object window_end
;
9221 int this_scroll_margin
;
9225 int amount_to_scroll
= 0;
9226 Lisp_Object aggressive
;
9230 debug_method_add (w
, "try_scrolling");
9233 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
9235 /* Compute scroll margin height in pixels. We scroll when point is
9236 within this distance from the top or bottom of the window. */
9237 if (scroll_margin
> 0)
9239 this_scroll_margin
= min (scroll_margin
, XINT (w
->height
) / 4);
9240 this_scroll_margin
*= CANON_Y_UNIT (f
);
9243 this_scroll_margin
= 0;
9245 /* Compute how much we should try to scroll maximally to bring point
9247 if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
9248 scroll_max
= max (scroll_step
,
9249 max (scroll_conservatively
, temp_scroll_step
));
9250 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
9251 || NUMBERP (current_buffer
->scroll_up_aggressively
))
9252 /* We're trying to scroll because of aggressive scrolling
9253 but no scroll_step is set. Choose an arbitrary one. Maybe
9254 there should be a variable for this. */
9258 scroll_max
*= CANON_Y_UNIT (f
);
9260 /* Decide whether we have to scroll down. Start at the window end
9261 and move this_scroll_margin up to find the position of the scroll
9263 window_end
= Fwindow_end (window
, Qt
);
9264 CHARPOS (scroll_margin_pos
) = XINT (window_end
);
9265 BYTEPOS (scroll_margin_pos
) = CHAR_TO_BYTE (CHARPOS (scroll_margin_pos
));
9266 if (this_scroll_margin
)
9268 start_display (&it
, w
, scroll_margin_pos
);
9269 move_it_vertically (&it
, - this_scroll_margin
);
9270 scroll_margin_pos
= it
.current
.pos
;
9273 if (PT
>= CHARPOS (scroll_margin_pos
))
9277 /* Point is in the scroll margin at the bottom of the window, or
9278 below. Compute a new window start that makes point visible. */
9280 /* Compute the distance from the scroll margin to PT.
9281 Give up if the distance is greater than scroll_max. */
9282 start_display (&it
, w
, scroll_margin_pos
);
9284 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
9285 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9287 /* With a scroll_margin of 0, scroll_margin_pos is at the window
9288 end, which is one line below the window. The iterator's
9289 current_y will be same as y0 in that case, but we have to
9290 scroll a line to make PT visible. That's the reason why 1 is
9292 dy
= 1 + it
.current_y
- y0
;
9294 if (dy
> scroll_max
)
9297 /* Move the window start down. If scrolling conservatively,
9298 move it just enough down to make point visible. If
9299 scroll_step is set, move it down by scroll_step. */
9300 start_display (&it
, w
, startp
);
9302 if (scroll_conservatively
)
9304 = max (max (dy
, CANON_Y_UNIT (f
)),
9305 CANON_Y_UNIT (f
) * max (scroll_step
, temp_scroll_step
));
9306 else if (scroll_step
|| temp_scroll_step
)
9307 amount_to_scroll
= scroll_max
;
9310 aggressive
= current_buffer
->scroll_down_aggressively
;
9311 height
= (WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE (w
)
9312 - WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
));
9313 if (NUMBERP (aggressive
))
9314 amount_to_scroll
= XFLOATINT (aggressive
) * height
;
9317 if (amount_to_scroll
<= 0)
9320 move_it_vertically (&it
, amount_to_scroll
);
9321 startp
= it
.current
.pos
;
9325 /* See if point is inside the scroll margin at the top of the
9327 scroll_margin_pos
= startp
;
9328 if (this_scroll_margin
)
9330 start_display (&it
, w
, startp
);
9331 move_it_vertically (&it
, this_scroll_margin
);
9332 scroll_margin_pos
= it
.current
.pos
;
9335 if (PT
< CHARPOS (scroll_margin_pos
))
9337 /* Point is in the scroll margin at the top of the window or
9338 above what is displayed in the window. */
9341 /* Compute the vertical distance from PT to the scroll
9342 margin position. Give up if distance is greater than
9344 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
9345 start_display (&it
, w
, pos
);
9347 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
9348 it
.last_visible_y
, -1,
9349 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9350 dy
= it
.current_y
- y0
;
9351 if (dy
> scroll_max
)
9354 /* Compute new window start. */
9355 start_display (&it
, w
, startp
);
9357 if (scroll_conservatively
)
9359 max (dy
, CANON_Y_UNIT (f
) * max (scroll_step
, temp_scroll_step
));
9360 else if (scroll_step
|| temp_scroll_step
)
9361 amount_to_scroll
= scroll_max
;
9364 aggressive
= current_buffer
->scroll_up_aggressively
;
9365 height
= (WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE (w
)
9366 - WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
));
9367 if (NUMBERP (aggressive
))
9368 amount_to_scroll
= XFLOATINT (aggressive
) * height
;
9371 if (amount_to_scroll
<= 0)
9374 move_it_vertically (&it
, - amount_to_scroll
);
9375 startp
= it
.current
.pos
;
9379 /* Run window scroll functions. */
9380 startp
= run_window_scroll_functions (window
, startp
);
9382 /* Display the window. Give up if new fonts are loaded, or if point
9384 if (!try_window (window
, startp
))
9386 else if (w
->cursor
.vpos
< 0)
9388 clear_glyph_matrix (w
->desired_matrix
);
9393 /* Maybe forget recorded base line for line number display. */
9394 if (!just_this_one_p
9395 || current_buffer
->clip_changed
9396 || BEG_UNCHANGED
< CHARPOS (startp
))
9397 w
->base_line_number
= Qnil
;
9399 /* If cursor ends up on a partially visible line, shift display
9400 lines up or down. */
9401 make_cursor_line_fully_visible (w
);
9409 /* Compute a suitable window start for window W if display of W starts
9410 on a continuation line. Value is non-zero if a new window start
9413 The new window start will be computed, based on W's width, starting
9414 from the start of the continued line. It is the start of the
9415 screen line with the minimum distance from the old start W->start. */
9418 compute_window_start_on_continuation_line (w
)
9421 struct text_pos pos
, start_pos
;
9422 int window_start_changed_p
= 0;
9424 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
9426 /* If window start is on a continuation line... Window start may be
9427 < BEGV in case there's invisible text at the start of the
9428 buffer (M-x rmail, for example). */
9429 if (CHARPOS (start_pos
) > BEGV
9430 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
9433 struct glyph_row
*row
;
9435 /* Handle the case that the window start is out of range. */
9436 if (CHARPOS (start_pos
) < BEGV
)
9437 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
9438 else if (CHARPOS (start_pos
) > ZV
)
9439 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
9441 /* Find the start of the continued line. This should be fast
9442 because scan_buffer is fast (newline cache). */
9443 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
9444 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
9445 row
, DEFAULT_FACE_ID
);
9446 reseat_at_previous_visible_line_start (&it
);
9448 /* If the line start is "too far" away from the window start,
9449 say it takes too much time to compute a new window start. */
9450 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
9451 < XFASTINT (w
->height
) * XFASTINT (w
->width
))
9453 int min_distance
, distance
;
9455 /* Move forward by display lines to find the new window
9456 start. If window width was enlarged, the new start can
9457 be expected to be > the old start. If window width was
9458 decreased, the new window start will be < the old start.
9459 So, we're looking for the display line start with the
9460 minimum distance from the old window start. */
9461 pos
= it
.current
.pos
;
9462 min_distance
= INFINITY
;
9463 while ((distance
= abs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
9464 distance
< min_distance
)
9466 min_distance
= distance
;
9467 pos
= it
.current
.pos
;
9468 move_it_by_lines (&it
, 1, 0);
9471 /* Set the window start there. */
9472 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
9473 window_start_changed_p
= 1;
9477 return window_start_changed_p
;
9481 /* Try cursor movement in case text has not changes in window WINDOW,
9482 with window start STARTP. Value is
9486 0 if this method cannot be used
9488 -1 if we know we have to scroll the display. *SCROLL_STEP is
9489 set to 1, under certain circumstances, if we want to scroll as
9490 if scroll-step were set to 1. See the code. */
9493 try_cursor_movement (window
, startp
, scroll_step
)
9495 struct text_pos startp
;
9498 struct window
*w
= XWINDOW (window
);
9499 struct frame
*f
= XFRAME (w
->frame
);
9502 /* Handle case where text has not changed, only point, and it has
9503 not moved off the frame. */
9504 if (/* Point may be in this window. */
9505 PT
>= CHARPOS (startp
)
9506 /* Selective display hasn't changed. */
9507 && !current_buffer
->clip_changed
9508 /* Function force-mode-line-update is used to force a thorough
9509 redisplay. It sets either windows_or_buffers_changed or
9510 update_mode_lines. So don't take a shortcut here for these
9512 && !update_mode_lines
9513 && !windows_or_buffers_changed
9514 /* Can't use this case if highlighting a region. When a
9515 region exists, cursor movement has to do more than just
9517 && !(!NILP (Vtransient_mark_mode
)
9518 && !NILP (current_buffer
->mark_active
))
9519 && NILP (w
->region_showing
)
9520 && NILP (Vshow_trailing_whitespace
)
9521 /* Right after splitting windows, last_point may be nil. */
9522 && INTEGERP (w
->last_point
)
9523 /* This code is not used for mini-buffer for the sake of the case
9524 of redisplaying to replace an echo area message; since in
9525 that case the mini-buffer contents per se are usually
9526 unchanged. This code is of no real use in the mini-buffer
9527 since the handling of this_line_start_pos, etc., in redisplay
9528 handles the same cases. */
9529 && !EQ (window
, minibuf_window
)
9530 /* When splitting windows or for new windows, it happens that
9531 redisplay is called with a nil window_end_vpos or one being
9532 larger than the window. This should really be fixed in
9533 window.c. I don't have this on my list, now, so we do
9534 approximately the same as the old redisplay code. --gerd. */
9535 && INTEGERP (w
->window_end_vpos
)
9536 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
9537 && (FRAME_WINDOW_P (f
)
9538 || !MARKERP (Voverlay_arrow_position
)
9539 || current_buffer
!= XMARKER (Voverlay_arrow_position
)->buffer
))
9541 int this_scroll_margin
;
9542 struct glyph_row
*row
;
9545 debug_method_add (w
, "cursor movement");
9548 /* Scroll if point within this distance from the top or bottom
9549 of the window. This is a pixel value. */
9550 this_scroll_margin
= max (0, scroll_margin
);
9551 this_scroll_margin
= min (this_scroll_margin
, XFASTINT (w
->height
) / 4);
9552 this_scroll_margin
*= CANON_Y_UNIT (f
);
9554 /* Start with the row the cursor was displayed during the last
9555 not paused redisplay. Give up if that row is not valid. */
9556 if (w
->last_cursor
.vpos
< 0
9557 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
9561 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
9562 if (row
->mode_line_p
)
9564 if (!row
->enabled_p
)
9571 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
9573 if (PT
> XFASTINT (w
->last_point
))
9575 /* Point has moved forward. */
9576 while (MATRIX_ROW_END_CHARPOS (row
) < PT
9577 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
9579 xassert (row
->enabled_p
);
9583 /* The end position of a row equals the start position
9584 of the next row. If PT is there, we would rather
9585 display it in the next line. */
9586 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
9587 && MATRIX_ROW_END_CHARPOS (row
) == PT
9588 && !cursor_row_p (w
, row
))
9591 /* If within the scroll margin, scroll. Note that
9592 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
9593 the next line would be drawn, and that
9594 this_scroll_margin can be zero. */
9595 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
9596 || PT
> MATRIX_ROW_END_CHARPOS (row
)
9597 /* Line is completely visible last line in window
9598 and PT is to be set in the next line. */
9599 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
9600 && PT
== MATRIX_ROW_END_CHARPOS (row
)
9601 && !row
->ends_at_zv_p
9602 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
9605 else if (PT
< XFASTINT (w
->last_point
))
9607 /* Cursor has to be moved backward. Note that PT >=
9608 CHARPOS (startp) because of the outer
9610 while (!row
->mode_line_p
9611 && (MATRIX_ROW_START_CHARPOS (row
) > PT
9612 || (MATRIX_ROW_START_CHARPOS (row
) == PT
9613 && MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)))
9614 && (row
->y
> this_scroll_margin
9615 || CHARPOS (startp
) == BEGV
))
9617 xassert (row
->enabled_p
);
9621 /* Consider the following case: Window starts at BEGV,
9622 there is invisible, intangible text at BEGV, so that
9623 display starts at some point START > BEGV. It can
9624 happen that we are called with PT somewhere between
9625 BEGV and START. Try to handle that case. */
9626 if (row
< w
->current_matrix
->rows
9627 || row
->mode_line_p
)
9629 row
= w
->current_matrix
->rows
;
9630 if (row
->mode_line_p
)
9634 /* Due to newlines in overlay strings, we may have to
9635 skip forward over overlay strings. */
9636 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
9637 && MATRIX_ROW_END_CHARPOS (row
) == PT
9638 && !cursor_row_p (w
, row
))
9641 /* If within the scroll margin, scroll. */
9642 if (row
->y
< this_scroll_margin
9643 && CHARPOS (startp
) != BEGV
)
9647 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
9648 || PT
> MATRIX_ROW_END_CHARPOS (row
))
9650 /* if PT is not in the glyph row, give up. */
9653 else if (MATRIX_ROW_PARTIALLY_VISIBLE_P (row
))
9655 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
9656 && !row
->ends_at_zv_p
9657 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
9659 else if (row
->height
> window_box_height (w
))
9661 /* If we end up in a partially visible line, let's
9662 make it fully visible, except when it's taller
9663 than the window, in which case we can't do much
9670 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
9671 try_window (window
, startp
);
9672 make_cursor_line_fully_visible (w
);
9680 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
9690 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
9691 selected_window is redisplayed. */
9694 redisplay_window (window
, just_this_one_p
)
9696 int just_this_one_p
;
9698 struct window
*w
= XWINDOW (window
);
9699 struct frame
*f
= XFRAME (w
->frame
);
9700 struct buffer
*buffer
= XBUFFER (w
->buffer
);
9701 struct buffer
*old
= current_buffer
;
9702 struct text_pos lpoint
, opoint
, startp
;
9703 int update_mode_line
;
9706 /* Record it now because it's overwritten. */
9707 int current_matrix_up_to_date_p
= 0;
9708 int temp_scroll_step
= 0;
9709 int count
= BINDING_STACK_SIZE ();
9712 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
9715 /* W must be a leaf window here. */
9716 xassert (!NILP (w
->buffer
));
9718 *w
->desired_matrix
->method
= 0;
9721 specbind (Qinhibit_point_motion_hooks
, Qt
);
9723 reconsider_clip_changes (w
, buffer
);
9725 /* Has the mode line to be updated? */
9726 update_mode_line
= (!NILP (w
->update_mode_line
)
9727 || update_mode_lines
9728 || buffer
->clip_changed
);
9730 if (MINI_WINDOW_P (w
))
9732 if (w
== XWINDOW (echo_area_window
)
9733 && !NILP (echo_area_buffer
[0]))
9735 if (update_mode_line
)
9736 /* We may have to update a tty frame's menu bar or a
9737 tool-bar. Example `M-x C-h C-h C-g'. */
9738 goto finish_menu_bars
;
9740 /* We've already displayed the echo area glyphs in this window. */
9741 goto finish_scroll_bars
;
9743 else if (w
!= XWINDOW (minibuf_window
))
9745 /* W is a mini-buffer window, but it's not the currently
9746 active one, so clear it. */
9747 int yb
= window_text_bottom_y (w
);
9748 struct glyph_row
*row
;
9751 for (y
= 0, row
= w
->desired_matrix
->rows
;
9753 y
+= row
->height
, ++row
)
9754 blank_row (w
, row
, y
);
9755 goto finish_scroll_bars
;
9758 clear_glyph_matrix (w
->desired_matrix
);
9761 /* Otherwise set up data on this window; select its buffer and point
9763 /* Really select the buffer, for the sake of buffer-local
9765 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9766 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
9768 current_matrix_up_to_date_p
9769 = (!NILP (w
->window_end_valid
)
9770 && !current_buffer
->clip_changed
9771 && XFASTINT (w
->last_modified
) >= MODIFF
9772 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
9774 /* When windows_or_buffers_changed is non-zero, we can't rely on
9775 the window end being valid, so set it to nil there. */
9776 if (windows_or_buffers_changed
)
9778 /* If window starts on a continuation line, maybe adjust the
9779 window start in case the window's width changed. */
9780 if (XMARKER (w
->start
)->buffer
== current_buffer
)
9781 compute_window_start_on_continuation_line (w
);
9783 w
->window_end_valid
= Qnil
;
9786 /* Some sanity checks. */
9787 CHECK_WINDOW_END (w
);
9788 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
9790 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
9793 /* If %c is in mode line, update it if needed. */
9794 if (!NILP (w
->column_number_displayed
)
9795 /* This alternative quickly identifies a common case
9796 where no change is needed. */
9797 && !(PT
== XFASTINT (w
->last_point
)
9798 && XFASTINT (w
->last_modified
) >= MODIFF
9799 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
9800 && XFASTINT (w
->column_number_displayed
) != current_column ())
9801 update_mode_line
= 1;
9803 /* Count number of windows showing the selected buffer. An indirect
9804 buffer counts as its base buffer. */
9805 if (!just_this_one_p
)
9807 struct buffer
*current_base
, *window_base
;
9808 current_base
= current_buffer
;
9809 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
9810 if (current_base
->base_buffer
)
9811 current_base
= current_base
->base_buffer
;
9812 if (window_base
->base_buffer
)
9813 window_base
= window_base
->base_buffer
;
9814 if (current_base
== window_base
)
9818 /* Point refers normally to the selected window. For any other
9819 window, set up appropriate value. */
9820 if (!EQ (window
, selected_window
))
9822 int new_pt
= XMARKER (w
->pointm
)->charpos
;
9823 int new_pt_byte
= marker_byte_position (w
->pointm
);
9827 new_pt_byte
= BEGV_BYTE
;
9828 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
9830 else if (new_pt
> (ZV
- 1))
9833 new_pt_byte
= ZV_BYTE
;
9834 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
9837 /* We don't use SET_PT so that the point-motion hooks don't run. */
9838 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
9841 /* If any of the character widths specified in the display table
9842 have changed, invalidate the width run cache. It's true that
9843 this may be a bit late to catch such changes, but the rest of
9844 redisplay goes (non-fatally) haywire when the display table is
9845 changed, so why should we worry about doing any better? */
9846 if (current_buffer
->width_run_cache
)
9848 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
9850 if (! disptab_matches_widthtab (disptab
,
9851 XVECTOR (current_buffer
->width_table
)))
9853 invalidate_region_cache (current_buffer
,
9854 current_buffer
->width_run_cache
,
9856 recompute_width_table (current_buffer
, disptab
);
9860 /* If window-start is screwed up, choose a new one. */
9861 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
9864 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
9866 /* If someone specified a new starting point but did not insist,
9867 check whether it can be used. */
9868 if (!NILP (w
->optional_new_start
)
9869 && CHARPOS (startp
) >= BEGV
9870 && CHARPOS (startp
) <= ZV
)
9872 w
->optional_new_start
= Qnil
;
9873 start_display (&it
, w
, startp
);
9874 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
9875 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9876 if (IT_CHARPOS (it
) == PT
)
9877 w
->force_start
= Qt
;
9880 /* Handle case where place to start displaying has been specified,
9881 unless the specified location is outside the accessible range. */
9882 if (!NILP (w
->force_start
)
9883 || w
->frozen_window_start_p
)
9885 w
->force_start
= Qnil
;
9887 w
->window_end_valid
= Qnil
;
9889 /* Forget any recorded base line for line number display. */
9890 if (!current_matrix_up_to_date_p
9891 || current_buffer
->clip_changed
)
9892 w
->base_line_number
= Qnil
;
9894 /* Redisplay the mode line. Select the buffer properly for that.
9895 Also, run the hook window-scroll-functions
9896 because we have scrolled. */
9897 /* Note, we do this after clearing force_start because
9898 if there's an error, it is better to forget about force_start
9899 than to get into an infinite loop calling the hook functions
9900 and having them get more errors. */
9901 if (!update_mode_line
9902 || ! NILP (Vwindow_scroll_functions
))
9904 update_mode_line
= 1;
9905 w
->update_mode_line
= Qt
;
9906 startp
= run_window_scroll_functions (window
, startp
);
9909 w
->last_modified
= make_number (0);
9910 w
->last_overlay_modified
= make_number (0);
9911 if (CHARPOS (startp
) < BEGV
)
9912 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
9913 else if (CHARPOS (startp
) > ZV
)
9914 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
9916 /* Redisplay, then check if cursor has been set during the
9917 redisplay. Give up if new fonts were loaded. */
9918 if (!try_window (window
, startp
))
9920 w
->force_start
= Qt
;
9921 clear_glyph_matrix (w
->desired_matrix
);
9922 goto finish_scroll_bars
;
9925 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
9927 /* If point does not appear, try to move point so it does
9928 appear. The desired matrix has been built above, so we
9931 struct glyph_row
*row
;
9933 window_height
= window_box_height (w
) / 2;
9934 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
9935 while (MATRIX_ROW_BOTTOM_Y (row
) < window_height
)
9938 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
9939 MATRIX_ROW_START_BYTEPOS (row
));
9941 if (w
!= XWINDOW (selected_window
))
9942 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
9943 else if (current_buffer
== old
)
9944 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
9946 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
9948 /* If we are highlighting the region, then we just changed
9949 the region, so redisplay to show it. */
9950 if (!NILP (Vtransient_mark_mode
)
9951 && !NILP (current_buffer
->mark_active
))
9953 clear_glyph_matrix (w
->desired_matrix
);
9954 if (!try_window (window
, startp
))
9955 goto finish_scroll_bars
;
9959 make_cursor_line_fully_visible (w
);
9961 debug_method_add (w
, "forced window start");
9966 /* Handle case where text has not changed, only point, and it has
9967 not moved off the frame. */
9968 if (current_matrix_up_to_date_p
9969 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
9977 /* If current starting point was originally the beginning of a line
9978 but no longer is, find a new starting point. */
9979 else if (!NILP (w
->start_at_line_beg
)
9980 && !(CHARPOS (startp
) <= BEGV
9981 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
9984 debug_method_add (w
, "recenter 1");
9989 /* Try scrolling with try_window_id. Value is > 0 if update has
9990 been done, it is -1 if we know that the same window start will
9991 not work. It is 0 if unsuccessful for some other reason. */
9992 else if ((tem
= try_window_id (w
)) != 0)
9995 debug_method_add (w
, "try_window_id %d", tem
);
9998 if (fonts_changed_p
)
9999 goto finish_scroll_bars
;
10003 /* Otherwise try_window_id has returned -1 which means that we
10004 don't want the alternative below this comment to execute. */
10006 else if (CHARPOS (startp
) >= BEGV
10007 && CHARPOS (startp
) <= ZV
10008 && PT
>= CHARPOS (startp
)
10009 && (CHARPOS (startp
) < ZV
10010 /* Avoid starting at end of buffer. */
10011 || CHARPOS (startp
) == BEGV
10012 || (XFASTINT (w
->last_modified
) >= MODIFF
10013 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
10016 debug_method_add (w
, "same window start");
10019 /* Try to redisplay starting at same place as before.
10020 If point has not moved off frame, accept the results. */
10021 if (!current_matrix_up_to_date_p
10022 /* Don't use try_window_reusing_current_matrix in this case
10023 because a window scroll function can have changed the
10025 || !NILP (Vwindow_scroll_functions
)
10026 || MINI_WINDOW_P (w
)
10027 || !try_window_reusing_current_matrix (w
))
10029 IF_DEBUG (debug_method_add (w
, "1"));
10030 try_window (window
, startp
);
10033 if (fonts_changed_p
)
10034 goto finish_scroll_bars
;
10036 if (w
->cursor
.vpos
>= 0)
10038 if (!just_this_one_p
10039 || current_buffer
->clip_changed
10040 || BEG_UNCHANGED
< CHARPOS (startp
))
10041 /* Forget any recorded base line for line number display. */
10042 w
->base_line_number
= Qnil
;
10044 make_cursor_line_fully_visible (w
);
10048 clear_glyph_matrix (w
->desired_matrix
);
10053 w
->last_modified
= make_number (0);
10054 w
->last_overlay_modified
= make_number (0);
10056 /* Redisplay the mode line. Select the buffer properly for that. */
10057 if (!update_mode_line
)
10059 update_mode_line
= 1;
10060 w
->update_mode_line
= Qt
;
10063 /* Try to scroll by specified few lines. */
10064 if ((scroll_conservatively
10066 || temp_scroll_step
10067 || NUMBERP (current_buffer
->scroll_up_aggressively
)
10068 || NUMBERP (current_buffer
->scroll_down_aggressively
))
10069 && !current_buffer
->clip_changed
10070 && CHARPOS (startp
) >= BEGV
10071 && CHARPOS (startp
) <= ZV
)
10073 /* The function returns -1 if new fonts were loaded, 1 if
10074 successful, 0 if not successful. */
10075 int rc
= try_scrolling (window
, just_this_one_p
,
10076 scroll_conservatively
,
10082 goto finish_scroll_bars
;
10085 /* Finally, just choose place to start which centers point */
10090 debug_method_add (w
, "recenter");
10093 /* w->vscroll = 0; */
10095 /* Forget any previously recorded base line for line number display. */
10096 if (!current_matrix_up_to_date_p
10097 || current_buffer
->clip_changed
)
10098 w
->base_line_number
= Qnil
;
10100 /* Move backward half the height of the window. */
10101 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
10102 it
.current_y
= it
.last_visible_y
;
10103 move_it_vertically_backward (&it
, window_box_height (w
) / 2);
10104 xassert (IT_CHARPOS (it
) >= BEGV
);
10106 /* The function move_it_vertically_backward may move over more
10107 than the specified y-distance. If it->w is small, e.g. a
10108 mini-buffer window, we may end up in front of the window's
10109 display area. Start displaying at the start of the line
10110 containing PT in this case. */
10111 if (it
.current_y
<= 0)
10113 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
10114 move_it_vertically (&it
, 0);
10115 xassert (IT_CHARPOS (it
) <= PT
);
10119 it
.current_x
= it
.hpos
= 0;
10121 /* Set startp here explicitly in case that helps avoid an infinite loop
10122 in case the window-scroll-functions functions get errors. */
10123 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
10125 /* Run scroll hooks. */
10126 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
10128 /* Redisplay the window. */
10129 if (!current_matrix_up_to_date_p
10130 || windows_or_buffers_changed
10131 /* Don't use try_window_reusing_current_matrix in this case
10132 because it can have changed the buffer. */
10133 || !NILP (Vwindow_scroll_functions
)
10134 || !just_this_one_p
10135 || MINI_WINDOW_P (w
)
10136 || !try_window_reusing_current_matrix (w
))
10137 try_window (window
, startp
);
10139 /* If new fonts have been loaded (due to fontsets), give up. We
10140 have to start a new redisplay since we need to re-adjust glyph
10142 if (fonts_changed_p
)
10143 goto finish_scroll_bars
;
10145 /* If cursor did not appear assume that the middle of the window is
10146 in the first line of the window. Do it again with the next line.
10147 (Imagine a window of height 100, displaying two lines of height
10148 60. Moving back 50 from it->last_visible_y will end in the first
10150 if (w
->cursor
.vpos
< 0)
10152 if (!NILP (w
->window_end_valid
)
10153 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
10155 clear_glyph_matrix (w
->desired_matrix
);
10156 move_it_by_lines (&it
, 1, 0);
10157 try_window (window
, it
.current
.pos
);
10159 else if (PT
< IT_CHARPOS (it
))
10161 clear_glyph_matrix (w
->desired_matrix
);
10162 move_it_by_lines (&it
, -1, 0);
10163 try_window (window
, it
.current
.pos
);
10167 /* Not much we can do about it. */
10171 /* Consider the following case: Window starts at BEGV, there is
10172 invisible, intangible text at BEGV, so that display starts at
10173 some point START > BEGV. It can happen that we are called with
10174 PT somewhere between BEGV and START. Try to handle that case. */
10175 if (w
->cursor
.vpos
< 0)
10177 struct glyph_row
*row
= w
->current_matrix
->rows
;
10178 if (row
->mode_line_p
)
10180 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
10183 make_cursor_line_fully_visible (w
);
10187 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
10188 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
10189 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
10192 /* Display the mode line, if we must. */
10193 if ((update_mode_line
10194 /* If window not full width, must redo its mode line
10195 if (a) the window to its side is being redone and
10196 (b) we do a frame-based redisplay. This is a consequence
10197 of how inverted lines are drawn in frame-based redisplay. */
10198 || (!just_this_one_p
10199 && !FRAME_WINDOW_P (f
)
10200 && !WINDOW_FULL_WIDTH_P (w
))
10201 /* Line number to display. */
10202 || INTEGERP (w
->base_line_pos
)
10203 /* Column number is displayed and different from the one displayed. */
10204 || (!NILP (w
->column_number_displayed
)
10205 && XFASTINT (w
->column_number_displayed
) != current_column ()))
10206 /* This means that the window has a mode line. */
10207 && (WINDOW_WANTS_MODELINE_P (w
)
10208 || WINDOW_WANTS_HEADER_LINE_P (w
)))
10210 Lisp_Object old_selected_frame
;
10212 old_selected_frame
= selected_frame
;
10214 XSETFRAME (selected_frame
, f
);
10215 display_mode_lines (w
);
10216 selected_frame
= old_selected_frame
;
10218 /* If mode line height has changed, arrange for a thorough
10219 immediate redisplay using the correct mode line height. */
10220 if (WINDOW_WANTS_MODELINE_P (w
)
10221 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
10223 fonts_changed_p
= 1;
10224 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
10225 = DESIRED_MODE_LINE_HEIGHT (w
);
10228 /* If top line height has changed, arrange for a thorough
10229 immediate redisplay using the correct mode line height. */
10230 if (WINDOW_WANTS_HEADER_LINE_P (w
)
10231 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
10233 fonts_changed_p
= 1;
10234 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
10235 = DESIRED_HEADER_LINE_HEIGHT (w
);
10238 if (fonts_changed_p
)
10239 goto finish_scroll_bars
;
10242 if (!line_number_displayed
10243 && !BUFFERP (w
->base_line_pos
))
10245 w
->base_line_pos
= Qnil
;
10246 w
->base_line_number
= Qnil
;
10251 /* When we reach a frame's selected window, redo the frame's menu bar. */
10252 if (update_mode_line
10253 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
10255 int redisplay_menu_p
= 0;
10257 if (FRAME_WINDOW_P (f
))
10259 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (macintosh)
10260 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
10262 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
10266 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
10268 if (redisplay_menu_p
)
10269 display_menu_bar (w
);
10271 #ifdef HAVE_WINDOW_SYSTEM
10272 if (WINDOWP (f
->tool_bar_window
)
10273 && (FRAME_TOOL_BAR_LINES (f
) > 0
10274 || auto_resize_tool_bars_p
))
10275 redisplay_tool_bar (f
);
10279 finish_scroll_bars
:
10281 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
))
10283 int start
, end
, whole
;
10285 /* Calculate the start and end positions for the current window.
10286 At some point, it would be nice to choose between scrollbars
10287 which reflect the whole buffer size, with special markers
10288 indicating narrowing, and scrollbars which reflect only the
10291 Note that mini-buffers sometimes aren't displaying any text. */
10292 if (!MINI_WINDOW_P (w
)
10293 || (w
== XWINDOW (minibuf_window
)
10294 && NILP (echo_area_buffer
[0])))
10297 start
= marker_position (w
->start
) - BEGV
;
10298 /* I don't think this is guaranteed to be right. For the
10299 moment, we'll pretend it is. */
10300 end
= (Z
- XFASTINT (w
->window_end_pos
)) - BEGV
;
10304 if (whole
< (end
- start
))
10305 whole
= end
- start
;
10308 start
= end
= whole
= 0;
10310 /* Indicate what this scroll bar ought to be displaying now. */
10311 set_vertical_scroll_bar_hook (w
, end
- start
, whole
, start
);
10313 /* Note that we actually used the scroll bar attached to this
10314 window, so it shouldn't be deleted at the end of redisplay. */
10315 redeem_scroll_bar_hook (w
);
10318 /* Restore current_buffer and value of point in it. */
10319 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
10320 set_buffer_internal_1 (old
);
10321 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
10323 unbind_to (count
, Qnil
);
10327 /* Build the complete desired matrix of WINDOW with a window start
10328 buffer position POS. Value is non-zero if successful. It is zero
10329 if fonts were loaded during redisplay which makes re-adjusting
10330 glyph matrices necessary. */
10333 try_window (window
, pos
)
10334 Lisp_Object window
;
10335 struct text_pos pos
;
10337 struct window
*w
= XWINDOW (window
);
10339 struct glyph_row
*last_text_row
= NULL
;
10341 /* Make POS the new window start. */
10342 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
10344 /* Mark cursor position as unknown. No overlay arrow seen. */
10345 w
->cursor
.vpos
= -1;
10346 overlay_arrow_seen
= 0;
10348 /* Initialize iterator and info to start at POS. */
10349 start_display (&it
, w
, pos
);
10351 /* Display all lines of W. */
10352 while (it
.current_y
< it
.last_visible_y
)
10354 if (display_line (&it
))
10355 last_text_row
= it
.glyph_row
- 1;
10356 if (fonts_changed_p
)
10360 /* If bottom moved off end of frame, change mode line percentage. */
10361 if (XFASTINT (w
->window_end_pos
) <= 0
10362 && Z
!= IT_CHARPOS (it
))
10363 w
->update_mode_line
= Qt
;
10365 /* Set window_end_pos to the offset of the last character displayed
10366 on the window from the end of current_buffer. Set
10367 window_end_vpos to its row number. */
10370 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
10371 w
->window_end_bytepos
10372 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
10374 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
10376 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
10377 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
10378 ->displays_text_p
);
10382 w
->window_end_bytepos
= 0;
10383 w
->window_end_pos
= w
->window_end_vpos
= make_number (0);
10386 /* But that is not valid info until redisplay finishes. */
10387 w
->window_end_valid
= Qnil
;
10393 /************************************************************************
10394 Window redisplay reusing current matrix when buffer has not changed
10395 ************************************************************************/
10397 /* Try redisplay of window W showing an unchanged buffer with a
10398 different window start than the last time it was displayed by
10399 reusing its current matrix. Value is non-zero if successful.
10400 W->start is the new window start. */
10403 try_window_reusing_current_matrix (w
)
10406 struct frame
*f
= XFRAME (w
->frame
);
10407 struct glyph_row
*row
, *bottom_row
;
10410 struct text_pos start
, new_start
;
10411 int nrows_scrolled
, i
;
10412 struct glyph_row
*last_text_row
;
10413 struct glyph_row
*last_reused_text_row
;
10414 struct glyph_row
*start_row
;
10415 int start_vpos
, min_y
, max_y
;
10417 if (/* This function doesn't handle terminal frames. */
10418 !FRAME_WINDOW_P (f
)
10419 /* Don't try to reuse the display if windows have been split
10421 || windows_or_buffers_changed
)
10424 /* Can't do this if region may have changed. */
10425 if ((!NILP (Vtransient_mark_mode
)
10426 && !NILP (current_buffer
->mark_active
))
10427 || !NILP (w
->region_showing
)
10428 || !NILP (Vshow_trailing_whitespace
))
10431 /* If top-line visibility has changed, give up. */
10432 if (WINDOW_WANTS_HEADER_LINE_P (w
)
10433 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
10436 /* Give up if old or new display is scrolled vertically. We could
10437 make this function handle this, but right now it doesn't. */
10438 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
10439 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (start_row
))
10442 /* The variable new_start now holds the new window start. The old
10443 start `start' can be determined from the current matrix. */
10444 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
10445 start
= start_row
->start
.pos
;
10446 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
10448 /* Clear the desired matrix for the display below. */
10449 clear_glyph_matrix (w
->desired_matrix
);
10451 if (CHARPOS (new_start
) <= CHARPOS (start
))
10455 /* Don't use this method if the display starts with an ellipsis
10456 displayed for invisible text. It's not easy to handle that case
10457 below, and it's certainly not worth the effort since this is
10458 not a frequent case. */
10459 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
10462 IF_DEBUG (debug_method_add (w
, "twu1"));
10464 /* Display up to a row that can be reused. The variable
10465 last_text_row is set to the last row displayed that displays
10466 text. Note that it.vpos == 0 if or if not there is a
10467 header-line; it's not the same as the MATRIX_ROW_VPOS! */
10468 start_display (&it
, w
, new_start
);
10469 first_row_y
= it
.current_y
;
10470 w
->cursor
.vpos
= -1;
10471 last_text_row
= last_reused_text_row
= NULL
;
10473 while (it
.current_y
< it
.last_visible_y
10474 && IT_CHARPOS (it
) < CHARPOS (start
)
10475 && !fonts_changed_p
)
10476 if (display_line (&it
))
10477 last_text_row
= it
.glyph_row
- 1;
10479 /* A value of current_y < last_visible_y means that we stopped
10480 at the previous window start, which in turn means that we
10481 have at least one reusable row. */
10482 if (it
.current_y
< it
.last_visible_y
)
10484 /* IT.vpos always starts from 0; it counts text lines. */
10485 nrows_scrolled
= it
.vpos
;
10487 /* Find PT if not already found in the lines displayed. */
10488 if (w
->cursor
.vpos
< 0)
10490 int dy
= it
.current_y
- first_row_y
;
10492 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
10493 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
10495 if (PT
>= MATRIX_ROW_START_CHARPOS (row
)
10496 && PT
< MATRIX_ROW_END_CHARPOS (row
))
10498 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
10499 dy
, nrows_scrolled
);
10503 if (MATRIX_ROW_BOTTOM_Y (row
) + dy
>= it
.last_visible_y
)
10509 /* Give up if point was not found. This shouldn't
10510 happen often; not more often than with try_window
10512 if (w
->cursor
.vpos
< 0)
10514 clear_glyph_matrix (w
->desired_matrix
);
10519 /* Scroll the display. Do it before the current matrix is
10520 changed. The problem here is that update has not yet
10521 run, i.e. part of the current matrix is not up to date.
10522 scroll_run_hook will clear the cursor, and use the
10523 current matrix to get the height of the row the cursor is
10525 run
.current_y
= first_row_y
;
10526 run
.desired_y
= it
.current_y
;
10527 run
.height
= it
.last_visible_y
- it
.current_y
;
10529 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
10532 rif
->update_window_begin_hook (w
);
10533 rif
->clear_mouse_face (w
);
10534 rif
->scroll_run_hook (w
, &run
);
10535 rif
->update_window_end_hook (w
, 0, 0);
10539 /* Shift current matrix down by nrows_scrolled lines. */
10540 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
10541 rotate_matrix (w
->current_matrix
,
10543 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
10546 /* Disable lines that must be updated. */
10547 for (i
= 0; i
< it
.vpos
; ++i
)
10548 (start_row
+ i
)->enabled_p
= 0;
10550 /* Re-compute Y positions. */
10551 min_y
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
);
10552 max_y
= it
.last_visible_y
;
10553 for (row
= start_row
+ nrows_scrolled
;
10557 row
->y
= it
.current_y
;
10559 if (row
->y
< min_y
)
10560 row
->visible_height
= row
->height
- (min_y
- row
->y
);
10561 else if (row
->y
+ row
->height
> max_y
)
10562 row
->visible_height
10563 = row
->height
- (row
->y
+ row
->height
- max_y
);
10565 row
->visible_height
= row
->height
;
10567 it
.current_y
+= row
->height
;
10569 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
10570 last_reused_text_row
= row
;
10571 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
10575 /* Disable lines in the current matrix which are now
10576 below the window. */
10577 for (++row
; row
< bottom_row
; ++row
)
10578 row
->enabled_p
= 0;
10581 /* Update window_end_pos etc.; last_reused_text_row is the last
10582 reused row from the current matrix containing text, if any.
10583 The value of last_text_row is the last displayed line
10584 containing text. */
10585 if (last_reused_text_row
)
10587 w
->window_end_bytepos
10588 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
10590 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
10592 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
10593 w
->current_matrix
));
10595 else if (last_text_row
)
10597 w
->window_end_bytepos
10598 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
10600 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
10602 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
10606 /* This window must be completely empty. */
10607 w
->window_end_bytepos
= 0;
10608 w
->window_end_pos
= w
->window_end_vpos
= make_number (0);
10610 w
->window_end_valid
= Qnil
;
10612 /* Update hint: don't try scrolling again in update_window. */
10613 w
->desired_matrix
->no_scrolling_p
= 1;
10616 debug_method_add (w
, "try_window_reusing_current_matrix 1");
10620 else if (CHARPOS (new_start
) > CHARPOS (start
))
10622 struct glyph_row
*pt_row
, *row
;
10623 struct glyph_row
*first_reusable_row
;
10624 struct glyph_row
*first_row_to_display
;
10626 int yb
= window_text_bottom_y (w
);
10628 /* Find the row starting at new_start, if there is one. Don't
10629 reuse a partially visible line at the end. */
10630 first_reusable_row
= start_row
;
10631 while (first_reusable_row
->enabled_p
10632 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
10633 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
10634 < CHARPOS (new_start
)))
10635 ++first_reusable_row
;
10637 /* Give up if there is no row to reuse. */
10638 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
10639 || !first_reusable_row
->enabled_p
10640 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
10641 != CHARPOS (new_start
)))
10644 /* We can reuse fully visible rows beginning with
10645 first_reusable_row to the end of the window. Set
10646 first_row_to_display to the first row that cannot be reused.
10647 Set pt_row to the row containing point, if there is any. */
10649 for (first_row_to_display
= first_reusable_row
;
10650 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
10651 ++first_row_to_display
)
10653 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
10654 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
10655 pt_row
= first_row_to_display
;
10658 /* Start displaying at the start of first_row_to_display. */
10659 xassert (first_row_to_display
->y
< yb
);
10660 init_to_row_start (&it
, w
, first_row_to_display
);
10662 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
10664 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
10666 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
10667 + WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
));
10669 /* Display lines beginning with first_row_to_display in the
10670 desired matrix. Set last_text_row to the last row displayed
10671 that displays text. */
10672 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
10673 if (pt_row
== NULL
)
10674 w
->cursor
.vpos
= -1;
10675 last_text_row
= NULL
;
10676 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
10677 if (display_line (&it
))
10678 last_text_row
= it
.glyph_row
- 1;
10680 /* Give up If point isn't in a row displayed or reused. */
10681 if (w
->cursor
.vpos
< 0)
10683 clear_glyph_matrix (w
->desired_matrix
);
10687 /* If point is in a reused row, adjust y and vpos of the cursor
10691 w
->cursor
.vpos
-= MATRIX_ROW_VPOS (first_reusable_row
,
10692 w
->current_matrix
);
10693 w
->cursor
.y
-= first_reusable_row
->y
;
10696 /* Scroll the display. */
10697 run
.current_y
= first_reusable_row
->y
;
10698 run
.desired_y
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
);
10699 run
.height
= it
.last_visible_y
- run
.current_y
;
10700 dy
= run
.current_y
- run
.desired_y
;
10704 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
10706 rif
->update_window_begin_hook (w
);
10707 rif
->clear_mouse_face (w
);
10708 rif
->scroll_run_hook (w
, &run
);
10709 rif
->update_window_end_hook (w
, 0, 0);
10713 /* Adjust Y positions of reused rows. */
10714 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
10715 min_y
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
);
10716 max_y
= it
.last_visible_y
;
10717 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
10720 if (row
->y
< min_y
)
10721 row
->visible_height
= row
->height
- (min_y
- row
->y
);
10722 else if (row
->y
+ row
->height
> max_y
)
10723 row
->visible_height
10724 = row
->height
- (row
->y
+ row
->height
- max_y
);
10726 row
->visible_height
= row
->height
;
10729 /* Scroll the current matrix. */
10730 xassert (nrows_scrolled
> 0);
10731 rotate_matrix (w
->current_matrix
,
10733 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
10736 /* Disable rows not reused. */
10737 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
10738 row
->enabled_p
= 0;
10740 /* Adjust window end. A null value of last_text_row means that
10741 the window end is in reused rows which in turn means that
10742 only its vpos can have changed. */
10745 w
->window_end_bytepos
10746 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
10748 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
10750 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
10755 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
10758 w
->window_end_valid
= Qnil
;
10759 w
->desired_matrix
->no_scrolling_p
= 1;
10762 debug_method_add (w
, "try_window_reusing_current_matrix 2");
10772 /************************************************************************
10773 Window redisplay reusing current matrix when buffer has changed
10774 ************************************************************************/
10776 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
10777 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
10779 static struct glyph_row
*
10780 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
10781 struct glyph_row
*));
10784 /* Return the last row in MATRIX displaying text. If row START is
10785 non-null, start searching with that row. IT gives the dimensions
10786 of the display. Value is null if matrix is empty; otherwise it is
10787 a pointer to the row found. */
10789 static struct glyph_row
*
10790 find_last_row_displaying_text (matrix
, it
, start
)
10791 struct glyph_matrix
*matrix
;
10793 struct glyph_row
*start
;
10795 struct glyph_row
*row
, *row_found
;
10797 /* Set row_found to the last row in IT->w's current matrix
10798 displaying text. The loop looks funny but think of partially
10801 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
10802 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
10804 xassert (row
->enabled_p
);
10806 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
10815 /* Return the last row in the current matrix of W that is not affected
10816 by changes at the start of current_buffer that occurred since W's
10817 current matrix was built. Value is null if no such row exists.
10819 BEG_UNCHANGED us the number of characters unchanged at the start of
10820 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
10821 first changed character in current_buffer. Characters at positions <
10822 BEG + BEG_UNCHANGED are at the same buffer positions as they were
10823 when the current matrix was built. */
10825 static struct glyph_row
*
10826 find_last_unchanged_at_beg_row (w
)
10829 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
10830 struct glyph_row
*row
;
10831 struct glyph_row
*row_found
= NULL
;
10832 int yb
= window_text_bottom_y (w
);
10834 /* Find the last row displaying unchanged text. */
10835 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
10836 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
10837 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
)
10839 if (/* If row ends before first_changed_pos, it is unchanged,
10840 except in some case. */
10841 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
10842 /* When row ends in ZV and we write at ZV it is not
10844 && !row
->ends_at_zv_p
10845 /* When first_changed_pos is the end of a continued line,
10846 row is not unchanged because it may be no longer
10848 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
10849 && row
->continued_p
))
10852 /* Stop if last visible row. */
10853 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
10863 /* Find the first glyph row in the current matrix of W that is not
10864 affected by changes at the end of current_buffer since the
10865 time W's current matrix was built.
10867 Return in *DELTA the number of chars by which buffer positions in
10868 unchanged text at the end of current_buffer must be adjusted.
10870 Return in *DELTA_BYTES the corresponding number of bytes.
10872 Value is null if no such row exists, i.e. all rows are affected by
10875 static struct glyph_row
*
10876 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
10878 int *delta
, *delta_bytes
;
10880 struct glyph_row
*row
;
10881 struct glyph_row
*row_found
= NULL
;
10883 *delta
= *delta_bytes
= 0;
10885 /* Display must not have been paused, otherwise the current matrix
10886 is not up to date. */
10887 if (NILP (w
->window_end_valid
))
10890 /* A value of window_end_pos >= END_UNCHANGED means that the window
10891 end is in the range of changed text. If so, there is no
10892 unchanged row at the end of W's current matrix. */
10893 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
10896 /* Set row to the last row in W's current matrix displaying text. */
10897 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
10899 /* If matrix is entirely empty, no unchanged row exists. */
10900 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
10902 /* The value of row is the last glyph row in the matrix having a
10903 meaningful buffer position in it. The end position of row
10904 corresponds to window_end_pos. This allows us to translate
10905 buffer positions in the current matrix to current buffer
10906 positions for characters not in changed text. */
10907 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
10908 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
10909 int last_unchanged_pos
, last_unchanged_pos_old
;
10910 struct glyph_row
*first_text_row
10911 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
10913 *delta
= Z
- Z_old
;
10914 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
10916 /* Set last_unchanged_pos to the buffer position of the last
10917 character in the buffer that has not been changed. Z is the
10918 index + 1 of the last character in current_buffer, i.e. by
10919 subtracting END_UNCHANGED we get the index of the last
10920 unchanged character, and we have to add BEG to get its buffer
10922 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
10923 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
10925 /* Search backward from ROW for a row displaying a line that
10926 starts at a minimum position >= last_unchanged_pos_old. */
10927 for (; row
> first_text_row
; --row
)
10929 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
10932 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
10937 if (row_found
&& !MATRIX_ROW_DISPLAYS_TEXT_P (row_found
))
10944 /* Make sure that glyph rows in the current matrix of window W
10945 reference the same glyph memory as corresponding rows in the
10946 frame's frame matrix. This function is called after scrolling W's
10947 current matrix on a terminal frame in try_window_id and
10948 try_window_reusing_current_matrix. */
10951 sync_frame_with_window_matrix_rows (w
)
10954 struct frame
*f
= XFRAME (w
->frame
);
10955 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
10957 /* Preconditions: W must be a leaf window and full-width. Its frame
10958 must have a frame matrix. */
10959 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
10960 xassert (WINDOW_FULL_WIDTH_P (w
));
10961 xassert (!FRAME_WINDOW_P (f
));
10963 /* If W is a full-width window, glyph pointers in W's current matrix
10964 have, by definition, to be the same as glyph pointers in the
10965 corresponding frame matrix. */
10966 window_row
= w
->current_matrix
->rows
;
10967 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
10968 frame_row
= f
->current_matrix
->rows
+ XFASTINT (w
->top
);
10969 while (window_row
< window_row_end
)
10973 for (area
= LEFT_MARGIN_AREA
; area
<= LAST_AREA
; ++area
)
10974 frame_row
->glyphs
[area
] = window_row
->glyphs
[area
];
10976 /* Disable frame rows whose corresponding window rows have
10977 been disabled in try_window_id. */
10978 if (!window_row
->enabled_p
)
10979 frame_row
->enabled_p
= 0;
10981 ++window_row
, ++frame_row
;
10986 /* Find the glyph row in window W containing CHARPOS. Consider all
10987 rows between START and END (not inclusive). END null means search
10988 all rows to the end of the display area of W. Value is the row
10989 containing CHARPOS or null. */
10991 static struct glyph_row
*
10992 row_containing_pos (w
, charpos
, start
, end
)
10995 struct glyph_row
*start
, *end
;
10997 struct glyph_row
*row
= start
;
11000 /* If we happen to start on a header-line, skip that. */
11001 if (row
->mode_line_p
)
11004 if ((end
&& row
>= end
) || !row
->enabled_p
)
11007 last_y
= window_text_bottom_y (w
);
11009 while ((end
== NULL
|| row
< end
)
11010 && (MATRIX_ROW_END_CHARPOS (row
) < charpos
11011 /* The end position of a row equals the start
11012 position of the next row. If CHARPOS is there, we
11013 would rather display it in the next line, except
11014 when this line ends in ZV. */
11015 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
11016 && (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)
11017 || !row
->ends_at_zv_p
)))
11018 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
11021 /* Give up if CHARPOS not found. */
11022 if ((end
&& row
>= end
)
11023 || charpos
< MATRIX_ROW_START_CHARPOS (row
)
11024 || charpos
> MATRIX_ROW_END_CHARPOS (row
))
11031 /* Try to redisplay window W by reusing its existing display. W's
11032 current matrix must be up to date when this function is called,
11033 i.e. window_end_valid must not be nil.
11037 1 if display has been updated
11038 0 if otherwise unsuccessful
11039 -1 if redisplay with same window start is known not to succeed
11041 The following steps are performed:
11043 1. Find the last row in the current matrix of W that is not
11044 affected by changes at the start of current_buffer. If no such row
11047 2. Find the first row in W's current matrix that is not affected by
11048 changes at the end of current_buffer. Maybe there is no such row.
11050 3. Display lines beginning with the row + 1 found in step 1 to the
11051 row found in step 2 or, if step 2 didn't find a row, to the end of
11054 4. If cursor is not known to appear on the window, give up.
11056 5. If display stopped at the row found in step 2, scroll the
11057 display and current matrix as needed.
11059 6. Maybe display some lines at the end of W, if we must. This can
11060 happen under various circumstances, like a partially visible line
11061 becoming fully visible, or because newly displayed lines are displayed
11062 in smaller font sizes.
11064 7. Update W's window end information. */
11070 struct frame
*f
= XFRAME (w
->frame
);
11071 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
11072 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
11073 struct glyph_row
*last_unchanged_at_beg_row
;
11074 struct glyph_row
*first_unchanged_at_end_row
;
11075 struct glyph_row
*row
;
11076 struct glyph_row
*bottom_row
;
11079 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
11080 struct text_pos start_pos
;
11082 int first_unchanged_at_end_vpos
= 0;
11083 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
11084 struct text_pos start
;
11085 int first_changed_charpos
, last_changed_charpos
;
11087 /* This is handy for debugging. */
11089 #define GIVE_UP(X) \
11091 fprintf (stderr, "try_window_id give up %d\n", (X)); \
11095 #define GIVE_UP(X) return 0
11098 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
11100 /* Don't use this for mini-windows because these can show
11101 messages and mini-buffers, and we don't handle that here. */
11102 if (MINI_WINDOW_P (w
))
11105 /* This flag is used to prevent redisplay optimizations. */
11106 if (windows_or_buffers_changed
)
11109 /* Narrowing has not changed. This flag is also set to prevent
11110 redisplay optimizations. It would be nice to further
11111 reduce the number of cases where this prevents try_window_id. */
11112 if (current_buffer
->clip_changed
)
11115 /* Window must either use window-based redisplay or be full width. */
11116 if (!FRAME_WINDOW_P (f
)
11117 && (!line_ins_del_ok
11118 || !WINDOW_FULL_WIDTH_P (w
)))
11121 /* Point is not known NOT to appear in W. */
11122 if (PT
< CHARPOS (start
))
11125 /* Another way to prevent redisplay optimizations. */
11126 if (XFASTINT (w
->last_modified
) == 0)
11129 /* Window is not hscrolled. */
11130 if (XFASTINT (w
->hscroll
) != 0)
11133 /* Display wasn't paused. */
11134 if (NILP (w
->window_end_valid
))
11137 /* Can't use this if highlighting a region because a cursor movement
11138 will do more than just set the cursor. */
11139 if (!NILP (Vtransient_mark_mode
)
11140 && !NILP (current_buffer
->mark_active
))
11143 /* Likewise if highlighting trailing whitespace. */
11144 if (!NILP (Vshow_trailing_whitespace
))
11147 /* Likewise if showing a region. */
11148 if (!NILP (w
->region_showing
))
11151 /* Can use this if overlay arrow position and or string have changed. */
11152 if (!EQ (last_arrow_position
, COERCE_MARKER (Voverlay_arrow_position
))
11153 || !EQ (last_arrow_string
, Voverlay_arrow_string
))
11157 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
11158 only if buffer has really changed. The reason is that the gap is
11159 initially at Z for freshly visited files. The code below would
11160 set end_unchanged to 0 in that case. */
11161 if (MODIFF
> SAVE_MODIFF
11162 /* This seems to happen sometimes after saving a buffer. */
11163 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
11165 if (GPT
- BEG
< BEG_UNCHANGED
)
11166 BEG_UNCHANGED
= GPT
- BEG
;
11167 if (Z
- GPT
< END_UNCHANGED
)
11168 END_UNCHANGED
= Z
- GPT
;
11171 /* The position of the first and last character that has been changed. */
11172 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
11173 last_changed_charpos
= Z
- END_UNCHANGED
;
11175 /* If window starts after a line end, and the last change is in
11176 front of that newline, then changes don't affect the display.
11177 This case happens with stealth-fontification. Note that although
11178 the display is unchanged, glyph positions in the matrix have to
11179 be adjusted, of course. */
11180 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
11181 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
11182 && ((last_changed_charpos
< CHARPOS (start
)
11183 && CHARPOS (start
) == BEGV
)
11184 || (last_changed_charpos
< CHARPOS (start
) - 1
11185 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
11187 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
11188 struct glyph_row
*r0
;
11190 /* Compute how many chars/bytes have been added to or removed
11191 from the buffer. */
11192 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
11193 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
11195 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
11197 /* Give up if PT is not in the window. Note that it already has
11198 been checked at the start of try_window_id that PT is not in
11199 front of the window start. */
11200 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
11203 /* If window start is unchanged, we can reuse the whole matrix
11204 as is, after adjusting glyph positions. No need to compute
11205 the window end again, since its offset from Z hasn't changed. */
11206 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
11207 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
11208 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
)
11210 /* Adjust positions in the glyph matrix. */
11211 if (delta
|| delta_bytes
)
11213 struct glyph_row
*r1
11214 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
11215 increment_matrix_positions (w
->current_matrix
,
11216 MATRIX_ROW_VPOS (r0
, current_matrix
),
11217 MATRIX_ROW_VPOS (r1
, current_matrix
),
11218 delta
, delta_bytes
);
11221 /* Set the cursor. */
11222 row
= row_containing_pos (w
, PT
, r0
, NULL
);
11223 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
11228 /* Handle the case that changes are all below what is displayed in
11229 the window, and that PT is in the window. */
11230 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
))
11232 struct glyph_row
*r0
;
11234 /* Give up if PT is not in the window. Note that it already has
11235 been checked at the start of try_window_id that PT is not in
11236 front of the window start. */
11237 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
11240 /* If window start is unchanged, we can reuse the whole matrix
11241 as is, without changing glyph positions since no text has
11242 been added/removed in front of the window end. */
11243 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
11244 if (TEXT_POS_EQUAL_P (start
, r0
->start
.pos
))
11246 /* We have to compute the window end anew since text
11247 can have been added/removed after it. */
11249 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
11250 w
->window_end_bytepos
11251 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
11253 /* Set the cursor. */
11254 row
= row_containing_pos (w
, PT
, r0
, NULL
);
11255 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
11260 /* Check that window start agrees with the start of the first glyph
11261 row in its current matrix. Check this after we know the window
11262 start is not in changed text, otherwise positions would not be
11264 if (BEG_UNCHANGED
+ END_UNCHANGED
!= Z
- BEG
11265 && CHARPOS (start
) >= first_changed_charpos
11266 && CHARPOS (start
) <= last_changed_charpos
)
11269 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
11270 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
11273 /* Compute the position at which we have to start displaying new
11274 lines. Some of the lines at the top of the window might be
11275 reusable because they are not displaying changed text. Find the
11276 last row in W's current matrix not affected by changes at the
11277 start of current_buffer. Value is null if changes start in the
11278 first line of window. */
11279 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
11280 if (last_unchanged_at_beg_row
)
11282 /* Avoid starting to display in the moddle of a character, a TAB
11283 for instance. This is easier than to set up the iterator
11284 exactly, and it's not a frequent case, so the additional
11285 effort wouldn't really pay off. */
11286 while (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
11287 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
11288 --last_unchanged_at_beg_row
;
11290 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
11293 init_to_row_end (&it
, w
, last_unchanged_at_beg_row
);
11294 start_pos
= it
.current
.pos
;
11296 /* Start displaying new lines in the desired matrix at the same
11297 vpos we would use in the current matrix, i.e. below
11298 last_unchanged_at_beg_row. */
11299 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
11301 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
11302 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
11304 xassert (it
.hpos
== 0 && it
.current_x
== 0);
11308 /* There are no reusable lines at the start of the window.
11309 Start displaying in the first line. */
11310 start_display (&it
, w
, start
);
11311 start_pos
= it
.current
.pos
;
11314 /* Find the first row that is not affected by changes at the end of
11315 the buffer. Value will be null if there is no unchanged row, in
11316 which case we must redisplay to the end of the window. delta
11317 will be set to the value by which buffer positions beginning with
11318 first_unchanged_at_end_row have to be adjusted due to text
11320 first_unchanged_at_end_row
11321 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
11322 IF_DEBUG (debug_delta
= delta
);
11323 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
11325 /* Set stop_pos to the buffer position up to which we will have to
11326 display new lines. If first_unchanged_at_end_row != NULL, this
11327 is the buffer position of the start of the line displayed in that
11328 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
11329 that we don't stop at a buffer position. */
11331 if (first_unchanged_at_end_row
)
11333 xassert (last_unchanged_at_beg_row
== NULL
11334 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
11336 /* If this is a continuation line, move forward to the next one
11337 that isn't. Changes in lines above affect this line.
11338 Caution: this may move first_unchanged_at_end_row to a row
11339 not displaying text. */
11340 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
11341 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
11342 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
11343 < it
.last_visible_y
))
11344 ++first_unchanged_at_end_row
;
11346 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
11347 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
11348 >= it
.last_visible_y
))
11349 first_unchanged_at_end_row
= NULL
;
11352 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
11354 first_unchanged_at_end_vpos
11355 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
11356 xassert (stop_pos
>= Z
- END_UNCHANGED
);
11359 else if (last_unchanged_at_beg_row
== NULL
)
11365 /* Either there is no unchanged row at the end, or the one we have
11366 now displays text. This is a necessary condition for the window
11367 end pos calculation at the end of this function. */
11368 xassert (first_unchanged_at_end_row
== NULL
11369 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
11371 debug_last_unchanged_at_beg_vpos
11372 = (last_unchanged_at_beg_row
11373 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
11375 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
11377 #endif /* GLYPH_DEBUG != 0 */
11380 /* Display new lines. Set last_text_row to the last new line
11381 displayed which has text on it, i.e. might end up as being the
11382 line where the window_end_vpos is. */
11383 w
->cursor
.vpos
= -1;
11384 last_text_row
= NULL
;
11385 overlay_arrow_seen
= 0;
11386 while (it
.current_y
< it
.last_visible_y
11387 && !fonts_changed_p
11388 && (first_unchanged_at_end_row
== NULL
11389 || IT_CHARPOS (it
) < stop_pos
))
11391 if (display_line (&it
))
11392 last_text_row
= it
.glyph_row
- 1;
11395 if (fonts_changed_p
)
11399 /* Compute differences in buffer positions, y-positions etc. for
11400 lines reused at the bottom of the window. Compute what we can
11402 if (first_unchanged_at_end_row
11403 /* No lines reused because we displayed everything up to the
11404 bottom of the window. */
11405 && it
.current_y
< it
.last_visible_y
)
11408 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
11410 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
11411 run
.current_y
= first_unchanged_at_end_row
->y
;
11412 run
.desired_y
= run
.current_y
+ dy
;
11413 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
11417 delta
= dvpos
= dy
= run
.current_y
= run
.desired_y
= run
.height
= 0;
11418 first_unchanged_at_end_row
= NULL
;
11420 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
11423 /* Find the cursor if not already found. We have to decide whether
11424 PT will appear on this window (it sometimes doesn't, but this is
11425 not a very frequent case.) This decision has to be made before
11426 the current matrix is altered. A value of cursor.vpos < 0 means
11427 that PT is either in one of the lines beginning at
11428 first_unchanged_at_end_row or below the window. Don't care for
11429 lines that might be displayed later at the window end; as
11430 mentioned, this is not a frequent case. */
11431 if (w
->cursor
.vpos
< 0)
11433 /* Cursor in unchanged rows at the top? */
11434 if (PT
< CHARPOS (start_pos
)
11435 && last_unchanged_at_beg_row
)
11437 row
= row_containing_pos (w
, PT
,
11438 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
11439 last_unchanged_at_beg_row
+ 1);
11441 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11444 /* Start from first_unchanged_at_end_row looking for PT. */
11445 else if (first_unchanged_at_end_row
)
11447 row
= row_containing_pos (w
, PT
- delta
,
11448 first_unchanged_at_end_row
, NULL
);
11450 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
11451 delta_bytes
, dy
, dvpos
);
11454 /* Give up if cursor was not found. */
11455 if (w
->cursor
.vpos
< 0)
11457 clear_glyph_matrix (w
->desired_matrix
);
11462 /* Don't let the cursor end in the scroll margins. */
11464 int this_scroll_margin
, cursor_height
;
11466 this_scroll_margin
= max (0, scroll_margin
);
11467 this_scroll_margin
= min (this_scroll_margin
,
11468 XFASTINT (w
->height
) / 4);
11469 this_scroll_margin
*= CANON_Y_UNIT (it
.f
);
11470 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
11472 if ((w
->cursor
.y
< this_scroll_margin
11473 && CHARPOS (start
) > BEGV
)
11474 /* Don't take scroll margin into account at the bottom because
11475 old redisplay didn't do it either. */
11476 || w
->cursor
.y
+ cursor_height
> it
.last_visible_y
)
11478 w
->cursor
.vpos
= -1;
11479 clear_glyph_matrix (w
->desired_matrix
);
11484 /* Scroll the display. Do it before changing the current matrix so
11485 that xterm.c doesn't get confused about where the cursor glyph is
11487 if (dy
&& run
.height
)
11491 if (FRAME_WINDOW_P (f
))
11493 rif
->update_window_begin_hook (w
);
11494 rif
->clear_mouse_face (w
);
11495 rif
->scroll_run_hook (w
, &run
);
11496 rif
->update_window_end_hook (w
, 0, 0);
11500 /* Terminal frame. In this case, dvpos gives the number of
11501 lines to scroll by; dvpos < 0 means scroll up. */
11502 int first_unchanged_at_end_vpos
11503 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
11504 int from
= XFASTINT (w
->top
) + first_unchanged_at_end_vpos
;
11505 int end
= (XFASTINT (w
->top
)
11506 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
11507 + window_internal_height (w
));
11509 /* Perform the operation on the screen. */
11512 /* Scroll last_unchanged_at_beg_row to the end of the
11513 window down dvpos lines. */
11514 set_terminal_window (end
);
11516 /* On dumb terminals delete dvpos lines at the end
11517 before inserting dvpos empty lines. */
11518 if (!scroll_region_ok
)
11519 ins_del_lines (end
- dvpos
, -dvpos
);
11521 /* Insert dvpos empty lines in front of
11522 last_unchanged_at_beg_row. */
11523 ins_del_lines (from
, dvpos
);
11525 else if (dvpos
< 0)
11527 /* Scroll up last_unchanged_at_beg_vpos to the end of
11528 the window to last_unchanged_at_beg_vpos - |dvpos|. */
11529 set_terminal_window (end
);
11531 /* Delete dvpos lines in front of
11532 last_unchanged_at_beg_vpos. ins_del_lines will set
11533 the cursor to the given vpos and emit |dvpos| delete
11535 ins_del_lines (from
+ dvpos
, dvpos
);
11537 /* On a dumb terminal insert dvpos empty lines at the
11539 if (!scroll_region_ok
)
11540 ins_del_lines (end
+ dvpos
, -dvpos
);
11543 set_terminal_window (0);
11549 /* Shift reused rows of the current matrix to the right position.
11550 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
11552 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
11553 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
11556 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
11557 bottom_vpos
, dvpos
);
11558 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
11561 else if (dvpos
> 0)
11563 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
11564 bottom_vpos
, dvpos
);
11565 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
11566 first_unchanged_at_end_vpos
+ dvpos
, 0);
11569 /* For frame-based redisplay, make sure that current frame and window
11570 matrix are in sync with respect to glyph memory. */
11571 if (!FRAME_WINDOW_P (f
))
11572 sync_frame_with_window_matrix_rows (w
);
11574 /* Adjust buffer positions in reused rows. */
11576 increment_matrix_positions (current_matrix
,
11577 first_unchanged_at_end_vpos
+ dvpos
,
11578 bottom_vpos
, delta
, delta_bytes
);
11580 /* Adjust Y positions. */
11582 shift_glyph_matrix (w
, current_matrix
,
11583 first_unchanged_at_end_vpos
+ dvpos
,
11586 if (first_unchanged_at_end_row
)
11587 first_unchanged_at_end_row
+= dvpos
;
11589 /* If scrolling up, there may be some lines to display at the end of
11591 last_text_row_at_end
= NULL
;
11594 /* Set last_row to the glyph row in the current matrix where the
11595 window end line is found. It has been moved up or down in
11596 the matrix by dvpos. */
11597 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
11598 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
11600 /* If last_row is the window end line, it should display text. */
11601 xassert (last_row
->displays_text_p
);
11603 /* If window end line was partially visible before, begin
11604 displaying at that line. Otherwise begin displaying with the
11605 line following it. */
11606 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
11608 init_to_row_start (&it
, w
, last_row
);
11609 it
.vpos
= last_vpos
;
11610 it
.current_y
= last_row
->y
;
11614 init_to_row_end (&it
, w
, last_row
);
11615 it
.vpos
= 1 + last_vpos
;
11616 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
11620 /* We may start in a continuation line. If so, we have to get
11621 the right continuation_lines_width and current_x. */
11622 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
11623 it
.hpos
= it
.current_x
= 0;
11625 /* Display the rest of the lines at the window end. */
11626 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
11627 while (it
.current_y
< it
.last_visible_y
11628 && !fonts_changed_p
)
11630 /* Is it always sure that the display agrees with lines in
11631 the current matrix? I don't think so, so we mark rows
11632 displayed invalid in the current matrix by setting their
11633 enabled_p flag to zero. */
11634 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
11635 if (display_line (&it
))
11636 last_text_row_at_end
= it
.glyph_row
- 1;
11640 /* Update window_end_pos and window_end_vpos. */
11641 if (first_unchanged_at_end_row
11642 && first_unchanged_at_end_row
->y
< it
.last_visible_y
11643 && !last_text_row_at_end
)
11645 /* Window end line if one of the preserved rows from the current
11646 matrix. Set row to the last row displaying text in current
11647 matrix starting at first_unchanged_at_end_row, after
11649 xassert (first_unchanged_at_end_row
->displays_text_p
);
11650 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
11651 first_unchanged_at_end_row
);
11652 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
11654 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
11655 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
11657 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
11658 xassert (w
->window_end_bytepos
>= 0);
11659 IF_DEBUG (debug_method_add (w
, "A"));
11661 else if (last_text_row_at_end
)
11664 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
11665 w
->window_end_bytepos
11666 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
11668 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
11669 xassert (w
->window_end_bytepos
>= 0);
11670 IF_DEBUG (debug_method_add (w
, "B"));
11672 else if (last_text_row
)
11674 /* We have displayed either to the end of the window or at the
11675 end of the window, i.e. the last row with text is to be found
11676 in the desired matrix. */
11678 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
11679 w
->window_end_bytepos
11680 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
11682 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
11683 xassert (w
->window_end_bytepos
>= 0);
11685 else if (first_unchanged_at_end_row
== NULL
11686 && last_text_row
== NULL
11687 && last_text_row_at_end
== NULL
)
11689 /* Displayed to end of window, but no line containing text was
11690 displayed. Lines were deleted at the end of the window. */
11691 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
11692 int vpos
= XFASTINT (w
->window_end_vpos
);
11693 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
11694 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
11697 row
== NULL
&& vpos
>= first_vpos
;
11698 --vpos
, --current_row
, --desired_row
)
11700 if (desired_row
->enabled_p
)
11702 if (desired_row
->displays_text_p
)
11705 else if (current_row
->displays_text_p
)
11709 xassert (row
!= NULL
);
11710 w
->window_end_vpos
= make_number (vpos
+ 1);
11711 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
11712 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
11713 xassert (w
->window_end_bytepos
>= 0);
11714 IF_DEBUG (debug_method_add (w
, "C"));
11719 #if 0 /* This leads to problems, for instance when the cursor is
11720 at ZV, and the cursor line displays no text. */
11721 /* Disable rows below what's displayed in the window. This makes
11722 debugging easier. */
11723 enable_glyph_matrix_rows (current_matrix
,
11724 XFASTINT (w
->window_end_vpos
) + 1,
11728 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
11729 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
11731 /* Record that display has not been completed. */
11732 w
->window_end_valid
= Qnil
;
11733 w
->desired_matrix
->no_scrolling_p
= 1;
11741 /***********************************************************************
11742 More debugging support
11743 ***********************************************************************/
11747 void dump_glyph_row
P_ ((struct glyph_matrix
*, int, int));
11748 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
11749 void dump_glyph
P_ ((struct glyph_row
*, struct glyph
*, int));
11752 /* Dump the contents of glyph matrix MATRIX on stderr.
11754 GLYPHS 0 means don't show glyph contents.
11755 GLYPHS 1 means show glyphs in short form
11756 GLYPHS > 1 means show glyphs in long form. */
11759 dump_glyph_matrix (matrix
, glyphs
)
11760 struct glyph_matrix
*matrix
;
11764 for (i
= 0; i
< matrix
->nrows
; ++i
)
11765 dump_glyph_row (matrix
, i
, glyphs
);
11769 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
11770 the glyph row and area where the glyph comes from. */
11773 dump_glyph (row
, glyph
, area
)
11774 struct glyph_row
*row
;
11775 struct glyph
*glyph
;
11778 if (glyph
->type
== CHAR_GLYPH
)
11781 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
11782 glyph
- row
->glyphs
[TEXT_AREA
],
11785 (BUFFERP (glyph
->object
)
11787 : (STRINGP (glyph
->object
)
11790 glyph
->pixel_width
,
11792 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
11796 glyph
->left_box_line_p
,
11797 glyph
->right_box_line_p
);
11799 else if (glyph
->type
== STRETCH_GLYPH
)
11802 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
11803 glyph
- row
->glyphs
[TEXT_AREA
],
11806 (BUFFERP (glyph
->object
)
11808 : (STRINGP (glyph
->object
)
11811 glyph
->pixel_width
,
11815 glyph
->left_box_line_p
,
11816 glyph
->right_box_line_p
);
11818 else if (glyph
->type
== IMAGE_GLYPH
)
11821 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
11822 glyph
- row
->glyphs
[TEXT_AREA
],
11825 (BUFFERP (glyph
->object
)
11827 : (STRINGP (glyph
->object
)
11830 glyph
->pixel_width
,
11834 glyph
->left_box_line_p
,
11835 glyph
->right_box_line_p
);
11840 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
11841 GLYPHS 0 means don't show glyph contents.
11842 GLYPHS 1 means show glyphs in short form
11843 GLYPHS > 1 means show glyphs in long form. */
11846 dump_glyph_row (matrix
, vpos
, glyphs
)
11847 struct glyph_matrix
*matrix
;
11850 struct glyph_row
*row
;
11852 if (vpos
< 0 || vpos
>= matrix
->nrows
)
11855 row
= MATRIX_ROW (matrix
, vpos
);
11859 fprintf (stderr
, "Row Start End Used oEI><O\\CTZFesm X Y W H V A P\n");
11860 fprintf (stderr
, "=======================================================================\n");
11862 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d\
11863 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
11864 row
- matrix
->rows
,
11865 MATRIX_ROW_START_CHARPOS (row
),
11866 MATRIX_ROW_END_CHARPOS (row
),
11867 row
->used
[TEXT_AREA
],
11868 row
->contains_overlapping_glyphs_p
,
11871 row
->truncated_on_left_p
,
11872 row
->truncated_on_right_p
,
11873 row
->overlay_arrow_p
,
11875 MATRIX_ROW_CONTINUATION_LINE_P (row
),
11876 row
->displays_text_p
,
11879 row
->ends_in_middle_of_char_p
,
11880 row
->starts_in_middle_of_char_p
,
11886 row
->visible_height
,
11889 fprintf (stderr
, "%9d %5d\n", row
->start
.overlay_string_index
,
11890 row
->end
.overlay_string_index
);
11891 fprintf (stderr
, "%9d %5d\n",
11892 CHARPOS (row
->start
.string_pos
),
11893 CHARPOS (row
->end
.string_pos
));
11894 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
11895 row
->end
.dpvec_index
);
11902 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
11904 struct glyph
*glyph
= row
->glyphs
[area
];
11905 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
11907 /* Glyph for a line end in text. */
11908 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
11911 if (glyph
< glyph_end
)
11912 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
11914 for (; glyph
< glyph_end
; ++glyph
)
11915 dump_glyph (row
, glyph
, area
);
11918 else if (glyphs
== 1)
11922 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
11924 char *s
= (char *) alloca (row
->used
[area
] + 1);
11927 for (i
= 0; i
< row
->used
[area
]; ++i
)
11929 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
11930 if (glyph
->type
== CHAR_GLYPH
11931 && glyph
->u
.ch
< 0x80
11932 && glyph
->u
.ch
>= ' ')
11933 s
[i
] = glyph
->u
.ch
;
11939 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
11945 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
11946 Sdump_glyph_matrix
, 0, 1, "p",
11947 "Dump the current matrix of the selected window to stderr.\n\
11948 Shows contents of glyph row structures. With non-nil\n\
11949 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show\n\
11950 glyphs in short form, otherwise show glyphs in long form.")
11952 Lisp_Object glyphs
;
11954 struct window
*w
= XWINDOW (selected_window
);
11955 struct buffer
*buffer
= XBUFFER (w
->buffer
);
11957 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
11958 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
11959 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
11960 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
11961 fprintf (stderr
, "=============================================\n");
11962 dump_glyph_matrix (w
->current_matrix
,
11963 NILP (glyphs
) ? 0 : XINT (glyphs
));
11968 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
11969 "Dump glyph row ROW to stderr.\n\
11970 GLYPH 0 means don't dump glyphs.\n\
11971 GLYPH 1 means dump glyphs in short form.\n\
11972 GLYPH > 1 or omitted means dump glyphs in long form.")
11974 Lisp_Object row
, glyphs
;
11976 CHECK_NUMBER (row
, 0);
11977 dump_glyph_row (XWINDOW (selected_window
)->current_matrix
,
11979 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
11984 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
11985 "Dump glyph row ROW of the tool-bar of the current frame to stderr.\n\
11986 GLYPH 0 means don't dump glyphs.\n\
11987 GLYPH 1 means dump glyphs in short form.\n\
11988 GLYPH > 1 or omitted means dump glyphs in long form.")
11990 Lisp_Object row
, glyphs
;
11992 struct frame
*sf
= SELECTED_FRAME ();
11993 struct glyph_matrix
*m
= (XWINDOW (sf
->tool_bar_window
)->current_matrix
);
11994 dump_glyph_row (m
, XINT (row
), INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
11999 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
12000 "Toggle tracing of redisplay.\n\
12001 With ARG, turn tracing on if and only if ARG is positive.")
12006 trace_redisplay_p
= !trace_redisplay_p
;
12009 arg
= Fprefix_numeric_value (arg
);
12010 trace_redisplay_p
= XINT (arg
) > 0;
12017 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, 1, "",
12018 "Print STRING to stderr.")
12020 Lisp_Object string
;
12022 CHECK_STRING (string
, 0);
12023 fprintf (stderr
, "%s", XSTRING (string
)->data
);
12027 #endif /* GLYPH_DEBUG */
12031 /***********************************************************************
12032 Building Desired Matrix Rows
12033 ***********************************************************************/
12035 /* Return a temporary glyph row holding the glyphs of an overlay
12036 arrow. Only used for non-window-redisplay windows. */
12038 static struct glyph_row
*
12039 get_overlay_arrow_glyph_row (w
)
12042 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
12043 struct buffer
*buffer
= XBUFFER (w
->buffer
);
12044 struct buffer
*old
= current_buffer
;
12045 unsigned char *arrow_string
= XSTRING (Voverlay_arrow_string
)->data
;
12046 int arrow_len
= XSTRING (Voverlay_arrow_string
)->size
;
12047 unsigned char *arrow_end
= arrow_string
+ arrow_len
;
12051 int n_glyphs_before
;
12053 set_buffer_temp (buffer
);
12054 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
12055 it
.glyph_row
->used
[TEXT_AREA
] = 0;
12056 SET_TEXT_POS (it
.position
, 0, 0);
12058 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
12060 while (p
< arrow_end
)
12062 Lisp_Object face
, ilisp
;
12064 /* Get the next character. */
12066 it
.c
= string_char_and_length (p
, arrow_len
, &it
.len
);
12068 it
.c
= *p
, it
.len
= 1;
12071 /* Get its face. */
12072 ilisp
= make_number (p
- arrow_string
);
12073 face
= Fget_text_property (ilisp
, Qface
, Voverlay_arrow_string
);
12074 it
.face_id
= compute_char_face (f
, it
.c
, face
);
12076 /* Compute its width, get its glyphs. */
12077 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
12078 SET_TEXT_POS (it
.position
, -1, -1);
12079 PRODUCE_GLYPHS (&it
);
12081 /* If this character doesn't fit any more in the line, we have
12082 to remove some glyphs. */
12083 if (it
.current_x
> it
.last_visible_x
)
12085 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
12090 set_buffer_temp (old
);
12091 return it
.glyph_row
;
12095 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
12096 glyphs are only inserted for terminal frames since we can't really
12097 win with truncation glyphs when partially visible glyphs are
12098 involved. Which glyphs to insert is determined by
12099 produce_special_glyphs. */
12102 insert_left_trunc_glyphs (it
)
12105 struct it truncate_it
;
12106 struct glyph
*from
, *end
, *to
, *toend
;
12108 xassert (!FRAME_WINDOW_P (it
->f
));
12110 /* Get the truncation glyphs. */
12112 truncate_it
.current_x
= 0;
12113 truncate_it
.face_id
= DEFAULT_FACE_ID
;
12114 truncate_it
.glyph_row
= &scratch_glyph_row
;
12115 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
12116 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
12117 truncate_it
.object
= make_number (0);
12118 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
12120 /* Overwrite glyphs from IT with truncation glyphs. */
12121 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
12122 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
12123 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
12124 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
12129 /* There may be padding glyphs left over. Overwrite them too. */
12130 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
12132 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
12138 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
12142 /* Compute the pixel height and width of IT->glyph_row.
12144 Most of the time, ascent and height of a display line will be equal
12145 to the max_ascent and max_height values of the display iterator
12146 structure. This is not the case if
12148 1. We hit ZV without displaying anything. In this case, max_ascent
12149 and max_height will be zero.
12151 2. We have some glyphs that don't contribute to the line height.
12152 (The glyph row flag contributes_to_line_height_p is for future
12153 pixmap extensions).
12155 The first case is easily covered by using default values because in
12156 these cases, the line height does not really matter, except that it
12157 must not be zero. */
12160 compute_line_metrics (it
)
12163 struct glyph_row
*row
= it
->glyph_row
;
12166 if (FRAME_WINDOW_P (it
->f
))
12168 int i
, header_line_height
;
12170 /* The line may consist of one space only, that was added to
12171 place the cursor on it. If so, the row's height hasn't been
12173 if (row
->height
== 0)
12175 if (it
->max_ascent
+ it
->max_descent
== 0)
12176 it
->max_descent
= it
->max_phys_descent
= CANON_Y_UNIT (it
->f
);
12177 row
->ascent
= it
->max_ascent
;
12178 row
->height
= it
->max_ascent
+ it
->max_descent
;
12179 row
->phys_ascent
= it
->max_phys_ascent
;
12180 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
12183 /* Compute the width of this line. */
12184 row
->pixel_width
= row
->x
;
12185 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
12186 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12188 xassert (row
->pixel_width
>= 0);
12189 xassert (row
->ascent
>= 0 && row
->height
> 0);
12191 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
12192 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
12194 /* If first line's physical ascent is larger than its logical
12195 ascent, use the physical ascent, and make the row taller.
12196 This makes accented characters fully visible. */
12197 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
12198 && row
->phys_ascent
> row
->ascent
)
12200 row
->height
+= row
->phys_ascent
- row
->ascent
;
12201 row
->ascent
= row
->phys_ascent
;
12204 /* Compute how much of the line is visible. */
12205 row
->visible_height
= row
->height
;
12207 header_line_height
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (it
->w
);
12208 if (row
->y
< header_line_height
)
12209 row
->visible_height
-= header_line_height
- row
->y
;
12212 int max_y
= WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE (it
->w
);
12213 if (row
->y
+ row
->height
> max_y
)
12214 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
12219 row
->pixel_width
= row
->used
[TEXT_AREA
];
12220 row
->ascent
= row
->phys_ascent
= 0;
12221 row
->height
= row
->phys_height
= row
->visible_height
= 1;
12224 /* Compute a hash code for this row. */
12226 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
12227 for (i
= 0; i
< row
->used
[area
]; ++i
)
12228 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
12229 + row
->glyphs
[area
][i
].u
.val
12230 + row
->glyphs
[area
][i
].face_id
12231 + row
->glyphs
[area
][i
].padding_p
12232 + (row
->glyphs
[area
][i
].type
<< 2));
12234 it
->max_ascent
= it
->max_descent
= 0;
12235 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
12239 /* Append one space to the glyph row of iterator IT if doing a
12240 window-based redisplay. DEFAULT_FACE_P non-zero means let the
12241 space have the default face, otherwise let it have the same face as
12242 IT->face_id. Value is non-zero if a space was added.
12244 This function is called to make sure that there is always one glyph
12245 at the end of a glyph row that the cursor can be set on under
12246 window-systems. (If there weren't such a glyph we would not know
12247 how wide and tall a box cursor should be displayed).
12249 At the same time this space let's a nicely handle clearing to the
12250 end of the line if the row ends in italic text. */
12253 append_space (it
, default_face_p
)
12255 int default_face_p
;
12257 if (FRAME_WINDOW_P (it
->f
))
12259 int n
= it
->glyph_row
->used
[TEXT_AREA
];
12261 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
12262 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
12264 /* Save some values that must not be changed.
12265 Must save IT->c and IT->len because otherwise
12266 ITERATOR_AT_END_P wouldn't work anymore after
12267 append_space has been called. */
12268 enum display_element_type saved_what
= it
->what
;
12269 int saved_c
= it
->c
, saved_len
= it
->len
;
12270 int saved_x
= it
->current_x
;
12271 int saved_face_id
= it
->face_id
;
12272 struct text_pos saved_pos
;
12273 Lisp_Object saved_object
;
12276 saved_object
= it
->object
;
12277 saved_pos
= it
->position
;
12279 it
->what
= IT_CHARACTER
;
12280 bzero (&it
->position
, sizeof it
->position
);
12281 it
->object
= make_number (0);
12285 if (default_face_p
)
12286 it
->face_id
= DEFAULT_FACE_ID
;
12287 else if (it
->face_before_selective_p
)
12288 it
->face_id
= it
->saved_face_id
;
12289 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
12290 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0);
12292 PRODUCE_GLYPHS (it
);
12294 it
->current_x
= saved_x
;
12295 it
->object
= saved_object
;
12296 it
->position
= saved_pos
;
12297 it
->what
= saved_what
;
12298 it
->face_id
= saved_face_id
;
12299 it
->len
= saved_len
;
12309 /* Extend the face of the last glyph in the text area of IT->glyph_row
12310 to the end of the display line. Called from display_line.
12311 If the glyph row is empty, add a space glyph to it so that we
12312 know the face to draw. Set the glyph row flag fill_line_p. */
12315 extend_face_to_end_of_line (it
)
12319 struct frame
*f
= it
->f
;
12321 /* If line is already filled, do nothing. */
12322 if (it
->current_x
>= it
->last_visible_x
)
12325 /* Face extension extends the background and box of IT->face_id
12326 to the end of the line. If the background equals the background
12327 of the frame, we don't have to do anything. */
12328 if (it
->face_before_selective_p
)
12329 face
= FACE_FROM_ID (it
->f
, it
->saved_face_id
);
12331 face
= FACE_FROM_ID (f
, it
->face_id
);
12333 if (FRAME_WINDOW_P (f
)
12334 && face
->box
== FACE_NO_BOX
12335 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
12339 /* Set the glyph row flag indicating that the face of the last glyph
12340 in the text area has to be drawn to the end of the text area. */
12341 it
->glyph_row
->fill_line_p
= 1;
12343 /* If current character of IT is not ASCII, make sure we have the
12344 ASCII face. This will be automatically undone the next time
12345 get_next_display_element returns a multibyte character. Note
12346 that the character will always be single byte in unibyte text. */
12347 if (!SINGLE_BYTE_CHAR_P (it
->c
))
12349 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0);
12352 if (FRAME_WINDOW_P (f
))
12354 /* If the row is empty, add a space with the current face of IT,
12355 so that we know which face to draw. */
12356 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
12358 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
12359 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
12360 it
->glyph_row
->used
[TEXT_AREA
] = 1;
12365 /* Save some values that must not be changed. */
12366 int saved_x
= it
->current_x
;
12367 struct text_pos saved_pos
;
12368 Lisp_Object saved_object
;
12369 enum display_element_type saved_what
= it
->what
;
12370 int saved_face_id
= it
->face_id
;
12372 saved_object
= it
->object
;
12373 saved_pos
= it
->position
;
12375 it
->what
= IT_CHARACTER
;
12376 bzero (&it
->position
, sizeof it
->position
);
12377 it
->object
= make_number (0);
12380 it
->face_id
= face
->id
;
12382 PRODUCE_GLYPHS (it
);
12384 while (it
->current_x
<= it
->last_visible_x
)
12385 PRODUCE_GLYPHS (it
);
12387 /* Don't count these blanks really. It would let us insert a left
12388 truncation glyph below and make us set the cursor on them, maybe. */
12389 it
->current_x
= saved_x
;
12390 it
->object
= saved_object
;
12391 it
->position
= saved_pos
;
12392 it
->what
= saved_what
;
12393 it
->face_id
= saved_face_id
;
12398 /* Value is non-zero if text starting at CHARPOS in current_buffer is
12399 trailing whitespace. */
12402 trailing_whitespace_p (charpos
)
12405 int bytepos
= CHAR_TO_BYTE (charpos
);
12408 while (bytepos
< ZV_BYTE
12409 && (c
= FETCH_CHAR (bytepos
),
12410 c
== ' ' || c
== '\t'))
12413 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
12415 if (bytepos
!= PT_BYTE
)
12422 /* Highlight trailing whitespace, if any, in ROW. */
12425 highlight_trailing_whitespace (f
, row
)
12427 struct glyph_row
*row
;
12429 int used
= row
->used
[TEXT_AREA
];
12433 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
12434 struct glyph
*glyph
= start
+ used
- 1;
12436 /* Skip over glyphs inserted to display the cursor at the
12437 end of a line, for extending the face of the last glyph
12438 to the end of the line on terminals, and for truncation
12439 and continuation glyphs. */
12440 while (glyph
>= start
12441 && glyph
->type
== CHAR_GLYPH
12442 && INTEGERP (glyph
->object
))
12445 /* If last glyph is a space or stretch, and it's trailing
12446 whitespace, set the face of all trailing whitespace glyphs in
12447 IT->glyph_row to `trailing-whitespace'. */
12449 && BUFFERP (glyph
->object
)
12450 && (glyph
->type
== STRETCH_GLYPH
12451 || (glyph
->type
== CHAR_GLYPH
12452 && glyph
->u
.ch
== ' '))
12453 && trailing_whitespace_p (glyph
->charpos
))
12455 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
12457 while (glyph
>= start
12458 && BUFFERP (glyph
->object
)
12459 && (glyph
->type
== STRETCH_GLYPH
12460 || (glyph
->type
== CHAR_GLYPH
12461 && glyph
->u
.ch
== ' ')))
12462 (glyph
--)->face_id
= face_id
;
12468 /* Value is non-zero if glyph row ROW in window W should be
12469 used to hold the cursor. */
12472 cursor_row_p (w
, row
)
12474 struct glyph_row
*row
;
12476 int cursor_row_p
= 1;
12478 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
12480 /* If the row ends with a newline from a string, we don't want
12481 the cursor there (if the row is continued it doesn't end in a
12483 if (CHARPOS (row
->end
.string_pos
) >= 0
12484 || MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
12485 cursor_row_p
= row
->continued_p
;
12487 /* If the row ends at ZV, display the cursor at the end of that
12488 row instead of at the start of the row below. */
12489 else if (row
->ends_at_zv_p
)
12495 return cursor_row_p
;
12499 /* Construct the glyph row IT->glyph_row in the desired matrix of
12500 IT->w from text at the current position of IT. See dispextern.h
12501 for an overview of struct it. Value is non-zero if
12502 IT->glyph_row displays text, as opposed to a line displaying ZV
12509 struct glyph_row
*row
= it
->glyph_row
;
12511 /* We always start displaying at hpos zero even if hscrolled. */
12512 xassert (it
->hpos
== 0 && it
->current_x
== 0);
12514 /* We must not display in a row that's not a text row. */
12515 xassert (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
12516 < it
->w
->desired_matrix
->nrows
);
12518 /* Is IT->w showing the region? */
12519 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
12521 /* Clear the result glyph row and enable it. */
12522 prepare_desired_row (row
);
12524 row
->y
= it
->current_y
;
12525 row
->start
= it
->current
;
12526 row
->continuation_lines_width
= it
->continuation_lines_width
;
12527 row
->displays_text_p
= 1;
12528 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
12529 it
->starts_in_middle_of_char_p
= 0;
12531 /* Arrange the overlays nicely for our purposes. Usually, we call
12532 display_line on only one line at a time, in which case this
12533 can't really hurt too much, or we call it on lines which appear
12534 one after another in the buffer, in which case all calls to
12535 recenter_overlay_lists but the first will be pretty cheap. */
12536 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
12538 /* Move over display elements that are not visible because we are
12539 hscrolled. This may stop at an x-position < IT->first_visible_x
12540 if the first glyph is partially visible or if we hit a line end. */
12541 if (it
->current_x
< it
->first_visible_x
)
12542 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
12543 MOVE_TO_POS
| MOVE_TO_X
);
12545 /* Get the initial row height. This is either the height of the
12546 text hscrolled, if there is any, or zero. */
12547 row
->ascent
= it
->max_ascent
;
12548 row
->height
= it
->max_ascent
+ it
->max_descent
;
12549 row
->phys_ascent
= it
->max_phys_ascent
;
12550 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
12552 /* Loop generating characters. The loop is left with IT on the next
12553 character to display. */
12556 int n_glyphs_before
, hpos_before
, x_before
;
12558 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
12560 /* Retrieve the next thing to display. Value is zero if end of
12562 if (!get_next_display_element (it
))
12564 /* Maybe add a space at the end of this line that is used to
12565 display the cursor there under X. Set the charpos of the
12566 first glyph of blank lines not corresponding to any text
12568 if ((append_space (it
, 1) && row
->used
[TEXT_AREA
] == 1)
12569 || row
->used
[TEXT_AREA
] == 0)
12571 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
12572 row
->displays_text_p
= 0;
12574 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
))
12575 row
->indicate_empty_line_p
= 1;
12578 it
->continuation_lines_width
= 0;
12579 row
->ends_at_zv_p
= 1;
12583 /* Now, get the metrics of what we want to display. This also
12584 generates glyphs in `row' (which is IT->glyph_row). */
12585 n_glyphs_before
= row
->used
[TEXT_AREA
];
12588 /* Remember the line height so far in case the next element doesn't
12589 fit on the line. */
12590 if (!it
->truncate_lines_p
)
12592 ascent
= it
->max_ascent
;
12593 descent
= it
->max_descent
;
12594 phys_ascent
= it
->max_phys_ascent
;
12595 phys_descent
= it
->max_phys_descent
;
12598 PRODUCE_GLYPHS (it
);
12600 /* If this display element was in marginal areas, continue with
12602 if (it
->area
!= TEXT_AREA
)
12604 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
12605 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
12606 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
12607 row
->phys_height
= max (row
->phys_height
,
12608 it
->max_phys_ascent
+ it
->max_phys_descent
);
12609 set_iterator_to_next (it
, 1);
12613 /* Does the display element fit on the line? If we truncate
12614 lines, we should draw past the right edge of the window. If
12615 we don't truncate, we want to stop so that we can display the
12616 continuation glyph before the right margin. If lines are
12617 continued, there are two possible strategies for characters
12618 resulting in more than 1 glyph (e.g. tabs): Display as many
12619 glyphs as possible in this line and leave the rest for the
12620 continuation line, or display the whole element in the next
12621 line. Original redisplay did the former, so we do it also. */
12622 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12623 hpos_before
= it
->hpos
;
12626 if (/* Not a newline. */
12628 /* Glyphs produced fit entirely in the line. */
12629 && it
->current_x
< it
->last_visible_x
)
12631 it
->hpos
+= nglyphs
;
12632 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
12633 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
12634 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
12635 row
->phys_height
= max (row
->phys_height
,
12636 it
->max_phys_ascent
+ it
->max_phys_descent
);
12637 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
12638 row
->x
= x
- it
->first_visible_x
;
12643 struct glyph
*glyph
;
12645 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
12647 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12648 new_x
= x
+ glyph
->pixel_width
;
12650 if (/* Lines are continued. */
12651 !it
->truncate_lines_p
12652 && (/* Glyph doesn't fit on the line. */
12653 new_x
> it
->last_visible_x
12654 /* Or it fits exactly on a window system frame. */
12655 || (new_x
== it
->last_visible_x
12656 && FRAME_WINDOW_P (it
->f
))))
12658 /* End of a continued line. */
12661 || (new_x
== it
->last_visible_x
12662 && FRAME_WINDOW_P (it
->f
)))
12664 /* Current glyph is the only one on the line or
12665 fits exactly on the line. We must continue
12666 the line because we can't draw the cursor
12667 after the glyph. */
12668 row
->continued_p
= 1;
12669 it
->current_x
= new_x
;
12670 it
->continuation_lines_width
+= new_x
;
12672 if (i
== nglyphs
- 1)
12673 set_iterator_to_next (it
, 1);
12675 else if (CHAR_GLYPH_PADDING_P (*glyph
)
12676 && !FRAME_WINDOW_P (it
->f
))
12678 /* A padding glyph that doesn't fit on this line.
12679 This means the whole character doesn't fit
12681 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12683 /* Fill the rest of the row with continuation
12684 glyphs like in 20.x. */
12685 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
12686 < row
->glyphs
[1 + TEXT_AREA
])
12687 produce_special_glyphs (it
, IT_CONTINUATION
);
12689 row
->continued_p
= 1;
12690 it
->current_x
= x_before
;
12691 it
->continuation_lines_width
+= x_before
;
12693 /* Restore the height to what it was before the
12694 element not fitting on the line. */
12695 it
->max_ascent
= ascent
;
12696 it
->max_descent
= descent
;
12697 it
->max_phys_ascent
= phys_ascent
;
12698 it
->max_phys_descent
= phys_descent
;
12702 /* Display element draws past the right edge of
12703 the window. Restore positions to values
12704 before the element. The next line starts
12705 with current_x before the glyph that could
12706 not be displayed, so that TAB works right. */
12707 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
12709 /* Display continuation glyphs. */
12710 if (!FRAME_WINDOW_P (it
->f
))
12711 produce_special_glyphs (it
, IT_CONTINUATION
);
12712 row
->continued_p
= 1;
12715 it
->continuation_lines_width
+= x
;
12716 if (nglyphs
> 1 && i
> 0)
12718 row
->ends_in_middle_of_char_p
= 1;
12719 it
->starts_in_middle_of_char_p
= 1;
12722 /* Restore the height to what it was before the
12723 element not fitting on the line. */
12724 it
->max_ascent
= ascent
;
12725 it
->max_descent
= descent
;
12726 it
->max_phys_ascent
= phys_ascent
;
12727 it
->max_phys_descent
= phys_descent
;
12732 else if (new_x
> it
->first_visible_x
)
12734 /* Increment number of glyphs actually displayed. */
12737 if (x
< it
->first_visible_x
)
12738 /* Glyph is partially visible, i.e. row starts at
12739 negative X position. */
12740 row
->x
= x
- it
->first_visible_x
;
12744 /* Glyph is completely off the left margin of the
12745 window. This should not happen because of the
12746 move_it_in_display_line at the start of
12752 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
12753 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
12754 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
12755 row
->phys_height
= max (row
->phys_height
,
12756 it
->max_phys_ascent
+ it
->max_phys_descent
);
12758 /* End of this display line if row is continued. */
12759 if (row
->continued_p
)
12763 /* Is this a line end? If yes, we're also done, after making
12764 sure that a non-default face is extended up to the right
12765 margin of the window. */
12766 if (ITERATOR_AT_END_OF_LINE_P (it
))
12768 int used_before
= row
->used
[TEXT_AREA
];
12770 /* Add a space at the end of the line that is used to
12771 display the cursor there. */
12772 append_space (it
, 0);
12774 /* Extend the face to the end of the line. */
12775 extend_face_to_end_of_line (it
);
12777 /* Make sure we have the position. */
12778 if (used_before
== 0)
12779 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
12781 /* Consume the line end. This skips over invisible lines. */
12782 set_iterator_to_next (it
, 1);
12783 it
->continuation_lines_width
= 0;
12787 /* Proceed with next display element. Note that this skips
12788 over lines invisible because of selective display. */
12789 set_iterator_to_next (it
, 1);
12791 /* If we truncate lines, we are done when the last displayed
12792 glyphs reach past the right margin of the window. */
12793 if (it
->truncate_lines_p
12794 && (FRAME_WINDOW_P (it
->f
)
12795 ? (it
->current_x
>= it
->last_visible_x
)
12796 : (it
->current_x
> it
->last_visible_x
)))
12798 /* Maybe add truncation glyphs. */
12799 if (!FRAME_WINDOW_P (it
->f
))
12803 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
12804 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
12807 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
12809 row
->used
[TEXT_AREA
] = i
;
12810 produce_special_glyphs (it
, IT_TRUNCATION
);
12814 row
->truncated_on_right_p
= 1;
12815 it
->continuation_lines_width
= 0;
12816 reseat_at_next_visible_line_start (it
, 0);
12817 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
12818 it
->hpos
= hpos_before
;
12819 it
->current_x
= x_before
;
12824 /* If line is not empty and hscrolled, maybe insert truncation glyphs
12825 at the left window margin. */
12826 if (it
->first_visible_x
12827 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
12829 if (!FRAME_WINDOW_P (it
->f
))
12830 insert_left_trunc_glyphs (it
);
12831 row
->truncated_on_left_p
= 1;
12834 /* If the start of this line is the overlay arrow-position, then
12835 mark this glyph row as the one containing the overlay arrow.
12836 This is clearly a mess with variable size fonts. It would be
12837 better to let it be displayed like cursors under X. */
12838 if (MARKERP (Voverlay_arrow_position
)
12839 && current_buffer
== XMARKER (Voverlay_arrow_position
)->buffer
12840 && (MATRIX_ROW_START_CHARPOS (row
)
12841 == marker_position (Voverlay_arrow_position
))
12842 && STRINGP (Voverlay_arrow_string
)
12843 && ! overlay_arrow_seen
)
12845 /* Overlay arrow in window redisplay is a bitmap. */
12846 if (!FRAME_WINDOW_P (it
->f
))
12848 struct glyph_row
*arrow_row
= get_overlay_arrow_glyph_row (it
->w
);
12849 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
12850 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
12851 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
12852 struct glyph
*p2
, *end
;
12854 /* Copy the arrow glyphs. */
12855 while (glyph
< arrow_end
)
12858 /* Throw away padding glyphs. */
12860 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
12861 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
12867 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
12871 overlay_arrow_seen
= 1;
12872 row
->overlay_arrow_p
= 1;
12875 /* Compute pixel dimensions of this line. */
12876 compute_line_metrics (it
);
12878 /* Remember the position at which this line ends. */
12879 row
->end
= it
->current
;
12881 /* Maybe set the cursor. */
12882 if (it
->w
->cursor
.vpos
< 0
12883 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
12884 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
12885 && cursor_row_p (it
->w
, row
))
12886 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
12888 /* Highlight trailing whitespace. */
12889 if (!NILP (Vshow_trailing_whitespace
))
12890 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
12892 /* Prepare for the next line. This line starts horizontally at (X
12893 HPOS) = (0 0). Vertical positions are incremented. As a
12894 convenience for the caller, IT->glyph_row is set to the next
12896 it
->current_x
= it
->hpos
= 0;
12897 it
->current_y
+= row
->height
;
12900 return row
->displays_text_p
;
12905 /***********************************************************************
12907 ***********************************************************************/
12909 /* Redisplay the menu bar in the frame for window W.
12911 The menu bar of X frames that don't have X toolkit support is
12912 displayed in a special window W->frame->menu_bar_window.
12914 The menu bar of terminal frames is treated specially as far as
12915 glyph matrices are concerned. Menu bar lines are not part of
12916 windows, so the update is done directly on the frame matrix rows
12917 for the menu bar. */
12920 display_menu_bar (w
)
12923 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
12928 /* Don't do all this for graphical frames. */
12930 if (!NILP (Vwindow_system
))
12933 #ifdef USE_X_TOOLKIT
12938 if (FRAME_MAC_P (f
))
12942 #ifdef USE_X_TOOLKIT
12943 xassert (!FRAME_WINDOW_P (f
));
12944 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
12945 it
.first_visible_x
= 0;
12946 it
.last_visible_x
= FRAME_WINDOW_WIDTH (f
) * CANON_X_UNIT (f
);
12947 #else /* not USE_X_TOOLKIT */
12948 if (FRAME_WINDOW_P (f
))
12950 /* Menu bar lines are displayed in the desired matrix of the
12951 dummy window menu_bar_window. */
12952 struct window
*menu_w
;
12953 xassert (WINDOWP (f
->menu_bar_window
));
12954 menu_w
= XWINDOW (f
->menu_bar_window
);
12955 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
12957 it
.first_visible_x
= 0;
12958 it
.last_visible_x
= FRAME_WINDOW_WIDTH (f
) * CANON_X_UNIT (f
);
12962 /* This is a TTY frame, i.e. character hpos/vpos are used as
12964 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
12966 it
.first_visible_x
= 0;
12967 it
.last_visible_x
= FRAME_WIDTH (f
);
12969 #endif /* not USE_X_TOOLKIT */
12971 if (! mode_line_inverse_video
)
12972 /* Force the menu-bar to be displayed in the default face. */
12973 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
12975 /* Clear all rows of the menu bar. */
12976 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
12978 struct glyph_row
*row
= it
.glyph_row
+ i
;
12979 clear_glyph_row (row
);
12980 row
->enabled_p
= 1;
12981 row
->full_width_p
= 1;
12984 /* Display all items of the menu bar. */
12985 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
12986 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
12988 Lisp_Object string
;
12990 /* Stop at nil string. */
12991 string
= AREF (items
, i
+ 1);
12995 /* Remember where item was displayed. */
12996 AREF (items
, i
+ 3) = make_number (it
.hpos
);
12998 /* Display the item, pad with one space. */
12999 if (it
.current_x
< it
.last_visible_x
)
13000 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
13001 XSTRING (string
)->size
+ 1, 0, 0, -1);
13004 /* Fill out the line with spaces. */
13005 if (it
.current_x
< it
.last_visible_x
)
13006 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
13008 /* Compute the total height of the lines. */
13009 compute_line_metrics (&it
);
13014 /***********************************************************************
13016 ***********************************************************************/
13018 /* Redisplay mode lines in the window tree whose root is WINDOW. If
13019 FORCE is non-zero, redisplay mode lines unconditionally.
13020 Otherwise, redisplay only mode lines that are garbaged. Value is
13021 the number of windows whose mode lines were redisplayed. */
13024 redisplay_mode_lines (window
, force
)
13025 Lisp_Object window
;
13030 while (!NILP (window
))
13032 struct window
*w
= XWINDOW (window
);
13034 if (WINDOWP (w
->hchild
))
13035 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
13036 else if (WINDOWP (w
->vchild
))
13037 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
13039 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
13040 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
13042 Lisp_Object old_selected_frame
;
13043 struct text_pos lpoint
;
13044 struct buffer
*old
= current_buffer
;
13046 /* Set the window's buffer for the mode line display. */
13047 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13048 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13050 /* Point refers normally to the selected window. For any
13051 other window, set up appropriate value. */
13052 if (!EQ (window
, selected_window
))
13054 struct text_pos pt
;
13056 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
13057 if (CHARPOS (pt
) < BEGV
)
13058 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
13059 else if (CHARPOS (pt
) > (ZV
- 1))
13060 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
13062 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
13065 /* Temporarily set up the selected frame. */
13066 old_selected_frame
= selected_frame
;
13067 selected_frame
= w
->frame
;
13069 /* Display mode lines. */
13070 clear_glyph_matrix (w
->desired_matrix
);
13071 if (display_mode_lines (w
))
13074 w
->must_be_updated_p
= 1;
13077 /* Restore old settings. */
13078 selected_frame
= old_selected_frame
;
13079 set_buffer_internal_1 (old
);
13080 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
13090 /* Display the mode and/or top line of window W. Value is the number
13091 of mode lines displayed. */
13094 display_mode_lines (w
)
13099 /* These will be set while the mode line specs are processed. */
13100 line_number_displayed
= 0;
13101 w
->column_number_displayed
= Qnil
;
13103 if (WINDOW_WANTS_MODELINE_P (w
))
13105 display_mode_line (w
, MODE_LINE_FACE_ID
,
13106 current_buffer
->mode_line_format
);
13110 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13112 display_mode_line (w
, HEADER_LINE_FACE_ID
,
13113 current_buffer
->header_line_format
);
13121 /* Display mode or top line of window W. FACE_ID specifies which line
13122 to display; it is either MODE_LINE_FACE_ID or HEADER_LINE_FACE_ID.
13123 FORMAT is the mode line format to display. Value is the pixel
13124 height of the mode line displayed. */
13127 display_mode_line (w
, face_id
, format
)
13129 enum face_id face_id
;
13130 Lisp_Object format
;
13135 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
13136 prepare_desired_row (it
.glyph_row
);
13138 if (! mode_line_inverse_video
)
13139 /* Force the mode-line to be displayed in the default face. */
13140 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
13142 /* Temporarily make frame's keyboard the current kboard so that
13143 kboard-local variables in the mode_line_format will get the right
13145 push_frame_kboard (it
.f
);
13146 display_mode_element (&it
, 0, 0, 0, format
);
13147 pop_frame_kboard ();
13149 /* Fill up with spaces. */
13150 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
13152 compute_line_metrics (&it
);
13153 it
.glyph_row
->full_width_p
= 1;
13154 it
.glyph_row
->mode_line_p
= 1;
13155 it
.glyph_row
->inverse_p
= 0;
13156 it
.glyph_row
->continued_p
= 0;
13157 it
.glyph_row
->truncated_on_left_p
= 0;
13158 it
.glyph_row
->truncated_on_right_p
= 0;
13160 /* Make a 3D mode-line have a shadow at its right end. */
13161 face
= FACE_FROM_ID (it
.f
, face_id
);
13162 extend_face_to_end_of_line (&it
);
13163 if (face
->box
!= FACE_NO_BOX
)
13165 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
13166 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
13167 last
->right_box_line_p
= 1;
13170 return it
.glyph_row
->height
;
13174 /* Contribute ELT to the mode line for window IT->w. How it
13175 translates into text depends on its data type.
13177 IT describes the display environment in which we display, as usual.
13179 DEPTH is the depth in recursion. It is used to prevent
13180 infinite recursion here.
13182 FIELD_WIDTH is the number of characters the display of ELT should
13183 occupy in the mode line, and PRECISION is the maximum number of
13184 characters to display from ELT's representation. See
13185 display_string for details. *
13187 Returns the hpos of the end of the text generated by ELT. */
13190 display_mode_element (it
, depth
, field_width
, precision
, elt
)
13193 int field_width
, precision
;
13196 int n
= 0, field
, prec
;
13204 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
13208 /* A string: output it and check for %-constructs within it. */
13210 unsigned char *this = XSTRING (elt
)->data
;
13211 unsigned char *lisp_string
= this;
13213 while ((precision
<= 0 || n
< precision
)
13215 && (frame_title_ptr
13216 || it
->current_x
< it
->last_visible_x
))
13218 unsigned char *last
= this;
13220 /* Advance to end of string or next format specifier. */
13221 while ((c
= *this++) != '\0' && c
!= '%')
13224 if (this - 1 != last
)
13226 /* Output to end of string or up to '%'. Field width
13227 is length of string. Don't output more than
13228 PRECISION allows us. */
13230 prec
= strwidth (last
, this - last
);
13231 if (precision
> 0 && prec
> precision
- n
)
13232 prec
= precision
- n
;
13234 if (frame_title_ptr
)
13235 n
+= store_frame_title (last
, 0, prec
);
13237 n
+= display_string (NULL
, elt
, Qnil
, 0, last
- lisp_string
,
13238 it
, 0, prec
, 0, -1);
13240 else /* c == '%' */
13242 unsigned char *percent_position
= this;
13244 /* Get the specified minimum width. Zero means
13247 while ((c
= *this++) >= '0' && c
<= '9')
13248 field
= field
* 10 + c
- '0';
13250 /* Don't pad beyond the total padding allowed. */
13251 if (field_width
- n
> 0 && field
> field_width
- n
)
13252 field
= field_width
- n
;
13254 /* Note that either PRECISION <= 0 or N < PRECISION. */
13255 prec
= precision
- n
;
13258 n
+= display_mode_element (it
, depth
, field
, prec
,
13259 Vglobal_mode_string
);
13262 unsigned char *spec
13263 = decode_mode_spec (it
->w
, c
, field
, prec
);
13265 if (frame_title_ptr
)
13266 n
+= store_frame_title (spec
, field
, prec
);
13270 = it
->glyph_row
->used
[TEXT_AREA
];
13272 = percent_position
- XSTRING (elt
)->data
;
13274 = display_string (spec
, Qnil
, elt
, charpos
, 0, it
,
13275 field
, prec
, 0, -1);
13277 /* Assign to the glyphs written above the
13278 string where the `%x' came from, position
13282 struct glyph
*glyph
13283 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
13287 for (i
= 0; i
< nwritten
; ++i
)
13289 glyph
[i
].object
= elt
;
13290 glyph
[i
].charpos
= charpos
;
13303 /* A symbol: process the value of the symbol recursively
13304 as if it appeared here directly. Avoid error if symbol void.
13305 Special case: if value of symbol is a string, output the string
13308 register Lisp_Object tem
;
13309 tem
= Fboundp (elt
);
13312 tem
= Fsymbol_value (elt
);
13313 /* If value is a string, output that string literally:
13314 don't check for % within it. */
13317 prec
= precision
- n
;
13318 if (frame_title_ptr
)
13319 n
+= store_frame_title (XSTRING (tem
)->data
, -1, prec
);
13321 n
+= display_string (NULL
, tem
, Qnil
, 0, 0, it
,
13324 else if (!EQ (tem
, elt
))
13326 /* Give up right away for nil or t. */
13336 register Lisp_Object car
, tem
;
13338 /* A cons cell: three distinct cases.
13339 If first element is a string or a cons, process all the elements
13340 and effectively concatenate them.
13341 If first element is a negative number, truncate displaying cdr to
13342 at most that many characters. If positive, pad (with spaces)
13343 to at least that many characters.
13344 If first element is a symbol, process the cadr or caddr recursively
13345 according to whether the symbol's value is non-nil or nil. */
13347 if (EQ (car
, QCeval
) && CONSP (XCDR (elt
)))
13349 /* An element of the form (:eval FORM) means evaluate FORM
13350 and use the result as mode line elements. */
13351 struct gcpro gcpro1
;
13354 spec
= safe_eval (XCAR (XCDR (elt
)));
13356 n
+= display_mode_element (it
, depth
, field_width
- n
,
13357 precision
- n
, spec
);
13360 else if (SYMBOLP (car
))
13362 tem
= Fboundp (car
);
13366 /* elt is now the cdr, and we know it is a cons cell.
13367 Use its car if CAR has a non-nil value. */
13370 tem
= Fsymbol_value (car
);
13377 /* Symbol's value is nil (or symbol is unbound)
13378 Get the cddr of the original list
13379 and if possible find the caddr and use that. */
13383 else if (!CONSP (elt
))
13388 else if (INTEGERP (car
))
13390 register int lim
= XINT (car
);
13394 /* Negative int means reduce maximum width. */
13395 if (precision
<= 0)
13398 precision
= min (precision
, -lim
);
13402 /* Padding specified. Don't let it be more than
13403 current maximum. */
13405 lim
= min (precision
, lim
);
13407 /* If that's more padding than already wanted, queue it.
13408 But don't reduce padding already specified even if
13409 that is beyond the current truncation point. */
13410 field_width
= max (lim
, field_width
);
13414 else if (STRINGP (car
) || CONSP (car
))
13416 register int limit
= 50;
13417 /* Limit is to protect against circular lists. */
13420 && (precision
<= 0 || n
< precision
))
13422 n
+= display_mode_element (it
, depth
, field_width
- n
,
13423 precision
- n
, XCAR (elt
));
13432 if (frame_title_ptr
)
13433 n
+= store_frame_title ("*invalid*", 0, precision
- n
);
13435 n
+= display_string ("*invalid*", Qnil
, Qnil
, 0, 0, it
, 0,
13436 precision
- n
, 0, 0);
13440 /* Pad to FIELD_WIDTH. */
13441 if (field_width
> 0 && n
< field_width
)
13443 if (frame_title_ptr
)
13444 n
+= store_frame_title ("", field_width
- n
, 0);
13446 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
13454 /* Write a null-terminated, right justified decimal representation of
13455 the positive integer D to BUF using a minimal field width WIDTH. */
13458 pint2str (buf
, width
, d
)
13459 register char *buf
;
13460 register int width
;
13463 register char *p
= buf
;
13471 *p
++ = d
% 10 + '0';
13476 for (width
-= (int) (p
- buf
); width
> 0; --width
)
13487 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
13488 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
13489 type of CODING_SYSTEM. Return updated pointer into BUF. */
13491 static unsigned char invalid_eol_type
[] = "(*invalid*)";
13494 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
13495 Lisp_Object coding_system
;
13496 register char *buf
;
13500 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
13501 unsigned char *eol_str
;
13503 /* The EOL conversion we are using. */
13504 Lisp_Object eoltype
;
13506 val
= Fget (coding_system
, Qcoding_system
);
13509 if (!VECTORP (val
)) /* Not yet decided. */
13514 eoltype
= eol_mnemonic_undecided
;
13515 /* Don't mention EOL conversion if it isn't decided. */
13519 Lisp_Object eolvalue
;
13521 eolvalue
= Fget (coding_system
, Qeol_type
);
13524 *buf
++ = XFASTINT (AREF (val
, 1));
13528 /* The EOL conversion that is normal on this system. */
13530 if (NILP (eolvalue
)) /* Not yet decided. */
13531 eoltype
= eol_mnemonic_undecided
;
13532 else if (VECTORP (eolvalue
)) /* Not yet decided. */
13533 eoltype
= eol_mnemonic_undecided
;
13534 else /* INTEGERP (eolvalue) -- 0:LF, 1:CRLF, 2:CR */
13535 eoltype
= (XFASTINT (eolvalue
) == 0
13536 ? eol_mnemonic_unix
13537 : (XFASTINT (eolvalue
) == 1
13538 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
13544 /* Mention the EOL conversion if it is not the usual one. */
13545 if (STRINGP (eoltype
))
13547 eol_str
= XSTRING (eoltype
)->data
;
13548 eol_str_len
= XSTRING (eoltype
)->size
;
13550 else if (INTEGERP (eoltype
)
13551 && CHAR_VALID_P (XINT (eoltype
), 0))
13553 eol_str
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
13554 eol_str_len
= CHAR_STRING (XINT (eoltype
), eol_str
);
13558 eol_str
= invalid_eol_type
;
13559 eol_str_len
= sizeof (invalid_eol_type
) - 1;
13561 bcopy (eol_str
, buf
, eol_str_len
);
13562 buf
+= eol_str_len
;
13568 /* Return a string for the output of a mode line %-spec for window W,
13569 generated by character C. PRECISION >= 0 means don't return a
13570 string longer than that value. FIELD_WIDTH > 0 means pad the
13571 string returned with spaces to that value. */
13573 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
13576 decode_mode_spec (w
, c
, field_width
, precision
)
13579 int field_width
, precision
;
13582 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
13583 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
13584 struct buffer
*b
= XBUFFER (w
->buffer
);
13591 if (!NILP (b
->read_only
))
13593 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
13598 /* This differs from %* only for a modified read-only buffer. */
13599 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
13601 if (!NILP (b
->read_only
))
13606 /* This differs from %* in ignoring read-only-ness. */
13607 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
13619 if (command_loop_level
> 5)
13621 p
= decode_mode_spec_buf
;
13622 for (i
= 0; i
< command_loop_level
; i
++)
13625 return decode_mode_spec_buf
;
13633 if (command_loop_level
> 5)
13635 p
= decode_mode_spec_buf
;
13636 for (i
= 0; i
< command_loop_level
; i
++)
13639 return decode_mode_spec_buf
;
13646 /* Let lots_of_dashes be a string of infinite length. */
13647 if (field_width
<= 0
13648 || field_width
> sizeof (lots_of_dashes
))
13650 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
13651 decode_mode_spec_buf
[i
] = '-';
13652 decode_mode_spec_buf
[i
] = '\0';
13653 return decode_mode_spec_buf
;
13656 return lots_of_dashes
;
13665 int col
= current_column ();
13666 w
->column_number_displayed
= make_number (col
);
13667 pint2str (decode_mode_spec_buf
, field_width
, col
);
13668 return decode_mode_spec_buf
;
13672 /* %F displays the frame name. */
13673 if (!NILP (f
->title
))
13674 return (char *) XSTRING (f
->title
)->data
;
13675 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
13676 return (char *) XSTRING (f
->name
)->data
;
13685 int startpos
= XMARKER (w
->start
)->charpos
;
13686 int startpos_byte
= marker_byte_position (w
->start
);
13687 int line
, linepos
, linepos_byte
, topline
;
13689 int height
= XFASTINT (w
->height
);
13691 /* If we decided that this buffer isn't suitable for line numbers,
13692 don't forget that too fast. */
13693 if (EQ (w
->base_line_pos
, w
->buffer
))
13695 /* But do forget it, if the window shows a different buffer now. */
13696 else if (BUFFERP (w
->base_line_pos
))
13697 w
->base_line_pos
= Qnil
;
13699 /* If the buffer is very big, don't waste time. */
13700 if (INTEGERP (Vline_number_display_limit
)
13701 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
13703 w
->base_line_pos
= Qnil
;
13704 w
->base_line_number
= Qnil
;
13708 if (!NILP (w
->base_line_number
)
13709 && !NILP (w
->base_line_pos
)
13710 && XFASTINT (w
->base_line_pos
) <= startpos
)
13712 line
= XFASTINT (w
->base_line_number
);
13713 linepos
= XFASTINT (w
->base_line_pos
);
13714 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
13719 linepos
= BUF_BEGV (b
);
13720 linepos_byte
= BUF_BEGV_BYTE (b
);
13723 /* Count lines from base line to window start position. */
13724 nlines
= display_count_lines (linepos
, linepos_byte
,
13728 topline
= nlines
+ line
;
13730 /* Determine a new base line, if the old one is too close
13731 or too far away, or if we did not have one.
13732 "Too close" means it's plausible a scroll-down would
13733 go back past it. */
13734 if (startpos
== BUF_BEGV (b
))
13736 w
->base_line_number
= make_number (topline
);
13737 w
->base_line_pos
= make_number (BUF_BEGV (b
));
13739 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
13740 || linepos
== BUF_BEGV (b
))
13742 int limit
= BUF_BEGV (b
);
13743 int limit_byte
= BUF_BEGV_BYTE (b
);
13745 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
13747 if (startpos
- distance
> limit
)
13749 limit
= startpos
- distance
;
13750 limit_byte
= CHAR_TO_BYTE (limit
);
13753 nlines
= display_count_lines (startpos
, startpos_byte
,
13755 - (height
* 2 + 30),
13757 /* If we couldn't find the lines we wanted within
13758 line_number_display_limit_width chars per line,
13759 give up on line numbers for this window. */
13760 if (position
== limit_byte
&& limit
== startpos
- distance
)
13762 w
->base_line_pos
= w
->buffer
;
13763 w
->base_line_number
= Qnil
;
13767 w
->base_line_number
= make_number (topline
- nlines
);
13768 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
13771 /* Now count lines from the start pos to point. */
13772 nlines
= display_count_lines (startpos
, startpos_byte
,
13773 PT_BYTE
, PT
, &junk
);
13775 /* Record that we did display the line number. */
13776 line_number_displayed
= 1;
13778 /* Make the string to show. */
13779 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
13780 return decode_mode_spec_buf
;
13783 char* p
= decode_mode_spec_buf
;
13784 int pad
= field_width
- 2;
13790 return decode_mode_spec_buf
;
13796 obj
= b
->mode_name
;
13800 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
13806 int pos
= marker_position (w
->start
);
13807 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
13809 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
13811 if (pos
<= BUF_BEGV (b
))
13816 else if (pos
<= BUF_BEGV (b
))
13820 if (total
> 1000000)
13821 /* Do it differently for a large value, to avoid overflow. */
13822 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
13824 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
13825 /* We can't normally display a 3-digit number,
13826 so get us a 2-digit number that is close. */
13829 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
13830 return decode_mode_spec_buf
;
13834 /* Display percentage of size above the bottom of the screen. */
13837 int toppos
= marker_position (w
->start
);
13838 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
13839 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
13841 if (botpos
>= BUF_ZV (b
))
13843 if (toppos
<= BUF_BEGV (b
))
13850 if (total
> 1000000)
13851 /* Do it differently for a large value, to avoid overflow. */
13852 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
13854 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
13855 /* We can't normally display a 3-digit number,
13856 so get us a 2-digit number that is close. */
13859 if (toppos
<= BUF_BEGV (b
))
13860 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
13862 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
13863 return decode_mode_spec_buf
;
13868 /* status of process */
13869 obj
= Fget_buffer_process (w
->buffer
);
13871 return "no process";
13872 #ifdef subprocesses
13873 obj
= Fsymbol_name (Fprocess_status (obj
));
13877 case 't': /* indicate TEXT or BINARY */
13878 #ifdef MODE_LINE_BINARY_TEXT
13879 return MODE_LINE_BINARY_TEXT (b
);
13885 /* coding-system (not including end-of-line format) */
13887 /* coding-system (including end-of-line type) */
13889 int eol_flag
= (c
== 'Z');
13890 char *p
= decode_mode_spec_buf
;
13892 if (! FRAME_WINDOW_P (f
))
13894 /* No need to mention EOL here--the terminal never needs
13895 to do EOL conversion. */
13896 p
= decode_mode_spec_coding (keyboard_coding
.symbol
, p
, 0);
13897 p
= decode_mode_spec_coding (terminal_coding
.symbol
, p
, 0);
13899 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
13902 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
13903 #ifdef subprocesses
13904 obj
= Fget_buffer_process (Fcurrent_buffer ());
13905 if (PROCESSP (obj
))
13907 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
13909 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
13912 #endif /* subprocesses */
13915 return decode_mode_spec_buf
;
13920 return (char *) XSTRING (obj
)->data
;
13926 /* Count up to COUNT lines starting from START / START_BYTE.
13927 But don't go beyond LIMIT_BYTE.
13928 Return the number of lines thus found (always nonnegative).
13930 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
13933 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
13934 int start
, start_byte
, limit_byte
, count
;
13937 register unsigned char *cursor
;
13938 unsigned char *base
;
13940 register int ceiling
;
13941 register unsigned char *ceiling_addr
;
13942 int orig_count
= count
;
13944 /* If we are not in selective display mode,
13945 check only for newlines. */
13946 int selective_display
= (!NILP (current_buffer
->selective_display
)
13947 && !INTEGERP (current_buffer
->selective_display
));
13951 while (start_byte
< limit_byte
)
13953 ceiling
= BUFFER_CEILING_OF (start_byte
);
13954 ceiling
= min (limit_byte
- 1, ceiling
);
13955 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
13956 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
13959 if (selective_display
)
13960 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
13963 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
13966 if (cursor
!= ceiling_addr
)
13970 start_byte
+= cursor
- base
+ 1;
13971 *byte_pos_ptr
= start_byte
;
13975 if (++cursor
== ceiling_addr
)
13981 start_byte
+= cursor
- base
;
13986 while (start_byte
> limit_byte
)
13988 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
13989 ceiling
= max (limit_byte
, ceiling
);
13990 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
13991 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
13994 if (selective_display
)
13995 while (--cursor
!= ceiling_addr
13996 && *cursor
!= '\n' && *cursor
!= 015)
13999 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
14002 if (cursor
!= ceiling_addr
)
14006 start_byte
+= cursor
- base
+ 1;
14007 *byte_pos_ptr
= start_byte
;
14008 /* When scanning backwards, we should
14009 not count the newline posterior to which we stop. */
14010 return - orig_count
- 1;
14016 /* Here we add 1 to compensate for the last decrement
14017 of CURSOR, which took it past the valid range. */
14018 start_byte
+= cursor
- base
+ 1;
14022 *byte_pos_ptr
= limit_byte
;
14025 return - orig_count
+ count
;
14026 return orig_count
- count
;
14032 /***********************************************************************
14034 ***********************************************************************/
14036 /* Display a NUL-terminated string, starting with index START.
14038 If STRING is non-null, display that C string. Otherwise, the Lisp
14039 string LISP_STRING is displayed.
14041 If FACE_STRING is not nil, FACE_STRING_POS is a position in
14042 FACE_STRING. Display STRING or LISP_STRING with the face at
14043 FACE_STRING_POS in FACE_STRING:
14045 Display the string in the environment given by IT, but use the
14046 standard display table, temporarily.
14048 FIELD_WIDTH is the minimum number of output glyphs to produce.
14049 If STRING has fewer characters than FIELD_WIDTH, pad to the right
14050 with spaces. If STRING has more characters, more than FIELD_WIDTH
14051 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
14053 PRECISION is the maximum number of characters to output from
14054 STRING. PRECISION < 0 means don't truncate the string.
14056 This is roughly equivalent to printf format specifiers:
14058 FIELD_WIDTH PRECISION PRINTF
14059 ----------------------------------------
14065 MULTIBYTE zero means do not display multibyte chars, > 0 means do
14066 display them, and < 0 means obey the current buffer's value of
14067 enable_multibyte_characters.
14069 Value is the number of glyphs produced. */
14072 display_string (string
, lisp_string
, face_string
, face_string_pos
,
14073 start
, it
, field_width
, precision
, max_x
, multibyte
)
14074 unsigned char *string
;
14075 Lisp_Object lisp_string
;
14076 Lisp_Object face_string
;
14077 int face_string_pos
;
14080 int field_width
, precision
, max_x
;
14083 int hpos_at_start
= it
->hpos
;
14084 int saved_face_id
= it
->face_id
;
14085 struct glyph_row
*row
= it
->glyph_row
;
14087 /* Initialize the iterator IT for iteration over STRING beginning
14088 with index START. */
14089 reseat_to_string (it
, string
, lisp_string
, start
,
14090 precision
, field_width
, multibyte
);
14092 /* If displaying STRING, set up the face of the iterator
14093 from LISP_STRING, if that's given. */
14094 if (STRINGP (face_string
))
14100 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
14101 0, it
->region_beg_charpos
,
14102 it
->region_end_charpos
,
14103 &endptr
, it
->base_face_id
, 0);
14104 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
14105 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
14108 /* Set max_x to the maximum allowed X position. Don't let it go
14109 beyond the right edge of the window. */
14111 max_x
= it
->last_visible_x
;
14113 max_x
= min (max_x
, it
->last_visible_x
);
14115 /* Skip over display elements that are not visible. because IT->w is
14117 if (it
->current_x
< it
->first_visible_x
)
14118 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
14119 MOVE_TO_POS
| MOVE_TO_X
);
14121 row
->ascent
= it
->max_ascent
;
14122 row
->height
= it
->max_ascent
+ it
->max_descent
;
14123 row
->phys_ascent
= it
->max_phys_ascent
;
14124 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
14126 /* This condition is for the case that we are called with current_x
14127 past last_visible_x. */
14128 while (it
->current_x
< max_x
)
14130 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
14132 /* Get the next display element. */
14133 if (!get_next_display_element (it
))
14136 /* Produce glyphs. */
14137 x_before
= it
->current_x
;
14138 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
14139 PRODUCE_GLYPHS (it
);
14141 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
14144 while (i
< nglyphs
)
14146 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
14148 if (!it
->truncate_lines_p
14149 && x
+ glyph
->pixel_width
> max_x
)
14151 /* End of continued line or max_x reached. */
14152 if (CHAR_GLYPH_PADDING_P (*glyph
))
14154 /* A wide character is unbreakable. */
14155 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
14156 it
->current_x
= x_before
;
14160 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
14165 else if (x
+ glyph
->pixel_width
> it
->first_visible_x
)
14167 /* Glyph is at least partially visible. */
14169 if (x
< it
->first_visible_x
)
14170 it
->glyph_row
->x
= x
- it
->first_visible_x
;
14174 /* Glyph is off the left margin of the display area.
14175 Should not happen. */
14179 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
14180 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
14181 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
14182 row
->phys_height
= max (row
->phys_height
,
14183 it
->max_phys_ascent
+ it
->max_phys_descent
);
14184 x
+= glyph
->pixel_width
;
14188 /* Stop if max_x reached. */
14192 /* Stop at line ends. */
14193 if (ITERATOR_AT_END_OF_LINE_P (it
))
14195 it
->continuation_lines_width
= 0;
14199 set_iterator_to_next (it
, 1);
14201 /* Stop if truncating at the right edge. */
14202 if (it
->truncate_lines_p
14203 && it
->current_x
>= it
->last_visible_x
)
14205 /* Add truncation mark, but don't do it if the line is
14206 truncated at a padding space. */
14207 if (IT_CHARPOS (*it
) < it
->string_nchars
)
14209 if (!FRAME_WINDOW_P (it
->f
))
14213 if (it
->current_x
> it
->last_visible_x
)
14215 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
14216 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
14218 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
14220 row
->used
[TEXT_AREA
] = i
;
14221 produce_special_glyphs (it
, IT_TRUNCATION
);
14224 produce_special_glyphs (it
, IT_TRUNCATION
);
14226 it
->glyph_row
->truncated_on_right_p
= 1;
14232 /* Maybe insert a truncation at the left. */
14233 if (it
->first_visible_x
14234 && IT_CHARPOS (*it
) > 0)
14236 if (!FRAME_WINDOW_P (it
->f
))
14237 insert_left_trunc_glyphs (it
);
14238 it
->glyph_row
->truncated_on_left_p
= 1;
14241 it
->face_id
= saved_face_id
;
14243 /* Value is number of columns displayed. */
14244 return it
->hpos
- hpos_at_start
;
14249 /* This is like a combination of memq and assq. Return 1 if PROPVAL
14250 appears as an element of LIST or as the car of an element of LIST.
14251 If PROPVAL is a list, compare each element against LIST in that
14252 way, and return 1 if any element of PROPVAL is found in LIST.
14253 Otherwise return 0. This function cannot quit. */
14256 invisible_p (propval
, list
)
14257 register Lisp_Object propval
;
14260 register Lisp_Object tail
, proptail
;
14262 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
14264 register Lisp_Object tem
;
14266 if (EQ (propval
, tem
))
14268 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
14272 if (CONSP (propval
))
14274 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
14276 Lisp_Object propelt
;
14277 propelt
= XCAR (proptail
);
14278 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
14280 register Lisp_Object tem
;
14282 if (EQ (propelt
, tem
))
14284 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
14294 /* Return 1 if PROPVAL appears as the car of an element of LIST and
14295 the cdr of that element is non-nil. If PROPVAL is a list, check
14296 each element of PROPVAL in that way, and the first time some
14297 element is found, return 1 if the cdr of that element is non-nil.
14298 Otherwise return 0. This function cannot quit. */
14301 invisible_ellipsis_p (propval
, list
)
14302 register Lisp_Object propval
;
14305 register Lisp_Object tail
, proptail
;
14307 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
14309 register Lisp_Object tem
;
14311 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
14312 return ! NILP (XCDR (tem
));
14315 if (CONSP (propval
))
14316 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
14318 Lisp_Object propelt
;
14319 propelt
= XCAR (proptail
);
14320 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
14322 register Lisp_Object tem
;
14324 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
14325 return ! NILP (XCDR (tem
));
14334 /***********************************************************************
14336 ***********************************************************************/
14341 Vwith_echo_area_save_vector
= Qnil
;
14342 staticpro (&Vwith_echo_area_save_vector
);
14344 Vmessage_stack
= Qnil
;
14345 staticpro (&Vmessage_stack
);
14347 Qinhibit_redisplay
= intern ("inhibit-redisplay");
14348 staticpro (&Qinhibit_redisplay
);
14351 defsubr (&Sdump_glyph_matrix
);
14352 defsubr (&Sdump_glyph_row
);
14353 defsubr (&Sdump_tool_bar_row
);
14354 defsubr (&Strace_redisplay
);
14355 defsubr (&Strace_to_stderr
);
14357 #ifdef HAVE_WINDOW_SYSTEM
14358 defsubr (&Stool_bar_lines_needed
);
14361 staticpro (&Qmenu_bar_update_hook
);
14362 Qmenu_bar_update_hook
= intern ("menu-bar-update-hook");
14364 staticpro (&Qoverriding_terminal_local_map
);
14365 Qoverriding_terminal_local_map
= intern ("overriding-terminal-local-map");
14367 staticpro (&Qoverriding_local_map
);
14368 Qoverriding_local_map
= intern ("overriding-local-map");
14370 staticpro (&Qwindow_scroll_functions
);
14371 Qwindow_scroll_functions
= intern ("window-scroll-functions");
14373 staticpro (&Qredisplay_end_trigger_functions
);
14374 Qredisplay_end_trigger_functions
= intern ("redisplay-end-trigger-functions");
14376 staticpro (&Qinhibit_point_motion_hooks
);
14377 Qinhibit_point_motion_hooks
= intern ("inhibit-point-motion-hooks");
14379 QCdata
= intern (":data");
14380 staticpro (&QCdata
);
14381 Qdisplay
= intern ("display");
14382 staticpro (&Qdisplay
);
14383 Qspace_width
= intern ("space-width");
14384 staticpro (&Qspace_width
);
14385 Qraise
= intern ("raise");
14386 staticpro (&Qraise
);
14387 Qspace
= intern ("space");
14388 staticpro (&Qspace
);
14389 Qmargin
= intern ("margin");
14390 staticpro (&Qmargin
);
14391 Qleft_margin
= intern ("left-margin");
14392 staticpro (&Qleft_margin
);
14393 Qright_margin
= intern ("right-margin");
14394 staticpro (&Qright_margin
);
14395 Qalign_to
= intern ("align-to");
14396 staticpro (&Qalign_to
);
14397 QCalign_to
= intern (":align-to");
14398 staticpro (&QCalign_to
);
14399 Qrelative_width
= intern ("relative-width");
14400 staticpro (&Qrelative_width
);
14401 QCrelative_width
= intern (":relative-width");
14402 staticpro (&QCrelative_width
);
14403 QCrelative_height
= intern (":relative-height");
14404 staticpro (&QCrelative_height
);
14405 QCeval
= intern (":eval");
14406 staticpro (&QCeval
);
14407 Qwhen
= intern ("when");
14408 staticpro (&Qwhen
);
14409 QCfile
= intern (":file");
14410 staticpro (&QCfile
);
14411 Qfontified
= intern ("fontified");
14412 staticpro (&Qfontified
);
14413 Qfontification_functions
= intern ("fontification-functions");
14414 staticpro (&Qfontification_functions
);
14415 Qtrailing_whitespace
= intern ("trailing-whitespace");
14416 staticpro (&Qtrailing_whitespace
);
14417 Qimage
= intern ("image");
14418 staticpro (&Qimage
);
14419 Qmessage_truncate_lines
= intern ("message-truncate-lines");
14420 staticpro (&Qmessage_truncate_lines
);
14421 Qgrow_only
= intern ("grow-only");
14422 staticpro (&Qgrow_only
);
14423 Qinhibit_menubar_update
= intern ("inhibit-menubar-update");
14424 staticpro (&Qinhibit_menubar_update
);
14425 Qinhibit_eval_during_redisplay
= intern ("inhibit-eval-during-redisplay");
14426 staticpro (&Qinhibit_eval_during_redisplay
);
14428 last_arrow_position
= Qnil
;
14429 last_arrow_string
= Qnil
;
14430 staticpro (&last_arrow_position
);
14431 staticpro (&last_arrow_string
);
14433 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
14434 staticpro (&echo_buffer
[0]);
14435 staticpro (&echo_buffer
[1]);
14437 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
14438 staticpro (&echo_area_buffer
[0]);
14439 staticpro (&echo_area_buffer
[1]);
14441 Vmessages_buffer_name
= build_string ("*Messages*");
14442 staticpro (&Vmessages_buffer_name
);
14444 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
14445 "Non-nil means highlight trailing whitespace.\n\
14446 The face used for trailing whitespace is `trailing-whitespace'.");
14447 Vshow_trailing_whitespace
= Qnil
;
14449 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
14450 "Non-nil means don't actually do any redisplay.\n\
14451 This is used for internal purposes.");
14452 Vinhibit_redisplay
= Qnil
;
14454 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
14455 "String (or mode line construct) included (normally) in `mode-line-format'.");
14456 Vglobal_mode_string
= Qnil
;
14458 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
14459 "Marker for where to display an arrow on top of the buffer text.\n\
14460 This must be the beginning of a line in order to work.\n\
14461 See also `overlay-arrow-string'.");
14462 Voverlay_arrow_position
= Qnil
;
14464 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
14465 "String to display as an arrow. See also `overlay-arrow-position'.");
14466 Voverlay_arrow_string
= Qnil
;
14468 DEFVAR_INT ("scroll-step", &scroll_step
,
14469 "*The number of lines to try scrolling a window by when point moves out.\n\
14470 If that fails to bring point back on frame, point is centered instead.\n\
14471 If this is zero, point is always centered after it moves off frame.\n\
14472 If you want scrolling to always be a line at a time, you should set\n\
14473 `scroll-conservatively' to a large value rather than set this to 1.");
14475 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
14476 "*Scroll up to this many lines, to bring point back on screen.\n\
14477 A value of zero means to scroll the text to center point vertically\n\
14479 scroll_conservatively
= 0;
14481 DEFVAR_INT ("scroll-margin", &scroll_margin
,
14482 "*Number of lines of margin at the top and bottom of a window.\n\
14483 Recenter the window whenever point gets within this many lines\n\
14484 of the top or bottom of the window.");
14488 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, "Don't ask");
14491 DEFVAR_BOOL ("truncate-partial-width-windows",
14492 &truncate_partial_width_windows
,
14493 "*Non-nil means truncate lines in all windows less than full frame wide.");
14494 truncate_partial_width_windows
= 1;
14496 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
14497 "nil means display the mode-line/header-line/menu-bar in the default face.\n\
14498 Any other value means to use the appropriate face, `mode-line',\n\
14499 `header-line', or `menu' respectively.\n\
14501 This variable is deprecated; please change the above faces instead.");
14502 mode_line_inverse_video
= 1;
14504 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
14505 "*Maximum buffer size for which line number should be displayed.\n\
14506 If the buffer is bigger than this, the line number does not appear\n\
14507 in the mode line. A value of nil means no limit.");
14508 Vline_number_display_limit
= Qnil
;
14510 DEFVAR_INT ("line-number-display-limit-width",
14511 &line_number_display_limit_width
,
14512 "*Maximum line width (in characters) for line number display.\n\
14513 If the average length of the lines near point is bigger than this, then the\n\
14514 line number may be omitted from the mode line.");
14515 line_number_display_limit_width
= 200;
14517 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
14518 "*Non-nil means highlight region even in nonselected windows.");
14519 highlight_nonselected_windows
= 0;
14521 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
14522 "Non-nil if more than one frame is visible on this display.\n\
14523 Minibuffer-only frames don't count, but iconified frames do.\n\
14524 This variable is not guaranteed to be accurate except while processing\n\
14525 `frame-title-format' and `icon-title-format'.");
14527 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
14528 "Template for displaying the title bar of visible frames.\n\
14529 \(Assuming the window manager supports this feature.)\n\
14530 This variable has the same structure as `mode-line-format' (which see),\n\
14531 and is used only on frames for which no explicit name has been set\n\
14532 \(see `modify-frame-parameters').");
14533 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
14534 "Template for displaying the title bar of an iconified frame.\n\
14535 \(Assuming the window manager supports this feature.)\n\
14536 This variable has the same structure as `mode-line-format' (which see),\n\
14537 and is used only on frames for which no explicit name has been set\n\
14538 \(see `modify-frame-parameters').");
14540 = Vframe_title_format
14541 = Fcons (intern ("multiple-frames"),
14542 Fcons (build_string ("%b"),
14543 Fcons (Fcons (build_string (""),
14544 Fcons (intern ("invocation-name"),
14545 Fcons (build_string ("@"),
14546 Fcons (intern ("system-name"),
14550 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
14551 "Maximum number of lines to keep in the message log buffer.\n\
14552 If nil, disable message logging. If t, log messages but don't truncate\n\
14553 the buffer when it becomes large.");
14554 Vmessage_log_max
= make_number (50);
14556 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
14557 "Functions called before redisplay, if window sizes have changed.\n\
14558 The value should be a list of functions that take one argument.\n\
14559 Just before redisplay, for each frame, if any of its windows have changed\n\
14560 size since the last redisplay, or have been split or deleted,\n\
14561 all the functions in the list are called, with the frame as argument.");
14562 Vwindow_size_change_functions
= Qnil
;
14564 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
14565 "List of Functions to call before redisplaying a window with scrolling.\n\
14566 Each function is called with two arguments, the window\n\
14567 and its new display-start position. Note that the value of `window-end'\n\
14568 is not valid when these functions are called.");
14569 Vwindow_scroll_functions
= Qnil
;
14571 DEFVAR_BOOL ("auto-resize-tool-bars", &auto_resize_tool_bars_p
,
14572 "*Non-nil means automatically resize tool-bars.\n\
14573 This increases a tool-bar's height if not all tool-bar items are visible.\n\
14574 It decreases a tool-bar's height when it would display blank lines\n\
14576 auto_resize_tool_bars_p
= 1;
14578 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
14579 "*Non-nil means raise tool-bar buttons when the mouse moves over them.");
14580 auto_raise_tool_bar_buttons_p
= 1;
14582 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
14583 "*Margin around tool-bar buttons in pixels.\n\
14584 If an integer, use that for both horizontal and vertical margins.\n\
14585 Otherwise, value should be a pair of integers `(HORZ : VERT)' with\n\
14586 HORZ specifying the horizontal margin, and VERT specifying the\n\
14587 vertical margin.");
14588 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
14590 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
14591 "Relief thickness of tool-bar buttons.");
14592 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
14594 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
14595 "List of functions to call to fontify regions of text.\n\
14596 Each function is called with one argument POS. Functions must\n\
14597 fontify a region starting at POS in the current buffer, and give\n\
14598 fontified regions the property `fontified'.\n\
14599 This variable automatically becomes buffer-local when set.");
14600 Vfontification_functions
= Qnil
;
14601 Fmake_variable_buffer_local (Qfontification_functions
);
14603 DEFVAR_BOOL ("unibyte-display-via-language-environment",
14604 &unibyte_display_via_language_environment
,
14605 "*Non-nil means display unibyte text according to language environment.\n\
14606 Specifically this means that unibyte non-ASCII characters\n\
14607 are displayed by converting them to the equivalent multibyte characters\n\
14608 according to the current language environment. As a result, they are\n\
14609 displayed according to the current fontset.");
14610 unibyte_display_via_language_environment
= 0;
14612 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
14613 "*Maximum height for resizing mini-windows.\n\
14614 If a float, it specifies a fraction of the mini-window frame's height.\n\
14615 If an integer, it specifies a number of lines.");
14616 Vmax_mini_window_height
= make_float (0.25);
14618 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
14619 "*How to resize mini-windows.\n\
14620 A value of nil means don't automatically resize mini-windows.\n\
14621 A value of t means resize them to fit the text displayed in them.\n\
14622 A value of `grow-only', the default, means let mini-windows grow\n\
14623 only, until their display becomes empty, at which point the windows\n\
14624 go back to their normal size.");
14625 Vresize_mini_windows
= Qgrow_only
;
14627 DEFVAR_BOOL ("cursor-in-non-selected-windows",
14628 &cursor_in_non_selected_windows
,
14629 "*Non-nil means display a hollow cursor in non-selected windows.\n\
14630 Nil means don't display a cursor there.");
14631 cursor_in_non_selected_windows
= 1;
14633 DEFVAR_BOOL ("automatic-hscrolling", &automatic_hscrolling_p
,
14634 "*Non-nil means scroll the display automatically to make point visible.");
14635 automatic_hscrolling_p
= 1;
14637 DEFVAR_LISP ("image-types", &Vimage_types
,
14638 "List of supported image types.\n\
14639 Each element of the list is a symbol for a supported image type.");
14640 Vimage_types
= Qnil
;
14642 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
14643 "If non-nil, messages are truncated instead of resizing the echo area.\n\
14644 Bind this around calls to `message' to let it take effect.");
14645 message_truncate_lines
= 0;
14647 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
14648 "Normal hook run for clicks on menu bar, before displaying a submenu.\n\
14649 Can be used to update submenus whose contents should vary.");
14650 Vmenu_bar_update_hook
= Qnil
;
14652 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
14653 "Non-nil means don't update menu bars. Internal use only.");
14654 inhibit_menubar_update
= 0;
14656 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
14657 "Non-nil means don't eval Lisp during redisplay.");
14658 inhibit_eval_during_redisplay
= 0;
14662 /* Initialize this module when Emacs starts. */
14667 Lisp_Object root_window
;
14668 struct window
*mini_w
;
14670 current_header_line_height
= current_mode_line_height
= -1;
14672 CHARPOS (this_line_start_pos
) = 0;
14674 mini_w
= XWINDOW (minibuf_window
);
14675 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
14677 if (!noninteractive
)
14679 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
14682 XWINDOW (root_window
)->top
= make_number (FRAME_TOP_MARGIN (f
));
14683 set_window_height (root_window
,
14684 FRAME_HEIGHT (f
) - 1 - FRAME_TOP_MARGIN (f
),
14686 mini_w
->top
= make_number (FRAME_HEIGHT (f
) - 1);
14687 set_window_height (minibuf_window
, 1, 0);
14689 XWINDOW (root_window
)->width
= make_number (FRAME_WIDTH (f
));
14690 mini_w
->width
= make_number (FRAME_WIDTH (f
));
14692 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
14693 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
14694 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
14696 /* The default ellipsis glyphs `...'. */
14697 for (i
= 0; i
< 3; ++i
)
14698 default_invis_vector
[i
] = make_number ('.');
14701 #ifdef HAVE_WINDOW_SYSTEM
14703 /* Allocate the buffer for frame titles. */
14705 frame_title_buf
= (char *) xmalloc (size
);
14706 frame_title_buf_end
= frame_title_buf
+ size
;
14707 frame_title_ptr
= NULL
;
14709 #endif /* HAVE_WINDOW_SYSTEM */
14711 help_echo_showing_p
= 0;