1 /* Display generation from window structure and buffer text.
2 Copyright (C) 1985, 86, 87, 88, 93, 94, 95, 97, 98, 99, 2000, 2001
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
26 Emacs separates the task of updating the display from code
27 modifying global state, e.g. buffer text. This way functions
28 operating on buffers don't also have to be concerned with updating
31 Updating the display is triggered by the Lisp interpreter when it
32 decides it's time to do it. This is done either automatically for
33 you as part of the interpreter's command loop or as the result of
34 calling Lisp functions like `sit-for'. The C function `redisplay'
35 in xdisp.c is the only entry into the inner redisplay code. (Or,
36 let's say almost---see the the description of direct update
39 The following diagram shows how redisplay code is invoked. As you
40 can see, Lisp calls redisplay and vice versa. Under window systems
41 like X, some portions of the redisplay code are also called
42 asynchronously during mouse movement or expose events. It is very
43 important that these code parts do NOT use the C library (malloc,
44 free) because many C libraries under Unix are not reentrant. They
45 may also NOT call functions of the Lisp interpreter which could
46 change the interpreter's state. If you don't follow these rules,
47 you will encounter bugs which are very hard to explain.
49 (Direct functions, see below)
50 direct_output_for_insert,
51 direct_forward_char (dispnew.c)
52 +---------------------------------+
55 +--------------+ redisplay() +----------------+
56 | Lisp machine |---------------->| Redisplay code |<--+
57 +--------------+ (xdisp.c) +----------------+ |
59 +----------------------------------+ |
60 Don't use this path when called |
63 expose_window (asynchronous) |
65 X expose events -----+
67 What does redisplay? Obviously, it has to figure out somehow what
68 has been changed since the last time the display has been updated,
69 and to make these changes visible. Preferably it would do that in
70 a moderately intelligent way, i.e. fast.
72 Changes in buffer text can be deduced from window and buffer
73 structures, and from some global variables like `beg_unchanged' and
74 `end_unchanged'. The contents of the display are additionally
75 recorded in a `glyph matrix', a two-dimensional matrix of glyph
76 structures. Each row in such a matrix corresponds to a line on the
77 display, and each glyph in a row corresponds to a column displaying
78 a character, an image, or what else. This matrix is called the
79 `current glyph matrix' or `current matrix' in redisplay
82 For buffer parts that have been changed since the last update, a
83 second glyph matrix is constructed, the so called `desired glyph
84 matrix' or short `desired matrix'. Current and desired matrix are
85 then compared to find a cheap way to update the display, e.g. by
86 reusing part of the display by scrolling lines.
91 You will find a lot of of redisplay optimizations when you start
92 looking at the innards of redisplay. The overall goal of all these
93 optimizations is to make redisplay fast because it is done
96 Two optimizations are not found in xdisp.c. These are the direct
97 operations mentioned above. As the name suggests they follow a
98 different principle than the rest of redisplay. Instead of
99 building a desired matrix and then comparing it with the current
100 display, they perform their actions directly on the display and on
103 One direct operation updates the display after one character has
104 been entered. The other one moves the cursor by one position
105 forward or backward. You find these functions under the names
106 `direct_output_for_insert' and `direct_output_forward_char' in
112 Desired matrices are always built per Emacs window. The function
113 `display_line' is the central function to look at if you are
114 interested. It constructs one row in a desired matrix given an
115 iterator structure containing both a buffer position and a
116 description of the environment in which the text is to be
117 displayed. But this is too early, read on.
119 Characters and pixmaps displayed for a range of buffer text depend
120 on various settings of buffers and windows, on overlays and text
121 properties, on display tables, on selective display. The good news
122 is that all this hairy stuff is hidden behind a small set of
123 interface functions taking a iterator structure (struct it)
126 Iteration over things to be be displayed is then simple. It is
127 started by initializing an iterator with a call to init_iterator
128 (or init_string_iterator for that matter). Calls to
129 get_next_display_element fill the iterator structure with relevant
130 information about the next thing to display. Calls to
131 set_iterator_to_next move the iterator to the next thing.
133 Besides this, an iterator also contains information about the
134 display environment in which glyphs for display elements are to be
135 produced. It has fields for the width and height of the display,
136 the information whether long lines are truncated or continued, a
137 current X and Y position, and lots of other stuff you can better
140 Glyphs in a desired matrix are normally constructed in a loop
141 calling get_next_display_element and then produce_glyphs. The call
142 to produce_glyphs will fill the iterator structure with pixel
143 information about the element being displayed and at the same time
144 produce glyphs for it. If the display element fits on the line
145 being displayed, set_iterator_to_next is called next, otherwise the
146 glyphs produced are discarded.
151 That just couldn't be all, could it? What about terminal types not
152 supporting operations on sub-windows of the screen? To update the
153 display on such a terminal, window-based glyph matrices are not
154 well suited. To be able to reuse part of the display (scrolling
155 lines up and down), we must instead have a view of the whole
156 screen. This is what `frame matrices' are for. They are a trick.
158 Frames on terminals like above have a glyph pool. Windows on such
159 a frame sub-allocate their glyph memory from their frame's glyph
160 pool. The frame itself is given its own glyph matrices. By
161 coincidence---or maybe something else---rows in window glyph
162 matrices are slices of corresponding rows in frame matrices. Thus
163 writing to window matrices implicitly updates a frame matrix which
164 provides us with the view of the whole screen that we originally
165 wanted to have without having to move many bytes around. To be
166 honest, there is a little bit more done, but not much more. If you
167 plan to extend that code, take a look at dispnew.c. The function
168 build_frame_matrix is a good starting point. */
173 #include "keyboard.h"
176 #include "termchar.h"
177 #include "dispextern.h"
181 #include "commands.h"
184 #include "termhooks.h"
185 #include "intervals.h"
188 #include "region-cache.h"
191 #ifdef HAVE_X_WINDOWS
201 #define min(a, b) ((a) < (b) ? (a) : (b))
202 #define max(a, b) ((a) > (b) ? (a) : (b))
204 #define INFINITY 10000000
206 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (macintosh)
207 extern void set_frame_menubar
P_ ((struct frame
*f
, int, int));
208 extern int pending_menu_activation
;
211 extern int interrupt_input
;
212 extern int command_loop_level
;
214 extern int minibuffer_auto_raise
;
216 extern Lisp_Object Qface
;
218 extern Lisp_Object Voverriding_local_map
;
219 extern Lisp_Object Voverriding_local_map_menu_flag
;
220 extern Lisp_Object Qmenu_item
;
222 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
223 Lisp_Object Qwindow_scroll_functions
, Vwindow_scroll_functions
;
224 Lisp_Object Qredisplay_end_trigger_functions
;
225 Lisp_Object Qinhibit_point_motion_hooks
;
226 Lisp_Object QCeval
, Qwhen
, QCfile
, QCdata
;
227 Lisp_Object Qfontified
;
228 Lisp_Object Qgrow_only
;
230 /* Functions called to fontify regions of text. */
232 Lisp_Object Vfontification_functions
;
233 Lisp_Object Qfontification_functions
;
235 /* Non-zero means draw tool bar buttons raised when the mouse moves
238 int auto_raise_tool_bar_buttons_p
;
240 /* Margin around tool bar buttons in pixels. */
242 int tool_bar_button_margin
;
244 /* Thickness of shadow to draw around tool bar buttons. */
246 int tool_bar_button_relief
;
248 /* Non-zero means automatically resize tool-bars so that all tool-bar
249 items are visible, and no blank lines remain. */
251 int auto_resize_tool_bars_p
;
253 /* Non-nil means don't actually do any redisplay. */
255 Lisp_Object Vinhibit_redisplay
, Qinhibit_redisplay
;
257 /* Names of text properties relevant for redisplay. */
259 Lisp_Object Qdisplay
, Qrelative_width
, Qalign_to
;
260 extern Lisp_Object Qface
, Qinvisible
, Qimage
, Qwidth
;
262 /* Symbols used in text property values. */
264 Lisp_Object Qspace
, QCalign_to
, QCrelative_width
, QCrelative_height
;
265 Lisp_Object Qleft_margin
, Qright_margin
, Qspace_width
, Qraise
;
267 extern Lisp_Object Qheight
;
269 /* Non-nil means highlight trailing whitespace. */
271 Lisp_Object Vshow_trailing_whitespace
;
273 /* Name of the face used to highlight trailing whitespace. */
275 Lisp_Object Qtrailing_whitespace
;
277 /* The symbol `image' which is the car of the lists used to represent
282 /* Non-zero means print newline to stdout before next mini-buffer
285 int noninteractive_need_newline
;
287 /* Non-zero means print newline to message log before next message. */
289 static int message_log_need_newline
;
292 /* The buffer position of the first character appearing entirely or
293 partially on the line of the selected window which contains the
294 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
295 redisplay optimization in redisplay_internal. */
297 static struct text_pos this_line_start_pos
;
299 /* Number of characters past the end of the line above, including the
300 terminating newline. */
302 static struct text_pos this_line_end_pos
;
304 /* The vertical positions and the height of this line. */
306 static int this_line_vpos
;
307 static int this_line_y
;
308 static int this_line_pixel_height
;
310 /* X position at which this display line starts. Usually zero;
311 negative if first character is partially visible. */
313 static int this_line_start_x
;
315 /* Buffer that this_line_.* variables are referring to. */
317 static struct buffer
*this_line_buffer
;
319 /* Nonzero means truncate lines in all windows less wide than the
322 int truncate_partial_width_windows
;
324 /* A flag to control how to display unibyte 8-bit character. */
326 int unibyte_display_via_language_environment
;
328 /* Nonzero means we have more than one non-mini-buffer-only frame.
329 Not guaranteed to be accurate except while parsing
330 frame-title-format. */
334 Lisp_Object Vglobal_mode_string
;
336 /* Marker for where to display an arrow on top of the buffer text. */
338 Lisp_Object Voverlay_arrow_position
;
340 /* String to display for the arrow. Only used on terminal frames. */
342 Lisp_Object Voverlay_arrow_string
;
344 /* Values of those variables at last redisplay. However, if
345 Voverlay_arrow_position is a marker, last_arrow_position is its
346 numerical position. */
348 static Lisp_Object last_arrow_position
, last_arrow_string
;
350 /* Like mode-line-format, but for the title bar on a visible frame. */
352 Lisp_Object Vframe_title_format
;
354 /* Like mode-line-format, but for the title bar on an iconified frame. */
356 Lisp_Object Vicon_title_format
;
358 /* List of functions to call when a window's size changes. These
359 functions get one arg, a frame on which one or more windows' sizes
362 static Lisp_Object Vwindow_size_change_functions
;
364 Lisp_Object Qmenu_bar_update_hook
, Vmenu_bar_update_hook
;
366 /* Nonzero if overlay arrow has been displayed once in this window. */
368 static int overlay_arrow_seen
;
370 /* Nonzero means highlight the region even in nonselected windows. */
372 int highlight_nonselected_windows
;
374 /* If cursor motion alone moves point off frame, try scrolling this
375 many lines up or down if that will bring it back. */
377 static int scroll_step
;
379 /* Non-0 means scroll just far enough to bring point back on the
380 screen, when appropriate. */
382 static int scroll_conservatively
;
384 /* Recenter the window whenever point gets within this many lines of
385 the top or bottom of the window. This value is translated into a
386 pixel value by multiplying it with CANON_Y_UNIT, which means that
387 there is really a fixed pixel height scroll margin. */
391 /* Number of windows showing the buffer of the selected window (or
392 another buffer with the same base buffer). keyboard.c refers to
397 /* Vector containing glyphs for an ellipsis `...'. */
399 static Lisp_Object default_invis_vector
[3];
401 /* Zero means display the mode-line/header-line/menu-bar in the default face
402 (this slightly odd definition is for compatibility with previous versions
403 of emacs), non-zero means display them using their respective faces.
405 This variable is deprecated. */
407 int mode_line_inverse_video
;
409 /* Prompt to display in front of the mini-buffer contents. */
411 Lisp_Object minibuf_prompt
;
413 /* Width of current mini-buffer prompt. Only set after display_line
414 of the line that contains the prompt. */
416 int minibuf_prompt_width
;
417 int minibuf_prompt_pixel_width
;
419 /* This is the window where the echo area message was displayed. It
420 is always a mini-buffer window, but it may not be the same window
421 currently active as a mini-buffer. */
423 Lisp_Object echo_area_window
;
425 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
426 pushes the current message and the value of
427 message_enable_multibyte on the stack, the function restore_message
428 pops the stack and displays MESSAGE again. */
430 Lisp_Object Vmessage_stack
;
432 /* Nonzero means multibyte characters were enabled when the echo area
433 message was specified. */
435 int message_enable_multibyte
;
437 /* True if we should redraw the mode lines on the next redisplay. */
439 int update_mode_lines
;
441 /* Nonzero if window sizes or contents have changed since last
442 redisplay that finished */
444 int windows_or_buffers_changed
;
446 /* Nonzero after display_mode_line if %l was used and it displayed a
449 int line_number_displayed
;
451 /* Maximum buffer size for which to display line numbers. */
453 Lisp_Object Vline_number_display_limit
;
455 /* line width to consider when repostioning for line number display */
457 static int line_number_display_limit_width
;
459 /* Number of lines to keep in the message log buffer. t means
460 infinite. nil means don't log at all. */
462 Lisp_Object Vmessage_log_max
;
464 /* The name of the *Messages* buffer, a string. */
466 static Lisp_Object Vmessages_buffer_name
;
468 /* Current, index 0, and last displayed echo area message. Either
469 buffers from echo_buffers, or nil to indicate no message. */
471 Lisp_Object echo_area_buffer
[2];
473 /* The buffers referenced from echo_area_buffer. */
475 static Lisp_Object echo_buffer
[2];
477 /* A vector saved used in with_area_buffer to reduce consing. */
479 static Lisp_Object Vwith_echo_area_save_vector
;
481 /* Non-zero means display_echo_area should display the last echo area
482 message again. Set by redisplay_preserve_echo_area. */
484 static int display_last_displayed_message_p
;
486 /* Nonzero if echo area is being used by print; zero if being used by
489 int message_buf_print
;
491 /* Maximum height for resizing mini-windows. Either a float
492 specifying a fraction of the available height, or an integer
493 specifying a number of lines. */
495 Lisp_Object Vmax_mini_window_height
;
497 /* Non-zero means messages should be displayed with truncated
498 lines instead of being continued. */
500 int message_truncate_lines
;
501 Lisp_Object Qmessage_truncate_lines
;
503 /* Non-zero means we want a hollow cursor in windows that are not
504 selected. Zero means there's no cursor in such windows. */
506 int cursor_in_non_selected_windows
;
508 /* A scratch glyph row with contents used for generating truncation
509 glyphs. Also used in direct_output_for_insert. */
511 #define MAX_SCRATCH_GLYPHS 100
512 struct glyph_row scratch_glyph_row
;
513 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
515 /* Ascent and height of the last line processed by move_it_to. */
517 static int last_max_ascent
, last_height
;
519 /* Non-zero if there's a help-echo in the echo area. */
521 int help_echo_showing_p
;
523 /* If >= 0, computed, exact values of mode-line and header-line height
524 to use in the macros CURRENT_MODE_LINE_HEIGHT and
525 CURRENT_HEADER_LINE_HEIGHT. */
527 int current_mode_line_height
, current_header_line_height
;
529 /* The maximum distance to look ahead for text properties. Values
530 that are too small let us call compute_char_face and similar
531 functions too often which is expensive. Values that are too large
532 let us call compute_char_face and alike too often because we
533 might not be interested in text properties that far away. */
535 #define TEXT_PROP_DISTANCE_LIMIT 100
539 /* Non-zero means print traces of redisplay if compiled with
542 int trace_redisplay_p
;
544 #endif /* GLYPH_DEBUG */
546 #ifdef DEBUG_TRACE_MOVE
547 /* Non-zero means trace with TRACE_MOVE to stderr. */
550 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
552 #define TRACE_MOVE(x) (void) 0
555 /* Non-zero means automatically scroll windows horizontally to make
558 int automatic_hscrolling_p
;
560 /* A list of symbols, one for each supported image type. */
562 Lisp_Object Vimage_types
;
564 /* The variable `resize-mini-windows'. If nil, don't resize
565 mini-windows. If t, always resize them to fit the text they
566 display. If `grow-only', let mini-windows grow only until they
569 Lisp_Object Vresize_mini_windows
;
571 /* Value returned from text property handlers (see below). */
576 HANDLED_RECOMPUTE_PROPS
,
577 HANDLED_OVERLAY_STRING_CONSUMED
,
581 /* A description of text properties that redisplay is interested
586 /* The name of the property. */
589 /* A unique index for the property. */
592 /* A handler function called to set up iterator IT from the property
593 at IT's current position. Value is used to steer handle_stop. */
594 enum prop_handled (*handler
) P_ ((struct it
*it
));
597 static enum prop_handled handle_face_prop
P_ ((struct it
*));
598 static enum prop_handled handle_invisible_prop
P_ ((struct it
*));
599 static enum prop_handled handle_display_prop
P_ ((struct it
*));
600 static enum prop_handled handle_composition_prop
P_ ((struct it
*));
601 static enum prop_handled handle_overlay_change
P_ ((struct it
*));
602 static enum prop_handled handle_fontified_prop
P_ ((struct it
*));
604 /* Properties handled by iterators. */
606 static struct props it_props
[] =
608 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
609 /* Handle `face' before `display' because some sub-properties of
610 `display' need to know the face. */
611 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
612 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
613 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
614 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
618 /* Value is the position described by X. If X is a marker, value is
619 the marker_position of X. Otherwise, value is X. */
621 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
623 /* Enumeration returned by some move_it_.* functions internally. */
627 /* Not used. Undefined value. */
630 /* Move ended at the requested buffer position or ZV. */
631 MOVE_POS_MATCH_OR_ZV
,
633 /* Move ended at the requested X pixel position. */
636 /* Move within a line ended at the end of a line that must be
640 /* Move within a line ended at the end of a line that would
641 be displayed truncated. */
644 /* Move within a line ended at a line end. */
650 /* Function prototypes. */
652 static int cursor_row_p
P_ ((struct window
*, struct glyph_row
*));
653 static int redisplay_mode_lines
P_ ((Lisp_Object
, int));
654 static char *decode_mode_spec_coding
P_ ((Lisp_Object
, char *, int));
655 static int invisible_text_between_p
P_ ((struct it
*, int, int));
656 static int next_element_from_ellipsis
P_ ((struct it
*));
657 static void pint2str
P_ ((char *, int, int));
658 static struct text_pos run_window_scroll_functions
P_ ((Lisp_Object
,
660 static void reconsider_clip_changes
P_ ((struct window
*, struct buffer
*));
661 static int text_outside_line_unchanged_p
P_ ((struct window
*, int, int));
662 static void store_frame_title_char
P_ ((char));
663 static int store_frame_title
P_ ((unsigned char *, int, int));
664 static void x_consider_frame_title
P_ ((Lisp_Object
));
665 static void handle_stop
P_ ((struct it
*));
666 static int tool_bar_lines_needed
P_ ((struct frame
*));
667 static int single_display_prop_intangible_p
P_ ((Lisp_Object
));
668 static void ensure_echo_area_buffers
P_ ((void));
669 static struct glyph_row
*row_containing_pos
P_ ((struct window
*, int,
671 struct glyph_row
*));
672 static Lisp_Object unwind_with_echo_area_buffer
P_ ((Lisp_Object
));
673 static Lisp_Object with_echo_area_buffer_unwind_data
P_ ((struct window
*));
674 static int with_echo_area_buffer
P_ ((struct window
*, int,
675 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
676 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
677 static void clear_garbaged_frames
P_ ((void));
678 static int current_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
679 static int truncate_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
680 static int set_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
681 static int display_echo_area
P_ ((struct window
*));
682 static int display_echo_area_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
683 static int resize_mini_window_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
684 static Lisp_Object unwind_redisplay
P_ ((Lisp_Object
));
685 static int string_char_and_length
P_ ((unsigned char *, int, int *));
686 static struct text_pos display_prop_end
P_ ((struct it
*, Lisp_Object
,
688 static int compute_window_start_on_continuation_line
P_ ((struct window
*));
689 static Lisp_Object safe_eval_handler
P_ ((Lisp_Object
));
690 static void insert_left_trunc_glyphs
P_ ((struct it
*));
691 static struct glyph_row
*get_overlay_arrow_glyph_row
P_ ((struct window
*));
692 static void extend_face_to_end_of_line
P_ ((struct it
*));
693 static int append_space
P_ ((struct it
*, int));
694 static void make_cursor_line_fully_visible
P_ ((struct window
*));
695 static int try_scrolling
P_ ((Lisp_Object
, int, int, int, int));
696 static int try_cursor_movement
P_ ((Lisp_Object
, struct text_pos
, int *));
697 static int trailing_whitespace_p
P_ ((int));
698 static int message_log_check_duplicate
P_ ((int, int, int, int));
699 int invisible_p
P_ ((Lisp_Object
, Lisp_Object
));
700 int invisible_ellipsis_p
P_ ((Lisp_Object
, Lisp_Object
));
701 static void push_it
P_ ((struct it
*));
702 static void pop_it
P_ ((struct it
*));
703 static void sync_frame_with_window_matrix_rows
P_ ((struct window
*));
704 static void redisplay_internal
P_ ((int));
705 static int echo_area_display
P_ ((int));
706 static void redisplay_windows
P_ ((Lisp_Object
));
707 static void redisplay_window
P_ ((Lisp_Object
, int));
708 static void update_menu_bar
P_ ((struct frame
*, int));
709 static int try_window_reusing_current_matrix
P_ ((struct window
*));
710 static int try_window_id
P_ ((struct window
*));
711 static int display_line
P_ ((struct it
*));
712 static int display_mode_lines
P_ ((struct window
*));
713 static int display_mode_line
P_ ((struct window
*, enum face_id
, Lisp_Object
));
714 static int display_mode_element
P_ ((struct it
*, int, int, int, Lisp_Object
));
715 static char *decode_mode_spec
P_ ((struct window
*, int, int, int));
716 static void display_menu_bar
P_ ((struct window
*));
717 static int display_count_lines
P_ ((int, int, int, int, int *));
718 static int display_string
P_ ((unsigned char *, Lisp_Object
, Lisp_Object
,
719 int, int, struct it
*, int, int, int, int));
720 static void compute_line_metrics
P_ ((struct it
*));
721 static void run_redisplay_end_trigger_hook
P_ ((struct it
*));
722 static int get_overlay_strings
P_ ((struct it
*));
723 static void next_overlay_string
P_ ((struct it
*));
724 static void reseat
P_ ((struct it
*, struct text_pos
, int));
725 static void reseat_1
P_ ((struct it
*, struct text_pos
, int));
726 static void back_to_previous_visible_line_start
P_ ((struct it
*));
727 static void reseat_at_previous_visible_line_start
P_ ((struct it
*));
728 static void reseat_at_next_visible_line_start
P_ ((struct it
*, int));
729 static int next_element_from_display_vector
P_ ((struct it
*));
730 static int next_element_from_string
P_ ((struct it
*));
731 static int next_element_from_c_string
P_ ((struct it
*));
732 static int next_element_from_buffer
P_ ((struct it
*));
733 static int next_element_from_composition
P_ ((struct it
*));
734 static int next_element_from_image
P_ ((struct it
*));
735 static int next_element_from_stretch
P_ ((struct it
*));
736 static void load_overlay_strings
P_ ((struct it
*));
737 static void init_from_display_pos
P_ ((struct it
*, struct window
*,
738 struct display_pos
*));
739 static void reseat_to_string
P_ ((struct it
*, unsigned char *,
740 Lisp_Object
, int, int, int, int));
741 static enum move_it_result move_it_in_display_line_to
P_ ((struct it
*,
743 void move_it_vertically_backward
P_ ((struct it
*, int));
744 static void init_to_row_start
P_ ((struct it
*, struct window
*,
745 struct glyph_row
*));
746 static void init_to_row_end
P_ ((struct it
*, struct window
*,
747 struct glyph_row
*));
748 static void back_to_previous_line_start
P_ ((struct it
*));
749 static int forward_to_next_line_start
P_ ((struct it
*, int *));
750 static struct text_pos string_pos_nchars_ahead
P_ ((struct text_pos
,
752 static struct text_pos string_pos
P_ ((int, Lisp_Object
));
753 static struct text_pos c_string_pos
P_ ((int, unsigned char *, int));
754 static int number_of_chars
P_ ((unsigned char *, int));
755 static void compute_stop_pos
P_ ((struct it
*));
756 static void compute_string_pos
P_ ((struct text_pos
*, struct text_pos
,
758 static int face_before_or_after_it_pos
P_ ((struct it
*, int));
759 static int next_overlay_change
P_ ((int));
760 static int handle_single_display_prop
P_ ((struct it
*, Lisp_Object
,
761 Lisp_Object
, struct text_pos
*));
762 static int underlying_face_id
P_ ((struct it
*));
764 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
765 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
767 #ifdef HAVE_WINDOW_SYSTEM
769 static void update_tool_bar
P_ ((struct frame
*, int));
770 static void build_desired_tool_bar_string
P_ ((struct frame
*f
));
771 static int redisplay_tool_bar
P_ ((struct frame
*));
772 static void display_tool_bar_line
P_ ((struct it
*));
774 #endif /* HAVE_WINDOW_SYSTEM */
777 /***********************************************************************
778 Window display dimensions
779 ***********************************************************************/
781 /* Return the window-relative maximum y + 1 for glyph rows displaying
782 text in window W. This is the height of W minus the height of a
783 mode line, if any. */
786 window_text_bottom_y (w
)
789 struct frame
*f
= XFRAME (w
->frame
);
790 int height
= XFASTINT (w
->height
) * CANON_Y_UNIT (f
);
792 if (WINDOW_WANTS_MODELINE_P (w
))
793 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
798 /* Return the pixel width of display area AREA of window W. AREA < 0
799 means return the total width of W, not including bitmap areas to
800 the left and right of the window. */
803 window_box_width (w
, area
)
807 struct frame
*f
= XFRAME (w
->frame
);
808 int width
= XFASTINT (w
->width
);
810 if (!w
->pseudo_window_p
)
812 width
-= FRAME_SCROLL_BAR_WIDTH (f
) + FRAME_FLAGS_AREA_COLS (f
);
814 if (area
== TEXT_AREA
)
816 if (INTEGERP (w
->left_margin_width
))
817 width
-= XFASTINT (w
->left_margin_width
);
818 if (INTEGERP (w
->right_margin_width
))
819 width
-= XFASTINT (w
->right_margin_width
);
821 else if (area
== LEFT_MARGIN_AREA
)
822 width
= (INTEGERP (w
->left_margin_width
)
823 ? XFASTINT (w
->left_margin_width
) : 0);
824 else if (area
== RIGHT_MARGIN_AREA
)
825 width
= (INTEGERP (w
->right_margin_width
)
826 ? XFASTINT (w
->right_margin_width
) : 0);
829 return width
* CANON_X_UNIT (f
);
833 /* Return the pixel height of the display area of window W, not
834 including mode lines of W, if any.. */
837 window_box_height (w
)
840 struct frame
*f
= XFRAME (w
->frame
);
841 int height
= XFASTINT (w
->height
) * CANON_Y_UNIT (f
);
843 xassert (height
>= 0);
845 /* Note: the code below that determines the mode-line/header-line
846 height is essentially the same as that contained in the macro
847 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
848 the appropriate glyph row has its `mode_line_p' flag set,
849 and if it doesn't, uses estimate_mode_line_height instead. */
851 if (WINDOW_WANTS_MODELINE_P (w
))
853 struct glyph_row
*ml_row
854 = (w
->current_matrix
&& w
->current_matrix
->rows
855 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
857 if (ml_row
&& ml_row
->mode_line_p
)
858 height
-= ml_row
->height
;
860 height
-= estimate_mode_line_height (f
, MODE_LINE_FACE_ID
);
863 if (WINDOW_WANTS_HEADER_LINE_P (w
))
865 struct glyph_row
*hl_row
866 = (w
->current_matrix
&& w
->current_matrix
->rows
867 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
869 if (hl_row
&& hl_row
->mode_line_p
)
870 height
-= hl_row
->height
;
872 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
879 /* Return the frame-relative coordinate of the left edge of display
880 area AREA of window W. AREA < 0 means return the left edge of the
881 whole window, to the right of any bitmap area at the left side of
885 window_box_left (w
, area
)
889 struct frame
*f
= XFRAME (w
->frame
);
890 int x
= FRAME_INTERNAL_BORDER_WIDTH_SAFE (f
);
892 if (!w
->pseudo_window_p
)
894 x
+= (WINDOW_LEFT_MARGIN (w
) * CANON_X_UNIT (f
)
895 + FRAME_LEFT_FLAGS_AREA_WIDTH (f
));
897 if (area
== TEXT_AREA
)
898 x
+= window_box_width (w
, LEFT_MARGIN_AREA
);
899 else if (area
== RIGHT_MARGIN_AREA
)
900 x
+= (window_box_width (w
, LEFT_MARGIN_AREA
)
901 + window_box_width (w
, TEXT_AREA
));
908 /* Return the frame-relative coordinate of the right edge of display
909 area AREA of window W. AREA < 0 means return the left edge of the
910 whole window, to the left of any bitmap area at the right side of
914 window_box_right (w
, area
)
918 return window_box_left (w
, area
) + window_box_width (w
, area
);
922 /* Get the bounding box of the display area AREA of window W, without
923 mode lines, in frame-relative coordinates. AREA < 0 means the
924 whole window, not including bitmap areas to the left and right of
925 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
926 coordinates of the upper-left corner of the box. Return in
927 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
930 window_box (w
, area
, box_x
, box_y
, box_width
, box_height
)
933 int *box_x
, *box_y
, *box_width
, *box_height
;
935 struct frame
*f
= XFRAME (w
->frame
);
937 *box_width
= window_box_width (w
, area
);
938 *box_height
= window_box_height (w
);
939 *box_x
= window_box_left (w
, area
);
940 *box_y
= (FRAME_INTERNAL_BORDER_WIDTH_SAFE (f
)
941 + XFASTINT (w
->top
) * CANON_Y_UNIT (f
));
942 if (WINDOW_WANTS_HEADER_LINE_P (w
))
943 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
947 /* Get the bounding box of the display area AREA of window W, without
948 mode lines. AREA < 0 means the whole window, not including bitmap
949 areas to the left and right of the window. Return in *TOP_LEFT_X
950 and TOP_LEFT_Y the frame-relative pixel coordinates of the
951 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
952 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
956 window_box_edges (w
, area
, top_left_x
, top_left_y
,
957 bottom_right_x
, bottom_right_y
)
960 int *top_left_x
, *top_left_y
, *bottom_right_x
, *bottom_right_y
;
962 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
964 *bottom_right_x
+= *top_left_x
;
965 *bottom_right_y
+= *top_left_y
;
970 /***********************************************************************
972 ***********************************************************************/
974 /* Return 1 if position CHARPOS is visible in window W. Set *FULLY to
975 1 if POS is visible and the line containing POS is fully visible.
976 EXACT_MODE_LINE_HEIGHTS_P non-zero means compute exact mode-line
977 and header-lines heights. */
980 pos_visible_p (w
, charpos
, fully
, exact_mode_line_heights_p
)
982 int charpos
, *fully
, exact_mode_line_heights_p
;
987 struct buffer
*old_buffer
= NULL
;
989 if (XBUFFER (w
->buffer
) != current_buffer
)
991 old_buffer
= current_buffer
;
992 set_buffer_internal_1 (XBUFFER (w
->buffer
));
995 *fully
= visible_p
= 0;
996 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
998 /* Compute exact mode line heights, if requested. */
999 if (exact_mode_line_heights_p
)
1001 if (WINDOW_WANTS_MODELINE_P (w
))
1002 current_mode_line_height
1003 = display_mode_line (w
, MODE_LINE_FACE_ID
,
1004 current_buffer
->mode_line_format
);
1006 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1007 current_header_line_height
1008 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1009 current_buffer
->header_line_format
);
1012 start_display (&it
, w
, top
);
1013 move_it_to (&it
, charpos
, 0, it
.last_visible_y
, -1,
1014 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
1016 /* Note that we may overshoot because of invisible text. */
1017 if (IT_CHARPOS (it
) >= charpos
)
1019 int line_height
, line_bottom_y
;
1020 int line_top_y
= it
.current_y
;
1021 int window_top_y
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
);
1023 line_height
= it
.max_ascent
+ it
.max_descent
;
1024 if (line_height
== 0)
1027 line_height
= last_height
;
1028 else if (charpos
< ZV
)
1030 move_it_by_lines (&it
, 1, 1);
1031 line_height
= (it
.max_ascent
|| it
.max_descent
1032 ? it
.max_ascent
+ it
.max_descent
1037 /* Use the default character height. */
1038 it
.what
= IT_CHARACTER
;
1041 PRODUCE_GLYPHS (&it
);
1042 line_height
= it
.ascent
+ it
.descent
;
1045 line_bottom_y
= line_top_y
+ line_height
;
1047 if (line_top_y
< window_top_y
)
1048 visible_p
= line_bottom_y
> window_top_y
;
1049 else if (line_top_y
< it
.last_visible_y
)
1052 *fully
= line_bottom_y
<= it
.last_visible_y
;
1055 else if (it
.current_y
+ it
.max_ascent
+ it
.max_descent
> it
.last_visible_y
)
1057 move_it_by_lines (&it
, 1, 0);
1058 if (charpos
< IT_CHARPOS (it
))
1066 set_buffer_internal_1 (old_buffer
);
1068 current_header_line_height
= current_mode_line_height
= -1;
1073 /* Return the next character from STR which is MAXLEN bytes long.
1074 Return in *LEN the length of the character. This is like
1075 STRING_CHAR_AND_LENGTH but never returns an invalid character. If
1076 we find one, we return a `?', but with the length of the invalid
1080 string_char_and_length (str
, maxlen
, len
)
1086 c
= STRING_CHAR_AND_LENGTH (str
, maxlen
, *len
);
1087 if (!CHAR_VALID_P (c
, 1))
1088 /* We may not change the length here because other places in Emacs
1089 don't use this function, i.e. they silently accept invalid
1098 /* Given a position POS containing a valid character and byte position
1099 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1101 static struct text_pos
1102 string_pos_nchars_ahead (pos
, string
, nchars
)
1103 struct text_pos pos
;
1107 xassert (STRINGP (string
) && nchars
>= 0);
1109 if (STRING_MULTIBYTE (string
))
1111 int rest
= STRING_BYTES (XSTRING (string
)) - BYTEPOS (pos
);
1112 unsigned char *p
= XSTRING (string
)->data
+ BYTEPOS (pos
);
1117 string_char_and_length (p
, rest
, &len
);
1118 p
+= len
, rest
-= len
;
1119 xassert (rest
>= 0);
1121 BYTEPOS (pos
) += len
;
1125 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1131 /* Value is the text position, i.e. character and byte position,
1132 for character position CHARPOS in STRING. */
1134 static INLINE
struct text_pos
1135 string_pos (charpos
, string
)
1139 struct text_pos pos
;
1140 xassert (STRINGP (string
));
1141 xassert (charpos
>= 0);
1142 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1147 /* Value is a text position, i.e. character and byte position, for
1148 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1149 means recognize multibyte characters. */
1151 static struct text_pos
1152 c_string_pos (charpos
, s
, multibyte_p
)
1157 struct text_pos pos
;
1159 xassert (s
!= NULL
);
1160 xassert (charpos
>= 0);
1164 int rest
= strlen (s
), len
;
1166 SET_TEXT_POS (pos
, 0, 0);
1169 string_char_and_length (s
, rest
, &len
);
1170 s
+= len
, rest
-= len
;
1171 xassert (rest
>= 0);
1173 BYTEPOS (pos
) += len
;
1177 SET_TEXT_POS (pos
, charpos
, charpos
);
1183 /* Value is the number of characters in C string S. MULTIBYTE_P
1184 non-zero means recognize multibyte characters. */
1187 number_of_chars (s
, multibyte_p
)
1195 int rest
= strlen (s
), len
;
1196 unsigned char *p
= (unsigned char *) s
;
1198 for (nchars
= 0; rest
> 0; ++nchars
)
1200 string_char_and_length (p
, rest
, &len
);
1201 rest
-= len
, p
+= len
;
1205 nchars
= strlen (s
);
1211 /* Compute byte position NEWPOS->bytepos corresponding to
1212 NEWPOS->charpos. POS is a known position in string STRING.
1213 NEWPOS->charpos must be >= POS.charpos. */
1216 compute_string_pos (newpos
, pos
, string
)
1217 struct text_pos
*newpos
, pos
;
1220 xassert (STRINGP (string
));
1221 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1223 if (STRING_MULTIBYTE (string
))
1224 *newpos
= string_pos_nchars_ahead (pos
, string
,
1225 CHARPOS (*newpos
) - CHARPOS (pos
));
1227 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1232 /***********************************************************************
1233 Lisp form evaluation
1234 ***********************************************************************/
1236 /* Error handler for safe_eval and safe_call. */
1239 safe_eval_handler (arg
)
1242 add_to_log ("Error during redisplay: %s", arg
, Qnil
);
1247 /* Evaluate SEXPR and return the result, or nil if something went
1254 int count
= BINDING_STACK_SIZE ();
1255 struct gcpro gcpro1
;
1259 specbind (Qinhibit_redisplay
, Qt
);
1260 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
, safe_eval_handler
);
1262 return unbind_to (count
, val
);
1266 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
1267 Return the result, or nil if something went wrong. */
1270 safe_call (nargs
, args
)
1274 int count
= BINDING_STACK_SIZE ();
1276 struct gcpro gcpro1
;
1279 gcpro1
.nvars
= nargs
;
1280 specbind (Qinhibit_redisplay
, Qt
);
1281 val
= internal_condition_case_2 (Ffuncall
, nargs
, args
, Qerror
,
1284 return unbind_to (count
, val
);
1288 /* Call function FN with one argument ARG.
1289 Return the result, or nil if something went wrong. */
1292 safe_call1 (fn
, arg
)
1293 Lisp_Object fn
, arg
;
1295 Lisp_Object args
[2];
1298 return safe_call (2, args
);
1303 /***********************************************************************
1305 ***********************************************************************/
1309 /* Define CHECK_IT to perform sanity checks on iterators.
1310 This is for debugging. It is too slow to do unconditionally. */
1316 if (it
->method
== next_element_from_string
)
1318 xassert (STRINGP (it
->string
));
1319 xassert (IT_STRING_CHARPOS (*it
) >= 0);
1321 else if (it
->method
== next_element_from_buffer
)
1323 /* Check that character and byte positions agree. */
1324 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
1328 xassert (it
->current
.dpvec_index
>= 0);
1330 xassert (it
->current
.dpvec_index
< 0);
1333 #define CHECK_IT(IT) check_it ((IT))
1337 #define CHECK_IT(IT) (void) 0
1344 /* Check that the window end of window W is what we expect it
1345 to be---the last row in the current matrix displaying text. */
1348 check_window_end (w
)
1351 if (!MINI_WINDOW_P (w
)
1352 && !NILP (w
->window_end_valid
))
1354 struct glyph_row
*row
;
1355 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
1356 XFASTINT (w
->window_end_vpos
)),
1358 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
1359 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
1363 #define CHECK_WINDOW_END(W) check_window_end ((W))
1365 #else /* not GLYPH_DEBUG */
1367 #define CHECK_WINDOW_END(W) (void) 0
1369 #endif /* not GLYPH_DEBUG */
1373 /***********************************************************************
1374 Iterator initialization
1375 ***********************************************************************/
1377 /* Initialize IT for displaying current_buffer in window W, starting
1378 at character position CHARPOS. CHARPOS < 0 means that no buffer
1379 position is specified which is useful when the iterator is assigned
1380 a position later. BYTEPOS is the byte position corresponding to
1381 CHARPOS. BYTEPOS <= 0 means compute it from CHARPOS.
1383 If ROW is not null, calls to produce_glyphs with IT as parameter
1384 will produce glyphs in that row.
1386 BASE_FACE_ID is the id of a base face to use. It must be one of
1387 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID or
1388 HEADER_LINE_FACE_ID for displaying mode lines, or TOOL_BAR_FACE_ID for
1389 displaying the tool-bar.
1391 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID or
1392 HEADER_LINE_FACE_ID, the iterator will be initialized to use the
1393 corresponding mode line glyph row of the desired matrix of W. */
1396 init_iterator (it
, w
, charpos
, bytepos
, row
, base_face_id
)
1399 int charpos
, bytepos
;
1400 struct glyph_row
*row
;
1401 enum face_id base_face_id
;
1403 int highlight_region_p
;
1405 /* Some precondition checks. */
1406 xassert (w
!= NULL
&& it
!= NULL
);
1407 xassert (charpos
< 0 || (charpos
> 0 && charpos
<= ZV
));
1409 /* If face attributes have been changed since the last redisplay,
1410 free realized faces now because they depend on face definitions
1411 that might have changed. */
1412 if (face_change_count
)
1414 face_change_count
= 0;
1415 free_all_realized_faces (Qnil
);
1418 /* Use one of the mode line rows of W's desired matrix if
1422 if (base_face_id
== MODE_LINE_FACE_ID
)
1423 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
1424 else if (base_face_id
== HEADER_LINE_FACE_ID
)
1425 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
1429 bzero (it
, sizeof *it
);
1430 it
->current
.overlay_string_index
= -1;
1431 it
->current
.dpvec_index
= -1;
1432 it
->base_face_id
= base_face_id
;
1434 /* The window in which we iterate over current_buffer: */
1435 XSETWINDOW (it
->window
, w
);
1437 it
->f
= XFRAME (w
->frame
);
1439 /* Extra space between lines (on window systems only). */
1440 if (base_face_id
== DEFAULT_FACE_ID
1441 && FRAME_WINDOW_P (it
->f
))
1443 if (NATNUMP (current_buffer
->extra_line_spacing
))
1444 it
->extra_line_spacing
= XFASTINT (current_buffer
->extra_line_spacing
);
1445 else if (it
->f
->extra_line_spacing
> 0)
1446 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
1449 /* If realized faces have been removed, e.g. because of face
1450 attribute changes of named faces, recompute them. When running
1451 in batch mode, the face cache of Vterminal_frame is null. If
1452 we happen to get called, make a dummy face cache. */
1457 FRAME_FACE_CACHE (it
->f
) == NULL
)
1458 init_frame_faces (it
->f
);
1459 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
1460 recompute_basic_faces (it
->f
);
1462 /* Current value of the `space-width', and 'height' properties. */
1463 it
->space_width
= Qnil
;
1464 it
->font_height
= Qnil
;
1466 /* Are control characters displayed as `^C'? */
1467 it
->ctl_arrow_p
= !NILP (current_buffer
->ctl_arrow
);
1469 /* -1 means everything between a CR and the following line end
1470 is invisible. >0 means lines indented more than this value are
1472 it
->selective
= (INTEGERP (current_buffer
->selective_display
)
1473 ? XFASTINT (current_buffer
->selective_display
)
1474 : (!NILP (current_buffer
->selective_display
)
1476 it
->selective_display_ellipsis_p
1477 = !NILP (current_buffer
->selective_display_ellipses
);
1479 /* Display table to use. */
1480 it
->dp
= window_display_table (w
);
1482 /* Are multibyte characters enabled in current_buffer? */
1483 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
1485 /* Non-zero if we should highlight the region. */
1487 = (!NILP (Vtransient_mark_mode
)
1488 && !NILP (current_buffer
->mark_active
)
1489 && XMARKER (current_buffer
->mark
)->buffer
!= 0);
1491 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
1492 start and end of a visible region in window IT->w. Set both to
1493 -1 to indicate no region. */
1494 if (highlight_region_p
1495 /* Maybe highlight only in selected window. */
1496 && (/* Either show region everywhere. */
1497 highlight_nonselected_windows
1498 /* Or show region in the selected window. */
1499 || w
== XWINDOW (selected_window
)
1500 /* Or show the region if we are in the mini-buffer and W is
1501 the window the mini-buffer refers to. */
1502 || (MINI_WINDOW_P (XWINDOW (selected_window
))
1503 && w
== XWINDOW (Vminibuf_scroll_window
))))
1505 int charpos
= marker_position (current_buffer
->mark
);
1506 it
->region_beg_charpos
= min (PT
, charpos
);
1507 it
->region_end_charpos
= max (PT
, charpos
);
1510 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
1512 /* Get the position at which the redisplay_end_trigger hook should
1513 be run, if it is to be run at all. */
1514 if (MARKERP (w
->redisplay_end_trigger
)
1515 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
1516 it
->redisplay_end_trigger_charpos
1517 = marker_position (w
->redisplay_end_trigger
);
1518 else if (INTEGERP (w
->redisplay_end_trigger
))
1519 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
1521 /* Correct bogus values of tab_width. */
1522 it
->tab_width
= XINT (current_buffer
->tab_width
);
1523 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
1526 /* Are lines in the display truncated? */
1527 it
->truncate_lines_p
1528 = (base_face_id
!= DEFAULT_FACE_ID
1529 || XINT (it
->w
->hscroll
)
1530 || (truncate_partial_width_windows
1531 && !WINDOW_FULL_WIDTH_P (it
->w
))
1532 || !NILP (current_buffer
->truncate_lines
));
1534 /* Get dimensions of truncation and continuation glyphs. These are
1535 displayed as bitmaps under X, so we don't need them for such
1537 if (!FRAME_WINDOW_P (it
->f
))
1539 if (it
->truncate_lines_p
)
1541 /* We will need the truncation glyph. */
1542 xassert (it
->glyph_row
== NULL
);
1543 produce_special_glyphs (it
, IT_TRUNCATION
);
1544 it
->truncation_pixel_width
= it
->pixel_width
;
1548 /* We will need the continuation glyph. */
1549 xassert (it
->glyph_row
== NULL
);
1550 produce_special_glyphs (it
, IT_CONTINUATION
);
1551 it
->continuation_pixel_width
= it
->pixel_width
;
1554 /* Reset these values to zero becaue the produce_special_glyphs
1555 above has changed them. */
1556 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
1557 it
->phys_ascent
= it
->phys_descent
= 0;
1560 /* Set this after getting the dimensions of truncation and
1561 continuation glyphs, so that we don't produce glyphs when calling
1562 produce_special_glyphs, above. */
1563 it
->glyph_row
= row
;
1564 it
->area
= TEXT_AREA
;
1566 /* Get the dimensions of the display area. The display area
1567 consists of the visible window area plus a horizontally scrolled
1568 part to the left of the window. All x-values are relative to the
1569 start of this total display area. */
1570 if (base_face_id
!= DEFAULT_FACE_ID
)
1572 /* Mode lines, menu bar in terminal frames. */
1573 it
->first_visible_x
= 0;
1574 it
->last_visible_x
= XFASTINT (w
->width
) * CANON_X_UNIT (it
->f
);
1579 = XFASTINT (it
->w
->hscroll
) * CANON_X_UNIT (it
->f
);
1580 it
->last_visible_x
= (it
->first_visible_x
1581 + window_box_width (w
, TEXT_AREA
));
1583 /* If we truncate lines, leave room for the truncator glyph(s) at
1584 the right margin. Otherwise, leave room for the continuation
1585 glyph(s). Truncation and continuation glyphs are not inserted
1586 for window-based redisplay. */
1587 if (!FRAME_WINDOW_P (it
->f
))
1589 if (it
->truncate_lines_p
)
1590 it
->last_visible_x
-= it
->truncation_pixel_width
;
1592 it
->last_visible_x
-= it
->continuation_pixel_width
;
1595 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
1596 it
->current_y
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
1599 /* Leave room for a border glyph. */
1600 if (!FRAME_WINDOW_P (it
->f
)
1601 && !WINDOW_RIGHTMOST_P (it
->w
))
1602 it
->last_visible_x
-= 1;
1604 it
->last_visible_y
= window_text_bottom_y (w
);
1606 /* For mode lines and alike, arrange for the first glyph having a
1607 left box line if the face specifies a box. */
1608 if (base_face_id
!= DEFAULT_FACE_ID
)
1612 it
->face_id
= base_face_id
;
1614 /* If we have a boxed mode line, make the first character appear
1615 with a left box line. */
1616 face
= FACE_FROM_ID (it
->f
, base_face_id
);
1617 if (face
->box
!= FACE_NO_BOX
)
1618 it
->start_of_box_run_p
= 1;
1621 /* If a buffer position was specified, set the iterator there,
1622 getting overlays and face properties from that position. */
1625 it
->end_charpos
= ZV
;
1627 IT_CHARPOS (*it
) = charpos
;
1629 /* Compute byte position if not specified. */
1631 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
1633 IT_BYTEPOS (*it
) = bytepos
;
1635 /* Compute faces etc. */
1636 reseat (it
, it
->current
.pos
, 1);
1643 /* Initialize IT for the display of window W with window start POS. */
1646 start_display (it
, w
, pos
)
1649 struct text_pos pos
;
1651 int start_at_line_beg_p
;
1652 struct glyph_row
*row
;
1653 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
1656 row
= w
->desired_matrix
->rows
+ first_vpos
;
1657 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
1658 first_y
= it
->current_y
;
1660 /* If window start is not at a line start, move back to the line
1661 start. This makes sure that we take continuation lines into
1663 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
1664 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
1665 if (!start_at_line_beg_p
)
1666 reseat_at_previous_visible_line_start (it
);
1668 /* If window start is not at a line start, skip forward to POS to
1669 get the correct continuation_lines_width and current_x. */
1670 if (!start_at_line_beg_p
)
1672 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
1674 /* If lines are continued, this line may end in the middle of a
1675 multi-glyph character (e.g. a control character displayed as
1676 \003, or in the middle of an overlay string). In this case
1677 move_it_to above will not have taken us to the start of
1678 the continuation line but to the end of the continued line. */
1679 if (!it
->truncate_lines_p
)
1681 if (it
->current_x
> 0)
1683 if (it
->current
.dpvec_index
>= 0
1684 || it
->current
.overlay_string_index
>= 0)
1686 set_iterator_to_next (it
, 1);
1687 move_it_in_display_line_to (it
, -1, -1, 0);
1690 it
->continuation_lines_width
+= it
->current_x
;
1693 /* We're starting a new display line, not affected by the
1694 height of the continued line, so clear the appropriate
1695 fields in the iterator structure. */
1696 it
->max_ascent
= it
->max_descent
= 0;
1697 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
1700 it
->current_y
= first_y
;
1702 it
->current_x
= it
->hpos
= 0;
1705 #if 0 /* Don't assert the following because start_display is sometimes
1706 called intentionally with a window start that is not at a
1707 line start. Please leave this code in as a comment. */
1709 /* Window start should be on a line start, now. */
1710 xassert (it
->continuation_lines_width
1711 || IT_CHARPOS (it
) == BEGV
1712 || FETCH_BYTE (IT_BYTEPOS (it
) - 1) == '\n');
1717 /* Initialize IT for stepping through current_buffer in window W,
1718 starting at position POS that includes overlay string and display
1719 vector/ control character translation position information. */
1722 init_from_display_pos (it
, w
, pos
)
1725 struct display_pos
*pos
;
1727 /* Keep in mind: the call to reseat in init_iterator skips invisible
1728 text, so we might end up at a position different from POS. This
1729 is only a problem when POS is a row start after a newline and an
1730 overlay starts there with an after-string, and the overlay has an
1731 invisible property. Since we don't skip invisible text in
1732 display_line and elsewhere immediately after consuming the
1733 newline before the row start, such a POS will not be in a string,
1734 but the call to init_iterator below will move us to the
1736 init_iterator (it
, w
, CHARPOS (pos
->pos
), BYTEPOS (pos
->pos
),
1737 NULL
, DEFAULT_FACE_ID
);
1739 /* If position is within an overlay string, set up IT to
1740 the right overlay string. */
1741 if (pos
->overlay_string_index
>= 0)
1745 /* We already have the first chunk of overlay strings in
1746 IT->overlay_strings. Load more until the one for
1747 pos->overlay_string_index is in IT->overlay_strings. */
1748 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
1750 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
1751 it
->current
.overlay_string_index
= 0;
1754 load_overlay_strings (it
);
1755 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
1759 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
1760 relative_index
= (it
->current
.overlay_string_index
1761 % OVERLAY_STRING_CHUNK_SIZE
);
1762 it
->string
= it
->overlay_strings
[relative_index
];
1763 xassert (STRINGP (it
->string
));
1764 it
->current
.string_pos
= pos
->string_pos
;
1765 it
->method
= next_element_from_string
;
1767 else if (it
->current
.overlay_string_index
>= 0)
1769 /* If POS says we're already after an overlay string ending at
1770 POS, make sure to pop the iterator because it will be in
1771 front of that overlay string. When POS is ZV, we've thereby
1772 also ``processed'' overlay strings at ZV. */
1775 it
->current
.overlay_string_index
= -1;
1776 it
->method
= next_element_from_buffer
;
1777 if (CHARPOS (pos
->pos
) == ZV
)
1778 it
->overlay_strings_at_end_processed_p
= 1;
1781 if (CHARPOS (pos
->string_pos
) >= 0)
1783 /* Recorded position is not in an overlay string, but in another
1784 string. This can only be a string from a `display' property.
1785 IT should already be filled with that string. */
1786 it
->current
.string_pos
= pos
->string_pos
;
1787 xassert (STRINGP (it
->string
));
1790 /* Restore position in display vector translations or control
1791 character translations. */
1792 if (pos
->dpvec_index
>= 0)
1794 /* This fills IT->dpvec. */
1795 get_next_display_element (it
);
1796 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
1797 it
->current
.dpvec_index
= pos
->dpvec_index
;
1804 /* Initialize IT for stepping through current_buffer in window W
1805 starting at ROW->start. */
1808 init_to_row_start (it
, w
, row
)
1811 struct glyph_row
*row
;
1813 init_from_display_pos (it
, w
, &row
->start
);
1814 it
->continuation_lines_width
= row
->continuation_lines_width
;
1819 /* Initialize IT for stepping through current_buffer in window W
1820 starting in the line following ROW, i.e. starting at ROW->end. */
1823 init_to_row_end (it
, w
, row
)
1826 struct glyph_row
*row
;
1828 init_from_display_pos (it
, w
, &row
->end
);
1830 if (row
->continued_p
)
1831 it
->continuation_lines_width
= (row
->continuation_lines_width
1832 + row
->pixel_width
);
1839 /***********************************************************************
1841 ***********************************************************************/
1843 /* Called when IT reaches IT->stop_charpos. Handle text property and
1844 overlay changes. Set IT->stop_charpos to the next position where
1851 enum prop_handled handled
;
1852 int handle_overlay_change_p
= 1;
1856 it
->current
.dpvec_index
= -1;
1860 handled
= HANDLED_NORMALLY
;
1862 /* Call text property handlers. */
1863 for (p
= it_props
; p
->handler
; ++p
)
1865 handled
= p
->handler (it
);
1867 if (handled
== HANDLED_RECOMPUTE_PROPS
)
1869 else if (handled
== HANDLED_RETURN
)
1871 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
1872 handle_overlay_change_p
= 0;
1875 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
1877 /* Don't check for overlay strings below when set to deliver
1878 characters from a display vector. */
1879 if (it
->method
== next_element_from_display_vector
)
1880 handle_overlay_change_p
= 0;
1882 /* Handle overlay changes. */
1883 if (handle_overlay_change_p
)
1884 handled
= handle_overlay_change (it
);
1886 /* Determine where to stop next. */
1887 if (handled
== HANDLED_NORMALLY
)
1888 compute_stop_pos (it
);
1891 while (handled
== HANDLED_RECOMPUTE_PROPS
);
1895 /* Compute IT->stop_charpos from text property and overlay change
1896 information for IT's current position. */
1899 compute_stop_pos (it
)
1902 register INTERVAL iv
, next_iv
;
1903 Lisp_Object object
, limit
, position
;
1905 /* If nowhere else, stop at the end. */
1906 it
->stop_charpos
= it
->end_charpos
;
1908 if (STRINGP (it
->string
))
1910 /* Strings are usually short, so don't limit the search for
1912 object
= it
->string
;
1914 XSETFASTINT (position
, IT_STRING_CHARPOS (*it
));
1920 /* If next overlay change is in front of the current stop pos
1921 (which is IT->end_charpos), stop there. Note: value of
1922 next_overlay_change is point-max if no overlay change
1924 charpos
= next_overlay_change (IT_CHARPOS (*it
));
1925 if (charpos
< it
->stop_charpos
)
1926 it
->stop_charpos
= charpos
;
1928 /* If showing the region, we have to stop at the region
1929 start or end because the face might change there. */
1930 if (it
->region_beg_charpos
> 0)
1932 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
1933 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
1934 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
1935 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
1938 /* Set up variables for computing the stop position from text
1939 property changes. */
1940 XSETBUFFER (object
, current_buffer
);
1941 XSETFASTINT (limit
, IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
1942 XSETFASTINT (position
, IT_CHARPOS (*it
));
1946 /* Get the interval containing IT's position. Value is a null
1947 interval if there isn't such an interval. */
1948 iv
= validate_interval_range (object
, &position
, &position
, 0);
1949 if (!NULL_INTERVAL_P (iv
))
1951 Lisp_Object values_here
[LAST_PROP_IDX
];
1954 /* Get properties here. */
1955 for (p
= it_props
; p
->handler
; ++p
)
1956 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
1958 /* Look for an interval following iv that has different
1960 for (next_iv
= next_interval (iv
);
1961 (!NULL_INTERVAL_P (next_iv
)
1963 || XFASTINT (limit
) > next_iv
->position
));
1964 next_iv
= next_interval (next_iv
))
1966 for (p
= it_props
; p
->handler
; ++p
)
1968 Lisp_Object new_value
;
1970 new_value
= textget (next_iv
->plist
, *p
->name
);
1971 if (!EQ (values_here
[p
->idx
], new_value
))
1979 if (!NULL_INTERVAL_P (next_iv
))
1981 if (INTEGERP (limit
)
1982 && next_iv
->position
>= XFASTINT (limit
))
1983 /* No text property change up to limit. */
1984 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
1986 /* Text properties change in next_iv. */
1987 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
1991 xassert (STRINGP (it
->string
)
1992 || (it
->stop_charpos
>= BEGV
1993 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
1997 /* Return the position of the next overlay change after POS in
1998 current_buffer. Value is point-max if no overlay change
1999 follows. This is like `next-overlay-change' but doesn't use
2003 next_overlay_change (pos
)
2008 Lisp_Object
*overlays
;
2012 /* Get all overlays at the given position. */
2014 overlays
= (Lisp_Object
*) alloca (len
* sizeof *overlays
);
2015 noverlays
= overlays_at (pos
, 0, &overlays
, &len
, &endpos
, NULL
, 1);
2016 if (noverlays
> len
)
2019 overlays
= (Lisp_Object
*) alloca (len
* sizeof *overlays
);
2020 noverlays
= overlays_at (pos
, 0, &overlays
, &len
, &endpos
, NULL
, 1);
2023 /* If any of these overlays ends before endpos,
2024 use its ending point instead. */
2025 for (i
= 0; i
< noverlays
; ++i
)
2030 oend
= OVERLAY_END (overlays
[i
]);
2031 oendpos
= OVERLAY_POSITION (oend
);
2032 endpos
= min (endpos
, oendpos
);
2040 /***********************************************************************
2042 ***********************************************************************/
2044 /* Handle changes in the `fontified' property of the current buffer by
2045 calling hook functions from Qfontification_functions to fontify
2048 static enum prop_handled
2049 handle_fontified_prop (it
)
2052 Lisp_Object prop
, pos
;
2053 enum prop_handled handled
= HANDLED_NORMALLY
;
2055 /* Get the value of the `fontified' property at IT's current buffer
2056 position. (The `fontified' property doesn't have a special
2057 meaning in strings.) If the value is nil, call functions from
2058 Qfontification_functions. */
2059 if (!STRINGP (it
->string
)
2061 && !NILP (Vfontification_functions
)
2062 && !NILP (Vrun_hooks
)
2063 && (pos
= make_number (IT_CHARPOS (*it
)),
2064 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
2067 int count
= BINDING_STACK_SIZE ();
2070 val
= Vfontification_functions
;
2071 specbind (Qfontification_functions
, Qnil
);
2072 specbind (Qafter_change_functions
, Qnil
);
2074 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
2075 safe_call1 (val
, pos
);
2078 Lisp_Object globals
, fn
;
2079 struct gcpro gcpro1
, gcpro2
;
2082 GCPRO2 (val
, globals
);
2084 for (; CONSP (val
); val
= XCDR (val
))
2090 /* A value of t indicates this hook has a local
2091 binding; it means to run the global binding too.
2092 In a global value, t should not occur. If it
2093 does, we must ignore it to avoid an endless
2095 for (globals
= Fdefault_value (Qfontification_functions
);
2097 globals
= XCDR (globals
))
2099 fn
= XCAR (globals
);
2101 safe_call1 (fn
, pos
);
2105 safe_call1 (fn
, pos
);
2111 unbind_to (count
, Qnil
);
2113 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
2114 something. This avoids an endless loop if they failed to
2115 fontify the text for which reason ever. */
2116 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
2117 handled
= HANDLED_RECOMPUTE_PROPS
;
2125 /***********************************************************************
2127 ***********************************************************************/
2129 /* Set up iterator IT from face properties at its current position.
2130 Called from handle_stop. */
2132 static enum prop_handled
2133 handle_face_prop (it
)
2136 int new_face_id
, next_stop
;
2138 if (!STRINGP (it
->string
))
2141 = face_at_buffer_position (it
->w
,
2143 it
->region_beg_charpos
,
2144 it
->region_end_charpos
,
2147 + TEXT_PROP_DISTANCE_LIMIT
),
2150 /* Is this a start of a run of characters with box face?
2151 Caveat: this can be called for a freshly initialized
2152 iterator; face_id is -1 is this case. We know that the new
2153 face will not change until limit, i.e. if the new face has a
2154 box, all characters up to limit will have one. But, as
2155 usual, we don't know whether limit is really the end. */
2156 if (new_face_id
!= it
->face_id
)
2158 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
2160 /* If new face has a box but old face has not, this is
2161 the start of a run of characters with box, i.e. it has
2162 a shadow on the left side. The value of face_id of the
2163 iterator will be -1 if this is the initial call that gets
2164 the face. In this case, we have to look in front of IT's
2165 position and see whether there is a face != new_face_id. */
2166 it
->start_of_box_run_p
2167 = (new_face
->box
!= FACE_NO_BOX
2168 && (it
->face_id
>= 0
2169 || IT_CHARPOS (*it
) == BEG
2170 || new_face_id
!= face_before_it_pos (it
)));
2171 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
2176 int base_face_id
, bufpos
;
2178 if (it
->current
.overlay_string_index
>= 0)
2179 bufpos
= IT_CHARPOS (*it
);
2183 /* For strings from a buffer, i.e. overlay strings or strings
2184 from a `display' property, use the face at IT's current
2185 buffer position as the base face to merge with, so that
2186 overlay strings appear in the same face as surrounding
2187 text, unless they specify their own faces. */
2188 base_face_id
= underlying_face_id (it
);
2190 new_face_id
= face_at_string_position (it
->w
,
2192 IT_STRING_CHARPOS (*it
),
2194 it
->region_beg_charpos
,
2195 it
->region_end_charpos
,
2199 #if 0 /* This shouldn't be neccessary. Let's check it. */
2200 /* If IT is used to display a mode line we would really like to
2201 use the mode line face instead of the frame's default face. */
2202 if (it
->glyph_row
== MATRIX_MODE_LINE_ROW (it
->w
->desired_matrix
)
2203 && new_face_id
== DEFAULT_FACE_ID
)
2204 new_face_id
= MODE_LINE_FACE_ID
;
2207 /* Is this a start of a run of characters with box? Caveat:
2208 this can be called for a freshly allocated iterator; face_id
2209 is -1 is this case. We know that the new face will not
2210 change until the next check pos, i.e. if the new face has a
2211 box, all characters up to that position will have a
2212 box. But, as usual, we don't know whether that position
2213 is really the end. */
2214 if (new_face_id
!= it
->face_id
)
2216 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
2217 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
2219 /* If new face has a box but old face hasn't, this is the
2220 start of a run of characters with box, i.e. it has a
2221 shadow on the left side. */
2222 it
->start_of_box_run_p
2223 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
2224 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
2228 it
->face_id
= new_face_id
;
2229 return HANDLED_NORMALLY
;
2233 /* Return the ID of the face ``underlying'' IT's current position,
2234 which is in a string. If the iterator is associated with a
2235 buffer, return the face at IT's current buffer position.
2236 Otherwise, use the iterator's base_face_id. */
2239 underlying_face_id (it
)
2242 int face_id
= it
->base_face_id
, i
;
2244 xassert (STRINGP (it
->string
));
2246 for (i
= it
->sp
- 1; i
>= 0; --i
)
2247 if (NILP (it
->stack
[i
].string
))
2248 face_id
= it
->stack
[i
].face_id
;
2254 /* Compute the face one character before or after the current position
2255 of IT. BEFORE_P non-zero means get the face in front of IT's
2256 position. Value is the id of the face. */
2259 face_before_or_after_it_pos (it
, before_p
)
2264 int next_check_charpos
;
2265 struct text_pos pos
;
2267 xassert (it
->s
== NULL
);
2269 if (STRINGP (it
->string
))
2271 int bufpos
, base_face_id
;
2273 /* No face change past the end of the string (for the case
2274 we are padding with spaces). No face change before the
2276 if (IT_STRING_CHARPOS (*it
) >= XSTRING (it
->string
)->size
2277 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
2280 /* Set pos to the position before or after IT's current position. */
2282 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
2284 /* For composition, we must check the character after the
2286 pos
= (it
->what
== IT_COMPOSITION
2287 ? string_pos (IT_STRING_CHARPOS (*it
) + it
->cmp_len
, it
->string
)
2288 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
2290 if (it
->current
.overlay_string_index
>= 0)
2291 bufpos
= IT_CHARPOS (*it
);
2295 base_face_id
= underlying_face_id (it
);
2297 /* Get the face for ASCII, or unibyte. */
2298 face_id
= face_at_string_position (it
->w
,
2302 it
->region_beg_charpos
,
2303 it
->region_end_charpos
,
2304 &next_check_charpos
,
2307 /* Correct the face for charsets different from ASCII. Do it
2308 for the multibyte case only. The face returned above is
2309 suitable for unibyte text if IT->string is unibyte. */
2310 if (STRING_MULTIBYTE (it
->string
))
2312 unsigned char *p
= XSTRING (it
->string
)->data
+ BYTEPOS (pos
);
2313 int rest
= STRING_BYTES (XSTRING (it
->string
)) - BYTEPOS (pos
);
2315 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
2317 c
= string_char_and_length (p
, rest
, &len
);
2318 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
);
2323 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
2324 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
2327 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
2328 pos
= it
->current
.pos
;
2331 DEC_TEXT_POS (pos
, it
->multibyte_p
);
2334 if (it
->what
== IT_COMPOSITION
)
2335 /* For composition, we must check the position after the
2337 pos
.charpos
+= it
->cmp_len
, pos
.bytepos
+= it
->len
;
2339 INC_TEXT_POS (pos
, it
->multibyte_p
);
2342 /* Determine face for CHARSET_ASCII, or unibyte. */
2343 face_id
= face_at_buffer_position (it
->w
,
2345 it
->region_beg_charpos
,
2346 it
->region_end_charpos
,
2347 &next_check_charpos
,
2350 /* Correct the face for charsets different from ASCII. Do it
2351 for the multibyte case only. The face returned above is
2352 suitable for unibyte text if current_buffer is unibyte. */
2353 if (it
->multibyte_p
)
2355 int c
= FETCH_MULTIBYTE_CHAR (CHARPOS (pos
));
2356 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
2357 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
);
2366 /***********************************************************************
2368 ***********************************************************************/
2370 /* Set up iterator IT from invisible properties at its current
2371 position. Called from handle_stop. */
2373 static enum prop_handled
2374 handle_invisible_prop (it
)
2377 enum prop_handled handled
= HANDLED_NORMALLY
;
2379 if (STRINGP (it
->string
))
2381 extern Lisp_Object Qinvisible
;
2382 Lisp_Object prop
, end_charpos
, limit
, charpos
;
2384 /* Get the value of the invisible text property at the
2385 current position. Value will be nil if there is no such
2387 XSETFASTINT (charpos
, IT_STRING_CHARPOS (*it
));
2388 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
2391 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
2393 handled
= HANDLED_RECOMPUTE_PROPS
;
2395 /* Get the position at which the next change of the
2396 invisible text property can be found in IT->string.
2397 Value will be nil if the property value is the same for
2398 all the rest of IT->string. */
2399 XSETINT (limit
, XSTRING (it
->string
)->size
);
2400 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
2403 /* Text at current position is invisible. The next
2404 change in the property is at position end_charpos.
2405 Move IT's current position to that position. */
2406 if (INTEGERP (end_charpos
)
2407 && XFASTINT (end_charpos
) < XFASTINT (limit
))
2409 struct text_pos old
;
2410 old
= it
->current
.string_pos
;
2411 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
2412 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
2416 /* The rest of the string is invisible. If this is an
2417 overlay string, proceed with the next overlay string
2418 or whatever comes and return a character from there. */
2419 if (it
->current
.overlay_string_index
>= 0)
2421 next_overlay_string (it
);
2422 /* Don't check for overlay strings when we just
2423 finished processing them. */
2424 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
2428 struct Lisp_String
*s
= XSTRING (it
->string
);
2429 IT_STRING_CHARPOS (*it
) = s
->size
;
2430 IT_STRING_BYTEPOS (*it
) = STRING_BYTES (s
);
2437 int visible_p
, newpos
, next_stop
;
2438 Lisp_Object pos
, prop
;
2440 /* First of all, is there invisible text at this position? */
2441 XSETFASTINT (pos
, IT_CHARPOS (*it
));
2442 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
2444 /* If we are on invisible text, skip over it. */
2445 if (TEXT_PROP_MEANS_INVISIBLE (prop
)
2446 && IT_CHARPOS (*it
) < it
->end_charpos
)
2448 /* Record whether we have to display an ellipsis for the
2450 int display_ellipsis_p
2451 = TEXT_PROP_MEANS_INVISIBLE_WITH_ELLIPSIS (prop
);
2453 handled
= HANDLED_RECOMPUTE_PROPS
;
2455 /* Loop skipping over invisible text. The loop is left at
2456 ZV or with IT on the first char being visible again. */
2459 /* Try to skip some invisible text. Return value is the
2460 position reached which can be equal to IT's position
2461 if there is nothing invisible here. This skips both
2462 over invisible text properties and overlays with
2463 invisible property. */
2464 newpos
= skip_invisible (IT_CHARPOS (*it
),
2465 &next_stop
, ZV
, it
->window
);
2467 /* If we skipped nothing at all we weren't at invisible
2468 text in the first place. If everything to the end of
2469 the buffer was skipped, end the loop. */
2470 if (newpos
== IT_CHARPOS (*it
) || newpos
>= ZV
)
2474 /* We skipped some characters but not necessarily
2475 all there are. Check if we ended up on visible
2476 text. Fget_char_property returns the property of
2477 the char before the given position, i.e. if we
2478 get visible_p = 1, this means that the char at
2479 newpos is visible. */
2480 XSETFASTINT (pos
, newpos
);
2481 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
2482 visible_p
= !TEXT_PROP_MEANS_INVISIBLE (prop
);
2485 /* If we ended up on invisible text, proceed to
2486 skip starting with next_stop. */
2488 IT_CHARPOS (*it
) = next_stop
;
2492 /* The position newpos is now either ZV or on visible text. */
2493 IT_CHARPOS (*it
) = newpos
;
2494 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
2496 /* Maybe return `...' next for the end of the invisible text. */
2497 if (display_ellipsis_p
)
2500 && VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
2502 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
2503 it
->dpvec
= v
->contents
;
2504 it
->dpend
= v
->contents
+ v
->size
;
2508 /* Default `...'. */
2509 it
->dpvec
= default_invis_vector
;
2510 it
->dpend
= default_invis_vector
+ 3;
2513 /* The ellipsis display does not replace the display of
2514 the character at the new position. Indicate this by
2515 setting IT->dpvec_char_len to zero. */
2516 it
->dpvec_char_len
= 0;
2518 it
->current
.dpvec_index
= 0;
2519 it
->method
= next_element_from_display_vector
;
2529 /***********************************************************************
2531 ***********************************************************************/
2533 /* Set up iterator IT from `display' property at its current position.
2534 Called from handle_stop. */
2536 static enum prop_handled
2537 handle_display_prop (it
)
2540 Lisp_Object prop
, object
;
2541 struct text_pos
*position
;
2542 int space_or_image_found_p
;
2544 if (STRINGP (it
->string
))
2546 object
= it
->string
;
2547 position
= &it
->current
.string_pos
;
2552 position
= &it
->current
.pos
;
2555 /* Reset those iterator values set from display property values. */
2556 it
->font_height
= Qnil
;
2557 it
->space_width
= Qnil
;
2560 /* We don't support recursive `display' properties, i.e. string
2561 values that have a string `display' property, that have a string
2562 `display' property etc. */
2563 if (!it
->string_from_display_prop_p
)
2564 it
->area
= TEXT_AREA
;
2566 prop
= Fget_char_property (make_number (position
->charpos
),
2569 return HANDLED_NORMALLY
;
2571 space_or_image_found_p
= 0;
2573 && CONSP (XCAR (prop
))
2574 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
2576 /* A list of sub-properties. */
2577 while (CONSP (prop
))
2579 if (handle_single_display_prop (it
, XCAR (prop
), object
, position
))
2580 space_or_image_found_p
= 1;
2584 else if (VECTORP (prop
))
2587 for (i
= 0; i
< XVECTOR (prop
)->size
; ++i
)
2588 if (handle_single_display_prop (it
, XVECTOR (prop
)->contents
[i
],
2590 space_or_image_found_p
= 1;
2594 if (handle_single_display_prop (it
, prop
, object
, position
))
2595 space_or_image_found_p
= 1;
2598 return space_or_image_found_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
2602 /* Value is the position of the end of the `display' property starting
2603 at START_POS in OBJECT. */
2605 static struct text_pos
2606 display_prop_end (it
, object
, start_pos
)
2609 struct text_pos start_pos
;
2612 struct text_pos end_pos
;
2614 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
2615 Qdisplay
, object
, Qnil
);
2616 CHARPOS (end_pos
) = XFASTINT (end
);
2617 if (STRINGP (object
))
2618 compute_string_pos (&end_pos
, start_pos
, it
->string
);
2620 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
2626 /* Set up IT from a single `display' sub-property value PROP. OBJECT
2627 is the object in which the `display' property was found. *POSITION
2628 is the position at which it was found.
2630 If PROP is a `space' or `image' sub-property, set *POSITION to the
2631 end position of the `display' property.
2633 Value is non-zero if a `space' or `image' property value was found. */
2636 handle_single_display_prop (it
, prop
, object
, position
)
2640 struct text_pos
*position
;
2643 int space_or_image_found_p
= 0;
2646 /* If PROP is a list of the form `(when FORM . VALUE)', FORM is
2647 evaluated. If the result is nil, VALUE is ignored. */
2649 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
2658 if (!NILP (form
) && !EQ (form
, Qt
))
2660 struct gcpro gcpro1
;
2661 struct text_pos end_pos
, pt
;
2664 end_pos
= display_prop_end (it
, object
, *position
);
2666 /* Temporarily set point to the end position, and then evaluate
2667 the form. This makes `(eolp)' work as FORM. */
2668 if (BUFFERP (object
))
2671 BYTEPOS (pt
) = PT_BYTE
;
2672 TEMP_SET_PT_BOTH (CHARPOS (end_pos
), BYTEPOS (end_pos
));
2675 form
= safe_eval (form
);
2677 if (BUFFERP (object
))
2678 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
2686 && EQ (XCAR (prop
), Qheight
)
2687 && CONSP (XCDR (prop
)))
2689 if (FRAME_TERMCAP_P (it
->f
)
2690 || FRAME_MSDOS_P (it
->f
)
2691 || FRAME_W32_CONSOLE_P (it
->f
))
2694 /* `(height HEIGHT)'. */
2695 it
->font_height
= XCAR (XCDR (prop
));
2696 if (!NILP (it
->font_height
))
2698 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
2699 int new_height
= -1;
2701 if (CONSP (it
->font_height
)
2702 && (EQ (XCAR (it
->font_height
), Qplus
)
2703 || EQ (XCAR (it
->font_height
), Qminus
))
2704 && CONSP (XCDR (it
->font_height
))
2705 && INTEGERP (XCAR (XCDR (it
->font_height
))))
2707 /* `(+ N)' or `(- N)' where N is an integer. */
2708 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
2709 if (EQ (XCAR (it
->font_height
), Qplus
))
2711 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
2713 else if (FUNCTIONP (it
->font_height
))
2715 /* Call function with current height as argument.
2716 Value is the new height. */
2718 height
= safe_call1 (it
->font_height
,
2719 face
->lface
[LFACE_HEIGHT_INDEX
]);
2720 if (NUMBERP (height
))
2721 new_height
= XFLOATINT (height
);
2723 else if (NUMBERP (it
->font_height
))
2725 /* Value is a multiple of the canonical char height. */
2728 face
= FACE_FROM_ID (it
->f
, DEFAULT_FACE_ID
);
2729 new_height
= (XFLOATINT (it
->font_height
)
2730 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
2734 /* Evaluate IT->font_height with `height' bound to the
2735 current specified height to get the new height. */
2737 int count
= BINDING_STACK_SIZE ();
2739 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
2740 value
= safe_eval (it
->font_height
);
2741 unbind_to (count
, Qnil
);
2743 if (NUMBERP (value
))
2744 new_height
= XFLOATINT (value
);
2748 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
2751 else if (CONSP (prop
)
2752 && EQ (XCAR (prop
), Qspace_width
)
2753 && CONSP (XCDR (prop
)))
2755 /* `(space_width WIDTH)'. */
2756 if (FRAME_TERMCAP_P (it
->f
)
2757 || FRAME_MSDOS_P (it
->f
)
2758 || FRAME_W32_CONSOLE_P (it
->f
))
2761 value
= XCAR (XCDR (prop
));
2762 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
2763 it
->space_width
= value
;
2765 else if (CONSP (prop
)
2766 && EQ (XCAR (prop
), Qraise
)
2767 && CONSP (XCDR (prop
)))
2769 /* `(raise FACTOR)'. */
2770 if (FRAME_TERMCAP_P (it
->f
)
2771 || FRAME_MSDOS_P (it
->f
)
2772 || FRAME_W32_CONSOLE_P (it
->f
))
2775 #ifdef HAVE_WINDOW_SYSTEM
2776 value
= XCAR (XCDR (prop
));
2777 if (NUMBERP (value
))
2779 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
2780 it
->voffset
= - (XFLOATINT (value
)
2781 * (FONT_HEIGHT (face
->font
)));
2783 #endif /* HAVE_WINDOW_SYSTEM */
2785 else if (!it
->string_from_display_prop_p
)
2787 /* `((margin left-margin) VALUE)' or `((margin right-margin)
2788 VALUE) or `((margin nil) VALUE)' or VALUE. */
2789 Lisp_Object location
, value
;
2790 struct text_pos start_pos
;
2793 /* Characters having this form of property are not displayed, so
2794 we have to find the end of the property. */
2795 start_pos
= *position
;
2796 *position
= display_prop_end (it
, object
, start_pos
);
2799 /* Let's stop at the new position and assume that all
2800 text properties change there. */
2801 it
->stop_charpos
= position
->charpos
;
2803 location
= Qunbound
;
2804 if (CONSP (prop
) && CONSP (XCAR (prop
)))
2808 value
= XCDR (prop
);
2810 value
= XCAR (value
);
2813 if (EQ (XCAR (tem
), Qmargin
)
2814 && (tem
= XCDR (tem
),
2815 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
2817 || EQ (tem
, Qleft_margin
)
2818 || EQ (tem
, Qright_margin
))))
2822 if (EQ (location
, Qunbound
))
2828 #ifdef HAVE_WINDOW_SYSTEM
2829 if (FRAME_TERMCAP_P (it
->f
))
2830 valid_p
= STRINGP (value
);
2832 valid_p
= (STRINGP (value
)
2833 || (CONSP (value
) && EQ (XCAR (value
), Qspace
))
2834 || valid_image_p (value
));
2835 #else /* not HAVE_WINDOW_SYSTEM */
2836 valid_p
= STRINGP (value
);
2837 #endif /* not HAVE_WINDOW_SYSTEM */
2839 if ((EQ (location
, Qleft_margin
)
2840 || EQ (location
, Qright_margin
)
2844 space_or_image_found_p
= 1;
2846 /* Save current settings of IT so that we can restore them
2847 when we are finished with the glyph property value. */
2850 if (NILP (location
))
2851 it
->area
= TEXT_AREA
;
2852 else if (EQ (location
, Qleft_margin
))
2853 it
->area
= LEFT_MARGIN_AREA
;
2855 it
->area
= RIGHT_MARGIN_AREA
;
2857 if (STRINGP (value
))
2860 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
2861 it
->current
.overlay_string_index
= -1;
2862 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
2863 it
->end_charpos
= it
->string_nchars
2864 = XSTRING (it
->string
)->size
;
2865 it
->method
= next_element_from_string
;
2866 it
->stop_charpos
= 0;
2867 it
->string_from_display_prop_p
= 1;
2869 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
2871 it
->method
= next_element_from_stretch
;
2873 it
->current
.pos
= it
->position
= start_pos
;
2875 #ifdef HAVE_WINDOW_SYSTEM
2878 it
->what
= IT_IMAGE
;
2879 it
->image_id
= lookup_image (it
->f
, value
);
2880 it
->position
= start_pos
;
2881 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
2882 it
->method
= next_element_from_image
;
2884 /* Say that we haven't consumed the characters with
2885 `display' property yet. The call to pop_it in
2886 set_iterator_to_next will clean this up. */
2887 *position
= start_pos
;
2889 #endif /* HAVE_WINDOW_SYSTEM */
2892 /* Invalid property or property not supported. Restore
2893 the position to what it was before. */
2894 *position
= start_pos
;
2897 return space_or_image_found_p
;
2901 /* Check if PROP is a display sub-property value whose text should be
2902 treated as intangible. */
2905 single_display_prop_intangible_p (prop
)
2908 /* Skip over `when FORM'. */
2909 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
2920 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
2921 we don't need to treat text as intangible. */
2922 if (EQ (XCAR (prop
), Qmargin
))
2930 || EQ (XCAR (prop
), Qleft_margin
)
2931 || EQ (XCAR (prop
), Qright_margin
))
2935 return CONSP (prop
) && EQ (XCAR (prop
), Qimage
);
2939 /* Check if PROP is a display property value whose text should be
2940 treated as intangible. */
2943 display_prop_intangible_p (prop
)
2947 && CONSP (XCAR (prop
))
2948 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
2950 /* A list of sub-properties. */
2951 while (CONSP (prop
))
2953 if (single_display_prop_intangible_p (XCAR (prop
)))
2958 else if (VECTORP (prop
))
2960 /* A vector of sub-properties. */
2962 for (i
= 0; i
< XVECTOR (prop
)->size
; ++i
)
2963 if (single_display_prop_intangible_p (XVECTOR (prop
)->contents
[i
]))
2967 return single_display_prop_intangible_p (prop
);
2973 /***********************************************************************
2974 `composition' property
2975 ***********************************************************************/
2977 /* Set up iterator IT from `composition' property at its current
2978 position. Called from handle_stop. */
2980 static enum prop_handled
2981 handle_composition_prop (it
)
2984 Lisp_Object prop
, string
;
2985 int pos
, pos_byte
, end
;
2986 enum prop_handled handled
= HANDLED_NORMALLY
;
2988 if (STRINGP (it
->string
))
2990 pos
= IT_STRING_CHARPOS (*it
);
2991 pos_byte
= IT_STRING_BYTEPOS (*it
);
2992 string
= it
->string
;
2996 pos
= IT_CHARPOS (*it
);
2997 pos_byte
= IT_BYTEPOS (*it
);
3001 /* If there's a valid composition and point is not inside of the
3002 composition (in the case that the composition is from the current
3003 buffer), draw a glyph composed from the composition components. */
3004 if (find_composition (pos
, -1, &pos
, &end
, &prop
, string
)
3005 && COMPOSITION_VALID_P (pos
, end
, prop
)
3006 && (STRINGP (it
->string
) || (PT
<= pos
|| PT
>= end
)))
3008 int id
= get_composition_id (pos
, pos_byte
, end
- pos
, prop
, string
);
3012 it
->method
= next_element_from_composition
;
3014 it
->cmp_len
= COMPOSITION_LENGTH (prop
);
3015 /* For a terminal, draw only the first character of the
3017 it
->c
= COMPOSITION_GLYPH (composition_table
[id
], 0);
3018 it
->len
= (STRINGP (it
->string
)
3019 ? string_char_to_byte (it
->string
, end
)
3020 : CHAR_TO_BYTE (end
)) - pos_byte
;
3021 it
->stop_charpos
= end
;
3022 handled
= HANDLED_RETURN
;
3031 /***********************************************************************
3033 ***********************************************************************/
3035 /* The following structure is used to record overlay strings for
3036 later sorting in load_overlay_strings. */
3038 struct overlay_entry
3040 Lisp_Object overlay
;
3047 /* Set up iterator IT from overlay strings at its current position.
3048 Called from handle_stop. */
3050 static enum prop_handled
3051 handle_overlay_change (it
)
3054 if (!STRINGP (it
->string
) && get_overlay_strings (it
))
3055 return HANDLED_RECOMPUTE_PROPS
;
3057 return HANDLED_NORMALLY
;
3061 /* Set up the next overlay string for delivery by IT, if there is an
3062 overlay string to deliver. Called by set_iterator_to_next when the
3063 end of the current overlay string is reached. If there are more
3064 overlay strings to display, IT->string and
3065 IT->current.overlay_string_index are set appropriately here.
3066 Otherwise IT->string is set to nil. */
3069 next_overlay_string (it
)
3072 ++it
->current
.overlay_string_index
;
3073 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
3075 /* No more overlay strings. Restore IT's settings to what
3076 they were before overlay strings were processed, and
3077 continue to deliver from current_buffer. */
3079 xassert (it
->stop_charpos
>= BEGV
3080 && it
->stop_charpos
<= it
->end_charpos
);
3082 it
->current
.overlay_string_index
= -1;
3083 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
3084 it
->n_overlay_strings
= 0;
3085 it
->method
= next_element_from_buffer
;
3087 /* If we're at the end of the buffer, record that we have
3088 processed the overlay strings there already, so that
3089 next_element_from_buffer doesn't try it again. */
3090 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
3091 it
->overlay_strings_at_end_processed_p
= 1;
3095 /* There are more overlay strings to process. If
3096 IT->current.overlay_string_index has advanced to a position
3097 where we must load IT->overlay_strings with more strings, do
3099 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
3101 if (it
->current
.overlay_string_index
&& i
== 0)
3102 load_overlay_strings (it
);
3104 /* Initialize IT to deliver display elements from the overlay
3106 it
->string
= it
->overlay_strings
[i
];
3107 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
3108 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
3109 it
->method
= next_element_from_string
;
3110 it
->stop_charpos
= 0;
3117 /* Compare two overlay_entry structures E1 and E2. Used as a
3118 comparison function for qsort in load_overlay_strings. Overlay
3119 strings for the same position are sorted so that
3121 1. All after-strings come in front of before-strings, except
3122 when they come from the same overlay.
3124 2. Within after-strings, strings are sorted so that overlay strings
3125 from overlays with higher priorities come first.
3127 2. Within before-strings, strings are sorted so that overlay
3128 strings from overlays with higher priorities come last.
3130 Value is analogous to strcmp. */
3134 compare_overlay_entries (e1
, e2
)
3137 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
3138 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
3141 if (entry1
->after_string_p
!= entry2
->after_string_p
)
3143 /* Let after-strings appear in front of before-strings if
3144 they come from different overlays. */
3145 if (EQ (entry1
->overlay
, entry2
->overlay
))
3146 result
= entry1
->after_string_p
? 1 : -1;
3148 result
= entry1
->after_string_p
? -1 : 1;
3150 else if (entry1
->after_string_p
)
3151 /* After-strings sorted in order of decreasing priority. */
3152 result
= entry2
->priority
- entry1
->priority
;
3154 /* Before-strings sorted in order of increasing priority. */
3155 result
= entry1
->priority
- entry2
->priority
;
3161 /* Load the vector IT->overlay_strings with overlay strings from IT's
3162 current buffer position. Set IT->n_overlays to the total number of
3163 overlay strings found.
3165 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
3166 a time. On entry into load_overlay_strings,
3167 IT->current.overlay_string_index gives the number of overlay
3168 strings that have already been loaded by previous calls to this
3171 IT->add_overlay_start contains an additional overlay start
3172 position to consider for taking overlay strings from, if non-zero.
3173 This position comes into play when the overlay has an `invisible'
3174 property, and both before and after-strings. When we've skipped to
3175 the end of the overlay, because of its `invisible' property, we
3176 nevertheless want its before-string to appear.
3177 IT->add_overlay_start will contain the overlay start position
3180 Overlay strings are sorted so that after-string strings come in
3181 front of before-string strings. Within before and after-strings,
3182 strings are sorted by overlay priority. See also function
3183 compare_overlay_entries. */
3186 load_overlay_strings (it
)
3189 extern Lisp_Object Qafter_string
, Qbefore_string
, Qwindow
, Qpriority
;
3190 Lisp_Object ov
, overlay
, window
, str
, invisible
;
3193 int n
= 0, i
, j
, invis_p
;
3194 struct overlay_entry
*entries
3195 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
3196 int charpos
= IT_CHARPOS (*it
);
3198 /* Append the overlay string STRING of overlay OVERLAY to vector
3199 `entries' which has size `size' and currently contains `n'
3200 elements. AFTER_P non-zero means STRING is an after-string of
3202 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
3205 Lisp_Object priority; \
3209 int new_size = 2 * size; \
3210 struct overlay_entry *old = entries; \
3212 (struct overlay_entry *) alloca (new_size \
3213 * sizeof *entries); \
3214 bcopy (old, entries, size * sizeof *entries); \
3218 entries[n].string = (STRING); \
3219 entries[n].overlay = (OVERLAY); \
3220 priority = Foverlay_get ((OVERLAY), Qpriority); \
3221 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
3222 entries[n].after_string_p = (AFTER_P); \
3227 /* Process overlay before the overlay center. */
3228 for (ov
= current_buffer
->overlays_before
; CONSP (ov
); ov
= XCDR (ov
))
3230 overlay
= XCAR (ov
);
3231 xassert (OVERLAYP (overlay
));
3232 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3233 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3238 /* Skip this overlay if it doesn't start or end at IT's current
3240 if (end
!= charpos
&& start
!= charpos
)
3243 /* Skip this overlay if it doesn't apply to IT->w. */
3244 window
= Foverlay_get (overlay
, Qwindow
);
3245 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
3248 /* If the text ``under'' the overlay is invisible, both before-
3249 and after-strings from this overlay are visible; start and
3250 end position are indistinguishable. */
3251 invisible
= Foverlay_get (overlay
, Qinvisible
);
3252 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
3254 /* If overlay has a non-empty before-string, record it. */
3255 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
3256 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
3257 && XSTRING (str
)->size
)
3258 RECORD_OVERLAY_STRING (overlay
, str
, 0);
3260 /* If overlay has a non-empty after-string, record it. */
3261 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
3262 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
3263 && XSTRING (str
)->size
)
3264 RECORD_OVERLAY_STRING (overlay
, str
, 1);
3267 /* Process overlays after the overlay center. */
3268 for (ov
= current_buffer
->overlays_after
; CONSP (ov
); ov
= XCDR (ov
))
3270 overlay
= XCAR (ov
);
3271 xassert (OVERLAYP (overlay
));
3272 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3273 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3275 if (start
> charpos
)
3278 /* Skip this overlay if it doesn't start or end at IT's current
3280 if (end
!= charpos
&& start
!= charpos
)
3283 /* Skip this overlay if it doesn't apply to IT->w. */
3284 window
= Foverlay_get (overlay
, Qwindow
);
3285 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
3288 /* If the text ``under'' the overlay is invisible, it has a zero
3289 dimension, and both before- and after-strings apply. */
3290 invisible
= Foverlay_get (overlay
, Qinvisible
);
3291 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
3293 /* If overlay has a non-empty before-string, record it. */
3294 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
3295 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
3296 && XSTRING (str
)->size
)
3297 RECORD_OVERLAY_STRING (overlay
, str
, 0);
3299 /* If overlay has a non-empty after-string, record it. */
3300 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
3301 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
3302 && XSTRING (str
)->size
)
3303 RECORD_OVERLAY_STRING (overlay
, str
, 1);
3306 #undef RECORD_OVERLAY_STRING
3310 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
3312 /* Record the total number of strings to process. */
3313 it
->n_overlay_strings
= n
;
3315 /* IT->current.overlay_string_index is the number of overlay strings
3316 that have already been consumed by IT. Copy some of the
3317 remaining overlay strings to IT->overlay_strings. */
3319 j
= it
->current
.overlay_string_index
;
3320 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
3321 it
->overlay_strings
[i
++] = entries
[j
++].string
;
3327 /* Get the first chunk of overlay strings at IT's current buffer
3328 position. Value is non-zero if at least one overlay string was
3332 get_overlay_strings (it
)
3335 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
3336 process. This fills IT->overlay_strings with strings, and sets
3337 IT->n_overlay_strings to the total number of strings to process.
3338 IT->pos.overlay_string_index has to be set temporarily to zero
3339 because load_overlay_strings needs this; it must be set to -1
3340 when no overlay strings are found because a zero value would
3341 indicate a position in the first overlay string. */
3342 it
->current
.overlay_string_index
= 0;
3343 load_overlay_strings (it
);
3345 /* If we found overlay strings, set up IT to deliver display
3346 elements from the first one. Otherwise set up IT to deliver
3347 from current_buffer. */
3348 if (it
->n_overlay_strings
)
3350 /* Make sure we know settings in current_buffer, so that we can
3351 restore meaningful values when we're done with the overlay
3353 compute_stop_pos (it
);
3354 xassert (it
->face_id
>= 0);
3356 /* Save IT's settings. They are restored after all overlay
3357 strings have been processed. */
3358 xassert (it
->sp
== 0);
3361 /* Set up IT to deliver display elements from the first overlay
3363 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
3364 it
->stop_charpos
= 0;
3365 it
->string
= it
->overlay_strings
[0];
3366 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
3367 xassert (STRINGP (it
->string
));
3368 it
->method
= next_element_from_string
;
3373 it
->current
.overlay_string_index
= -1;
3374 it
->method
= next_element_from_buffer
;
3379 /* Value is non-zero if we found at least one overlay string. */
3380 return STRINGP (it
->string
);
3385 /***********************************************************************
3386 Saving and restoring state
3387 ***********************************************************************/
3389 /* Save current settings of IT on IT->stack. Called, for example,
3390 before setting up IT for an overlay string, to be able to restore
3391 IT's settings to what they were after the overlay string has been
3398 struct iterator_stack_entry
*p
;
3400 xassert (it
->sp
< 2);
3401 p
= it
->stack
+ it
->sp
;
3403 p
->stop_charpos
= it
->stop_charpos
;
3404 xassert (it
->face_id
>= 0);
3405 p
->face_id
= it
->face_id
;
3406 p
->string
= it
->string
;
3407 p
->pos
= it
->current
;
3408 p
->end_charpos
= it
->end_charpos
;
3409 p
->string_nchars
= it
->string_nchars
;
3411 p
->multibyte_p
= it
->multibyte_p
;
3412 p
->space_width
= it
->space_width
;
3413 p
->font_height
= it
->font_height
;
3414 p
->voffset
= it
->voffset
;
3415 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
3420 /* Restore IT's settings from IT->stack. Called, for example, when no
3421 more overlay strings must be processed, and we return to delivering
3422 display elements from a buffer, or when the end of a string from a
3423 `display' property is reached and we return to delivering display
3424 elements from an overlay string, or from a buffer. */
3430 struct iterator_stack_entry
*p
;
3432 xassert (it
->sp
> 0);
3434 p
= it
->stack
+ it
->sp
;
3435 it
->stop_charpos
= p
->stop_charpos
;
3436 it
->face_id
= p
->face_id
;
3437 it
->string
= p
->string
;
3438 it
->current
= p
->pos
;
3439 it
->end_charpos
= p
->end_charpos
;
3440 it
->string_nchars
= p
->string_nchars
;
3442 it
->multibyte_p
= p
->multibyte_p
;
3443 it
->space_width
= p
->space_width
;
3444 it
->font_height
= p
->font_height
;
3445 it
->voffset
= p
->voffset
;
3446 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
3451 /***********************************************************************
3453 ***********************************************************************/
3455 /* Set IT's current position to the previous line start. */
3458 back_to_previous_line_start (it
)
3461 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
3462 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
3466 /* Move IT to the next line start.
3468 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
3469 we skipped over part of the text (as opposed to moving the iterator
3470 continuously over the text). Otherwise, don't change the value
3473 Newlines may come from buffer text, overlay strings, or strings
3474 displayed via the `display' property. That's the reason we can't
3475 simply use find_next_newline_no_quit.
3477 Note that this function may not skip over invisible text that is so
3478 because of text properties and immediately follows a newline. If
3479 it would, function reseat_at_next_visible_line_start, when called
3480 from set_iterator_to_next, would effectively make invisible
3481 characters following a newline part of the wrong glyph row, which
3482 leads to wrong cursor motion. */
3485 forward_to_next_line_start (it
, skipped_p
)
3489 int old_selective
, newline_found_p
, n
;
3490 const int MAX_NEWLINE_DISTANCE
= 500;
3492 /* If already on a newline, just consume it to avoid unintended
3493 skipping over invisible text below. */
3494 if (it
->what
== IT_CHARACTER
&& it
->c
== '\n')
3496 set_iterator_to_next (it
, 0);
3501 /* Don't handle selective display in the following. It's (a)
3502 unnecessary because it's done by the caller, and (b) leads to an
3503 infinite recursion because next_element_from_ellipsis indirectly
3504 calls this function. */
3505 old_selective
= it
->selective
;
3508 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
3509 from buffer text. */
3510 n
= newline_found_p
= 0;
3511 while (n
< MAX_NEWLINE_DISTANCE
3512 && get_next_display_element (it
)
3513 && !newline_found_p
)
3515 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
3516 set_iterator_to_next (it
, 0);
3517 if (!STRINGP (it
->string
))
3521 /* If we didn't find a newline near enough, see if we can use a
3523 if (!newline_found_p
&& n
== MAX_NEWLINE_DISTANCE
)
3525 int start
= IT_CHARPOS (*it
);
3526 int limit
= find_next_newline_no_quit (start
, 1);
3529 xassert (!STRINGP (it
->string
));
3531 /* If there isn't any `display' property in sight, and no
3532 overlays, we can just use the position of the newline in
3534 if (it
->stop_charpos
>= limit
3535 || ((pos
= Fnext_single_property_change (make_number (start
),
3537 Qnil
, make_number (limit
)),
3539 && next_overlay_change (start
) == ZV
))
3541 IT_CHARPOS (*it
) = limit
;
3542 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
3543 *skipped_p
= newline_found_p
= 1;
3547 while (get_next_display_element (it
)
3548 && !newline_found_p
)
3550 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
3551 set_iterator_to_next (it
, 0);
3556 it
->selective
= old_selective
;
3557 xassert (!newline_found_p
|| FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
3558 return newline_found_p
;
3562 /* Set IT's current position to the previous visible line start. Skip
3563 invisible text that is so either due to text properties or due to
3564 selective display. Caution: this does not change IT->current_x and
3568 back_to_previous_visible_line_start (it
)
3573 /* Go back one newline if not on BEGV already. */
3574 if (IT_CHARPOS (*it
) > BEGV
)
3575 back_to_previous_line_start (it
);
3577 /* Move over lines that are invisible because of selective display
3578 or text properties. */
3579 while (IT_CHARPOS (*it
) > BEGV
3584 /* If selective > 0, then lines indented more than that values
3586 if (it
->selective
> 0
3587 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
3594 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
)),
3595 Qinvisible
, it
->window
);
3596 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
3600 /* Back one more newline if the current one is invisible. */
3602 back_to_previous_line_start (it
);
3605 xassert (IT_CHARPOS (*it
) >= BEGV
);
3606 xassert (IT_CHARPOS (*it
) == BEGV
3607 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
3612 /* Reseat iterator IT at the previous visible line start. Skip
3613 invisible text that is so either due to text properties or due to
3614 selective display. At the end, update IT's overlay information,
3615 face information etc. */
3618 reseat_at_previous_visible_line_start (it
)
3621 back_to_previous_visible_line_start (it
);
3622 reseat (it
, it
->current
.pos
, 1);
3627 /* Reseat iterator IT on the next visible line start in the current
3628 buffer. ON_NEWLINE_P non-zero means position IT on the newline
3629 preceding the line start. Skip over invisible text that is so
3630 because of selective display. Compute faces, overlays etc at the
3631 new position. Note that this function does not skip over text that
3632 is invisible because of text properties. */
3635 reseat_at_next_visible_line_start (it
, on_newline_p
)
3639 int newline_found_p
, skipped_p
= 0;
3641 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
3643 /* Skip over lines that are invisible because they are indented
3644 more than the value of IT->selective. */
3645 if (it
->selective
> 0)
3646 while (IT_CHARPOS (*it
) < ZV
3647 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
3650 xassert (FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
3651 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
3654 /* Position on the newline if that's what's requested. */
3655 if (on_newline_p
&& newline_found_p
)
3657 if (STRINGP (it
->string
))
3659 if (IT_STRING_CHARPOS (*it
) > 0)
3661 --IT_STRING_CHARPOS (*it
);
3662 --IT_STRING_BYTEPOS (*it
);
3665 else if (IT_CHARPOS (*it
) > BEGV
)
3669 reseat (it
, it
->current
.pos
, 0);
3673 reseat (it
, it
->current
.pos
, 0);
3680 /***********************************************************************
3681 Changing an iterator's position
3682 ***********************************************************************/
3684 /* Change IT's current position to POS in current_buffer. If FORCE_P
3685 is non-zero, always check for text properties at the new position.
3686 Otherwise, text properties are only looked up if POS >=
3687 IT->check_charpos of a property. */
3690 reseat (it
, pos
, force_p
)
3692 struct text_pos pos
;
3695 int original_pos
= IT_CHARPOS (*it
);
3697 reseat_1 (it
, pos
, 0);
3699 /* Determine where to check text properties. Avoid doing it
3700 where possible because text property lookup is very expensive. */
3702 || CHARPOS (pos
) > it
->stop_charpos
3703 || CHARPOS (pos
) < original_pos
)
3710 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
3711 IT->stop_pos to POS, also. */
3714 reseat_1 (it
, pos
, set_stop_p
)
3716 struct text_pos pos
;
3719 /* Don't call this function when scanning a C string. */
3720 xassert (it
->s
== NULL
);
3722 /* POS must be a reasonable value. */
3723 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
3725 it
->current
.pos
= it
->position
= pos
;
3726 XSETBUFFER (it
->object
, current_buffer
);
3728 it
->current
.dpvec_index
= -1;
3729 it
->current
.overlay_string_index
= -1;
3730 IT_STRING_CHARPOS (*it
) = -1;
3731 IT_STRING_BYTEPOS (*it
) = -1;
3733 it
->method
= next_element_from_buffer
;
3735 it
->face_before_selective_p
= 0;
3738 it
->stop_charpos
= CHARPOS (pos
);
3742 /* Set up IT for displaying a string, starting at CHARPOS in window W.
3743 If S is non-null, it is a C string to iterate over. Otherwise,
3744 STRING gives a Lisp string to iterate over.
3746 If PRECISION > 0, don't return more then PRECISION number of
3747 characters from the string.
3749 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
3750 characters have been returned. FIELD_WIDTH < 0 means an infinite
3753 MULTIBYTE = 0 means disable processing of multibyte characters,
3754 MULTIBYTE > 0 means enable it,
3755 MULTIBYTE < 0 means use IT->multibyte_p.
3757 IT must be initialized via a prior call to init_iterator before
3758 calling this function. */
3761 reseat_to_string (it
, s
, string
, charpos
, precision
, field_width
, multibyte
)
3766 int precision
, field_width
, multibyte
;
3768 /* No region in strings. */
3769 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
3771 /* No text property checks performed by default, but see below. */
3772 it
->stop_charpos
= -1;
3774 /* Set iterator position and end position. */
3775 bzero (&it
->current
, sizeof it
->current
);
3776 it
->current
.overlay_string_index
= -1;
3777 it
->current
.dpvec_index
= -1;
3778 xassert (charpos
>= 0);
3780 /* Use the setting of MULTIBYTE if specified. */
3782 it
->multibyte_p
= multibyte
> 0;
3786 xassert (STRINGP (string
));
3787 it
->string
= string
;
3789 it
->end_charpos
= it
->string_nchars
= XSTRING (string
)->size
;
3790 it
->method
= next_element_from_string
;
3791 it
->current
.string_pos
= string_pos (charpos
, string
);
3798 /* Note that we use IT->current.pos, not it->current.string_pos,
3799 for displaying C strings. */
3800 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
3801 if (it
->multibyte_p
)
3803 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
3804 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
3808 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
3809 it
->end_charpos
= it
->string_nchars
= strlen (s
);
3812 it
->method
= next_element_from_c_string
;
3815 /* PRECISION > 0 means don't return more than PRECISION characters
3817 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
3818 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
3820 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
3821 characters have been returned. FIELD_WIDTH == 0 means don't pad,
3822 FIELD_WIDTH < 0 means infinite field width. This is useful for
3823 padding with `-' at the end of a mode line. */
3824 if (field_width
< 0)
3825 field_width
= INFINITY
;
3826 if (field_width
> it
->end_charpos
- charpos
)
3827 it
->end_charpos
= charpos
+ field_width
;
3829 /* Use the standard display table for displaying strings. */
3830 if (DISP_TABLE_P (Vstandard_display_table
))
3831 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
3833 it
->stop_charpos
= charpos
;
3839 /***********************************************************************
3841 ***********************************************************************/
3843 /* Load IT's display element fields with information about the next
3844 display element from the current position of IT. Value is zero if
3845 end of buffer (or C string) is reached. */
3848 get_next_display_element (it
)
3851 /* Non-zero means that we found an display element. Zero means that
3852 we hit the end of what we iterate over. Performance note: the
3853 function pointer `method' used here turns out to be faster than
3854 using a sequence of if-statements. */
3855 int success_p
= (*it
->method
) (it
);
3857 if (it
->what
== IT_CHARACTER
)
3859 /* Map via display table or translate control characters.
3860 IT->c, IT->len etc. have been set to the next character by
3861 the function call above. If we have a display table, and it
3862 contains an entry for IT->c, translate it. Don't do this if
3863 IT->c itself comes from a display table, otherwise we could
3864 end up in an infinite recursion. (An alternative could be to
3865 count the recursion depth of this function and signal an
3866 error when a certain maximum depth is reached.) Is it worth
3868 if (success_p
&& it
->dpvec
== NULL
)
3873 && (dv
= DISP_CHAR_VECTOR (it
->dp
, it
->c
),
3876 struct Lisp_Vector
*v
= XVECTOR (dv
);
3878 /* Return the first character from the display table
3879 entry, if not empty. If empty, don't display the
3880 current character. */
3883 it
->dpvec_char_len
= it
->len
;
3884 it
->dpvec
= v
->contents
;
3885 it
->dpend
= v
->contents
+ v
->size
;
3886 it
->current
.dpvec_index
= 0;
3887 it
->method
= next_element_from_display_vector
;
3890 success_p
= get_next_display_element (it
);
3893 /* Translate control characters into `\003' or `^C' form.
3894 Control characters coming from a display table entry are
3895 currently not translated because we use IT->dpvec to hold
3896 the translation. This could easily be changed but I
3897 don't believe that it is worth doing.
3899 Non-printable multibyte characters are also translated
3901 else if ((it
->c
< ' '
3902 && (it
->area
!= TEXT_AREA
3903 || (it
->c
!= '\n' && it
->c
!= '\t')))
3906 || !CHAR_PRINTABLE_P (it
->c
))
3908 /* IT->c is a control character which must be displayed
3909 either as '\003' or as `^C' where the '\\' and '^'
3910 can be defined in the display table. Fill
3911 IT->ctl_chars with glyphs for what we have to
3912 display. Then, set IT->dpvec to these glyphs. */
3915 if (it
->c
< 128 && it
->ctl_arrow_p
)
3917 /* Set IT->ctl_chars[0] to the glyph for `^'. */
3919 && INTEGERP (DISP_CTRL_GLYPH (it
->dp
))
3920 && GLYPH_CHAR_VALID_P (XINT (DISP_CTRL_GLYPH (it
->dp
))))
3921 g
= XINT (DISP_CTRL_GLYPH (it
->dp
));
3923 g
= FAST_MAKE_GLYPH ('^', 0);
3924 XSETINT (it
->ctl_chars
[0], g
);
3926 g
= FAST_MAKE_GLYPH (it
->c
^ 0100, 0);
3927 XSETINT (it
->ctl_chars
[1], g
);
3929 /* Set up IT->dpvec and return first character from it. */
3930 it
->dpvec_char_len
= it
->len
;
3931 it
->dpvec
= it
->ctl_chars
;
3932 it
->dpend
= it
->dpvec
+ 2;
3933 it
->current
.dpvec_index
= 0;
3934 it
->method
= next_element_from_display_vector
;
3935 get_next_display_element (it
);
3939 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
3944 /* Set IT->ctl_chars[0] to the glyph for `\\'. */
3946 && INTEGERP (DISP_ESCAPE_GLYPH (it
->dp
))
3947 && GLYPH_CHAR_VALID_P (XFASTINT (DISP_ESCAPE_GLYPH (it
->dp
))))
3948 escape_glyph
= XFASTINT (DISP_ESCAPE_GLYPH (it
->dp
));
3950 escape_glyph
= FAST_MAKE_GLYPH ('\\', 0);
3952 if (SINGLE_BYTE_CHAR_P (it
->c
))
3953 str
[0] = it
->c
, len
= 1;
3955 len
= CHAR_STRING (it
->c
, str
);
3957 for (i
= 0; i
< len
; i
++)
3959 XSETINT (it
->ctl_chars
[i
* 4], escape_glyph
);
3960 /* Insert three more glyphs into IT->ctl_chars for
3961 the octal display of the character. */
3962 g
= FAST_MAKE_GLYPH (((str
[i
] >> 6) & 7) + '0', 0);
3963 XSETINT (it
->ctl_chars
[i
* 4 + 1], g
);
3964 g
= FAST_MAKE_GLYPH (((str
[i
] >> 3) & 7) + '0', 0);
3965 XSETINT (it
->ctl_chars
[i
* 4 + 2], g
);
3966 g
= FAST_MAKE_GLYPH ((str
[i
] & 7) + '0', 0);
3967 XSETINT (it
->ctl_chars
[i
* 4 + 3], g
);
3970 /* Set up IT->dpvec and return the first character
3972 it
->dpvec_char_len
= it
->len
;
3973 it
->dpvec
= it
->ctl_chars
;
3974 it
->dpend
= it
->dpvec
+ len
* 4;
3975 it
->current
.dpvec_index
= 0;
3976 it
->method
= next_element_from_display_vector
;
3977 get_next_display_element (it
);
3982 /* Adjust face id for a multibyte character. There are no
3983 multibyte character in unibyte text. */
3986 && FRAME_WINDOW_P (it
->f
))
3988 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3989 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->c
);
3993 /* Is this character the last one of a run of characters with
3994 box? If yes, set IT->end_of_box_run_p to 1. */
4001 it
->end_of_box_run_p
4002 = ((face_id
= face_after_it_pos (it
),
4003 face_id
!= it
->face_id
)
4004 && (face
= FACE_FROM_ID (it
->f
, face_id
),
4005 face
->box
== FACE_NO_BOX
));
4008 /* Value is 0 if end of buffer or string reached. */
4013 /* Move IT to the next display element.
4015 RESEAT_P non-zero means if called on a newline in buffer text,
4016 skip to the next visible line start.
4018 Functions get_next_display_element and set_iterator_to_next are
4019 separate because I find this arrangement easier to handle than a
4020 get_next_display_element function that also increments IT's
4021 position. The way it is we can first look at an iterator's current
4022 display element, decide whether it fits on a line, and if it does,
4023 increment the iterator position. The other way around we probably
4024 would either need a flag indicating whether the iterator has to be
4025 incremented the next time, or we would have to implement a
4026 decrement position function which would not be easy to write. */
4029 set_iterator_to_next (it
, reseat_p
)
4033 /* Reset flags indicating start and end of a sequence of characters
4034 with box. Reset them at the start of this function because
4035 moving the iterator to a new position might set them. */
4036 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
4038 if (it
->method
== next_element_from_buffer
)
4040 /* The current display element of IT is a character from
4041 current_buffer. Advance in the buffer, and maybe skip over
4042 invisible lines that are so because of selective display. */
4043 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
4044 reseat_at_next_visible_line_start (it
, 0);
4047 xassert (it
->len
!= 0);
4048 IT_BYTEPOS (*it
) += it
->len
;
4049 IT_CHARPOS (*it
) += 1;
4050 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
4053 else if (it
->method
== next_element_from_composition
)
4055 xassert (it
->cmp_id
>= 0 && it
->cmp_id
< n_compositions
);
4056 if (STRINGP (it
->string
))
4058 IT_STRING_BYTEPOS (*it
) += it
->len
;
4059 IT_STRING_CHARPOS (*it
) += it
->cmp_len
;
4060 it
->method
= next_element_from_string
;
4061 goto consider_string_end
;
4065 IT_BYTEPOS (*it
) += it
->len
;
4066 IT_CHARPOS (*it
) += it
->cmp_len
;
4067 it
->method
= next_element_from_buffer
;
4070 else if (it
->method
== next_element_from_c_string
)
4072 /* Current display element of IT is from a C string. */
4073 IT_BYTEPOS (*it
) += it
->len
;
4074 IT_CHARPOS (*it
) += 1;
4076 else if (it
->method
== next_element_from_display_vector
)
4078 /* Current display element of IT is from a display table entry.
4079 Advance in the display table definition. Reset it to null if
4080 end reached, and continue with characters from buffers/
4082 ++it
->current
.dpvec_index
;
4084 /* Restore face of the iterator to what they were before the
4085 display vector entry (these entries may contain faces). */
4086 it
->face_id
= it
->saved_face_id
;
4088 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
4091 it
->method
= next_element_from_c_string
;
4092 else if (STRINGP (it
->string
))
4093 it
->method
= next_element_from_string
;
4095 it
->method
= next_element_from_buffer
;
4098 it
->current
.dpvec_index
= -1;
4100 /* Skip over characters which were displayed via IT->dpvec. */
4101 if (it
->dpvec_char_len
< 0)
4102 reseat_at_next_visible_line_start (it
, 1);
4103 else if (it
->dpvec_char_len
> 0)
4105 it
->len
= it
->dpvec_char_len
;
4106 set_iterator_to_next (it
, reseat_p
);
4110 else if (it
->method
== next_element_from_string
)
4112 /* Current display element is a character from a Lisp string. */
4113 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
4114 IT_STRING_BYTEPOS (*it
) += it
->len
;
4115 IT_STRING_CHARPOS (*it
) += 1;
4117 consider_string_end
:
4119 if (it
->current
.overlay_string_index
>= 0)
4121 /* IT->string is an overlay string. Advance to the
4122 next, if there is one. */
4123 if (IT_STRING_CHARPOS (*it
) >= XSTRING (it
->string
)->size
)
4124 next_overlay_string (it
);
4128 /* IT->string is not an overlay string. If we reached
4129 its end, and there is something on IT->stack, proceed
4130 with what is on the stack. This can be either another
4131 string, this time an overlay string, or a buffer. */
4132 if (IT_STRING_CHARPOS (*it
) == XSTRING (it
->string
)->size
4136 if (!STRINGP (it
->string
))
4137 it
->method
= next_element_from_buffer
;
4141 else if (it
->method
== next_element_from_image
4142 || it
->method
== next_element_from_stretch
)
4144 /* The position etc with which we have to proceed are on
4145 the stack. The position may be at the end of a string,
4146 if the `display' property takes up the whole string. */
4149 if (STRINGP (it
->string
))
4151 it
->method
= next_element_from_string
;
4152 goto consider_string_end
;
4155 it
->method
= next_element_from_buffer
;
4158 /* There are no other methods defined, so this should be a bug. */
4161 xassert (it
->method
!= next_element_from_string
4162 || (STRINGP (it
->string
)
4163 && IT_STRING_CHARPOS (*it
) >= 0));
4167 /* Load IT's display element fields with information about the next
4168 display element which comes from a display table entry or from the
4169 result of translating a control character to one of the forms `^C'
4170 or `\003'. IT->dpvec holds the glyphs to return as characters. */
4173 next_element_from_display_vector (it
)
4177 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
4179 /* Remember the current face id in case glyphs specify faces.
4180 IT's face is restored in set_iterator_to_next. */
4181 it
->saved_face_id
= it
->face_id
;
4183 if (INTEGERP (*it
->dpvec
)
4184 && GLYPH_CHAR_VALID_P (XFASTINT (*it
->dpvec
)))
4189 g
= XFASTINT (it
->dpvec
[it
->current
.dpvec_index
]);
4190 it
->c
= FAST_GLYPH_CHAR (g
);
4191 it
->len
= CHAR_BYTES (it
->c
);
4193 /* The entry may contain a face id to use. Such a face id is
4194 the id of a Lisp face, not a realized face. A face id of
4195 zero means no face is specified. */
4196 lface_id
= FAST_GLYPH_FACE (g
);
4199 /* The function returns -1 if lface_id is invalid. */
4200 int face_id
= ascii_face_of_lisp_face (it
->f
, lface_id
);
4202 it
->face_id
= face_id
;
4206 /* Display table entry is invalid. Return a space. */
4207 it
->c
= ' ', it
->len
= 1;
4209 /* Don't change position and object of the iterator here. They are
4210 still the values of the character that had this display table
4211 entry or was translated, and that's what we want. */
4212 it
->what
= IT_CHARACTER
;
4217 /* Load IT with the next display element from Lisp string IT->string.
4218 IT->current.string_pos is the current position within the string.
4219 If IT->current.overlay_string_index >= 0, the Lisp string is an
4223 next_element_from_string (it
)
4226 struct text_pos position
;
4228 xassert (STRINGP (it
->string
));
4229 xassert (IT_STRING_CHARPOS (*it
) >= 0);
4230 position
= it
->current
.string_pos
;
4232 /* Time to check for invisible text? */
4233 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
4234 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
4238 /* Since a handler may have changed IT->method, we must
4240 return get_next_display_element (it
);
4243 if (it
->current
.overlay_string_index
>= 0)
4245 /* Get the next character from an overlay string. In overlay
4246 strings, There is no field width or padding with spaces to
4248 if (IT_STRING_CHARPOS (*it
) >= XSTRING (it
->string
)->size
)
4253 else if (STRING_MULTIBYTE (it
->string
))
4255 int remaining
= (STRING_BYTES (XSTRING (it
->string
))
4256 - IT_STRING_BYTEPOS (*it
));
4257 unsigned char *s
= (XSTRING (it
->string
)->data
4258 + IT_STRING_BYTEPOS (*it
));
4259 it
->c
= string_char_and_length (s
, remaining
, &it
->len
);
4263 it
->c
= XSTRING (it
->string
)->data
[IT_STRING_BYTEPOS (*it
)];
4269 /* Get the next character from a Lisp string that is not an
4270 overlay string. Such strings come from the mode line, for
4271 example. We may have to pad with spaces, or truncate the
4272 string. See also next_element_from_c_string. */
4273 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
4278 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
4280 /* Pad with spaces. */
4281 it
->c
= ' ', it
->len
= 1;
4282 CHARPOS (position
) = BYTEPOS (position
) = -1;
4284 else if (STRING_MULTIBYTE (it
->string
))
4286 int maxlen
= (STRING_BYTES (XSTRING (it
->string
))
4287 - IT_STRING_BYTEPOS (*it
));
4288 unsigned char *s
= (XSTRING (it
->string
)->data
4289 + IT_STRING_BYTEPOS (*it
));
4290 it
->c
= string_char_and_length (s
, maxlen
, &it
->len
);
4294 it
->c
= XSTRING (it
->string
)->data
[IT_STRING_BYTEPOS (*it
)];
4299 /* Record what we have and where it came from. Note that we store a
4300 buffer position in IT->position although it could arguably be a
4302 it
->what
= IT_CHARACTER
;
4303 it
->object
= it
->string
;
4304 it
->position
= position
;
4309 /* Load IT with next display element from C string IT->s.
4310 IT->string_nchars is the maximum number of characters to return
4311 from the string. IT->end_charpos may be greater than
4312 IT->string_nchars when this function is called, in which case we
4313 may have to return padding spaces. Value is zero if end of string
4314 reached, including padding spaces. */
4317 next_element_from_c_string (it
)
4323 it
->what
= IT_CHARACTER
;
4324 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
4327 /* IT's position can be greater IT->string_nchars in case a field
4328 width or precision has been specified when the iterator was
4330 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
4332 /* End of the game. */
4336 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
4338 /* Pad with spaces. */
4339 it
->c
= ' ', it
->len
= 1;
4340 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
4342 else if (it
->multibyte_p
)
4344 /* Implementation note: The calls to strlen apparently aren't a
4345 performance problem because there is no noticeable performance
4346 difference between Emacs running in unibyte or multibyte mode. */
4347 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
4348 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
),
4352 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
4358 /* Set up IT to return characters from an ellipsis, if appropriate.
4359 The definition of the ellipsis glyphs may come from a display table
4360 entry. This function Fills IT with the first glyph from the
4361 ellipsis if an ellipsis is to be displayed. */
4364 next_element_from_ellipsis (it
)
4367 if (it
->selective_display_ellipsis_p
)
4369 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4371 /* Use the display table definition for `...'. Invalid glyphs
4372 will be handled by the method returning elements from dpvec. */
4373 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4374 it
->dpvec_char_len
= it
->len
;
4375 it
->dpvec
= v
->contents
;
4376 it
->dpend
= v
->contents
+ v
->size
;
4377 it
->current
.dpvec_index
= 0;
4378 it
->method
= next_element_from_display_vector
;
4382 /* Use default `...' which is stored in default_invis_vector. */
4383 it
->dpvec_char_len
= it
->len
;
4384 it
->dpvec
= default_invis_vector
;
4385 it
->dpend
= default_invis_vector
+ 3;
4386 it
->current
.dpvec_index
= 0;
4387 it
->method
= next_element_from_display_vector
;
4392 /* The face at the current position may be different from the
4393 face we find after the invisible text. Remember what it
4394 was in IT->saved_face_id, and signal that it's there by
4395 setting face_before_selective_p. */
4396 it
->saved_face_id
= it
->face_id
;
4397 it
->method
= next_element_from_buffer
;
4398 reseat_at_next_visible_line_start (it
, 1);
4399 it
->face_before_selective_p
= 1;
4402 return get_next_display_element (it
);
4406 /* Deliver an image display element. The iterator IT is already
4407 filled with image information (done in handle_display_prop). Value
4412 next_element_from_image (it
)
4415 it
->what
= IT_IMAGE
;
4420 /* Fill iterator IT with next display element from a stretch glyph
4421 property. IT->object is the value of the text property. Value is
4425 next_element_from_stretch (it
)
4428 it
->what
= IT_STRETCH
;
4433 /* Load IT with the next display element from current_buffer. Value
4434 is zero if end of buffer reached. IT->stop_charpos is the next
4435 position at which to stop and check for text properties or buffer
4439 next_element_from_buffer (it
)
4444 /* Check this assumption, otherwise, we would never enter the
4445 if-statement, below. */
4446 xassert (IT_CHARPOS (*it
) >= BEGV
4447 && IT_CHARPOS (*it
) <= it
->stop_charpos
);
4449 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
4451 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
4453 int overlay_strings_follow_p
;
4455 /* End of the game, except when overlay strings follow that
4456 haven't been returned yet. */
4457 if (it
->overlay_strings_at_end_processed_p
)
4458 overlay_strings_follow_p
= 0;
4461 it
->overlay_strings_at_end_processed_p
= 1;
4462 overlay_strings_follow_p
= get_overlay_strings (it
);
4465 if (overlay_strings_follow_p
)
4466 success_p
= get_next_display_element (it
);
4470 it
->position
= it
->current
.pos
;
4477 return get_next_display_element (it
);
4482 /* No face changes, overlays etc. in sight, so just return a
4483 character from current_buffer. */
4486 /* Maybe run the redisplay end trigger hook. Performance note:
4487 This doesn't seem to cost measurable time. */
4488 if (it
->redisplay_end_trigger_charpos
4490 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
4491 run_redisplay_end_trigger_hook (it
);
4493 /* Get the next character, maybe multibyte. */
4494 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
4495 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
4497 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT_BYTE
? ZV_BYTE
: GPT_BYTE
)
4498 - IT_BYTEPOS (*it
));
4499 it
->c
= string_char_and_length (p
, maxlen
, &it
->len
);
4502 it
->c
= *p
, it
->len
= 1;
4504 /* Record what we have and where it came from. */
4505 it
->what
= IT_CHARACTER
;;
4506 it
->object
= it
->w
->buffer
;
4507 it
->position
= it
->current
.pos
;
4509 /* Normally we return the character found above, except when we
4510 really want to return an ellipsis for selective display. */
4515 /* A value of selective > 0 means hide lines indented more
4516 than that number of columns. */
4517 if (it
->selective
> 0
4518 && IT_CHARPOS (*it
) + 1 < ZV
4519 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
4520 IT_BYTEPOS (*it
) + 1,
4523 success_p
= next_element_from_ellipsis (it
);
4524 it
->dpvec_char_len
= -1;
4527 else if (it
->c
== '\r' && it
->selective
== -1)
4529 /* A value of selective == -1 means that everything from the
4530 CR to the end of the line is invisible, with maybe an
4531 ellipsis displayed for it. */
4532 success_p
= next_element_from_ellipsis (it
);
4533 it
->dpvec_char_len
= -1;
4538 /* Value is zero if end of buffer reached. */
4539 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
4544 /* Run the redisplay end trigger hook for IT. */
4547 run_redisplay_end_trigger_hook (it
)
4550 Lisp_Object args
[3];
4552 /* IT->glyph_row should be non-null, i.e. we should be actually
4553 displaying something, or otherwise we should not run the hook. */
4554 xassert (it
->glyph_row
);
4556 /* Set up hook arguments. */
4557 args
[0] = Qredisplay_end_trigger_functions
;
4558 args
[1] = it
->window
;
4559 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
4560 it
->redisplay_end_trigger_charpos
= 0;
4562 /* Since we are *trying* to run these functions, don't try to run
4563 them again, even if they get an error. */
4564 it
->w
->redisplay_end_trigger
= Qnil
;
4565 Frun_hook_with_args (3, args
);
4567 /* Notice if it changed the face of the character we are on. */
4568 handle_face_prop (it
);
4572 /* Deliver a composition display element. The iterator IT is already
4573 filled with composition information (done in
4574 handle_composition_prop). Value is always 1. */
4577 next_element_from_composition (it
)
4580 it
->what
= IT_COMPOSITION
;
4581 it
->position
= (STRINGP (it
->string
)
4582 ? it
->current
.string_pos
4589 /***********************************************************************
4590 Moving an iterator without producing glyphs
4591 ***********************************************************************/
4593 /* Move iterator IT to a specified buffer or X position within one
4594 line on the display without producing glyphs.
4596 Begin to skip at IT's current position. Skip to TO_CHARPOS or TO_X
4597 whichever is reached first.
4599 TO_CHARPOS <= 0 means no TO_CHARPOS is specified.
4601 TO_X < 0 means that no TO_X is specified. TO_X is normally a value
4602 0 <= TO_X <= IT->last_visible_x. This means in particular, that
4603 TO_X includes the amount by which a window is horizontally
4608 MOVE_POS_MATCH_OR_ZV
4609 - when TO_POS or ZV was reached.
4612 -when TO_X was reached before TO_POS or ZV were reached.
4615 - when we reached the end of the display area and the line must
4619 - when we reached the end of the display area and the line is
4623 - when we stopped at a line end, i.e. a newline or a CR and selective
4626 static enum move_it_result
4627 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
)
4629 int to_charpos
, to_x
, op
;
4631 enum move_it_result result
= MOVE_UNDEFINED
;
4632 struct glyph_row
*saved_glyph_row
;
4634 /* Don't produce glyphs in produce_glyphs. */
4635 saved_glyph_row
= it
->glyph_row
;
4636 it
->glyph_row
= NULL
;
4640 int x
, i
, ascent
= 0, descent
= 0;
4642 /* Stop when ZV or TO_CHARPOS reached. */
4643 if (!get_next_display_element (it
)
4644 || ((op
& MOVE_TO_POS
) != 0
4645 && BUFFERP (it
->object
)
4646 && IT_CHARPOS (*it
) >= to_charpos
))
4648 result
= MOVE_POS_MATCH_OR_ZV
;
4652 /* The call to produce_glyphs will get the metrics of the
4653 display element IT is loaded with. We record in x the
4654 x-position before this display element in case it does not
4658 /* Remember the line height so far in case the next element doesn't
4660 if (!it
->truncate_lines_p
)
4662 ascent
= it
->max_ascent
;
4663 descent
= it
->max_descent
;
4666 PRODUCE_GLYPHS (it
);
4668 if (it
->area
!= TEXT_AREA
)
4670 set_iterator_to_next (it
, 1);
4674 /* The number of glyphs we get back in IT->nglyphs will normally
4675 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
4676 character on a terminal frame, or (iii) a line end. For the
4677 second case, IT->nglyphs - 1 padding glyphs will be present
4678 (on X frames, there is only one glyph produced for a
4679 composite character.
4681 The behavior implemented below means, for continuation lines,
4682 that as many spaces of a TAB as fit on the current line are
4683 displayed there. For terminal frames, as many glyphs of a
4684 multi-glyph character are displayed in the current line, too.
4685 This is what the old redisplay code did, and we keep it that
4686 way. Under X, the whole shape of a complex character must
4687 fit on the line or it will be completely displayed in the
4690 Note that both for tabs and padding glyphs, all glyphs have
4694 /* More than one glyph or glyph doesn't fit on line. All
4695 glyphs have the same width. */
4696 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
4699 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
4701 new_x
= x
+ single_glyph_width
;
4703 /* We want to leave anything reaching TO_X to the caller. */
4704 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
4707 result
= MOVE_X_REACHED
;
4710 else if (/* Lines are continued. */
4711 !it
->truncate_lines_p
4712 && (/* And glyph doesn't fit on the line. */
4713 new_x
> it
->last_visible_x
4714 /* Or it fits exactly and we're on a window
4716 || (new_x
== it
->last_visible_x
4717 && FRAME_WINDOW_P (it
->f
))))
4719 if (/* IT->hpos == 0 means the very first glyph
4720 doesn't fit on the line, e.g. a wide image. */
4722 || (new_x
== it
->last_visible_x
4723 && FRAME_WINDOW_P (it
->f
)))
4726 it
->current_x
= new_x
;
4727 if (i
== it
->nglyphs
- 1)
4728 set_iterator_to_next (it
, 1);
4733 it
->max_ascent
= ascent
;
4734 it
->max_descent
= descent
;
4737 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
4739 result
= MOVE_LINE_CONTINUED
;
4742 else if (new_x
> it
->first_visible_x
)
4744 /* Glyph is visible. Increment number of glyphs that
4745 would be displayed. */
4750 /* Glyph is completely off the left margin of the display
4751 area. Nothing to do. */
4755 if (result
!= MOVE_UNDEFINED
)
4758 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
4760 /* Stop when TO_X specified and reached. This check is
4761 necessary here because of lines consisting of a line end,
4762 only. The line end will not produce any glyphs and we
4763 would never get MOVE_X_REACHED. */
4764 xassert (it
->nglyphs
== 0);
4765 result
= MOVE_X_REACHED
;
4769 /* Is this a line end? If yes, we're done. */
4770 if (ITERATOR_AT_END_OF_LINE_P (it
))
4772 result
= MOVE_NEWLINE_OR_CR
;
4776 /* The current display element has been consumed. Advance
4778 set_iterator_to_next (it
, 1);
4780 /* Stop if lines are truncated and IT's current x-position is
4781 past the right edge of the window now. */
4782 if (it
->truncate_lines_p
4783 && it
->current_x
>= it
->last_visible_x
)
4785 result
= MOVE_LINE_TRUNCATED
;
4790 /* Restore the iterator settings altered at the beginning of this
4792 it
->glyph_row
= saved_glyph_row
;
4797 /* Move IT forward to a specified buffer position TO_CHARPOS, TO_X,
4798 TO_Y, TO_VPOS. OP is a bit-mask that specifies where to stop. See
4799 the description of enum move_operation_enum.
4801 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
4802 screen line, this function will set IT to the next position >
4806 move_it_to (it
, to_charpos
, to_x
, to_y
, to_vpos
, op
)
4808 int to_charpos
, to_x
, to_y
, to_vpos
;
4811 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
4817 if (op
& MOVE_TO_VPOS
)
4819 /* If no TO_CHARPOS and no TO_X specified, stop at the
4820 start of the line TO_VPOS. */
4821 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
4823 if (it
->vpos
== to_vpos
)
4829 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
4833 /* TO_VPOS >= 0 means stop at TO_X in the line at
4834 TO_VPOS, or at TO_POS, whichever comes first. */
4835 if (it
->vpos
== to_vpos
)
4841 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
4843 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
4848 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
4850 /* We have reached TO_X but not in the line we want. */
4851 skip
= move_it_in_display_line_to (it
, to_charpos
,
4853 if (skip
== MOVE_POS_MATCH_OR_ZV
)
4861 else if (op
& MOVE_TO_Y
)
4863 struct it it_backup
;
4865 /* TO_Y specified means stop at TO_X in the line containing
4866 TO_Y---or at TO_CHARPOS if this is reached first. The
4867 problem is that we can't really tell whether the line
4868 contains TO_Y before we have completely scanned it, and
4869 this may skip past TO_X. What we do is to first scan to
4872 If TO_X is not specified, use a TO_X of zero. The reason
4873 is to make the outcome of this function more predictable.
4874 If we didn't use TO_X == 0, we would stop at the end of
4875 the line which is probably not what a caller would expect
4877 skip
= move_it_in_display_line_to (it
, to_charpos
,
4881 | (op
& MOVE_TO_POS
)));
4883 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
4884 if (skip
== MOVE_POS_MATCH_OR_ZV
)
4890 /* If TO_X was reached, we would like to know whether TO_Y
4891 is in the line. This can only be said if we know the
4892 total line height which requires us to scan the rest of
4894 if (skip
== MOVE_X_REACHED
)
4897 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
4898 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
4900 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
4903 /* Now, decide whether TO_Y is in this line. */
4904 line_height
= it
->max_ascent
+ it
->max_descent
;
4905 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
4907 if (to_y
>= it
->current_y
4908 && to_y
< it
->current_y
+ line_height
)
4910 if (skip
== MOVE_X_REACHED
)
4911 /* If TO_Y is in this line and TO_X was reached above,
4912 we scanned too far. We have to restore IT's settings
4913 to the ones before skipping. */
4917 else if (skip
== MOVE_X_REACHED
)
4920 if (skip
== MOVE_POS_MATCH_OR_ZV
)
4928 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
4932 case MOVE_POS_MATCH_OR_ZV
:
4936 case MOVE_NEWLINE_OR_CR
:
4937 set_iterator_to_next (it
, 1);
4938 it
->continuation_lines_width
= 0;
4941 case MOVE_LINE_TRUNCATED
:
4942 it
->continuation_lines_width
= 0;
4943 reseat_at_next_visible_line_start (it
, 0);
4944 if ((op
& MOVE_TO_POS
) != 0
4945 && IT_CHARPOS (*it
) > to_charpos
)
4952 case MOVE_LINE_CONTINUED
:
4953 it
->continuation_lines_width
+= it
->current_x
;
4960 /* Reset/increment for the next run. */
4961 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
4962 it
->current_x
= it
->hpos
= 0;
4963 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
4965 last_height
= it
->max_ascent
+ it
->max_descent
;
4966 last_max_ascent
= it
->max_ascent
;
4967 it
->max_ascent
= it
->max_descent
= 0;
4972 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
4976 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
4978 If DY > 0, move IT backward at least that many pixels. DY = 0
4979 means move IT backward to the preceding line start or BEGV. This
4980 function may move over more than DY pixels if IT->current_y - DY
4981 ends up in the middle of a line; in this case IT->current_y will be
4982 set to the top of the line moved to. */
4985 move_it_vertically_backward (it
, dy
)
4989 int nlines
, h
, line_height
;
4991 int start_pos
= IT_CHARPOS (*it
);
4995 /* Estimate how many newlines we must move back. */
4996 nlines
= max (1, dy
/ CANON_Y_UNIT (it
->f
));
4998 /* Set the iterator's position that many lines back. */
4999 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
5000 back_to_previous_visible_line_start (it
);
5002 /* Reseat the iterator here. When moving backward, we don't want
5003 reseat to skip forward over invisible text, set up the iterator
5004 to deliver from overlay strings at the new position etc. So,
5005 use reseat_1 here. */
5006 reseat_1 (it
, it
->current
.pos
, 1);
5008 /* We are now surely at a line start. */
5009 it
->current_x
= it
->hpos
= 0;
5011 /* Move forward and see what y-distance we moved. First move to the
5012 start of the next line so that we get its height. We need this
5013 height to be able to tell whether we reached the specified
5016 it2
.max_ascent
= it2
.max_descent
= 0;
5017 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
5018 MOVE_TO_POS
| MOVE_TO_VPOS
);
5019 xassert (IT_CHARPOS (*it
) >= BEGV
);
5020 line_height
= it2
.max_ascent
+ it2
.max_descent
;
5022 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
5023 xassert (IT_CHARPOS (*it
) >= BEGV
);
5024 h
= it2
.current_y
- it
->current_y
;
5025 nlines
= it2
.vpos
- it
->vpos
;
5027 /* Correct IT's y and vpos position. */
5033 /* DY == 0 means move to the start of the screen line. The
5034 value of nlines is > 0 if continuation lines were involved. */
5036 move_it_by_lines (it
, nlines
, 1);
5037 xassert (IT_CHARPOS (*it
) <= start_pos
);
5041 /* The y-position we try to reach. Note that h has been
5042 subtracted in front of the if-statement. */
5043 int target_y
= it
->current_y
+ h
- dy
;
5045 /* If we did not reach target_y, try to move further backward if
5046 we can. If we moved too far backward, try to move forward. */
5047 if (target_y
< it
->current_y
5048 && IT_CHARPOS (*it
) > BEGV
)
5050 move_it_vertically (it
, target_y
- it
->current_y
);
5051 xassert (IT_CHARPOS (*it
) >= BEGV
);
5053 else if (target_y
>= it
->current_y
+ line_height
5054 && IT_CHARPOS (*it
) < ZV
)
5056 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
5057 xassert (IT_CHARPOS (*it
) >= BEGV
);
5063 /* Move IT by a specified amount of pixel lines DY. DY negative means
5064 move backwards. DY = 0 means move to start of screen line. At the
5065 end, IT will be on the start of a screen line. */
5068 move_it_vertically (it
, dy
)
5073 move_it_vertically_backward (it
, -dy
);
5076 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
5077 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
5078 MOVE_TO_POS
| MOVE_TO_Y
);
5079 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
5081 /* If buffer ends in ZV without a newline, move to the start of
5082 the line to satisfy the post-condition. */
5083 if (IT_CHARPOS (*it
) == ZV
5084 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
5085 move_it_by_lines (it
, 0, 0);
5090 /* Move iterator IT past the end of the text line it is in. */
5093 move_it_past_eol (it
)
5096 enum move_it_result rc
;
5098 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
5099 if (rc
== MOVE_NEWLINE_OR_CR
)
5100 set_iterator_to_next (it
, 0);
5104 #if 0 /* Currently not used. */
5106 /* Return non-zero if some text between buffer positions START_CHARPOS
5107 and END_CHARPOS is invisible. IT->window is the window for text
5111 invisible_text_between_p (it
, start_charpos
, end_charpos
)
5113 int start_charpos
, end_charpos
;
5115 Lisp_Object prop
, limit
;
5116 int invisible_found_p
;
5118 xassert (it
!= NULL
&& start_charpos
<= end_charpos
);
5120 /* Is text at START invisible? */
5121 prop
= Fget_char_property (make_number (start_charpos
), Qinvisible
,
5123 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5124 invisible_found_p
= 1;
5127 limit
= Fnext_single_char_property_change (make_number (start_charpos
),
5129 make_number (end_charpos
));
5130 invisible_found_p
= XFASTINT (limit
) < end_charpos
;
5133 return invisible_found_p
;
5139 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
5140 negative means move up. DVPOS == 0 means move to the start of the
5141 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
5142 NEED_Y_P is zero, IT->current_y will be left unchanged.
5144 Further optimization ideas: If we would know that IT->f doesn't use
5145 a face with proportional font, we could be faster for
5146 truncate-lines nil. */
5149 move_it_by_lines (it
, dvpos
, need_y_p
)
5151 int dvpos
, need_y_p
;
5153 struct position pos
;
5155 if (!FRAME_WINDOW_P (it
->f
))
5157 struct text_pos textpos
;
5159 /* We can use vmotion on frames without proportional fonts. */
5160 pos
= *vmotion (IT_CHARPOS (*it
), dvpos
, it
->w
);
5161 SET_TEXT_POS (textpos
, pos
.bufpos
, pos
.bytepos
);
5162 reseat (it
, textpos
, 1);
5163 it
->vpos
+= pos
.vpos
;
5164 it
->current_y
+= pos
.vpos
;
5166 else if (dvpos
== 0)
5168 /* DVPOS == 0 means move to the start of the screen line. */
5169 move_it_vertically_backward (it
, 0);
5170 xassert (it
->current_x
== 0 && it
->hpos
== 0);
5173 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
5177 int start_charpos
, i
;
5179 /* Go back -DVPOS visible lines and reseat the iterator there. */
5180 start_charpos
= IT_CHARPOS (*it
);
5181 for (i
= -dvpos
; i
&& IT_CHARPOS (*it
) > BEGV
; --i
)
5182 back_to_previous_visible_line_start (it
);
5183 reseat (it
, it
->current
.pos
, 1);
5184 it
->current_x
= it
->hpos
= 0;
5186 /* Above call may have moved too far if continuation lines
5187 are involved. Scan forward and see if it did. */
5189 it2
.vpos
= it2
.current_y
= 0;
5190 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
5191 it
->vpos
-= it2
.vpos
;
5192 it
->current_y
-= it2
.current_y
;
5193 it
->current_x
= it
->hpos
= 0;
5195 /* If we moved too far, move IT some lines forward. */
5196 if (it2
.vpos
> -dvpos
)
5198 int delta
= it2
.vpos
+ dvpos
;
5199 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
5206 /***********************************************************************
5208 ***********************************************************************/
5211 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
5215 add_to_log (format
, arg1
, arg2
)
5217 Lisp_Object arg1
, arg2
;
5219 Lisp_Object args
[3];
5220 Lisp_Object msg
, fmt
;
5223 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
5226 GCPRO4 (fmt
, msg
, arg1
, arg2
);
5228 args
[0] = fmt
= build_string (format
);
5231 msg
= Fformat (3, args
);
5233 len
= STRING_BYTES (XSTRING (msg
)) + 1;
5234 buffer
= (char *) alloca (len
);
5235 strcpy (buffer
, XSTRING (msg
)->data
);
5237 message_dolog (buffer
, len
- 1, 1, 0);
5242 /* Output a newline in the *Messages* buffer if "needs" one. */
5245 message_log_maybe_newline ()
5247 if (message_log_need_newline
)
5248 message_dolog ("", 0, 1, 0);
5252 /* Add a string M of length LEN to the message log, optionally
5253 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
5254 nonzero, means interpret the contents of M as multibyte. This
5255 function calls low-level routines in order to bypass text property
5256 hooks, etc. which might not be safe to run. */
5259 message_dolog (m
, len
, nlflag
, multibyte
)
5261 int len
, nlflag
, multibyte
;
5263 if (!NILP (Vmessage_log_max
))
5265 struct buffer
*oldbuf
;
5266 Lisp_Object oldpoint
, oldbegv
, oldzv
;
5267 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
5268 int point_at_end
= 0;
5270 Lisp_Object old_deactivate_mark
, tem
;
5271 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
5273 old_deactivate_mark
= Vdeactivate_mark
;
5274 oldbuf
= current_buffer
;
5275 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
5276 current_buffer
->undo_list
= Qt
;
5278 oldpoint
= Fpoint_marker ();
5279 oldbegv
= Fpoint_min_marker ();
5280 oldzv
= Fpoint_max_marker ();
5281 GCPRO4 (oldpoint
, oldbegv
, oldzv
, old_deactivate_mark
);
5289 BEGV_BYTE
= BEG_BYTE
;
5292 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
5294 /* Insert the string--maybe converting multibyte to single byte
5295 or vice versa, so that all the text fits the buffer. */
5297 && NILP (current_buffer
->enable_multibyte_characters
))
5300 unsigned char work
[1];
5302 /* Convert a multibyte string to single-byte
5303 for the *Message* buffer. */
5304 for (i
= 0; i
< len
; i
+= nbytes
)
5306 c
= string_char_and_length (m
+ i
, len
- i
, &nbytes
);
5307 work
[0] = (SINGLE_BYTE_CHAR_P (c
)
5309 : multibyte_char_to_unibyte (c
, Qnil
));
5310 insert_1_both (work
, 1, 1, 1, 0, 0);
5313 else if (! multibyte
5314 && ! NILP (current_buffer
->enable_multibyte_characters
))
5317 unsigned char *msg
= (unsigned char *) m
;
5318 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
5319 /* Convert a single-byte string to multibyte
5320 for the *Message* buffer. */
5321 for (i
= 0; i
< len
; i
++)
5323 c
= unibyte_char_to_multibyte (msg
[i
]);
5324 nbytes
= CHAR_STRING (c
, str
);
5325 insert_1_both (str
, 1, nbytes
, 1, 0, 0);
5329 insert_1 (m
, len
, 1, 0, 0);
5333 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
5334 insert_1 ("\n", 1, 1, 0, 0);
5336 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
5338 this_bol_byte
= PT_BYTE
;
5342 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
5344 prev_bol_byte
= PT_BYTE
;
5346 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
5347 this_bol
, this_bol_byte
);
5350 del_range_both (prev_bol
, prev_bol_byte
,
5351 this_bol
, this_bol_byte
, 0);
5357 /* If you change this format, don't forget to also
5358 change message_log_check_duplicate. */
5359 sprintf (dupstr
, " [%d times]", dup
);
5360 duplen
= strlen (dupstr
);
5361 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
5362 insert_1 (dupstr
, duplen
, 1, 0, 1);
5367 if (NATNUMP (Vmessage_log_max
))
5369 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
5370 -XFASTINT (Vmessage_log_max
) - 1, 0);
5371 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
5374 BEGV
= XMARKER (oldbegv
)->charpos
;
5375 BEGV_BYTE
= marker_byte_position (oldbegv
);
5384 ZV
= XMARKER (oldzv
)->charpos
;
5385 ZV_BYTE
= marker_byte_position (oldzv
);
5389 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
5391 /* We can't do Fgoto_char (oldpoint) because it will run some
5393 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
5394 XMARKER (oldpoint
)->bytepos
);
5397 free_marker (oldpoint
);
5398 free_marker (oldbegv
);
5399 free_marker (oldzv
);
5401 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
5402 set_buffer_internal (oldbuf
);
5404 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
5405 message_log_need_newline
= !nlflag
;
5406 Vdeactivate_mark
= old_deactivate_mark
;
5411 /* We are at the end of the buffer after just having inserted a newline.
5412 (Note: We depend on the fact we won't be crossing the gap.)
5413 Check to see if the most recent message looks a lot like the previous one.
5414 Return 0 if different, 1 if the new one should just replace it, or a
5415 value N > 1 if we should also append " [N times]". */
5418 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
5419 int prev_bol
, this_bol
;
5420 int prev_bol_byte
, this_bol_byte
;
5423 int len
= Z_BYTE
- 1 - this_bol_byte
;
5425 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
5426 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
5428 for (i
= 0; i
< len
; i
++)
5430 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
5438 if (*p1
++ == ' ' && *p1
++ == '[')
5441 while (*p1
>= '0' && *p1
<= '9')
5442 n
= n
* 10 + *p1
++ - '0';
5443 if (strncmp (p1
, " times]\n", 8) == 0)
5450 /* Display an echo area message M with a specified length of LEN
5451 chars. The string may include null characters. If M is 0, clear
5452 out any existing message, and let the mini-buffer text show through.
5454 The buffer M must continue to exist until after the echo area gets
5455 cleared or some other message gets displayed there. This means do
5456 not pass text that is stored in a Lisp string; do not pass text in
5457 a buffer that was alloca'd. */
5460 message2 (m
, len
, multibyte
)
5465 /* First flush out any partial line written with print. */
5466 message_log_maybe_newline ();
5468 message_dolog (m
, len
, 1, multibyte
);
5469 message2_nolog (m
, len
, multibyte
);
5473 /* The non-logging counterpart of message2. */
5476 message2_nolog (m
, len
, multibyte
)
5480 struct frame
*sf
= SELECTED_FRAME ();
5481 message_enable_multibyte
= multibyte
;
5485 if (noninteractive_need_newline
)
5486 putc ('\n', stderr
);
5487 noninteractive_need_newline
= 0;
5489 fwrite (m
, len
, 1, stderr
);
5490 if (cursor_in_echo_area
== 0)
5491 fprintf (stderr
, "\n");
5494 /* A null message buffer means that the frame hasn't really been
5495 initialized yet. Error messages get reported properly by
5496 cmd_error, so this must be just an informative message; toss it. */
5497 else if (INTERACTIVE
5498 && sf
->glyphs_initialized_p
5499 && FRAME_MESSAGE_BUF (sf
))
5501 Lisp_Object mini_window
;
5504 /* Get the frame containing the mini-buffer
5505 that the selected frame is using. */
5506 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
5507 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
5509 FRAME_SAMPLE_VISIBILITY (f
);
5510 if (FRAME_VISIBLE_P (sf
)
5511 && ! FRAME_VISIBLE_P (f
))
5512 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
5516 set_message (m
, Qnil
, len
, multibyte
);
5517 if (minibuffer_auto_raise
)
5518 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
5521 clear_message (1, 1);
5523 do_pending_window_change (0);
5524 echo_area_display (1);
5525 do_pending_window_change (0);
5526 if (frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
5527 (*frame_up_to_date_hook
) (f
);
5532 /* Display an echo area message M with a specified length of NBYTES
5533 bytes. The string may include null characters. If M is not a
5534 string, clear out any existing message, and let the mini-buffer
5535 text show through. */
5538 message3 (m
, nbytes
, multibyte
)
5543 struct gcpro gcpro1
;
5547 /* First flush out any partial line written with print. */
5548 message_log_maybe_newline ();
5550 message_dolog (XSTRING (m
)->data
, nbytes
, 1, multibyte
);
5551 message3_nolog (m
, nbytes
, multibyte
);
5557 /* The non-logging version of message3. */
5560 message3_nolog (m
, nbytes
, multibyte
)
5562 int nbytes
, multibyte
;
5564 struct frame
*sf
= SELECTED_FRAME ();
5565 message_enable_multibyte
= multibyte
;
5569 if (noninteractive_need_newline
)
5570 putc ('\n', stderr
);
5571 noninteractive_need_newline
= 0;
5573 fwrite (XSTRING (m
)->data
, nbytes
, 1, stderr
);
5574 if (cursor_in_echo_area
== 0)
5575 fprintf (stderr
, "\n");
5578 /* A null message buffer means that the frame hasn't really been
5579 initialized yet. Error messages get reported properly by
5580 cmd_error, so this must be just an informative message; toss it. */
5581 else if (INTERACTIVE
5582 && sf
->glyphs_initialized_p
5583 && FRAME_MESSAGE_BUF (sf
))
5585 Lisp_Object mini_window
;
5589 /* Get the frame containing the mini-buffer
5590 that the selected frame is using. */
5591 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
5592 frame
= XWINDOW (mini_window
)->frame
;
5595 FRAME_SAMPLE_VISIBILITY (f
);
5596 if (FRAME_VISIBLE_P (sf
)
5597 && !FRAME_VISIBLE_P (f
))
5598 Fmake_frame_visible (frame
);
5600 if (STRINGP (m
) && XSTRING (m
)->size
)
5602 set_message (NULL
, m
, nbytes
, multibyte
);
5603 if (minibuffer_auto_raise
)
5604 Fraise_frame (frame
);
5607 clear_message (1, 1);
5609 do_pending_window_change (0);
5610 echo_area_display (1);
5611 do_pending_window_change (0);
5612 if (frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
5613 (*frame_up_to_date_hook
) (f
);
5618 /* Display a null-terminated echo area message M. If M is 0, clear
5619 out any existing message, and let the mini-buffer text show through.
5621 The buffer M must continue to exist until after the echo area gets
5622 cleared or some other message gets displayed there. Do not pass
5623 text that is stored in a Lisp string. Do not pass text in a buffer
5624 that was alloca'd. */
5630 message2 (m
, (m
? strlen (m
) : 0), 0);
5634 /* The non-logging counterpart of message1. */
5640 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
5643 /* Display a message M which contains a single %s
5644 which gets replaced with STRING. */
5647 message_with_string (m
, string
, log
)
5656 if (noninteractive_need_newline
)
5657 putc ('\n', stderr
);
5658 noninteractive_need_newline
= 0;
5659 fprintf (stderr
, m
, XSTRING (string
)->data
);
5660 if (cursor_in_echo_area
== 0)
5661 fprintf (stderr
, "\n");
5665 else if (INTERACTIVE
)
5667 /* The frame whose minibuffer we're going to display the message on.
5668 It may be larger than the selected frame, so we need
5669 to use its buffer, not the selected frame's buffer. */
5670 Lisp_Object mini_window
;
5671 struct frame
*f
, *sf
= SELECTED_FRAME ();
5673 /* Get the frame containing the minibuffer
5674 that the selected frame is using. */
5675 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
5676 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
5678 /* A null message buffer means that the frame hasn't really been
5679 initialized yet. Error messages get reported properly by
5680 cmd_error, so this must be just an informative message; toss it. */
5681 if (FRAME_MESSAGE_BUF (f
))
5685 a
[0] = (char *) XSTRING (string
)->data
;
5687 len
= doprnt (FRAME_MESSAGE_BUF (f
),
5688 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
5691 message2 (FRAME_MESSAGE_BUF (f
), len
,
5692 STRING_MULTIBYTE (string
));
5694 message2_nolog (FRAME_MESSAGE_BUF (f
), len
,
5695 STRING_MULTIBYTE (string
));
5697 /* Print should start at the beginning of the message
5698 buffer next time. */
5699 message_buf_print
= 0;
5705 /* Dump an informative message to the minibuf. If M is 0, clear out
5706 any existing message, and let the mini-buffer text show through. */
5710 message (m
, a1
, a2
, a3
)
5712 EMACS_INT a1
, a2
, a3
;
5718 if (noninteractive_need_newline
)
5719 putc ('\n', stderr
);
5720 noninteractive_need_newline
= 0;
5721 fprintf (stderr
, m
, a1
, a2
, a3
);
5722 if (cursor_in_echo_area
== 0)
5723 fprintf (stderr
, "\n");
5727 else if (INTERACTIVE
)
5729 /* The frame whose mini-buffer we're going to display the message
5730 on. It may be larger than the selected frame, so we need to
5731 use its buffer, not the selected frame's buffer. */
5732 Lisp_Object mini_window
;
5733 struct frame
*f
, *sf
= SELECTED_FRAME ();
5735 /* Get the frame containing the mini-buffer
5736 that the selected frame is using. */
5737 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
5738 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
5740 /* A null message buffer means that the frame hasn't really been
5741 initialized yet. Error messages get reported properly by
5742 cmd_error, so this must be just an informative message; toss
5744 if (FRAME_MESSAGE_BUF (f
))
5755 len
= doprnt (FRAME_MESSAGE_BUF (f
),
5756 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
5758 len
= doprnt (FRAME_MESSAGE_BUF (f
),
5759 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3,
5761 #endif /* NO_ARG_ARRAY */
5763 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
5768 /* Print should start at the beginning of the message
5769 buffer next time. */
5770 message_buf_print
= 0;
5776 /* The non-logging version of message. */
5779 message_nolog (m
, a1
, a2
, a3
)
5781 EMACS_INT a1
, a2
, a3
;
5783 Lisp_Object old_log_max
;
5784 old_log_max
= Vmessage_log_max
;
5785 Vmessage_log_max
= Qnil
;
5786 message (m
, a1
, a2
, a3
);
5787 Vmessage_log_max
= old_log_max
;
5791 /* Display the current message in the current mini-buffer. This is
5792 only called from error handlers in process.c, and is not time
5798 if (!NILP (echo_area_buffer
[0]))
5801 string
= Fcurrent_message ();
5802 message3 (string
, XSTRING (string
)->size
,
5803 !NILP (current_buffer
->enable_multibyte_characters
));
5808 /* Make sure echo area buffers in echo_buffers[] are life. If they
5809 aren't, make new ones. */
5812 ensure_echo_area_buffers ()
5816 for (i
= 0; i
< 2; ++i
)
5817 if (!BUFFERP (echo_buffer
[i
])
5818 || NILP (XBUFFER (echo_buffer
[i
])->name
))
5821 Lisp_Object old_buffer
;
5824 old_buffer
= echo_buffer
[i
];
5825 sprintf (name
, " *Echo Area %d*", i
);
5826 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
5827 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
5829 for (j
= 0; j
< 2; ++j
)
5830 if (EQ (old_buffer
, echo_area_buffer
[j
]))
5831 echo_area_buffer
[j
] = echo_buffer
[i
];
5836 /* Call FN with args A1..A4 with either the current or last displayed
5837 echo_area_buffer as current buffer.
5839 WHICH zero means use the current message buffer
5840 echo_area_buffer[0]. If that is nil, choose a suitable buffer
5841 from echo_buffer[] and clear it.
5843 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
5844 suitable buffer from echo_buffer[] and clear it.
5846 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
5847 that the current message becomes the last displayed one, make
5848 choose a suitable buffer for echo_area_buffer[0], and clear it.
5850 Value is what FN returns. */
5853 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
)
5856 int (*fn
) P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
5862 int this_one
, the_other
, clear_buffer_p
, rc
;
5863 int count
= BINDING_STACK_SIZE ();
5865 /* If buffers aren't life, make new ones. */
5866 ensure_echo_area_buffers ();
5871 this_one
= 0, the_other
= 1;
5873 this_one
= 1, the_other
= 0;
5876 this_one
= 0, the_other
= 1;
5879 /* We need a fresh one in case the current echo buffer equals
5880 the one containing the last displayed echo area message. */
5881 if (!NILP (echo_area_buffer
[this_one
])
5882 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
5883 echo_area_buffer
[this_one
] = Qnil
;
5886 /* Choose a suitable buffer from echo_buffer[] is we don't
5888 if (NILP (echo_area_buffer
[this_one
]))
5890 echo_area_buffer
[this_one
]
5891 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
5892 ? echo_buffer
[the_other
]
5893 : echo_buffer
[this_one
]);
5897 buffer
= echo_area_buffer
[this_one
];
5899 record_unwind_protect (unwind_with_echo_area_buffer
,
5900 with_echo_area_buffer_unwind_data (w
));
5902 /* Make the echo area buffer current. Note that for display
5903 purposes, it is not necessary that the displayed window's buffer
5904 == current_buffer, except for text property lookup. So, let's
5905 only set that buffer temporarily here without doing a full
5906 Fset_window_buffer. We must also change w->pointm, though,
5907 because otherwise an assertions in unshow_buffer fails, and Emacs
5909 set_buffer_internal_1 (XBUFFER (buffer
));
5913 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
5916 current_buffer
->undo_list
= Qt
;
5917 current_buffer
->read_only
= Qnil
;
5918 specbind (Qinhibit_read_only
, Qt
);
5920 if (clear_buffer_p
&& Z
> BEG
)
5923 xassert (BEGV
>= BEG
);
5924 xassert (ZV
<= Z
&& ZV
>= BEGV
);
5926 rc
= fn (a1
, a2
, a3
, a4
);
5928 xassert (BEGV
>= BEG
);
5929 xassert (ZV
<= Z
&& ZV
>= BEGV
);
5931 unbind_to (count
, Qnil
);
5936 /* Save state that should be preserved around the call to the function
5937 FN called in with_echo_area_buffer. */
5940 with_echo_area_buffer_unwind_data (w
)
5946 /* Reduce consing by keeping one vector in
5947 Vwith_echo_area_save_vector. */
5948 vector
= Vwith_echo_area_save_vector
;
5949 Vwith_echo_area_save_vector
= Qnil
;
5952 vector
= Fmake_vector (make_number (7), Qnil
);
5954 XSETBUFFER (XVECTOR (vector
)->contents
[i
], current_buffer
); ++i
;
5955 XVECTOR (vector
)->contents
[i
++] = Vdeactivate_mark
;
5956 XVECTOR (vector
)->contents
[i
++] = make_number (windows_or_buffers_changed
);
5960 XSETWINDOW (XVECTOR (vector
)->contents
[i
], w
); ++i
;
5961 XVECTOR (vector
)->contents
[i
++] = w
->buffer
;
5962 XVECTOR (vector
)->contents
[i
++]
5963 = make_number (XMARKER (w
->pointm
)->charpos
);
5964 XVECTOR (vector
)->contents
[i
++]
5965 = make_number (XMARKER (w
->pointm
)->bytepos
);
5971 XVECTOR (vector
)->contents
[i
++] = Qnil
;
5974 xassert (i
== XVECTOR (vector
)->size
);
5979 /* Restore global state from VECTOR which was created by
5980 with_echo_area_buffer_unwind_data. */
5983 unwind_with_echo_area_buffer (vector
)
5986 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
5987 Vdeactivate_mark
= AREF (vector
, 1);
5988 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
5990 if (WINDOWP (AREF (vector
, 3)))
5993 Lisp_Object buffer
, charpos
, bytepos
;
5995 w
= XWINDOW (AREF (vector
, 3));
5996 buffer
= AREF (vector
, 4);
5997 charpos
= AREF (vector
, 5);
5998 bytepos
= AREF (vector
, 6);
6001 set_marker_both (w
->pointm
, buffer
,
6002 XFASTINT (charpos
), XFASTINT (bytepos
));
6005 Vwith_echo_area_save_vector
= vector
;
6010 /* Set up the echo area for use by print functions. MULTIBYTE_P
6011 non-zero means we will print multibyte. */
6014 setup_echo_area_for_printing (multibyte_p
)
6017 ensure_echo_area_buffers ();
6019 if (!message_buf_print
)
6021 /* A message has been output since the last time we printed.
6022 Choose a fresh echo area buffer. */
6023 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
6024 echo_area_buffer
[0] = echo_buffer
[1];
6026 echo_area_buffer
[0] = echo_buffer
[0];
6028 /* Switch to that buffer and clear it. */
6029 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
6033 int count
= BINDING_STACK_SIZE ();
6034 specbind (Qinhibit_read_only
, Qt
);
6036 unbind_to (count
, Qnil
);
6038 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
6040 /* Set up the buffer for the multibyteness we need. */
6042 != !NILP (current_buffer
->enable_multibyte_characters
))
6043 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
6045 /* Raise the frame containing the echo area. */
6046 if (minibuffer_auto_raise
)
6048 struct frame
*sf
= SELECTED_FRAME ();
6049 Lisp_Object mini_window
;
6050 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
6051 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
6054 message_log_maybe_newline ();
6055 message_buf_print
= 1;
6059 if (NILP (echo_area_buffer
[0]))
6061 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
6062 echo_area_buffer
[0] = echo_buffer
[1];
6064 echo_area_buffer
[0] = echo_buffer
[0];
6067 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
6068 /* Someone switched buffers between print requests. */
6069 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
6074 /* Display an echo area message in window W. Value is non-zero if W's
6075 height is changed. If display_last_displayed_message_p is
6076 non-zero, display the message that was last displayed, otherwise
6077 display the current message. */
6080 display_echo_area (w
)
6083 int i
, no_message_p
, window_height_changed_p
, count
;
6085 /* Temporarily disable garbage collections while displaying the echo
6086 area. This is done because a GC can print a message itself.
6087 That message would modify the echo area buffer's contents while a
6088 redisplay of the buffer is going on, and seriously confuse
6090 count
= inhibit_garbage_collection ();
6092 /* If there is no message, we must call display_echo_area_1
6093 nevertheless because it resizes the window. But we will have to
6094 reset the echo_area_buffer in question to nil at the end because
6095 with_echo_area_buffer will sets it to an empty buffer. */
6096 i
= display_last_displayed_message_p
? 1 : 0;
6097 no_message_p
= NILP (echo_area_buffer
[i
]);
6099 window_height_changed_p
6100 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
6101 display_echo_area_1
,
6102 (EMACS_INT
) w
, Qnil
, 0, 0);
6105 echo_area_buffer
[i
] = Qnil
;
6107 unbind_to (count
, Qnil
);
6108 return window_height_changed_p
;
6112 /* Helper for display_echo_area. Display the current buffer which
6113 contains the current echo area message in window W, a mini-window,
6114 a pointer to which is passed in A1. A2..A4 are currently not used.
6115 Change the height of W so that all of the message is displayed.
6116 Value is non-zero if height of W was changed. */
6119 display_echo_area_1 (a1
, a2
, a3
, a4
)
6124 struct window
*w
= (struct window
*) a1
;
6126 struct text_pos start
;
6127 int window_height_changed_p
= 0;
6129 /* Do this before displaying, so that we have a large enough glyph
6130 matrix for the display. */
6131 window_height_changed_p
= resize_mini_window (w
, 0);
6134 clear_glyph_matrix (w
->desired_matrix
);
6135 XSETWINDOW (window
, w
);
6136 SET_TEXT_POS (start
, BEG
, BEG_BYTE
);
6137 try_window (window
, start
);
6139 return window_height_changed_p
;
6143 /* Resize the echo area window to exactly the size needed for the
6144 currently displayed message, if there is one. */
6147 resize_echo_area_axactly ()
6149 if (BUFFERP (echo_area_buffer
[0])
6150 && WINDOWP (echo_area_window
))
6152 struct window
*w
= XWINDOW (echo_area_window
);
6155 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
6156 (EMACS_INT
) w
, Qnil
, 0, 0);
6159 ++windows_or_buffers_changed
;
6160 ++update_mode_lines
;
6161 redisplay_internal (0);
6167 /* Callback function for with_echo_area_buffer, when used from
6168 resize_echo_area_axactly. A1 contains a pointer to the window to
6169 resize, A2 to A4 are not used. Value is what resize_mini_window
6173 resize_mini_window_1 (a1
, a2
, a3
, a4
)
6178 return resize_mini_window ((struct window
*) a1
, 1);
6182 /* Resize mini-window W to fit the size of its contents. EXACT:P
6183 means size the window exactly to the size needed. Otherwise, it's
6184 only enlarged until W's buffer is empty. Value is non-zero if
6185 the window height has been changed. */
6188 resize_mini_window (w
, exact_p
)
6192 struct frame
*f
= XFRAME (w
->frame
);
6193 int window_height_changed_p
= 0;
6195 xassert (MINI_WINDOW_P (w
));
6197 /* Nil means don't try to resize. */
6198 if (NILP (Vresize_mini_windows
)
6199 || (FRAME_X_P (f
) && f
->output_data
.x
== NULL
))
6202 if (!FRAME_MINIBUF_ONLY_P (f
))
6205 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
6206 int total_height
= XFASTINT (root
->height
) + XFASTINT (w
->height
);
6207 int height
, max_height
;
6208 int unit
= CANON_Y_UNIT (f
);
6209 struct text_pos start
;
6210 struct buffer
*old_current_buffer
= NULL
;
6212 if (current_buffer
!= XBUFFER (w
->buffer
))
6214 old_current_buffer
= current_buffer
;
6215 set_buffer_internal (XBUFFER (w
->buffer
));
6218 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
6220 /* Compute the max. number of lines specified by the user. */
6221 if (FLOATP (Vmax_mini_window_height
))
6222 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
6223 else if (INTEGERP (Vmax_mini_window_height
))
6224 max_height
= XINT (Vmax_mini_window_height
);
6226 max_height
= total_height
/ 4;
6228 /* Correct that max. height if it's bogus. */
6229 max_height
= max (1, max_height
);
6230 max_height
= min (total_height
, max_height
);
6232 /* Find out the height of the text in the window. */
6233 if (it
.truncate_lines_p
)
6238 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
6239 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
6240 height
= it
.current_y
+ last_height
;
6242 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
6243 height
-= it
.extra_line_spacing
;
6244 height
= (height
+ unit
- 1) / unit
;
6247 /* Compute a suitable window start. */
6248 if (height
> max_height
)
6250 height
= max_height
;
6251 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
6252 move_it_vertically_backward (&it
, (height
- 1) * unit
);
6253 start
= it
.current
.pos
;
6256 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
6257 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
6259 if (EQ (Vresize_mini_windows
, Qgrow_only
))
6261 /* Let it grow only, until we display an empty message, in which
6262 case the window shrinks again. */
6263 if (height
> XFASTINT (w
->height
))
6265 int old_height
= XFASTINT (w
->height
);
6266 freeze_window_starts (f
, 1);
6267 grow_mini_window (w
, height
- XFASTINT (w
->height
));
6268 window_height_changed_p
= XFASTINT (w
->height
) != old_height
;
6270 else if (height
< XFASTINT (w
->height
)
6271 && (exact_p
|| BEGV
== ZV
))
6273 int old_height
= XFASTINT (w
->height
);
6274 freeze_window_starts (f
, 0);
6275 shrink_mini_window (w
);
6276 window_height_changed_p
= XFASTINT (w
->height
) != old_height
;
6281 /* Always resize to exact size needed. */
6282 if (height
> XFASTINT (w
->height
))
6284 int old_height
= XFASTINT (w
->height
);
6285 freeze_window_starts (f
, 1);
6286 grow_mini_window (w
, height
- XFASTINT (w
->height
));
6287 window_height_changed_p
= XFASTINT (w
->height
) != old_height
;
6289 else if (height
< XFASTINT (w
->height
))
6291 int old_height
= XFASTINT (w
->height
);
6292 freeze_window_starts (f
, 0);
6293 shrink_mini_window (w
);
6297 freeze_window_starts (f
, 1);
6298 grow_mini_window (w
, height
- XFASTINT (w
->height
));
6301 window_height_changed_p
= XFASTINT (w
->height
) != old_height
;
6305 if (old_current_buffer
)
6306 set_buffer_internal (old_current_buffer
);
6309 return window_height_changed_p
;
6313 /* Value is the current message, a string, or nil if there is no
6321 if (NILP (echo_area_buffer
[0]))
6325 with_echo_area_buffer (0, 0, current_message_1
,
6326 (EMACS_INT
) &msg
, Qnil
, 0, 0);
6328 echo_area_buffer
[0] = Qnil
;
6336 current_message_1 (a1
, a2
, a3
, a4
)
6341 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
6344 *msg
= make_buffer_string (BEG
, Z
, 1);
6351 /* Push the current message on Vmessage_stack for later restauration
6352 by restore_message. Value is non-zero if the current message isn't
6353 empty. This is a relatively infrequent operation, so it's not
6354 worth optimizing. */
6360 msg
= current_message ();
6361 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
6362 return STRINGP (msg
);
6366 /* Handler for record_unwind_protect calling pop_message. */
6369 push_message_unwind (dummy
)
6377 /* Restore message display from the top of Vmessage_stack. */
6384 xassert (CONSP (Vmessage_stack
));
6385 msg
= XCAR (Vmessage_stack
);
6387 message3_nolog (msg
, STRING_BYTES (XSTRING (msg
)), STRING_MULTIBYTE (msg
));
6389 message3_nolog (msg
, 0, 0);
6393 /* Pop the top-most entry off Vmessage_stack. */
6398 xassert (CONSP (Vmessage_stack
));
6399 Vmessage_stack
= XCDR (Vmessage_stack
);
6403 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
6404 exits. If the stack is not empty, we have a missing pop_message
6408 check_message_stack ()
6410 if (!NILP (Vmessage_stack
))
6415 /* Truncate to NCHARS what will be displayed in the echo area the next
6416 time we display it---but don't redisplay it now. */
6419 truncate_echo_area (nchars
)
6423 echo_area_buffer
[0] = Qnil
;
6424 /* A null message buffer means that the frame hasn't really been
6425 initialized yet. Error messages get reported properly by
6426 cmd_error, so this must be just an informative message; toss it. */
6427 else if (!noninteractive
6429 && !NILP (echo_area_buffer
[0]))
6431 struct frame
*sf
= SELECTED_FRAME ();
6432 if (FRAME_MESSAGE_BUF (sf
))
6433 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
6438 /* Helper function for truncate_echo_area. Truncate the current
6439 message to at most NCHARS characters. */
6442 truncate_message_1 (nchars
, a2
, a3
, a4
)
6447 if (BEG
+ nchars
< Z
)
6448 del_range (BEG
+ nchars
, Z
);
6450 echo_area_buffer
[0] = Qnil
;
6455 /* Set the current message to a substring of S or STRING.
6457 If STRING is a Lisp string, set the message to the first NBYTES
6458 bytes from STRING. NBYTES zero means use the whole string. If
6459 STRING is multibyte, the message will be displayed multibyte.
6461 If S is not null, set the message to the first LEN bytes of S. LEN
6462 zero means use the whole string. MULTIBYTE_P non-zero means S is
6463 multibyte. Display the message multibyte in that case. */
6466 set_message (s
, string
, nbytes
, multibyte_p
)
6471 message_enable_multibyte
6472 = ((s
&& multibyte_p
)
6473 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
6475 with_echo_area_buffer (0, -1, set_message_1
,
6476 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
6477 message_buf_print
= 0;
6478 help_echo_showing_p
= 0;
6482 /* Helper function for set_message. Arguments have the same meaning
6483 as there, with A1 corresponding to S and A2 corresponding to STRING
6484 This function is called with the echo area buffer being
6488 set_message_1 (a1
, a2
, nbytes
, multibyte_p
)
6491 EMACS_INT nbytes
, multibyte_p
;
6493 char *s
= (char *) a1
;
6494 Lisp_Object string
= a2
;
6498 /* Change multibyteness of the echo buffer appropriately. */
6499 if (message_enable_multibyte
6500 != !NILP (current_buffer
->enable_multibyte_characters
))
6501 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
6503 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
6505 /* Insert new message at BEG. */
6506 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
6508 if (STRINGP (string
))
6513 nbytes
= XSTRING (string
)->size_byte
;
6514 nchars
= string_byte_to_char (string
, nbytes
);
6516 /* This function takes care of single/multibyte conversion. We
6517 just have to ensure that the echo area buffer has the right
6518 setting of enable_multibyte_characters. */
6519 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
6524 nbytes
= strlen (s
);
6526 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
6528 /* Convert from multi-byte to single-byte. */
6530 unsigned char work
[1];
6532 /* Convert a multibyte string to single-byte. */
6533 for (i
= 0; i
< nbytes
; i
+= n
)
6535 c
= string_char_and_length (s
+ i
, nbytes
- i
, &n
);
6536 work
[0] = (SINGLE_BYTE_CHAR_P (c
)
6538 : multibyte_char_to_unibyte (c
, Qnil
));
6539 insert_1_both (work
, 1, 1, 1, 0, 0);
6542 else if (!multibyte_p
6543 && !NILP (current_buffer
->enable_multibyte_characters
))
6545 /* Convert from single-byte to multi-byte. */
6547 unsigned char *msg
= (unsigned char *) s
;
6548 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
6550 /* Convert a single-byte string to multibyte. */
6551 for (i
= 0; i
< nbytes
; i
++)
6553 c
= unibyte_char_to_multibyte (msg
[i
]);
6554 n
= CHAR_STRING (c
, str
);
6555 insert_1_both (str
, 1, n
, 1, 0, 0);
6559 insert_1 (s
, nbytes
, 1, 0, 0);
6566 /* Clear messages. CURRENT_P non-zero means clear the current
6567 message. LAST_DISPLAYED_P non-zero means clear the message
6571 clear_message (current_p
, last_displayed_p
)
6572 int current_p
, last_displayed_p
;
6575 echo_area_buffer
[0] = Qnil
;
6577 if (last_displayed_p
)
6578 echo_area_buffer
[1] = Qnil
;
6580 message_buf_print
= 0;
6583 /* Clear garbaged frames.
6585 This function is used where the old redisplay called
6586 redraw_garbaged_frames which in turn called redraw_frame which in
6587 turn called clear_frame. The call to clear_frame was a source of
6588 flickering. I believe a clear_frame is not necessary. It should
6589 suffice in the new redisplay to invalidate all current matrices,
6590 and ensure a complete redisplay of all windows. */
6593 clear_garbaged_frames ()
6597 Lisp_Object tail
, frame
;
6599 FOR_EACH_FRAME (tail
, frame
)
6601 struct frame
*f
= XFRAME (frame
);
6603 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
6605 clear_current_matrices (f
);
6611 ++windows_or_buffers_changed
;
6616 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
6617 is non-zero update selected_frame. Value is non-zero if the
6618 mini-windows height has been changed. */
6621 echo_area_display (update_frame_p
)
6624 Lisp_Object mini_window
;
6627 int window_height_changed_p
= 0;
6628 struct frame
*sf
= SELECTED_FRAME ();
6630 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
6631 w
= XWINDOW (mini_window
);
6632 f
= XFRAME (WINDOW_FRAME (w
));
6634 /* Don't display if frame is invisible or not yet initialized. */
6635 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
6638 /* The terminal frame is used as the first Emacs frame on the Mac OS. */
6640 #ifdef HAVE_WINDOW_SYSTEM
6641 /* When Emacs starts, selected_frame may be a visible terminal
6642 frame, even if we run under a window system. If we let this
6643 through, a message would be displayed on the terminal. */
6644 if (EQ (selected_frame
, Vterminal_frame
)
6645 && !NILP (Vwindow_system
))
6647 #endif /* HAVE_WINDOW_SYSTEM */
6650 /* Redraw garbaged frames. */
6652 clear_garbaged_frames ();
6654 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
6656 echo_area_window
= mini_window
;
6657 window_height_changed_p
= display_echo_area (w
);
6658 w
->must_be_updated_p
= 1;
6660 /* Update the display, unless called from redisplay_internal.
6661 Also don't update the screen during redisplay itself. The
6662 update will happen at the end of redisplay, and an update
6663 here could cause confusion. */
6664 if (update_frame_p
&& !redisplaying_p
)
6668 /* If the display update has been interrupted by pending
6669 input, update mode lines in the frame. Due to the
6670 pending input, it might have been that redisplay hasn't
6671 been called, so that mode lines above the echo area are
6672 garbaged. This looks odd, so we prevent it here. */
6673 if (!display_completed
)
6674 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
6676 if (window_height_changed_p
)
6678 /* Must update other windows. Likewise as in other
6679 cases, don't let this update be interrupted by
6681 int count
= BINDING_STACK_SIZE ();
6682 specbind (Qredisplay_dont_pause
, Qt
);
6683 windows_or_buffers_changed
= 1;
6684 redisplay_internal (0);
6685 unbind_to (count
, Qnil
);
6687 else if (FRAME_WINDOW_P (f
) && n
== 0)
6689 /* Window configuration is the same as before.
6690 Can do with a display update of the echo area,
6691 unless we displayed some mode lines. */
6692 update_single_window (w
, 1);
6693 rif
->flush_display (f
);
6696 update_frame (f
, 1, 1);
6698 /* If cursor is in the echo area, make sure that the next
6699 redisplay displays the minibuffer, so that the cursor will
6700 be replaced with what the minibuffer wants. */
6701 if (cursor_in_echo_area
)
6702 ++windows_or_buffers_changed
;
6705 else if (!EQ (mini_window
, selected_window
))
6706 windows_or_buffers_changed
++;
6708 /* Last displayed message is now the current message. */
6709 echo_area_buffer
[1] = echo_area_buffer
[0];
6711 /* Prevent redisplay optimization in redisplay_internal by resetting
6712 this_line_start_pos. This is done because the mini-buffer now
6713 displays the message instead of its buffer text. */
6714 if (EQ (mini_window
, selected_window
))
6715 CHARPOS (this_line_start_pos
) = 0;
6717 return window_height_changed_p
;
6722 /***********************************************************************
6724 ***********************************************************************/
6727 #ifdef HAVE_WINDOW_SYSTEM
6729 /* A buffer for constructing frame titles in it; allocated from the
6730 heap in init_xdisp and resized as needed in store_frame_title_char. */
6732 static char *frame_title_buf
;
6734 /* The buffer's end, and a current output position in it. */
6736 static char *frame_title_buf_end
;
6737 static char *frame_title_ptr
;
6740 /* Store a single character C for the frame title in frame_title_buf.
6741 Re-allocate frame_title_buf if necessary. */
6744 store_frame_title_char (c
)
6747 /* If output position has reached the end of the allocated buffer,
6748 double the buffer's size. */
6749 if (frame_title_ptr
== frame_title_buf_end
)
6751 int len
= frame_title_ptr
- frame_title_buf
;
6752 int new_size
= 2 * len
* sizeof *frame_title_buf
;
6753 frame_title_buf
= (char *) xrealloc (frame_title_buf
, new_size
);
6754 frame_title_buf_end
= frame_title_buf
+ new_size
;
6755 frame_title_ptr
= frame_title_buf
+ len
;
6758 *frame_title_ptr
++ = c
;
6762 /* Store part of a frame title in frame_title_buf, beginning at
6763 frame_title_ptr. STR is the string to store. Do not copy more
6764 than PRECISION number of bytes from STR; PRECISION <= 0 means copy
6765 the whole string. Pad with spaces until FIELD_WIDTH number of
6766 characters have been copied; FIELD_WIDTH <= 0 means don't pad.
6767 Called from display_mode_element when it is used to build a frame
6771 store_frame_title (str
, field_width
, precision
)
6773 int field_width
, precision
;
6777 /* Copy at most PRECISION chars from STR. */
6778 while ((precision
<= 0 || n
< precision
)
6781 store_frame_title_char (*str
++);
6785 /* Fill up with spaces until FIELD_WIDTH reached. */
6786 while (field_width
> 0
6789 store_frame_title_char (' ');
6797 /* Set the title of FRAME, if it has changed. The title format is
6798 Vicon_title_format if FRAME is iconified, otherwise it is
6799 frame_title_format. */
6802 x_consider_frame_title (frame
)
6805 struct frame
*f
= XFRAME (frame
);
6807 if (FRAME_WINDOW_P (f
)
6808 || FRAME_MINIBUF_ONLY_P (f
)
6809 || f
->explicit_name
)
6811 /* Do we have more than one visible frame on this X display? */
6814 struct buffer
*obuf
;
6818 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
6820 struct frame
*tf
= XFRAME (XCAR (tail
));
6823 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
6824 && !FRAME_MINIBUF_ONLY_P (tf
)
6825 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
6829 /* Set global variable indicating that multiple frames exist. */
6830 multiple_frames
= CONSP (tail
);
6832 /* Switch to the buffer of selected window of the frame. Set up
6833 frame_title_ptr so that display_mode_element will output into it;
6834 then display the title. */
6835 obuf
= current_buffer
;
6836 Fset_buffer (XWINDOW (f
->selected_window
)->buffer
);
6837 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
6838 frame_title_ptr
= frame_title_buf
;
6839 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
6840 NULL
, DEFAULT_FACE_ID
);
6841 len
= display_mode_element (&it
, 0, -1, -1, fmt
);
6842 frame_title_ptr
= NULL
;
6843 set_buffer_internal (obuf
);
6845 /* Set the title only if it's changed. This avoids consing in
6846 the common case where it hasn't. (If it turns out that we've
6847 already wasted too much time by walking through the list with
6848 display_mode_element, then we might need to optimize at a
6849 higher level than this.) */
6850 if (! STRINGP (f
->name
)
6851 || STRING_BYTES (XSTRING (f
->name
)) != len
6852 || bcmp (frame_title_buf
, XSTRING (f
->name
)->data
, len
) != 0)
6853 x_implicitly_set_name (f
, make_string (frame_title_buf
, len
), Qnil
);
6857 #else /* not HAVE_WINDOW_SYSTEM */
6859 #define frame_title_ptr ((char *)0)
6860 #define store_frame_title(str, mincol, maxcol) 0
6862 #endif /* not HAVE_WINDOW_SYSTEM */
6867 /***********************************************************************
6869 ***********************************************************************/
6872 /* Prepare for redisplay by updating menu-bar item lists when
6873 appropriate. This can call eval. */
6876 prepare_menu_bars ()
6879 struct gcpro gcpro1
, gcpro2
;
6881 Lisp_Object tooltip_frame
;
6883 #ifdef HAVE_X_WINDOWS
6884 tooltip_frame
= tip_frame
;
6886 tooltip_frame
= Qnil
;
6889 /* Update all frame titles based on their buffer names, etc. We do
6890 this before the menu bars so that the buffer-menu will show the
6891 up-to-date frame titles. */
6892 #ifdef HAVE_WINDOW_SYSTEM
6893 if (windows_or_buffers_changed
|| update_mode_lines
)
6895 Lisp_Object tail
, frame
;
6897 FOR_EACH_FRAME (tail
, frame
)
6900 if (!EQ (frame
, tooltip_frame
)
6901 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
6902 x_consider_frame_title (frame
);
6905 #endif /* HAVE_WINDOW_SYSTEM */
6907 /* Update the menu bar item lists, if appropriate. This has to be
6908 done before any actual redisplay or generation of display lines. */
6909 all_windows
= (update_mode_lines
6910 || buffer_shared
> 1
6911 || windows_or_buffers_changed
);
6914 Lisp_Object tail
, frame
;
6915 int count
= BINDING_STACK_SIZE ();
6917 record_unwind_protect (Fset_match_data
, Fmatch_data (Qnil
, Qnil
));
6919 FOR_EACH_FRAME (tail
, frame
)
6923 /* Ignore tooltip frame. */
6924 if (EQ (frame
, tooltip_frame
))
6927 /* If a window on this frame changed size, report that to
6928 the user and clear the size-change flag. */
6929 if (FRAME_WINDOW_SIZES_CHANGED (f
))
6931 Lisp_Object functions
;
6933 /* Clear flag first in case we get an error below. */
6934 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
6935 functions
= Vwindow_size_change_functions
;
6936 GCPRO2 (tail
, functions
);
6938 while (CONSP (functions
))
6940 call1 (XCAR (functions
), frame
);
6941 functions
= XCDR (functions
);
6947 update_menu_bar (f
, 0);
6948 #ifdef HAVE_WINDOW_SYSTEM
6949 update_tool_bar (f
, 0);
6954 unbind_to (count
, Qnil
);
6958 struct frame
*sf
= SELECTED_FRAME ();
6959 update_menu_bar (sf
, 1);
6960 #ifdef HAVE_WINDOW_SYSTEM
6961 update_tool_bar (sf
, 1);
6965 /* Motif needs this. See comment in xmenu.c. Turn it off when
6966 pending_menu_activation is not defined. */
6967 #ifdef USE_X_TOOLKIT
6968 pending_menu_activation
= 0;
6973 /* Update the menu bar item list for frame F. This has to be done
6974 before we start to fill in any display lines, because it can call
6977 If SAVE_MATCH_DATA is non-zero, we must save and restore it here. */
6980 update_menu_bar (f
, save_match_data
)
6982 int save_match_data
;
6985 register struct window
*w
;
6987 window
= FRAME_SELECTED_WINDOW (f
);
6988 w
= XWINDOW (window
);
6990 if (update_mode_lines
)
6991 w
->update_mode_line
= Qt
;
6993 if (FRAME_WINDOW_P (f
)
6995 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (macintosh)
6996 FRAME_EXTERNAL_MENU_BAR (f
)
6998 FRAME_MENU_BAR_LINES (f
) > 0
7000 : FRAME_MENU_BAR_LINES (f
) > 0)
7002 /* If the user has switched buffers or windows, we need to
7003 recompute to reflect the new bindings. But we'll
7004 recompute when update_mode_lines is set too; that means
7005 that people can use force-mode-line-update to request
7006 that the menu bar be recomputed. The adverse effect on
7007 the rest of the redisplay algorithm is about the same as
7008 windows_or_buffers_changed anyway. */
7009 if (windows_or_buffers_changed
7010 || !NILP (w
->update_mode_line
)
7011 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
7012 < BUF_MODIFF (XBUFFER (w
->buffer
)))
7013 != !NILP (w
->last_had_star
))
7014 || ((!NILP (Vtransient_mark_mode
)
7015 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
7016 != !NILP (w
->region_showing
)))
7018 struct buffer
*prev
= current_buffer
;
7019 int count
= BINDING_STACK_SIZE ();
7021 set_buffer_internal_1 (XBUFFER (w
->buffer
));
7022 if (save_match_data
)
7023 record_unwind_protect (Fset_match_data
, Fmatch_data (Qnil
, Qnil
));
7024 if (NILP (Voverriding_local_map_menu_flag
))
7026 specbind (Qoverriding_terminal_local_map
, Qnil
);
7027 specbind (Qoverriding_local_map
, Qnil
);
7030 /* Run the Lucid hook. */
7031 call1 (Vrun_hooks
, Qactivate_menubar_hook
);
7033 /* If it has changed current-menubar from previous value,
7034 really recompute the menu-bar from the value. */
7035 if (! NILP (Vlucid_menu_bar_dirty_flag
))
7036 call0 (Qrecompute_lucid_menubar
);
7038 safe_run_hooks (Qmenu_bar_update_hook
);
7039 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
7041 /* Redisplay the menu bar in case we changed it. */
7042 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (macintosh)
7043 if (FRAME_WINDOW_P (f
)
7044 #if defined (macintosh)
7045 /* All frames on Mac OS share the same menubar. So only the
7046 selected frame should be allowed to set it. */
7047 && f
== SELECTED_FRAME ()
7050 set_frame_menubar (f
, 0, 0);
7052 /* On a terminal screen, the menu bar is an ordinary screen
7053 line, and this makes it get updated. */
7054 w
->update_mode_line
= Qt
;
7055 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI) */
7056 /* In the non-toolkit version, the menu bar is an ordinary screen
7057 line, and this makes it get updated. */
7058 w
->update_mode_line
= Qt
;
7059 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI) */
7061 unbind_to (count
, Qnil
);
7062 set_buffer_internal_1 (prev
);
7069 /***********************************************************************
7071 ***********************************************************************/
7073 #ifdef HAVE_WINDOW_SYSTEM
7075 /* Update the tool-bar item list for frame F. This has to be done
7076 before we start to fill in any display lines. Called from
7077 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
7078 and restore it here. */
7081 update_tool_bar (f
, save_match_data
)
7083 int save_match_data
;
7085 if (WINDOWP (f
->tool_bar_window
)
7086 && XFASTINT (XWINDOW (f
->tool_bar_window
)->height
) > 0)
7091 window
= FRAME_SELECTED_WINDOW (f
);
7092 w
= XWINDOW (window
);
7094 /* If the user has switched buffers or windows, we need to
7095 recompute to reflect the new bindings. But we'll
7096 recompute when update_mode_lines is set too; that means
7097 that people can use force-mode-line-update to request
7098 that the menu bar be recomputed. The adverse effect on
7099 the rest of the redisplay algorithm is about the same as
7100 windows_or_buffers_changed anyway. */
7101 if (windows_or_buffers_changed
7102 || !NILP (w
->update_mode_line
)
7103 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
7104 < BUF_MODIFF (XBUFFER (w
->buffer
)))
7105 != !NILP (w
->last_had_star
))
7106 || ((!NILP (Vtransient_mark_mode
)
7107 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
7108 != !NILP (w
->region_showing
)))
7110 struct buffer
*prev
= current_buffer
;
7111 int count
= BINDING_STACK_SIZE ();
7113 /* Set current_buffer to the buffer of the selected
7114 window of the frame, so that we get the right local
7116 set_buffer_internal_1 (XBUFFER (w
->buffer
));
7118 /* Save match data, if we must. */
7119 if (save_match_data
)
7120 record_unwind_protect (Fset_match_data
, Fmatch_data (Qnil
, Qnil
));
7122 /* Make sure that we don't accidentally use bogus keymaps. */
7123 if (NILP (Voverriding_local_map_menu_flag
))
7125 specbind (Qoverriding_terminal_local_map
, Qnil
);
7126 specbind (Qoverriding_local_map
, Qnil
);
7129 /* Build desired tool-bar items from keymaps. */
7131 = tool_bar_items (f
->tool_bar_items
, &f
->n_tool_bar_items
);
7133 /* Redisplay the tool-bar in case we changed it. */
7134 w
->update_mode_line
= Qt
;
7136 unbind_to (count
, Qnil
);
7137 set_buffer_internal_1 (prev
);
7143 /* Set F->desired_tool_bar_string to a Lisp string representing frame
7144 F's desired tool-bar contents. F->tool_bar_items must have
7145 been set up previously by calling prepare_menu_bars. */
7148 build_desired_tool_bar_string (f
)
7151 int i
, size
, size_needed
, string_idx
;
7152 struct gcpro gcpro1
, gcpro2
, gcpro3
;
7153 Lisp_Object image
, plist
, props
;
7155 image
= plist
= props
= Qnil
;
7156 GCPRO3 (image
, plist
, props
);
7158 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
7159 Otherwise, make a new string. */
7161 /* The size of the string we might be able to reuse. */
7162 size
= (STRINGP (f
->desired_tool_bar_string
)
7163 ? XSTRING (f
->desired_tool_bar_string
)->size
7166 /* Each image in the string we build is preceded by a space,
7167 and there is a space at the end. */
7168 size_needed
= f
->n_tool_bar_items
+ 1;
7170 /* Reuse f->desired_tool_bar_string, if possible. */
7171 if (size
< size_needed
)
7172 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
7176 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
7177 Fremove_text_properties (make_number (0), make_number (size
),
7178 props
, f
->desired_tool_bar_string
);
7181 /* Put a `display' property on the string for the images to display,
7182 put a `menu_item' property on tool-bar items with a value that
7183 is the index of the item in F's tool-bar item vector. */
7184 for (i
= 0, string_idx
= 0;
7185 i
< f
->n_tool_bar_items
;
7186 ++i
, string_idx
+= 1)
7188 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
7190 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7191 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7192 int margin
, relief
, idx
;
7193 extern Lisp_Object QCrelief
, QCmargin
, QCalgorithm
, Qimage
;
7194 extern Lisp_Object Qlaplace
;
7196 /* If image is a vector, choose the image according to the
7198 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
7199 if (VECTORP (image
))
7203 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
7204 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
7207 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
7208 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
7210 xassert (ASIZE (image
) >= idx
);
7211 image
= AREF (image
, idx
);
7216 /* Ignore invalid image specifications. */
7217 if (!valid_image_p (image
))
7220 /* Display the tool-bar button pressed, or depressed. */
7221 plist
= Fcopy_sequence (XCDR (image
));
7223 /* Compute margin and relief to draw. */
7224 relief
= tool_bar_button_relief
> 0 ? tool_bar_button_relief
: 3;
7225 margin
= relief
+ max (0, tool_bar_button_margin
);
7227 if (auto_raise_tool_bar_buttons_p
)
7229 /* Add a `:relief' property to the image spec if the item is
7233 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
7239 /* If image is selected, display it pressed, i.e. with a
7240 negative relief. If it's not selected, display it with a
7242 plist
= Fplist_put (plist
, QCrelief
,
7244 ? make_number (-relief
)
7245 : make_number (relief
)));
7249 /* Put a margin around the image. */
7251 plist
= Fplist_put (plist
, QCmargin
, make_number (margin
));
7253 /* If button is not enabled, and we don't have special images
7254 for the disabled state, make the image appear disabled by
7255 applying an appropriate algorithm to it. */
7256 if (!enabled_p
&& idx
< 0)
7257 plist
= Fplist_put (plist
, QCalgorithm
, Qdisabled
);
7259 /* Put a `display' text property on the string for the image to
7260 display. Put a `menu-item' property on the string that gives
7261 the start of this item's properties in the tool-bar items
7263 image
= Fcons (Qimage
, plist
);
7264 props
= list4 (Qdisplay
, image
,
7265 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
)),
7266 Fadd_text_properties (make_number (string_idx
),
7267 make_number (string_idx
+ 1),
7268 props
, f
->desired_tool_bar_string
);
7276 /* Display one line of the tool-bar of frame IT->f. */
7279 display_tool_bar_line (it
)
7282 struct glyph_row
*row
= it
->glyph_row
;
7283 int max_x
= it
->last_visible_x
;
7286 prepare_desired_row (row
);
7287 row
->y
= it
->current_y
;
7289 /* Note that this isn't made use of if the face hasn't a box,
7290 so there's no need to check the face here. */
7291 it
->start_of_box_run_p
= 1;
7293 while (it
->current_x
< max_x
)
7295 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
7297 /* Get the next display element. */
7298 if (!get_next_display_element (it
))
7301 /* Produce glyphs. */
7302 x_before
= it
->current_x
;
7303 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
7304 PRODUCE_GLYPHS (it
);
7306 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
7311 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
7313 if (x
+ glyph
->pixel_width
> max_x
)
7315 /* Glyph doesn't fit on line. */
7316 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
7322 x
+= glyph
->pixel_width
;
7326 /* Stop at line ends. */
7327 if (ITERATOR_AT_END_OF_LINE_P (it
))
7330 set_iterator_to_next (it
, 1);
7335 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
7336 extend_face_to_end_of_line (it
);
7337 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
7338 last
->right_box_line_p
= 1;
7339 if (last
== row
->glyphs
[TEXT_AREA
])
7340 last
->left_box_line_p
= 1;
7341 compute_line_metrics (it
);
7343 /* If line is empty, make it occupy the rest of the tool-bar. */
7344 if (!row
->displays_text_p
)
7346 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
7347 row
->ascent
= row
->phys_ascent
= 0;
7350 row
->full_width_p
= 1;
7351 row
->continued_p
= 0;
7352 row
->truncated_on_left_p
= 0;
7353 row
->truncated_on_right_p
= 0;
7355 it
->current_x
= it
->hpos
= 0;
7356 it
->current_y
+= row
->height
;
7362 /* Value is the number of screen lines needed to make all tool-bar
7363 items of frame F visible. */
7366 tool_bar_lines_needed (f
)
7369 struct window
*w
= XWINDOW (f
->tool_bar_window
);
7372 /* Initialize an iterator for iteration over
7373 F->desired_tool_bar_string in the tool-bar window of frame F. */
7374 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
7375 it
.first_visible_x
= 0;
7376 it
.last_visible_x
= FRAME_WINDOW_WIDTH (f
) * CANON_X_UNIT (f
);
7377 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
7379 while (!ITERATOR_AT_END_P (&it
))
7381 it
.glyph_row
= w
->desired_matrix
->rows
;
7382 clear_glyph_row (it
.glyph_row
);
7383 display_tool_bar_line (&it
);
7386 return (it
.current_y
+ CANON_Y_UNIT (f
) - 1) / CANON_Y_UNIT (f
);
7390 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
7391 height should be changed. */
7394 redisplay_tool_bar (f
)
7399 struct glyph_row
*row
;
7400 int change_height_p
= 0;
7402 /* If frame hasn't a tool-bar window or if it is zero-height, don't
7403 do anything. This means you must start with tool-bar-lines
7404 non-zero to get the auto-sizing effect. Or in other words, you
7405 can turn off tool-bars by specifying tool-bar-lines zero. */
7406 if (!WINDOWP (f
->tool_bar_window
)
7407 || (w
= XWINDOW (f
->tool_bar_window
),
7408 XFASTINT (w
->height
) == 0))
7411 /* Set up an iterator for the tool-bar window. */
7412 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
7413 it
.first_visible_x
= 0;
7414 it
.last_visible_x
= FRAME_WINDOW_WIDTH (f
) * CANON_X_UNIT (f
);
7417 /* Build a string that represents the contents of the tool-bar. */
7418 build_desired_tool_bar_string (f
);
7419 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
7421 /* Display as many lines as needed to display all tool-bar items. */
7422 while (it
.current_y
< it
.last_visible_y
)
7423 display_tool_bar_line (&it
);
7425 /* It doesn't make much sense to try scrolling in the tool-bar
7426 window, so don't do it. */
7427 w
->desired_matrix
->no_scrolling_p
= 1;
7428 w
->must_be_updated_p
= 1;
7430 if (auto_resize_tool_bars_p
)
7434 /* If there are blank lines at the end, except for a partially
7435 visible blank line at the end that is smaller than
7436 CANON_Y_UNIT, change the tool-bar's height. */
7437 row
= it
.glyph_row
- 1;
7438 if (!row
->displays_text_p
7439 && row
->height
>= CANON_Y_UNIT (f
))
7440 change_height_p
= 1;
7442 /* If row displays tool-bar items, but is partially visible,
7443 change the tool-bar's height. */
7444 if (row
->displays_text_p
7445 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
7446 change_height_p
= 1;
7448 /* Resize windows as needed by changing the `tool-bar-lines'
7451 && (nlines
= tool_bar_lines_needed (f
),
7452 nlines
!= XFASTINT (w
->height
)))
7454 extern Lisp_Object Qtool_bar_lines
;
7456 int old_height
= XFASTINT (w
->height
);
7458 XSETFRAME (frame
, f
);
7459 clear_glyph_matrix (w
->desired_matrix
);
7460 Fmodify_frame_parameters (frame
,
7461 Fcons (Fcons (Qtool_bar_lines
,
7462 make_number (nlines
)),
7464 if (XFASTINT (w
->height
) != old_height
)
7465 fonts_changed_p
= 1;
7469 return change_height_p
;
7473 /* Get information about the tool-bar item which is displayed in GLYPH
7474 on frame F. Return in *PROP_IDX the index where tool-bar item
7475 properties start in F->tool_bar_items. Value is zero if
7476 GLYPH doesn't display a tool-bar item. */
7479 tool_bar_item_info (f
, glyph
, prop_idx
)
7481 struct glyph
*glyph
;
7487 /* Get the text property `menu-item' at pos. The value of that
7488 property is the start index of this item's properties in
7489 F->tool_bar_items. */
7490 prop
= Fget_text_property (make_number (glyph
->charpos
),
7491 Qmenu_item
, f
->current_tool_bar_string
);
7492 if (INTEGERP (prop
))
7494 *prop_idx
= XINT (prop
);
7503 #endif /* HAVE_WINDOW_SYSTEM */
7507 /************************************************************************
7508 Horizontal scrolling
7509 ************************************************************************/
7511 static int hscroll_window_tree
P_ ((Lisp_Object
));
7512 static int hscroll_windows
P_ ((Lisp_Object
));
7514 /* For all leaf windows in the window tree rooted at WINDOW, set their
7515 hscroll value so that PT is (i) visible in the window, and (ii) so
7516 that it is not within a certain margin at the window's left and
7517 right border. Value is non-zero if any window's hscroll has been
7521 hscroll_window_tree (window
)
7524 int hscrolled_p
= 0;
7526 while (WINDOWP (window
))
7528 struct window
*w
= XWINDOW (window
);
7530 if (WINDOWP (w
->hchild
))
7531 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
7532 else if (WINDOWP (w
->vchild
))
7533 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
7534 else if (w
->cursor
.vpos
>= 0)
7536 int hscroll_margin
, text_area_x
, text_area_y
;
7537 int text_area_width
, text_area_height
;
7538 struct glyph_row
*current_cursor_row
7539 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
7540 struct glyph_row
*desired_cursor_row
7541 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
7542 struct glyph_row
*cursor_row
7543 = (desired_cursor_row
->enabled_p
7544 ? desired_cursor_row
7545 : current_cursor_row
);
7547 window_box (w
, TEXT_AREA
, &text_area_x
, &text_area_y
,
7548 &text_area_width
, &text_area_height
);
7550 /* Scroll when cursor is inside this scroll margin. */
7551 hscroll_margin
= 5 * CANON_X_UNIT (XFRAME (w
->frame
));
7553 if ((XFASTINT (w
->hscroll
)
7554 && w
->cursor
.x
< hscroll_margin
)
7555 || (cursor_row
->enabled_p
7556 && cursor_row
->truncated_on_right_p
7557 && (w
->cursor
.x
> text_area_width
- hscroll_margin
)))
7561 struct buffer
*saved_current_buffer
;
7564 /* Find point in a display of infinite width. */
7565 saved_current_buffer
= current_buffer
;
7566 current_buffer
= XBUFFER (w
->buffer
);
7568 if (w
== XWINDOW (selected_window
))
7569 pt
= BUF_PT (current_buffer
);
7572 pt
= marker_position (w
->pointm
);
7573 pt
= max (BEGV
, pt
);
7577 /* Move iterator to pt starting at cursor_row->start in
7578 a line with infinite width. */
7579 init_to_row_start (&it
, w
, cursor_row
);
7580 it
.last_visible_x
= INFINITY
;
7581 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
7582 current_buffer
= saved_current_buffer
;
7584 /* Center cursor in window. */
7585 hscroll
= (max (0, it
.current_x
- text_area_width
/ 2)
7586 / CANON_X_UNIT (it
.f
));
7587 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
7589 /* Don't call Fset_window_hscroll if value hasn't
7590 changed because it will prevent redisplay
7592 if (XFASTINT (w
->hscroll
) != hscroll
)
7594 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
7595 w
->hscroll
= make_number (hscroll
);
7604 /* Value is non-zero if hscroll of any leaf window has been changed. */
7609 /* Set hscroll so that cursor is visible and not inside horizontal
7610 scroll margins for all windows in the tree rooted at WINDOW. See
7611 also hscroll_window_tree above. Value is non-zero if any window's
7612 hscroll has been changed. If it has, desired matrices on the frame
7613 of WINDOW are cleared. */
7616 hscroll_windows (window
)
7621 if (automatic_hscrolling_p
)
7623 hscrolled_p
= hscroll_window_tree (window
);
7625 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
7634 /************************************************************************
7636 ************************************************************************/
7638 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
7639 to a non-zero value. This is sometimes handy to have in a debugger
7644 /* First and last unchanged row for try_window_id. */
7646 int debug_first_unchanged_at_end_vpos
;
7647 int debug_last_unchanged_at_beg_vpos
;
7649 /* Delta vpos and y. */
7651 int debug_dvpos
, debug_dy
;
7653 /* Delta in characters and bytes for try_window_id. */
7655 int debug_delta
, debug_delta_bytes
;
7657 /* Values of window_end_pos and window_end_vpos at the end of
7660 int debug_end_pos
, debug_end_vpos
;
7662 /* Append a string to W->desired_matrix->method. FMT is a printf
7663 format string. A1...A9 are a supplement for a variable-length
7664 argument list. If trace_redisplay_p is non-zero also printf the
7665 resulting string to stderr. */
7668 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
7671 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
7674 char *method
= w
->desired_matrix
->method
;
7675 int len
= strlen (method
);
7676 int size
= sizeof w
->desired_matrix
->method
;
7677 int remaining
= size
- len
- 1;
7679 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
7680 if (len
&& remaining
)
7686 strncpy (method
+ len
, buffer
, remaining
);
7688 if (trace_redisplay_p
)
7689 fprintf (stderr
, "%p (%s): %s\n",
7691 ((BUFFERP (w
->buffer
)
7692 && STRINGP (XBUFFER (w
->buffer
)->name
))
7693 ? (char *) XSTRING (XBUFFER (w
->buffer
)->name
)->data
7698 #endif /* GLYPH_DEBUG */
7701 /* This counter is used to clear the face cache every once in a while
7702 in redisplay_internal. It is incremented for each redisplay.
7703 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
7706 #define CLEAR_FACE_CACHE_COUNT 10000
7707 static int clear_face_cache_count
;
7709 /* Record the previous terminal frame we displayed. */
7711 static struct frame
*previous_terminal_frame
;
7713 /* Non-zero while redisplay_internal is in progress. */
7718 /* Value is non-zero if all changes in window W, which displays
7719 current_buffer, are in the text between START and END. START is a
7720 buffer position, END is given as a distance from Z. Used in
7721 redisplay_internal for display optimization. */
7724 text_outside_line_unchanged_p (w
, start
, end
)
7728 int unchanged_p
= 1;
7730 /* If text or overlays have changed, see where. */
7731 if (XFASTINT (w
->last_modified
) < MODIFF
7732 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
7734 /* Gap in the line? */
7735 if (GPT
< start
|| Z
- GPT
< end
)
7738 /* Changes start in front of the line, or end after it? */
7740 && (BEG_UNCHANGED
< start
- 1
7741 || END_UNCHANGED
< end
))
7744 /* If selective display, can't optimize if changes start at the
7745 beginning of the line. */
7747 && INTEGERP (current_buffer
->selective_display
)
7748 && XINT (current_buffer
->selective_display
) > 0
7749 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
7757 /* Do a frame update, taking possible shortcuts into account. This is
7758 the main external entry point for redisplay.
7760 If the last redisplay displayed an echo area message and that message
7761 is no longer requested, we clear the echo area or bring back the
7762 mini-buffer if that is in use. */
7767 redisplay_internal (0);
7770 /* Return 1 if point moved out of or into a composition. Otherwise
7771 return 0. PREV_BUF and PREV_PT are the last point buffer and
7772 position. BUF and PT are the current point buffer and position. */
7775 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
7776 struct buffer
*prev_buf
, *buf
;
7783 XSETBUFFER (buffer
, buf
);
7784 /* Check a composition at the last point if point moved within the
7786 if (prev_buf
== buf
)
7789 /* Point didn't move. */
7792 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
7793 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
7794 && COMPOSITION_VALID_P (start
, end
, prop
)
7795 && start
< prev_pt
&& end
> prev_pt
)
7796 /* The last point was within the composition. Return 1 iff
7797 point moved out of the composition. */
7798 return (pt
<= start
|| pt
>= end
);
7801 /* Check a composition at the current point. */
7802 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
7803 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
7804 && COMPOSITION_VALID_P (start
, end
, prop
)
7805 && start
< pt
&& end
> pt
);
7808 /* Reconsider the setting of B->clip_changed which is displayed
7812 reconsider_clip_changes (w
, b
)
7816 if (b
->prevent_redisplay_optimizations_p
)
7817 b
->clip_changed
= 1;
7818 else if (b
->clip_changed
7819 && !NILP (w
->window_end_valid
)
7820 && w
->current_matrix
->buffer
== b
7821 && w
->current_matrix
->zv
== BUF_ZV (b
)
7822 && w
->current_matrix
->begv
== BUF_BEGV (b
))
7823 b
->clip_changed
= 0;
7825 /* If display wasn't paused, and W is not a tool bar window, see if
7826 point has been moved into or out of a composition. In that case,
7827 we set b->clip_changed to 1 to force updating the screen. If
7828 b->clip_changed has already been set to 1, we can skip this
7830 if (!b
->clip_changed
7831 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
7835 if (w
== XWINDOW (selected_window
))
7836 pt
= BUF_PT (current_buffer
);
7838 pt
= marker_position (w
->pointm
);
7840 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
7841 || pt
!= XINT (w
->last_point
))
7842 && check_point_in_composition (w
->current_matrix
->buffer
,
7843 XINT (w
->last_point
),
7844 XBUFFER (w
->buffer
), pt
))
7845 b
->clip_changed
= 1;
7850 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
7851 response to any user action; therefore, we should preserve the echo
7852 area. (Actually, our caller does that job.) Perhaps in the future
7853 avoid recentering windows if it is not necessary; currently that
7854 causes some problems. */
7857 redisplay_internal (preserve_echo_area
)
7858 int preserve_echo_area
;
7860 struct window
*w
= XWINDOW (selected_window
);
7861 struct frame
*f
= XFRAME (w
->frame
);
7863 int must_finish
= 0;
7864 struct text_pos tlbufpos
, tlendpos
;
7865 int number_of_visible_frames
;
7867 struct frame
*sf
= SELECTED_FRAME ();
7869 /* Non-zero means redisplay has to consider all windows on all
7870 frames. Zero means, only selected_window is considered. */
7871 int consider_all_windows_p
;
7873 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
7875 /* No redisplay if running in batch mode or frame is not yet fully
7876 initialized, or redisplay is explicitly turned off by setting
7877 Vinhibit_redisplay. */
7879 || !NILP (Vinhibit_redisplay
)
7880 || !f
->glyphs_initialized_p
)
7883 /* The flag redisplay_performed_directly_p is set by
7884 direct_output_for_insert when it already did the whole screen
7885 update necessary. */
7886 if (redisplay_performed_directly_p
)
7888 redisplay_performed_directly_p
= 0;
7889 if (!hscroll_windows (selected_window
))
7893 #ifdef USE_X_TOOLKIT
7894 if (popup_activated ())
7898 /* I don't think this happens but let's be paranoid. */
7902 /* Record a function that resets redisplaying_p to its old value
7903 when we leave this function. */
7904 count
= BINDING_STACK_SIZE ();
7905 record_unwind_protect (unwind_redisplay
, make_number (redisplaying_p
));
7910 reconsider_clip_changes (w
, current_buffer
);
7912 /* If new fonts have been loaded that make a glyph matrix adjustment
7913 necessary, do it. */
7914 if (fonts_changed_p
)
7916 adjust_glyphs (NULL
);
7917 ++windows_or_buffers_changed
;
7918 fonts_changed_p
= 0;
7921 if (! FRAME_WINDOW_P (sf
)
7922 && previous_terminal_frame
!= sf
)
7924 /* Since frames on an ASCII terminal share the same display
7925 area, displaying a different frame means redisplay the whole
7927 windows_or_buffers_changed
++;
7928 SET_FRAME_GARBAGED (sf
);
7929 XSETFRAME (Vterminal_frame
, sf
);
7931 previous_terminal_frame
= sf
;
7933 /* Set the visible flags for all frames. Do this before checking
7934 for resized or garbaged frames; they want to know if their frames
7935 are visible. See the comment in frame.h for
7936 FRAME_SAMPLE_VISIBILITY. */
7938 Lisp_Object tail
, frame
;
7940 number_of_visible_frames
= 0;
7942 FOR_EACH_FRAME (tail
, frame
)
7944 struct frame
*f
= XFRAME (frame
);
7946 FRAME_SAMPLE_VISIBILITY (f
);
7947 if (FRAME_VISIBLE_P (f
))
7948 ++number_of_visible_frames
;
7949 clear_desired_matrices (f
);
7953 /* Notice any pending interrupt request to change frame size. */
7954 do_pending_window_change (1);
7956 /* Clear frames marked as garbaged. */
7958 clear_garbaged_frames ();
7960 /* Build menubar and tool-bar items. */
7961 prepare_menu_bars ();
7963 if (windows_or_buffers_changed
)
7964 update_mode_lines
++;
7966 /* Detect case that we need to write or remove a star in the mode line. */
7967 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
7969 w
->update_mode_line
= Qt
;
7970 if (buffer_shared
> 1)
7971 update_mode_lines
++;
7974 /* If %c is in the mode line, update it if needed. */
7975 if (!NILP (w
->column_number_displayed
)
7976 /* This alternative quickly identifies a common case
7977 where no change is needed. */
7978 && !(PT
== XFASTINT (w
->last_point
)
7979 && XFASTINT (w
->last_modified
) >= MODIFF
7980 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
7981 && XFASTINT (w
->column_number_displayed
) != current_column ())
7982 w
->update_mode_line
= Qt
;
7984 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
7986 /* The variable buffer_shared is set in redisplay_window and
7987 indicates that we redisplay a buffer in different windows. See
7989 consider_all_windows_p
= update_mode_lines
|| buffer_shared
> 1;
7991 /* If specs for an arrow have changed, do thorough redisplay
7992 to ensure we remove any arrow that should no longer exist. */
7993 if (! EQ (COERCE_MARKER (Voverlay_arrow_position
), last_arrow_position
)
7994 || ! EQ (Voverlay_arrow_string
, last_arrow_string
))
7995 consider_all_windows_p
= windows_or_buffers_changed
= 1;
7997 /* Normally the message* functions will have already displayed and
7998 updated the echo area, but the frame may have been trashed, or
7999 the update may have been preempted, so display the echo area
8000 again here. Checking both message buffers captures the case that
8001 the echo area should be cleared. */
8002 if (!NILP (echo_area_buffer
[0]) || !NILP (echo_area_buffer
[1]))
8004 int window_height_changed_p
= echo_area_display (0);
8007 if (fonts_changed_p
)
8009 else if (window_height_changed_p
)
8011 consider_all_windows_p
= 1;
8012 ++update_mode_lines
;
8013 ++windows_or_buffers_changed
;
8015 /* If window configuration was changed, frames may have been
8016 marked garbaged. Clear them or we will experience
8017 surprises wrt scrolling. */
8019 clear_garbaged_frames ();
8022 else if (EQ (selected_window
, minibuf_window
)
8023 && (current_buffer
->clip_changed
8024 || XFASTINT (w
->last_modified
) < MODIFF
8025 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
8026 && resize_mini_window (w
, 0))
8028 /* Resized active mini-window to fit the size of what it is
8029 showing if its contents might have changed. */
8031 consider_all_windows_p
= 1;
8032 ++windows_or_buffers_changed
;
8033 ++update_mode_lines
;
8035 /* If window configuration was changed, frames may have been
8036 marked garbaged. Clear them or we will experience
8037 surprises wrt scrolling. */
8039 clear_garbaged_frames ();
8043 /* If showing the region, and mark has changed, we must redisplay
8044 the whole window. The assignment to this_line_start_pos prevents
8045 the optimization directly below this if-statement. */
8046 if (((!NILP (Vtransient_mark_mode
)
8047 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
8048 != !NILP (w
->region_showing
))
8049 || (!NILP (w
->region_showing
)
8050 && !EQ (w
->region_showing
,
8051 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
8052 CHARPOS (this_line_start_pos
) = 0;
8054 /* Optimize the case that only the line containing the cursor in the
8055 selected window has changed. Variables starting with this_ are
8056 set in display_line and record information about the line
8057 containing the cursor. */
8058 tlbufpos
= this_line_start_pos
;
8059 tlendpos
= this_line_end_pos
;
8060 if (!consider_all_windows_p
8061 && CHARPOS (tlbufpos
) > 0
8062 && NILP (w
->update_mode_line
)
8063 && !current_buffer
->clip_changed
8064 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
8065 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
8066 /* Make sure recorded data applies to current buffer, etc. */
8067 && this_line_buffer
== current_buffer
8068 && current_buffer
== XBUFFER (w
->buffer
)
8069 && NILP (w
->force_start
)
8070 /* Point must be on the line that we have info recorded about. */
8071 && PT
>= CHARPOS (tlbufpos
)
8072 && PT
<= Z
- CHARPOS (tlendpos
)
8073 /* All text outside that line, including its final newline,
8074 must be unchanged */
8075 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
8076 CHARPOS (tlendpos
)))
8078 if (CHARPOS (tlbufpos
) > BEGV
8079 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
8080 && (CHARPOS (tlbufpos
) == ZV
8081 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
8082 /* Former continuation line has disappeared by becoming empty */
8084 else if (XFASTINT (w
->last_modified
) < MODIFF
8085 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
8086 || MINI_WINDOW_P (w
))
8088 /* We have to handle the case of continuation around a
8089 wide-column character (See the comment in indent.c around
8092 For instance, in the following case:
8094 -------- Insert --------
8095 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
8096 J_I_ ==> J_I_ `^^' are cursors.
8100 As we have to redraw the line above, we should goto cancel. */
8103 int line_height_before
= this_line_pixel_height
;
8105 /* Note that start_display will handle the case that the
8106 line starting at tlbufpos is a continuation lines. */
8107 start_display (&it
, w
, tlbufpos
);
8109 /* Implementation note: It this still necessary? */
8110 if (it
.current_x
!= this_line_start_x
)
8113 TRACE ((stderr
, "trying display optimization 1\n"));
8114 w
->cursor
.vpos
= -1;
8115 overlay_arrow_seen
= 0;
8116 it
.vpos
= this_line_vpos
;
8117 it
.current_y
= this_line_y
;
8118 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
8121 /* If line contains point, is not continued,
8122 and ends at same distance from eob as before, we win */
8123 if (w
->cursor
.vpos
>= 0
8124 /* Line is not continued, otherwise this_line_start_pos
8125 would have been set to 0 in display_line. */
8126 && CHARPOS (this_line_start_pos
)
8127 /* Line ends as before. */
8128 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
8129 /* Line has same height as before. Otherwise other lines
8130 would have to be shifted up or down. */
8131 && this_line_pixel_height
== line_height_before
)
8133 /* If this is not the window's last line, we must adjust
8134 the charstarts of the lines below. */
8135 if (it
.current_y
< it
.last_visible_y
)
8137 struct glyph_row
*row
8138 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
8139 int delta
, delta_bytes
;
8141 if (Z
- CHARPOS (tlendpos
) == ZV
)
8143 /* This line ends at end of (accessible part of)
8144 buffer. There is no newline to count. */
8146 - CHARPOS (tlendpos
)
8147 - MATRIX_ROW_START_CHARPOS (row
));
8148 delta_bytes
= (Z_BYTE
8149 - BYTEPOS (tlendpos
)
8150 - MATRIX_ROW_START_BYTEPOS (row
));
8154 /* This line ends in a newline. Must take
8155 account of the newline and the rest of the
8156 text that follows. */
8158 - CHARPOS (tlendpos
)
8159 - MATRIX_ROW_START_CHARPOS (row
));
8160 delta_bytes
= (Z_BYTE
8161 - BYTEPOS (tlendpos
)
8162 - MATRIX_ROW_START_BYTEPOS (row
));
8165 increment_matrix_positions (w
->current_matrix
,
8167 w
->current_matrix
->nrows
,
8168 delta
, delta_bytes
);
8171 /* If this row displays text now but previously didn't,
8172 or vice versa, w->window_end_vpos may have to be
8174 if ((it
.glyph_row
- 1)->displays_text_p
)
8176 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
8177 XSETINT (w
->window_end_vpos
, this_line_vpos
);
8179 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
8180 && this_line_vpos
> 0)
8181 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
8182 w
->window_end_valid
= Qnil
;
8184 /* Update hint: No need to try to scroll in update_window. */
8185 w
->desired_matrix
->no_scrolling_p
= 1;
8188 *w
->desired_matrix
->method
= 0;
8189 debug_method_add (w
, "optimization 1");
8196 else if (/* Cursor position hasn't changed. */
8197 PT
== XFASTINT (w
->last_point
)
8198 /* Make sure the cursor was last displayed
8199 in this window. Otherwise we have to reposition it. */
8200 && 0 <= w
->cursor
.vpos
8201 && XINT (w
->height
) > w
->cursor
.vpos
)
8205 do_pending_window_change (1);
8207 /* We used to always goto end_of_redisplay here, but this
8208 isn't enough if we have a blinking cursor. */
8209 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
8210 goto end_of_redisplay
;
8214 /* If highlighting the region, or if the cursor is in the echo area,
8215 then we can't just move the cursor. */
8216 else if (! (!NILP (Vtransient_mark_mode
)
8217 && !NILP (current_buffer
->mark_active
))
8218 && (EQ (selected_window
, current_buffer
->last_selected_window
)
8219 || highlight_nonselected_windows
)
8220 && NILP (w
->region_showing
)
8221 && NILP (Vshow_trailing_whitespace
)
8222 && !cursor_in_echo_area
)
8225 struct glyph_row
*row
;
8227 /* Skip from tlbufpos to PT and see where it is. Note that
8228 PT may be in invisible text. If so, we will end at the
8229 next visible position. */
8230 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
8231 NULL
, DEFAULT_FACE_ID
);
8232 it
.current_x
= this_line_start_x
;
8233 it
.current_y
= this_line_y
;
8234 it
.vpos
= this_line_vpos
;
8236 /* The call to move_it_to stops in front of PT, but
8237 moves over before-strings. */
8238 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
8240 if (it
.vpos
== this_line_vpos
8241 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
8244 xassert (this_line_vpos
== it
.vpos
);
8245 xassert (this_line_y
== it
.current_y
);
8246 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
8254 /* Text changed drastically or point moved off of line. */
8255 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
8258 CHARPOS (this_line_start_pos
) = 0;
8259 consider_all_windows_p
|= buffer_shared
> 1;
8260 ++clear_face_cache_count
;
8263 /* Build desired matrices, and update the display. If
8264 consider_all_windows_p is non-zero, do it for all windows on all
8265 frames. Otherwise do it for selected_window, only. */
8267 if (consider_all_windows_p
)
8269 Lisp_Object tail
, frame
;
8271 /* Clear the face cache eventually. */
8272 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
8274 clear_face_cache (0);
8275 clear_face_cache_count
= 0;
8278 /* Recompute # windows showing selected buffer. This will be
8279 incremented each time such a window is displayed. */
8282 FOR_EACH_FRAME (tail
, frame
)
8284 struct frame
*f
= XFRAME (frame
);
8286 if (FRAME_WINDOW_P (f
) || f
== sf
)
8288 /* Mark all the scroll bars to be removed; we'll redeem
8289 the ones we want when we redisplay their windows. */
8290 if (condemn_scroll_bars_hook
)
8291 condemn_scroll_bars_hook (f
);
8293 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
8294 redisplay_windows (FRAME_ROOT_WINDOW (f
));
8296 /* Any scroll bars which redisplay_windows should have
8297 nuked should now go away. */
8298 if (judge_scroll_bars_hook
)
8299 judge_scroll_bars_hook (f
);
8301 /* If fonts changed, display again. */
8302 if (fonts_changed_p
)
8305 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
8307 /* See if we have to hscroll. */
8308 if (hscroll_windows (f
->root_window
))
8311 /* Prevent various kinds of signals during display
8312 update. stdio is not robust about handling
8313 signals, which can cause an apparent I/O
8315 if (interrupt_input
)
8319 /* Update the display. */
8320 set_window_update_flags (XWINDOW (f
->root_window
), 1);
8321 pause
|= update_frame (f
, 0, 0);
8325 mark_window_display_accurate (f
->root_window
, 1);
8326 if (frame_up_to_date_hook
)
8327 frame_up_to_date_hook (f
);
8332 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
8334 Lisp_Object mini_window
;
8335 struct frame
*mini_frame
;
8337 redisplay_window (selected_window
, 1);
8339 /* Compare desired and current matrices, perform output. */
8342 /* If fonts changed, display again. */
8343 if (fonts_changed_p
)
8346 /* Prevent various kinds of signals during display update.
8347 stdio is not robust about handling signals,
8348 which can cause an apparent I/O error. */
8349 if (interrupt_input
)
8353 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
8355 if (hscroll_windows (selected_window
))
8358 XWINDOW (selected_window
)->must_be_updated_p
= 1;
8359 pause
= update_frame (sf
, 0, 0);
8362 /* We may have called echo_area_display at the top of this
8363 function. If the echo area is on another frame, that may
8364 have put text on a frame other than the selected one, so the
8365 above call to update_frame would not have caught it. Catch
8367 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8368 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8370 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
8372 XWINDOW (mini_window
)->must_be_updated_p
= 1;
8373 pause
|= update_frame (mini_frame
, 0, 0);
8374 if (!pause
&& hscroll_windows (mini_window
))
8379 /* If display was paused because of pending input, make sure we do a
8380 thorough update the next time. */
8383 /* Prevent the optimization at the beginning of
8384 redisplay_internal that tries a single-line update of the
8385 line containing the cursor in the selected window. */
8386 CHARPOS (this_line_start_pos
) = 0;
8388 /* Let the overlay arrow be updated the next time. */
8389 if (!NILP (last_arrow_position
))
8391 last_arrow_position
= Qt
;
8392 last_arrow_string
= Qt
;
8395 /* If we pause after scrolling, some rows in the current
8396 matrices of some windows are not valid. */
8397 if (!WINDOW_FULL_WIDTH_P (w
)
8398 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
8399 update_mode_lines
= 1;
8402 /* Now text on frame agrees with windows, so put info into the
8403 windows for partial redisplay to follow. */
8406 register struct buffer
*b
= XBUFFER (w
->buffer
);
8408 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
8409 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
8410 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
8411 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
8413 if (consider_all_windows_p
)
8414 mark_window_display_accurate (FRAME_ROOT_WINDOW (sf
), 1);
8417 XSETFASTINT (w
->last_point
, BUF_PT (b
));
8418 w
->last_cursor
= w
->cursor
;
8419 w
->last_cursor_off_p
= w
->cursor_off_p
;
8421 b
->clip_changed
= 0;
8422 b
->prevent_redisplay_optimizations_p
= 0;
8423 w
->update_mode_line
= Qnil
;
8424 XSETFASTINT (w
->last_modified
, BUF_MODIFF (b
));
8425 XSETFASTINT (w
->last_overlay_modified
, BUF_OVERLAY_MODIFF (b
));
8427 = (BUF_MODIFF (XBUFFER (w
->buffer
)) > BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
8430 /* Record if we are showing a region, so can make sure to
8431 update it fully at next redisplay. */
8432 w
->region_showing
= (!NILP (Vtransient_mark_mode
)
8433 && (EQ (selected_window
,
8434 current_buffer
->last_selected_window
)
8435 || highlight_nonselected_windows
)
8436 && !NILP (XBUFFER (w
->buffer
)->mark_active
)
8437 ? Fmarker_position (XBUFFER (w
->buffer
)->mark
)
8440 w
->window_end_valid
= w
->buffer
;
8441 last_arrow_position
= COERCE_MARKER (Voverlay_arrow_position
);
8442 last_arrow_string
= Voverlay_arrow_string
;
8443 if (frame_up_to_date_hook
!= 0)
8444 (*frame_up_to_date_hook
) (sf
);
8446 w
->current_matrix
->buffer
= b
;
8447 w
->current_matrix
->begv
= BUF_BEGV (b
);
8448 w
->current_matrix
->zv
= BUF_ZV (b
);
8451 update_mode_lines
= 0;
8452 windows_or_buffers_changed
= 0;
8455 /* Start SIGIO interrupts coming again. Having them off during the
8456 code above makes it less likely one will discard output, but not
8457 impossible, since there might be stuff in the system buffer here.
8458 But it is much hairier to try to do anything about that. */
8459 if (interrupt_input
)
8463 /* If a frame has become visible which was not before, redisplay
8464 again, so that we display it. Expose events for such a frame
8465 (which it gets when becoming visible) don't call the parts of
8466 redisplay constructing glyphs, so simply exposing a frame won't
8467 display anything in this case. So, we have to display these
8468 frames here explicitly. */
8471 Lisp_Object tail
, frame
;
8474 FOR_EACH_FRAME (tail
, frame
)
8476 int this_is_visible
= 0;
8478 if (XFRAME (frame
)->visible
)
8479 this_is_visible
= 1;
8480 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
8481 if (XFRAME (frame
)->visible
)
8482 this_is_visible
= 1;
8484 if (this_is_visible
)
8488 if (new_count
!= number_of_visible_frames
)
8489 windows_or_buffers_changed
++;
8492 /* Change frame size now if a change is pending. */
8493 do_pending_window_change (1);
8495 /* If we just did a pending size change, or have additional
8496 visible frames, redisplay again. */
8497 if (windows_or_buffers_changed
&& !pause
)
8502 unbind_to (count
, Qnil
);
8506 /* Redisplay, but leave alone any recent echo area message unless
8507 another message has been requested in its place.
8509 This is useful in situations where you need to redisplay but no
8510 user action has occurred, making it inappropriate for the message
8511 area to be cleared. See tracking_off and
8512 wait_reading_process_input for examples of these situations. */
8515 redisplay_preserve_echo_area ()
8517 if (!NILP (echo_area_buffer
[1]))
8519 /* We have a previously displayed message, but no current
8520 message. Redisplay the previous message. */
8521 display_last_displayed_message_p
= 1;
8522 redisplay_internal (1);
8523 display_last_displayed_message_p
= 0;
8526 redisplay_internal (1);
8530 /* Function registered with record_unwind_protect in
8531 redisplay_internal. Clears the flag indicating that a redisplay is
8535 unwind_redisplay (old_redisplaying_p
)
8536 Lisp_Object old_redisplaying_p
;
8538 redisplaying_p
= XFASTINT (old_redisplaying_p
);
8543 /* Mark the display of windows in the window tree rooted at WINDOW as
8544 accurate or inaccurate. If FLAG is non-zero mark display of WINDOW
8545 as accurate. If FLAG is zero arrange for WINDOW to be redisplayed
8546 the next time redisplay_internal is called. */
8549 mark_window_display_accurate (window
, accurate_p
)
8555 for (; !NILP (window
); window
= w
->next
)
8557 w
= XWINDOW (window
);
8559 if (BUFFERP (w
->buffer
))
8561 struct buffer
*b
= XBUFFER (w
->buffer
);
8563 XSETFASTINT (w
->last_modified
,
8564 accurate_p
? BUF_MODIFF (b
) : 0);
8565 XSETFASTINT (w
->last_overlay_modified
,
8566 accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
8567 w
->last_had_star
= (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
)
8570 #if 0 /* I don't think this is necessary because display_line does it.
8572 /* Record if we are showing a region, so can make sure to
8573 update it fully at next redisplay. */
8575 = (!NILP (Vtransient_mark_mode
)
8576 && (w
== XWINDOW (current_buffer
->last_selected_window
)
8577 || highlight_nonselected_windows
)
8578 && (!NILP (b
->mark_active
)
8579 ? Fmarker_position (b
->mark
)
8585 b
->clip_changed
= 0;
8586 b
->prevent_redisplay_optimizations_p
= 0;
8587 w
->current_matrix
->buffer
= b
;
8588 w
->current_matrix
->begv
= BUF_BEGV (b
);
8589 w
->current_matrix
->zv
= BUF_ZV (b
);
8590 w
->last_cursor
= w
->cursor
;
8591 w
->last_cursor_off_p
= w
->cursor_off_p
;
8592 if (w
== XWINDOW (selected_window
))
8593 w
->last_point
= make_number (BUF_PT (b
));
8595 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
8599 w
->window_end_valid
= w
->buffer
;
8600 w
->update_mode_line
= Qnil
;
8602 if (!NILP (w
->vchild
))
8603 mark_window_display_accurate (w
->vchild
, accurate_p
);
8604 if (!NILP (w
->hchild
))
8605 mark_window_display_accurate (w
->hchild
, accurate_p
);
8610 last_arrow_position
= COERCE_MARKER (Voverlay_arrow_position
);
8611 last_arrow_string
= Voverlay_arrow_string
;
8615 /* Force a thorough redisplay the next time by setting
8616 last_arrow_position and last_arrow_string to t, which is
8617 unequal to any useful value of Voverlay_arrow_... */
8618 last_arrow_position
= Qt
;
8619 last_arrow_string
= Qt
;
8624 /* Return value in display table DP (Lisp_Char_Table *) for character
8625 C. Since a display table doesn't have any parent, we don't have to
8626 follow parent. Do not call this function directly but use the
8627 macro DISP_CHAR_VECTOR. */
8630 disp_char_vector (dp
, c
)
8631 struct Lisp_Char_Table
*dp
;
8637 if (SINGLE_BYTE_CHAR_P (c
))
8638 return (dp
->contents
[c
]);
8640 SPLIT_CHAR (c
, code
[0], code
[1], code
[2]);
8643 else if (code
[2] < 32)
8646 /* Here, the possible range of code[0] (== charset ID) is
8647 128..max_charset. Since the top level char table contains data
8648 for multibyte characters after 256th element, we must increment
8649 code[0] by 128 to get a correct index. */
8651 code
[3] = -1; /* anchor */
8653 for (i
= 0; code
[i
] >= 0; i
++, dp
= XCHAR_TABLE (val
))
8655 val
= dp
->contents
[code
[i
]];
8656 if (!SUB_CHAR_TABLE_P (val
))
8657 return (NILP (val
) ? dp
->defalt
: val
);
8660 /* Here, val is a sub char table. We return the default value of
8662 return (dp
->defalt
);
8667 /***********************************************************************
8669 ***********************************************************************/
8671 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
8674 redisplay_windows (window
)
8677 while (!NILP (window
))
8679 struct window
*w
= XWINDOW (window
);
8681 if (!NILP (w
->hchild
))
8682 redisplay_windows (w
->hchild
);
8683 else if (!NILP (w
->vchild
))
8684 redisplay_windows (w
->vchild
);
8686 redisplay_window (window
, 0);
8693 /* Set cursor position of W. PT is assumed to be displayed in ROW.
8694 DELTA is the number of bytes by which positions recorded in ROW
8695 differ from current buffer positions. */
8698 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
8700 struct glyph_row
*row
;
8701 struct glyph_matrix
*matrix
;
8702 int delta
, delta_bytes
, dy
, dvpos
;
8704 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
8705 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
8707 int pt_old
= PT
- delta
;
8709 /* Skip over glyphs not having an object at the start of the row.
8710 These are special glyphs like truncation marks on terminal
8712 if (row
->displays_text_p
)
8714 && INTEGERP (glyph
->object
)
8715 && glyph
->charpos
< 0)
8717 x
+= glyph
->pixel_width
;
8722 && !INTEGERP (glyph
->object
)
8723 && (!BUFFERP (glyph
->object
)
8724 || glyph
->charpos
< pt_old
))
8726 x
+= glyph
->pixel_width
;
8730 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
8732 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
8733 w
->cursor
.y
= row
->y
+ dy
;
8735 if (w
== XWINDOW (selected_window
))
8737 if (!row
->continued_p
8738 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
8741 this_line_buffer
= XBUFFER (w
->buffer
);
8743 CHARPOS (this_line_start_pos
)
8744 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
8745 BYTEPOS (this_line_start_pos
)
8746 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
8748 CHARPOS (this_line_end_pos
)
8749 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
8750 BYTEPOS (this_line_end_pos
)
8751 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
8753 this_line_y
= w
->cursor
.y
;
8754 this_line_pixel_height
= row
->height
;
8755 this_line_vpos
= w
->cursor
.vpos
;
8756 this_line_start_x
= row
->x
;
8759 CHARPOS (this_line_start_pos
) = 0;
8764 /* Run window scroll functions, if any, for WINDOW with new window
8765 start STARTP. Sets the window start of WINDOW to that position.
8767 We assume that the window's buffer is really current. */
8769 static INLINE
struct text_pos
8770 run_window_scroll_functions (window
, startp
)
8772 struct text_pos startp
;
8774 struct window
*w
= XWINDOW (window
);
8775 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
8777 if (current_buffer
!= XBUFFER (w
->buffer
))
8780 if (!NILP (Vwindow_scroll_functions
))
8782 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
8783 make_number (CHARPOS (startp
)));
8784 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
8785 /* In case the hook functions switch buffers. */
8786 if (current_buffer
!= XBUFFER (w
->buffer
))
8787 set_buffer_internal_1 (XBUFFER (w
->buffer
));
8794 /* Modify the desired matrix of window W and W->vscroll so that the
8795 line containing the cursor is fully visible. */
8798 make_cursor_line_fully_visible (w
)
8801 struct glyph_matrix
*matrix
;
8802 struct glyph_row
*row
;
8805 /* It's not always possible to find the cursor, e.g, when a window
8806 is full of overlay strings. Don't do anything in that case. */
8807 if (w
->cursor
.vpos
< 0)
8810 matrix
= w
->desired_matrix
;
8811 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
8813 /* If the cursor row is not partially visible, there's nothing
8815 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (row
))
8818 /* If the row the cursor is in is taller than the window's height,
8819 it's not clear what to do, so do nothing. */
8820 window_height
= window_box_height (w
);
8821 if (row
->height
>= window_height
)
8824 if (MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (w
, row
))
8826 int dy
= row
->height
- row
->visible_height
;
8829 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
8831 else /* MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P (w, row)) */
8833 int dy
= - (row
->height
- row
->visible_height
);
8836 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
8839 /* When we change the cursor y-position of the selected window,
8840 change this_line_y as well so that the display optimization for
8841 the cursor line of the selected window in redisplay_internal uses
8842 the correct y-position. */
8843 if (w
== XWINDOW (selected_window
))
8844 this_line_y
= w
->cursor
.y
;
8848 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
8849 non-zero means only WINDOW is redisplayed in redisplay_internal.
8850 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
8851 in redisplay_window to bring a partially visible line into view in
8852 the case that only the cursor has moved.
8856 1 if scrolling succeeded
8858 0 if scrolling didn't find point.
8860 -1 if new fonts have been loaded so that we must interrupt
8861 redisplay, adjust glyph matrices, and try again. */
8864 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
8865 scroll_step
, temp_scroll_step
)
8867 int just_this_one_p
;
8868 int scroll_conservatively
, scroll_step
;
8869 int temp_scroll_step
;
8871 struct window
*w
= XWINDOW (window
);
8872 struct frame
*f
= XFRAME (w
->frame
);
8873 struct text_pos scroll_margin_pos
;
8874 struct text_pos pos
;
8875 struct text_pos startp
;
8877 Lisp_Object window_end
;
8878 int this_scroll_margin
;
8882 int amount_to_scroll
= 0;
8883 Lisp_Object aggressive
;
8887 debug_method_add (w
, "try_scrolling");
8890 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
8892 /* Compute scroll margin height in pixels. We scroll when point is
8893 within this distance from the top or bottom of the window. */
8894 if (scroll_margin
> 0)
8896 this_scroll_margin
= min (scroll_margin
, XINT (w
->height
) / 4);
8897 this_scroll_margin
*= CANON_Y_UNIT (f
);
8900 this_scroll_margin
= 0;
8902 /* Compute how much we should try to scroll maximally to bring point
8904 if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
8905 scroll_max
= max (scroll_step
,
8906 max (scroll_conservatively
, temp_scroll_step
));
8907 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
8908 || NUMBERP (current_buffer
->scroll_up_aggressively
))
8909 /* We're trying to scroll because of aggressive scrolling
8910 but no scroll_step is set. Choose an arbitrary one. Maybe
8911 there should be a variable for this. */
8915 scroll_max
*= CANON_Y_UNIT (f
);
8917 /* Decide whether we have to scroll down. Start at the window end
8918 and move this_scroll_margin up to find the position of the scroll
8920 window_end
= Fwindow_end (window
, Qt
);
8921 CHARPOS (scroll_margin_pos
) = XINT (window_end
);
8922 BYTEPOS (scroll_margin_pos
) = CHAR_TO_BYTE (CHARPOS (scroll_margin_pos
));
8923 if (this_scroll_margin
)
8925 start_display (&it
, w
, scroll_margin_pos
);
8926 move_it_vertically (&it
, - this_scroll_margin
);
8927 scroll_margin_pos
= it
.current
.pos
;
8930 if (PT
>= CHARPOS (scroll_margin_pos
))
8937 /* Point is in the scroll margin at the bottom of the window, or
8938 below. Compute a new window start that makes point visible. */
8940 /* Compute the distance from the scroll margin to PT.
8941 Give up if the distance is greater than scroll_max. */
8942 start_display (&it
, w
, scroll_margin_pos
);
8944 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
8945 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
8946 #if 0 /* Taking the line's height into account here looks wrong. */
8947 line_height
= (it
.max_ascent
+ it
.max_descent
8948 ? it
.max_ascent
+ it
.max_descent
8950 dy
= it
.current_y
+ line_height
- y0
;
8952 /* With a scroll_margin of 0, scroll_margin_pos is at the window
8953 end, which is one line below the window. The iterator's
8954 current_y will be same as y0 in that case, but we have to
8955 scroll a line to make PT visible. That's the reason why 1 is
8957 dy
= 1 + it
.current_y
- y0
;
8960 if (dy
> scroll_max
)
8963 /* Move the window start down. If scrolling conservatively,
8964 move it just enough down to make point visible. If
8965 scroll_step is set, move it down by scroll_step. */
8966 start_display (&it
, w
, startp
);
8968 if (scroll_conservatively
)
8970 max (dy
, CANON_Y_UNIT (f
) * max (scroll_step
, temp_scroll_step
));
8971 else if (scroll_step
|| temp_scroll_step
)
8972 amount_to_scroll
= scroll_max
;
8975 aggressive
= current_buffer
->scroll_down_aggressively
;
8976 height
= (WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE (w
)
8977 - WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
));
8978 if (NUMBERP (aggressive
))
8979 amount_to_scroll
= XFLOATINT (aggressive
) * height
;
8982 if (amount_to_scroll
<= 0)
8985 move_it_vertically (&it
, amount_to_scroll
);
8986 startp
= it
.current
.pos
;
8990 /* See if point is inside the scroll margin at the top of the
8992 scroll_margin_pos
= startp
;
8993 if (this_scroll_margin
)
8995 start_display (&it
, w
, startp
);
8996 move_it_vertically (&it
, this_scroll_margin
);
8997 scroll_margin_pos
= it
.current
.pos
;
9000 if (PT
< CHARPOS (scroll_margin_pos
))
9002 /* Point is in the scroll margin at the top of the window or
9003 above what is displayed in the window. */
9006 /* Compute the vertical distance from PT to the scroll
9007 margin position. Give up if distance is greater than
9009 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
9010 start_display (&it
, w
, pos
);
9012 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
9013 it
.last_visible_y
, -1,
9014 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9015 dy
= it
.current_y
- y0
;
9016 if (dy
> scroll_max
)
9019 /* Compute new window start. */
9020 start_display (&it
, w
, startp
);
9022 if (scroll_conservatively
)
9024 max (dy
, CANON_Y_UNIT (f
) * max (scroll_step
, temp_scroll_step
));
9025 else if (scroll_step
|| temp_scroll_step
)
9026 amount_to_scroll
= scroll_max
;
9029 aggressive
= current_buffer
->scroll_up_aggressively
;
9030 height
= (WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE (w
)
9031 - WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
));
9032 if (NUMBERP (aggressive
))
9033 amount_to_scroll
= XFLOATINT (aggressive
) * height
;
9036 if (amount_to_scroll
<= 0)
9039 move_it_vertically (&it
, - amount_to_scroll
);
9040 startp
= it
.current
.pos
;
9044 /* Run window scroll functions. */
9045 startp
= run_window_scroll_functions (window
, startp
);
9047 /* Display the window. Give up if new fonts are loaded, or if point
9049 if (!try_window (window
, startp
))
9051 else if (w
->cursor
.vpos
< 0)
9053 clear_glyph_matrix (w
->desired_matrix
);
9058 /* Maybe forget recorded base line for line number display. */
9059 if (!just_this_one_p
9060 || current_buffer
->clip_changed
9061 || BEG_UNCHANGED
< CHARPOS (startp
))
9062 w
->base_line_number
= Qnil
;
9064 /* If cursor ends up on a partially visible line, shift display
9065 lines up or down. */
9066 make_cursor_line_fully_visible (w
);
9074 /* Compute a suitable window start for window W if display of W starts
9075 on a continuation line. Value is non-zero if a new window start
9078 The new window start will be computed, based on W's width, starting
9079 from the start of the continued line. It is the start of the
9080 screen line with the minimum distance from the old start W->start. */
9083 compute_window_start_on_continuation_line (w
)
9086 struct text_pos pos
, start_pos
;
9087 int window_start_changed_p
= 0;
9089 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
9091 /* If window start is on a continuation line... Window start may be
9092 < BEGV in case there's invisible text at the start of the
9093 buffer (M-x rmail, for example). */
9094 if (CHARPOS (start_pos
) > BEGV
9095 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
9098 struct glyph_row
*row
;
9100 /* Handle the case that the window start is out of range. */
9101 if (CHARPOS (start_pos
) < BEGV
)
9102 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
9103 else if (CHARPOS (start_pos
) > ZV
)
9104 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
9106 /* Find the start of the continued line. This should be fast
9107 because scan_buffer is fast (newline cache). */
9108 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
9109 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
9110 row
, DEFAULT_FACE_ID
);
9111 reseat_at_previous_visible_line_start (&it
);
9113 /* If the line start is "too far" away from the window start,
9114 say it takes too much time to compute a new window start. */
9115 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
9116 < XFASTINT (w
->height
) * XFASTINT (w
->width
))
9118 int min_distance
, distance
;
9120 /* Move forward by display lines to find the new window
9121 start. If window width was enlarged, the new start can
9122 be expected to be > the old start. If window width was
9123 decreased, the new window start will be < the old start.
9124 So, we're looking for the display line start with the
9125 minimum distance from the old window start. */
9126 pos
= it
.current
.pos
;
9127 min_distance
= INFINITY
;
9128 while ((distance
= abs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
9129 distance
< min_distance
)
9131 min_distance
= distance
;
9132 pos
= it
.current
.pos
;
9133 move_it_by_lines (&it
, 1, 0);
9136 /* Set the window start there. */
9137 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
9138 window_start_changed_p
= 1;
9142 return window_start_changed_p
;
9146 /* Try cursor movement in case text has not changes in window WINDOW,
9147 with window start STARTP. Value is
9151 0 if this method cannot be used
9153 -1 if we know we have to scroll the display. *SCROLL_STEP is
9154 set to 1, under certain circumstances, if we want to scroll as
9155 if scroll-step were set to 1. See the code. */
9158 try_cursor_movement (window
, startp
, scroll_step
)
9160 struct text_pos startp
;
9163 struct window
*w
= XWINDOW (window
);
9164 struct frame
*f
= XFRAME (w
->frame
);
9167 /* Handle case where text has not changed, only point, and it has
9168 not moved off the frame. */
9169 if (/* Point may be in this window. */
9170 PT
>= CHARPOS (startp
)
9171 /* Selective display hasn't changed. */
9172 && !current_buffer
->clip_changed
9173 /* Function force-mode-line-update is used to force a thorough
9174 redisplay. It sets either windows_or_buffers_changed or
9175 update_mode_lines. So don't take a shortcut here for these
9177 && !update_mode_lines
9178 && !windows_or_buffers_changed
9179 /* Can't use this case if highlighting a region. When a
9180 region exists, cursor movement has to do more than just
9182 && !(!NILP (Vtransient_mark_mode
)
9183 && !NILP (current_buffer
->mark_active
))
9184 && NILP (w
->region_showing
)
9185 && NILP (Vshow_trailing_whitespace
)
9186 /* Right after splitting windows, last_point may be nil. */
9187 && INTEGERP (w
->last_point
)
9188 /* This code is not used for mini-buffer for the sake of the case
9189 of redisplaying to replace an echo area message; since in
9190 that case the mini-buffer contents per se are usually
9191 unchanged. This code is of no real use in the mini-buffer
9192 since the handling of this_line_start_pos, etc., in redisplay
9193 handles the same cases. */
9194 && !EQ (window
, minibuf_window
)
9195 /* When splitting windows or for new windows, it happens that
9196 redisplay is called with a nil window_end_vpos or one being
9197 larger than the window. This should really be fixed in
9198 window.c. I don't have this on my list, now, so we do
9199 approximately the same as the old redisplay code. --gerd. */
9200 && INTEGERP (w
->window_end_vpos
)
9201 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
9202 && (FRAME_WINDOW_P (f
)
9203 || !MARKERP (Voverlay_arrow_position
)
9204 || current_buffer
!= XMARKER (Voverlay_arrow_position
)->buffer
))
9206 int this_scroll_margin
;
9207 struct glyph_row
*row
;
9210 debug_method_add (w
, "cursor movement");
9213 /* Scroll if point within this distance from the top or bottom
9214 of the window. This is a pixel value. */
9215 this_scroll_margin
= max (0, scroll_margin
);
9216 this_scroll_margin
= min (this_scroll_margin
, XFASTINT (w
->height
) / 4);
9217 this_scroll_margin
*= CANON_Y_UNIT (f
);
9219 /* Start with the row the cursor was displayed during the last
9220 not paused redisplay. Give up if that row is not valid. */
9221 if (w
->last_cursor
.vpos
< 0
9222 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
9226 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
9227 if (row
->mode_line_p
)
9229 if (!row
->enabled_p
)
9236 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
9238 if (PT
> XFASTINT (w
->last_point
))
9240 /* Point has moved forward. */
9241 while (MATRIX_ROW_END_CHARPOS (row
) < PT
9242 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
9244 xassert (row
->enabled_p
);
9248 /* The end position of a row equals the start position
9249 of the next row. If PT is there, we would rather
9250 display it in the next line. */
9251 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
9252 && MATRIX_ROW_END_CHARPOS (row
) == PT
9253 && !cursor_row_p (w
, row
))
9256 /* If within the scroll margin, scroll. Note that
9257 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
9258 the next line would be drawn, and that
9259 this_scroll_margin can be zero. */
9260 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
9261 || PT
> MATRIX_ROW_END_CHARPOS (row
)
9262 /* Line is completely visible last line in window
9263 and PT is to be set in the next line. */
9264 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
9265 && PT
== MATRIX_ROW_END_CHARPOS (row
)
9266 && !row
->ends_at_zv_p
9267 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
9270 else if (PT
< XFASTINT (w
->last_point
))
9272 /* Cursor has to be moved backward. Note that PT >=
9273 CHARPOS (startp) because of the outer
9275 while (!row
->mode_line_p
9276 && (MATRIX_ROW_START_CHARPOS (row
) > PT
9277 || (MATRIX_ROW_START_CHARPOS (row
) == PT
9278 && MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)))
9279 && (row
->y
> this_scroll_margin
9280 || CHARPOS (startp
) == BEGV
))
9282 xassert (row
->enabled_p
);
9286 /* Consider the following case: Window starts at BEGV,
9287 there is invisible, intangible text at BEGV, so that
9288 display starts at some point START > BEGV. It can
9289 happen that we are called with PT somewhere between
9290 BEGV and START. Try to handle that case. */
9291 if (row
< w
->current_matrix
->rows
9292 || row
->mode_line_p
)
9294 row
= w
->current_matrix
->rows
;
9295 if (row
->mode_line_p
)
9299 /* Due to newlines in overlay strings, we may have to
9300 skip forward over overlay strings. */
9301 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
9302 && MATRIX_ROW_END_CHARPOS (row
) == PT
9303 && !cursor_row_p (w
, row
))
9306 /* If within the scroll margin, scroll. */
9307 if (row
->y
< this_scroll_margin
9308 && CHARPOS (startp
) != BEGV
)
9312 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
9313 || PT
> MATRIX_ROW_END_CHARPOS (row
))
9315 /* if PT is not in the glyph row, give up. */
9318 else if (MATRIX_ROW_PARTIALLY_VISIBLE_P (row
))
9320 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
9321 && !row
->ends_at_zv_p
9322 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
9324 else if (row
->height
> window_box_height (w
))
9326 /* If we end up in a partially visible line, let's
9327 make it fully visible, except when it's taller
9328 than the window, in which case we can't do much
9335 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
9336 try_window (window
, startp
);
9337 make_cursor_line_fully_visible (w
);
9345 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
9355 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
9356 selected_window is redisplayed. */
9359 redisplay_window (window
, just_this_one_p
)
9361 int just_this_one_p
;
9363 struct window
*w
= XWINDOW (window
);
9364 struct frame
*f
= XFRAME (w
->frame
);
9365 struct buffer
*buffer
= XBUFFER (w
->buffer
);
9366 struct buffer
*old
= current_buffer
;
9367 struct text_pos lpoint
, opoint
, startp
;
9368 int update_mode_line
;
9371 /* Record it now because it's overwritten. */
9372 int current_matrix_up_to_date_p
= 0;
9373 int temp_scroll_step
= 0;
9374 int count
= BINDING_STACK_SIZE ();
9377 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
9380 /* W must be a leaf window here. */
9381 xassert (!NILP (w
->buffer
));
9383 *w
->desired_matrix
->method
= 0;
9386 specbind (Qinhibit_point_motion_hooks
, Qt
);
9388 reconsider_clip_changes (w
, buffer
);
9390 /* Has the mode line to be updated? */
9391 update_mode_line
= (!NILP (w
->update_mode_line
)
9392 || update_mode_lines
9393 || buffer
->clip_changed
);
9395 if (MINI_WINDOW_P (w
))
9397 if (w
== XWINDOW (echo_area_window
)
9398 && !NILP (echo_area_buffer
[0]))
9400 if (update_mode_line
)
9401 /* We may have to update a tty frame's menu bar or a
9402 tool-bar. Example `M-x C-h C-h C-g'. */
9403 goto finish_menu_bars
;
9405 /* We've already displayed the echo area glyphs in this window. */
9406 goto finish_scroll_bars
;
9408 else if (w
!= XWINDOW (minibuf_window
))
9410 /* W is a mini-buffer window, but it's not the currently
9411 active one, so clear it. */
9412 int yb
= window_text_bottom_y (w
);
9413 struct glyph_row
*row
;
9416 for (y
= 0, row
= w
->desired_matrix
->rows
;
9418 y
+= row
->height
, ++row
)
9419 blank_row (w
, row
, y
);
9420 goto finish_scroll_bars
;
9424 /* Otherwise set up data on this window; select its buffer and point
9426 /* Really select the buffer, for the sake of buffer-local
9428 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9429 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
9431 current_matrix_up_to_date_p
9432 = (!NILP (w
->window_end_valid
)
9433 && !current_buffer
->clip_changed
9434 && XFASTINT (w
->last_modified
) >= MODIFF
9435 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
9437 /* When windows_or_buffers_changed is non-zero, we can't rely on
9438 the window end being valid, so set it to nil there. */
9439 if (windows_or_buffers_changed
)
9441 /* If window starts on a continuation line, maybe adjust the
9442 window start in case the window's width changed. */
9443 if (XMARKER (w
->start
)->buffer
== current_buffer
)
9444 compute_window_start_on_continuation_line (w
);
9446 w
->window_end_valid
= Qnil
;
9449 /* Some sanity checks. */
9450 CHECK_WINDOW_END (w
);
9451 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
9453 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
9456 /* If %c is in mode line, update it if needed. */
9457 if (!NILP (w
->column_number_displayed
)
9458 /* This alternative quickly identifies a common case
9459 where no change is needed. */
9460 && !(PT
== XFASTINT (w
->last_point
)
9461 && XFASTINT (w
->last_modified
) >= MODIFF
9462 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
9463 && XFASTINT (w
->column_number_displayed
) != current_column ())
9464 update_mode_line
= 1;
9466 /* Count number of windows showing the selected buffer. An indirect
9467 buffer counts as its base buffer. */
9468 if (!just_this_one_p
)
9470 struct buffer
*current_base
, *window_base
;
9471 current_base
= current_buffer
;
9472 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
9473 if (current_base
->base_buffer
)
9474 current_base
= current_base
->base_buffer
;
9475 if (window_base
->base_buffer
)
9476 window_base
= window_base
->base_buffer
;
9477 if (current_base
== window_base
)
9481 /* Point refers normally to the selected window. For any other
9482 window, set up appropriate value. */
9483 if (!EQ (window
, selected_window
))
9485 int new_pt
= XMARKER (w
->pointm
)->charpos
;
9486 int new_pt_byte
= marker_byte_position (w
->pointm
);
9490 new_pt_byte
= BEGV_BYTE
;
9491 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
9493 else if (new_pt
> (ZV
- 1))
9496 new_pt_byte
= ZV_BYTE
;
9497 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
9500 /* We don't use SET_PT so that the point-motion hooks don't run. */
9501 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
9504 /* If any of the character widths specified in the display table
9505 have changed, invalidate the width run cache. It's true that
9506 this may be a bit late to catch such changes, but the rest of
9507 redisplay goes (non-fatally) haywire when the display table is
9508 changed, so why should we worry about doing any better? */
9509 if (current_buffer
->width_run_cache
)
9511 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
9513 if (! disptab_matches_widthtab (disptab
,
9514 XVECTOR (current_buffer
->width_table
)))
9516 invalidate_region_cache (current_buffer
,
9517 current_buffer
->width_run_cache
,
9519 recompute_width_table (current_buffer
, disptab
);
9523 /* If window-start is screwed up, choose a new one. */
9524 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
9527 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
9529 /* If someone specified a new starting point but did not insist,
9530 check whether it can be used. */
9531 if (!NILP (w
->optional_new_start
)
9532 && CHARPOS (startp
) >= BEGV
9533 && CHARPOS (startp
) <= ZV
)
9535 w
->optional_new_start
= Qnil
;
9536 start_display (&it
, w
, startp
);
9537 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
9538 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9539 if (IT_CHARPOS (it
) == PT
)
9540 w
->force_start
= Qt
;
9543 /* Handle case where place to start displaying has been specified,
9544 unless the specified location is outside the accessible range. */
9545 if (!NILP (w
->force_start
)
9546 || w
->frozen_window_start_p
)
9548 w
->force_start
= Qnil
;
9550 w
->window_end_valid
= Qnil
;
9552 /* Forget any recorded base line for line number display. */
9553 if (!current_matrix_up_to_date_p
9554 || current_buffer
->clip_changed
)
9555 w
->base_line_number
= Qnil
;
9557 /* Redisplay the mode line. Select the buffer properly for that.
9558 Also, run the hook window-scroll-functions
9559 because we have scrolled. */
9560 /* Note, we do this after clearing force_start because
9561 if there's an error, it is better to forget about force_start
9562 than to get into an infinite loop calling the hook functions
9563 and having them get more errors. */
9564 if (!update_mode_line
9565 || ! NILP (Vwindow_scroll_functions
))
9567 update_mode_line
= 1;
9568 w
->update_mode_line
= Qt
;
9569 startp
= run_window_scroll_functions (window
, startp
);
9572 XSETFASTINT (w
->last_modified
, 0);
9573 XSETFASTINT (w
->last_overlay_modified
, 0);
9574 if (CHARPOS (startp
) < BEGV
)
9575 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
9576 else if (CHARPOS (startp
) > ZV
)
9577 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
9579 /* Redisplay, then check if cursor has been set during the
9580 redisplay. Give up if new fonts were loaded. */
9581 if (!try_window (window
, startp
))
9583 w
->force_start
= Qt
;
9584 clear_glyph_matrix (w
->desired_matrix
);
9585 goto finish_scroll_bars
;
9588 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
9590 /* If point does not appear, try to move point so it does
9591 appear. The desired matrix has been built above, so we
9594 struct glyph_row
*row
;
9596 window_height
= window_box_height (w
) / 2;
9597 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
9598 while (MATRIX_ROW_BOTTOM_Y (row
) < window_height
)
9601 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
9602 MATRIX_ROW_START_BYTEPOS (row
));
9604 if (w
!= XWINDOW (selected_window
))
9605 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
9606 else if (current_buffer
== old
)
9607 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
9609 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
9611 /* If we are highlighting the region, then we just changed
9612 the region, so redisplay to show it. */
9613 if (!NILP (Vtransient_mark_mode
)
9614 && !NILP (current_buffer
->mark_active
))
9616 clear_glyph_matrix (w
->desired_matrix
);
9617 if (!try_window (window
, startp
))
9618 goto finish_scroll_bars
;
9622 make_cursor_line_fully_visible (w
);
9624 debug_method_add (w
, "forced window start");
9629 /* Handle case where text has not changed, only point, and it has
9630 not moved off the frame. */
9631 if (current_matrix_up_to_date_p
9632 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
9640 /* If current starting point was originally the beginning of a line
9641 but no longer is, find a new starting point. */
9642 else if (!NILP (w
->start_at_line_beg
)
9643 && !(CHARPOS (startp
) <= BEGV
9644 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
9647 debug_method_add (w
, "recenter 1");
9652 /* Try scrolling with try_window_id. */
9653 else if (/* Windows and buffers haven't changed. */
9654 !windows_or_buffers_changed
9655 /* Window must be either use window-based redisplay or
9657 && (FRAME_WINDOW_P (f
)
9658 || (line_ins_del_ok
&& WINDOW_FULL_WIDTH_P (w
)))
9659 && !MINI_WINDOW_P (w
)
9660 /* Point is not known NOT to appear in window. */
9661 && PT
>= CHARPOS (startp
)
9662 && XFASTINT (w
->last_modified
)
9663 /* Window is not hscrolled. */
9664 && XFASTINT (w
->hscroll
) == 0
9665 /* Selective display has not changed. */
9666 && !current_buffer
->clip_changed
9667 /* Current matrix is up to date. */
9668 && !NILP (w
->window_end_valid
)
9669 /* Can't use this case if highlighting a region because
9670 a cursor movement will do more than just set the cursor. */
9671 && !(!NILP (Vtransient_mark_mode
)
9672 && !NILP (current_buffer
->mark_active
))
9673 && NILP (w
->region_showing
)
9674 && NILP (Vshow_trailing_whitespace
)
9675 /* Overlay arrow position and string not changed. */
9676 && EQ (last_arrow_position
, COERCE_MARKER (Voverlay_arrow_position
))
9677 && EQ (last_arrow_string
, Voverlay_arrow_string
)
9678 /* Value is > 0 if update has been done, it is -1 if we
9679 know that the same window start will not work. It is 0
9680 if unsuccessful for some other reason. */
9681 && (tem
= try_window_id (w
)) != 0)
9684 debug_method_add (w
, "try_window_id %d", tem
);
9687 if (fonts_changed_p
)
9688 goto finish_scroll_bars
;
9692 /* Otherwise try_window_id has returned -1 which means that we
9693 don't want the alternative below this comment to execute. */
9695 else if (CHARPOS (startp
) >= BEGV
9696 && CHARPOS (startp
) <= ZV
9697 && PT
>= CHARPOS (startp
)
9698 && (CHARPOS (startp
) < ZV
9699 /* Avoid starting at end of buffer. */
9700 || CHARPOS (startp
) == BEGV
9701 || (XFASTINT (w
->last_modified
) >= MODIFF
9702 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
9705 debug_method_add (w
, "same window start");
9708 /* Try to redisplay starting at same place as before.
9709 If point has not moved off frame, accept the results. */
9710 if (!current_matrix_up_to_date_p
9711 /* Don't use try_window_reusing_current_matrix in this case
9712 because a window scroll function can have changed the
9714 || !NILP (Vwindow_scroll_functions
)
9715 || MINI_WINDOW_P (w
)
9716 || !try_window_reusing_current_matrix (w
))
9718 IF_DEBUG (debug_method_add (w
, "1"));
9719 try_window (window
, startp
);
9722 if (fonts_changed_p
)
9723 goto finish_scroll_bars
;
9725 if (w
->cursor
.vpos
>= 0)
9727 if (!just_this_one_p
9728 || current_buffer
->clip_changed
9729 || BEG_UNCHANGED
< CHARPOS (startp
))
9730 /* Forget any recorded base line for line number display. */
9731 w
->base_line_number
= Qnil
;
9733 make_cursor_line_fully_visible (w
);
9737 clear_glyph_matrix (w
->desired_matrix
);
9742 XSETFASTINT (w
->last_modified
, 0);
9743 XSETFASTINT (w
->last_overlay_modified
, 0);
9745 /* Redisplay the mode line. Select the buffer properly for that. */
9746 if (!update_mode_line
)
9748 update_mode_line
= 1;
9749 w
->update_mode_line
= Qt
;
9752 /* Try to scroll by specified few lines. */
9753 if ((scroll_conservatively
9756 || NUMBERP (current_buffer
->scroll_up_aggressively
)
9757 || NUMBERP (current_buffer
->scroll_down_aggressively
))
9758 && !current_buffer
->clip_changed
9759 && CHARPOS (startp
) >= BEGV
9760 && CHARPOS (startp
) <= ZV
)
9762 /* The function returns -1 if new fonts were loaded, 1 if
9763 successful, 0 if not successful. */
9764 int rc
= try_scrolling (window
, just_this_one_p
,
9765 scroll_conservatively
,
9771 goto finish_scroll_bars
;
9774 /* Finally, just choose place to start which centers point */
9779 debug_method_add (w
, "recenter");
9782 /* w->vscroll = 0; */
9784 /* Forget any previously recorded base line for line number display. */
9785 if (!current_matrix_up_to_date_p
9786 || current_buffer
->clip_changed
)
9787 w
->base_line_number
= Qnil
;
9789 /* Move backward half the height of the window. */
9790 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
9791 it
.current_y
= it
.last_visible_y
;
9792 move_it_vertically_backward (&it
, it
.last_visible_y
/ 2);
9793 xassert (IT_CHARPOS (it
) >= BEGV
);
9795 /* The function move_it_vertically_backward may move over more
9796 than the specified y-distance. If it->w is small, e.g. a
9797 mini-buffer window, we may end up in front of the window's
9798 display area. Start displaying at the start of the line
9799 containing PT in this case. */
9800 if (it
.current_y
<= 0)
9802 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
9803 move_it_vertically (&it
, 0);
9804 xassert (IT_CHARPOS (it
) <= PT
);
9808 it
.current_x
= it
.hpos
= 0;
9810 /* Set startp here explicitly in case that helps avoid an infinite loop
9811 in case the window-scroll-functions functions get errors. */
9812 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
9814 /* Run scroll hooks. */
9815 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
9817 /* Redisplay the window. */
9818 if (!current_matrix_up_to_date_p
9819 || windows_or_buffers_changed
9820 /* Don't use try_window_reusing_current_matrix in this case
9821 because it can have changed the buffer. */
9822 || !NILP (Vwindow_scroll_functions
)
9824 || MINI_WINDOW_P (w
)
9825 || !try_window_reusing_current_matrix (w
))
9826 try_window (window
, startp
);
9828 /* If new fonts have been loaded (due to fontsets), give up. We
9829 have to start a new redisplay since we need to re-adjust glyph
9831 if (fonts_changed_p
)
9832 goto finish_scroll_bars
;
9834 /* If cursor did not appear assume that the middle of the window is
9835 in the first line of the window. Do it again with the next line.
9836 (Imagine a window of height 100, displaying two lines of height
9837 60. Moving back 50 from it->last_visible_y will end in the first
9839 if (w
->cursor
.vpos
< 0)
9841 if (!NILP (w
->window_end_valid
)
9842 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
9844 clear_glyph_matrix (w
->desired_matrix
);
9845 move_it_by_lines (&it
, 1, 0);
9846 try_window (window
, it
.current
.pos
);
9848 else if (PT
< IT_CHARPOS (it
))
9850 clear_glyph_matrix (w
->desired_matrix
);
9851 move_it_by_lines (&it
, -1, 0);
9852 try_window (window
, it
.current
.pos
);
9856 /* Not much we can do about it. */
9860 /* Consider the following case: Window starts at BEGV, there is
9861 invisible, intangible text at BEGV, so that display starts at
9862 some point START > BEGV. It can happen that we are called with
9863 PT somewhere between BEGV and START. Try to handle that case. */
9864 if (w
->cursor
.vpos
< 0)
9866 struct glyph_row
*row
= w
->current_matrix
->rows
;
9867 if (row
->mode_line_p
)
9869 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
9872 make_cursor_line_fully_visible (w
);
9876 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
9877 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
9878 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
9881 /* Display the mode line, if we must. */
9882 if ((update_mode_line
9883 /* If window not full width, must redo its mode line
9884 if (a) the window to its side is being redone and
9885 (b) we do a frame-based redisplay. This is a consequence
9886 of how inverted lines are drawn in frame-based redisplay. */
9887 || (!just_this_one_p
9888 && !FRAME_WINDOW_P (f
)
9889 && !WINDOW_FULL_WIDTH_P (w
))
9890 /* Line number to display. */
9891 || INTEGERP (w
->base_line_pos
)
9892 /* Column number is displayed and different from the one displayed. */
9893 || (!NILP (w
->column_number_displayed
)
9894 && XFASTINT (w
->column_number_displayed
) != current_column ()))
9895 /* This means that the window has a mode line. */
9896 && (WINDOW_WANTS_MODELINE_P (w
)
9897 || WINDOW_WANTS_HEADER_LINE_P (w
)))
9899 Lisp_Object old_selected_frame
;
9901 old_selected_frame
= selected_frame
;
9903 XSETFRAME (selected_frame
, f
);
9904 display_mode_lines (w
);
9905 selected_frame
= old_selected_frame
;
9907 /* If mode line height has changed, arrange for a thorough
9908 immediate redisplay using the correct mode line height. */
9909 if (WINDOW_WANTS_MODELINE_P (w
)
9910 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
9912 fonts_changed_p
= 1;
9913 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
9914 = DESIRED_MODE_LINE_HEIGHT (w
);
9917 /* If top line height has changed, arrange for a thorough
9918 immediate redisplay using the correct mode line height. */
9919 if (WINDOW_WANTS_HEADER_LINE_P (w
)
9920 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
9922 fonts_changed_p
= 1;
9923 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
9924 = DESIRED_HEADER_LINE_HEIGHT (w
);
9927 if (fonts_changed_p
)
9928 goto finish_scroll_bars
;
9931 if (!line_number_displayed
9932 && !BUFFERP (w
->base_line_pos
))
9934 w
->base_line_pos
= Qnil
;
9935 w
->base_line_number
= Qnil
;
9940 /* When we reach a frame's selected window, redo the frame's menu bar. */
9941 if (update_mode_line
9942 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
9944 int redisplay_menu_p
= 0;
9946 if (FRAME_WINDOW_P (f
))
9948 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (macintosh)
9949 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
9951 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
9955 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
9957 if (redisplay_menu_p
)
9958 display_menu_bar (w
);
9960 #ifdef HAVE_WINDOW_SYSTEM
9961 if (WINDOWP (f
->tool_bar_window
)
9962 && (FRAME_TOOL_BAR_LINES (f
) > 0
9963 || auto_resize_tool_bars_p
))
9964 redisplay_tool_bar (f
);
9970 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
))
9972 int start
, end
, whole
;
9974 /* Calculate the start and end positions for the current window.
9975 At some point, it would be nice to choose between scrollbars
9976 which reflect the whole buffer size, with special markers
9977 indicating narrowing, and scrollbars which reflect only the
9980 Note that mini-buffers sometimes aren't displaying any text. */
9981 if (!MINI_WINDOW_P (w
)
9982 || (w
== XWINDOW (minibuf_window
)
9983 && NILP (echo_area_buffer
[0])))
9986 start
= marker_position (w
->start
) - BEGV
;
9987 /* I don't think this is guaranteed to be right. For the
9988 moment, we'll pretend it is. */
9989 end
= (Z
- XFASTINT (w
->window_end_pos
)) - BEGV
;
9993 if (whole
< (end
- start
))
9994 whole
= end
- start
;
9997 start
= end
= whole
= 0;
9999 /* Indicate what this scroll bar ought to be displaying now. */
10000 set_vertical_scroll_bar_hook (w
, end
- start
, whole
, start
);
10002 /* Note that we actually used the scroll bar attached to this
10003 window, so it shouldn't be deleted at the end of redisplay. */
10004 redeem_scroll_bar_hook (w
);
10007 /* Restore current_buffer and value of point in it. */
10008 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
10009 set_buffer_internal_1 (old
);
10010 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
10012 unbind_to (count
, Qnil
);
10016 /* Build the complete desired matrix of WINDOW with a window start
10017 buffer position POS. Value is non-zero if successful. It is zero
10018 if fonts were loaded during redisplay which makes re-adjusting
10019 glyph matrices necessary. */
10022 try_window (window
, pos
)
10023 Lisp_Object window
;
10024 struct text_pos pos
;
10026 struct window
*w
= XWINDOW (window
);
10028 struct glyph_row
*last_text_row
= NULL
;
10030 /* Make POS the new window start. */
10031 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
10033 /* Mark cursor position as unknown. No overlay arrow seen. */
10034 w
->cursor
.vpos
= -1;
10035 overlay_arrow_seen
= 0;
10037 /* Initialize iterator and info to start at POS. */
10038 start_display (&it
, w
, pos
);
10040 /* Display all lines of W. */
10041 while (it
.current_y
< it
.last_visible_y
)
10043 if (display_line (&it
))
10044 last_text_row
= it
.glyph_row
- 1;
10045 if (fonts_changed_p
)
10049 /* If bottom moved off end of frame, change mode line percentage. */
10050 if (XFASTINT (w
->window_end_pos
) <= 0
10051 && Z
!= IT_CHARPOS (it
))
10052 w
->update_mode_line
= Qt
;
10054 /* Set window_end_pos to the offset of the last character displayed
10055 on the window from the end of current_buffer. Set
10056 window_end_vpos to its row number. */
10059 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
10060 w
->window_end_bytepos
10061 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
10062 XSETFASTINT (w
->window_end_pos
,
10063 Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
10064 XSETFASTINT (w
->window_end_vpos
,
10065 MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
10066 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
10067 ->displays_text_p
);
10071 w
->window_end_bytepos
= 0;
10072 XSETFASTINT (w
->window_end_pos
, 0);
10073 XSETFASTINT (w
->window_end_vpos
, 0);
10076 /* But that is not valid info until redisplay finishes. */
10077 w
->window_end_valid
= Qnil
;
10083 /************************************************************************
10084 Window redisplay reusing current matrix when buffer has not changed
10085 ************************************************************************/
10087 /* Try redisplay of window W showing an unchanged buffer with a
10088 different window start than the last time it was displayed by
10089 reusing its current matrix. Value is non-zero if successful.
10090 W->start is the new window start. */
10093 try_window_reusing_current_matrix (w
)
10096 struct frame
*f
= XFRAME (w
->frame
);
10097 struct glyph_row
*row
, *bottom_row
;
10100 struct text_pos start
, new_start
;
10101 int nrows_scrolled
, i
;
10102 struct glyph_row
*last_text_row
;
10103 struct glyph_row
*last_reused_text_row
;
10104 struct glyph_row
*start_row
;
10105 int start_vpos
, min_y
, max_y
;
10107 if (/* This function doesn't handle terminal frames. */
10108 !FRAME_WINDOW_P (f
)
10109 /* Don't try to reuse the display if windows have been split
10111 || windows_or_buffers_changed
)
10114 /* Can't do this if region may have changed. */
10115 if ((!NILP (Vtransient_mark_mode
)
10116 && !NILP (current_buffer
->mark_active
))
10117 || !NILP (w
->region_showing
)
10118 || !NILP (Vshow_trailing_whitespace
))
10121 /* If top-line visibility has changed, give up. */
10122 if (WINDOW_WANTS_HEADER_LINE_P (w
)
10123 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
10126 /* Give up if old or new display is scrolled vertically. We could
10127 make this function handle this, but right now it doesn't. */
10128 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
10129 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (start_row
))
10132 /* The variable new_start now holds the new window start. The old
10133 start `start' can be determined from the current matrix. */
10134 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
10135 start
= start_row
->start
.pos
;
10136 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
10138 /* Clear the desired matrix for the display below. */
10139 clear_glyph_matrix (w
->desired_matrix
);
10141 if (CHARPOS (new_start
) <= CHARPOS (start
))
10145 IF_DEBUG (debug_method_add (w
, "twu1"));
10147 /* Display up to a row that can be reused. The variable
10148 last_text_row is set to the last row displayed that displays
10149 text. Note that it.vpos == 0 if or if not there is a
10150 header-line; it's not the same as the MATRIX_ROW_VPOS! */
10151 start_display (&it
, w
, new_start
);
10152 first_row_y
= it
.current_y
;
10153 w
->cursor
.vpos
= -1;
10154 last_text_row
= last_reused_text_row
= NULL
;
10156 while (it
.current_y
< it
.last_visible_y
10157 && IT_CHARPOS (it
) < CHARPOS (start
)
10158 && !fonts_changed_p
)
10159 if (display_line (&it
))
10160 last_text_row
= it
.glyph_row
- 1;
10162 /* A value of current_y < last_visible_y means that we stopped
10163 at the previous window start, which in turn means that we
10164 have at least one reusable row. */
10165 if (it
.current_y
< it
.last_visible_y
)
10167 /* IT.vpos always starts from 0; it counts text lines. */
10168 nrows_scrolled
= it
.vpos
;
10170 /* Find PT if not already found in the lines displayed. */
10171 if (w
->cursor
.vpos
< 0)
10173 int dy
= it
.current_y
- first_row_y
;
10175 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
10176 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
10178 if (PT
>= MATRIX_ROW_START_CHARPOS (row
)
10179 && PT
< MATRIX_ROW_END_CHARPOS (row
))
10181 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
10182 dy
, nrows_scrolled
);
10186 if (MATRIX_ROW_BOTTOM_Y (row
) + dy
>= it
.last_visible_y
)
10192 /* Give up if point was not found. This shouldn't
10193 happen often; not more often than with try_window
10195 if (w
->cursor
.vpos
< 0)
10197 clear_glyph_matrix (w
->desired_matrix
);
10202 /* Scroll the display. Do it before the current matrix is
10203 changed. The problem here is that update has not yet
10204 run, i.e. part of the current matrix is not up to date.
10205 scroll_run_hook will clear the cursor, and use the
10206 current matrix to get the height of the row the cursor is
10208 run
.current_y
= first_row_y
;
10209 run
.desired_y
= it
.current_y
;
10210 run
.height
= it
.last_visible_y
- it
.current_y
;
10212 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
10215 rif
->update_window_begin_hook (w
);
10216 rif
->clear_mouse_face (w
);
10217 rif
->scroll_run_hook (w
, &run
);
10218 rif
->update_window_end_hook (w
, 0, 0);
10222 /* Shift current matrix down by nrows_scrolled lines. */
10223 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
10224 rotate_matrix (w
->current_matrix
,
10226 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
10229 /* Disable lines that must be updated. */
10230 for (i
= 0; i
< it
.vpos
; ++i
)
10231 (start_row
+ i
)->enabled_p
= 0;
10233 /* Re-compute Y positions. */
10234 min_y
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
);
10235 max_y
= it
.last_visible_y
;
10236 for (row
= start_row
+ nrows_scrolled
;
10240 row
->y
= it
.current_y
;
10242 if (row
->y
< min_y
)
10243 row
->visible_height
= row
->height
- (min_y
- row
->y
);
10244 else if (row
->y
+ row
->height
> max_y
)
10245 row
->visible_height
10246 = row
->height
- (row
->y
+ row
->height
- max_y
);
10248 row
->visible_height
= row
->height
;
10250 it
.current_y
+= row
->height
;
10252 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
10253 last_reused_text_row
= row
;
10254 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
10258 /* Disable lines in the current matrix which are now
10259 below the window. */
10260 for (++row
; row
< bottom_row
; ++row
)
10261 row
->enabled_p
= 0;
10264 /* Update window_end_pos etc.; last_reused_text_row is the last
10265 reused row from the current matrix containing text, if any.
10266 The value of last_text_row is the last displayed line
10267 containing text. */
10268 if (last_reused_text_row
)
10270 w
->window_end_bytepos
10271 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
10272 XSETFASTINT (w
->window_end_pos
,
10273 Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
10274 XSETFASTINT (w
->window_end_vpos
,
10275 MATRIX_ROW_VPOS (last_reused_text_row
,
10276 w
->current_matrix
));
10278 else if (last_text_row
)
10280 w
->window_end_bytepos
10281 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
10282 XSETFASTINT (w
->window_end_pos
,
10283 Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
10284 XSETFASTINT (w
->window_end_vpos
,
10285 MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
10289 /* This window must be completely empty. */
10290 w
->window_end_bytepos
= 0;
10291 XSETFASTINT (w
->window_end_pos
, 0);
10292 XSETFASTINT (w
->window_end_vpos
, 0);
10294 w
->window_end_valid
= Qnil
;
10296 /* Update hint: don't try scrolling again in update_window. */
10297 w
->desired_matrix
->no_scrolling_p
= 1;
10300 debug_method_add (w
, "try_window_reusing_current_matrix 1");
10304 else if (CHARPOS (new_start
) > CHARPOS (start
))
10306 struct glyph_row
*pt_row
, *row
;
10307 struct glyph_row
*first_reusable_row
;
10308 struct glyph_row
*first_row_to_display
;
10310 int yb
= window_text_bottom_y (w
);
10312 IF_DEBUG (debug_method_add (w
, "twu2"));
10314 /* Find the row starting at new_start, if there is one. Don't
10315 reuse a partially visible line at the end. */
10316 first_reusable_row
= start_row
;
10317 while (first_reusable_row
->enabled_p
10318 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
10319 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
10320 < CHARPOS (new_start
)))
10321 ++first_reusable_row
;
10323 /* Give up if there is no row to reuse. */
10324 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
10325 || !first_reusable_row
->enabled_p
10326 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
10327 != CHARPOS (new_start
)))
10330 /* We can reuse fully visible rows beginning with
10331 first_reusable_row to the end of the window. Set
10332 first_row_to_display to the first row that cannot be reused.
10333 Set pt_row to the row containing point, if there is any. */
10334 first_row_to_display
= first_reusable_row
;
10336 while (MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
)
10338 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
10339 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
10340 pt_row
= first_row_to_display
;
10342 ++first_row_to_display
;
10345 /* Start displaying at the start of first_row_to_display. */
10346 xassert (first_row_to_display
->y
< yb
);
10347 init_to_row_start (&it
, w
, first_row_to_display
);
10348 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
10350 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
10352 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
10353 + WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
));
10355 /* Display lines beginning with first_row_to_display in the
10356 desired matrix. Set last_text_row to the last row displayed
10357 that displays text. */
10358 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
10359 if (pt_row
== NULL
)
10360 w
->cursor
.vpos
= -1;
10361 last_text_row
= NULL
;
10362 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
10363 if (display_line (&it
))
10364 last_text_row
= it
.glyph_row
- 1;
10366 /* Give up If point isn't in a row displayed or reused. */
10367 if (w
->cursor
.vpos
< 0)
10369 clear_glyph_matrix (w
->desired_matrix
);
10373 /* If point is in a reused row, adjust y and vpos of the cursor
10377 w
->cursor
.vpos
-= MATRIX_ROW_VPOS (first_reusable_row
,
10378 w
->current_matrix
);
10379 w
->cursor
.y
-= first_reusable_row
->y
;
10382 /* Scroll the display. */
10383 run
.current_y
= first_reusable_row
->y
;
10384 run
.desired_y
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
);
10385 run
.height
= it
.last_visible_y
- run
.current_y
;
10386 dy
= run
.current_y
- run
.desired_y
;
10390 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
10392 rif
->update_window_begin_hook (w
);
10393 rif
->clear_mouse_face (w
);
10394 rif
->scroll_run_hook (w
, &run
);
10395 rif
->update_window_end_hook (w
, 0, 0);
10399 /* Adjust Y positions of reused rows. */
10400 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
10401 min_y
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
);
10402 max_y
= it
.last_visible_y
;
10403 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
10406 if (row
->y
< min_y
)
10407 row
->visible_height
= row
->height
- (min_y
- row
->y
);
10408 else if (row
->y
+ row
->height
> max_y
)
10409 row
->visible_height
10410 = row
->height
- (row
->y
+ row
->height
- max_y
);
10412 row
->visible_height
= row
->height
;
10415 /* Disable rows not reused. */
10416 while (row
< bottom_row
)
10418 row
->enabled_p
= 0;
10422 /* Scroll the current matrix. */
10423 xassert (nrows_scrolled
> 0);
10424 rotate_matrix (w
->current_matrix
,
10426 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
10429 /* Adjust window end. A null value of last_text_row means that
10430 the window end is in reused rows which in turn means that
10431 only its vpos can have changed. */
10434 w
->window_end_bytepos
10435 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
10436 XSETFASTINT (w
->window_end_pos
,
10437 Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
10438 XSETFASTINT (w
->window_end_vpos
,
10439 MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
10443 XSETFASTINT (w
->window_end_vpos
,
10444 XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
10447 w
->window_end_valid
= Qnil
;
10448 w
->desired_matrix
->no_scrolling_p
= 1;
10451 debug_method_add (w
, "try_window_reusing_current_matrix 2");
10461 /************************************************************************
10462 Window redisplay reusing current matrix when buffer has changed
10463 ************************************************************************/
10465 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
10466 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
10468 static struct glyph_row
*
10469 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
10470 struct glyph_row
*));
10473 /* Return the last row in MATRIX displaying text. If row START is
10474 non-null, start searching with that row. IT gives the dimensions
10475 of the display. Value is null if matrix is empty; otherwise it is
10476 a pointer to the row found. */
10478 static struct glyph_row
*
10479 find_last_row_displaying_text (matrix
, it
, start
)
10480 struct glyph_matrix
*matrix
;
10482 struct glyph_row
*start
;
10484 struct glyph_row
*row
, *row_found
;
10486 /* Set row_found to the last row in IT->w's current matrix
10487 displaying text. The loop looks funny but think of partially
10490 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
10491 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
10493 xassert (row
->enabled_p
);
10495 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
10504 /* Return the last row in the current matrix of W that is not affected
10505 by changes at the start of current_buffer that occurred since the
10506 last time W was redisplayed. Value is null if no such row exists.
10508 The global variable beg_unchanged has to contain the number of
10509 bytes unchanged at the start of current_buffer. BEG +
10510 beg_unchanged is the buffer position of the first changed byte in
10511 current_buffer. Characters at positions < BEG + beg_unchanged are
10512 at the same buffer positions as they were when the current matrix
10515 static struct glyph_row
*
10516 find_last_unchanged_at_beg_row (w
)
10519 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
10520 struct glyph_row
*row
;
10521 struct glyph_row
*row_found
= NULL
;
10522 int yb
= window_text_bottom_y (w
);
10524 /* Find the last row displaying unchanged text. */
10525 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
10526 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
10527 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
)
10529 if (/* If row ends before first_changed_pos, it is unchanged,
10530 except in some case. */
10531 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
10532 /* When row ends in ZV and we write at ZV it is not
10534 && !row
->ends_at_zv_p
10535 /* When first_changed_pos is the end of a continued line,
10536 row is not unchanged because it may be no longer
10538 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
10539 && row
->continued_p
))
10542 /* Stop if last visible row. */
10543 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
10553 /* Find the first glyph row in the current matrix of W that is not
10554 affected by changes at the end of current_buffer since the last
10555 time the window was redisplayed. Return in *DELTA the number of
10556 chars by which buffer positions in unchanged text at the end of
10557 current_buffer must be adjusted. Return in *DELTA_BYTES the
10558 corresponding number of bytes. Value is null if no such row
10559 exists, i.e. all rows are affected by changes. */
10561 static struct glyph_row
*
10562 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
10564 int *delta
, *delta_bytes
;
10566 struct glyph_row
*row
;
10567 struct glyph_row
*row_found
= NULL
;
10569 *delta
= *delta_bytes
= 0;
10571 /* Display must not have been paused, otherwise the current matrix
10572 is not up to date. */
10573 if (NILP (w
->window_end_valid
))
10576 /* A value of window_end_pos >= END_UNCHANGED means that the window
10577 end is in the range of changed text. If so, there is no
10578 unchanged row at the end of W's current matrix. */
10579 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
10582 /* Set row to the last row in W's current matrix displaying text. */
10583 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
10585 /* If matrix is entirely empty, no unchanged row exists. */
10586 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
10588 /* The value of row is the last glyph row in the matrix having a
10589 meaningful buffer position in it. The end position of row
10590 corresponds to window_end_pos. This allows us to translate
10591 buffer positions in the current matrix to current buffer
10592 positions for characters not in changed text. */
10593 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
10594 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
10595 int last_unchanged_pos
, last_unchanged_pos_old
;
10596 struct glyph_row
*first_text_row
10597 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
10599 *delta
= Z
- Z_old
;
10600 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
10602 /* Set last_unchanged_pos to the buffer position of the last
10603 character in the buffer that has not been changed. Z is the
10604 index + 1 of the last byte in current_buffer, i.e. by
10605 subtracting end_unchanged we get the index of the last
10606 unchanged character, and we have to add BEG to get its buffer
10608 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
10609 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
10611 /* Search backward from ROW for a row displaying a line that
10612 starts at a minimum position >= last_unchanged_pos_old. */
10613 for (; row
> first_text_row
; --row
)
10615 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
10618 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
10623 if (row_found
&& !MATRIX_ROW_DISPLAYS_TEXT_P (row_found
))
10630 /* Make sure that glyph rows in the current matrix of window W
10631 reference the same glyph memory as corresponding rows in the
10632 frame's frame matrix. This function is called after scrolling W's
10633 current matrix on a terminal frame in try_window_id and
10634 try_window_reusing_current_matrix. */
10637 sync_frame_with_window_matrix_rows (w
)
10640 struct frame
*f
= XFRAME (w
->frame
);
10641 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
10643 /* Preconditions: W must be a leaf window and full-width. Its frame
10644 must have a frame matrix. */
10645 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
10646 xassert (WINDOW_FULL_WIDTH_P (w
));
10647 xassert (!FRAME_WINDOW_P (f
));
10649 /* If W is a full-width window, glyph pointers in W's current matrix
10650 have, by definition, to be the same as glyph pointers in the
10651 corresponding frame matrix. */
10652 window_row
= w
->current_matrix
->rows
;
10653 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
10654 frame_row
= f
->current_matrix
->rows
+ XFASTINT (w
->top
);
10655 while (window_row
< window_row_end
)
10659 for (area
= LEFT_MARGIN_AREA
; area
<= LAST_AREA
; ++area
)
10660 frame_row
->glyphs
[area
] = window_row
->glyphs
[area
];
10662 /* Disable frame rows whose corresponding window rows have
10663 been disabled in try_window_id. */
10664 if (!window_row
->enabled_p
)
10665 frame_row
->enabled_p
= 0;
10667 ++window_row
, ++frame_row
;
10672 /* Find the glyph row in window W containing CHARPOS. Consider all
10673 rows between START and END (not inclusive). END null means search
10674 all rows to the end of the display area of W. Value is the row
10675 containing CHARPOS or null. */
10677 static struct glyph_row
*
10678 row_containing_pos (w
, charpos
, start
, end
)
10681 struct glyph_row
*start
, *end
;
10683 struct glyph_row
*row
= start
;
10686 /* If we happen to start on a header-line, skip that. */
10687 if (row
->mode_line_p
)
10690 if ((end
&& row
>= end
) || !row
->enabled_p
)
10693 last_y
= window_text_bottom_y (w
);
10695 while ((end
== NULL
|| row
< end
)
10696 && (MATRIX_ROW_END_CHARPOS (row
) < charpos
10697 /* The end position of a row equals the start
10698 position of the next row. If CHARPOS is there, we
10699 would rather display it in the next line, except
10700 when this line ends in ZV. */
10701 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
10702 && (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)
10703 || !row
->ends_at_zv_p
)))
10704 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
10707 /* Give up if CHARPOS not found. */
10708 if ((end
&& row
>= end
)
10709 || charpos
< MATRIX_ROW_START_CHARPOS (row
)
10710 || charpos
> MATRIX_ROW_END_CHARPOS (row
))
10717 /* Try to redisplay window W by reusing its existing display. W's
10718 current matrix must be up to date when this function is called,
10719 i.e. window_end_valid must not be nil.
10723 1 if display has been updated
10724 0 if otherwise unsuccessful
10725 -1 if redisplay with same window start is known not to succeed
10727 The following steps are performed:
10729 1. Find the last row in the current matrix of W that is not
10730 affected by changes at the start of current_buffer. If no such row
10733 2. Find the first row in W's current matrix that is not affected by
10734 changes at the end of current_buffer. Maybe there is no such row.
10736 3. Display lines beginning with the row + 1 found in step 1 to the
10737 row found in step 2 or, if step 2 didn't find a row, to the end of
10740 4. If cursor is not known to appear on the window, give up.
10742 5. If display stopped at the row found in step 2, scroll the
10743 display and current matrix as needed.
10745 6. Maybe display some lines at the end of W, if we must. This can
10746 happen under various circumstances, like a partially visible line
10747 becoming fully visible, or because newly displayed lines are displayed
10748 in smaller font sizes.
10750 7. Update W's window end information. */
10752 /* Check that window end is what we expect it to be. */
10758 struct frame
*f
= XFRAME (w
->frame
);
10759 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
10760 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
10761 struct glyph_row
*last_unchanged_at_beg_row
;
10762 struct glyph_row
*first_unchanged_at_end_row
;
10763 struct glyph_row
*row
;
10764 struct glyph_row
*bottom_row
;
10767 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
10768 struct text_pos start_pos
;
10770 int first_unchanged_at_end_vpos
= 0;
10771 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
10772 struct text_pos start
;
10774 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10776 /* Check pre-conditions. Window end must be valid, otherwise
10777 the current matrix would not be up to date. */
10778 xassert (!NILP (w
->window_end_valid
));
10779 xassert (FRAME_WINDOW_P (XFRAME (w
->frame
))
10780 || (line_ins_del_ok
&& WINDOW_FULL_WIDTH_P (w
)));
10782 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
10783 only if buffer has really changed. The reason is that the gap is
10784 initially at Z for freshly visited files. The code below would
10785 set end_unchanged to 0 in that case. */
10786 if (MODIFF
> SAVE_MODIFF
10787 /* This seems to happen sometimes after saving a buffer. */
10788 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
10790 if (GPT
- BEG
< BEG_UNCHANGED
)
10791 BEG_UNCHANGED
= GPT
- BEG
;
10792 if (Z
- GPT
< END_UNCHANGED
)
10793 END_UNCHANGED
= Z
- GPT
;
10796 /* If window starts after a line end, and the last change is in
10797 front of that newline, then changes don't affect the display.
10798 This case happens with stealth-fontification. Note that although
10799 the display is unchanged, glyph positions in the matrix have to
10800 be adjusted, of course. */
10801 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
10802 if (CHARPOS (start
) > BEGV
10803 && Z
- END_UNCHANGED
< CHARPOS (start
) - 1
10804 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n'
10805 && PT
< MATRIX_ROW_END_CHARPOS (row
))
10807 struct glyph_row
*r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
10808 int delta
= CHARPOS (start
) - MATRIX_ROW_START_CHARPOS (r0
);
10812 struct glyph_row
*r1
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
10813 int delta_bytes
= BYTEPOS (start
) - MATRIX_ROW_START_BYTEPOS (r0
);
10815 increment_matrix_positions (w
->current_matrix
,
10816 MATRIX_ROW_VPOS (r0
, current_matrix
),
10817 MATRIX_ROW_VPOS (r1
, current_matrix
),
10818 delta
, delta_bytes
);
10821 #if 0 /* If changes are all in front of the window start, the
10822 distance of the last displayed glyph from Z hasn't
10825 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
10826 w
->window_end_bytepos
10827 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
10830 row
= row_containing_pos (w
, PT
, r0
, NULL
);
10834 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
10838 /* Return quickly if changes are all below what is displayed in the
10839 window, and if PT is in the window. */
10840 if (BEG_UNCHANGED
> MATRIX_ROW_END_CHARPOS (row
)
10841 && PT
< MATRIX_ROW_END_CHARPOS (row
))
10843 /* We have to update window end positions because the buffer's
10844 size has changed. */
10846 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
10847 w
->window_end_bytepos
10848 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
10850 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
10851 row
= row_containing_pos (w
, PT
, row
, NULL
);
10852 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
10856 /* Check that window start agrees with the start of the first glyph
10857 row in its current matrix. Check this after we know the window
10858 start is not in changed text, otherwise positions would not be
10860 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
10861 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
10864 /* Compute the position at which we have to start displaying new
10865 lines. Some of the lines at the top of the window might be
10866 reusable because they are not displaying changed text. Find the
10867 last row in W's current matrix not affected by changes at the
10868 start of current_buffer. Value is null if changes start in the
10869 first line of window. */
10870 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
10871 if (last_unchanged_at_beg_row
)
10873 /* Avoid starting to display in the moddle of a character, a TAB
10874 for instance. This is easier than to set up the iterator
10875 exactly, and it's not a frequent case, so the additional
10876 effort wouldn't really pay off. */
10877 while (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
10878 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
10879 --last_unchanged_at_beg_row
;
10881 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
10884 init_to_row_end (&it
, w
, last_unchanged_at_beg_row
);
10885 start_pos
= it
.current
.pos
;
10887 /* Start displaying new lines in the desired matrix at the same
10888 vpos we would use in the current matrix, i.e. below
10889 last_unchanged_at_beg_row. */
10890 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
10892 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
10893 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
10895 xassert (it
.hpos
== 0 && it
.current_x
== 0);
10899 /* There are no reusable lines at the start of the window.
10900 Start displaying in the first line. */
10901 start_display (&it
, w
, start
);
10902 start_pos
= it
.current
.pos
;
10905 /* Find the first row that is not affected by changes at the end of
10906 the buffer. Value will be null if there is no unchanged row, in
10907 which case we must redisplay to the end of the window. delta
10908 will be set to the value by which buffer positions beginning with
10909 first_unchanged_at_end_row have to be adjusted due to text
10911 first_unchanged_at_end_row
10912 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
10913 IF_DEBUG (debug_delta
= delta
);
10914 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
10916 /* Set stop_pos to the buffer position up to which we will have to
10917 display new lines. If first_unchanged_at_end_row != NULL, this
10918 is the buffer position of the start of the line displayed in that
10919 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
10920 that we don't stop at a buffer position. */
10922 if (first_unchanged_at_end_row
)
10924 xassert (last_unchanged_at_beg_row
== NULL
10925 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
10927 /* If this is a continuation line, move forward to the next one
10928 that isn't. Changes in lines above affect this line.
10929 Caution: this may move first_unchanged_at_end_row to a row
10930 not displaying text. */
10931 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
10932 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
10933 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
10934 < it
.last_visible_y
))
10935 ++first_unchanged_at_end_row
;
10937 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
10938 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
10939 >= it
.last_visible_y
))
10940 first_unchanged_at_end_row
= NULL
;
10943 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
10945 first_unchanged_at_end_vpos
10946 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
10947 xassert (stop_pos
>= Z
- END_UNCHANGED
);
10950 else if (last_unchanged_at_beg_row
== NULL
)
10956 /* Either there is no unchanged row at the end, or the one we have
10957 now displays text. This is a necessary condition for the window
10958 end pos calculation at the end of this function. */
10959 xassert (first_unchanged_at_end_row
== NULL
10960 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
10962 debug_last_unchanged_at_beg_vpos
10963 = (last_unchanged_at_beg_row
10964 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
10966 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
10968 #endif /* GLYPH_DEBUG != 0 */
10971 /* Display new lines. Set last_text_row to the last new line
10972 displayed which has text on it, i.e. might end up as being the
10973 line where the window_end_vpos is. */
10974 w
->cursor
.vpos
= -1;
10975 last_text_row
= NULL
;
10976 overlay_arrow_seen
= 0;
10977 while (it
.current_y
< it
.last_visible_y
10978 && !fonts_changed_p
10979 && (first_unchanged_at_end_row
== NULL
10980 || IT_CHARPOS (it
) < stop_pos
))
10982 if (display_line (&it
))
10983 last_text_row
= it
.glyph_row
- 1;
10986 if (fonts_changed_p
)
10990 /* Compute differences in buffer positions, y-positions etc. for
10991 lines reused at the bottom of the window. Compute what we can
10993 if (first_unchanged_at_end_row
10994 /* No lines reused because we displayed everything up to the
10995 bottom of the window. */
10996 && it
.current_y
< it
.last_visible_y
)
10999 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
11001 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
11002 run
.current_y
= first_unchanged_at_end_row
->y
;
11003 run
.desired_y
= run
.current_y
+ dy
;
11004 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
11008 delta
= dvpos
= dy
= run
.current_y
= run
.desired_y
= run
.height
= 0;
11009 first_unchanged_at_end_row
= NULL
;
11011 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
11014 /* Find the cursor if not already found. We have to decide whether
11015 PT will appear on this window (it sometimes doesn't, but this is
11016 not a very frequent case.) This decision has to be made before
11017 the current matrix is altered. A value of cursor.vpos < 0 means
11018 that PT is either in one of the lines beginning at
11019 first_unchanged_at_end_row or below the window. Don't care for
11020 lines that might be displayed later at the window end; as
11021 mentioned, this is not a frequent case. */
11022 if (w
->cursor
.vpos
< 0)
11024 /* Cursor in unchanged rows at the top? */
11025 if (PT
< CHARPOS (start_pos
)
11026 && last_unchanged_at_beg_row
)
11028 row
= row_containing_pos (w
, PT
,
11029 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
11030 last_unchanged_at_beg_row
+ 1);
11032 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11035 /* Start from first_unchanged_at_end_row looking for PT. */
11036 else if (first_unchanged_at_end_row
)
11038 row
= row_containing_pos (w
, PT
- delta
,
11039 first_unchanged_at_end_row
, NULL
);
11041 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
11042 delta_bytes
, dy
, dvpos
);
11045 /* Give up if cursor was not found. */
11046 if (w
->cursor
.vpos
< 0)
11048 clear_glyph_matrix (w
->desired_matrix
);
11053 /* Don't let the cursor end in the scroll margins. */
11055 int this_scroll_margin
, cursor_height
;
11057 this_scroll_margin
= max (0, scroll_margin
);
11058 this_scroll_margin
= min (this_scroll_margin
,
11059 XFASTINT (w
->height
) / 4);
11060 this_scroll_margin
*= CANON_Y_UNIT (it
.f
);
11061 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
11063 if ((w
->cursor
.y
< this_scroll_margin
11064 && CHARPOS (start
) > BEGV
)
11065 /* Don't take scroll margin into account at the bottom because
11066 old redisplay didn't do it either. */
11067 || w
->cursor
.y
+ cursor_height
> it
.last_visible_y
)
11069 w
->cursor
.vpos
= -1;
11070 clear_glyph_matrix (w
->desired_matrix
);
11075 /* Scroll the display. Do it before changing the current matrix so
11076 that xterm.c doesn't get confused about where the cursor glyph is
11078 if (dy
&& run
.height
)
11082 if (FRAME_WINDOW_P (f
))
11084 rif
->update_window_begin_hook (w
);
11085 rif
->clear_mouse_face (w
);
11086 rif
->scroll_run_hook (w
, &run
);
11087 rif
->update_window_end_hook (w
, 0, 0);
11091 /* Terminal frame. In this case, dvpos gives the number of
11092 lines to scroll by; dvpos < 0 means scroll up. */
11093 int first_unchanged_at_end_vpos
11094 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
11095 int from
= XFASTINT (w
->top
) + first_unchanged_at_end_vpos
;
11096 int end
= XFASTINT (w
->top
) + window_internal_height (w
);
11098 /* Perform the operation on the screen. */
11101 /* Scroll last_unchanged_at_beg_row to the end of the
11102 window down dvpos lines. */
11103 set_terminal_window (end
);
11105 /* On dumb terminals delete dvpos lines at the end
11106 before inserting dvpos empty lines. */
11107 if (!scroll_region_ok
)
11108 ins_del_lines (end
- dvpos
, -dvpos
);
11110 /* Insert dvpos empty lines in front of
11111 last_unchanged_at_beg_row. */
11112 ins_del_lines (from
, dvpos
);
11114 else if (dvpos
< 0)
11116 /* Scroll up last_unchanged_at_beg_vpos to the end of
11117 the window to last_unchanged_at_beg_vpos - |dvpos|. */
11118 set_terminal_window (end
);
11120 /* Delete dvpos lines in front of
11121 last_unchanged_at_beg_vpos. ins_del_lines will set
11122 the cursor to the given vpos and emit |dvpos| delete
11124 ins_del_lines (from
+ dvpos
, dvpos
);
11126 /* On a dumb terminal insert dvpos empty lines at the
11128 if (!scroll_region_ok
)
11129 ins_del_lines (end
+ dvpos
, -dvpos
);
11132 set_terminal_window (0);
11138 /* Shift reused rows of the current matrix to the right position.
11139 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
11141 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
11142 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
11145 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
11146 bottom_vpos
, dvpos
);
11147 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
11150 else if (dvpos
> 0)
11152 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
11153 bottom_vpos
, dvpos
);
11154 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
11155 first_unchanged_at_end_vpos
+ dvpos
, 0);
11158 /* For frame-based redisplay, make sure that current frame and window
11159 matrix are in sync with respect to glyph memory. */
11160 if (!FRAME_WINDOW_P (f
))
11161 sync_frame_with_window_matrix_rows (w
);
11163 /* Adjust buffer positions in reused rows. */
11165 increment_matrix_positions (current_matrix
,
11166 first_unchanged_at_end_vpos
+ dvpos
,
11167 bottom_vpos
, delta
, delta_bytes
);
11169 /* Adjust Y positions. */
11171 shift_glyph_matrix (w
, current_matrix
,
11172 first_unchanged_at_end_vpos
+ dvpos
,
11175 if (first_unchanged_at_end_row
)
11176 first_unchanged_at_end_row
+= dvpos
;
11178 /* If scrolling up, there may be some lines to display at the end of
11180 last_text_row_at_end
= NULL
;
11183 /* Set last_row to the glyph row in the current matrix where the
11184 window end line is found. It has been moved up or down in
11185 the matrix by dvpos. */
11186 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
11187 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
11189 /* If last_row is the window end line, it should display text. */
11190 xassert (last_row
->displays_text_p
);
11192 /* If window end line was partially visible before, begin
11193 displaying at that line. Otherwise begin displaying with the
11194 line following it. */
11195 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
11197 init_to_row_start (&it
, w
, last_row
);
11198 it
.vpos
= last_vpos
;
11199 it
.current_y
= last_row
->y
;
11203 init_to_row_end (&it
, w
, last_row
);
11204 it
.vpos
= 1 + last_vpos
;
11205 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
11209 /* We may start in a continuation line. If so, we have to get
11210 the right continuation_lines_width and current_x. */
11211 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
11212 it
.hpos
= it
.current_x
= 0;
11214 /* Display the rest of the lines at the window end. */
11215 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
11216 while (it
.current_y
< it
.last_visible_y
11217 && !fonts_changed_p
)
11219 /* Is it always sure that the display agrees with lines in
11220 the current matrix? I don't think so, so we mark rows
11221 displayed invalid in the current matrix by setting their
11222 enabled_p flag to zero. */
11223 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
11224 if (display_line (&it
))
11225 last_text_row_at_end
= it
.glyph_row
- 1;
11229 /* Update window_end_pos and window_end_vpos. */
11230 if (first_unchanged_at_end_row
11231 && first_unchanged_at_end_row
->y
< it
.last_visible_y
11232 && !last_text_row_at_end
)
11234 /* Window end line if one of the preserved rows from the current
11235 matrix. Set row to the last row displaying text in current
11236 matrix starting at first_unchanged_at_end_row, after
11238 xassert (first_unchanged_at_end_row
->displays_text_p
);
11239 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
11240 first_unchanged_at_end_row
);
11241 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
11243 XSETFASTINT (w
->window_end_pos
, Z
- MATRIX_ROW_END_CHARPOS (row
));
11244 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
11245 XSETFASTINT (w
->window_end_vpos
,
11246 MATRIX_ROW_VPOS (row
, w
->current_matrix
));
11248 else if (last_text_row_at_end
)
11250 XSETFASTINT (w
->window_end_pos
,
11251 Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
11252 w
->window_end_bytepos
11253 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
11254 XSETFASTINT (w
->window_end_vpos
,
11255 MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
11257 else if (last_text_row
)
11259 /* We have displayed either to the end of the window or at the
11260 end of the window, i.e. the last row with text is to be found
11261 in the desired matrix. */
11262 XSETFASTINT (w
->window_end_pos
,
11263 Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
11264 w
->window_end_bytepos
11265 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
11266 XSETFASTINT (w
->window_end_vpos
,
11267 MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
11269 else if (first_unchanged_at_end_row
== NULL
11270 && last_text_row
== NULL
11271 && last_text_row_at_end
== NULL
)
11273 /* Displayed to end of window, but no line containing text was
11274 displayed. Lines were deleted at the end of the window. */
11276 int header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
11278 for (vpos
= XFASTINT (w
->window_end_vpos
); vpos
> 0; --vpos
)
11279 if ((w
->desired_matrix
->rows
[vpos
+ header_line_p
].enabled_p
11280 && w
->desired_matrix
->rows
[vpos
+ header_line_p
].displays_text_p
)
11281 || (!w
->desired_matrix
->rows
[vpos
+ header_line_p
].enabled_p
11282 && w
->current_matrix
->rows
[vpos
+ header_line_p
].displays_text_p
))
11285 w
->window_end_vpos
= make_number (vpos
);
11290 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
11291 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
11293 /* Record that display has not been completed. */
11294 w
->window_end_valid
= Qnil
;
11295 w
->desired_matrix
->no_scrolling_p
= 1;
11301 /***********************************************************************
11302 More debugging support
11303 ***********************************************************************/
11307 void dump_glyph_row
P_ ((struct glyph_matrix
*, int, int));
11308 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
11311 /* Dump the contents of glyph matrix MATRIX on stderr.
11313 GLYPHS 0 means don't show glyph contents.
11314 GLYPHS 1 means show glyphs in short form
11315 GLYPHS > 1 means show glyphs in long form. */
11318 dump_glyph_matrix (matrix
, glyphs
)
11319 struct glyph_matrix
*matrix
;
11323 for (i
= 0; i
< matrix
->nrows
; ++i
)
11324 dump_glyph_row (matrix
, i
, glyphs
);
11328 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
11329 GLYPHS 0 means don't show glyph contents.
11330 GLYPHS 1 means show glyphs in short form
11331 GLYPHS > 1 means show glyphs in long form. */
11334 dump_glyph_row (matrix
, vpos
, glyphs
)
11335 struct glyph_matrix
*matrix
;
11338 struct glyph_row
*row
;
11340 if (vpos
< 0 || vpos
>= matrix
->nrows
)
11343 row
= MATRIX_ROW (matrix
, vpos
);
11347 fprintf (stderr
, "Row Start End Used oEI><O\\CTZFes X Y W H V A P\n");
11348 fprintf (stderr
, "=======================================================================\n");
11350 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d\
11351 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
11352 row
- matrix
->rows
,
11353 MATRIX_ROW_START_CHARPOS (row
),
11354 MATRIX_ROW_END_CHARPOS (row
),
11355 row
->used
[TEXT_AREA
],
11356 row
->contains_overlapping_glyphs_p
,
11359 row
->truncated_on_left_p
,
11360 row
->truncated_on_right_p
,
11361 row
->overlay_arrow_p
,
11363 MATRIX_ROW_CONTINUATION_LINE_P (row
),
11364 row
->displays_text_p
,
11367 row
->ends_in_middle_of_char_p
,
11368 row
->starts_in_middle_of_char_p
,
11373 row
->visible_height
,
11376 fprintf (stderr
, "%9d %5d\n", row
->start
.overlay_string_index
,
11377 row
->end
.overlay_string_index
);
11378 fprintf (stderr
, "%9d %5d\n",
11379 CHARPOS (row
->start
.string_pos
),
11380 CHARPOS (row
->end
.string_pos
));
11381 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
11382 row
->end
.dpvec_index
);
11387 struct glyph
*glyph
, *glyph_end
;
11388 int prev_had_glyphs_p
;
11390 glyph
= row
->glyphs
[TEXT_AREA
];
11391 glyph_end
= glyph
+ row
->used
[TEXT_AREA
];
11393 /* Glyph for a line end in text. */
11394 if (glyph
== glyph_end
&& glyph
->charpos
> 0)
11397 if (glyph
< glyph_end
)
11399 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
11400 prev_had_glyphs_p
= 1;
11403 prev_had_glyphs_p
= 0;
11405 while (glyph
< glyph_end
)
11407 if (glyph
->type
== CHAR_GLYPH
)
11410 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
11411 glyph
- row
->glyphs
[TEXT_AREA
],
11414 (BUFFERP (glyph
->object
)
11416 : (STRINGP (glyph
->object
)
11419 glyph
->pixel_width
,
11421 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
11425 glyph
->left_box_line_p
,
11426 glyph
->right_box_line_p
);
11428 else if (glyph
->type
== STRETCH_GLYPH
)
11431 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
11432 glyph
- row
->glyphs
[TEXT_AREA
],
11435 (BUFFERP (glyph
->object
)
11437 : (STRINGP (glyph
->object
)
11440 glyph
->pixel_width
,
11444 glyph
->left_box_line_p
,
11445 glyph
->right_box_line_p
);
11447 else if (glyph
->type
== IMAGE_GLYPH
)
11450 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
11451 glyph
- row
->glyphs
[TEXT_AREA
],
11454 (BUFFERP (glyph
->object
)
11456 : (STRINGP (glyph
->object
)
11459 glyph
->pixel_width
,
11463 glyph
->left_box_line_p
,
11464 glyph
->right_box_line_p
);
11469 else if (glyphs
== 1)
11471 char *s
= (char *) alloca (row
->used
[TEXT_AREA
] + 1);
11474 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
11476 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + i
;
11477 if (glyph
->type
== CHAR_GLYPH
11478 && glyph
->u
.ch
< 0x80
11479 && glyph
->u
.ch
>= ' ')
11480 s
[i
] = glyph
->u
.ch
;
11486 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
11491 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
11492 Sdump_glyph_matrix
, 0, 1, "p",
11493 "Dump the current matrix of the selected window to stderr.\n\
11494 Shows contents of glyph row structures. With non-nil\n\
11495 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show\n\
11496 glyphs in short form, otherwise show glyphs in long form.")
11498 Lisp_Object glyphs
;
11500 struct window
*w
= XWINDOW (selected_window
);
11501 struct buffer
*buffer
= XBUFFER (w
->buffer
);
11503 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
11504 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
11505 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
11506 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
11507 fprintf (stderr
, "=============================================\n");
11508 dump_glyph_matrix (w
->current_matrix
,
11509 NILP (glyphs
) ? 0 : XINT (glyphs
));
11514 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
11515 "Dump glyph row ROW to stderr.\n\
11516 GLYPH 0 means don't dump glyphs.\n\
11517 GLYPH 1 means dump glyphs in short form.\n\
11518 GLYPH > 1 or omitted means dump glyphs in long form.")
11520 Lisp_Object row
, glyphs
;
11522 CHECK_NUMBER (row
, 0);
11523 dump_glyph_row (XWINDOW (selected_window
)->current_matrix
,
11525 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
11530 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
,
11534 struct frame
*sf
= SELECTED_FRAME ();
11535 struct glyph_matrix
*m
= (XWINDOW (sf
->tool_bar_window
)
11537 dump_glyph_row (m
, 0, 1);
11542 DEFUN ("trace-redisplay-toggle", Ftrace_redisplay_toggle
,
11543 Strace_redisplay_toggle
, 0, 0, "",
11544 "Toggle tracing of redisplay.")
11547 trace_redisplay_p
= !trace_redisplay_p
;
11552 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, 1, "",
11553 "Print STRING to stderr.")
11555 Lisp_Object string
;
11557 CHECK_STRING (string
, 0);
11558 fprintf (stderr
, "%s", XSTRING (string
)->data
);
11562 #endif /* GLYPH_DEBUG */
11566 /***********************************************************************
11567 Building Desired Matrix Rows
11568 ***********************************************************************/
11570 /* Return a temporary glyph row holding the glyphs of an overlay
11571 arrow. Only used for non-window-redisplay windows. */
11573 static struct glyph_row
*
11574 get_overlay_arrow_glyph_row (w
)
11577 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
11578 struct buffer
*buffer
= XBUFFER (w
->buffer
);
11579 struct buffer
*old
= current_buffer
;
11580 unsigned char *arrow_string
= XSTRING (Voverlay_arrow_string
)->data
;
11581 int arrow_len
= XSTRING (Voverlay_arrow_string
)->size
;
11582 unsigned char *arrow_end
= arrow_string
+ arrow_len
;
11586 int n_glyphs_before
;
11588 set_buffer_temp (buffer
);
11589 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
11590 it
.glyph_row
->used
[TEXT_AREA
] = 0;
11591 SET_TEXT_POS (it
.position
, 0, 0);
11593 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
11595 while (p
< arrow_end
)
11597 Lisp_Object face
, ilisp
;
11599 /* Get the next character. */
11601 it
.c
= string_char_and_length (p
, arrow_len
, &it
.len
);
11603 it
.c
= *p
, it
.len
= 1;
11606 /* Get its face. */
11607 XSETFASTINT (ilisp
, p
- arrow_string
);
11608 face
= Fget_text_property (ilisp
, Qface
, Voverlay_arrow_string
);
11609 it
.face_id
= compute_char_face (f
, it
.c
, face
);
11611 /* Compute its width, get its glyphs. */
11612 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
11613 SET_TEXT_POS (it
.position
, -1, -1);
11614 PRODUCE_GLYPHS (&it
);
11616 /* If this character doesn't fit any more in the line, we have
11617 to remove some glyphs. */
11618 if (it
.current_x
> it
.last_visible_x
)
11620 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
11625 set_buffer_temp (old
);
11626 return it
.glyph_row
;
11630 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
11631 glyphs are only inserted for terminal frames since we can't really
11632 win with truncation glyphs when partially visible glyphs are
11633 involved. Which glyphs to insert is determined by
11634 produce_special_glyphs. */
11637 insert_left_trunc_glyphs (it
)
11640 struct it truncate_it
;
11641 struct glyph
*from
, *end
, *to
, *toend
;
11643 xassert (!FRAME_WINDOW_P (it
->f
));
11645 /* Get the truncation glyphs. */
11647 truncate_it
.current_x
= 0;
11648 truncate_it
.face_id
= DEFAULT_FACE_ID
;
11649 truncate_it
.glyph_row
= &scratch_glyph_row
;
11650 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
11651 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
11652 truncate_it
.object
= make_number (0);
11653 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
11655 /* Overwrite glyphs from IT with truncation glyphs. */
11656 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
11657 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
11658 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
11659 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
11664 /* There may be padding glyphs left over. Remove them. */
11666 while (from
< toend
&& CHAR_GLYPH_PADDING_P (*from
))
11668 while (from
< toend
)
11671 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
11675 /* Compute the pixel height and width of IT->glyph_row.
11677 Most of the time, ascent and height of a display line will be equal
11678 to the max_ascent and max_height values of the display iterator
11679 structure. This is not the case if
11681 1. We hit ZV without displaying anything. In this case, max_ascent
11682 and max_height will be zero.
11684 2. We have some glyphs that don't contribute to the line height.
11685 (The glyph row flag contributes_to_line_height_p is for future
11686 pixmap extensions).
11688 The first case is easily covered by using default values because in
11689 these cases, the line height does not really matter, except that it
11690 must not be zero. */
11693 compute_line_metrics (it
)
11696 struct glyph_row
*row
= it
->glyph_row
;
11699 if (FRAME_WINDOW_P (it
->f
))
11701 int i
, header_line_height
;
11703 /* The line may consist of one space only, that was added to
11704 place the cursor on it. If so, the row's height hasn't been
11706 if (row
->height
== 0)
11708 if (it
->max_ascent
+ it
->max_descent
== 0)
11709 it
->max_descent
= it
->max_phys_descent
= CANON_Y_UNIT (it
->f
);
11710 row
->ascent
= it
->max_ascent
;
11711 row
->height
= it
->max_ascent
+ it
->max_descent
;
11712 row
->phys_ascent
= it
->max_phys_ascent
;
11713 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
11716 /* Compute the width of this line. */
11717 row
->pixel_width
= row
->x
;
11718 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
11719 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
11721 xassert (row
->pixel_width
>= 0);
11722 xassert (row
->ascent
>= 0 && row
->height
> 0);
11724 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
11725 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
11727 /* If first line's physical ascent is larger than its logical
11728 ascent, use the physical ascent, and make the row taller.
11729 This makes accented characters fully visible. */
11730 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
11731 && row
->phys_ascent
> row
->ascent
)
11733 row
->height
+= row
->phys_ascent
- row
->ascent
;
11734 row
->ascent
= row
->phys_ascent
;
11737 /* Compute how much of the line is visible. */
11738 row
->visible_height
= row
->height
;
11740 header_line_height
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (it
->w
);
11741 if (row
->y
< header_line_height
)
11742 row
->visible_height
-= header_line_height
- row
->y
;
11745 int max_y
= WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE (it
->w
);
11746 if (row
->y
+ row
->height
> max_y
)
11747 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
11752 row
->pixel_width
= row
->used
[TEXT_AREA
];
11753 row
->ascent
= row
->phys_ascent
= 0;
11754 row
->height
= row
->phys_height
= row
->visible_height
= 1;
11757 /* Compute a hash code for this row. */
11759 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
11760 for (i
= 0; i
< row
->used
[area
]; ++i
)
11761 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
11762 + row
->glyphs
[area
][i
].u
.val
11763 + row
->glyphs
[area
][i
].face_id
11764 + row
->glyphs
[area
][i
].padding_p
11765 + (row
->glyphs
[area
][i
].type
<< 2));
11767 it
->max_ascent
= it
->max_descent
= 0;
11768 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
11772 /* Append one space to the glyph row of iterator IT if doing a
11773 window-based redisplay. DEFAULT_FACE_P non-zero means let the
11774 space have the default face, otherwise let it have the same face as
11775 IT->face_id. Value is non-zero if a space was added.
11777 This function is called to make sure that there is always one glyph
11778 at the end of a glyph row that the cursor can be set on under
11779 window-systems. (If there weren't such a glyph we would not know
11780 how wide and tall a box cursor should be displayed).
11782 At the same time this space let's a nicely handle clearing to the
11783 end of the line if the row ends in italic text. */
11786 append_space (it
, default_face_p
)
11788 int default_face_p
;
11790 if (FRAME_WINDOW_P (it
->f
))
11792 int n
= it
->glyph_row
->used
[TEXT_AREA
];
11794 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
11795 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
11797 /* Save some values that must not be changed.
11798 Must save IT->c and IT->len because otherwise
11799 ITERATOR_AT_END_P wouldn't work anymore after
11800 append_space has been called. */
11801 enum display_element_type saved_what
= it
->what
;
11802 int saved_c
= it
->c
, saved_len
= it
->len
;
11803 int saved_x
= it
->current_x
;
11804 int saved_face_id
= it
->face_id
;
11805 struct text_pos saved_pos
;
11806 Lisp_Object saved_object
;
11809 saved_object
= it
->object
;
11810 saved_pos
= it
->position
;
11812 it
->what
= IT_CHARACTER
;
11813 bzero (&it
->position
, sizeof it
->position
);
11814 it
->object
= make_number (0);
11818 if (default_face_p
)
11819 it
->face_id
= DEFAULT_FACE_ID
;
11820 else if (it
->face_before_selective_p
)
11821 it
->face_id
= it
->saved_face_id
;
11822 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
11823 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0);
11825 PRODUCE_GLYPHS (it
);
11827 it
->current_x
= saved_x
;
11828 it
->object
= saved_object
;
11829 it
->position
= saved_pos
;
11830 it
->what
= saved_what
;
11831 it
->face_id
= saved_face_id
;
11832 it
->len
= saved_len
;
11842 /* Extend the face of the last glyph in the text area of IT->glyph_row
11843 to the end of the display line. Called from display_line.
11844 If the glyph row is empty, add a space glyph to it so that we
11845 know the face to draw. Set the glyph row flag fill_line_p. */
11848 extend_face_to_end_of_line (it
)
11852 struct frame
*f
= it
->f
;
11854 /* If line is already filled, do nothing. */
11855 if (it
->current_x
>= it
->last_visible_x
)
11858 /* Face extension extends the background and box of IT->face_id
11859 to the end of the line. If the background equals the background
11860 of the frame, we don't have to do anything. */
11861 if (it
->face_before_selective_p
)
11862 face
= FACE_FROM_ID (it
->f
, it
->saved_face_id
);
11864 face
= FACE_FROM_ID (f
, it
->face_id
);
11866 if (FRAME_WINDOW_P (f
)
11867 && face
->box
== FACE_NO_BOX
11868 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
11872 /* Set the glyph row flag indicating that the face of the last glyph
11873 in the text area has to be drawn to the end of the text area. */
11874 it
->glyph_row
->fill_line_p
= 1;
11876 /* If current character of IT is not ASCII, make sure we have the
11877 ASCII face. This will be automatically undone the next time
11878 get_next_display_element returns a multibyte character. Note
11879 that the character will always be single byte in unibyte text. */
11880 if (!SINGLE_BYTE_CHAR_P (it
->c
))
11882 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0);
11885 if (FRAME_WINDOW_P (f
))
11887 /* If the row is empty, add a space with the current face of IT,
11888 so that we know which face to draw. */
11889 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
11891 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
11892 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
11893 it
->glyph_row
->used
[TEXT_AREA
] = 1;
11898 /* Save some values that must not be changed. */
11899 int saved_x
= it
->current_x
;
11900 struct text_pos saved_pos
;
11901 Lisp_Object saved_object
;
11902 enum display_element_type saved_what
= it
->what
;
11903 int saved_face_id
= it
->face_id
;
11905 saved_object
= it
->object
;
11906 saved_pos
= it
->position
;
11908 it
->what
= IT_CHARACTER
;
11909 bzero (&it
->position
, sizeof it
->position
);
11910 it
->object
= make_number (0);
11913 it
->face_id
= face
->id
;
11915 PRODUCE_GLYPHS (it
);
11917 while (it
->current_x
<= it
->last_visible_x
)
11918 PRODUCE_GLYPHS (it
);
11920 /* Don't count these blanks really. It would let us insert a left
11921 truncation glyph below and make us set the cursor on them, maybe. */
11922 it
->current_x
= saved_x
;
11923 it
->object
= saved_object
;
11924 it
->position
= saved_pos
;
11925 it
->what
= saved_what
;
11926 it
->face_id
= saved_face_id
;
11931 /* Value is non-zero if text starting at CHARPOS in current_buffer is
11932 trailing whitespace. */
11935 trailing_whitespace_p (charpos
)
11938 int bytepos
= CHAR_TO_BYTE (charpos
);
11941 while (bytepos
< ZV_BYTE
11942 && (c
= FETCH_CHAR (bytepos
),
11943 c
== ' ' || c
== '\t'))
11946 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
11948 if (bytepos
!= PT_BYTE
)
11955 /* Highlight trailing whitespace, if any, in ROW. */
11958 highlight_trailing_whitespace (f
, row
)
11960 struct glyph_row
*row
;
11962 int used
= row
->used
[TEXT_AREA
];
11966 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
11967 struct glyph
*glyph
= start
+ used
- 1;
11969 /* Skip over the space glyph inserted to display the
11970 cursor at the end of a line. */
11971 if (glyph
->type
== CHAR_GLYPH
11972 && glyph
->u
.ch
== ' '
11973 && INTEGERP (glyph
->object
))
11976 /* If last glyph is a space or stretch, and it's trailing
11977 whitespace, set the face of all trailing whitespace glyphs in
11978 IT->glyph_row to `trailing-whitespace'. */
11980 && BUFFERP (glyph
->object
)
11981 && (glyph
->type
== STRETCH_GLYPH
11982 || (glyph
->type
== CHAR_GLYPH
11983 && glyph
->u
.ch
== ' '))
11984 && trailing_whitespace_p (glyph
->charpos
))
11986 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
11988 while (glyph
>= start
11989 && BUFFERP (glyph
->object
)
11990 && (glyph
->type
== STRETCH_GLYPH
11991 || (glyph
->type
== CHAR_GLYPH
11992 && glyph
->u
.ch
== ' ')))
11993 (glyph
--)->face_id
= face_id
;
11999 /* Value is non-zero if glyph row ROW in window W should be
12000 used to hold the cursor. */
12003 cursor_row_p (w
, row
)
12005 struct glyph_row
*row
;
12007 int cursor_row_p
= 1;
12009 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
12011 /* If the row ends with a newline from a string, we don't want
12012 the cursor there (if the row is continued it doesn't end in a
12014 if (CHARPOS (row
->end
.string_pos
) >= 0
12015 || MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
12016 cursor_row_p
= row
->continued_p
;
12018 /* If the row ends at ZV, display the cursor at the end of that
12019 row instead of at the start of the row below. */
12020 else if (row
->ends_at_zv_p
)
12026 return cursor_row_p
;
12030 /* Construct the glyph row IT->glyph_row in the desired matrix of
12031 IT->w from text at the current position of IT. See dispextern.h
12032 for an overview of struct it. Value is non-zero if
12033 IT->glyph_row displays text, as opposed to a line displaying ZV
12040 struct glyph_row
*row
= it
->glyph_row
;
12042 /* We always start displaying at hpos zero even if hscrolled. */
12043 xassert (it
->hpos
== 0 && it
->current_x
== 0);
12045 /* We must not display in a row that's not a text row. */
12046 xassert (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
12047 < it
->w
->desired_matrix
->nrows
);
12049 /* Is IT->w showing the region? */
12050 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
12052 /* Clear the result glyph row and enable it. */
12053 prepare_desired_row (row
);
12055 row
->y
= it
->current_y
;
12056 row
->start
= it
->current
;
12057 row
->continuation_lines_width
= it
->continuation_lines_width
;
12058 row
->displays_text_p
= 1;
12059 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
12060 it
->starts_in_middle_of_char_p
= 0;
12062 /* Arrange the overlays nicely for our purposes. Usually, we call
12063 display_line on only one line at a time, in which case this
12064 can't really hurt too much, or we call it on lines which appear
12065 one after another in the buffer, in which case all calls to
12066 recenter_overlay_lists but the first will be pretty cheap. */
12067 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
12069 /* Move over display elements that are not visible because we are
12070 hscrolled. This may stop at an x-position < IT->first_visible_x
12071 if the first glyph is partially visible or if we hit a line end. */
12072 if (it
->current_x
< it
->first_visible_x
)
12073 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
12074 MOVE_TO_POS
| MOVE_TO_X
);
12076 /* Get the initial row height. This is either the height of the
12077 text hscrolled, if there is any, or zero. */
12078 row
->ascent
= it
->max_ascent
;
12079 row
->height
= it
->max_ascent
+ it
->max_descent
;
12080 row
->phys_ascent
= it
->max_phys_ascent
;
12081 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
12083 /* Loop generating characters. The loop is left with IT on the next
12084 character to display. */
12087 int n_glyphs_before
, hpos_before
, x_before
;
12089 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
12091 /* Retrieve the next thing to display. Value is zero if end of
12093 if (!get_next_display_element (it
))
12095 /* Maybe add a space at the end of this line that is used to
12096 display the cursor there under X. Set the charpos of the
12097 first glyph of blank lines not corresponding to any text
12099 if ((append_space (it
, 1) && row
->used
[TEXT_AREA
] == 1)
12100 || row
->used
[TEXT_AREA
] == 0)
12102 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
12103 row
->displays_text_p
= 0;
12105 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
))
12106 row
->indicate_empty_line_p
= 1;
12109 it
->continuation_lines_width
= 0;
12110 row
->ends_at_zv_p
= 1;
12114 /* Now, get the metrics of what we want to display. This also
12115 generates glyphs in `row' (which is IT->glyph_row). */
12116 n_glyphs_before
= row
->used
[TEXT_AREA
];
12119 /* Remember the line height so far in case the next element doesn't
12120 fit on the line. */
12121 if (!it
->truncate_lines_p
)
12123 ascent
= it
->max_ascent
;
12124 descent
= it
->max_descent
;
12125 phys_ascent
= it
->max_phys_ascent
;
12126 phys_descent
= it
->max_phys_descent
;
12129 PRODUCE_GLYPHS (it
);
12131 /* If this display element was in marginal areas, continue with
12133 if (it
->area
!= TEXT_AREA
)
12135 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
12136 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
12137 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
12138 row
->phys_height
= max (row
->phys_height
,
12139 it
->max_phys_ascent
+ it
->max_phys_descent
);
12140 set_iterator_to_next (it
, 1);
12144 /* Does the display element fit on the line? If we truncate
12145 lines, we should draw past the right edge of the window. If
12146 we don't truncate, we want to stop so that we can display the
12147 continuation glyph before the right margin. If lines are
12148 continued, there are two possible strategies for characters
12149 resulting in more than 1 glyph (e.g. tabs): Display as many
12150 glyphs as possible in this line and leave the rest for the
12151 continuation line, or display the whole element in the next
12152 line. Original redisplay did the former, so we do it also. */
12153 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12154 hpos_before
= it
->hpos
;
12158 && it
->current_x
< it
->last_visible_x
)
12161 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
12162 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
12163 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
12164 row
->phys_height
= max (row
->phys_height
,
12165 it
->max_phys_ascent
+ it
->max_phys_descent
);
12166 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
12167 row
->x
= x
- it
->first_visible_x
;
12172 struct glyph
*glyph
;
12174 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
12176 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12177 new_x
= x
+ glyph
->pixel_width
;
12179 if (/* Lines are continued. */
12180 !it
->truncate_lines_p
12181 && (/* Glyph doesn't fit on the line. */
12182 new_x
> it
->last_visible_x
12183 /* Or it fits exactly on a window system frame. */
12184 || (new_x
== it
->last_visible_x
12185 && FRAME_WINDOW_P (it
->f
))))
12187 /* End of a continued line. */
12190 || (new_x
== it
->last_visible_x
12191 && FRAME_WINDOW_P (it
->f
)))
12193 /* Current glyph is the only one on the line or
12194 fits exactly on the line. We must continue
12195 the line because we can't draw the cursor
12196 after the glyph. */
12197 row
->continued_p
= 1;
12198 it
->current_x
= new_x
;
12199 it
->continuation_lines_width
+= new_x
;
12201 if (i
== nglyphs
- 1)
12202 set_iterator_to_next (it
, 1);
12204 else if (CHAR_GLYPH_PADDING_P (*glyph
)
12205 && !FRAME_WINDOW_P (it
->f
))
12207 /* A padding glyph that doesn't fit on this line.
12208 This means the whole character doesn't fit
12210 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12212 /* Fill the rest of the row with continuation
12213 glyphs like in 20.x. */
12214 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
12215 < row
->glyphs
[1 + TEXT_AREA
])
12216 produce_special_glyphs (it
, IT_CONTINUATION
);
12218 row
->continued_p
= 1;
12219 it
->current_x
= x_before
;
12220 it
->continuation_lines_width
+= x_before
;
12222 /* Restore the height to what it was before the
12223 element not fitting on the line. */
12224 it
->max_ascent
= ascent
;
12225 it
->max_descent
= descent
;
12226 it
->max_phys_ascent
= phys_ascent
;
12227 it
->max_phys_descent
= phys_descent
;
12231 /* Display element draws past the right edge of
12232 the window. Restore positions to values
12233 before the element. The next line starts
12234 with current_x before the glyph that could
12235 not be displayed, so that TAB works right. */
12236 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
12238 /* Display continuation glyphs. */
12239 if (!FRAME_WINDOW_P (it
->f
))
12240 produce_special_glyphs (it
, IT_CONTINUATION
);
12241 row
->continued_p
= 1;
12244 it
->continuation_lines_width
+= x
;
12245 if (nglyphs
> 1 && i
> 0)
12247 row
->ends_in_middle_of_char_p
= 1;
12248 it
->starts_in_middle_of_char_p
= 1;
12251 /* Restore the height to what it was before the
12252 element not fitting on the line. */
12253 it
->max_ascent
= ascent
;
12254 it
->max_descent
= descent
;
12255 it
->max_phys_ascent
= phys_ascent
;
12256 it
->max_phys_descent
= phys_descent
;
12261 else if (new_x
> it
->first_visible_x
)
12263 /* Increment number of glyphs actually displayed. */
12266 if (x
< it
->first_visible_x
)
12267 /* Glyph is partially visible, i.e. row starts at
12268 negative X position. */
12269 row
->x
= x
- it
->first_visible_x
;
12273 /* Glyph is completely off the left margin of the
12274 window. This should not happen because of the
12275 move_it_in_display_line at the start of
12281 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
12282 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
12283 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
12284 row
->phys_height
= max (row
->phys_height
,
12285 it
->max_phys_ascent
+ it
->max_phys_descent
);
12287 /* End of this display line if row is continued. */
12288 if (row
->continued_p
)
12292 /* Is this a line end? If yes, we're also done, after making
12293 sure that a non-default face is extended up to the right
12294 margin of the window. */
12295 if (ITERATOR_AT_END_OF_LINE_P (it
))
12297 int used_before
= row
->used
[TEXT_AREA
];
12299 /* Add a space at the end of the line that is used to
12300 display the cursor there. */
12301 append_space (it
, 0);
12303 /* Extend the face to the end of the line. */
12304 extend_face_to_end_of_line (it
);
12306 /* Make sure we have the position. */
12307 if (used_before
== 0)
12308 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
12310 /* Consume the line end. This skips over invisible lines. */
12311 set_iterator_to_next (it
, 1);
12312 it
->continuation_lines_width
= 0;
12316 /* Proceed with next display element. Note that this skips
12317 over lines invisible because of selective display. */
12318 set_iterator_to_next (it
, 1);
12320 /* If we truncate lines, we are done when the last displayed
12321 glyphs reach past the right margin of the window. */
12322 if (it
->truncate_lines_p
12323 && (FRAME_WINDOW_P (it
->f
)
12324 ? (it
->current_x
>= it
->last_visible_x
)
12325 : (it
->current_x
> it
->last_visible_x
)))
12327 /* Maybe add truncation glyphs. */
12328 if (!FRAME_WINDOW_P (it
->f
))
12332 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
12333 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
12336 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
12338 row
->used
[TEXT_AREA
] = i
;
12339 produce_special_glyphs (it
, IT_TRUNCATION
);
12343 row
->truncated_on_right_p
= 1;
12344 it
->continuation_lines_width
= 0;
12345 reseat_at_next_visible_line_start (it
, 0);
12346 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
12347 it
->hpos
= hpos_before
;
12348 it
->current_x
= x_before
;
12353 /* If line is not empty and hscrolled, maybe insert truncation glyphs
12354 at the left window margin. */
12355 if (it
->first_visible_x
12356 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
12358 if (!FRAME_WINDOW_P (it
->f
))
12359 insert_left_trunc_glyphs (it
);
12360 row
->truncated_on_left_p
= 1;
12363 /* If the start of this line is the overlay arrow-position, then
12364 mark this glyph row as the one containing the overlay arrow.
12365 This is clearly a mess with variable size fonts. It would be
12366 better to let it be displayed like cursors under X. */
12367 if (MARKERP (Voverlay_arrow_position
)
12368 && current_buffer
== XMARKER (Voverlay_arrow_position
)->buffer
12369 && (MATRIX_ROW_START_CHARPOS (row
)
12370 == marker_position (Voverlay_arrow_position
))
12371 && STRINGP (Voverlay_arrow_string
)
12372 && ! overlay_arrow_seen
)
12374 /* Overlay arrow in window redisplay is a bitmap. */
12375 if (!FRAME_WINDOW_P (it
->f
))
12377 struct glyph_row
*arrow_row
= get_overlay_arrow_glyph_row (it
->w
);
12378 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
12379 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
12380 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
12381 struct glyph
*p2
, *end
;
12383 /* Copy the arrow glyphs. */
12384 while (glyph
< arrow_end
)
12387 /* Throw away padding glyphs. */
12389 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
12390 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
12396 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
12400 overlay_arrow_seen
= 1;
12401 row
->overlay_arrow_p
= 1;
12404 /* Compute pixel dimensions of this line. */
12405 compute_line_metrics (it
);
12407 /* Remember the position at which this line ends. */
12408 row
->end
= it
->current
;
12410 /* Maybe set the cursor. */
12411 if (it
->w
->cursor
.vpos
< 0
12412 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
12413 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
12414 && cursor_row_p (it
->w
, row
))
12415 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
12417 /* Highlight trailing whitespace. */
12418 if (!NILP (Vshow_trailing_whitespace
))
12419 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
12421 /* Prepare for the next line. This line starts horizontally at (X
12422 HPOS) = (0 0). Vertical positions are incremented. As a
12423 convenience for the caller, IT->glyph_row is set to the next
12425 it
->current_x
= it
->hpos
= 0;
12426 it
->current_y
+= row
->height
;
12429 return row
->displays_text_p
;
12434 /***********************************************************************
12436 ***********************************************************************/
12438 /* Redisplay the menu bar in the frame for window W.
12440 The menu bar of X frames that don't have X toolkit support is
12441 displayed in a special window W->frame->menu_bar_window.
12443 The menu bar of terminal frames is treated specially as far as
12444 glyph matrices are concerned. Menu bar lines are not part of
12445 windows, so the update is done directly on the frame matrix rows
12446 for the menu bar. */
12449 display_menu_bar (w
)
12452 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
12457 /* Don't do all this for graphical frames. */
12459 if (!NILP (Vwindow_system
))
12462 #ifdef USE_X_TOOLKIT
12467 if (FRAME_MAC_P (f
))
12471 #ifdef USE_X_TOOLKIT
12472 xassert (!FRAME_WINDOW_P (f
));
12473 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
12474 it
.first_visible_x
= 0;
12475 it
.last_visible_x
= FRAME_WINDOW_WIDTH (f
) * CANON_X_UNIT (f
);
12476 #else /* not USE_X_TOOLKIT */
12477 if (FRAME_WINDOW_P (f
))
12479 /* Menu bar lines are displayed in the desired matrix of the
12480 dummy window menu_bar_window. */
12481 struct window
*menu_w
;
12482 xassert (WINDOWP (f
->menu_bar_window
));
12483 menu_w
= XWINDOW (f
->menu_bar_window
);
12484 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
12486 it
.first_visible_x
= 0;
12487 it
.last_visible_x
= FRAME_WINDOW_WIDTH (f
) * CANON_X_UNIT (f
);
12491 /* This is a TTY frame, i.e. character hpos/vpos are used as
12493 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
12495 it
.first_visible_x
= 0;
12496 it
.last_visible_x
= FRAME_WIDTH (f
);
12498 #endif /* not USE_X_TOOLKIT */
12500 if (! mode_line_inverse_video
)
12501 /* Force the menu-bar to be displayed in the default face. */
12502 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
12504 /* Clear all rows of the menu bar. */
12505 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
12507 struct glyph_row
*row
= it
.glyph_row
+ i
;
12508 clear_glyph_row (row
);
12509 row
->enabled_p
= 1;
12510 row
->full_width_p
= 1;
12513 /* Display all items of the menu bar. */
12514 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
12515 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
12517 Lisp_Object string
;
12519 /* Stop at nil string. */
12520 string
= XVECTOR (items
)->contents
[i
+ 1];
12524 /* Remember where item was displayed. */
12525 XSETFASTINT (XVECTOR (items
)->contents
[i
+ 3], it
.hpos
);
12527 /* Display the item, pad with one space. */
12528 if (it
.current_x
< it
.last_visible_x
)
12529 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
12530 XSTRING (string
)->size
+ 1, 0, 0, -1);
12533 /* Fill out the line with spaces. */
12534 if (it
.current_x
< it
.last_visible_x
)
12535 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
12537 /* Compute the total height of the lines. */
12538 compute_line_metrics (&it
);
12543 /***********************************************************************
12545 ***********************************************************************/
12547 /* Redisplay mode lines in the window tree whose root is WINDOW. If
12548 FORCE is non-zero, redisplay mode lines unconditionally.
12549 Otherwise, redisplay only mode lines that are garbaged. Value is
12550 the number of windows whose mode lines were redisplayed. */
12553 redisplay_mode_lines (window
, force
)
12554 Lisp_Object window
;
12559 while (!NILP (window
))
12561 struct window
*w
= XWINDOW (window
);
12563 if (WINDOWP (w
->hchild
))
12564 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
12565 else if (WINDOWP (w
->vchild
))
12566 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
12568 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
12569 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
12571 Lisp_Object old_selected_frame
;
12572 struct text_pos lpoint
;
12573 struct buffer
*old
= current_buffer
;
12575 /* Set the window's buffer for the mode line display. */
12576 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
12577 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12579 /* Point refers normally to the selected window. For any
12580 other window, set up appropriate value. */
12581 if (!EQ (window
, selected_window
))
12583 struct text_pos pt
;
12585 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
12586 if (CHARPOS (pt
) < BEGV
)
12587 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
12588 else if (CHARPOS (pt
) > (ZV
- 1))
12589 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
12591 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
12594 /* Temporarily set up the selected frame. */
12595 old_selected_frame
= selected_frame
;
12596 selected_frame
= w
->frame
;
12598 /* Display mode lines. */
12599 clear_glyph_matrix (w
->desired_matrix
);
12600 if (display_mode_lines (w
))
12603 w
->must_be_updated_p
= 1;
12606 /* Restore old settings. */
12607 selected_frame
= old_selected_frame
;
12608 set_buffer_internal_1 (old
);
12609 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
12619 /* Display the mode and/or top line of window W. Value is the number
12620 of mode lines displayed. */
12623 display_mode_lines (w
)
12628 /* These will be set while the mode line specs are processed. */
12629 line_number_displayed
= 0;
12630 w
->column_number_displayed
= Qnil
;
12632 if (WINDOW_WANTS_MODELINE_P (w
))
12634 display_mode_line (w
, MODE_LINE_FACE_ID
,
12635 current_buffer
->mode_line_format
);
12639 if (WINDOW_WANTS_HEADER_LINE_P (w
))
12641 display_mode_line (w
, HEADER_LINE_FACE_ID
,
12642 current_buffer
->header_line_format
);
12650 /* Display mode or top line of window W. FACE_ID specifies which line
12651 to display; it is either MODE_LINE_FACE_ID or HEADER_LINE_FACE_ID.
12652 FORMAT is the mode line format to display. Value is the pixel
12653 height of the mode line displayed. */
12656 display_mode_line (w
, face_id
, format
)
12658 enum face_id face_id
;
12659 Lisp_Object format
;
12664 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
12665 prepare_desired_row (it
.glyph_row
);
12667 if (! mode_line_inverse_video
)
12668 /* Force the mode-line to be displayed in the default face. */
12669 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
12671 /* Temporarily make frame's keyboard the current kboard so that
12672 kboard-local variables in the mode_line_format will get the right
12674 push_frame_kboard (it
.f
);
12675 display_mode_element (&it
, 0, 0, 0, format
);
12676 pop_frame_kboard ();
12678 /* Fill up with spaces. */
12679 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
12681 compute_line_metrics (&it
);
12682 it
.glyph_row
->full_width_p
= 1;
12683 it
.glyph_row
->mode_line_p
= 1;
12684 it
.glyph_row
->inverse_p
= 0;
12685 it
.glyph_row
->continued_p
= 0;
12686 it
.glyph_row
->truncated_on_left_p
= 0;
12687 it
.glyph_row
->truncated_on_right_p
= 0;
12689 /* Make a 3D mode-line have a shadow at its right end. */
12690 face
= FACE_FROM_ID (it
.f
, face_id
);
12691 extend_face_to_end_of_line (&it
);
12692 if (face
->box
!= FACE_NO_BOX
)
12694 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
12695 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
12696 last
->right_box_line_p
= 1;
12699 return it
.glyph_row
->height
;
12703 /* Contribute ELT to the mode line for window IT->w. How it
12704 translates into text depends on its data type.
12706 IT describes the display environment in which we display, as usual.
12708 DEPTH is the depth in recursion. It is used to prevent
12709 infinite recursion here.
12711 FIELD_WIDTH is the number of characters the display of ELT should
12712 occupy in the mode line, and PRECISION is the maximum number of
12713 characters to display from ELT's representation. See
12714 display_string for details. *
12716 Returns the hpos of the end of the text generated by ELT. */
12719 display_mode_element (it
, depth
, field_width
, precision
, elt
)
12722 int field_width
, precision
;
12725 int n
= 0, field
, prec
;
12733 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
12737 /* A string: output it and check for %-constructs within it. */
12739 unsigned char *this = XSTRING (elt
)->data
;
12740 unsigned char *lisp_string
= this;
12742 while ((precision
<= 0 || n
< precision
)
12744 && (frame_title_ptr
12745 || it
->current_x
< it
->last_visible_x
))
12747 unsigned char *last
= this;
12749 /* Advance to end of string or next format specifier. */
12750 while ((c
= *this++) != '\0' && c
!= '%')
12753 if (this - 1 != last
)
12755 /* Output to end of string or up to '%'. Field width
12756 is length of string. Don't output more than
12757 PRECISION allows us. */
12758 prec
= --this - last
;
12759 if (precision
> 0 && prec
> precision
- n
)
12760 prec
= precision
- n
;
12762 if (frame_title_ptr
)
12763 n
+= store_frame_title (last
, prec
, prec
);
12765 n
+= display_string (NULL
, elt
, Qnil
, 0, last
- lisp_string
,
12766 it
, 0, prec
, 0, -1);
12768 else /* c == '%' */
12770 unsigned char *percent_position
= this;
12772 /* Get the specified minimum width. Zero means
12775 while ((c
= *this++) >= '0' && c
<= '9')
12776 field
= field
* 10 + c
- '0';
12778 /* Don't pad beyond the total padding allowed. */
12779 if (field_width
- n
> 0 && field
> field_width
- n
)
12780 field
= field_width
- n
;
12782 /* Note that either PRECISION <= 0 or N < PRECISION. */
12783 prec
= precision
- n
;
12786 n
+= display_mode_element (it
, depth
, field
, prec
,
12787 Vglobal_mode_string
);
12790 unsigned char *spec
12791 = decode_mode_spec (it
->w
, c
, field
, prec
);
12793 if (frame_title_ptr
)
12794 n
+= store_frame_title (spec
, field
, prec
);
12798 = it
->glyph_row
->used
[TEXT_AREA
];
12800 = percent_position
- XSTRING (elt
)->data
;
12802 = display_string (spec
, Qnil
, elt
, charpos
, 0, it
,
12803 field
, prec
, 0, -1);
12805 /* Assign to the glyphs written above the
12806 string where the `%x' came from, position
12810 struct glyph
*glyph
12811 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
12815 for (i
= 0; i
< nwritten
; ++i
)
12817 glyph
[i
].object
= elt
;
12818 glyph
[i
].charpos
= charpos
;
12831 /* A symbol: process the value of the symbol recursively
12832 as if it appeared here directly. Avoid error if symbol void.
12833 Special case: if value of symbol is a string, output the string
12836 register Lisp_Object tem
;
12837 tem
= Fboundp (elt
);
12840 tem
= Fsymbol_value (elt
);
12841 /* If value is a string, output that string literally:
12842 don't check for % within it. */
12845 prec
= XSTRING (tem
)->size
;
12846 if (precision
> 0 && prec
> precision
- n
)
12847 prec
= precision
- n
;
12848 if (frame_title_ptr
)
12849 n
+= store_frame_title (XSTRING (tem
)->data
, -1, prec
);
12851 n
+= display_string (NULL
, tem
, Qnil
, 0, 0, it
,
12854 else if (!EQ (tem
, elt
))
12856 /* Give up right away for nil or t. */
12866 register Lisp_Object car
, tem
;
12868 /* A cons cell: three distinct cases.
12869 If first element is a string or a cons, process all the elements
12870 and effectively concatenate them.
12871 If first element is a negative number, truncate displaying cdr to
12872 at most that many characters. If positive, pad (with spaces)
12873 to at least that many characters.
12874 If first element is a symbol, process the cadr or caddr recursively
12875 according to whether the symbol's value is non-nil or nil. */
12877 if (EQ (car
, QCeval
) && CONSP (XCDR (elt
)))
12879 /* An element of the form (:eval FORM) means evaluate FORM
12880 and use the result as mode line elements. */
12881 struct gcpro gcpro1
;
12884 spec
= safe_eval (XCAR (XCDR (elt
)));
12886 n
+= display_mode_element (it
, depth
, field_width
- n
,
12887 precision
- n
, spec
);
12890 else if (SYMBOLP (car
))
12892 tem
= Fboundp (car
);
12896 /* elt is now the cdr, and we know it is a cons cell.
12897 Use its car if CAR has a non-nil value. */
12900 tem
= Fsymbol_value (car
);
12907 /* Symbol's value is nil (or symbol is unbound)
12908 Get the cddr of the original list
12909 and if possible find the caddr and use that. */
12913 else if (!CONSP (elt
))
12918 else if (INTEGERP (car
))
12920 register int lim
= XINT (car
);
12924 /* Negative int means reduce maximum width. */
12925 if (precision
<= 0)
12928 precision
= min (precision
, -lim
);
12932 /* Padding specified. Don't let it be more than
12933 current maximum. */
12935 lim
= min (precision
, lim
);
12937 /* If that's more padding than already wanted, queue it.
12938 But don't reduce padding already specified even if
12939 that is beyond the current truncation point. */
12940 field_width
= max (lim
, field_width
);
12944 else if (STRINGP (car
) || CONSP (car
))
12946 register int limit
= 50;
12947 /* Limit is to protect against circular lists. */
12950 && (precision
<= 0 || n
< precision
))
12952 n
+= display_mode_element (it
, depth
, field_width
- n
,
12953 precision
- n
, XCAR (elt
));
12962 if (frame_title_ptr
)
12963 n
+= store_frame_title ("*invalid*", 0, precision
- n
);
12965 n
+= display_string ("*invalid*", Qnil
, Qnil
, 0, 0, it
, 0,
12966 precision
- n
, 0, 0);
12970 /* Pad to FIELD_WIDTH. */
12971 if (field_width
> 0 && n
< field_width
)
12973 if (frame_title_ptr
)
12974 n
+= store_frame_title ("", field_width
- n
, 0);
12976 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
12984 /* Write a null-terminated, right justified decimal representation of
12985 the positive integer D to BUF using a minimal field width WIDTH. */
12988 pint2str (buf
, width
, d
)
12989 register char *buf
;
12990 register int width
;
12993 register char *p
= buf
;
13001 *p
++ = d
% 10 + '0';
13006 for (width
-= (int) (p
- buf
); width
> 0; --width
)
13017 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
13018 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
13019 type of CODING_SYSTEM. Return updated pointer into BUF. */
13021 static unsigned char invalid_eol_type
[] = "(*invalid*)";
13024 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
13025 Lisp_Object coding_system
;
13026 register char *buf
;
13030 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
13031 unsigned char *eol_str
;
13033 /* The EOL conversion we are using. */
13034 Lisp_Object eoltype
;
13036 val
= Fget (coding_system
, Qcoding_system
);
13039 if (!VECTORP (val
)) /* Not yet decided. */
13044 eoltype
= eol_mnemonic_undecided
;
13045 /* Don't mention EOL conversion if it isn't decided. */
13049 Lisp_Object eolvalue
;
13051 eolvalue
= Fget (coding_system
, Qeol_type
);
13054 *buf
++ = XFASTINT (XVECTOR (val
)->contents
[1]);
13058 /* The EOL conversion that is normal on this system. */
13060 if (NILP (eolvalue
)) /* Not yet decided. */
13061 eoltype
= eol_mnemonic_undecided
;
13062 else if (VECTORP (eolvalue
)) /* Not yet decided. */
13063 eoltype
= eol_mnemonic_undecided
;
13064 else /* INTEGERP (eolvalue) -- 0:LF, 1:CRLF, 2:CR */
13065 eoltype
= (XFASTINT (eolvalue
) == 0
13066 ? eol_mnemonic_unix
13067 : (XFASTINT (eolvalue
) == 1
13068 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
13074 /* Mention the EOL conversion if it is not the usual one. */
13075 if (STRINGP (eoltype
))
13077 eol_str
= XSTRING (eoltype
)->data
;
13078 eol_str_len
= XSTRING (eoltype
)->size
;
13080 else if (INTEGERP (eoltype
)
13081 && CHAR_VALID_P (XINT (eoltype
), 0))
13083 eol_str
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
13084 eol_str_len
= CHAR_STRING (XINT (eoltype
), eol_str
);
13088 eol_str
= invalid_eol_type
;
13089 eol_str_len
= sizeof (invalid_eol_type
) - 1;
13091 bcopy (eol_str
, buf
, eol_str_len
);
13092 buf
+= eol_str_len
;
13098 /* Return a string for the output of a mode line %-spec for window W,
13099 generated by character C. PRECISION >= 0 means don't return a
13100 string longer than that value. FIELD_WIDTH > 0 means pad the
13101 string returned with spaces to that value. */
13103 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
13106 decode_mode_spec (w
, c
, field_width
, precision
)
13109 int field_width
, precision
;
13112 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
13113 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
13114 struct buffer
*b
= XBUFFER (w
->buffer
);
13121 if (!NILP (b
->read_only
))
13123 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
13128 /* This differs from %* only for a modified read-only buffer. */
13129 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
13131 if (!NILP (b
->read_only
))
13136 /* This differs from %* in ignoring read-only-ness. */
13137 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
13149 if (command_loop_level
> 5)
13151 p
= decode_mode_spec_buf
;
13152 for (i
= 0; i
< command_loop_level
; i
++)
13155 return decode_mode_spec_buf
;
13163 if (command_loop_level
> 5)
13165 p
= decode_mode_spec_buf
;
13166 for (i
= 0; i
< command_loop_level
; i
++)
13169 return decode_mode_spec_buf
;
13176 /* Let lots_of_dashes be a string of infinite length. */
13177 if (field_width
<= 0
13178 || field_width
> sizeof (lots_of_dashes
))
13180 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
13181 decode_mode_spec_buf
[i
] = '-';
13182 decode_mode_spec_buf
[i
] = '\0';
13183 return decode_mode_spec_buf
;
13186 return lots_of_dashes
;
13195 int col
= current_column ();
13196 XSETFASTINT (w
->column_number_displayed
, col
);
13197 pint2str (decode_mode_spec_buf
, field_width
, col
);
13198 return decode_mode_spec_buf
;
13202 /* %F displays the frame name. */
13203 if (!NILP (f
->title
))
13204 return (char *) XSTRING (f
->title
)->data
;
13205 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
13206 return (char *) XSTRING (f
->name
)->data
;
13215 int startpos
= XMARKER (w
->start
)->charpos
;
13216 int startpos_byte
= marker_byte_position (w
->start
);
13217 int line
, linepos
, linepos_byte
, topline
;
13219 int height
= XFASTINT (w
->height
);
13221 /* If we decided that this buffer isn't suitable for line numbers,
13222 don't forget that too fast. */
13223 if (EQ (w
->base_line_pos
, w
->buffer
))
13225 /* But do forget it, if the window shows a different buffer now. */
13226 else if (BUFFERP (w
->base_line_pos
))
13227 w
->base_line_pos
= Qnil
;
13229 /* If the buffer is very big, don't waste time. */
13230 if (INTEGERP (Vline_number_display_limit
)
13231 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
13233 w
->base_line_pos
= Qnil
;
13234 w
->base_line_number
= Qnil
;
13238 if (!NILP (w
->base_line_number
)
13239 && !NILP (w
->base_line_pos
)
13240 && XFASTINT (w
->base_line_pos
) <= startpos
)
13242 line
= XFASTINT (w
->base_line_number
);
13243 linepos
= XFASTINT (w
->base_line_pos
);
13244 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
13249 linepos
= BUF_BEGV (b
);
13250 linepos_byte
= BUF_BEGV_BYTE (b
);
13253 /* Count lines from base line to window start position. */
13254 nlines
= display_count_lines (linepos
, linepos_byte
,
13258 topline
= nlines
+ line
;
13260 /* Determine a new base line, if the old one is too close
13261 or too far away, or if we did not have one.
13262 "Too close" means it's plausible a scroll-down would
13263 go back past it. */
13264 if (startpos
== BUF_BEGV (b
))
13266 XSETFASTINT (w
->base_line_number
, topline
);
13267 XSETFASTINT (w
->base_line_pos
, BUF_BEGV (b
));
13269 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
13270 || linepos
== BUF_BEGV (b
))
13272 int limit
= BUF_BEGV (b
);
13273 int limit_byte
= BUF_BEGV_BYTE (b
);
13275 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
13277 if (startpos
- distance
> limit
)
13279 limit
= startpos
- distance
;
13280 limit_byte
= CHAR_TO_BYTE (limit
);
13283 nlines
= display_count_lines (startpos
, startpos_byte
,
13285 - (height
* 2 + 30),
13287 /* If we couldn't find the lines we wanted within
13288 line_number_display_limit_width chars per line,
13289 give up on line numbers for this window. */
13290 if (position
== limit_byte
&& limit
== startpos
- distance
)
13292 w
->base_line_pos
= w
->buffer
;
13293 w
->base_line_number
= Qnil
;
13297 XSETFASTINT (w
->base_line_number
, topline
- nlines
);
13298 XSETFASTINT (w
->base_line_pos
, BYTE_TO_CHAR (position
));
13301 /* Now count lines from the start pos to point. */
13302 nlines
= display_count_lines (startpos
, startpos_byte
,
13303 PT_BYTE
, PT
, &junk
);
13305 /* Record that we did display the line number. */
13306 line_number_displayed
= 1;
13308 /* Make the string to show. */
13309 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
13310 return decode_mode_spec_buf
;
13313 char* p
= decode_mode_spec_buf
;
13314 int pad
= field_width
- 2;
13320 return decode_mode_spec_buf
;
13326 obj
= b
->mode_name
;
13330 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
13336 int pos
= marker_position (w
->start
);
13337 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
13339 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
13341 if (pos
<= BUF_BEGV (b
))
13346 else if (pos
<= BUF_BEGV (b
))
13350 if (total
> 1000000)
13351 /* Do it differently for a large value, to avoid overflow. */
13352 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
13354 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
13355 /* We can't normally display a 3-digit number,
13356 so get us a 2-digit number that is close. */
13359 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
13360 return decode_mode_spec_buf
;
13364 /* Display percentage of size above the bottom of the screen. */
13367 int toppos
= marker_position (w
->start
);
13368 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
13369 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
13371 if (botpos
>= BUF_ZV (b
))
13373 if (toppos
<= BUF_BEGV (b
))
13380 if (total
> 1000000)
13381 /* Do it differently for a large value, to avoid overflow. */
13382 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
13384 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
13385 /* We can't normally display a 3-digit number,
13386 so get us a 2-digit number that is close. */
13389 if (toppos
<= BUF_BEGV (b
))
13390 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
13392 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
13393 return decode_mode_spec_buf
;
13398 /* status of process */
13399 obj
= Fget_buffer_process (w
->buffer
);
13401 return "no process";
13402 #ifdef subprocesses
13403 obj
= Fsymbol_name (Fprocess_status (obj
));
13407 case 't': /* indicate TEXT or BINARY */
13408 #ifdef MODE_LINE_BINARY_TEXT
13409 return MODE_LINE_BINARY_TEXT (b
);
13415 /* coding-system (not including end-of-line format) */
13417 /* coding-system (including end-of-line type) */
13419 int eol_flag
= (c
== 'Z');
13420 char *p
= decode_mode_spec_buf
;
13422 if (! FRAME_WINDOW_P (f
))
13424 /* No need to mention EOL here--the terminal never needs
13425 to do EOL conversion. */
13426 p
= decode_mode_spec_coding (keyboard_coding
.symbol
, p
, 0);
13427 p
= decode_mode_spec_coding (terminal_coding
.symbol
, p
, 0);
13429 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
13432 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
13433 #ifdef subprocesses
13434 obj
= Fget_buffer_process (Fcurrent_buffer ());
13435 if (PROCESSP (obj
))
13437 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
13439 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
13442 #endif /* subprocesses */
13445 return decode_mode_spec_buf
;
13450 return (char *) XSTRING (obj
)->data
;
13456 /* Count up to COUNT lines starting from START / START_BYTE.
13457 But don't go beyond LIMIT_BYTE.
13458 Return the number of lines thus found (always nonnegative).
13460 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
13463 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
13464 int start
, start_byte
, limit_byte
, count
;
13467 register unsigned char *cursor
;
13468 unsigned char *base
;
13470 register int ceiling
;
13471 register unsigned char *ceiling_addr
;
13472 int orig_count
= count
;
13474 /* If we are not in selective display mode,
13475 check only for newlines. */
13476 int selective_display
= (!NILP (current_buffer
->selective_display
)
13477 && !INTEGERP (current_buffer
->selective_display
));
13481 while (start_byte
< limit_byte
)
13483 ceiling
= BUFFER_CEILING_OF (start_byte
);
13484 ceiling
= min (limit_byte
- 1, ceiling
);
13485 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
13486 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
13489 if (selective_display
)
13490 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
13493 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
13496 if (cursor
!= ceiling_addr
)
13500 start_byte
+= cursor
- base
+ 1;
13501 *byte_pos_ptr
= start_byte
;
13505 if (++cursor
== ceiling_addr
)
13511 start_byte
+= cursor
- base
;
13516 while (start_byte
> limit_byte
)
13518 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
13519 ceiling
= max (limit_byte
, ceiling
);
13520 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
13521 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
13524 if (selective_display
)
13525 while (--cursor
!= ceiling_addr
13526 && *cursor
!= '\n' && *cursor
!= 015)
13529 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
13532 if (cursor
!= ceiling_addr
)
13536 start_byte
+= cursor
- base
+ 1;
13537 *byte_pos_ptr
= start_byte
;
13538 /* When scanning backwards, we should
13539 not count the newline posterior to which we stop. */
13540 return - orig_count
- 1;
13546 /* Here we add 1 to compensate for the last decrement
13547 of CURSOR, which took it past the valid range. */
13548 start_byte
+= cursor
- base
+ 1;
13552 *byte_pos_ptr
= limit_byte
;
13555 return - orig_count
+ count
;
13556 return orig_count
- count
;
13562 /***********************************************************************
13564 ***********************************************************************/
13566 /* Display a NUL-terminated string, starting with index START.
13568 If STRING is non-null, display that C string. Otherwise, the Lisp
13569 string LISP_STRING is displayed.
13571 If FACE_STRING is not nil, FACE_STRING_POS is a position in
13572 FACE_STRING. Display STRING or LISP_STRING with the face at
13573 FACE_STRING_POS in FACE_STRING:
13575 Display the string in the environment given by IT, but use the
13576 standard display table, temporarily.
13578 FIELD_WIDTH is the minimum number of output glyphs to produce.
13579 If STRING has fewer characters than FIELD_WIDTH, pad to the right
13580 with spaces. If STRING has more characters, more than FIELD_WIDTH
13581 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
13583 PRECISION is the maximum number of characters to output from
13584 STRING. PRECISION < 0 means don't truncate the string.
13586 This is roughly equivalent to printf format specifiers:
13588 FIELD_WIDTH PRECISION PRINTF
13589 ----------------------------------------
13595 MULTIBYTE zero means do not display multibyte chars, > 0 means do
13596 display them, and < 0 means obey the current buffer's value of
13597 enable_multibyte_characters.
13599 Value is the number of glyphs produced. */
13602 display_string (string
, lisp_string
, face_string
, face_string_pos
,
13603 start
, it
, field_width
, precision
, max_x
, multibyte
)
13604 unsigned char *string
;
13605 Lisp_Object lisp_string
;
13606 Lisp_Object face_string
;
13607 int face_string_pos
;
13610 int field_width
, precision
, max_x
;
13613 int hpos_at_start
= it
->hpos
;
13614 int saved_face_id
= it
->face_id
;
13615 struct glyph_row
*row
= it
->glyph_row
;
13617 /* Initialize the iterator IT for iteration over STRING beginning
13618 with index START. We assume that IT may be modified here (which
13619 means that display_line has to do something when displaying a
13620 mini-buffer prompt, which it does). */
13621 reseat_to_string (it
, string
, lisp_string
, start
,
13622 precision
, field_width
, multibyte
);
13624 /* If displaying STRING, set up the face of the iterator
13625 from LISP_STRING, if that's given. */
13626 if (STRINGP (face_string
))
13632 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
13633 0, it
->region_beg_charpos
,
13634 it
->region_end_charpos
,
13635 &endptr
, it
->base_face_id
);
13636 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
13637 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
13640 /* Set max_x to the maximum allowed X position. Don't let it go
13641 beyond the right edge of the window. */
13643 max_x
= it
->last_visible_x
;
13645 max_x
= min (max_x
, it
->last_visible_x
);
13647 /* Skip over display elements that are not visible. because IT->w is
13649 if (it
->current_x
< it
->first_visible_x
)
13650 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
13651 MOVE_TO_POS
| MOVE_TO_X
);
13653 row
->ascent
= it
->max_ascent
;
13654 row
->height
= it
->max_ascent
+ it
->max_descent
;
13655 row
->phys_ascent
= it
->max_phys_ascent
;
13656 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
13658 /* This condition is for the case that we are called with current_x
13659 past last_visible_x. */
13660 while (it
->current_x
< max_x
)
13662 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
13664 /* Get the next display element. */
13665 if (!get_next_display_element (it
))
13668 /* Produce glyphs. */
13669 x_before
= it
->current_x
;
13670 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
13671 PRODUCE_GLYPHS (it
);
13673 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
13676 while (i
< nglyphs
)
13678 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
13680 if (!it
->truncate_lines_p
13681 && x
+ glyph
->pixel_width
> max_x
)
13683 /* End of continued line or max_x reached. */
13684 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
13688 else if (x
+ glyph
->pixel_width
> it
->first_visible_x
)
13690 /* Glyph is at least partially visible. */
13692 if (x
< it
->first_visible_x
)
13693 it
->glyph_row
->x
= x
- it
->first_visible_x
;
13697 /* Glyph is off the left margin of the display area.
13698 Should not happen. */
13702 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
13703 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
13704 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
13705 row
->phys_height
= max (row
->phys_height
,
13706 it
->max_phys_ascent
+ it
->max_phys_descent
);
13707 x
+= glyph
->pixel_width
;
13711 /* Stop if max_x reached. */
13715 /* Stop at line ends. */
13716 if (ITERATOR_AT_END_OF_LINE_P (it
))
13718 it
->continuation_lines_width
= 0;
13722 set_iterator_to_next (it
, 1);
13724 /* Stop if truncating at the right edge. */
13725 if (it
->truncate_lines_p
13726 && it
->current_x
>= it
->last_visible_x
)
13728 /* Add truncation mark, but don't do it if the line is
13729 truncated at a padding space. */
13730 if (IT_CHARPOS (*it
) < it
->string_nchars
)
13732 if (!FRAME_WINDOW_P (it
->f
))
13733 produce_special_glyphs (it
, IT_TRUNCATION
);
13734 it
->glyph_row
->truncated_on_right_p
= 1;
13740 /* Maybe insert a truncation at the left. */
13741 if (it
->first_visible_x
13742 && IT_CHARPOS (*it
) > 0)
13744 if (!FRAME_WINDOW_P (it
->f
))
13745 insert_left_trunc_glyphs (it
);
13746 it
->glyph_row
->truncated_on_left_p
= 1;
13749 it
->face_id
= saved_face_id
;
13751 /* Value is number of columns displayed. */
13752 return it
->hpos
- hpos_at_start
;
13757 /* This is like a combination of memq and assq. Return 1 if PROPVAL
13758 appears as an element of LIST or as the car of an element of LIST.
13759 If PROPVAL is a list, compare each element against LIST in that
13760 way, and return 1 if any element of PROPVAL is found in LIST.
13761 Otherwise return 0. This function cannot quit. */
13764 invisible_p (propval
, list
)
13765 register Lisp_Object propval
;
13768 register Lisp_Object tail
, proptail
;
13770 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
13772 register Lisp_Object tem
;
13774 if (EQ (propval
, tem
))
13776 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
13780 if (CONSP (propval
))
13782 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
13784 Lisp_Object propelt
;
13785 propelt
= XCAR (proptail
);
13786 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
13788 register Lisp_Object tem
;
13790 if (EQ (propelt
, tem
))
13792 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
13802 /* Return 1 if PROPVAL appears as the car of an element of LIST and
13803 the cdr of that element is non-nil. If PROPVAL is a list, check
13804 each element of PROPVAL in that way, and the first time some
13805 element is found, return 1 if the cdr of that element is non-nil.
13806 Otherwise return 0. This function cannot quit. */
13809 invisible_ellipsis_p (propval
, list
)
13810 register Lisp_Object propval
;
13813 register Lisp_Object tail
, proptail
;
13815 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
13817 register Lisp_Object tem
;
13819 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
13820 return ! NILP (XCDR (tem
));
13823 if (CONSP (propval
))
13824 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
13826 Lisp_Object propelt
;
13827 propelt
= XCAR (proptail
);
13828 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
13830 register Lisp_Object tem
;
13832 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
13833 return ! NILP (XCDR (tem
));
13842 /***********************************************************************
13844 ***********************************************************************/
13849 Vwith_echo_area_save_vector
= Qnil
;
13850 staticpro (&Vwith_echo_area_save_vector
);
13852 Vmessage_stack
= Qnil
;
13853 staticpro (&Vmessage_stack
);
13855 Qinhibit_redisplay
= intern ("inhibit-redisplay");
13856 staticpro (&Qinhibit_redisplay
);
13859 defsubr (&Sdump_glyph_matrix
);
13860 defsubr (&Sdump_glyph_row
);
13861 defsubr (&Sdump_tool_bar_row
);
13862 defsubr (&Strace_redisplay_toggle
);
13863 defsubr (&Strace_to_stderr
);
13866 staticpro (&Qmenu_bar_update_hook
);
13867 Qmenu_bar_update_hook
= intern ("menu-bar-update-hook");
13869 staticpro (&Qoverriding_terminal_local_map
);
13870 Qoverriding_terminal_local_map
= intern ("overriding-terminal-local-map");
13872 staticpro (&Qoverriding_local_map
);
13873 Qoverriding_local_map
= intern ("overriding-local-map");
13875 staticpro (&Qwindow_scroll_functions
);
13876 Qwindow_scroll_functions
= intern ("window-scroll-functions");
13878 staticpro (&Qredisplay_end_trigger_functions
);
13879 Qredisplay_end_trigger_functions
= intern ("redisplay-end-trigger-functions");
13881 staticpro (&Qinhibit_point_motion_hooks
);
13882 Qinhibit_point_motion_hooks
= intern ("inhibit-point-motion-hooks");
13884 QCdata
= intern (":data");
13885 staticpro (&QCdata
);
13886 Qdisplay
= intern ("display");
13887 staticpro (&Qdisplay
);
13888 Qspace_width
= intern ("space-width");
13889 staticpro (&Qspace_width
);
13890 Qraise
= intern ("raise");
13891 staticpro (&Qraise
);
13892 Qspace
= intern ("space");
13893 staticpro (&Qspace
);
13894 Qmargin
= intern ("margin");
13895 staticpro (&Qmargin
);
13896 Qleft_margin
= intern ("left-margin");
13897 staticpro (&Qleft_margin
);
13898 Qright_margin
= intern ("right-margin");
13899 staticpro (&Qright_margin
);
13900 Qalign_to
= intern ("align-to");
13901 staticpro (&Qalign_to
);
13902 QCalign_to
= intern (":align-to");
13903 staticpro (&QCalign_to
);
13904 Qrelative_width
= intern ("relative-width");
13905 staticpro (&Qrelative_width
);
13906 QCrelative_width
= intern (":relative-width");
13907 staticpro (&QCrelative_width
);
13908 QCrelative_height
= intern (":relative-height");
13909 staticpro (&QCrelative_height
);
13910 QCeval
= intern (":eval");
13911 staticpro (&QCeval
);
13912 Qwhen
= intern ("when");
13913 staticpro (&Qwhen
);
13914 QCfile
= intern (":file");
13915 staticpro (&QCfile
);
13916 Qfontified
= intern ("fontified");
13917 staticpro (&Qfontified
);
13918 Qfontification_functions
= intern ("fontification-functions");
13919 staticpro (&Qfontification_functions
);
13920 Qtrailing_whitespace
= intern ("trailing-whitespace");
13921 staticpro (&Qtrailing_whitespace
);
13922 Qimage
= intern ("image");
13923 staticpro (&Qimage
);
13924 Qmessage_truncate_lines
= intern ("message-truncate-lines");
13925 staticpro (&Qmessage_truncate_lines
);
13926 Qgrow_only
= intern ("grow-only");
13927 staticpro (&Qgrow_only
);
13929 last_arrow_position
= Qnil
;
13930 last_arrow_string
= Qnil
;
13931 staticpro (&last_arrow_position
);
13932 staticpro (&last_arrow_string
);
13934 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
13935 staticpro (&echo_buffer
[0]);
13936 staticpro (&echo_buffer
[1]);
13938 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
13939 staticpro (&echo_area_buffer
[0]);
13940 staticpro (&echo_area_buffer
[1]);
13942 Vmessages_buffer_name
= build_string ("*Messages*");
13943 staticpro (&Vmessages_buffer_name
);
13945 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
13946 "Non-nil means highlight trailing whitespace.\n\
13947 The face used for trailing whitespace is `trailing-whitespace'.");
13948 Vshow_trailing_whitespace
= Qnil
;
13950 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
13951 "Non-nil means don't actually do any redisplay.\n\
13952 This is used for internal purposes.");
13953 Vinhibit_redisplay
= Qnil
;
13955 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
13956 "String (or mode line construct) included (normally) in `mode-line-format'.");
13957 Vglobal_mode_string
= Qnil
;
13959 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
13960 "Marker for where to display an arrow on top of the buffer text.\n\
13961 This must be the beginning of a line in order to work.\n\
13962 See also `overlay-arrow-string'.");
13963 Voverlay_arrow_position
= Qnil
;
13965 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
13966 "String to display as an arrow. See also `overlay-arrow-position'.");
13967 Voverlay_arrow_string
= Qnil
;
13969 DEFVAR_INT ("scroll-step", &scroll_step
,
13970 "*The number of lines to try scrolling a window by when point moves out.\n\
13971 If that fails to bring point back on frame, point is centered instead.\n\
13972 If this is zero, point is always centered after it moves off frame.\n\
13973 If you want scrolling to always be a line at a time, you should set\n\
13974 `scroll-conservatively' to a large value rather than set this to 1.");
13976 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
13977 "*Scroll up to this many lines, to bring point back on screen.\n\
13978 A value of zero means to scroll the text to center point vertically\n\
13980 scroll_conservatively
= 0;
13982 DEFVAR_INT ("scroll-margin", &scroll_margin
,
13983 "*Number of lines of margin at the top and bottom of a window.\n\
13984 Recenter the window whenever point gets within this many lines\n\
13985 of the top or bottom of the window.");
13989 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, "Don't ask");
13992 DEFVAR_BOOL ("truncate-partial-width-windows",
13993 &truncate_partial_width_windows
,
13994 "*Non-nil means truncate lines in all windows less than full frame wide.");
13995 truncate_partial_width_windows
= 1;
13997 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
13998 "nil means display the mode-line/header-line/menu-bar in the default face.\n\
13999 Any other value means to use the appropriate face, `mode-line',\n\
14000 `header-line', or `menu' respectively.\n\
14002 This variable is deprecated; please change the above faces instead.");
14003 mode_line_inverse_video
= 1;
14005 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
14006 "*Maximum buffer size for which line number should be displayed.\n\
14007 If the buffer is bigger than this, the line number does not appear\n\
14008 in the mode line. A value of nil means no limit.");
14009 Vline_number_display_limit
= Qnil
;
14011 DEFVAR_INT ("line-number-display-limit-width",
14012 &line_number_display_limit_width
,
14013 "*Maximum line width (in characters) for line number display.\n\
14014 If the average length of the lines near point is bigger than this, then the\n\
14015 line number may be omitted from the mode line.");
14016 line_number_display_limit_width
= 200;
14018 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
14019 "*Non-nil means highlight region even in nonselected windows.");
14020 highlight_nonselected_windows
= 0;
14022 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
14023 "Non-nil if more than one frame is visible on this display.\n\
14024 Minibuffer-only frames don't count, but iconified frames do.\n\
14025 This variable is not guaranteed to be accurate except while processing\n\
14026 `frame-title-format' and `icon-title-format'.");
14028 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
14029 "Template for displaying the title bar of visible frames.\n\
14030 \(Assuming the window manager supports this feature.)\n\
14031 This variable has the same structure as `mode-line-format' (which see),\n\
14032 and is used only on frames for which no explicit name has been set\n\
14033 \(see `modify-frame-parameters').");
14034 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
14035 "Template for displaying the title bar of an iconified frame.\n\
14036 \(Assuming the window manager supports this feature.)\n\
14037 This variable has the same structure as `mode-line-format' (which see),\n\
14038 and is used only on frames for which no explicit name has been set\n\
14039 \(see `modify-frame-parameters').");
14041 = Vframe_title_format
14042 = Fcons (intern ("multiple-frames"),
14043 Fcons (build_string ("%b"),
14044 Fcons (Fcons (build_string (""),
14045 Fcons (intern ("invocation-name"),
14046 Fcons (build_string ("@"),
14047 Fcons (intern ("system-name"),
14051 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
14052 "Maximum number of lines to keep in the message log buffer.\n\
14053 If nil, disable message logging. If t, log messages but don't truncate\n\
14054 the buffer when it becomes large.");
14055 XSETFASTINT (Vmessage_log_max
, 50);
14057 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
14058 "Functions called before redisplay, if window sizes have changed.\n\
14059 The value should be a list of functions that take one argument.\n\
14060 Just before redisplay, for each frame, if any of its windows have changed\n\
14061 size since the last redisplay, or have been split or deleted,\n\
14062 all the functions in the list are called, with the frame as argument.");
14063 Vwindow_size_change_functions
= Qnil
;
14065 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
14066 "List of Functions to call before redisplaying a window with scrolling.\n\
14067 Each function is called with two arguments, the window\n\
14068 and its new display-start position. Note that the value of `window-end'\n\
14069 is not valid when these functions are called.");
14070 Vwindow_scroll_functions
= Qnil
;
14072 DEFVAR_BOOL ("auto-resize-tool-bars", &auto_resize_tool_bars_p
,
14073 "*Non-nil means automatically resize tool-bars.\n\
14074 This increases a tool-bar's height if not all tool-bar items are visible.\n\
14075 It decreases a tool-bar's height when it would display blank lines\n\
14077 auto_resize_tool_bars_p
= 1;
14079 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
14080 "*Non-nil means raise tool-bar buttons when the mouse moves over them.");
14081 auto_raise_tool_bar_buttons_p
= 1;
14083 DEFVAR_INT ("tool-bar-button-margin", &tool_bar_button_margin
,
14084 "*Margin around tool-bar buttons in pixels.");
14085 tool_bar_button_margin
= 1;
14087 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
14088 "Relief thickness of tool-bar buttons.");
14089 tool_bar_button_relief
= 3;
14091 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
14092 "List of functions to call to fontify regions of text.\n\
14093 Each function is called with one argument POS. Functions must\n\
14094 fontify a region starting at POS in the current buffer, and give\n\
14095 fontified regions the property `fontified'.\n\
14096 This variable automatically becomes buffer-local when set.");
14097 Vfontification_functions
= Qnil
;
14098 Fmake_variable_buffer_local (Qfontification_functions
);
14100 DEFVAR_BOOL ("unibyte-display-via-language-environment",
14101 &unibyte_display_via_language_environment
,
14102 "*Non-nil means display unibyte text according to language environment.\n\
14103 Specifically this means that unibyte non-ASCII characters\n\
14104 are displayed by converting them to the equivalent multibyte characters\n\
14105 according to the current language environment. As a result, they are\n\
14106 displayed according to the current fontset.");
14107 unibyte_display_via_language_environment
= 0;
14109 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
14110 "*Maximum height for resizing mini-windows.\n\
14111 If a float, it specifies a fraction of the mini-window frame's height.\n\
14112 If an integer, it specifies a number of lines.");
14113 Vmax_mini_window_height
= make_float (0.25);
14115 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
14116 "*How to resize mini-windows.\n\
14117 A value of nil means don't automatically resize mini-windows.\n\
14118 A value of t means resize them to fit the text displayed in them.\n\
14119 A value of `grow-only', the default, means let mini-windows grow\n\
14120 only, until their display becomes empty, at which point the windows\n\
14121 go back to their normal size.");
14122 Vresize_mini_windows
= Qgrow_only
;
14124 DEFVAR_BOOL ("cursor-in-non-selected-windows",
14125 &cursor_in_non_selected_windows
,
14126 "*Non-nil means display a hollow cursor in non-selected windows.\n\
14127 Nil means don't display a cursor there.");
14128 cursor_in_non_selected_windows
= 1;
14130 DEFVAR_BOOL ("automatic-hscrolling", &automatic_hscrolling_p
,
14131 "*Non-nil means scroll the display automatically to make point visible.");
14132 automatic_hscrolling_p
= 1;
14134 DEFVAR_LISP ("image-types", &Vimage_types
,
14135 "List of supported image types.\n\
14136 Each element of the list is a symbol for a supported image type.");
14137 Vimage_types
= Qnil
;
14139 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
14140 "If non-nil, messages are truncated instead of resizing the echo area.\n\
14141 Bind this around calls to `message' to let it take effect.");
14142 message_truncate_lines
= 0;
14144 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
14145 "Normal hook run for clicks on menu bar, before displaying a submenu.\n\
14146 Can be used to update submenus whose contents should vary.");
14147 Vmenu_bar_update_hook
= Qnil
;
14151 /* Initialize this module when Emacs starts. */
14156 Lisp_Object root_window
;
14157 struct window
*mini_w
;
14159 current_header_line_height
= current_mode_line_height
= -1;
14161 CHARPOS (this_line_start_pos
) = 0;
14163 mini_w
= XWINDOW (minibuf_window
);
14164 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
14166 if (!noninteractive
)
14168 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
14171 XSETFASTINT (XWINDOW (root_window
)->top
, FRAME_TOP_MARGIN (f
));
14172 set_window_height (root_window
,
14173 FRAME_HEIGHT (f
) - 1 - FRAME_TOP_MARGIN (f
),
14175 XSETFASTINT (mini_w
->top
, FRAME_HEIGHT (f
) - 1);
14176 set_window_height (minibuf_window
, 1, 0);
14178 XSETFASTINT (XWINDOW (root_window
)->width
, FRAME_WIDTH (f
));
14179 XSETFASTINT (mini_w
->width
, FRAME_WIDTH (f
));
14181 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
14182 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
14183 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
14185 /* The default ellipsis glyphs `...'. */
14186 for (i
= 0; i
< 3; ++i
)
14187 XSETFASTINT (default_invis_vector
[i
], '.');
14190 #ifdef HAVE_WINDOW_SYSTEM
14192 /* Allocate the buffer for frame titles. */
14194 frame_title_buf
= (char *) xmalloc (size
);
14195 frame_title_buf_end
= frame_title_buf
+ size
;
14196 frame_title_ptr
= NULL
;
14198 #endif /* HAVE_WINDOW_SYSTEM */
14200 help_echo_showing_p
= 0;