1 /* Display generation from window structure and buffer text.
2 Copyright (C) 1985, 86, 87, 88, 93, 94, 95, 97, 98, 99
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. */
175 #include "termchar.h"
176 #include "dispextern.h"
180 #include "commands.h"
183 #include "termhooks.h"
184 #include "intervals.h"
185 #include "keyboard.h"
188 #include "region-cache.h"
190 #ifdef HAVE_X_WINDOWS
194 #define min(a, b) ((a) < (b) ? (a) : (b))
195 #define max(a, b) ((a) > (b) ? (a) : (b))
197 #define INFINITY 10000000
199 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
200 extern void set_frame_menubar ();
201 extern int pending_menu_activation
;
204 extern int interrupt_input
;
205 extern int command_loop_level
;
207 extern int minibuffer_auto_raise
;
209 extern Lisp_Object Qface
;
211 extern Lisp_Object Voverriding_local_map
;
212 extern Lisp_Object Voverriding_local_map_menu_flag
;
213 extern Lisp_Object Qmenu_item
;
215 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
216 Lisp_Object Qwindow_scroll_functions
, Vwindow_scroll_functions
;
217 Lisp_Object Qredisplay_end_trigger_functions
;
218 Lisp_Object Qinhibit_point_motion_hooks
;
219 Lisp_Object QCeval
, Qwhen
, QCfile
;
220 Lisp_Object Qfontified
;
222 /* Functions called to fontify regions of text. */
224 Lisp_Object Vfontification_functions
;
225 Lisp_Object Qfontification_functions
;
227 /* Non-zero means draw tool bar buttons raised when the mouse moves
230 int auto_raise_tool_bar_buttons_p
;
232 /* Margin around tool bar buttons in pixels. */
234 int tool_bar_button_margin
;
236 /* Thickness of shadow to draw around tool bar buttons. */
238 int tool_bar_button_relief
;
240 /* Non-zero means automatically resize tool-bars so that all tool-bar
241 items are visible, and no blank lines remain. */
243 int auto_resize_tool_bars_p
;
245 /* Non-nil means don't actually do any redisplay. */
247 Lisp_Object Vinhibit_redisplay
, Qinhibit_redisplay
;
249 /* Names of text properties relevant for redisplay. */
251 Lisp_Object Qdisplay
, Qrelative_width
, Qalign_to
;
252 extern Lisp_Object Qface
, Qinvisible
, Qimage
, Qwidth
;
254 /* Symbols used in text property values. */
256 Lisp_Object Qspace
, QCalign_to
, QCrelative_width
, QCrelative_height
;
257 Lisp_Object Qleft_margin
, Qright_margin
, Qspace_width
, Qraise
;
259 extern Lisp_Object Qheight
;
261 /* Non-nil means highlight trailing whitespace. */
263 Lisp_Object Vshow_trailing_whitespace
;
265 /* Name of the face used to highlight trailing whitespace. */
267 Lisp_Object Qtrailing_whitespace
;
269 /* The symbol `image' which is the car of the lists used to represent
274 /* Non-zero means print newline to stdout before next mini-buffer
277 int noninteractive_need_newline
;
279 /* Non-zero means print newline to message log before next message. */
281 static int message_log_need_newline
;
284 /* The buffer position of the first character appearing entirely or
285 partially on the line of the selected window which contains the
286 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
287 redisplay optimization in redisplay_internal. */
289 static struct text_pos this_line_start_pos
;
291 /* Number of characters past the end of the line above, including the
292 terminating newline. */
294 static struct text_pos this_line_end_pos
;
296 /* The vertical positions and the height of this line. */
298 static int this_line_vpos
;
299 static int this_line_y
;
300 static int this_line_pixel_height
;
302 /* X position at which this display line starts. Usually zero;
303 negative if first character is partially visible. */
305 static int this_line_start_x
;
307 /* Buffer that this_line_.* variables are referring to. */
309 static struct buffer
*this_line_buffer
;
311 /* Nonzero means truncate lines in all windows less wide than the
314 int truncate_partial_width_windows
;
316 /* A flag to control how to display unibyte 8-bit character. */
318 int unibyte_display_via_language_environment
;
320 /* Nonzero means we have more than one non-mini-buffer-only frame.
321 Not guaranteed to be accurate except while parsing
322 frame-title-format. */
326 Lisp_Object Vglobal_mode_string
;
328 /* Marker for where to display an arrow on top of the buffer text. */
330 Lisp_Object Voverlay_arrow_position
;
332 /* String to display for the arrow. Only used on terminal frames. */
334 Lisp_Object Voverlay_arrow_string
;
336 /* Values of those variables at last redisplay. However, if
337 Voverlay_arrow_position is a marker, last_arrow_position is its
338 numerical position. */
340 static Lisp_Object last_arrow_position
, last_arrow_string
;
342 /* Like mode-line-format, but for the title bar on a visible frame. */
344 Lisp_Object Vframe_title_format
;
346 /* Like mode-line-format, but for the title bar on an iconified frame. */
348 Lisp_Object Vicon_title_format
;
350 /* List of functions to call when a window's size changes. These
351 functions get one arg, a frame on which one or more windows' sizes
354 static Lisp_Object Vwindow_size_change_functions
;
356 Lisp_Object Qmenu_bar_update_hook
;
358 /* Nonzero if overlay arrow has been displayed once in this window. */
360 static int overlay_arrow_seen
;
362 /* Nonzero means highlight the region even in nonselected windows. */
364 int highlight_nonselected_windows
;
366 /* If cursor motion alone moves point off frame, try scrolling this
367 many lines up or down if that will bring it back. */
369 static int scroll_step
;
371 /* Non-0 means scroll just far enough to bring point back on the
372 screen, when appropriate. */
374 static int scroll_conservatively
;
376 /* Recenter the window whenever point gets within this many lines of
377 the top or bottom of the window. This value is translated into a
378 pixel value by multiplying it with CANON_Y_UNIT, which means that
379 there is really a fixed pixel height scroll margin. */
383 /* Number of windows showing the buffer of the selected window (or
384 another buffer with the same base buffer). keyboard.c refers to
389 /* Vector containing glyphs for an ellipsis `...'. */
391 static Lisp_Object default_invis_vector
[3];
393 /* Nonzero means display mode line highlighted. */
395 int mode_line_inverse_video
;
397 /* Prompt to display in front of the mini-buffer contents. */
399 Lisp_Object minibuf_prompt
;
401 /* Width of current mini-buffer prompt. Only set after display_line
402 of the line that contains the prompt. */
404 int minibuf_prompt_width
;
405 int minibuf_prompt_pixel_width
;
407 /* This is the window where the echo area message was displayed. It
408 is always a mini-buffer window, but it may not be the same window
409 currently active as a mini-buffer. */
411 Lisp_Object echo_area_window
;
413 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
414 pushes the current message and the value of
415 message_enable_multibyte on the stack, the function restore_message
416 pops the stack and displays MESSAGE again. */
418 Lisp_Object Vmessage_stack
;
420 /* Nonzero means multibyte characters were enabled when the echo area
421 message was specified. */
423 int message_enable_multibyte
;
425 /* True if we should redraw the mode lines on the next redisplay. */
427 int update_mode_lines
;
429 /* Nonzero if window sizes or contents have changed since last
430 redisplay that finished */
432 int windows_or_buffers_changed
;
434 /* Nonzero after display_mode_line if %l was used and it displayed a
437 int line_number_displayed
;
439 /* Maximum buffer size for which to display line numbers. */
441 static int line_number_display_limit
;
443 /* line width to consider when repostioning for line number display */
445 static int line_number_display_limit_width
;
447 /* Number of lines to keep in the message log buffer. t means
448 infinite. nil means don't log at all. */
450 Lisp_Object Vmessage_log_max
;
452 /* Current, index 0, and last displayed echo area message. Either
453 buffers from echo_buffers, or nil to indicate no message. */
455 Lisp_Object echo_area_buffer
[2];
457 /* The buffers referenced from echo_area_buffer. */
459 static Lisp_Object echo_buffer
[2];
461 /* A vector saved used in with_area_buffer to reduce consing. */
463 static Lisp_Object Vwith_echo_area_save_vector
;
465 /* Non-zero means display_echo_area should display the last echo area
466 message again. Set by redisplay_preserve_echo_area. */
468 static int display_last_displayed_message_p
;
470 /* Nonzero if echo area is being used by print; zero if being used by
473 int message_buf_print
;
475 /* Maximum height for resizing mini-windows. Either a float
476 specifying a fraction of the available height, or an integer
477 specifying a number of lines. */
479 static Lisp_Object Vmax_mini_window_height
;
481 /* A scratch glyph row with contents used for generating truncation
482 glyphs. Also used in direct_output_for_insert. */
484 #define MAX_SCRATCH_GLYPHS 100
485 struct glyph_row scratch_glyph_row
;
486 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
488 /* Ascent and height of the last line processed by move_it_to. */
490 static int last_max_ascent
, last_height
;
492 /* The maximum distance to look ahead for text properties. Values
493 that are too small let us call compute_char_face and similar
494 functions too often which is expensive. Values that are too large
495 let us call compute_char_face and alike too often because we
496 might not be interested in text properties that far away. */
498 #define TEXT_PROP_DISTANCE_LIMIT 100
500 /* Non-zero means print traces of redisplay if compiled with
504 int trace_redisplay_p
;
507 /* Value returned from text property handlers (see below). */
512 HANDLED_RECOMPUTE_PROPS
,
513 HANDLED_OVERLAY_STRING_CONSUMED
,
517 /* A description of text properties that redisplay is interested
522 /* The name of the property. */
525 /* A unique index for the property. */
528 /* A handler function called to set up iterator IT from the property
529 at IT's current position. Value is used to steer handle_stop. */
530 enum prop_handled (*handler
) P_ ((struct it
*it
));
533 static enum prop_handled handle_face_prop
P_ ((struct it
*));
534 static enum prop_handled handle_invisible_prop
P_ ((struct it
*));
535 static enum prop_handled handle_display_prop
P_ ((struct it
*));
536 static enum prop_handled handle_composition_prop
P_ ((struct it
*));
537 static enum prop_handled handle_overlay_change
P_ ((struct it
*));
538 static enum prop_handled handle_fontified_prop
P_ ((struct it
*));
540 /* Properties handled by iterators. */
542 static struct props it_props
[] =
544 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
545 /* Handle `face' before `display' because some sub-properties of
546 `display' need to know the face. */
547 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
548 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
549 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
550 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
554 /* Value is the position described by X. If X is a marker, value is
555 the marker_position of X. Otherwise, value is X. */
557 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
559 /* Enumeration returned by some move_it_.* functions internally. */
563 /* Not used. Undefined value. */
566 /* Move ended at the requested buffer position or ZV. */
567 MOVE_POS_MATCH_OR_ZV
,
569 /* Move ended at the requested X pixel position. */
572 /* Move within a line ended at the end of a line that must be
576 /* Move within a line ended at the end of a line that would
577 be displayed truncated. */
580 /* Move within a line ended at a line end. */
586 /* Function prototypes. */
588 static void ensure_echo_area_buffers
P_ ((void));
589 static struct glyph_row
*row_containing_pos
P_ ((struct window
*, int,
591 struct glyph_row
*));
592 static Lisp_Object unwind_with_echo_area_buffer
P_ ((Lisp_Object
));
593 static Lisp_Object with_echo_area_buffer_unwind_data
P_ ((struct window
*));
594 static void clear_garbaged_frames
P_ ((void));
595 static int current_message_1
P_ ((Lisp_Object
*));
596 static int truncate_message_1
P_ ((int));
597 static int set_message_1
P_ ((char *s
, Lisp_Object
, int, int));
598 static int display_echo_area
P_ ((struct window
*));
599 static int display_echo_area_1
P_ ((struct window
*));
600 static Lisp_Object unwind_redisplay
P_ ((Lisp_Object
));
601 static int string_char_and_length
P_ ((unsigned char *, int, int *));
602 static struct text_pos display_prop_end
P_ ((struct it
*, Lisp_Object
,
604 static int compute_window_start_on_continuation_line
P_ ((struct window
*));
605 static Lisp_Object eval_handler
P_ ((Lisp_Object
));
606 static Lisp_Object eval_form
P_ ((Lisp_Object
));
607 static void insert_left_trunc_glyphs
P_ ((struct it
*));
608 static struct glyph_row
*get_overlay_arrow_glyph_row
P_ ((struct window
*));
609 static void extend_face_to_end_of_line
P_ ((struct it
*));
610 static int append_space
P_ ((struct it
*, int));
611 static void make_cursor_line_fully_visible
P_ ((struct window
*));
612 static int try_scrolling
P_ ((Lisp_Object
, int, int, int, int));
613 static int trailing_whitespace_p
P_ ((int));
614 static int message_log_check_duplicate
P_ ((int, int, int, int));
615 int invisible_p
P_ ((Lisp_Object
, Lisp_Object
));
616 int invisible_ellipsis_p
P_ ((Lisp_Object
, Lisp_Object
));
617 static void push_it
P_ ((struct it
*));
618 static void pop_it
P_ ((struct it
*));
619 static void sync_frame_with_window_matrix_rows
P_ ((struct window
*));
620 static void redisplay_internal
P_ ((int));
621 static int echo_area_display
P_ ((int));
622 static void redisplay_windows
P_ ((Lisp_Object
));
623 static void redisplay_window
P_ ((Lisp_Object
, int));
624 static void update_menu_bar
P_ ((struct frame
*, int));
625 static int try_window_reusing_current_matrix
P_ ((struct window
*));
626 static int try_window_id
P_ ((struct window
*));
627 static int display_line
P_ ((struct it
*));
628 static void display_mode_lines
P_ ((struct window
*));
629 static void display_mode_line
P_ ((struct window
*, enum face_id
,
631 static int display_mode_element
P_ ((struct it
*, int, int, int, Lisp_Object
));
632 static char *decode_mode_spec
P_ ((struct window
*, int, int, int));
633 static void display_menu_bar
P_ ((struct window
*));
634 static int display_count_lines
P_ ((int, int, int, int, int *));
635 static int display_string
P_ ((unsigned char *, Lisp_Object
, Lisp_Object
,
636 int, int, struct it
*, int, int, int, int));
637 static void compute_line_metrics
P_ ((struct it
*));
638 static void run_redisplay_end_trigger_hook
P_ ((struct it
*));
639 static int get_overlay_strings
P_ ((struct it
*));
640 static void next_overlay_string
P_ ((struct it
*));
641 void set_iterator_to_next
P_ ((struct it
*));
642 static void reseat
P_ ((struct it
*, struct text_pos
, int));
643 static void reseat_1
P_ ((struct it
*, struct text_pos
, int));
644 static void back_to_previous_visible_line_start
P_ ((struct it
*));
645 static void reseat_at_previous_visible_line_start
P_ ((struct it
*));
646 static void reseat_at_next_visible_line_start
P_ ((struct it
*, int));
647 static int next_element_from_display_vector
P_ ((struct it
*));
648 static int next_element_from_string
P_ ((struct it
*));
649 static int next_element_from_c_string
P_ ((struct it
*));
650 static int next_element_from_buffer
P_ ((struct it
*));
651 static int next_element_from_composition
P_ ((struct it
*));
652 static int next_element_from_image
P_ ((struct it
*));
653 static int next_element_from_stretch
P_ ((struct it
*));
654 static void load_overlay_strings
P_ ((struct it
*));
655 static void init_from_display_pos
P_ ((struct it
*, struct window
*,
656 struct display_pos
*));
657 static void reseat_to_string
P_ ((struct it
*, unsigned char *,
658 Lisp_Object
, int, int, int, int));
659 static int charset_at_position
P_ ((struct text_pos
));
660 static enum move_it_result move_it_in_display_line_to
P_ ((struct it
*,
662 void move_it_vertically_backward
P_ ((struct it
*, int));
663 static void init_to_row_start
P_ ((struct it
*, struct window
*,
664 struct glyph_row
*));
665 static void init_to_row_end
P_ ((struct it
*, struct window
*,
666 struct glyph_row
*));
667 static void back_to_previous_line_start
P_ ((struct it
*));
668 static void forward_to_next_line_start
P_ ((struct it
*));
669 static struct text_pos string_pos_nchars_ahead
P_ ((struct text_pos
,
671 static struct text_pos string_pos
P_ ((int, Lisp_Object
));
672 static struct text_pos c_string_pos
P_ ((int, unsigned char *, int));
673 static int number_of_chars
P_ ((unsigned char *, int));
674 static void compute_stop_pos
P_ ((struct it
*));
675 static void compute_string_pos
P_ ((struct text_pos
*, struct text_pos
,
677 static int face_before_or_after_it_pos
P_ ((struct it
*, int));
678 static int next_overlay_change
P_ ((int));
679 static int handle_single_display_prop
P_ ((struct it
*, Lisp_Object
,
680 Lisp_Object
, struct text_pos
*));
682 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
683 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
685 #ifdef HAVE_WINDOW_SYSTEM
687 static void update_tool_bar
P_ ((struct frame
*, int));
688 static void build_desired_tool_bar_string
P_ ((struct frame
*f
));
689 static int redisplay_tool_bar
P_ ((struct frame
*));
690 static void display_tool_bar_line
P_ ((struct it
*));
692 #endif /* HAVE_WINDOW_SYSTEM */
695 /***********************************************************************
696 Window display dimensions
697 ***********************************************************************/
699 /* Return the window-relative maximum y + 1 for glyph rows displaying
700 text in window W. This is the height of W minus the height of a
701 mode line, if any. */
704 window_text_bottom_y (w
)
707 struct frame
*f
= XFRAME (w
->frame
);
708 int height
= XFASTINT (w
->height
) * CANON_Y_UNIT (f
);
710 if (WINDOW_WANTS_MODELINE_P (w
))
711 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
716 /* Return the pixel width of display area AREA of window W. AREA < 0
717 means return the total width of W, not including bitmap areas to
718 the left and right of the window. */
721 window_box_width (w
, area
)
725 struct frame
*f
= XFRAME (w
->frame
);
726 int width
= XFASTINT (w
->width
);
728 if (!w
->pseudo_window_p
)
730 width
-= FRAME_SCROLL_BAR_WIDTH (f
) + FRAME_FLAGS_AREA_COLS (f
);
732 if (area
== TEXT_AREA
)
734 if (INTEGERP (w
->left_margin_width
))
735 width
-= XFASTINT (w
->left_margin_width
);
736 if (INTEGERP (w
->right_margin_width
))
737 width
-= XFASTINT (w
->right_margin_width
);
739 else if (area
== LEFT_MARGIN_AREA
)
740 width
= (INTEGERP (w
->left_margin_width
)
741 ? XFASTINT (w
->left_margin_width
) : 0);
742 else if (area
== RIGHT_MARGIN_AREA
)
743 width
= (INTEGERP (w
->right_margin_width
)
744 ? XFASTINT (w
->right_margin_width
) : 0);
747 return width
* CANON_X_UNIT (f
);
751 /* Return the pixel height of the display area of window W, not
752 including mode lines of W, if any.. */
755 window_box_height (w
)
758 struct frame
*f
= XFRAME (w
->frame
);
759 int height
= XFASTINT (w
->height
) * CANON_Y_UNIT (f
);
761 if (WINDOW_WANTS_MODELINE_P (w
))
762 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
764 if (WINDOW_WANTS_HEADER_LINE_P (w
))
765 height
-= CURRENT_HEADER_LINE_HEIGHT (w
);
771 /* Return the frame-relative coordinate of the left edge of display
772 area AREA of window W. AREA < 0 means return the left edge of the
773 whole window, to the right of any bitmap area at the left side of
777 window_box_left (w
, area
)
781 struct frame
*f
= XFRAME (w
->frame
);
782 int x
= FRAME_INTERNAL_BORDER_WIDTH_SAFE (f
);
784 if (!w
->pseudo_window_p
)
786 x
+= (WINDOW_LEFT_MARGIN (w
) * CANON_X_UNIT (f
)
787 + FRAME_LEFT_FLAGS_AREA_WIDTH (f
));
789 if (area
== TEXT_AREA
)
790 x
+= window_box_width (w
, LEFT_MARGIN_AREA
);
791 else if (area
== RIGHT_MARGIN_AREA
)
792 x
+= (window_box_width (w
, LEFT_MARGIN_AREA
)
793 + window_box_width (w
, TEXT_AREA
));
800 /* Return the frame-relative coordinate of the right edge of display
801 area AREA of window W. AREA < 0 means return the left edge of the
802 whole window, to the left of any bitmap area at the right side of
806 window_box_right (w
, area
)
810 return window_box_left (w
, area
) + window_box_width (w
, area
);
814 /* Get the bounding box of the display area AREA of window W, without
815 mode lines, in frame-relative coordinates. AREA < 0 means the
816 whole window, not including bitmap areas to the left and right of
817 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
818 coordinates of the upper-left corner of the box. Return in
819 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
822 window_box (w
, area
, box_x
, box_y
, box_width
, box_height
)
825 int *box_x
, *box_y
, *box_width
, *box_height
;
827 struct frame
*f
= XFRAME (w
->frame
);
829 *box_width
= window_box_width (w
, area
);
830 *box_height
= window_box_height (w
);
831 *box_x
= window_box_left (w
, area
);
832 *box_y
= (FRAME_INTERNAL_BORDER_WIDTH_SAFE (f
)
833 + XFASTINT (w
->top
) * CANON_Y_UNIT (f
));
834 if (WINDOW_WANTS_HEADER_LINE_P (w
))
835 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
839 /* Get the bounding box of the display area AREA of window W, without
840 mode lines. AREA < 0 means the whole window, not including bitmap
841 areas to the left and right of the window. Return in *TOP_LEFT_X
842 and TOP_LEFT_Y the frame-relative pixel coordinates of the
843 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
844 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
848 window_box_edges (w
, area
, top_left_x
, top_left_y
,
849 bottom_right_x
, bottom_right_y
)
852 int *top_left_x
, *top_left_y
, *bottom_right_x
, *bottom_right_y
;
854 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
856 *bottom_right_x
+= *top_left_x
;
857 *bottom_right_y
+= *top_left_y
;
862 /***********************************************************************
864 ***********************************************************************/
866 /* Return the next character from STR which is MAXLEN bytes long.
867 Return in *LEN the length of the character. This is like
868 STRING_CHAR_AND_LENGTH but never returns an invalid character. If
869 we find one, we return a `?', but with the length of the illegal
873 string_char_and_length (str
, maxlen
, len
)
879 c
= STRING_CHAR_AND_LENGTH (str
, maxlen
, *len
);
880 if (!CHAR_VALID_P (c
, 1))
881 /* We may not change the length here because other places in Emacs
882 don't use this function, i.e. they silently accept illegal
891 /* Given a position POS containing a valid character and byte position
892 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
894 static struct text_pos
895 string_pos_nchars_ahead (pos
, string
, nchars
)
900 xassert (STRINGP (string
) && nchars
>= 0);
902 if (STRING_MULTIBYTE (string
))
904 int rest
= STRING_BYTES (XSTRING (string
)) - BYTEPOS (pos
);
905 unsigned char *p
= XSTRING (string
)->data
+ BYTEPOS (pos
);
910 string_char_and_length (p
, rest
, &len
);
911 p
+= len
, rest
-= len
;
914 BYTEPOS (pos
) += len
;
918 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
924 /* Value is the text position, i.e. character and byte position,
925 for character position CHARPOS in STRING. */
927 static INLINE
struct text_pos
928 string_pos (charpos
, string
)
933 xassert (STRINGP (string
));
934 xassert (charpos
>= 0);
935 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
940 /* Value is a text position, i.e. character and byte position, for
941 character position CHARPOS in C string S. MULTIBYTE_P non-zero
942 means recognize multibyte characters. */
944 static struct text_pos
945 c_string_pos (charpos
, s
, multibyte_p
)
953 xassert (charpos
>= 0);
957 int rest
= strlen (s
), len
;
959 SET_TEXT_POS (pos
, 0, 0);
962 string_char_and_length (s
, rest
, &len
);
963 s
+= len
, rest
-= len
;
966 BYTEPOS (pos
) += len
;
970 SET_TEXT_POS (pos
, charpos
, charpos
);
976 /* Value is the number of characters in C string S. MULTIBYTE_P
977 non-zero means recognize multibyte characters. */
980 number_of_chars (s
, multibyte_p
)
988 int rest
= strlen (s
), len
;
989 unsigned char *p
= (unsigned char *) s
;
991 for (nchars
= 0; rest
> 0; ++nchars
)
993 string_char_and_length (p
, rest
, &len
);
994 rest
-= len
, p
+= len
;
1004 /* Compute byte position NEWPOS->bytepos corresponding to
1005 NEWPOS->charpos. POS is a known position in string STRING.
1006 NEWPOS->charpos must be >= POS.charpos. */
1009 compute_string_pos (newpos
, pos
, string
)
1010 struct text_pos
*newpos
, pos
;
1013 xassert (STRINGP (string
));
1014 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1016 if (STRING_MULTIBYTE (string
))
1017 *newpos
= string_pos_nchars_ahead (pos
, CHARPOS (*newpos
) - CHARPOS (pos
),
1020 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1024 /* Return the charset of the character at position POS in
1028 charset_at_position (pos
)
1029 struct text_pos pos
;
1032 unsigned char *p
= BYTE_POS_ADDR (BYTEPOS (pos
));
1034 multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
1037 int maxlen
= ((BYTEPOS (pos
) >= GPT_BYTE
? ZV_BYTE
: GPT_BYTE
)
1040 c
= string_char_and_length (p
, maxlen
, &len
);
1045 return CHAR_CHARSET (c
);
1050 /***********************************************************************
1051 Lisp form evaluation
1052 ***********************************************************************/
1054 /* Error handler for eval_form. */
1064 /* Evaluate SEXPR and return the result, or nil if something went
1071 int count
= specpdl_ptr
- specpdl
;
1073 specbind (Qinhibit_redisplay
, Qt
);
1074 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
, eval_handler
);
1075 return unbind_to (count
, val
);
1080 /***********************************************************************
1082 ***********************************************************************/
1086 /* Define CHECK_IT to perform sanity checks on iterators.
1087 This is for debugging. It is too slow to do unconditionally. */
1093 if (it
->method
== next_element_from_string
)
1095 xassert (STRINGP (it
->string
));
1096 xassert (IT_STRING_CHARPOS (*it
) >= 0);
1098 else if (it
->method
== next_element_from_buffer
)
1100 /* Check that character and byte positions agree. */
1101 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
1105 xassert (it
->current
.dpvec_index
>= 0);
1107 xassert (it
->current
.dpvec_index
< 0);
1110 #define CHECK_IT(IT) check_it ((IT))
1114 #define CHECK_IT(IT) (void) 0
1121 /* Check that the window end of window W is what we expect it
1122 to be---the last row in the current matrix displaying text. */
1125 check_window_end (w
)
1128 if (!MINI_WINDOW_P (w
)
1129 && !NILP (w
->window_end_valid
))
1131 struct glyph_row
*row
;
1132 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
1133 XFASTINT (w
->window_end_vpos
)),
1135 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
1136 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
1140 #define CHECK_WINDOW_END(W) check_window_end ((W))
1142 #else /* not GLYPH_DEBUG */
1144 #define CHECK_WINDOW_END(W) (void) 0
1146 #endif /* not GLYPH_DEBUG */
1150 /***********************************************************************
1151 Iterator initialization
1152 ***********************************************************************/
1154 /* Initialize IT for displaying current_buffer in window W, starting
1155 at character position CHARPOS. CHARPOS < 0 means that no buffer
1156 position is specified which is useful when the iterator is assigned
1157 a position later. BYTEPOS is the byte position corresponding to
1158 CHARPOS. BYTEPOS <= 0 means compute it from CHARPOS.
1160 If ROW is not null, calls to produce_glyphs with IT as parameter
1161 will produce glyphs in that row.
1163 BASE_FACE_ID is the id of a base face to use. It must be one of
1164 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID or
1165 HEADER_LINE_FACE_ID for displaying mode lines, or TOOL_BAR_FACE_ID for
1166 displaying the tool-bar.
1168 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID or
1169 HEADER_LINE_FACE_ID, the iterator will be initialized to use the
1170 corresponding mode line glyph row of the desired matrix of W. */
1173 init_iterator (it
, w
, charpos
, bytepos
, row
, base_face_id
)
1176 int charpos
, bytepos
;
1177 struct glyph_row
*row
;
1178 enum face_id base_face_id
;
1180 int highlight_region_p
;
1182 /* Some precondition checks. */
1183 xassert (w
!= NULL
&& it
!= NULL
);
1184 xassert (charpos
< 0 || (charpos
> 0 && charpos
<= ZV
));
1186 /* If face attributes have been changed since the last redisplay,
1187 free realized faces now because they depend on face definitions
1188 that might have changed. */
1189 if (face_change_count
)
1191 face_change_count
= 0;
1192 free_all_realized_faces (Qnil
);
1195 /* Use one of the mode line rows of W's desired matrix if
1199 if (base_face_id
== MODE_LINE_FACE_ID
)
1200 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
1201 else if (base_face_id
== HEADER_LINE_FACE_ID
)
1202 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
1206 bzero (it
, sizeof *it
);
1207 it
->current
.overlay_string_index
= -1;
1208 it
->current
.dpvec_index
= -1;
1209 it
->charset
= CHARSET_ASCII
;
1210 it
->base_face_id
= base_face_id
;
1212 /* The window in which we iterate over current_buffer: */
1213 XSETWINDOW (it
->window
, w
);
1215 it
->f
= XFRAME (w
->frame
);
1217 /* If realized faces have been removed, e.g. because of face
1218 attribute changes of named faces, recompute them. */
1219 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
1220 recompute_basic_faces (it
->f
);
1222 /* Current value of the `space-width', and 'height' properties. */
1223 it
->space_width
= Qnil
;
1224 it
->font_height
= Qnil
;
1226 /* Are control characters displayed as `^C'? */
1227 it
->ctl_arrow_p
= !NILP (current_buffer
->ctl_arrow
);
1229 /* -1 means everything between a CR and the following line end
1230 is invisible. >0 means lines indented more than this value are
1232 it
->selective
= (INTEGERP (current_buffer
->selective_display
)
1233 ? XFASTINT (current_buffer
->selective_display
)
1234 : (!NILP (current_buffer
->selective_display
)
1236 it
->selective_display_ellipsis_p
1237 = !NILP (current_buffer
->selective_display_ellipses
);
1239 /* Display table to use. */
1240 it
->dp
= window_display_table (w
);
1242 /* Are multibyte characters enabled in current_buffer? */
1243 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
1245 /* Non-zero if we should highlight the region. */
1247 = (!NILP (Vtransient_mark_mode
)
1248 && !NILP (current_buffer
->mark_active
)
1249 && XMARKER (current_buffer
->mark
)->buffer
!= 0);
1251 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
1252 start and end of a visible region in window IT->w. Set both to
1253 -1 to indicate no region. */
1254 if (highlight_region_p
1255 /* Maybe highlight only in selected window. */
1256 && (/* Either show region everywhere. */
1257 highlight_nonselected_windows
1258 /* Or show region in the selected window. */
1259 || w
== XWINDOW (selected_window
)
1260 /* Or show the region if we are in the mini-buffer and W is
1261 the window the mini-buffer refers to. */
1262 || (MINI_WINDOW_P (XWINDOW (selected_window
))
1263 && w
== XWINDOW (Vminibuf_scroll_window
))))
1265 int charpos
= marker_position (current_buffer
->mark
);
1266 it
->region_beg_charpos
= min (PT
, charpos
);
1267 it
->region_end_charpos
= max (PT
, charpos
);
1270 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
1272 /* Get the position at which the redisplay_end_trigger hook should
1273 be run, if it is to be run at all. */
1274 if (MARKERP (w
->redisplay_end_trigger
)
1275 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
1276 it
->redisplay_end_trigger_charpos
1277 = marker_position (w
->redisplay_end_trigger
);
1278 else if (INTEGERP (w
->redisplay_end_trigger
))
1279 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
1281 /* Correct bogus values of tab_width. */
1282 it
->tab_width
= XINT (current_buffer
->tab_width
);
1283 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
1286 /* Are lines in the display truncated? */
1287 it
->truncate_lines_p
1288 = (base_face_id
!= DEFAULT_FACE_ID
1289 || XINT (it
->w
->hscroll
)
1290 || (truncate_partial_width_windows
1291 && !WINDOW_FULL_WIDTH_P (it
->w
))
1292 || !NILP (current_buffer
->truncate_lines
));
1294 /* Get dimensions of truncation and continuation glyphs. These are
1295 displayed as bitmaps under X, so we don't need them for such
1297 if (!FRAME_WINDOW_P (it
->f
))
1299 if (it
->truncate_lines_p
)
1301 /* We will need the truncation glyph. */
1302 xassert (it
->glyph_row
== NULL
);
1303 produce_special_glyphs (it
, IT_TRUNCATION
);
1304 it
->truncation_pixel_width
= it
->pixel_width
;
1308 /* We will need the continuation glyph. */
1309 xassert (it
->glyph_row
== NULL
);
1310 produce_special_glyphs (it
, IT_CONTINUATION
);
1311 it
->continuation_pixel_width
= it
->pixel_width
;
1314 /* Reset these values to zero becaue the produce_special_glyphs
1315 above has changed them. */
1316 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
1317 it
->phys_ascent
= it
->phys_descent
= 0;
1320 /* Set this after getting the dimensions of truncation and
1321 continuation glyphs, so that we don't produce glyphs when calling
1322 produce_special_glyphs, above. */
1323 it
->glyph_row
= row
;
1324 it
->area
= TEXT_AREA
;
1326 /* Get the dimensions of the display area. The display area
1327 consists of the visible window area plus a horizontally scrolled
1328 part to the left of the window. All x-values are relative to the
1329 start of this total display area. */
1330 if (base_face_id
!= DEFAULT_FACE_ID
)
1332 /* Mode lines, menu bar in terminal frames. */
1333 it
->first_visible_x
= 0;
1334 it
->last_visible_x
= XFASTINT (w
->width
) * CANON_X_UNIT (it
->f
);
1339 = XFASTINT (it
->w
->hscroll
) * CANON_X_UNIT (it
->f
);
1340 it
->last_visible_x
= (it
->first_visible_x
1341 + window_box_width (w
, TEXT_AREA
));
1343 /* If we truncate lines, leave room for the truncator glyph(s) at
1344 the right margin. Otherwise, leave room for the continuation
1345 glyph(s). Truncation and continuation glyphs are not inserted
1346 for window-based redisplay. */
1347 if (!FRAME_WINDOW_P (it
->f
))
1349 if (it
->truncate_lines_p
)
1350 it
->last_visible_x
-= it
->truncation_pixel_width
;
1352 it
->last_visible_x
-= it
->continuation_pixel_width
;
1355 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
1356 it
->current_y
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
1359 /* Leave room for a border glyph. */
1360 if (!FRAME_WINDOW_P (it
->f
)
1361 && !WINDOW_RIGHTMOST_P (it
->w
))
1362 it
->last_visible_x
-= 1;
1364 it
->last_visible_y
= window_text_bottom_y (w
);
1366 /* For mode lines and alike, arrange for the first glyph having a
1367 left box line if the face specifies a box. */
1368 if (base_face_id
!= DEFAULT_FACE_ID
)
1372 it
->face_id
= base_face_id
;
1374 /* If we have a boxed mode line, make the first character appear
1375 with a left box line. */
1376 face
= FACE_FROM_ID (it
->f
, base_face_id
);
1377 if (face
->box
!= FACE_NO_BOX
)
1378 it
->start_of_box_run_p
= 1;
1381 /* If a buffer position was specified, set the iterator there,
1382 getting overlays and face properties from that position. */
1385 it
->end_charpos
= ZV
;
1387 IT_CHARPOS (*it
) = charpos
;
1389 /* Compute byte position if not specified. */
1391 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
1393 IT_BYTEPOS (*it
) = bytepos
;
1395 /* Compute faces etc. */
1396 reseat (it
, it
->current
.pos
, 1);
1403 /* Initialize IT for the display of window W with window start POS. */
1406 start_display (it
, w
, pos
)
1409 struct text_pos pos
;
1411 int start_at_line_beg_p
;
1412 struct glyph_row
*row
;
1413 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
1416 row
= w
->desired_matrix
->rows
+ first_vpos
;
1417 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
1418 first_y
= it
->current_y
;
1420 /* If window start is not at a line start, move back to the line
1421 start. This makes sure that we take continuation lines into
1423 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
1424 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
1425 if (!start_at_line_beg_p
)
1426 reseat_at_previous_visible_line_start (it
);
1428 /* If window start is not at a line start, skip forward to POS to
1429 get the correct continuation_lines_width and current_x. */
1430 if (!start_at_line_beg_p
)
1432 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
1434 /* If lines are continued, this line may end in the middle of a
1435 multi-glyph character (e.g. a control character displayed as
1436 \003, or in the middle of an overlay string). In this case
1437 move_it_to above will not have taken us to the start of
1438 the continuation line but to the end of the continued line. */
1439 if (!it
->truncate_lines_p
&& it
->current_x
> 0)
1441 if (it
->current
.dpvec_index
>= 0
1442 || it
->current
.overlay_string_index
>= 0)
1444 set_iterator_to_next (it
);
1445 move_it_in_display_line_to (it
, -1, -1, 0);
1447 it
->continuation_lines_width
+= it
->current_x
;
1450 it
->current_y
= first_y
;
1452 it
->current_x
= it
->hpos
= 0;
1455 #if 0 /* Don't assert the following because start_display is sometimes
1456 called intentionally with a window start that is not at a
1457 line start. Please leave this code in as a comment. */
1459 /* Window start should be on a line start, now. */
1460 xassert (it
->continuation_lines_width
1461 || IT_CHARPOS (it
) == BEGV
1462 || FETCH_BYTE (IT_BYTEPOS (it
) - 1) == '\n');
1467 /* Initialize IT for stepping through current_buffer in window W,
1468 starting at position POS that includes overlay string and display
1469 vector/ control character translation position information. */
1472 init_from_display_pos (it
, w
, pos
)
1475 struct display_pos
*pos
;
1477 /* Keep in mind: the call to reseat in init_iterator skips invisible
1478 text, so we might end up at a position different from POS. This
1479 is only a problem when POS is a row start after a newline and an
1480 overlay starts there with an after-string, and the overlay has an
1481 invisible property. Since we don't skip invisible text in
1482 display_line and elsewhere immediately after consuming the
1483 newline before the row start, such a POS will not be in a string,
1484 but the call to init_iterator below will move us to the
1486 init_iterator (it
, w
, CHARPOS (pos
->pos
), BYTEPOS (pos
->pos
),
1487 NULL
, DEFAULT_FACE_ID
);
1489 /* If position is within an overlay string, set up IT to
1490 the right overlay string. */
1491 if (pos
->overlay_string_index
>= 0)
1495 /* We already have the first chunk of overlay strings in
1496 IT->overlay_strings. Load more until the one for
1497 pos->overlay_string_index is in IT->overlay_strings. */
1498 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
1500 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
1501 it
->current
.overlay_string_index
= 0;
1504 load_overlay_strings (it
);
1505 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
1509 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
1510 relative_index
= (it
->current
.overlay_string_index
1511 % OVERLAY_STRING_CHUNK_SIZE
);
1512 it
->string
= it
->overlay_strings
[relative_index
];
1513 it
->current
.string_pos
= pos
->string_pos
;
1514 it
->method
= next_element_from_string
;
1516 else if (CHARPOS (pos
->string_pos
) >= 0)
1518 /* Recorded position is not in an overlay string, but in another
1519 string. This can only be a string from a `display' property.
1520 IT should already be filled with that string. */
1521 it
->current
.string_pos
= pos
->string_pos
;
1522 xassert (STRINGP (it
->string
));
1525 /* Restore position in display vector translations or control
1526 character translations. */
1527 if (pos
->dpvec_index
>= 0)
1529 /* This fills IT->dpvec. */
1530 get_next_display_element (it
);
1531 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
1532 it
->current
.dpvec_index
= pos
->dpvec_index
;
1539 /* Initialize IT for stepping through current_buffer in window W
1540 starting at ROW->start. */
1543 init_to_row_start (it
, w
, row
)
1546 struct glyph_row
*row
;
1548 init_from_display_pos (it
, w
, &row
->start
);
1549 it
->continuation_lines_width
= row
->continuation_lines_width
;
1554 /* Initialize IT for stepping through current_buffer in window W
1555 starting in the line following ROW, i.e. starting at ROW->end. */
1558 init_to_row_end (it
, w
, row
)
1561 struct glyph_row
*row
;
1563 init_from_display_pos (it
, w
, &row
->end
);
1565 if (row
->continued_p
)
1566 it
->continuation_lines_width
= (row
->continuation_lines_width
1567 + row
->pixel_width
);
1574 /***********************************************************************
1576 ***********************************************************************/
1578 /* Called when IT reaches IT->stop_charpos. Handle text property and
1579 overlay changes. Set IT->stop_charpos to the next position where
1586 enum prop_handled handled
;
1587 int handle_overlay_change_p
= 1;
1591 it
->current
.dpvec_index
= -1;
1595 handled
= HANDLED_NORMALLY
;
1597 /* Call text property handlers. */
1598 for (p
= it_props
; p
->handler
; ++p
)
1600 handled
= p
->handler (it
);
1602 if (handled
== HANDLED_RECOMPUTE_PROPS
)
1604 else if (handled
== HANDLED_RETURN
)
1606 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
1607 handle_overlay_change_p
= 0;
1610 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
1612 /* Don't check for overlay strings below when set to deliver
1613 characters from a display vector. */
1614 if (it
->method
== next_element_from_display_vector
)
1615 handle_overlay_change_p
= 0;
1617 /* Handle overlay changes. */
1618 if (handle_overlay_change_p
)
1619 handled
= handle_overlay_change (it
);
1621 /* Determine where to stop next. */
1622 if (handled
== HANDLED_NORMALLY
)
1623 compute_stop_pos (it
);
1626 while (handled
== HANDLED_RECOMPUTE_PROPS
);
1630 /* Compute IT->stop_charpos from text property and overlay change
1631 information for IT's current position. */
1634 compute_stop_pos (it
)
1637 register INTERVAL iv
, next_iv
;
1638 Lisp_Object object
, limit
, position
;
1640 /* If nowhere else, stop at the end. */
1641 it
->stop_charpos
= it
->end_charpos
;
1643 if (STRINGP (it
->string
))
1645 /* Strings are usually short, so don't limit the search for
1647 object
= it
->string
;
1649 XSETFASTINT (position
, IT_STRING_CHARPOS (*it
));
1655 /* If next overlay change is in front of the current stop pos
1656 (which is IT->end_charpos), stop there. Note: value of
1657 next_overlay_change is point-max if no overlay change
1659 charpos
= next_overlay_change (IT_CHARPOS (*it
));
1660 if (charpos
< it
->stop_charpos
)
1661 it
->stop_charpos
= charpos
;
1663 /* If showing the region, we have to stop at the region
1664 start or end because the face might change there. */
1665 if (it
->region_beg_charpos
> 0)
1667 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
1668 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
1669 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
1670 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
1673 /* Set up variables for computing the stop position from text
1674 property changes. */
1675 XSETBUFFER (object
, current_buffer
);
1676 XSETFASTINT (limit
, IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
1677 XSETFASTINT (position
, IT_CHARPOS (*it
));
1681 /* Get the interval containing IT's position. Value is a null
1682 interval if there isn't such an interval. */
1683 iv
= validate_interval_range (object
, &position
, &position
, 0);
1684 if (!NULL_INTERVAL_P (iv
))
1686 Lisp_Object values_here
[LAST_PROP_IDX
];
1689 /* Get properties here. */
1690 for (p
= it_props
; p
->handler
; ++p
)
1691 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
1693 /* Look for an interval following iv that has different
1695 for (next_iv
= next_interval (iv
);
1696 (!NULL_INTERVAL_P (next_iv
)
1698 || XFASTINT (limit
) > next_iv
->position
));
1699 next_iv
= next_interval (next_iv
))
1701 for (p
= it_props
; p
->handler
; ++p
)
1703 Lisp_Object new_value
;
1705 new_value
= textget (next_iv
->plist
, *p
->name
);
1706 if (!EQ (values_here
[p
->idx
], new_value
))
1714 if (!NULL_INTERVAL_P (next_iv
))
1716 if (INTEGERP (limit
)
1717 && next_iv
->position
>= XFASTINT (limit
))
1718 /* No text property change up to limit. */
1719 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
1721 /* Text properties change in next_iv. */
1722 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
1726 xassert (STRINGP (it
->string
)
1727 || (it
->stop_charpos
>= BEGV
1728 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
1732 /* Return the position of the next overlay change after POS in
1733 current_buffer. Value is point-max if no overlay change
1734 follows. This is like `next-overlay-change' but doesn't use
1738 next_overlay_change (pos
)
1743 Lisp_Object
*overlays
;
1747 /* Get all overlays at the given position. */
1749 overlays
= (Lisp_Object
*) alloca (len
* sizeof *overlays
);
1750 noverlays
= overlays_at (pos
, 0, &overlays
, &len
, &endpos
, NULL
);
1751 if (noverlays
> len
)
1754 overlays
= (Lisp_Object
*) alloca (len
* sizeof *overlays
);
1755 noverlays
= overlays_at (pos
, 0, &overlays
, &len
, &endpos
, NULL
);
1758 /* If any of these overlays ends before endpos,
1759 use its ending point instead. */
1760 for (i
= 0; i
< noverlays
; ++i
)
1765 oend
= OVERLAY_END (overlays
[i
]);
1766 oendpos
= OVERLAY_POSITION (oend
);
1767 endpos
= min (endpos
, oendpos
);
1775 /***********************************************************************
1777 ***********************************************************************/
1779 /* Handle changes in the `fontified' property of the current buffer by
1780 calling hook functions from Qfontification_functions to fontify
1783 static enum prop_handled
1784 handle_fontified_prop (it
)
1787 Lisp_Object prop
, pos
;
1788 enum prop_handled handled
= HANDLED_NORMALLY
;
1789 struct gcpro gcpro1
;
1791 /* Get the value of the `fontified' property at IT's current buffer
1792 position. (The `fontified' property doesn't have a special
1793 meaning in strings.) If the value is nil, call functions from
1794 Qfontification_functions. */
1795 if (!STRINGP (it
->string
)
1797 && !NILP (Vfontification_functions
)
1798 && (pos
= make_number (IT_CHARPOS (*it
)),
1799 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
1802 Lisp_Object args
[2];
1805 /* Run the hook functions. */
1806 args
[0] = Qfontification_functions
;
1808 Frun_hook_with_args (make_number (2), args
);
1810 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
1811 something. This avoids an endless loop if they failed to
1812 fontify the text for which reason ever. */
1813 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
1814 handled
= HANDLED_RECOMPUTE_PROPS
;
1823 /***********************************************************************
1825 ***********************************************************************/
1827 /* Set up iterator IT from face properties at its current position.
1828 Called from handle_stop. */
1830 static enum prop_handled
1831 handle_face_prop (it
)
1834 int new_face_id
, next_stop
;
1836 if (!STRINGP (it
->string
))
1839 = face_at_buffer_position (it
->w
,
1841 it
->region_beg_charpos
,
1842 it
->region_end_charpos
,
1845 + TEXT_PROP_DISTANCE_LIMIT
),
1848 /* Is this a start of a run of characters with box face?
1849 Caveat: this can be called for a freshly initialized
1850 iterator; face_id is -1 is this case. We know that the new
1851 face will not change until limit, i.e. if the new face has a
1852 box, all characters up to limit will have one. But, as
1853 usual, we don't know whether limit is really the end. */
1854 if (new_face_id
!= it
->face_id
)
1856 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
1858 /* If new face has a box but old face has not, this is
1859 the start of a run of characters with box, i.e. it has
1860 a shadow on the left side. The value of face_id of the
1861 iterator will be -1 if this is the initial call that gets
1862 the face. In this case, we have to look in front of IT's
1863 position and see whether there is a face != new_face_id. */
1864 it
->start_of_box_run_p
1865 = (new_face
->box
!= FACE_NO_BOX
1866 && (it
->face_id
>= 0
1867 || IT_CHARPOS (*it
) == BEG
1868 || new_face_id
!= face_before_it_pos (it
)));
1869 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
1875 = face_at_string_position (it
->w
,
1877 IT_STRING_CHARPOS (*it
),
1878 (it
->current
.overlay_string_index
>= 0
1881 it
->region_beg_charpos
,
1882 it
->region_end_charpos
,
1886 #if 0 /* This shouldn't be neccessary. Let's check it. */
1887 /* If IT is used to display a mode line we would really like to
1888 use the mode line face instead of the frame's default face. */
1889 if (it
->glyph_row
== MATRIX_MODE_LINE_ROW (it
->w
->desired_matrix
)
1890 && new_face_id
== DEFAULT_FACE_ID
)
1891 new_face_id
= MODE_LINE_FACE_ID
;
1894 /* Is this a start of a run of characters with box? Caveat:
1895 this can be called for a freshly allocated iterator; face_id
1896 is -1 is this case. We know that the new face will not
1897 change until the next check pos, i.e. if the new face has a
1898 box, all characters up to that position will have a
1899 box. But, as usual, we don't know whether that position
1900 is really the end. */
1901 if (new_face_id
!= it
->face_id
)
1903 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
1904 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
1906 /* If new face has a box but old face hasn't, this is the
1907 start of a run of characters with box, i.e. it has a
1908 shadow on the left side. */
1909 it
->start_of_box_run_p
1910 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
1911 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
1915 it
->face_id
= new_face_id
;
1916 it
->charset
= CHARSET_ASCII
;
1917 return HANDLED_NORMALLY
;
1921 /* Compute the face one character before or after the current position
1922 of IT. BEFORE_P non-zero means get the face in front of IT's
1923 position. Value is the id of the face. */
1926 face_before_or_after_it_pos (it
, before_p
)
1931 int next_check_charpos
;
1932 struct text_pos pos
;
1934 xassert (it
->s
== NULL
);
1936 if (STRINGP (it
->string
))
1938 /* No face change past the end of the string (for the case
1939 we are padding with spaces). No face change before the
1941 if (IT_STRING_CHARPOS (*it
) >= XSTRING (it
->string
)->size
1942 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
1945 /* Set pos to the position before or after IT's current position. */
1947 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
1949 /* For composition, we must check the character after the
1951 pos
= (it
->what
== IT_COMPOSITION
1952 ? string_pos (IT_STRING_CHARPOS (*it
) + it
->cmp_len
, it
->string
)
1953 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
1955 /* Get the face for ASCII, or unibyte. */
1957 = face_at_string_position (it
->w
,
1960 (it
->current
.overlay_string_index
>= 0
1963 it
->region_beg_charpos
,
1964 it
->region_end_charpos
,
1965 &next_check_charpos
,
1968 /* Correct the face for charsets different from ASCII. Do it
1969 for the multibyte case only. The face returned above is
1970 suitable for unibyte text if IT->string is unibyte. */
1971 if (STRING_MULTIBYTE (it
->string
))
1973 unsigned char *p
= XSTRING (it
->string
)->data
+ BYTEPOS (pos
);
1974 int rest
= STRING_BYTES (XSTRING (it
->string
)) - BYTEPOS (pos
);
1975 int c
, len
, charset
;
1977 c
= string_char_and_length (p
, rest
, &len
);
1978 charset
= CHAR_CHARSET (c
);
1979 if (charset
!= CHARSET_ASCII
)
1980 face_id
= FACE_FOR_CHARSET (it
->f
, face_id
, charset
);
1985 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
1986 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
1989 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
1990 pos
= it
->current
.pos
;
1996 if (it
->what
== IT_COMPOSITION
)
1997 /* For composition, we must check the position after the
1999 pos
.charpos
+= it
->cmp_len
, pos
.bytepos
+= it
->len
;
2003 /* Determine face for CHARSET_ASCII, or unibyte. */
2004 face_id
= face_at_buffer_position (it
->w
,
2006 it
->region_beg_charpos
,
2007 it
->region_end_charpos
,
2008 &next_check_charpos
,
2011 /* Correct the face for charsets different from ASCII. Do it
2012 for the multibyte case only. The face returned above is
2013 suitable for unibyte text if current_buffer is unibyte. */
2014 if (it
->multibyte_p
)
2016 int charset
= charset_at_position (pos
);
2017 if (charset
!= CHARSET_ASCII
)
2018 face_id
= FACE_FOR_CHARSET (it
->f
, face_id
, charset
);
2027 /***********************************************************************
2029 ***********************************************************************/
2031 /* Set up iterator IT from invisible properties at its current
2032 position. Called from handle_stop. */
2034 static enum prop_handled
2035 handle_invisible_prop (it
)
2038 enum prop_handled handled
= HANDLED_NORMALLY
;
2040 if (STRINGP (it
->string
))
2042 extern Lisp_Object Qinvisible
;
2043 Lisp_Object prop
, end_charpos
, limit
, charpos
;
2045 /* Get the value of the invisible text property at the
2046 current position. Value will be nil if there is no such
2048 XSETFASTINT (charpos
, IT_STRING_CHARPOS (*it
));
2049 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
2053 handled
= HANDLED_RECOMPUTE_PROPS
;
2055 /* Get the position at which the next change of the
2056 invisible text property can be found in IT->string.
2057 Value will be nil if the property value is the same for
2058 all the rest of IT->string. */
2059 XSETINT (limit
, XSTRING (it
->string
)->size
);
2060 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
2063 /* Text at current position is invisible. The next
2064 change in the property is at position end_charpos.
2065 Move IT's current position to that position. */
2066 if (INTEGERP (end_charpos
)
2067 && XFASTINT (end_charpos
) < XFASTINT (limit
))
2069 struct text_pos old
;
2070 old
= it
->current
.string_pos
;
2071 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
2072 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
2076 /* The rest of the string is invisible. If this is an
2077 overlay string, proceed with the next overlay string
2078 or whatever comes and return a character from there. */
2079 if (it
->current
.overlay_string_index
>= 0)
2081 next_overlay_string (it
);
2082 /* Don't check for overlay strings when we just
2083 finished processing them. */
2084 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
2088 struct Lisp_String
*s
= XSTRING (it
->string
);
2089 IT_STRING_CHARPOS (*it
) = s
->size
;
2090 IT_STRING_BYTEPOS (*it
) = STRING_BYTES (s
);
2097 int visible_p
, newpos
, next_stop
;
2098 Lisp_Object pos
, prop
;
2100 /* First of all, is there invisible text at this position? */
2101 XSETFASTINT (pos
, IT_CHARPOS (*it
));
2102 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
2104 /* If we are on invisible text, skip over it. */
2105 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
2107 /* Record whether we have to display an ellipsis for the
2109 int display_ellipsis_p
2110 = TEXT_PROP_MEANS_INVISIBLE_WITH_ELLIPSIS (prop
);
2112 handled
= HANDLED_RECOMPUTE_PROPS
;
2114 /* Loop skipping over invisible text. The loop is left at
2115 ZV or with IT on the first char being visible again. */
2118 /* Try to skip some invisible text. Return value is the
2119 position reached which can be equal to IT's position
2120 if there is nothing invisible here. This skips both
2121 over invisible text properties and overlays with
2122 invisible property. */
2123 newpos
= skip_invisible (IT_CHARPOS (*it
),
2124 &next_stop
, ZV
, it
->window
);
2126 /* If we skipped nothing at all we weren't at invisible
2127 text in the first place. If everything to the end of
2128 the buffer was skipped, end the loop. */
2129 if (newpos
== IT_CHARPOS (*it
) || newpos
>= ZV
)
2133 /* We skipped some characters but not necessarily
2134 all there are. Check if we ended up on visible
2135 text. Fget_char_property returns the property of
2136 the char before the given position, i.e. if we
2137 get visible_p = 1, this means that the char at
2138 newpos is visible. */
2139 XSETFASTINT (pos
, newpos
);
2140 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
2141 visible_p
= !TEXT_PROP_MEANS_INVISIBLE (prop
);
2144 /* If we ended up on invisible text, proceed to
2145 skip starting with next_stop. */
2147 IT_CHARPOS (*it
) = next_stop
;
2151 /* The position newpos is now either ZV or on visible text. */
2152 IT_CHARPOS (*it
) = newpos
;
2153 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
2155 /* Maybe return `...' next for the end of the invisible text. */
2156 if (display_ellipsis_p
)
2159 && VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
2161 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
2162 it
->dpvec
= v
->contents
;
2163 it
->dpend
= v
->contents
+ v
->size
;
2167 /* Default `...'. */
2168 it
->dpvec
= default_invis_vector
;
2169 it
->dpend
= default_invis_vector
+ 3;
2172 /* The ellipsis display does not replace the display of
2173 the character at the new position. Indicate this by
2174 setting IT->dpvec_char_len to zero. */
2175 it
->dpvec_char_len
= 0;
2177 it
->current
.dpvec_index
= 0;
2178 it
->method
= next_element_from_display_vector
;
2188 /***********************************************************************
2190 ***********************************************************************/
2192 /* Set up iterator IT from `display' property at its current position.
2193 Called from handle_stop. */
2195 static enum prop_handled
2196 handle_display_prop (it
)
2199 Lisp_Object prop
, object
;
2200 struct text_pos
*position
;
2201 int space_or_image_found_p
;
2203 if (STRINGP (it
->string
))
2205 object
= it
->string
;
2206 position
= &it
->current
.string_pos
;
2211 position
= &it
->current
.pos
;
2214 /* Reset those iterator values set from display property values. */
2215 it
->font_height
= Qnil
;
2216 it
->space_width
= Qnil
;
2219 /* We don't support recursive `display' properties, i.e. string
2220 values that have a string `display' property, that have a string
2221 `display' property etc. */
2222 if (!it
->string_from_display_prop_p
)
2223 it
->area
= TEXT_AREA
;
2225 prop
= Fget_char_property (make_number (position
->charpos
),
2228 return HANDLED_NORMALLY
;
2230 space_or_image_found_p
= 0;
2232 && CONSP (XCAR (prop
))
2233 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
2235 /* A list of sub-properties. */
2236 while (CONSP (prop
))
2238 if (handle_single_display_prop (it
, XCAR (prop
), object
, position
))
2239 space_or_image_found_p
= 1;
2243 else if (VECTORP (prop
))
2246 for (i
= 0; i
< XVECTOR (prop
)->size
; ++i
)
2247 if (handle_single_display_prop (it
, XVECTOR (prop
)->contents
[i
],
2249 space_or_image_found_p
= 1;
2253 if (handle_single_display_prop (it
, prop
, object
, position
))
2254 space_or_image_found_p
= 1;
2257 return space_or_image_found_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
2261 /* Value is the position of the end of the `display' property starting
2262 at START_POS in OBJECT. */
2264 static struct text_pos
2265 display_prop_end (it
, object
, start_pos
)
2268 struct text_pos start_pos
;
2271 struct text_pos end_pos
;
2273 end
= next_single_char_property_change (make_number (CHARPOS (start_pos
)),
2274 Qdisplay
, object
, Qnil
);
2275 CHARPOS (end_pos
) = XFASTINT (end
);
2276 if (STRINGP (object
))
2277 compute_string_pos (&end_pos
, start_pos
, it
->string
);
2279 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
2285 /* Set up IT from a single `display' sub-property value PROP. OBJECT
2286 is the object in which the `display' property was found. *POSITION
2287 is the position at which it was found.
2289 If PROP is a `space' or `image' sub-property, set *POSITION to the
2290 end position of the `display' property.
2292 Value is non-zero if a `space' or `image' property value was found. */
2295 handle_single_display_prop (it
, prop
, object
, position
)
2299 struct text_pos
*position
;
2302 int space_or_image_found_p
= 0;
2306 /* If PROP is a list of the form `(when FORM . VALUE)', FORM is
2307 evaluated. If the result is nil, VALUE is ignored. */
2309 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
2318 if (!NILP (form
) && !EQ (form
, Qt
))
2320 struct gcpro gcpro1
;
2321 struct text_pos end_pos
, pt
;
2323 end_pos
= display_prop_end (it
, object
, *position
);
2326 /* Temporarily set point to the end position, and then evaluate
2327 the form. This makes `(eolp)' work as FORM. */
2329 BYTEPOS (pt
) = PT_BYTE
;
2330 TEMP_SET_PT_BOTH (CHARPOS (end_pos
), BYTEPOS (end_pos
));
2331 form
= eval_form (form
);
2332 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
2340 && EQ (XCAR (prop
), Qheight
)
2341 && CONSP (XCDR (prop
)))
2343 if (FRAME_TERMCAP_P (it
->f
) || FRAME_MSDOS_P (it
->f
))
2346 /* `(height HEIGHT)'. */
2347 it
->font_height
= XCAR (XCDR (prop
));
2348 if (!NILP (it
->font_height
))
2350 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
2351 int new_height
= -1;
2353 if (CONSP (it
->font_height
)
2354 && (EQ (XCAR (it
->font_height
), Qplus
)
2355 || EQ (XCAR (it
->font_height
), Qminus
))
2356 && CONSP (XCDR (it
->font_height
))
2357 && INTEGERP (XCAR (XCDR (it
->font_height
))))
2359 /* `(+ N)' or `(- N)' where N is an integer. */
2360 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
2361 if (EQ (XCAR (it
->font_height
), Qplus
))
2363 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
2365 else if (SYMBOLP (it
->font_height
))
2367 /* Call function with current height as argument.
2368 Value is the new height. */
2369 Lisp_Object form
, height
;
2370 struct gcpro gcpro1
;
2372 height
= face
->lface
[LFACE_HEIGHT_INDEX
];
2373 form
= Fcons (it
->font_height
, Fcons (height
, Qnil
));
2375 height
= eval_form (form
);
2376 if (NUMBERP (height
))
2377 new_height
= XFLOATINT (height
);
2380 else if (NUMBERP (it
->font_height
))
2382 /* Value is a multiple of the canonical char height. */
2385 face
= FACE_FROM_ID (it
->f
, DEFAULT_FACE_ID
);
2386 new_height
= (XFLOATINT (it
->font_height
)
2387 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
2391 /* Evaluate IT->font_height with `height' bound to the
2392 current specified height to get the new height. */
2394 int count
= specpdl_ptr
- specpdl
;
2396 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
2397 value
= eval_form (it
->font_height
);
2398 unbind_to (count
, Qnil
);
2400 if (NUMBERP (value
))
2401 new_height
= XFLOATINT (value
);
2405 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
2408 else if (CONSP (prop
)
2409 && EQ (XCAR (prop
), Qspace_width
)
2410 && CONSP (XCDR (prop
)))
2412 /* `(space_width WIDTH)'. */
2413 if (FRAME_TERMCAP_P (it
->f
) || FRAME_MSDOS_P (it
->f
))
2416 value
= XCAR (XCDR (prop
));
2417 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
2418 it
->space_width
= value
;
2420 else if (CONSP (prop
)
2421 && EQ (XCAR (prop
), Qraise
)
2422 && CONSP (XCDR (prop
)))
2424 /* `(raise FACTOR)'. */
2425 if (FRAME_TERMCAP_P (it
->f
) || FRAME_MSDOS_P (it
->f
))
2428 #ifdef HAVE_WINDOW_SYSTEM
2429 value
= XCAR (XCDR (prop
));
2430 if (NUMBERP (value
))
2432 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
2433 it
->voffset
= - (XFLOATINT (value
)
2434 * (face
->font
->ascent
+ face
->font
->descent
));
2436 #endif /* HAVE_WINDOW_SYSTEM */
2438 else if (!it
->string_from_display_prop_p
)
2440 /* `((margin left-margin) VALUE)' or `((margin right-margin)
2441 VALUE) or `((margin nil) VALUE)' or VALUE. */
2442 Lisp_Object location
, value
;
2443 struct text_pos start_pos
;
2446 /* Characters having this form of property are not displayed, so
2447 we have to find the end of the property. */
2448 space_or_image_found_p
= 1;
2449 start_pos
= *position
;
2450 *position
= display_prop_end (it
, object
, start_pos
);
2452 /* Let's stop at the new position and assume that all
2453 text properties change there. */
2454 it
->stop_charpos
= position
->charpos
;
2456 location
= Qunbound
;
2457 if (CONSP (prop
) && CONSP (XCAR (prop
)))
2461 value
= XCDR (prop
);
2463 value
= XCAR (value
);
2466 if (EQ (XCAR (tem
), Qmargin
)
2467 && (tem
= XCDR (tem
),
2468 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
2470 || EQ (tem
, Qleft_margin
)
2471 || EQ (tem
, Qright_margin
))))
2475 if (EQ (location
, Qunbound
))
2481 #ifdef HAVE_WINDOW_SYSTEM
2482 if (FRAME_TERMCAP_P (it
->f
))
2483 valid_p
= STRINGP (value
);
2485 valid_p
= (STRINGP (value
)
2486 || (CONSP (value
) && EQ (XCAR (value
), Qspace
))
2487 || valid_image_p (value
));
2488 #else /* not HAVE_WINDOW_SYSTEM */
2489 valid_p
= STRINGP (value
);
2490 #endif /* not HAVE_WINDOW_SYSTEM */
2492 if ((EQ (location
, Qleft_margin
)
2493 || EQ (location
, Qright_margin
)
2497 /* Save current settings of IT so that we can restore them
2498 when we are finished with the glyph property value. */
2501 if (NILP (location
))
2502 it
->area
= TEXT_AREA
;
2503 else if (EQ (location
, Qleft_margin
))
2504 it
->area
= LEFT_MARGIN_AREA
;
2506 it
->area
= RIGHT_MARGIN_AREA
;
2508 if (STRINGP (value
))
2511 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
2512 it
->current
.overlay_string_index
= -1;
2513 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
2514 it
->end_charpos
= it
->string_nchars
2515 = XSTRING (it
->string
)->size
;
2516 it
->method
= next_element_from_string
;
2517 it
->stop_charpos
= 0;
2518 it
->string_from_display_prop_p
= 1;
2520 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
2522 it
->method
= next_element_from_stretch
;
2524 it
->current
.pos
= it
->position
= start_pos
;
2526 #ifdef HAVE_WINDOW_SYSTEM
2529 it
->what
= IT_IMAGE
;
2530 it
->image_id
= lookup_image (it
->f
, value
);
2531 it
->position
= start_pos
;
2532 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
2533 it
->method
= next_element_from_image
;
2535 /* Say that we don't have consumed the characters with
2536 `display' property yet. The call to pop_it in
2537 set_iterator_to_next will clean this up. */
2538 *position
= start_pos
;
2540 #endif /* HAVE_WINDOW_SYSTEM */
2544 return space_or_image_found_p
;
2549 /***********************************************************************
2550 `composition' property
2551 ***********************************************************************/
2553 /* Set up iterator IT from `composition' property at its current
2554 position. Called from handle_stop. */
2556 static enum prop_handled
2557 handle_composition_prop (it
)
2560 Lisp_Object prop
, string
;
2561 int pos
, pos_byte
, end
;
2562 enum prop_handled handled
= HANDLED_NORMALLY
;
2564 if (STRINGP (it
->string
))
2566 pos
= IT_STRING_CHARPOS (*it
);
2567 pos_byte
= IT_STRING_BYTEPOS (*it
);
2568 string
= it
->string
;
2572 pos
= IT_CHARPOS (*it
);
2573 pos_byte
= IT_BYTEPOS (*it
);
2577 /* If there's a valid composition and point is not inside of the
2578 composition (in the case that the composition is from the current
2579 buffer), draw a glyph composed from the composition components. */
2580 if (find_composition (pos
, -1, &pos
, &end
, &prop
, string
)
2581 && COMPOSITION_VALID_P (pos
, end
, prop
)
2582 && (STRINGP (it
->string
) || (PT
<= pos
|| PT
>= end
)))
2584 int id
= get_composition_id (pos
, pos_byte
, end
- pos
, prop
, string
);
2588 it
->method
= next_element_from_composition
;
2590 it
->cmp_len
= COMPOSITION_LENGTH (prop
);
2591 /* For a terminal, draw only the first character of the
2593 it
->c
= COMPOSITION_GLYPH (composition_table
[id
], 0);
2594 it
->len
= (STRINGP (it
->string
)
2595 ? string_char_to_byte (it
->string
, end
)
2596 : CHAR_TO_BYTE (end
)) - pos_byte
;
2597 it
->stop_charpos
= end
;
2598 handled
= HANDLED_RETURN
;
2607 /***********************************************************************
2609 ***********************************************************************/
2611 /* The following structure is used to record overlay strings for
2612 later sorting in load_overlay_strings. */
2614 struct overlay_entry
2622 /* Set up iterator IT from overlay strings at its current position.
2623 Called from handle_stop. */
2625 static enum prop_handled
2626 handle_overlay_change (it
)
2629 /* Overlays are handled in current_buffer only. */
2630 if (STRINGP (it
->string
))
2631 return HANDLED_NORMALLY
;
2633 return (get_overlay_strings (it
)
2634 ? HANDLED_RECOMPUTE_PROPS
2635 : HANDLED_NORMALLY
);
2639 /* Set up the next overlay string for delivery by IT, if there is an
2640 overlay string to deliver. Called by set_iterator_to_next when the
2641 end of the current overlay string is reached. If there are more
2642 overlay strings to display, IT->string and
2643 IT->current.overlay_string_index are set appropriately here.
2644 Otherwise IT->string is set to nil. */
2647 next_overlay_string (it
)
2650 ++it
->current
.overlay_string_index
;
2651 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
2653 /* No more overlay strings. Restore IT's settings to what
2654 they were before overlay strings were processed, and
2655 continue to deliver from current_buffer. */
2657 xassert (it
->stop_charpos
>= BEGV
2658 && it
->stop_charpos
<= it
->end_charpos
);
2660 it
->current
.overlay_string_index
= -1;
2661 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
2662 it
->n_overlay_strings
= 0;
2663 it
->method
= next_element_from_buffer
;
2667 /* There are more overlay strings to process. If
2668 IT->current.overlay_string_index has advanced to a position
2669 where we must load IT->overlay_strings with more strings, do
2671 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
2673 if (it
->current
.overlay_string_index
&& i
== 0)
2674 load_overlay_strings (it
);
2676 /* Initialize IT to deliver display elements from the overlay
2678 it
->string
= it
->overlay_strings
[i
];
2679 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
2680 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
2681 it
->method
= next_element_from_string
;
2682 it
->stop_charpos
= 0;
2689 /* Compare two overlay_entry structures E1 and E2. Used as a
2690 comparison function for qsort in load_overlay_strings. Overlay
2691 strings for the same position are sorted so that
2693 1. All after-strings come in front of before-strings.
2695 2. Within after-strings, strings are sorted so that overlay strings
2696 from overlays with higher priorities come first.
2698 2. Within before-strings, strings are sorted so that overlay
2699 strings from overlays with higher priorities come last.
2701 Value is analogous to strcmp. */
2705 compare_overlay_entries (e1
, e2
)
2708 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
2709 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
2712 if (entry1
->after_string_p
!= entry2
->after_string_p
)
2713 /* Let after-strings appear in front of before-strings. */
2714 result
= entry1
->after_string_p
? -1 : 1;
2715 else if (entry1
->after_string_p
)
2716 /* After-strings sorted in order of decreasing priority. */
2717 result
= entry2
->priority
- entry1
->priority
;
2719 /* Before-strings sorted in order of increasing priority. */
2720 result
= entry1
->priority
- entry2
->priority
;
2726 /* Load the vector IT->overlay_strings with overlay strings from IT's
2727 current buffer position. Set IT->n_overlays to the total number of
2728 overlay strings found.
2730 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
2731 a time. On entry into load_overlay_strings,
2732 IT->current.overlay_string_index gives the number of overlay
2733 strings that have already been loaded by previous calls to this
2736 Overlay strings are sorted so that after-string strings come in
2737 front of before-string strings. Within before and after-strings,
2738 strings are sorted by overlay priority. See also function
2739 compare_overlay_entries. */
2742 load_overlay_strings (it
)
2745 extern Lisp_Object Qafter_string
, Qbefore_string
, Qwindow
, Qpriority
;
2746 Lisp_Object ov
, overlay
, window
, str
;
2750 struct overlay_entry
*entries
2751 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
2753 /* Append the overlay string STRING of overlay OVERLAY to vector
2754 `entries' which has size `size' and currently contains `n'
2755 elements. AFTER_P non-zero means STRING is an after-string of
2757 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
2760 Lisp_Object priority; \
2764 int new_size = 2 * size; \
2765 struct overlay_entry *old = entries; \
2767 (struct overlay_entry *) alloca (new_size \
2768 * sizeof *entries); \
2769 bcopy (old, entries, size * sizeof *entries); \
2773 entries[n].string = (STRING); \
2774 priority = Foverlay_get ((OVERLAY), Qpriority); \
2775 entries[n].priority \
2776 = INTEGERP (priority) ? XFASTINT (priority) : 0; \
2777 entries[n].after_string_p = (AFTER_P); \
2782 /* Process overlay before the overlay center. */
2783 for (ov
= current_buffer
->overlays_before
;
2787 overlay
= XCAR (ov
);
2788 xassert (OVERLAYP (overlay
));
2789 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
2790 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
2792 if (end
< IT_CHARPOS (*it
))
2795 /* Skip this overlay if it doesn't start or end at IT's current
2797 if (end
!= IT_CHARPOS (*it
) && start
!= IT_CHARPOS (*it
))
2800 /* Skip this overlay if it doesn't apply to IT->w. */
2801 window
= Foverlay_get (overlay
, Qwindow
);
2802 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
2805 /* If overlay has a non-empty before-string, record it. */
2806 if (start
== IT_CHARPOS (*it
)
2807 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
2808 && XSTRING (str
)->size
)
2809 RECORD_OVERLAY_STRING (overlay
, str
, 0);
2811 /* If overlay has a non-empty after-string, record it. */
2812 if (end
== IT_CHARPOS (*it
)
2813 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
2814 && XSTRING (str
)->size
)
2815 RECORD_OVERLAY_STRING (overlay
, str
, 1);
2818 /* Process overlays after the overlay center. */
2819 for (ov
= current_buffer
->overlays_after
;
2823 overlay
= XCAR (ov
);
2824 xassert (OVERLAYP (overlay
));
2825 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
2826 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
2828 if (start
> IT_CHARPOS (*it
))
2831 /* Skip this overlay if it doesn't start or end at IT's current
2833 if (end
!= IT_CHARPOS (*it
) && start
!= IT_CHARPOS (*it
))
2836 /* Skip this overlay if it doesn't apply to IT->w. */
2837 window
= Foverlay_get (overlay
, Qwindow
);
2838 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
2841 /* If overlay has a non-empty before-string, record it. */
2842 if (start
== IT_CHARPOS (*it
)
2843 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
2844 && XSTRING (str
)->size
)
2845 RECORD_OVERLAY_STRING (overlay
, str
, 0);
2847 /* If overlay has a non-empty after-string, record it. */
2848 if (end
== IT_CHARPOS (*it
)
2849 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
2850 && XSTRING (str
)->size
)
2851 RECORD_OVERLAY_STRING (overlay
, str
, 1);
2854 #undef RECORD_OVERLAY_STRING
2857 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
2859 /* Record the total number of strings to process. */
2860 it
->n_overlay_strings
= n
;
2862 /* IT->current.overlay_string_index is the number of overlay strings
2863 that have already been consumed by IT. Copy some of the
2864 remaining overlay strings to IT->overlay_strings. */
2866 j
= it
->current
.overlay_string_index
;
2867 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
2868 it
->overlay_strings
[i
++] = entries
[j
++].string
;
2874 /* Get the first chunk of overlay strings at IT's current buffer
2875 position. Value is non-zero if at least one overlay string was
2879 get_overlay_strings (it
)
2882 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
2883 process. This fills IT->overlay_strings with strings, and sets
2884 IT->n_overlay_strings to the total number of strings to process.
2885 IT->pos.overlay_string_index has to be set temporarily to zero
2886 because load_overlay_strings needs this; it must be set to -1
2887 when no overlay strings are found because a zero value would
2888 indicate a position in the first overlay string. */
2889 it
->current
.overlay_string_index
= 0;
2890 load_overlay_strings (it
);
2892 /* If we found overlay strings, set up IT to deliver display
2893 elements from the first one. Otherwise set up IT to deliver
2894 from current_buffer. */
2895 if (it
->n_overlay_strings
)
2897 /* Make sure we know settings in current_buffer, so that we can
2898 restore meaningful values when we're done with the overlay
2900 compute_stop_pos (it
);
2901 xassert (it
->face_id
>= 0);
2903 /* Save IT's settings. They are restored after all overlay
2904 strings have been processed. */
2905 xassert (it
->sp
== 0);
2908 /* Set up IT to deliver display elements from the first overlay
2910 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
2911 it
->stop_charpos
= 0;
2912 it
->string
= it
->overlay_strings
[0];
2913 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
2914 xassert (STRINGP (it
->string
));
2915 it
->method
= next_element_from_string
;
2920 it
->current
.overlay_string_index
= -1;
2921 it
->method
= next_element_from_buffer
;
2926 /* Value is non-zero if we found at least one overlay string. */
2927 return STRINGP (it
->string
);
2932 /***********************************************************************
2933 Saving and restoring state
2934 ***********************************************************************/
2936 /* Save current settings of IT on IT->stack. Called, for example,
2937 before setting up IT for an overlay string, to be able to restore
2938 IT's settings to what they were after the overlay string has been
2945 struct iterator_stack_entry
*p
;
2947 xassert (it
->sp
< 2);
2948 p
= it
->stack
+ it
->sp
;
2950 p
->stop_charpos
= it
->stop_charpos
;
2951 xassert (it
->face_id
>= 0);
2952 p
->face_id
= it
->face_id
;
2953 p
->string
= it
->string
;
2954 p
->pos
= it
->current
;
2955 p
->end_charpos
= it
->end_charpos
;
2956 p
->string_nchars
= it
->string_nchars
;
2958 p
->multibyte_p
= it
->multibyte_p
;
2959 p
->space_width
= it
->space_width
;
2960 p
->font_height
= it
->font_height
;
2961 p
->voffset
= it
->voffset
;
2962 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
2967 /* Restore IT's settings from IT->stack. Called, for example, when no
2968 more overlay strings must be processed, and we return to delivering
2969 display elements from a buffer, or when the end of a string from a
2970 `display' property is reached and we return to delivering display
2971 elements from an overlay string, or from a buffer. */
2977 struct iterator_stack_entry
*p
;
2979 xassert (it
->sp
> 0);
2981 p
= it
->stack
+ it
->sp
;
2982 it
->stop_charpos
= p
->stop_charpos
;
2983 it
->face_id
= p
->face_id
;
2984 it
->string
= p
->string
;
2985 it
->current
= p
->pos
;
2986 it
->end_charpos
= p
->end_charpos
;
2987 it
->string_nchars
= p
->string_nchars
;
2989 it
->multibyte_p
= p
->multibyte_p
;
2990 it
->space_width
= p
->space_width
;
2991 it
->font_height
= p
->font_height
;
2992 it
->voffset
= p
->voffset
;
2993 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
2998 /***********************************************************************
3000 ***********************************************************************/
3002 /* Set IT's current position to the previous line start. */
3005 back_to_previous_line_start (it
)
3008 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
3009 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
3013 /* Set IT's current position to the next line start. */
3016 forward_to_next_line_start (it
)
3019 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
), 1);
3020 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
3024 /* Set IT's current position to the previous visible line start. Skip
3025 invisible text that is so either due to text properties or due to
3026 selective display. Caution: this does not change IT->current_x and
3030 back_to_previous_visible_line_start (it
)
3035 /* Go back one newline if not on BEGV already. */
3036 if (IT_CHARPOS (*it
) > BEGV
)
3037 back_to_previous_line_start (it
);
3039 /* Move over lines that are invisible because of selective display
3040 or text properties. */
3041 while (IT_CHARPOS (*it
) > BEGV
3046 /* If selective > 0, then lines indented more than that values
3048 if (it
->selective
> 0
3049 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
3056 prop
= Fget_char_property (IT_CHARPOS (*it
), Qinvisible
, it
->window
);
3057 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
3061 /* Back one more newline if the current one is invisible. */
3063 back_to_previous_line_start (it
);
3066 xassert (IT_CHARPOS (*it
) >= BEGV
);
3067 xassert (IT_CHARPOS (*it
) == BEGV
3068 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
3073 /* Reseat iterator IT at the previous visible line start. Skip
3074 invisible text that is so either due to text properties or due to
3075 selective display. At the end, update IT's overlay information,
3076 face information etc. */
3079 reseat_at_previous_visible_line_start (it
)
3082 back_to_previous_visible_line_start (it
);
3083 reseat (it
, it
->current
.pos
, 1);
3088 /* Reseat iterator IT on the next visible line start in the current
3089 buffer. ON_NEWLINE_P non-zero means position IT on the newline
3090 preceding the line start. Skip over invisible text that is so
3091 because of selective display. Compute faces, overlays etc at the
3092 new position. Note that this function does not skip over text that
3093 is invisible because of text properties. */
3096 reseat_at_next_visible_line_start (it
, on_newline_p
)
3100 /* Restore the buffer position when currently not delivering display
3101 elements from the current buffer. This is the case, for example,
3102 when called at the end of a truncated overlay string. */
3105 it
->method
= next_element_from_buffer
;
3107 /* Otherwise, scan_buffer would not work. */
3108 if (IT_CHARPOS (*it
) < ZV
)
3110 /* If on a newline, advance past it. Otherwise, find the next
3111 newline which automatically gives us the position following
3113 if (FETCH_BYTE (IT_BYTEPOS (*it
)) == '\n')
3119 forward_to_next_line_start (it
);
3121 /* We must either have reached the end of the buffer or end up
3123 xassert (IT_CHARPOS (*it
) == ZV
3124 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
3126 /* Skip over lines that are invisible because they are indented
3127 more than the value of IT->selective. */
3128 if (it
->selective
> 0)
3129 while (IT_CHARPOS (*it
) < ZV
3130 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
3132 forward_to_next_line_start (it
);
3134 /* Position on the newline if we should. */
3136 && IT_CHARPOS (*it
) > BEGV
3137 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n')
3140 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
3143 /* Set the iterator there. The 0 as the last parameter of
3144 reseat means don't force a text property lookup. The lookup
3145 is then only done if we've skipped past the iterator's
3146 check_charpos'es. This optimization is important because
3147 text property lookups tend to be expensive. */
3148 reseat (it
, it
->current
.pos
, 0);
3156 /***********************************************************************
3157 Changing an iterator's position
3158 ***********************************************************************/
3160 /* Change IT's current position to POS in current_buffer. If FORCE_P
3161 is non-zero, always check for text properties at the new position.
3162 Otherwise, text properties are only looked up if POS >=
3163 IT->check_charpos of a property. */
3166 reseat (it
, pos
, force_p
)
3168 struct text_pos pos
;
3171 int original_pos
= IT_CHARPOS (*it
);
3173 reseat_1 (it
, pos
, 0);
3175 /* Determine where to check text properties. Avoid doing it
3176 where possible because text property lookup is very expensive. */
3178 || CHARPOS (pos
) > it
->stop_charpos
3179 || CHARPOS (pos
) < original_pos
)
3186 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
3187 IT->stop_pos to POS, also. */
3190 reseat_1 (it
, pos
, set_stop_p
)
3192 struct text_pos pos
;
3195 /* Don't call this function when scanning a C string. */
3196 xassert (it
->s
== NULL
);
3198 /* POS must be a reasonable value. */
3199 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
3201 it
->current
.pos
= it
->position
= pos
;
3202 XSETBUFFER (it
->object
, current_buffer
);
3204 it
->current
.dpvec_index
= -1;
3205 it
->current
.overlay_string_index
= -1;
3206 IT_STRING_CHARPOS (*it
) = -1;
3207 IT_STRING_BYTEPOS (*it
) = -1;
3209 it
->method
= next_element_from_buffer
;
3213 it
->stop_charpos
= CHARPOS (pos
);
3217 /* Set up IT for displaying a string, starting at CHARPOS in window W.
3218 If S is non-null, it is a C string to iterate over. Otherwise,
3219 STRING gives a Lisp string to iterate over.
3221 If PRECISION > 0, don't return more then PRECISION number of
3222 characters from the string.
3224 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
3225 characters have been returned. FIELD_WIDTH < 0 means an infinite
3228 MULTIBYTE = 0 means disable processing of multibyte characters,
3229 MULTIBYTE > 0 means enable it,
3230 MULTIBYTE < 0 means use IT->multibyte_p.
3232 IT must be initialized via a prior call to init_iterator before
3233 calling this function. */
3236 reseat_to_string (it
, s
, string
, charpos
, precision
, field_width
, multibyte
)
3241 int precision
, field_width
, multibyte
;
3243 /* No region in strings. */
3244 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
3246 /* No text property checks performed by default, but see below. */
3247 it
->stop_charpos
= -1;
3249 /* Set iterator position and end position. */
3250 bzero (&it
->current
, sizeof it
->current
);
3251 it
->current
.overlay_string_index
= -1;
3252 it
->current
.dpvec_index
= -1;
3253 it
->charset
= CHARSET_ASCII
;
3254 xassert (charpos
>= 0);
3256 /* Use the setting of MULTIBYTE if specified. */
3258 it
->multibyte_p
= multibyte
> 0;
3262 xassert (STRINGP (string
));
3263 it
->string
= string
;
3265 it
->end_charpos
= it
->string_nchars
= XSTRING (string
)->size
;
3266 it
->method
= next_element_from_string
;
3267 it
->current
.string_pos
= string_pos (charpos
, string
);
3274 /* Note that we use IT->current.pos, not it->current.string_pos,
3275 for displaying C strings. */
3276 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
3277 if (it
->multibyte_p
)
3279 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
3280 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
3284 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
3285 it
->end_charpos
= it
->string_nchars
= strlen (s
);
3288 it
->method
= next_element_from_c_string
;
3291 /* PRECISION > 0 means don't return more than PRECISION characters
3293 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
3294 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
3296 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
3297 characters have been returned. FIELD_WIDTH == 0 means don't pad,
3298 FIELD_WIDTH < 0 means infinite field width. This is useful for
3299 padding with `-' at the end of a mode line. */
3300 if (field_width
< 0)
3301 field_width
= INFINITY
;
3302 if (field_width
> it
->end_charpos
- charpos
)
3303 it
->end_charpos
= charpos
+ field_width
;
3305 /* Use the standard display table for displaying strings. */
3306 if (DISP_TABLE_P (Vstandard_display_table
))
3307 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
3309 it
->stop_charpos
= charpos
;
3315 /***********************************************************************
3317 ***********************************************************************/
3319 /* Load IT's display element fields with information about the next
3320 display element from the current position of IT. Value is zero if
3321 end of buffer (or C string) is reached. */
3324 get_next_display_element (it
)
3327 /* Non-zero means that we found an display element. Zero means that
3328 we hit the end of what we iterate over. Performance note: the
3329 function pointer `method' used here turns out to be faster than
3330 using a sequence of if-statements. */
3331 int success_p
= (*it
->method
) (it
);
3334 if (it
->what
== IT_CHARACTER
)
3336 /* Map via display table or translate control characters.
3337 IT->c, IT->len etc. have been set to the next character by
3338 the function call above. If we have a display table, and it
3339 contains an entry for IT->c, translate it. Don't do this if
3340 IT->c itself comes from a display table, otherwise we could
3341 end up in an infinite recursion. (An alternative could be to
3342 count the recursion depth of this function and signal an
3343 error when a certain maximum depth is reached.) Is it worth
3345 if (success_p
&& it
->dpvec
== NULL
)
3350 && (dv
= DISP_CHAR_VECTOR (it
->dp
, it
->c
),
3353 struct Lisp_Vector
*v
= XVECTOR (dv
);
3355 /* Return the first character from the display table
3356 entry, if not empty. If empty, don't display the
3357 current character. */
3360 it
->dpvec_char_len
= it
->len
;
3361 it
->dpvec
= v
->contents
;
3362 it
->dpend
= v
->contents
+ v
->size
;
3363 it
->current
.dpvec_index
= 0;
3364 it
->method
= next_element_from_display_vector
;
3367 success_p
= get_next_display_element (it
);
3370 /* Translate control characters into `\003' or `^C' form.
3371 Control characters coming from a display table entry are
3372 currently not translated because we use IT->dpvec to hold
3373 the translation. This could easily be changed but I
3374 don't believe that it is worth doing.
3376 Non-printable multibyte characters are also translated
3378 else if ((it
->c
< ' '
3379 && (it
->area
!= TEXT_AREA
3380 || (it
->c
!= '\n' && it
->c
!= '\t')))
3383 || !CHAR_PRINTABLE_P (it
->c
))
3385 /* IT->c is a control character which must be displayed
3386 either as '\003' or as `^C' where the '\\' and '^'
3387 can be defined in the display table. Fill
3388 IT->ctl_chars with glyphs for what we have to
3389 display. Then, set IT->dpvec to these glyphs. */
3392 if (it
->c
< 128 && it
->ctl_arrow_p
)
3394 /* Set IT->ctl_chars[0] to the glyph for `^'. */
3396 && INTEGERP (DISP_CTRL_GLYPH (it
->dp
))
3397 && GLYPH_CHAR_VALID_P (XINT (DISP_CTRL_GLYPH (it
->dp
))))
3398 g
= XINT (DISP_CTRL_GLYPH (it
->dp
));
3400 g
= FAST_MAKE_GLYPH ('^', 0);
3401 XSETINT (it
->ctl_chars
[0], g
);
3403 g
= FAST_MAKE_GLYPH (it
->c
^ 0100, 0);
3404 XSETINT (it
->ctl_chars
[1], g
);
3406 /* Set up IT->dpvec and return first character from it. */
3407 it
->dpvec_char_len
= it
->len
;
3408 it
->dpvec
= it
->ctl_chars
;
3409 it
->dpend
= it
->dpvec
+ 2;
3410 it
->current
.dpvec_index
= 0;
3411 it
->method
= next_element_from_display_vector
;
3412 get_next_display_element (it
);
3416 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
3417 int len
= CHAR_STRING (it
->c
, str
);
3421 /* Set IT->ctl_chars[0] to the glyph for `\\'. */
3423 && INTEGERP (DISP_ESCAPE_GLYPH (it
->dp
))
3424 && GLYPH_CHAR_VALID_P (XFASTINT (DISP_ESCAPE_GLYPH (it
->dp
))))
3425 escape_glyph
= XFASTINT (DISP_ESCAPE_GLYPH (it
->dp
));
3427 escape_glyph
= FAST_MAKE_GLYPH ('\\', 0);
3429 for (i
= 0; i
< len
; i
++)
3431 XSETINT (it
->ctl_chars
[i
* 4], escape_glyph
);
3432 /* Insert three more glyphs into IT->ctl_chars for
3433 the octal display of the character. */
3434 g
= FAST_MAKE_GLYPH (((str
[i
] >> 6) & 7) + '0', 0);
3435 XSETINT (it
->ctl_chars
[i
* 4 + 1], g
);
3436 g
= FAST_MAKE_GLYPH (((str
[i
] >> 3) & 7) + '0', 0);
3437 XSETINT (it
->ctl_chars
[i
* 4 + 2], g
);
3438 g
= FAST_MAKE_GLYPH ((str
[i
] & 7) + '0', 0);
3439 XSETINT (it
->ctl_chars
[i
* 4 + 3], g
);
3442 /* Set up IT->dpvec and return the first character
3444 it
->dpvec_char_len
= it
->len
;
3445 it
->dpvec
= it
->ctl_chars
;
3446 it
->dpend
= it
->dpvec
+ len
* 4;
3447 it
->current
.dpvec_index
= 0;
3448 it
->method
= next_element_from_display_vector
;
3449 get_next_display_element (it
);
3454 /* Adjust face id if charset changes. There are no charset
3455 changes in unibyte text because Emacs' charsets are not
3456 applicable there. */
3459 && (charset
= CHAR_CHARSET (it
->c
),
3460 charset
!= it
->charset
))
3462 it
->charset
= charset
;
3463 it
->face_id
= FACE_FOR_CHARSET (it
->f
, it
->face_id
, charset
);
3467 /* Is this character the last one of a run of characters with
3468 box? If yes, set IT->end_of_box_run_p to 1. */
3475 it
->end_of_box_run_p
3476 = ((face_id
= face_after_it_pos (it
),
3477 face_id
!= it
->face_id
)
3478 && (face
= FACE_FROM_ID (it
->f
, face_id
),
3479 face
->box
== FACE_NO_BOX
));
3482 /* Value is 0 if end of buffer or string reached. */
3487 /* Move IT to the next display element.
3489 Functions get_next_display_element and set_iterator_to_next are
3490 separate because I find this arrangement easier to handle than a
3491 get_next_display_element function that also increments IT's
3492 position. The way it is we can first look at an iterator's current
3493 display element, decide whether it fits on a line, and if it does,
3494 increment the iterator position. The other way around we probably
3495 would either need a flag indicating whether the iterator has to be
3496 incremented the next time, or we would have to implement a
3497 decrement position function which would not be easy to write. */
3500 set_iterator_to_next (it
)
3503 if (it
->method
== next_element_from_buffer
)
3505 /* The current display element of IT is a character from
3506 current_buffer. Advance in the buffer, and maybe skip over
3507 invisible lines that are so because of selective display. */
3508 if (ITERATOR_AT_END_OF_LINE_P (it
))
3509 reseat_at_next_visible_line_start (it
, 0);
3512 xassert (it
->len
!= 0);
3513 IT_BYTEPOS (*it
) += it
->len
;
3514 IT_CHARPOS (*it
) += 1;
3515 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
3518 else if (it
->method
== next_element_from_composition
)
3520 xassert (it
->cmp_id
>= 0 && it
->cmp_id
< n_compositions
);
3521 if (STRINGP (it
->string
))
3523 IT_STRING_BYTEPOS (*it
) += it
->len
;
3524 IT_STRING_CHARPOS (*it
) += it
->cmp_len
;
3525 it
->method
= next_element_from_string
;
3526 goto consider_string_end
;
3530 IT_BYTEPOS (*it
) += it
->len
;
3531 IT_CHARPOS (*it
) += it
->cmp_len
;
3532 it
->method
= next_element_from_buffer
;
3535 else if (it
->method
== next_element_from_c_string
)
3537 /* Current display element of IT is from a C string. */
3538 IT_BYTEPOS (*it
) += it
->len
;
3539 IT_CHARPOS (*it
) += 1;
3541 else if (it
->method
== next_element_from_display_vector
)
3543 /* Current display element of IT is from a display table entry.
3544 Advance in the display table definition. Reset it to null if
3545 end reached, and continue with characters from buffers/
3547 ++it
->current
.dpvec_index
;
3549 /* Restore face and charset of the iterator to what they were
3550 before the display vector entry (these entries may contain
3551 faces, and of course characters of different charsets). */
3552 it
->face_id
= it
->saved_face_id
;
3553 it
->charset
= FACE_FROM_ID (it
->f
, it
->face_id
)->charset
;
3555 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
3558 it
->method
= next_element_from_c_string
;
3559 else if (STRINGP (it
->string
))
3560 it
->method
= next_element_from_string
;
3562 it
->method
= next_element_from_buffer
;
3565 it
->current
.dpvec_index
= -1;
3567 /* Skip over characters which were displayed via IT->dpvec. */
3568 if (it
->dpvec_char_len
< 0)
3569 reseat_at_next_visible_line_start (it
, 1);
3570 else if (it
->dpvec_char_len
> 0)
3572 it
->len
= it
->dpvec_char_len
;
3573 set_iterator_to_next (it
);
3577 else if (it
->method
== next_element_from_string
)
3579 /* Current display element is a character from a Lisp string. */
3580 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
3581 IT_STRING_BYTEPOS (*it
) += it
->len
;
3582 IT_STRING_CHARPOS (*it
) += 1;
3584 consider_string_end
:
3586 if (it
->current
.overlay_string_index
>= 0)
3588 /* IT->string is an overlay string. Advance to the
3589 next, if there is one. */
3590 if (IT_STRING_CHARPOS (*it
) >= XSTRING (it
->string
)->size
)
3591 next_overlay_string (it
);
3595 /* IT->string is not an overlay string. If we reached
3596 its end, and there is something on IT->stack, proceed
3597 with what is on the stack. This can be either another
3598 string, this time an overlay string, or a buffer. */
3599 if (IT_STRING_CHARPOS (*it
) == XSTRING (it
->string
)->size
3603 if (!STRINGP (it
->string
))
3604 it
->method
= next_element_from_buffer
;
3608 else if (it
->method
== next_element_from_image
3609 || it
->method
== next_element_from_stretch
)
3611 /* The position etc with which we have to proceed are on
3612 the stack. The position may be at the end of a string,
3613 if the `display' property takes up the whole string. */
3616 if (STRINGP (it
->string
))
3618 it
->method
= next_element_from_string
;
3619 goto consider_string_end
;
3622 it
->method
= next_element_from_buffer
;
3625 /* There are no other methods defined, so this should be a bug. */
3628 /* Reset flags indicating start and end of a sequence of
3629 characters with box. */
3630 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
3632 xassert (it
->method
!= next_element_from_string
3633 || (STRINGP (it
->string
)
3634 && IT_STRING_CHARPOS (*it
) >= 0));
3638 /* Load IT's display element fields with information about the next
3639 display element which comes from a display table entry or from the
3640 result of translating a control character to one of the forms `^C'
3641 or `\003'. IT->dpvec holds the glyphs to return as characters. */
3644 next_element_from_display_vector (it
)
3648 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
3650 /* Remember the current face id in case glyphs specify faces.
3651 IT's face is restored in set_iterator_to_next. */
3652 it
->saved_face_id
= it
->face_id
;
3654 if (INTEGERP (*it
->dpvec
)
3655 && GLYPH_CHAR_VALID_P (XFASTINT (*it
->dpvec
)))
3660 g
= XFASTINT (it
->dpvec
[it
->current
.dpvec_index
]);
3661 it
->c
= FAST_GLYPH_CHAR (g
);
3662 it
->len
= CHAR_LEN (it
->c
);
3664 /* The entry may contain a face id to use. Such a face id is
3665 the id of a Lisp face, not a realized face. A face id of
3666 zero means no face. */
3667 lface_id
= FAST_GLYPH_FACE (g
);
3670 int face_id
= ascii_face_of_lisp_face (it
->f
, lface_id
);
3673 it
->face_id
= face_id
;
3674 it
->charset
= CHARSET_ASCII
;
3679 /* Display table entry is invalid. Return a space. */
3680 it
->c
= ' ', it
->len
= 1;
3682 /* Don't change position and object of the iterator here. They are
3683 still the values of the character that had this display table
3684 entry or was translated, and that's what we want. */
3685 it
->what
= IT_CHARACTER
;
3690 /* Load IT with the next display element from Lisp string IT->string.
3691 IT->current.string_pos is the current position within the string.
3692 If IT->current.overlay_string_index >= 0, the Lisp string is an
3696 next_element_from_string (it
)
3699 struct text_pos position
;
3701 xassert (STRINGP (it
->string
));
3702 xassert (IT_STRING_CHARPOS (*it
) >= 0);
3703 position
= it
->current
.string_pos
;
3705 /* Time to check for invisible text? */
3706 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
3707 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
3711 /* Since a handler may have changed IT->method, we must
3713 return get_next_display_element (it
);
3716 if (it
->current
.overlay_string_index
>= 0)
3718 /* Get the next character from an overlay string. In overlay
3719 strings, There is no field width or padding with spaces to
3721 if (IT_STRING_CHARPOS (*it
) >= XSTRING (it
->string
)->size
)
3726 else if (STRING_MULTIBYTE (it
->string
))
3728 int remaining
= (STRING_BYTES (XSTRING (it
->string
))
3729 - IT_STRING_BYTEPOS (*it
));
3730 unsigned char *s
= (XSTRING (it
->string
)->data
3731 + IT_STRING_BYTEPOS (*it
));
3732 it
->c
= string_char_and_length (s
, remaining
, &it
->len
);
3736 it
->c
= XSTRING (it
->string
)->data
[IT_STRING_BYTEPOS (*it
)];
3742 /* Get the next character from a Lisp string that is not an
3743 overlay string. Such strings come from the mode line, for
3744 example. We may have to pad with spaces, or truncate the
3745 string. See also next_element_from_c_string. */
3746 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
3751 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
3753 /* Pad with spaces. */
3754 it
->c
= ' ', it
->len
= 1;
3755 CHARPOS (position
) = BYTEPOS (position
) = -1;
3757 else if (STRING_MULTIBYTE (it
->string
))
3759 int maxlen
= (STRING_BYTES (XSTRING (it
->string
))
3760 - IT_STRING_BYTEPOS (*it
));
3761 unsigned char *s
= (XSTRING (it
->string
)->data
3762 + IT_STRING_BYTEPOS (*it
));
3763 it
->c
= string_char_and_length (s
, maxlen
, &it
->len
);
3767 it
->c
= XSTRING (it
->string
)->data
[IT_STRING_BYTEPOS (*it
)];
3772 /* Record what we have and where it came from. Note that we store a
3773 buffer position in IT->position although it could arguably be a
3775 it
->what
= IT_CHARACTER
;
3776 it
->object
= it
->string
;
3777 it
->position
= position
;
3782 /* Load IT with next display element from C string IT->s.
3783 IT->string_nchars is the maximum number of characters to return
3784 from the string. IT->end_charpos may be greater than
3785 IT->string_nchars when this function is called, in which case we
3786 may have to return padding spaces. Value is zero if end of string
3787 reached, including padding spaces. */
3790 next_element_from_c_string (it
)
3796 it
->what
= IT_CHARACTER
;
3797 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
3800 /* IT's position can be greater IT->string_nchars in case a field
3801 width or precision has been specified when the iterator was
3803 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
3805 /* End of the game. */
3809 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
3811 /* Pad with spaces. */
3812 it
->c
= ' ', it
->len
= 1;
3813 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
3815 else if (it
->multibyte_p
)
3817 /* Implementation note: The calls to strlen apparently aren't a
3818 performance problem because there is no noticeable performance
3819 difference between Emacs running in unibyte or multibyte mode. */
3820 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
3821 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
),
3825 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
3831 /* Set up IT to return characters from an ellipsis, if appropriate.
3832 The definition of the ellipsis glyphs may come from a display table
3833 entry. This function Fills IT with the first glyph from the
3834 ellipsis if an ellipsis is to be displayed. */
3837 next_element_from_ellipsis (it
)
3840 if (it
->selective_display_ellipsis_p
)
3842 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3844 /* Use the display table definition for `...'. Invalid glyphs
3845 will be handled by the method returning elements from dpvec. */
3846 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3847 it
->dpvec_char_len
= it
->len
;
3848 it
->dpvec
= v
->contents
;
3849 it
->dpend
= v
->contents
+ v
->size
;
3850 it
->current
.dpvec_index
= 0;
3851 it
->method
= next_element_from_display_vector
;
3855 /* Use default `...' which is stored in default_invis_vector. */
3856 it
->dpvec_char_len
= it
->len
;
3857 it
->dpvec
= default_invis_vector
;
3858 it
->dpend
= default_invis_vector
+ 3;
3859 it
->current
.dpvec_index
= 0;
3860 it
->method
= next_element_from_display_vector
;
3864 reseat_at_next_visible_line_start (it
, 1);
3866 return get_next_display_element (it
);
3870 /* Deliver an image display element. The iterator IT is already
3871 filled with image information (done in handle_display_prop). Value
3876 next_element_from_image (it
)
3879 it
->what
= IT_IMAGE
;
3884 /* Fill iterator IT with next display element from a stretch glyph
3885 property. IT->object is the value of the text property. Value is
3889 next_element_from_stretch (it
)
3892 it
->what
= IT_STRETCH
;
3897 /* Load IT with the next display element from current_buffer. Value
3898 is zero if end of buffer reached. IT->stop_charpos is the next
3899 position at which to stop and check for text properties or buffer
3903 next_element_from_buffer (it
)
3908 /* Check this assumption, otherwise, we would never enter the
3909 if-statement, below. */
3910 xassert (IT_CHARPOS (*it
) >= BEGV
3911 && IT_CHARPOS (*it
) <= it
->stop_charpos
);
3913 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
3915 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
3917 int overlay_strings_follow_p
;
3919 /* End of the game, except when overlay strings follow that
3920 haven't been returned yet. */
3921 if (it
->overlay_strings_at_end_processed_p
)
3922 overlay_strings_follow_p
= 0;
3925 it
->overlay_strings_at_end_processed_p
= 1;
3926 overlay_strings_follow_p
= get_overlay_strings (it
);
3929 if (overlay_strings_follow_p
)
3930 success_p
= get_next_display_element (it
);
3934 it
->position
= it
->current
.pos
;
3941 return get_next_display_element (it
);
3946 /* No face changes, overlays etc. in sight, so just return a
3947 character from current_buffer. */
3950 /* Maybe run the redisplay end trigger hook. Performance note:
3951 This doesn't seem to cost measurable time. */
3952 if (it
->redisplay_end_trigger_charpos
3954 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
3955 run_redisplay_end_trigger_hook (it
);
3957 /* Get the next character, maybe multibyte. */
3958 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
3959 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
3961 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT_BYTE
? ZV_BYTE
: GPT_BYTE
)
3962 - IT_BYTEPOS (*it
));
3963 it
->c
= string_char_and_length (p
, maxlen
, &it
->len
);
3966 it
->c
= *p
, it
->len
= 1;
3968 /* Record what we have and where it came from. */
3969 it
->what
= IT_CHARACTER
;;
3970 it
->object
= it
->w
->buffer
;
3971 it
->position
= it
->current
.pos
;
3973 /* Normally we return the character found above, except when we
3974 really want to return an ellipsis for selective display. */
3979 /* A value of selective > 0 means hide lines indented more
3980 than that number of columns. */
3981 if (it
->selective
> 0
3982 && IT_CHARPOS (*it
) + 1 < ZV
3983 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
3984 IT_BYTEPOS (*it
) + 1,
3987 success_p
= next_element_from_ellipsis (it
);
3988 it
->dpvec_char_len
= -1;
3991 else if (it
->c
== '\r' && it
->selective
== -1)
3993 /* A value of selective == -1 means that everything from the
3994 CR to the end of the line is invisible, with maybe an
3995 ellipsis displayed for it. */
3996 success_p
= next_element_from_ellipsis (it
);
3997 it
->dpvec_char_len
= -1;
4002 /* Value is zero if end of buffer reached. */
4003 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
4008 /* Run the redisplay end trigger hook for IT. */
4011 run_redisplay_end_trigger_hook (it
)
4014 Lisp_Object args
[3];
4016 /* IT->glyph_row should be non-null, i.e. we should be actually
4017 displaying something, or otherwise we should not run the hook. */
4018 xassert (it
->glyph_row
);
4020 /* Set up hook arguments. */
4021 args
[0] = Qredisplay_end_trigger_functions
;
4022 args
[1] = it
->window
;
4023 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
4024 it
->redisplay_end_trigger_charpos
= 0;
4026 /* Since we are *trying* to run these functions, don't try to run
4027 them again, even if they get an error. */
4028 it
->w
->redisplay_end_trigger
= Qnil
;
4029 Frun_hook_with_args (3, args
);
4031 /* Notice if it changed the face of the character we are on. */
4032 handle_face_prop (it
);
4036 /* Deliver a composition display element. The iterator IT is already
4037 filled with composition information (done in
4038 handle_composition_prop). Value is always 1. */
4041 next_element_from_composition (it
)
4044 it
->what
= IT_COMPOSITION
;
4045 it
->position
= (STRINGP (it
->string
)
4046 ? it
->current
.string_pos
4053 /***********************************************************************
4054 Moving an iterator without producing glyphs
4055 ***********************************************************************/
4057 /* Move iterator IT to a specified buffer or X position within one
4058 line on the display without producing glyphs.
4060 Begin to skip at IT's current position. Skip to TO_CHARPOS or TO_X
4061 whichever is reached first.
4063 TO_CHARPOS <= 0 means no TO_CHARPOS is specified.
4065 TO_X < 0 means that no TO_X is specified. TO_X is normally a value
4066 0 <= TO_X <= IT->last_visible_x. This means in particular, that
4067 TO_X includes the amount by which a window is horizontally
4072 MOVE_POS_MATCH_OR_ZV
4073 - when TO_POS or ZV was reached.
4076 -when TO_X was reached before TO_POS or ZV were reached.
4079 - when we reached the end of the display area and the line must
4083 - when we reached the end of the display area and the line is
4087 - when we stopped at a line end, i.e. a newline or a CR and selective
4090 static enum move_it_result
4091 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
)
4093 int to_charpos
, to_x
, op
;
4095 enum move_it_result result
= MOVE_UNDEFINED
;
4096 struct glyph_row
*saved_glyph_row
;
4098 /* Don't produce glyphs in produce_glyphs. */
4099 saved_glyph_row
= it
->glyph_row
;
4100 it
->glyph_row
= NULL
;
4106 /* Stop when ZV or TO_CHARPOS reached. */
4107 if (!get_next_display_element (it
)
4108 || ((op
& MOVE_TO_POS
) != 0
4109 && BUFFERP (it
->object
)
4110 && IT_CHARPOS (*it
) >= to_charpos
))
4112 result
= MOVE_POS_MATCH_OR_ZV
;
4116 /* The call to produce_glyphs will get the metrics of the
4117 display element IT is loaded with. We record in x the
4118 x-position before this display element in case it does not
4121 PRODUCE_GLYPHS (it
);
4123 if (it
->area
!= TEXT_AREA
)
4125 set_iterator_to_next (it
);
4129 /* The number of glyphs we get back in IT->nglyphs will normally
4130 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
4131 character on a terminal frame, or (iii) a line end. For the
4132 second case, IT->nglyphs - 1 padding glyphs will be present
4133 (on X frames, there is only one glyph produced for a
4134 composite character.
4136 The behavior implemented below means, for continuation lines,
4137 that as many spaces of a TAB as fit on the current line are
4138 displayed there. For terminal frames, as many glyphs of a
4139 multi-glyph character are displayed in the current line, too.
4140 This is what the old redisplay code did, and we keep it that
4141 way. Under X, the whole shape of a complex character must
4142 fit on the line or it will be completely displayed in the
4145 Note that both for tabs and padding glyphs, all glyphs have
4149 /* More than one glyph or glyph doesn't fit on line. All
4150 glyphs have the same width. */
4151 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
4154 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
4156 new_x
= x
+ single_glyph_width
;
4158 /* We want to leave anything reaching TO_X to the caller. */
4159 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
4162 result
= MOVE_X_REACHED
;
4165 else if (/* Lines are continued. */
4166 !it
->truncate_lines_p
4167 && (/* And glyph doesn't fit on the line. */
4168 new_x
> it
->last_visible_x
4169 /* Or it fits exactly and we're on a window
4171 || (new_x
== it
->last_visible_x
4172 && FRAME_WINDOW_P (it
->f
))))
4174 if (/* IT->hpos == 0 means the very first glyph
4175 doesn't fit on the line, e.g. a wide image. */
4177 || (new_x
== it
->last_visible_x
4178 && FRAME_WINDOW_P (it
->f
)))
4181 it
->current_x
= new_x
;
4182 if (i
== it
->nglyphs
- 1)
4183 set_iterator_to_next (it
);
4188 result
= MOVE_LINE_CONTINUED
;
4191 else if (new_x
> it
->first_visible_x
)
4193 /* Glyph is visible. Increment number of glyphs that
4194 would be displayed. */
4199 /* Glyph is completely off the left margin of the display
4200 area. Nothing to do. */
4204 if (result
!= MOVE_UNDEFINED
)
4207 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
4209 /* Stop when TO_X specified and reached. This check is
4210 necessary here because of lines consisting of a line end,
4211 only. The line end will not produce any glyphs and we
4212 would never get MOVE_X_REACHED. */
4213 xassert (it
->nglyphs
== 0);
4214 result
= MOVE_X_REACHED
;
4218 /* Is this a line end? If yes, we're done. */
4219 if (ITERATOR_AT_END_OF_LINE_P (it
))
4221 result
= MOVE_NEWLINE_OR_CR
;
4225 /* The current display element has been consumed. Advance
4227 set_iterator_to_next (it
);
4229 /* Stop if lines are truncated and IT's current x-position is
4230 past the right edge of the window now. */
4231 if (it
->truncate_lines_p
4232 && it
->current_x
>= it
->last_visible_x
)
4234 result
= MOVE_LINE_TRUNCATED
;
4239 /* Restore the iterator settings altered at the beginning of this
4241 it
->glyph_row
= saved_glyph_row
;
4246 /* Move IT forward to a specified buffer position TO_CHARPOS, TO_X,
4247 TO_Y, TO_VPOS. OP is a bit-mask that specifies where to stop. See
4248 the description of enum move_operation_enum.
4250 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
4251 screen line, this function will set IT to the next position >
4255 move_it_to (it
, to_charpos
, to_x
, to_y
, to_vpos
, op
)
4257 int to_charpos
, to_x
, to_y
, to_vpos
;
4260 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
4265 if (op
& MOVE_TO_VPOS
)
4267 /* If no TO_CHARPOS and no TO_X specified, stop at the
4268 start of the line TO_VPOS. */
4269 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
4271 if (it
->vpos
== to_vpos
)
4273 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
4277 /* TO_VPOS >= 0 means stop at TO_X in the line at
4278 TO_VPOS, or at TO_POS, whichever comes first. */
4279 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
4281 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
4283 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
4285 /* We have reached TO_X but not in the line we want. */
4286 skip
= move_it_in_display_line_to (it
, to_charpos
,
4288 if (skip
== MOVE_POS_MATCH_OR_ZV
)
4293 else if (op
& MOVE_TO_Y
)
4295 struct it it_backup
;
4298 /* TO_Y specified means stop at TO_X in the line containing
4299 TO_Y---or at TO_CHARPOS if this is reached first. The
4300 problem is that we can't really tell whether the line
4301 contains TO_Y before we have completely scanned it, and
4302 this may skip past TO_X. What we do is to first scan to
4305 If TO_X is not specified, use a TO_X of zero. The reason
4306 is to make the outcome of this function more predictable.
4307 If we didn't use TO_X == 0, we would stop at the end of
4308 the line which is probably not what a caller would expect
4310 skip
= move_it_in_display_line_to (it
, to_charpos
,
4314 | (op
& MOVE_TO_POS
)));
4316 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
4317 if (skip
== MOVE_POS_MATCH_OR_ZV
)
4320 /* If TO_X was reached, we would like to know whether TO_Y
4321 is in the line. This can only be said if we know the
4322 total line height which requires us to scan the rest of
4325 if (skip
== MOVE_X_REACHED
)
4328 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
4332 /* Now, decide whether TO_Y is in this line. */
4333 line_height
= it
->max_ascent
+ it
->max_descent
;
4335 if (to_y
>= it
->current_y
4336 && to_y
< it
->current_y
+ line_height
)
4338 if (skip
== MOVE_X_REACHED
)
4339 /* If TO_Y is in this line and TO_X was reached above,
4340 we scanned too far. We have to restore IT's settings
4341 to the ones before skipping. */
4345 else if (skip
== MOVE_X_REACHED
)
4348 if (skip
== MOVE_POS_MATCH_OR_ZV
)
4356 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
4360 case MOVE_POS_MATCH_OR_ZV
:
4363 case MOVE_NEWLINE_OR_CR
:
4364 set_iterator_to_next (it
);
4365 it
->continuation_lines_width
= 0;
4368 case MOVE_LINE_TRUNCATED
:
4369 it
->continuation_lines_width
= 0;
4370 reseat_at_next_visible_line_start (it
, 0);
4371 if ((op
& MOVE_TO_POS
) != 0
4372 && IT_CHARPOS (*it
) > to_charpos
)
4376 case MOVE_LINE_CONTINUED
:
4377 it
->continuation_lines_width
+= it
->current_x
;
4384 /* Reset/increment for the next run. */
4385 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
4386 it
->current_x
= it
->hpos
= 0;
4387 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
4389 last_height
= it
->max_ascent
+ it
->max_descent
;
4390 last_max_ascent
= it
->max_ascent
;
4391 it
->max_ascent
= it
->max_descent
= 0;
4397 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
4399 If DY > 0, move IT backward at least that many pixels. DY = 0
4400 means move IT backward to the preceding line start or BEGV. This
4401 function may move over more than DY pixels if IT->current_y - DY
4402 ends up in the middle of a line; in this case IT->current_y will be
4403 set to the top of the line moved to. */
4406 move_it_vertically_backward (it
, dy
)
4410 int nlines
, h
, line_height
;
4412 int start_pos
= IT_CHARPOS (*it
);
4416 /* Estimate how many newlines we must move back. */
4417 nlines
= max (1, dy
/ CANON_Y_UNIT (it
->f
));
4419 /* Set the iterator's position that many lines back. */
4420 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
4421 back_to_previous_visible_line_start (it
);
4423 /* Reseat the iterator here. When moving backward, we don't want
4424 reseat to skip forward over invisible text, set up the iterator
4425 to deliver from overlay strings at the new position etc. So,
4426 use reseat_1 here. */
4427 reseat_1 (it
, it
->current
.pos
, 1);
4429 /* We are now surely at a line start. */
4430 it
->current_x
= it
->hpos
= 0;
4432 /* Move forward and see what y-distance we moved. First move to the
4433 start of the next line so that we get its height. We need this
4434 height to be able to tell whether we reached the specified
4437 it2
.max_ascent
= it2
.max_descent
= 0;
4438 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
4439 MOVE_TO_POS
| MOVE_TO_VPOS
);
4440 xassert (IT_CHARPOS (*it
) >= BEGV
);
4441 line_height
= it2
.max_ascent
+ it2
.max_descent
;
4442 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
4443 xassert (IT_CHARPOS (*it
) >= BEGV
);
4444 h
= it2
.current_y
- it
->current_y
;
4445 nlines
= it2
.vpos
- it
->vpos
;
4447 /* Correct IT's y and vpos position. */
4453 /* DY == 0 means move to the start of the screen line. The
4454 value of nlines is > 0 if continuation lines were involved. */
4456 move_it_by_lines (it
, nlines
, 1);
4457 xassert (IT_CHARPOS (*it
) <= start_pos
);
4461 /* The y-position we try to reach. Note that h has been
4462 subtracted in front of the if-statement. */
4463 int target_y
= it
->current_y
+ h
- dy
;
4465 /* If we did not reach target_y, try to move further backward if
4466 we can. If we moved too far backward, try to move forward. */
4467 if (target_y
< it
->current_y
4468 && IT_CHARPOS (*it
) > BEGV
)
4470 move_it_vertically (it
, target_y
- it
->current_y
);
4471 xassert (IT_CHARPOS (*it
) >= BEGV
);
4473 else if (target_y
>= it
->current_y
+ line_height
4474 && IT_CHARPOS (*it
) < ZV
)
4476 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
4477 xassert (IT_CHARPOS (*it
) >= BEGV
);
4483 /* Move IT by a specified amount of pixel lines DY. DY negative means
4484 move backwards. DY = 0 means move to start of screen line. At the
4485 end, IT will be on the start of a screen line. */
4488 move_it_vertically (it
, dy
)
4493 move_it_vertically_backward (it
, -dy
);
4496 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
4497 MOVE_TO_POS
| MOVE_TO_Y
);
4499 /* If buffer ends in ZV without a newline, move to the start of
4500 the line to satisfy the post-condition. */
4501 if (IT_CHARPOS (*it
) == ZV
4502 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
4503 move_it_by_lines (it
, 0, 0);
4508 /* Return non-zero if some text between buffer positions START_CHARPOS
4509 and END_CHARPOS is invisible. IT->window is the window for text
4513 invisible_text_between_p (it
, start_charpos
, end_charpos
)
4515 int start_charpos
, end_charpos
;
4517 Lisp_Object prop
, limit
;
4518 int invisible_found_p
;
4520 xassert (it
!= NULL
&& start_charpos
<= end_charpos
);
4522 /* Is text at START invisible? */
4523 prop
= Fget_char_property (make_number (start_charpos
), Qinvisible
,
4525 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
4526 invisible_found_p
= 1;
4529 limit
= next_single_char_property_change (make_number (start_charpos
),
4531 make_number (end_charpos
));
4532 invisible_found_p
= XFASTINT (limit
) < end_charpos
;
4535 return invisible_found_p
;
4539 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
4540 negative means move up. DVPOS == 0 means move to the start of the
4541 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
4542 NEED_Y_P is zero, IT->current_y will be left unchanged.
4544 Further optimization ideas: If we would know that IT->f doesn't use
4545 a face with proportional font, we could be faster for
4546 truncate-lines nil. */
4549 move_it_by_lines (it
, dvpos
, need_y_p
)
4551 int dvpos
, need_y_p
;
4553 struct position pos
;
4555 if (!FRAME_WINDOW_P (it
->f
))
4557 struct text_pos textpos
;
4559 /* We can use vmotion on frames without proportional fonts. */
4560 pos
= *vmotion (IT_CHARPOS (*it
), dvpos
, it
->w
);
4561 SET_TEXT_POS (textpos
, pos
.bufpos
, pos
.bytepos
);
4562 reseat (it
, textpos
, 1);
4563 it
->vpos
+= pos
.vpos
;
4564 it
->current_y
+= pos
.vpos
;
4566 else if (dvpos
== 0)
4568 /* DVPOS == 0 means move to the start of the screen line. */
4569 move_it_vertically_backward (it
, 0);
4570 xassert (it
->current_x
== 0 && it
->hpos
== 0);
4574 /* If there are no continuation lines, and if there is no
4575 selective display, try the simple method of moving forward
4576 DVPOS newlines, then see where we are. */
4577 if (!need_y_p
&& it
->truncate_lines_p
&& it
->selective
== 0)
4579 int shortage
= 0, charpos
;
4581 if (FETCH_BYTE (IT_BYTEPOS (*it
) == '\n'))
4582 charpos
= IT_CHARPOS (*it
) + 1;
4584 charpos
= scan_buffer ('\n', IT_CHARPOS (*it
), 0, dvpos
,
4587 if (!invisible_text_between_p (it
, IT_CHARPOS (*it
), charpos
))
4589 struct text_pos pos
;
4590 CHARPOS (pos
) = charpos
;
4591 BYTEPOS (pos
) = CHAR_TO_BYTE (charpos
);
4592 reseat (it
, pos
, 1);
4593 it
->vpos
+= dvpos
- shortage
;
4594 it
->hpos
= it
->current_x
= 0;
4599 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
4604 int start_charpos
, i
;
4606 /* If there are no continuation lines, and if there is no
4607 selective display, try the simple method of moving backward
4609 if (!need_y_p
&& it
->truncate_lines_p
&& it
->selective
== 0)
4612 int charpos
= IT_CHARPOS (*it
);
4613 int bytepos
= IT_BYTEPOS (*it
);
4615 /* If in the middle of a line, go to its start. */
4616 if (charpos
> BEGV
&& FETCH_BYTE (bytepos
- 1) != '\n')
4618 charpos
= find_next_newline_no_quit (charpos
, -1);
4619 bytepos
= CHAR_TO_BYTE (charpos
);
4622 if (charpos
== BEGV
)
4624 struct text_pos pos
;
4625 CHARPOS (pos
) = charpos
;
4626 BYTEPOS (pos
) = bytepos
;
4627 reseat (it
, pos
, 1);
4628 it
->hpos
= it
->current_x
= 0;
4633 charpos
= scan_buffer ('\n', charpos
- 1, 0, dvpos
, &shortage
, 0);
4634 if (!invisible_text_between_p (it
, charpos
, IT_CHARPOS (*it
)))
4636 struct text_pos pos
;
4637 CHARPOS (pos
) = charpos
;
4638 BYTEPOS (pos
) = CHAR_TO_BYTE (charpos
);
4639 reseat (it
, pos
, 1);
4640 it
->vpos
+= dvpos
+ (shortage
? shortage
- 1 : 0);
4641 it
->hpos
= it
->current_x
= 0;
4647 /* Go back -DVPOS visible lines and reseat the iterator there. */
4648 start_charpos
= IT_CHARPOS (*it
);
4649 for (i
= -dvpos
; i
&& IT_CHARPOS (*it
) > BEGV
; --i
)
4650 back_to_previous_visible_line_start (it
);
4651 reseat (it
, it
->current
.pos
, 1);
4652 it
->current_x
= it
->hpos
= 0;
4654 /* Above call may have moved too far if continuation lines
4655 are involved. Scan forward and see if it did. */
4657 it2
.vpos
= it2
.current_y
= 0;
4658 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
4659 it
->vpos
-= it2
.vpos
;
4660 it
->current_y
-= it2
.current_y
;
4661 it
->current_x
= it
->hpos
= 0;
4663 /* If we moved too far, move IT some lines forward. */
4664 if (it2
.vpos
> -dvpos
)
4666 int delta
= it2
.vpos
+ dvpos
;
4667 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
4674 /***********************************************************************
4676 ***********************************************************************/
4679 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
4683 add_to_log (format
, arg1
, arg2
)
4685 Lisp_Object arg1
, arg2
;
4687 Lisp_Object args
[3];
4688 Lisp_Object msg
, fmt
;
4691 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
4694 GCPRO4 (fmt
, msg
, arg1
, arg2
);
4696 args
[0] = fmt
= build_string (format
);
4699 msg
= Fformat (make_number (3), args
);
4701 len
= STRING_BYTES (XSTRING (msg
)) + 1;
4702 buffer
= (char *) alloca (len
);
4703 strcpy (buffer
, XSTRING (msg
)->data
);
4705 message_dolog (buffer
, len
, 1, 0);
4710 /* Output a newline in the *Messages* buffer if "needs" one. */
4713 message_log_maybe_newline ()
4715 if (message_log_need_newline
)
4716 message_dolog ("", 0, 1, 0);
4720 /* Add a string M of length LEN to the message log, optionally
4721 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
4722 nonzero, means interpret the contents of M as multibyte. This
4723 function calls low-level routines in order to bypass text property
4724 hooks, etc. which might not be safe to run. */
4727 message_dolog (m
, len
, nlflag
, multibyte
)
4729 int len
, nlflag
, multibyte
;
4731 if (!NILP (Vmessage_log_max
))
4733 struct buffer
*oldbuf
;
4734 Lisp_Object oldpoint
, oldbegv
, oldzv
;
4735 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
4736 int point_at_end
= 0;
4738 Lisp_Object old_deactivate_mark
, tem
;
4739 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
4741 old_deactivate_mark
= Vdeactivate_mark
;
4742 oldbuf
= current_buffer
;
4743 Fset_buffer (Fget_buffer_create (build_string ("*Messages*")));
4744 current_buffer
->undo_list
= Qt
;
4746 oldpoint
= Fpoint_marker ();
4747 oldbegv
= Fpoint_min_marker ();
4748 oldzv
= Fpoint_max_marker ();
4749 GCPRO4 (oldpoint
, oldbegv
, oldzv
, old_deactivate_mark
);
4757 BEGV_BYTE
= BEG_BYTE
;
4760 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
4762 /* Insert the string--maybe converting multibyte to single byte
4763 or vice versa, so that all the text fits the buffer. */
4765 && NILP (current_buffer
->enable_multibyte_characters
))
4768 unsigned char work
[1];
4770 /* Convert a multibyte string to single-byte
4771 for the *Message* buffer. */
4772 for (i
= 0; i
< len
; i
+= nbytes
)
4774 c
= string_char_and_length (m
+ i
, len
- i
, &nbytes
);
4775 work
[0] = (SINGLE_BYTE_CHAR_P (c
)
4777 : multibyte_char_to_unibyte (c
, Qnil
));
4778 insert_1_both (work
, 1, 1, 1, 0, 0);
4781 else if (! multibyte
4782 && ! NILP (current_buffer
->enable_multibyte_characters
))
4785 unsigned char *msg
= (unsigned char *) m
;
4786 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
4787 /* Convert a single-byte string to multibyte
4788 for the *Message* buffer. */
4789 for (i
= 0; i
< len
; i
++)
4791 c
= unibyte_char_to_multibyte (msg
[i
]);
4792 nbytes
= CHAR_STRING (c
, str
);
4793 insert_1_both (str
, 1, nbytes
, 1, 0, 0);
4797 insert_1 (m
, len
, 1, 0, 0);
4801 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
4802 insert_1 ("\n", 1, 1, 0, 0);
4804 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
4806 this_bol_byte
= PT_BYTE
;
4810 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
4812 prev_bol_byte
= PT_BYTE
;
4814 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
4815 this_bol
, this_bol_byte
);
4818 del_range_both (prev_bol
, prev_bol_byte
,
4819 this_bol
, this_bol_byte
, 0);
4825 /* If you change this format, don't forget to also
4826 change message_log_check_duplicate. */
4827 sprintf (dupstr
, " [%d times]", dup
);
4828 duplen
= strlen (dupstr
);
4829 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
4830 insert_1 (dupstr
, duplen
, 1, 0, 1);
4835 if (NATNUMP (Vmessage_log_max
))
4837 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
4838 -XFASTINT (Vmessage_log_max
) - 1, 0);
4839 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
4842 BEGV
= XMARKER (oldbegv
)->charpos
;
4843 BEGV_BYTE
= marker_byte_position (oldbegv
);
4852 ZV
= XMARKER (oldzv
)->charpos
;
4853 ZV_BYTE
= marker_byte_position (oldzv
);
4857 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
4859 /* We can't do Fgoto_char (oldpoint) because it will run some
4861 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
4862 XMARKER (oldpoint
)->bytepos
);
4865 free_marker (oldpoint
);
4866 free_marker (oldbegv
);
4867 free_marker (oldzv
);
4869 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
4870 set_buffer_internal (oldbuf
);
4872 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
4873 message_log_need_newline
= !nlflag
;
4874 Vdeactivate_mark
= old_deactivate_mark
;
4879 /* We are at the end of the buffer after just having inserted a newline.
4880 (Note: We depend on the fact we won't be crossing the gap.)
4881 Check to see if the most recent message looks a lot like the previous one.
4882 Return 0 if different, 1 if the new one should just replace it, or a
4883 value N > 1 if we should also append " [N times]". */
4886 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
4887 int prev_bol
, this_bol
;
4888 int prev_bol_byte
, this_bol_byte
;
4891 int len
= Z_BYTE
- 1 - this_bol_byte
;
4893 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
4894 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
4896 for (i
= 0; i
< len
; i
++)
4898 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.'
4907 if (*p1
++ == ' ' && *p1
++ == '[')
4910 while (*p1
>= '0' && *p1
<= '9')
4911 n
= n
* 10 + *p1
++ - '0';
4912 if (strncmp (p1
, " times]\n", 8) == 0)
4919 /* Display an echo area message M with a specified length of LEN
4920 chars. The string may include null characters. If M is 0, clear
4921 out any existing message, and let the mini-buffer text show through.
4923 The buffer M must continue to exist until after the echo area gets
4924 cleared or some other message gets displayed there. This means do
4925 not pass text that is stored in a Lisp string; do not pass text in
4926 a buffer that was alloca'd. */
4929 message2 (m
, len
, multibyte
)
4934 /* First flush out any partial line written with print. */
4935 message_log_maybe_newline ();
4937 message_dolog (m
, len
, 1, multibyte
);
4938 message2_nolog (m
, len
, multibyte
);
4942 /* The non-logging counterpart of message2. */
4945 message2_nolog (m
, len
, multibyte
)
4949 struct frame
*sf
= SELECTED_FRAME ();
4950 message_enable_multibyte
= multibyte
;
4954 if (noninteractive_need_newline
)
4955 putc ('\n', stderr
);
4956 noninteractive_need_newline
= 0;
4958 fwrite (m
, len
, 1, stderr
);
4959 if (cursor_in_echo_area
== 0)
4960 fprintf (stderr
, "\n");
4963 /* A null message buffer means that the frame hasn't really been
4964 initialized yet. Error messages get reported properly by
4965 cmd_error, so this must be just an informative message; toss it. */
4966 else if (INTERACTIVE
4967 && sf
->glyphs_initialized_p
4968 && FRAME_MESSAGE_BUF (sf
))
4970 Lisp_Object mini_window
;
4973 /* Get the frame containing the mini-buffer
4974 that the selected frame is using. */
4975 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
4976 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
4978 FRAME_SAMPLE_VISIBILITY (f
);
4979 if (FRAME_VISIBLE_P (sf
)
4980 && ! FRAME_VISIBLE_P (f
))
4981 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
4985 set_message (m
, Qnil
, len
, multibyte
);
4986 if (minibuffer_auto_raise
)
4987 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
4990 clear_message (1, 1);
4992 do_pending_window_change (0);
4993 echo_area_display (1);
4994 do_pending_window_change (0);
4995 if (frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
4996 (*frame_up_to_date_hook
) (f
);
5001 /* Display an echo area message M with a specified length of NBYTES
5002 bytes. The string may include null characters. If M is not a
5003 string, clear out any existing message, and let the mini-buffer
5004 text show through. */
5007 message3 (m
, nbytes
, multibyte
)
5012 struct gcpro gcpro1
;
5016 /* First flush out any partial line written with print. */
5017 message_log_maybe_newline ();
5019 message_dolog (XSTRING (m
)->data
, nbytes
, 1, multibyte
);
5020 message3_nolog (m
, nbytes
, multibyte
);
5026 /* The non-logging version of message3. */
5029 message3_nolog (m
, nbytes
, multibyte
)
5031 int nbytes
, multibyte
;
5033 struct frame
*sf
= SELECTED_FRAME ();
5034 message_enable_multibyte
= multibyte
;
5038 if (noninteractive_need_newline
)
5039 putc ('\n', stderr
);
5040 noninteractive_need_newline
= 0;
5042 fwrite (XSTRING (m
)->data
, nbytes
, 1, stderr
);
5043 if (cursor_in_echo_area
== 0)
5044 fprintf (stderr
, "\n");
5047 /* A null message buffer means that the frame hasn't really been
5048 initialized yet. Error messages get reported properly by
5049 cmd_error, so this must be just an informative message; toss it. */
5050 else if (INTERACTIVE
5051 && sf
->glyphs_initialized_p
5052 && FRAME_MESSAGE_BUF (sf
))
5054 Lisp_Object mini_window
;
5058 /* Get the frame containing the mini-buffer
5059 that the selected frame is using. */
5060 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
5061 frame
= XWINDOW (mini_window
)->frame
;
5064 FRAME_SAMPLE_VISIBILITY (f
);
5065 if (FRAME_VISIBLE_P (sf
)
5066 && !FRAME_VISIBLE_P (f
))
5067 Fmake_frame_visible (frame
);
5069 if (STRINGP (m
) && XSTRING (m
)->size
)
5071 set_message (NULL
, m
, nbytes
, multibyte
);
5072 if (minibuffer_auto_raise
)
5073 Fraise_frame (frame
);
5076 clear_message (1, 1);
5078 do_pending_window_change (0);
5079 echo_area_display (1);
5080 do_pending_window_change (0);
5081 if (frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
5082 (*frame_up_to_date_hook
) (f
);
5087 /* Display a null-terminated echo area message M. If M is 0, clear
5088 out any existing message, and let the mini-buffer text show through.
5090 The buffer M must continue to exist until after the echo area gets
5091 cleared or some other message gets displayed there. Do not pass
5092 text that is stored in a Lisp string. Do not pass text in a buffer
5093 that was alloca'd. */
5099 message2 (m
, (m
? strlen (m
) : 0), 0);
5103 /* The non-logging counterpart of message1. */
5109 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
5112 /* Display a message M which contains a single %s
5113 which gets replaced with STRING. */
5116 message_with_string (m
, string
, log
)
5125 if (noninteractive_need_newline
)
5126 putc ('\n', stderr
);
5127 noninteractive_need_newline
= 0;
5128 fprintf (stderr
, m
, XSTRING (string
)->data
);
5129 if (cursor_in_echo_area
== 0)
5130 fprintf (stderr
, "\n");
5134 else if (INTERACTIVE
)
5136 /* The frame whose minibuffer we're going to display the message on.
5137 It may be larger than the selected frame, so we need
5138 to use its buffer, not the selected frame's buffer. */
5139 Lisp_Object mini_window
;
5140 struct frame
*f
, *sf
= SELECTED_FRAME ();
5142 /* Get the frame containing the minibuffer
5143 that the selected frame is using. */
5144 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
5145 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
5147 /* A null message buffer means that the frame hasn't really been
5148 initialized yet. Error messages get reported properly by
5149 cmd_error, so this must be just an informative message; toss it. */
5150 if (FRAME_MESSAGE_BUF (f
))
5154 a
[0] = (char *) XSTRING (string
)->data
;
5156 len
= doprnt (FRAME_MESSAGE_BUF (f
),
5157 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
5160 message2 (FRAME_MESSAGE_BUF (f
), len
,
5161 STRING_MULTIBYTE (string
));
5163 message2_nolog (FRAME_MESSAGE_BUF (f
), len
,
5164 STRING_MULTIBYTE (string
));
5166 /* Print should start at the beginning of the message
5167 buffer next time. */
5168 message_buf_print
= 0;
5174 /* Dump an informative message to the minibuf. If M is 0, clear out
5175 any existing message, and let the mini-buffer text show through. */
5179 message (m
, a1
, a2
, a3
)
5181 EMACS_INT a1
, a2
, a3
;
5187 if (noninteractive_need_newline
)
5188 putc ('\n', stderr
);
5189 noninteractive_need_newline
= 0;
5190 fprintf (stderr
, m
, a1
, a2
, a3
);
5191 if (cursor_in_echo_area
== 0)
5192 fprintf (stderr
, "\n");
5196 else if (INTERACTIVE
)
5198 /* The frame whose mini-buffer we're going to display the message
5199 on. It may be larger than the selected frame, so we need to
5200 use its buffer, not the selected frame's buffer. */
5201 Lisp_Object mini_window
;
5202 struct frame
*f
, *sf
= SELECTED_FRAME ();
5204 /* Get the frame containing the mini-buffer
5205 that the selected frame is using. */
5206 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
5207 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
5209 /* A null message buffer means that the frame hasn't really been
5210 initialized yet. Error messages get reported properly by
5211 cmd_error, so this must be just an informative message; toss
5213 if (FRAME_MESSAGE_BUF (f
))
5224 len
= doprnt (FRAME_MESSAGE_BUF (f
),
5225 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
5227 len
= doprnt (FRAME_MESSAGE_BUF (f
),
5228 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3,
5230 #endif /* NO_ARG_ARRAY */
5232 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
5237 /* Print should start at the beginning of the message
5238 buffer next time. */
5239 message_buf_print
= 0;
5245 /* The non-logging version of message. */
5248 message_nolog (m
, a1
, a2
, a3
)
5250 EMACS_INT a1
, a2
, a3
;
5252 Lisp_Object old_log_max
;
5253 old_log_max
= Vmessage_log_max
;
5254 Vmessage_log_max
= Qnil
;
5255 message (m
, a1
, a2
, a3
);
5256 Vmessage_log_max
= old_log_max
;
5260 /* Display the current message in the current mini-buffer. This is
5261 only called from error handlers in process.c, and is not time
5267 if (!NILP (echo_area_buffer
[0]))
5270 string
= Fcurrent_message ();
5271 message3 (string
, XSTRING (string
)->size
,
5272 !NILP (current_buffer
->enable_multibyte_characters
));
5277 /* Make sure echo area buffers in echo_buffers[] are life. If they
5278 aren't, make new ones. */
5281 ensure_echo_area_buffers ()
5285 for (i
= 0; i
< 2; ++i
)
5286 if (!BUFFERP (echo_buffer
[i
])
5287 || NILP (XBUFFER (echo_buffer
[i
])->name
))
5290 sprintf (name
, " *Echo Area %d*", i
);
5291 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
5296 /* Call FN with args A1..A5 with either the current or last displayed
5297 echo_area_buffer as current buffer.
5299 WHICH zero means use the current message buffer
5300 echo_area_buffer[0]. If that is nil, choose a suitable buffer
5301 from echo_buffer[] and clear it.
5303 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
5304 suitable buffer from echo_buffer[] and clear it.
5306 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
5307 that the current message becomes the last displayed one, make
5308 choose a suitable buffer for echo_area_buffer[0], and clear it.
5310 Value is what FN returns. */
5313 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
, a5
)
5317 int a1
, a2
, a3
, a4
, a5
;
5320 int i
, this_one
, the_other
, clear_buffer_p
, rc
;
5321 int count
= specpdl_ptr
- specpdl
;
5323 /* If buffers aren't life, make new ones. */
5324 ensure_echo_area_buffers ();
5329 this_one
= 0, the_other
= 1;
5331 this_one
= 1, the_other
= 0;
5334 this_one
= 0, the_other
= 1;
5337 /* We need a fresh one in case the current echo buffer equals
5338 the one containing the last displayed echo area message. */
5339 if (!NILP (echo_area_buffer
[this_one
])
5340 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
5341 echo_area_buffer
[this_one
] = Qnil
;
5344 /* Choose a suitable buffer from echo_buffer[] is we don't
5346 if (NILP (echo_area_buffer
[this_one
]))
5348 echo_area_buffer
[this_one
]
5349 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
5350 ? echo_buffer
[the_other
]
5351 : echo_buffer
[this_one
]);
5355 buffer
= echo_area_buffer
[this_one
];
5357 record_unwind_protect (unwind_with_echo_area_buffer
,
5358 with_echo_area_buffer_unwind_data (w
));
5360 /* Make the echo area buffer current. Note that for display
5361 purposes, it is not necessary that the displayed window's buffer
5362 == current_buffer, except for text property lookup. So, let's
5363 only set that buffer temporarily here without doing a full
5364 Fset_window_buffer. We must also change w->pointm, though,
5365 because otherwise an assertions in unshow_buffer fails, and Emacs
5367 set_buffer_internal_1 (XBUFFER (buffer
));
5371 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
5373 current_buffer
->truncate_lines
= Qnil
;
5374 current_buffer
->undo_list
= Qt
;
5375 current_buffer
->read_only
= Qnil
;
5377 if (clear_buffer_p
&& Z
> BEG
)
5380 xassert (BEGV
>= BEG
);
5381 xassert (ZV
<= Z
&& ZV
>= BEGV
);
5383 rc
= fn (a1
, a2
, a3
, a4
, a5
);
5385 xassert (BEGV
>= BEG
);
5386 xassert (ZV
<= Z
&& ZV
>= BEGV
);
5388 unbind_to (count
, Qnil
);
5393 /* Save state that should be preserved around the call to the function
5394 FN called in with_echo_area_buffer. */
5397 with_echo_area_buffer_unwind_data (w
)
5403 /* Reduce consing by keeping one vector in
5404 Vwith_echo_area_save_vector. */
5405 vector
= Vwith_echo_area_save_vector
;
5406 Vwith_echo_area_save_vector
= Qnil
;
5409 vector
= Fmake_vector (make_number (7), Qnil
);
5411 XSETBUFFER (XVECTOR (vector
)->contents
[i
], current_buffer
); ++i
;
5412 XVECTOR (vector
)->contents
[i
++] = Vdeactivate_mark
;
5413 XVECTOR (vector
)->contents
[i
++] = make_number (windows_or_buffers_changed
);
5417 XSETWINDOW (XVECTOR (vector
)->contents
[i
], w
); ++i
;
5418 XVECTOR (vector
)->contents
[i
++] = w
->buffer
;
5419 XVECTOR (vector
)->contents
[i
++]
5420 = make_number (XMARKER (w
->pointm
)->charpos
);
5421 XVECTOR (vector
)->contents
[i
++]
5422 = make_number (XMARKER (w
->pointm
)->bytepos
);
5428 XVECTOR (vector
)->contents
[i
++] = Qnil
;
5431 xassert (i
== XVECTOR (vector
)->size
);
5436 /* Restore global state from VECTOR which was created by
5437 with_echo_area_buffer_unwind_data. */
5440 unwind_with_echo_area_buffer (vector
)
5445 set_buffer_internal_1 (XBUFFER (XVECTOR (vector
)->contents
[i
])); ++i
;
5446 Vdeactivate_mark
= XVECTOR (vector
)->contents
[i
]; ++i
;
5447 windows_or_buffers_changed
= XFASTINT (XVECTOR (vector
)->contents
[i
]); ++i
;
5449 if (WINDOWP (XVECTOR (vector
)->contents
[i
]))
5452 Lisp_Object buffer
, charpos
, bytepos
;
5454 w
= XWINDOW (XVECTOR (vector
)->contents
[i
]); ++i
;
5455 buffer
= XVECTOR (vector
)->contents
[i
]; ++i
;
5456 charpos
= XVECTOR (vector
)->contents
[i
]; ++i
;
5457 bytepos
= XVECTOR (vector
)->contents
[i
]; ++i
;
5460 set_marker_both (w
->pointm
, buffer
,
5461 XFASTINT (charpos
), XFASTINT (bytepos
));
5464 Vwith_echo_area_save_vector
= vector
;
5469 /* Set up the echo area for use by print functions. MULTIBYTE_P
5470 non-zero means we will print multibyte. */
5473 setup_echo_area_for_printing (multibyte_p
)
5476 ensure_echo_area_buffers ();
5478 if (!message_buf_print
)
5480 /* A message has been output since the last time we printed.
5481 Choose a fresh echo area buffer. */
5482 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
5483 echo_area_buffer
[0] = echo_buffer
[1];
5485 echo_area_buffer
[0] = echo_buffer
[0];
5487 /* Switch to that buffer and clear it. */
5488 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
5491 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
5493 /* Set up the buffer for the multibyteness we need. */
5495 != !NILP (current_buffer
->enable_multibyte_characters
))
5496 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
5498 /* Raise the frame containing the echo area. */
5499 if (minibuffer_auto_raise
)
5501 struct frame
*sf
= SELECTED_FRAME ();
5502 Lisp_Object mini_window
;
5503 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
5504 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
5507 message_buf_print
= 1;
5509 else if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
5510 /* Someone switched buffers between print requests. */
5511 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
5515 /* Display an echo area message in window W. Value is non-zero if W's
5516 height is changed. If display_last_displayed_message_p is
5517 non-zero, display the message that was last displayed, otherwise
5518 display the current message. */
5521 display_echo_area (w
)
5524 int i
, no_message_p
, window_height_changed_p
;
5526 /* If there is no message, we must call display_echo_area_1
5527 nevertheless because it resizes the window. But we will have to
5528 reset the echo_area_buffer in question to nil at the end because
5529 with_echo_area_buffer will sets it to an empty buffer. */
5530 i
= display_last_displayed_message_p
? 1 : 0;
5531 no_message_p
= NILP (echo_area_buffer
[i
]);
5533 window_height_changed_p
5534 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
5535 (int (*) ()) display_echo_area_1
, w
);
5538 echo_area_buffer
[i
] = Qnil
;
5540 return window_height_changed_p
;
5544 /* Helper for display_echo_area. Display the current buffer which
5545 contains the current echo area message in window W, a mini-window.
5546 Change the height of W so that all of the message is displayed.
5547 Value is non-zero if height of W was changed. */
5550 display_echo_area_1 (w
)
5554 struct text_pos start
;
5555 int window_height_changed_p
= 0;
5557 /* Do this before displaying, so that we have a large enough glyph
5558 matrix for the display. */
5559 window_height_changed_p
= resize_mini_window (w
, 0);
5562 clear_glyph_matrix (w
->desired_matrix
);
5563 XSETWINDOW (window
, w
);
5564 SET_TEXT_POS (start
, BEG
, BEG_BYTE
);
5565 try_window (window
, start
);
5567 return window_height_changed_p
;
5571 /* Resize the echo area window to exactly the size needed for the
5572 currently displayed message, if there is one. */
5575 resize_echo_area_axactly ()
5577 if (BUFFERP (echo_area_buffer
[0])
5578 && WINDOWP (echo_area_window
))
5580 struct window
*w
= XWINDOW (echo_area_window
);
5583 resized_p
= with_echo_area_buffer (w
, 0,
5584 (int (*) ()) resize_mini_window
,
5588 ++windows_or_buffers_changed
;
5589 ++update_mode_lines
;
5590 redisplay_internal (0);
5596 /* Resize mini-window W to fit the size of its contents. EXACT:P
5597 means size the window exactly to the size needed. Otherwise, it's
5598 only enlarged until W's buffer is empty. Value is non-zero if
5599 the window height has been changed. */
5602 resize_mini_window (w
, exact_p
)
5606 struct frame
*f
= XFRAME (w
->frame
);
5607 int window_height_changed_p
= 0;
5609 xassert (MINI_WINDOW_P (w
));
5611 /* Nil means don't try to resize. */
5612 if (NILP (Vmax_mini_window_height
)
5613 || (FRAME_X_P (f
) && f
->output_data
.x
== NULL
))
5616 if (!FRAME_MINIBUF_ONLY_P (f
))
5619 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
5620 int total_height
= XFASTINT (root
->height
) + XFASTINT (w
->height
);
5621 int height
, max_height
;
5622 int unit
= CANON_Y_UNIT (f
);
5623 struct text_pos start
;
5625 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
5627 /* Compute the max. number of lines specified by the user. */
5628 if (FLOATP (Vmax_mini_window_height
))
5629 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
5630 else if (INTEGERP (Vmax_mini_window_height
))
5631 max_height
= XINT (Vmax_mini_window_height
);
5633 max_height
= total_height
/ 4;
5635 /* Correct that max. height if it's bogus. */
5636 max_height
= max (1, max_height
);
5637 max_height
= min (total_height
, max_height
);
5639 /* Find out the height of the text in the window. */
5641 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
5642 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
5643 height
= it
.current_y
+ last_height
;
5645 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
5646 height
= (height
+ unit
- 1) / unit
;
5648 /* Compute a suitable window start. */
5649 if (height
> max_height
)
5651 height
= max_height
;
5652 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
5653 move_it_vertically_backward (&it
, (height
- 1) * unit
);
5654 start
= it
.current
.pos
;
5657 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
5658 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
5660 /* Let it grow only, until we display an empty message, in which
5661 case the window shrinks again. */
5662 if (height
> XFASTINT (w
->height
))
5664 int old_height
= XFASTINT (w
->height
);
5665 freeze_window_starts (f
, 1);
5666 grow_mini_window (w
, height
- XFASTINT (w
->height
));
5667 window_height_changed_p
= XFASTINT (w
->height
) != old_height
;
5669 else if (height
< XFASTINT (w
->height
)
5670 && (exact_p
|| BEGV
== ZV
))
5672 int old_height
= XFASTINT (w
->height
);
5673 freeze_window_starts (f
, 0);
5674 shrink_mini_window (w
);
5675 window_height_changed_p
= XFASTINT (w
->height
) != old_height
;
5679 return window_height_changed_p
;
5683 /* Value is the current message, a string, or nil if there is no
5691 if (NILP (echo_area_buffer
[0]))
5695 with_echo_area_buffer (0, 0, (int (*) ()) current_message_1
, &msg
);
5697 echo_area_buffer
[0] = Qnil
;
5705 current_message_1 (msg
)
5709 *msg
= make_buffer_string (BEG
, Z
, 1);
5716 /* Push the current message on Vmessage_stack for later restauration
5717 by restore_message. Value is non-zero if the current message isn't
5718 empty. This is a relatively infrequent operation, so it's not
5719 worth optimizing. */
5725 msg
= current_message ();
5726 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
5727 return STRINGP (msg
);
5731 /* Restore message display from the top of Vmessage_stack. */
5738 xassert (CONSP (Vmessage_stack
));
5739 msg
= XCAR (Vmessage_stack
);
5741 message3_nolog (msg
, STRING_BYTES (XSTRING (msg
)), STRING_MULTIBYTE (msg
));
5743 message3_nolog (msg
, 0, 0);
5747 /* Pop the top-most entry off Vmessage_stack. */
5752 xassert (CONSP (Vmessage_stack
));
5753 Vmessage_stack
= XCDR (Vmessage_stack
);
5757 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
5758 exits. If the stack is not empty, we have a missing pop_message
5762 check_message_stack ()
5764 if (!NILP (Vmessage_stack
))
5769 /* Truncate to NCHARS what will be displayed in the echo area the next
5770 time we display it---but don't redisplay it now. */
5773 truncate_echo_area (nchars
)
5777 echo_area_buffer
[0] = Qnil
;
5778 /* A null message buffer means that the frame hasn't really been
5779 initialized yet. Error messages get reported properly by
5780 cmd_error, so this must be just an informative message; toss it. */
5781 else if (!noninteractive
5783 && !NILP (echo_area_buffer
[0]))
5785 struct frame
*sf
= SELECTED_FRAME ();
5786 if (FRAME_MESSAGE_BUF (sf
))
5787 with_echo_area_buffer (0, 0, (int (*) ()) truncate_message_1
, nchars
);
5792 /* Helper function for truncate_echo_area. Truncate the current
5793 message to at most NCHARS characters. */
5796 truncate_message_1 (nchars
)
5799 if (BEG
+ nchars
< Z
)
5800 del_range (BEG
+ nchars
, Z
);
5802 echo_area_buffer
[0] = Qnil
;
5807 /* Set the current message to a substring of S or STRING.
5809 If STRING is a Lisp string, set the message to the first NBYTES
5810 bytes from STRING. NBYTES zero means use the whole string. If
5811 STRING is multibyte, the message will be displayed multibyte.
5813 If S is not null, set the message to the first LEN bytes of S. LEN
5814 zero means use the whole string. MULTIBYTE_P non-zero means S is
5815 multibyte. Display the message multibyte in that case. */
5818 set_message (s
, string
, nbytes
, multibyte_p
)
5823 message_enable_multibyte
5824 = ((s
&& multibyte_p
)
5825 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
5827 with_echo_area_buffer (0, -1, (int (*) ()) set_message_1
,
5828 s
, string
, nbytes
, multibyte_p
);
5829 message_buf_print
= 0;
5833 /* Helper function for set_message. Arguments have the same meaning
5834 as there. This function is called with the echo area buffer being
5838 set_message_1 (s
, string
, nbytes
, multibyte_p
)
5841 int nbytes
, multibyte_p
;
5845 /* Change multibyteness of the echo buffer appropriately. */
5846 if (message_enable_multibyte
5847 != !NILP (current_buffer
->enable_multibyte_characters
))
5848 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
5850 /* Insert new message at BEG. */
5851 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
5853 if (STRINGP (string
))
5858 nbytes
= XSTRING (string
)->size_byte
;
5859 nchars
= string_byte_to_char (string
, nbytes
);
5861 /* This function takes care of single/multibyte conversion. We
5862 just have to ensure that the echo area buffer has the right
5863 setting of enable_multibyte_characters. */
5864 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
5869 nbytes
= strlen (s
);
5871 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
5873 /* Convert from multi-byte to single-byte. */
5875 unsigned char work
[1];
5877 /* Convert a multibyte string to single-byte. */
5878 for (i
= 0; i
< nbytes
; i
+= n
)
5880 c
= string_char_and_length (s
+ i
, nbytes
- i
, &n
);
5881 work
[0] = (SINGLE_BYTE_CHAR_P (c
)
5883 : multibyte_char_to_unibyte (c
, Qnil
));
5884 insert_1_both (work
, 1, 1, 1, 0, 0);
5887 else if (!multibyte_p
5888 && !NILP (current_buffer
->enable_multibyte_characters
))
5890 /* Convert from single-byte to multi-byte. */
5892 unsigned char *msg
= (unsigned char *) s
;
5893 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
5895 /* Convert a single-byte string to multibyte. */
5896 for (i
= 0; i
< nbytes
; i
++)
5898 c
= unibyte_char_to_multibyte (msg
[i
]);
5899 n
= CHAR_STRING (c
, str
);
5900 insert_1_both (str
, 1, n
, 1, 0, 0);
5904 insert_1 (s
, nbytes
, 1, 0, 0);
5911 /* Clear messages. CURRENT_P non-zero means clear the current
5912 message. LAST_DISPLAYED_P non-zero means clear the message
5916 clear_message (current_p
, last_displayed_p
)
5917 int current_p
, last_displayed_p
;
5920 echo_area_buffer
[0] = Qnil
;
5922 if (last_displayed_p
)
5923 echo_area_buffer
[1] = Qnil
;
5925 message_buf_print
= 0;
5928 /* Clear garbaged frames.
5930 This function is used where the old redisplay called
5931 redraw_garbaged_frames which in turn called redraw_frame which in
5932 turn called clear_frame. The call to clear_frame was a source of
5933 flickering. I believe a clear_frame is not necessary. It should
5934 suffice in the new redisplay to invalidate all current matrices,
5935 and ensure a complete redisplay of all windows. */
5938 clear_garbaged_frames ()
5942 Lisp_Object tail
, frame
;
5944 FOR_EACH_FRAME (tail
, frame
)
5946 struct frame
*f
= XFRAME (frame
);
5948 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
5950 clear_current_matrices (f
);
5956 ++windows_or_buffers_changed
;
5961 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
5962 is non-zero update selected_frame. Value is non-zero if the
5963 mini-windows height has been changed. */
5966 echo_area_display (update_frame_p
)
5969 Lisp_Object mini_window
;
5972 int window_height_changed_p
= 0;
5973 struct frame
*sf
= SELECTED_FRAME ();
5975 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
5976 w
= XWINDOW (mini_window
);
5977 f
= XFRAME (WINDOW_FRAME (w
));
5979 /* Don't display if frame is invisible or not yet initialized. */
5980 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
5983 #ifdef HAVE_X_WINDOWS
5984 /* When Emacs starts, selected_frame may be a visible terminal
5985 frame, even if we run under a window system. If we let this
5986 through, a message would be displayed on the terminal. */
5987 if (EQ (selected_frame
, Vterminal_frame
)
5988 && !NILP (Vwindow_system
))
5990 #endif /* HAVE_X_WINDOWS */
5992 /* Redraw garbaged frames. */
5994 clear_garbaged_frames ();
5996 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
5998 echo_area_window
= mini_window
;
5999 window_height_changed_p
= display_echo_area (w
);
6000 w
->must_be_updated_p
= 1;
6004 /* Not called from redisplay_internal. If we changed
6005 window configuration, we must redisplay thoroughly.
6006 Otherwise, we can do with updating what we displayed
6008 if (window_height_changed_p
)
6010 ++windows_or_buffers_changed
;
6011 ++update_mode_lines
;
6012 redisplay_internal (0);
6014 else if (FRAME_WINDOW_P (f
))
6016 update_single_window (w
, 1);
6017 rif
->flush_display (f
);
6020 update_frame (f
, 1, 1);
6023 else if (!EQ (mini_window
, selected_window
))
6024 windows_or_buffers_changed
++;
6026 /* Last displayed message is now the current message. */
6027 echo_area_buffer
[1] = echo_area_buffer
[0];
6029 /* Prevent redisplay optimization in redisplay_internal by resetting
6030 this_line_start_pos. This is done because the mini-buffer now
6031 displays the message instead of its buffer text. */
6032 if (EQ (mini_window
, selected_window
))
6033 CHARPOS (this_line_start_pos
) = 0;
6035 return window_height_changed_p
;
6040 /***********************************************************************
6042 ***********************************************************************/
6045 #ifdef HAVE_WINDOW_SYSTEM
6047 /* A buffer for constructing frame titles in it; allocated from the
6048 heap in init_xdisp and resized as needed in store_frame_title_char. */
6050 static char *frame_title_buf
;
6052 /* The buffer's end, and a current output position in it. */
6054 static char *frame_title_buf_end
;
6055 static char *frame_title_ptr
;
6058 /* Store a single character C for the frame title in frame_title_buf.
6059 Re-allocate frame_title_buf if necessary. */
6062 store_frame_title_char (c
)
6065 /* If output position has reached the end of the allocated buffer,
6066 double the buffer's size. */
6067 if (frame_title_ptr
== frame_title_buf_end
)
6069 int len
= frame_title_ptr
- frame_title_buf
;
6070 int new_size
= 2 * len
* sizeof *frame_title_buf
;
6071 frame_title_buf
= (char *) xrealloc (frame_title_buf
, new_size
);
6072 frame_title_buf_end
= frame_title_buf
+ new_size
;
6073 frame_title_ptr
= frame_title_buf
+ len
;
6076 *frame_title_ptr
++ = c
;
6080 /* Store part of a frame title in frame_title_buf, beginning at
6081 frame_title_ptr. STR is the string to store. Do not copy more
6082 than PRECISION number of bytes from STR; PRECISION <= 0 means copy
6083 the whole string. Pad with spaces until FIELD_WIDTH number of
6084 characters have been copied; FIELD_WIDTH <= 0 means don't pad.
6085 Called from display_mode_element when it is used to build a frame
6089 store_frame_title (str
, field_width
, precision
)
6091 int field_width
, precision
;
6095 /* Copy at most PRECISION chars from STR. */
6096 while ((precision
<= 0 || n
< precision
)
6099 store_frame_title_char (*str
++);
6103 /* Fill up with spaces until FIELD_WIDTH reached. */
6104 while (field_width
> 0
6107 store_frame_title_char (' ');
6115 /* Set the title of FRAME, if it has changed. The title format is
6116 Vicon_title_format if FRAME is iconified, otherwise it is
6117 frame_title_format. */
6120 x_consider_frame_title (frame
)
6123 struct frame
*f
= XFRAME (frame
);
6125 if (FRAME_WINDOW_P (f
)
6126 || FRAME_MINIBUF_ONLY_P (f
)
6127 || f
->explicit_name
)
6129 /* Do we have more than one visible frame on this X display? */
6132 struct buffer
*obuf
;
6136 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
6138 struct frame
*tf
= XFRAME (XCAR (tail
));
6141 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
6142 && !FRAME_MINIBUF_ONLY_P (tf
)
6143 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
6147 /* Set global variable indicating that multiple frames exist. */
6148 multiple_frames
= CONSP (tail
);
6150 /* Switch to the buffer of selected window of the frame. Set up
6151 frame_title_ptr so that display_mode_element will output into it;
6152 then display the title. */
6153 obuf
= current_buffer
;
6154 Fset_buffer (XWINDOW (f
->selected_window
)->buffer
);
6155 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
6156 frame_title_ptr
= frame_title_buf
;
6157 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
6158 NULL
, DEFAULT_FACE_ID
);
6159 len
= display_mode_element (&it
, 0, -1, -1, fmt
);
6160 frame_title_ptr
= NULL
;
6161 set_buffer_internal (obuf
);
6163 /* Set the title only if it's changed. This avoids consing in
6164 the common case where it hasn't. (If it turns out that we've
6165 already wasted too much time by walking through the list with
6166 display_mode_element, then we might need to optimize at a
6167 higher level than this.) */
6168 if (! STRINGP (f
->name
)
6169 || STRING_BYTES (XSTRING (f
->name
)) != len
6170 || bcmp (frame_title_buf
, XSTRING (f
->name
)->data
, len
) != 0)
6171 x_implicitly_set_name (f
, make_string (frame_title_buf
, len
), Qnil
);
6175 #else /* not HAVE_WINDOW_SYSTEM */
6177 #define frame_title_ptr ((char *)0)
6178 #define store_frame_title(str, mincol, maxcol) 0
6180 #endif /* not HAVE_WINDOW_SYSTEM */
6185 /***********************************************************************
6187 ***********************************************************************/
6190 /* Prepare for redisplay by updating menu-bar item lists when
6191 appropriate. This can call eval. */
6194 prepare_menu_bars ()
6197 struct gcpro gcpro1
, gcpro2
;
6199 struct frame
*tooltip_frame
;
6201 #ifdef HAVE_X_WINDOWS
6202 tooltip_frame
= tip_frame
;
6204 tooltip_frame
= NULL
;
6207 /* Update all frame titles based on their buffer names, etc. We do
6208 this before the menu bars so that the buffer-menu will show the
6209 up-to-date frame titles. */
6210 #ifdef HAVE_WINDOW_SYSTEM
6211 if (windows_or_buffers_changed
|| update_mode_lines
)
6213 Lisp_Object tail
, frame
;
6215 FOR_EACH_FRAME (tail
, frame
)
6218 if (f
!= tooltip_frame
6219 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
6220 x_consider_frame_title (frame
);
6223 #endif /* HAVE_WINDOW_SYSTEM */
6225 /* Update the menu bar item lists, if appropriate. This has to be
6226 done before any actual redisplay or generation of display lines. */
6227 all_windows
= (update_mode_lines
6228 || buffer_shared
> 1
6229 || windows_or_buffers_changed
);
6232 Lisp_Object tail
, frame
;
6233 int count
= specpdl_ptr
- specpdl
;
6235 record_unwind_protect (Fset_match_data
, Fmatch_data (Qnil
, Qnil
));
6237 FOR_EACH_FRAME (tail
, frame
)
6241 /* Ignore tooltip frame. */
6242 if (f
== tooltip_frame
)
6245 /* If a window on this frame changed size, report that to
6246 the user and clear the size-change flag. */
6247 if (FRAME_WINDOW_SIZES_CHANGED (f
))
6249 Lisp_Object functions
;
6251 /* Clear flag first in case we get an error below. */
6252 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
6253 functions
= Vwindow_size_change_functions
;
6254 GCPRO2 (tail
, functions
);
6256 while (CONSP (functions
))
6258 call1 (XCAR (functions
), frame
);
6259 functions
= XCDR (functions
);
6265 update_menu_bar (f
, 0);
6266 #ifdef HAVE_WINDOW_SYSTEM
6267 update_tool_bar (f
, 0);
6272 unbind_to (count
, Qnil
);
6276 struct frame
*sf
= SELECTED_FRAME ();
6277 update_menu_bar (sf
, 1);
6278 #ifdef HAVE_WINDOW_SYSTEM
6279 update_tool_bar (sf
, 1);
6283 /* Motif needs this. See comment in xmenu.c. Turn it off when
6284 pending_menu_activation is not defined. */
6285 #ifdef USE_X_TOOLKIT
6286 pending_menu_activation
= 0;
6291 /* Update the menu bar item list for frame F. This has to be done
6292 before we start to fill in any display lines, because it can call
6295 If SAVE_MATCH_DATA is non-zero, we must save and restore it here. */
6298 update_menu_bar (f
, save_match_data
)
6300 int save_match_data
;
6303 register struct window
*w
;
6305 window
= FRAME_SELECTED_WINDOW (f
);
6306 w
= XWINDOW (window
);
6308 if (update_mode_lines
)
6309 w
->update_mode_line
= Qt
;
6311 if (FRAME_WINDOW_P (f
)
6313 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
6314 FRAME_EXTERNAL_MENU_BAR (f
)
6316 FRAME_MENU_BAR_LINES (f
) > 0
6318 : FRAME_MENU_BAR_LINES (f
) > 0)
6320 /* If the user has switched buffers or windows, we need to
6321 recompute to reflect the new bindings. But we'll
6322 recompute when update_mode_lines is set too; that means
6323 that people can use force-mode-line-update to request
6324 that the menu bar be recomputed. The adverse effect on
6325 the rest of the redisplay algorithm is about the same as
6326 windows_or_buffers_changed anyway. */
6327 if (windows_or_buffers_changed
6328 || !NILP (w
->update_mode_line
)
6329 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
6330 < BUF_MODIFF (XBUFFER (w
->buffer
)))
6331 != !NILP (w
->last_had_star
))
6332 || ((!NILP (Vtransient_mark_mode
)
6333 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
6334 != !NILP (w
->region_showing
)))
6336 struct buffer
*prev
= current_buffer
;
6337 int count
= specpdl_ptr
- specpdl
;
6339 set_buffer_internal_1 (XBUFFER (w
->buffer
));
6340 if (save_match_data
)
6341 record_unwind_protect (Fset_match_data
, Fmatch_data (Qnil
, Qnil
));
6342 if (NILP (Voverriding_local_map_menu_flag
))
6344 specbind (Qoverriding_terminal_local_map
, Qnil
);
6345 specbind (Qoverriding_local_map
, Qnil
);
6348 /* Run the Lucid hook. */
6349 call1 (Vrun_hooks
, Qactivate_menubar_hook
);
6351 /* If it has changed current-menubar from previous value,
6352 really recompute the menu-bar from the value. */
6353 if (! NILP (Vlucid_menu_bar_dirty_flag
))
6354 call0 (Qrecompute_lucid_menubar
);
6356 safe_run_hooks (Qmenu_bar_update_hook
);
6357 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
6359 /* Redisplay the menu bar in case we changed it. */
6360 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
6361 if (FRAME_WINDOW_P (f
))
6362 set_frame_menubar (f
, 0, 0);
6364 /* On a terminal screen, the menu bar is an ordinary screen
6365 line, and this makes it get updated. */
6366 w
->update_mode_line
= Qt
;
6367 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI) */
6368 /* In the non-toolkit version, the menu bar is an ordinary screen
6369 line, and this makes it get updated. */
6370 w
->update_mode_line
= Qt
;
6371 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI) */
6373 unbind_to (count
, Qnil
);
6374 set_buffer_internal_1 (prev
);
6381 /***********************************************************************
6383 ***********************************************************************/
6385 #ifdef HAVE_WINDOW_SYSTEM
6387 /* Update the tool-bar item list for frame F. This has to be done
6388 before we start to fill in any display lines. Called from
6389 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
6390 and restore it here. */
6393 update_tool_bar (f
, save_match_data
)
6395 int save_match_data
;
6397 if (WINDOWP (f
->tool_bar_window
)
6398 && XFASTINT (XWINDOW (f
->tool_bar_window
)->height
) > 0)
6403 window
= FRAME_SELECTED_WINDOW (f
);
6404 w
= XWINDOW (window
);
6406 /* If the user has switched buffers or windows, we need to
6407 recompute to reflect the new bindings. But we'll
6408 recompute when update_mode_lines is set too; that means
6409 that people can use force-mode-line-update to request
6410 that the menu bar be recomputed. The adverse effect on
6411 the rest of the redisplay algorithm is about the same as
6412 windows_or_buffers_changed anyway. */
6413 if (windows_or_buffers_changed
6414 || !NILP (w
->update_mode_line
)
6415 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
6416 < BUF_MODIFF (XBUFFER (w
->buffer
)))
6417 != !NILP (w
->last_had_star
))
6418 || ((!NILP (Vtransient_mark_mode
)
6419 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
6420 != !NILP (w
->region_showing
)))
6422 struct buffer
*prev
= current_buffer
;
6423 int count
= specpdl_ptr
- specpdl
;
6425 /* Set current_buffer to the buffer of the selected
6426 window of the frame, so that we get the right local
6428 set_buffer_internal_1 (XBUFFER (w
->buffer
));
6430 /* Save match data, if we must. */
6431 if (save_match_data
)
6432 record_unwind_protect (Fset_match_data
, Fmatch_data (Qnil
, Qnil
));
6434 /* Make sure that we don't accidentally use bogus keymaps. */
6435 if (NILP (Voverriding_local_map_menu_flag
))
6437 specbind (Qoverriding_terminal_local_map
, Qnil
);
6438 specbind (Qoverriding_local_map
, Qnil
);
6441 /* Build desired tool-bar items from keymaps. */
6442 f
->desired_tool_bar_items
6443 = tool_bar_items (f
->desired_tool_bar_items
,
6444 &f
->n_desired_tool_bar_items
);
6446 /* Redisplay the tool-bar in case we changed it. */
6447 w
->update_mode_line
= Qt
;
6449 unbind_to (count
, Qnil
);
6450 set_buffer_internal_1 (prev
);
6456 /* Set F->desired_tool_bar_string to a Lisp string representing frame
6457 F's desired tool-bar contents. F->desired_tool_bar_items must have
6458 been set up previously by calling prepare_menu_bars. */
6461 build_desired_tool_bar_string (f
)
6464 int i
, size
, size_needed
, string_idx
;
6465 struct gcpro gcpro1
, gcpro2
, gcpro3
;
6466 Lisp_Object image
, plist
, props
;
6468 image
= plist
= props
= Qnil
;
6469 GCPRO3 (image
, plist
, props
);
6471 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
6472 Otherwise, make a new string. */
6474 /* The size of the string we might be able to reuse. */
6475 size
= (STRINGP (f
->desired_tool_bar_string
)
6476 ? XSTRING (f
->desired_tool_bar_string
)->size
6479 /* Each image in the string we build is preceded by a space,
6480 and there is a space at the end. */
6481 size_needed
= f
->n_desired_tool_bar_items
+ 1;
6483 /* Reuse f->desired_tool_bar_string, if possible. */
6484 if (size
< size_needed
)
6485 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
), ' ');
6488 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
6489 Fremove_text_properties (make_number (0), make_number (size
),
6490 props
, f
->desired_tool_bar_string
);
6493 /* Put a `display' property on the string for the images to display,
6494 put a `menu_item' property on tool-bar items with a value that
6495 is the index of the item in F's tool-bar item vector. */
6496 for (i
= 0, string_idx
= 0;
6497 i
< f
->n_desired_tool_bar_items
;
6498 ++i
, string_idx
+= 1)
6501 (XVECTOR (f->desired_tool_bar_items) \
6502 ->contents[i * TOOL_BAR_ITEM_NSLOTS + (IDX)])
6504 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
6505 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
6507 extern Lisp_Object QCrelief
, QCmargin
, QCalgorithm
, Qimage
;
6508 extern Lisp_Object Qlaplace
;
6510 /* If image is a vector, choose the image according to the
6512 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
6513 if (VECTORP (image
))
6515 enum tool_bar_item_image idx
;
6519 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
6520 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
6523 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
6524 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
6526 xassert (XVECTOR (image
)->size
>= idx
);
6527 image
= XVECTOR (image
)->contents
[idx
];
6530 /* Ignore invalid image specifications. */
6531 if (!valid_image_p (image
))
6534 /* Display the tool-bar button pressed, or depressed. */
6535 plist
= Fcopy_sequence (XCDR (image
));
6537 /* Compute margin and relief to draw. */
6538 relief
= tool_bar_button_relief
> 0 ? tool_bar_button_relief
: 3;
6539 margin
= relief
+ max (0, tool_bar_button_margin
);
6541 if (auto_raise_tool_bar_buttons_p
)
6543 /* Add a `:relief' property to the image spec if the item is
6547 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
6553 /* If image is selected, display it pressed, i.e. with a
6554 negative relief. If it's not selected, display it with a
6556 plist
= Fplist_put (plist
, QCrelief
,
6558 ? make_number (-relief
)
6559 : make_number (relief
)));
6563 /* Put a margin around the image. */
6565 plist
= Fplist_put (plist
, QCmargin
, make_number (margin
));
6567 /* If button is not enabled, make the image appear disabled by
6568 applying an appropriate algorithm to it. */
6570 plist
= Fplist_put (plist
, QCalgorithm
, Qlaplace
);
6572 /* Put a `display' text property on the string for the image to
6573 display. Put a `menu-item' property on the string that gives
6574 the start of this item's properties in the tool-bar items
6576 image
= Fcons (Qimage
, plist
);
6577 props
= list4 (Qdisplay
, image
,
6578 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
)),
6579 Fadd_text_properties (make_number (string_idx
),
6580 make_number (string_idx
+ 1),
6581 props
, f
->desired_tool_bar_string
);
6589 /* Display one line of the tool-bar of frame IT->f. */
6592 display_tool_bar_line (it
)
6595 struct glyph_row
*row
= it
->glyph_row
;
6596 int max_x
= it
->last_visible_x
;
6599 prepare_desired_row (row
);
6600 row
->y
= it
->current_y
;
6602 while (it
->current_x
< max_x
)
6604 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
6606 /* Get the next display element. */
6607 if (!get_next_display_element (it
))
6610 /* Produce glyphs. */
6611 x_before
= it
->current_x
;
6612 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
6613 PRODUCE_GLYPHS (it
);
6615 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
6620 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
6622 if (x
+ glyph
->pixel_width
> max_x
)
6624 /* Glyph doesn't fit on line. */
6625 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
6631 x
+= glyph
->pixel_width
;
6635 /* Stop at line ends. */
6636 if (ITERATOR_AT_END_OF_LINE_P (it
))
6639 set_iterator_to_next (it
);
6644 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
6645 extend_face_to_end_of_line (it
);
6646 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
6647 last
->right_box_line_p
= 1;
6648 compute_line_metrics (it
);
6650 /* If line is empty, make it occupy the rest of the tool-bar. */
6651 if (!row
->displays_text_p
)
6653 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
6654 row
->ascent
= row
->phys_ascent
= 0;
6657 row
->full_width_p
= 1;
6658 row
->continued_p
= 0;
6659 row
->truncated_on_left_p
= 0;
6660 row
->truncated_on_right_p
= 0;
6662 it
->current_x
= it
->hpos
= 0;
6663 it
->current_y
+= row
->height
;
6669 /* Value is the number of screen lines needed to make all tool-bar
6670 items of frame F visible. */
6673 tool_bar_lines_needed (f
)
6676 struct window
*w
= XWINDOW (f
->tool_bar_window
);
6679 /* Initialize an iterator for iteration over
6680 F->desired_tool_bar_string in the tool-bar window of frame F. */
6681 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
6682 it
.first_visible_x
= 0;
6683 it
.last_visible_x
= FRAME_WINDOW_WIDTH (f
) * CANON_X_UNIT (f
);
6684 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
6686 while (!ITERATOR_AT_END_P (&it
))
6688 it
.glyph_row
= w
->desired_matrix
->rows
;
6689 clear_glyph_row (it
.glyph_row
);
6690 display_tool_bar_line (&it
);
6693 return (it
.current_y
+ CANON_Y_UNIT (f
) - 1) / CANON_Y_UNIT (f
);
6697 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
6698 height should be changed. */
6701 redisplay_tool_bar (f
)
6706 struct glyph_row
*row
;
6707 int change_height_p
= 0;
6709 /* If frame hasn't a tool-bar window or if it is zero-height, don't
6710 do anything. This means you must start with tool-bar-lines
6711 non-zero to get the auto-sizing effect. Or in other words, you
6712 can turn off tool-bars by specifying tool-bar-lines zero. */
6713 if (!WINDOWP (f
->tool_bar_window
)
6714 || (w
= XWINDOW (f
->tool_bar_window
),
6715 XFASTINT (w
->height
) == 0))
6718 /* Set up an iterator for the tool-bar window. */
6719 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
6720 it
.first_visible_x
= 0;
6721 it
.last_visible_x
= FRAME_WINDOW_WIDTH (f
) * CANON_X_UNIT (f
);
6724 /* Build a string that represents the contents of the tool-bar. */
6725 build_desired_tool_bar_string (f
);
6726 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
6728 /* Display as many lines as needed to display all tool-bar items. */
6729 while (it
.current_y
< it
.last_visible_y
)
6730 display_tool_bar_line (&it
);
6732 /* It doesn't make much sense to try scrolling in the tool-bar
6733 window, so don't do it. */
6734 w
->desired_matrix
->no_scrolling_p
= 1;
6735 w
->must_be_updated_p
= 1;
6737 if (auto_resize_tool_bars_p
)
6741 /* If there are blank lines at the end, except for a partially
6742 visible blank line at the end that is smaller than
6743 CANON_Y_UNIT, change the tool-bar's height. */
6744 row
= it
.glyph_row
- 1;
6745 if (!row
->displays_text_p
6746 && row
->height
>= CANON_Y_UNIT (f
))
6747 change_height_p
= 1;
6749 /* If row displays tool-bar items, but is partially visible,
6750 change the tool-bar's height. */
6751 if (row
->displays_text_p
6752 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
6753 change_height_p
= 1;
6755 /* Resize windows as needed by changing the `tool-bar-lines'
6758 && (nlines
= tool_bar_lines_needed (f
),
6759 nlines
!= XFASTINT (w
->height
)))
6761 extern Lisp_Object Qtool_bar_lines
;
6764 XSETFRAME (frame
, f
);
6765 clear_glyph_matrix (w
->desired_matrix
);
6766 Fmodify_frame_parameters (frame
,
6767 Fcons (Fcons (Qtool_bar_lines
,
6768 make_number (nlines
)),
6770 fonts_changed_p
= 1;
6774 return change_height_p
;
6778 /* Get information about the tool-bar item which is displayed in GLYPH
6779 on frame F. Return in *PROP_IDX the index where tool-bar item
6780 properties start in F->current_tool_bar_items. Value is zero if
6781 GLYPH doesn't display a tool-bar item. */
6784 tool_bar_item_info (f
, glyph
, prop_idx
)
6786 struct glyph
*glyph
;
6792 /* Get the text property `menu-item' at pos. The value of that
6793 property is the start index of this item's properties in
6794 F->current_tool_bar_items. */
6795 prop
= Fget_text_property (make_number (glyph
->charpos
),
6796 Qmenu_item
, f
->current_tool_bar_string
);
6797 if (INTEGERP (prop
))
6799 *prop_idx
= XINT (prop
);
6808 #endif /* HAVE_WINDOW_SYSTEM */
6812 /************************************************************************
6813 Horizontal scrolling
6814 ************************************************************************/
6816 static int hscroll_window_tree
P_ ((Lisp_Object
));
6817 static int hscroll_windows
P_ ((Lisp_Object
));
6819 /* For all leaf windows in the window tree rooted at WINDOW, set their
6820 hscroll value so that PT is (i) visible in the window, and (ii) so
6821 that it is not within a certain margin at the window's left and
6822 right border. Value is non-zero if any window's hscroll has been
6826 hscroll_window_tree (window
)
6829 int hscrolled_p
= 0;
6831 while (WINDOWP (window
))
6833 struct window
*w
= XWINDOW (window
);
6835 if (WINDOWP (w
->hchild
))
6836 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
6837 else if (WINDOWP (w
->vchild
))
6838 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
6839 else if (w
->cursor
.vpos
>= 0)
6841 int hscroll_margin
, text_area_x
, text_area_y
;
6842 int text_area_width
, text_area_height
;
6843 struct glyph_row
*current_cursor_row
6844 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
6845 struct glyph_row
*desired_cursor_row
6846 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
6847 struct glyph_row
*cursor_row
6848 = (desired_cursor_row
->enabled_p
6849 ? desired_cursor_row
6850 : current_cursor_row
);
6852 window_box (w
, TEXT_AREA
, &text_area_x
, &text_area_y
,
6853 &text_area_width
, &text_area_height
);
6855 /* Scroll when cursor is inside this scroll margin. */
6856 hscroll_margin
= 5 * CANON_X_UNIT (XFRAME (w
->frame
));
6858 if ((XFASTINT (w
->hscroll
)
6859 && w
->cursor
.x
< hscroll_margin
)
6860 || (cursor_row
->enabled_p
6861 && cursor_row
->truncated_on_right_p
6862 && (w
->cursor
.x
> text_area_width
- hscroll_margin
)))
6866 struct buffer
*saved_current_buffer
;
6869 /* Find point in a display of infinite width. */
6870 saved_current_buffer
= current_buffer
;
6871 current_buffer
= XBUFFER (w
->buffer
);
6873 if (w
== XWINDOW (selected_window
))
6874 pt
= BUF_PT (current_buffer
);
6877 pt
= marker_position (w
->pointm
);
6878 pt
= max (BEGV
, pt
);
6882 /* Move iterator to pt starting at cursor_row->start in
6883 a line with infinite width. */
6884 init_to_row_start (&it
, w
, cursor_row
);
6885 it
.last_visible_x
= INFINITY
;
6886 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
6887 current_buffer
= saved_current_buffer
;
6889 /* Center cursor in window. */
6890 hscroll
= (max (0, it
.current_x
- text_area_width
/ 2)
6891 / CANON_X_UNIT (it
.f
));
6893 /* Don't call Fset_window_hscroll if value hasn't
6894 changed because it will prevent redisplay
6896 if (XFASTINT (w
->hscroll
) != hscroll
)
6898 Fset_window_hscroll (window
, make_number (hscroll
));
6907 /* Value is non-zero if hscroll of any leaf window has been changed. */
6912 /* Set hscroll so that cursor is visible and not inside horizontal
6913 scroll margins for all windows in the tree rooted at WINDOW. See
6914 also hscroll_window_tree above. Value is non-zero if any window's
6915 hscroll has been changed. If it has, desired matrices on the frame
6916 of WINDOW are cleared. */
6919 hscroll_windows (window
)
6922 int hscrolled_p
= hscroll_window_tree (window
);
6924 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
6930 /************************************************************************
6932 ************************************************************************/
6934 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
6935 to a non-zero value. This is sometimes handy to have in a debugger
6940 /* First and last unchanged row for try_window_id. */
6942 int debug_first_unchanged_at_end_vpos
;
6943 int debug_last_unchanged_at_beg_vpos
;
6945 /* Delta vpos and y. */
6947 int debug_dvpos
, debug_dy
;
6949 /* Delta in characters and bytes for try_window_id. */
6951 int debug_delta
, debug_delta_bytes
;
6953 /* Values of window_end_pos and window_end_vpos at the end of
6956 int debug_end_pos
, debug_end_vpos
;
6958 /* Append a string to W->desired_matrix->method. FMT is a printf
6959 format string. A1...A9 are a supplement for a variable-length
6960 argument list. If trace_redisplay_p is non-zero also printf the
6961 resulting string to stderr. */
6964 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
6967 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
6970 char *method
= w
->desired_matrix
->method
;
6971 int len
= strlen (method
);
6972 int size
= sizeof w
->desired_matrix
->method
;
6973 int remaining
= size
- len
- 1;
6975 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
6976 if (len
&& remaining
)
6982 strncpy (method
+ len
, buffer
, remaining
);
6984 if (trace_redisplay_p
)
6985 fprintf (stderr
, "%p (%s): %s\n",
6987 ((BUFFERP (w
->buffer
)
6988 && STRINGP (XBUFFER (w
->buffer
)->name
))
6989 ? (char *) XSTRING (XBUFFER (w
->buffer
)->name
)->data
6994 #endif /* GLYPH_DEBUG */
6997 /* This counter is used to clear the face cache every once in a while
6998 in redisplay_internal. It is incremented for each redisplay.
6999 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
7002 #define CLEAR_FACE_CACHE_COUNT 10000
7003 static int clear_face_cache_count
;
7005 /* Record the previous terminal frame we displayed. */
7007 static struct frame
*previous_terminal_frame
;
7009 /* Non-zero while redisplay_internal is in progress. */
7014 /* Value is non-zero if all changes in window W, which displays
7015 current_buffer, are in the text between START and END. START is a
7016 buffer position, END is given as a distance from Z. Used in
7017 redisplay_internal for display optimization. */
7020 text_outside_line_unchanged_p (w
, start
, end
)
7024 int unchanged_p
= 1;
7026 /* If text or overlays have changed, see where. */
7027 if (XFASTINT (w
->last_modified
) < MODIFF
7028 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
7030 /* Gap in the line? */
7031 if (GPT
< start
|| Z
- GPT
< end
)
7034 /* Changes start in front of the line, or end after it? */
7036 && (BEG_UNCHANGED
< start
- 1
7037 || END_UNCHANGED
< end
))
7040 /* If selective display, can't optimize if changes start at the
7041 beginning of the line. */
7043 && INTEGERP (current_buffer
->selective_display
)
7044 && XINT (current_buffer
->selective_display
) > 0
7045 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
7053 /* Do a frame update, taking possible shortcuts into account. This is
7054 the main external entry point for redisplay.
7056 If the last redisplay displayed an echo area message and that message
7057 is no longer requested, we clear the echo area or bring back the
7058 mini-buffer if that is in use. */
7063 redisplay_internal (0);
7066 /* Return 1 if point moved out of or into a composition. Otherwise
7067 return 0. PREV_BUF and PREV_PT are the last point buffer and
7068 position. BUF and PT are the current point buffer and position. */
7071 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
7072 struct buffer
*prev_buf
, *buf
;
7079 XSETBUFFER (buffer
, buf
);
7080 /* Check a composition at the last point if point moved within the
7082 if (prev_buf
== buf
)
7085 /* Point didn't move. */
7088 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
7089 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
7090 && COMPOSITION_VALID_P (start
, end
, prop
)
7091 && start
< prev_pt
&& end
> prev_pt
)
7092 /* The last point was within the composition. Return 1 iff
7093 point moved out of the composition. */
7094 return (pt
<= start
|| pt
>= end
);
7097 /* Check a composition at the current point. */
7098 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
7099 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
7100 && COMPOSITION_VALID_P (start
, end
, prop
)
7101 && start
< pt
&& end
> pt
);
7104 /* Reconsider the setting of B->clip_changed which is displayed
7108 reconsider_clip_changes (w
, b
)
7112 if (b
->prevent_redisplay_optimizations_p
)
7113 b
->clip_changed
= 1;
7114 else if (b
->clip_changed
7115 && !NILP (w
->window_end_valid
)
7116 && w
->current_matrix
->buffer
== b
7117 && w
->current_matrix
->zv
== BUF_ZV (b
)
7118 && w
->current_matrix
->begv
== BUF_BEGV (b
))
7119 b
->clip_changed
= 0;
7121 /* If display wasn't paused, and W is not a tool bar window, see if
7122 point has been moved into or out of a composition. In that case,
7123 we set b->clip_changed to 1 to force updating the screen. If
7124 b->clip_changed has already been set to 1, we can skip this
7126 if (!b
->clip_changed
7127 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
7131 if (w
== XWINDOW (selected_window
))
7132 pt
= BUF_PT (current_buffer
);
7134 pt
= marker_position (w
->pointm
);
7136 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
7137 || pt
!= w
->last_point
)
7138 && check_point_in_composition (w
->current_matrix
->buffer
,
7140 XBUFFER (w
->buffer
), pt
))
7141 b
->clip_changed
= 1;
7146 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
7147 response to any user action; therefore, we should preserve the echo
7148 area. (Actually, our caller does that job.) Perhaps in the future
7149 avoid recentering windows if it is not necessary; currently that
7150 causes some problems. */
7153 redisplay_internal (preserve_echo_area
)
7154 int preserve_echo_area
;
7156 struct window
*w
= XWINDOW (selected_window
);
7157 struct frame
*f
= XFRAME (w
->frame
);
7159 int must_finish
= 0;
7160 struct text_pos tlbufpos
, tlendpos
;
7161 int number_of_visible_frames
;
7163 struct frame
*sf
= SELECTED_FRAME ();
7165 /* Non-zero means redisplay has to consider all windows on all
7166 frames. Zero means, only selected_window is considered. */
7167 int consider_all_windows_p
;
7169 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
7171 /* No redisplay if running in batch mode or frame is not yet fully
7172 initialized, or redisplay is explicitly turned off by setting
7173 Vinhibit_redisplay. */
7175 || !NILP (Vinhibit_redisplay
)
7176 || !f
->glyphs_initialized_p
)
7179 /* The flag redisplay_performed_directly_p is set by
7180 direct_output_for_insert when it already did the whole screen
7181 update necessary. */
7182 if (redisplay_performed_directly_p
)
7184 redisplay_performed_directly_p
= 0;
7185 if (!hscroll_windows (selected_window
))
7189 #ifdef USE_X_TOOLKIT
7190 if (popup_activated ())
7194 /* I don't think this happens but let's be paranoid. */
7198 /* Record a function that resets redisplaying_p to its old value
7199 when we leave this function. */
7200 count
= specpdl_ptr
- specpdl
;
7201 record_unwind_protect (unwind_redisplay
, make_number (redisplaying_p
));
7206 reconsider_clip_changes (w
, current_buffer
);
7208 /* If new fonts have been loaded that make a glyph matrix adjustment
7209 necessary, do it. */
7210 if (fonts_changed_p
)
7212 adjust_glyphs (NULL
);
7213 ++windows_or_buffers_changed
;
7214 fonts_changed_p
= 0;
7217 if (! FRAME_WINDOW_P (sf
)
7218 && previous_terminal_frame
!= sf
)
7220 /* Since frames on an ASCII terminal share the same display
7221 area, displaying a different frame means redisplay the whole
7223 windows_or_buffers_changed
++;
7224 SET_FRAME_GARBAGED (sf
);
7225 XSETFRAME (Vterminal_frame
, sf
);
7227 previous_terminal_frame
= sf
;
7229 /* Set the visible flags for all frames. Do this before checking
7230 for resized or garbaged frames; they want to know if their frames
7231 are visible. See the comment in frame.h for
7232 FRAME_SAMPLE_VISIBILITY. */
7234 Lisp_Object tail
, frame
;
7236 number_of_visible_frames
= 0;
7238 FOR_EACH_FRAME (tail
, frame
)
7240 struct frame
*f
= XFRAME (frame
);
7242 FRAME_SAMPLE_VISIBILITY (f
);
7243 if (FRAME_VISIBLE_P (f
))
7244 ++number_of_visible_frames
;
7245 clear_desired_matrices (f
);
7249 /* Notice any pending interrupt request to change frame size. */
7250 do_pending_window_change (1);
7252 /* Clear frames marked as garbaged. */
7254 clear_garbaged_frames ();
7256 /* Build menubar and tool-bar items. */
7257 prepare_menu_bars ();
7259 if (windows_or_buffers_changed
)
7260 update_mode_lines
++;
7262 /* Detect case that we need to write or remove a star in the mode line. */
7263 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
7265 w
->update_mode_line
= Qt
;
7266 if (buffer_shared
> 1)
7267 update_mode_lines
++;
7270 /* If %c is in the mode line, update it if needed. */
7271 if (!NILP (w
->column_number_displayed
)
7272 /* This alternative quickly identifies a common case
7273 where no change is needed. */
7274 && !(PT
== XFASTINT (w
->last_point
)
7275 && XFASTINT (w
->last_modified
) >= MODIFF
7276 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
7277 && XFASTINT (w
->column_number_displayed
) != current_column ())
7278 w
->update_mode_line
= Qt
;
7280 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
7282 /* The variable buffer_shared is set in redisplay_window and
7283 indicates that we redisplay a buffer in different windows. See
7285 consider_all_windows_p
= update_mode_lines
|| buffer_shared
> 1;
7287 /* If specs for an arrow have changed, do thorough redisplay
7288 to ensure we remove any arrow that should no longer exist. */
7289 if (! EQ (COERCE_MARKER (Voverlay_arrow_position
), last_arrow_position
)
7290 || ! EQ (Voverlay_arrow_string
, last_arrow_string
))
7291 consider_all_windows_p
= windows_or_buffers_changed
= 1;
7293 /* Normally the message* functions will have already displayed and
7294 updated the echo area, but the frame may have been trashed, or
7295 the update may have been preempted, so display the echo area
7296 again here. Checking both message buffers captures the case that
7297 the echo area should be cleared. */
7298 if (!NILP (echo_area_buffer
[0]) || !NILP (echo_area_buffer
[1]))
7300 int window_height_changed_p
= echo_area_display (0);
7303 if (fonts_changed_p
)
7305 else if (window_height_changed_p
)
7307 consider_all_windows_p
= 1;
7308 ++update_mode_lines
;
7309 ++windows_or_buffers_changed
;
7311 /* If window configuration was changed, frames may have been
7312 marked garbaged. Clear them or we will experience
7313 surprises wrt scrolling. */
7315 clear_garbaged_frames ();
7318 else if (w
== XWINDOW (minibuf_window
)
7319 && (current_buffer
->clip_changed
7320 || XFASTINT (w
->last_modified
) < MODIFF
7321 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
7322 && resize_mini_window (w
, 0))
7324 /* Resized active mini-window to fit the size of what it is
7325 showing if its contents might have changed. */
7327 consider_all_windows_p
= 1;
7328 ++windows_or_buffers_changed
;
7329 ++update_mode_lines
;
7331 /* If window configuration was changed, frames may have been
7332 marked garbaged. Clear them or we will experience
7333 surprises wrt scrolling. */
7335 clear_garbaged_frames ();
7339 /* If showing the region, and mark has changed, we must redisplay
7340 the whole window. The assignment to this_line_start_pos prevents
7341 the optimization directly below this if-statement. */
7342 if (((!NILP (Vtransient_mark_mode
)
7343 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
7344 != !NILP (w
->region_showing
))
7345 || (!NILP (w
->region_showing
)
7346 && !EQ (w
->region_showing
,
7347 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
7348 CHARPOS (this_line_start_pos
) = 0;
7350 /* Optimize the case that only the line containing the cursor in the
7351 selected window has changed. Variables starting with this_ are
7352 set in display_line and record information about the line
7353 containing the cursor. */
7354 tlbufpos
= this_line_start_pos
;
7355 tlendpos
= this_line_end_pos
;
7356 if (!consider_all_windows_p
7357 && CHARPOS (tlbufpos
) > 0
7358 && NILP (w
->update_mode_line
)
7359 && !current_buffer
->clip_changed
7360 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
7361 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
7362 /* Make sure recorded data applies to current buffer, etc. */
7363 && this_line_buffer
== current_buffer
7364 && current_buffer
== XBUFFER (w
->buffer
)
7365 && NILP (w
->force_start
)
7366 /* Point must be on the line that we have info recorded about. */
7367 && PT
>= CHARPOS (tlbufpos
)
7368 && PT
<= Z
- CHARPOS (tlendpos
)
7369 /* All text outside that line, including its final newline,
7370 must be unchanged */
7371 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
7372 CHARPOS (tlendpos
)))
7374 if (CHARPOS (tlbufpos
) > BEGV
7375 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
7376 && (CHARPOS (tlbufpos
) == ZV
7377 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
7378 /* Former continuation line has disappeared by becoming empty */
7380 else if (XFASTINT (w
->last_modified
) < MODIFF
7381 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
7382 || MINI_WINDOW_P (w
))
7384 /* We have to handle the case of continuation around a
7385 wide-column character (See the comment in indent.c around
7388 For instance, in the following case:
7390 -------- Insert --------
7391 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
7392 J_I_ ==> J_I_ `^^' are cursors.
7396 As we have to redraw the line above, we should goto cancel. */
7399 int line_height_before
= this_line_pixel_height
;
7401 /* Note that start_display will handle the case that the
7402 line starting at tlbufpos is a continuation lines. */
7403 start_display (&it
, w
, tlbufpos
);
7405 /* Implementation note: It this still necessary? */
7406 if (it
.current_x
!= this_line_start_x
)
7409 TRACE ((stderr
, "trying display optimization 1\n"));
7410 w
->cursor
.vpos
= -1;
7411 overlay_arrow_seen
= 0;
7412 it
.vpos
= this_line_vpos
;
7413 it
.current_y
= this_line_y
;
7414 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
7417 /* If line contains point, is not continued,
7418 and ends at same distance from eob as before, we win */
7419 if (w
->cursor
.vpos
>= 0
7420 /* Line is not continued, otherwise this_line_start_pos
7421 would have been set to 0 in display_line. */
7422 && CHARPOS (this_line_start_pos
)
7423 /* Line ends as before. */
7424 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
7425 /* Line has same height as before. Otherwise other lines
7426 would have to be shifted up or down. */
7427 && this_line_pixel_height
== line_height_before
)
7429 /* If this is not the window's last line, we must adjust
7430 the charstarts of the lines below. */
7431 if (it
.current_y
< it
.last_visible_y
)
7433 struct glyph_row
*row
7434 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
7435 int delta
, delta_bytes
;
7437 if (Z
- CHARPOS (tlendpos
) == ZV
)
7439 /* This line ends at end of (accessible part of)
7440 buffer. There is no newline to count. */
7442 - CHARPOS (tlendpos
)
7443 - MATRIX_ROW_START_CHARPOS (row
));
7444 delta_bytes
= (Z_BYTE
7445 - BYTEPOS (tlendpos
)
7446 - MATRIX_ROW_START_BYTEPOS (row
));
7450 /* This line ends in a newline. Must take
7451 account of the newline and the rest of the
7452 text that follows. */
7454 - CHARPOS (tlendpos
)
7455 - MATRIX_ROW_START_CHARPOS (row
));
7456 delta_bytes
= (Z_BYTE
7457 - BYTEPOS (tlendpos
)
7458 - MATRIX_ROW_START_BYTEPOS (row
));
7461 increment_glyph_matrix_buffer_positions (w
->current_matrix
,
7463 w
->current_matrix
->nrows
,
7464 delta
, delta_bytes
);
7467 /* If this row displays text now but previously didn't,
7468 or vice versa, w->window_end_vpos may have to be
7470 if ((it
.glyph_row
- 1)->displays_text_p
)
7472 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
7473 XSETINT (w
->window_end_vpos
, this_line_vpos
);
7475 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
7476 && this_line_vpos
> 0)
7477 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
7478 w
->window_end_valid
= Qnil
;
7480 /* Update hint: No need to try to scroll in update_window. */
7481 w
->desired_matrix
->no_scrolling_p
= 1;
7484 *w
->desired_matrix
->method
= 0;
7485 debug_method_add (w
, "optimization 1");
7492 else if (/* Cursor position hasn't changed. */
7493 PT
== XFASTINT (w
->last_point
)
7494 /* Make sure the cursor was last displayed
7495 in this window. Otherwise we have to reposition it. */
7496 && 0 <= w
->cursor
.vpos
7497 && XINT (w
->height
) > w
->cursor
.vpos
)
7501 do_pending_window_change (1);
7503 /* We used to always goto end_of_redisplay here, but this
7504 isn't enough if we have a blinking cursor. */
7505 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
7506 goto end_of_redisplay
;
7510 /* If highlighting the region, or if the cursor is in the echo area,
7511 then we can't just move the cursor. */
7512 else if (! (!NILP (Vtransient_mark_mode
)
7513 && !NILP (current_buffer
->mark_active
))
7514 && (w
== XWINDOW (current_buffer
->last_selected_window
)
7515 || highlight_nonselected_windows
)
7516 && NILP (w
->region_showing
)
7517 && NILP (Vshow_trailing_whitespace
)
7518 && !cursor_in_echo_area
)
7521 struct glyph_row
*row
;
7523 /* Skip from tlbufpos to PT and see where it is. Note that
7524 PT may be in invisible text. If so, we will end at the
7525 next visible position. */
7526 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
7527 NULL
, DEFAULT_FACE_ID
);
7528 it
.current_x
= this_line_start_x
;
7529 it
.current_y
= this_line_y
;
7530 it
.vpos
= this_line_vpos
;
7532 /* The call to move_it_to stops in front of PT, but
7533 moves over before-strings. */
7534 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
7536 if (it
.vpos
== this_line_vpos
7537 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
7540 xassert (this_line_vpos
== it
.vpos
);
7541 xassert (this_line_y
== it
.current_y
);
7542 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
7550 /* Text changed drastically or point moved off of line. */
7551 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
7554 CHARPOS (this_line_start_pos
) = 0;
7555 consider_all_windows_p
|= buffer_shared
> 1;
7556 ++clear_face_cache_count
;
7559 /* Build desired matrices. If consider_all_windows_p is non-zero,
7560 do it for all windows on all frames. Otherwise do it for
7561 selected_window, only. */
7563 if (consider_all_windows_p
)
7565 Lisp_Object tail
, frame
;
7567 /* Clear the face cache eventually. */
7568 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
7570 clear_face_cache (0);
7571 clear_face_cache_count
= 0;
7574 /* Recompute # windows showing selected buffer. This will be
7575 incremented each time such a window is displayed. */
7578 FOR_EACH_FRAME (tail
, frame
)
7580 struct frame
*f
= XFRAME (frame
);
7581 if (FRAME_WINDOW_P (f
) || f
== sf
)
7583 /* Mark all the scroll bars to be removed; we'll redeem
7584 the ones we want when we redisplay their windows. */
7585 if (condemn_scroll_bars_hook
)
7586 (*condemn_scroll_bars_hook
) (f
);
7588 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
7589 redisplay_windows (FRAME_ROOT_WINDOW (f
));
7591 /* Any scroll bars which redisplay_windows should have
7592 nuked should now go away. */
7593 if (judge_scroll_bars_hook
)
7594 (*judge_scroll_bars_hook
) (f
);
7598 else if (FRAME_VISIBLE_P (sf
)
7599 && !FRAME_OBSCURED_P (sf
))
7600 redisplay_window (selected_window
, 1);
7603 /* Compare desired and current matrices, perform output. */
7607 /* If fonts changed, display again. */
7608 if (fonts_changed_p
)
7611 /* Prevent various kinds of signals during display update.
7612 stdio is not robust about handling signals,
7613 which can cause an apparent I/O error. */
7614 if (interrupt_input
)
7618 if (consider_all_windows_p
)
7627 /* See if we have to hscroll. */
7628 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
7629 if (FRAMEP (XCAR (tail
)))
7631 f
= XFRAME (XCAR (tail
));
7633 if ((FRAME_WINDOW_P (f
)
7635 && FRAME_VISIBLE_P (f
)
7636 && !FRAME_OBSCURED_P (f
)
7637 && hscroll_windows (f
->root_window
))
7644 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
7646 if (!FRAMEP (XCAR (tail
)))
7649 f
= XFRAME (XCAR (tail
));
7651 if ((FRAME_WINDOW_P (f
) || f
== sf
)
7652 && FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
7654 /* Mark all windows as to be updated. */
7655 set_window_update_flags (XWINDOW (f
->root_window
), 1);
7656 pause
|= update_frame (f
, 0, 0);
7659 mark_window_display_accurate (f
->root_window
, 1);
7660 if (frame_up_to_date_hook
!= 0)
7661 (*frame_up_to_date_hook
) (f
);
7668 if (FRAME_VISIBLE_P (sf
)
7669 && !FRAME_OBSCURED_P (sf
))
7671 if (hscroll_windows (selected_window
))
7674 XWINDOW (selected_window
)->must_be_updated_p
= 1;
7675 pause
= update_frame (sf
, 0, 0);
7680 /* We may have called echo_area_display at the top of this
7681 function. If the echo area is on another frame, that may
7682 have put text on a frame other than the selected one, so the
7683 above call to update_frame would not have caught it. Catch
7686 Lisp_Object mini_window
;
7687 struct frame
*mini_frame
;
7689 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7690 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
7692 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
7694 XWINDOW (mini_window
)->must_be_updated_p
= 1;
7695 pause
|= update_frame (mini_frame
, 0, 0);
7696 if (!pause
&& hscroll_windows (mini_window
))
7702 /* If display was paused because of pending input, make sure we do a
7703 thorough update the next time. */
7706 /* Prevent the optimization at the beginning of
7707 redisplay_internal that tries a single-line update of the
7708 line containing the cursor in the selected window. */
7709 CHARPOS (this_line_start_pos
) = 0;
7711 /* Let the overlay arrow be updated the next time. */
7712 if (!NILP (last_arrow_position
))
7714 last_arrow_position
= Qt
;
7715 last_arrow_string
= Qt
;
7718 /* If we pause after scrolling, some rows in the current
7719 matrices of some windows are not valid. */
7720 if (!WINDOW_FULL_WIDTH_P (w
)
7721 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
7722 update_mode_lines
= 1;
7725 /* Now text on frame agrees with windows, so put info into the
7726 windows for partial redisplay to follow. */
7729 register struct buffer
*b
= XBUFFER (w
->buffer
);
7731 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
7732 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
7733 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
7734 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
7736 if (consider_all_windows_p
)
7737 mark_window_display_accurate (FRAME_ROOT_WINDOW (sf
), 1);
7740 XSETFASTINT (w
->last_point
, BUF_PT (b
));
7741 w
->last_cursor
= w
->cursor
;
7742 w
->last_cursor_off_p
= w
->cursor_off_p
;
7744 b
->clip_changed
= 0;
7745 b
->prevent_redisplay_optimizations_p
= 0;
7746 w
->update_mode_line
= Qnil
;
7747 XSETFASTINT (w
->last_modified
, BUF_MODIFF (b
));
7748 XSETFASTINT (w
->last_overlay_modified
, BUF_OVERLAY_MODIFF (b
));
7750 = (BUF_MODIFF (XBUFFER (w
->buffer
)) > BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
7753 /* Record if we are showing a region, so can make sure to
7754 update it fully at next redisplay. */
7755 w
->region_showing
= (!NILP (Vtransient_mark_mode
)
7756 && (w
== XWINDOW (current_buffer
->last_selected_window
)
7757 || highlight_nonselected_windows
)
7758 && !NILP (XBUFFER (w
->buffer
)->mark_active
)
7759 ? Fmarker_position (XBUFFER (w
->buffer
)->mark
)
7762 w
->window_end_valid
= w
->buffer
;
7763 last_arrow_position
= COERCE_MARKER (Voverlay_arrow_position
);
7764 last_arrow_string
= Voverlay_arrow_string
;
7765 if (frame_up_to_date_hook
!= 0)
7766 (*frame_up_to_date_hook
) (sf
);
7768 w
->current_matrix
->buffer
= b
;
7769 w
->current_matrix
->begv
= BUF_BEGV (b
);
7770 w
->current_matrix
->zv
= BUF_ZV (b
);
7773 update_mode_lines
= 0;
7774 windows_or_buffers_changed
= 0;
7777 /* Start SIGIO interrupts coming again. Having them off during the
7778 code above makes it less likely one will discard output, but not
7779 impossible, since there might be stuff in the system buffer here.
7780 But it is much hairier to try to do anything about that. */
7781 if (interrupt_input
)
7785 /* If a frame has become visible which was not before, redisplay
7786 again, so that we display it. Expose events for such a frame
7787 (which it gets when becoming visible) don't call the parts of
7788 redisplay constructing glyphs, so simply exposing a frame won't
7789 display anything in this case. So, we have to display these
7790 frames here explicitly. */
7793 Lisp_Object tail
, frame
;
7796 FOR_EACH_FRAME (tail
, frame
)
7798 int this_is_visible
= 0;
7800 if (XFRAME (frame
)->visible
)
7801 this_is_visible
= 1;
7802 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
7803 if (XFRAME (frame
)->visible
)
7804 this_is_visible
= 1;
7806 if (this_is_visible
)
7810 if (new_count
!= number_of_visible_frames
)
7811 windows_or_buffers_changed
++;
7814 /* Change frame size now if a change is pending. */
7815 do_pending_window_change (1);
7817 /* If we just did a pending size change, or have additional
7818 visible frames, redisplay again. */
7819 if (windows_or_buffers_changed
&& !pause
)
7824 unbind_to (count
, Qnil
);
7828 /* Redisplay, but leave alone any recent echo area message unless
7829 another message has been requested in its place.
7831 This is useful in situations where you need to redisplay but no
7832 user action has occurred, making it inappropriate for the message
7833 area to be cleared. See tracking_off and
7834 wait_reading_process_input for examples of these situations. */
7837 redisplay_preserve_echo_area ()
7839 if (!NILP (echo_area_buffer
[1]))
7841 /* We have a previously displayed message, but no current
7842 message. Redisplay the previous message. */
7843 display_last_displayed_message_p
= 1;
7844 redisplay_internal (1);
7845 display_last_displayed_message_p
= 0;
7848 redisplay_internal (1);
7852 /* Function registered with record_unwind_protect in
7853 redisplay_internal. Clears the flag indicating that a redisplay is
7857 unwind_redisplay (old_redisplaying_p
)
7858 Lisp_Object old_redisplaying_p
;
7860 redisplaying_p
= XFASTINT (old_redisplaying_p
);
7865 /* Mark the display of windows in the window tree rooted at WINDOW as
7866 accurate or inaccurate. If FLAG is non-zero mark display of WINDOW
7867 as accurate. If FLAG is zero arrange for WINDOW to be redisplayed
7868 the next time redisplay_internal is called. */
7871 mark_window_display_accurate (window
, accurate_p
)
7877 for (; !NILP (window
); window
= w
->next
)
7879 w
= XWINDOW (window
);
7881 if (BUFFERP (w
->buffer
))
7883 struct buffer
*b
= XBUFFER (w
->buffer
);
7885 XSETFASTINT (w
->last_modified
,
7886 accurate_p
? BUF_MODIFF (b
) : 0);
7887 XSETFASTINT (w
->last_overlay_modified
,
7888 accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
7889 w
->last_had_star
= (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
)
7892 #if 0 /* I don't think this is necessary because display_line does it.
7894 /* Record if we are showing a region, so can make sure to
7895 update it fully at next redisplay. */
7897 = (!NILP (Vtransient_mark_mode
)
7898 && (w
== XWINDOW (current_buffer
->last_selected_window
)
7899 || highlight_nonselected_windows
)
7900 && (!NILP (b
->mark_active
)
7901 ? Fmarker_position (b
->mark
)
7907 b
->clip_changed
= 0;
7908 b
->prevent_redisplay_optimizations_p
= 0;
7909 w
->current_matrix
->buffer
= b
;
7910 w
->current_matrix
->begv
= BUF_BEGV (b
);
7911 w
->current_matrix
->zv
= BUF_ZV (b
);
7912 w
->last_cursor
= w
->cursor
;
7913 w
->last_cursor_off_p
= w
->cursor_off_p
;
7914 if (w
== XWINDOW (selected_window
))
7915 w
->last_point
= BUF_PT (b
);
7917 w
->last_point
= XMARKER (w
->pointm
)->charpos
;
7921 w
->window_end_valid
= w
->buffer
;
7922 w
->update_mode_line
= Qnil
;
7924 if (!NILP (w
->vchild
))
7925 mark_window_display_accurate (w
->vchild
, accurate_p
);
7926 if (!NILP (w
->hchild
))
7927 mark_window_display_accurate (w
->hchild
, accurate_p
);
7932 last_arrow_position
= COERCE_MARKER (Voverlay_arrow_position
);
7933 last_arrow_string
= Voverlay_arrow_string
;
7937 /* Force a thorough redisplay the next time by setting
7938 last_arrow_position and last_arrow_string to t, which is
7939 unequal to any useful value of Voverlay_arrow_... */
7940 last_arrow_position
= Qt
;
7941 last_arrow_string
= Qt
;
7946 /* Return value in display table DP (Lisp_Char_Table *) for character
7947 C. Since a display table doesn't have any parent, we don't have to
7948 follow parent. Do not call this function directly but use the
7949 macro DISP_CHAR_VECTOR. */
7952 disp_char_vector (dp
, c
)
7953 struct Lisp_Char_Table
*dp
;
7959 if (SINGLE_BYTE_CHAR_P (c
))
7960 return (dp
->contents
[c
]);
7962 SPLIT_NON_ASCII_CHAR (c
, code
[0], code
[1], code
[2]);
7965 else if (code
[2] < 32)
7968 /* Here, the possible range of code[0] (== charset ID) is
7969 128..max_charset. Since the top level char table contains data
7970 for multibyte characters after 256th element, we must increment
7971 code[0] by 128 to get a correct index. */
7973 code
[3] = -1; /* anchor */
7975 for (i
= 0; code
[i
] >= 0; i
++, dp
= XCHAR_TABLE (val
))
7977 val
= dp
->contents
[code
[i
]];
7978 if (!SUB_CHAR_TABLE_P (val
))
7979 return (NILP (val
) ? dp
->defalt
: val
);
7982 /* Here, val is a sub char table. We return the default value of
7984 return (dp
->defalt
);
7989 /***********************************************************************
7991 ***********************************************************************/
7993 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
7996 redisplay_windows (window
)
7999 while (!NILP (window
))
8001 struct window
*w
= XWINDOW (window
);
8003 if (!NILP (w
->hchild
))
8004 redisplay_windows (w
->hchild
);
8005 else if (!NILP (w
->vchild
))
8006 redisplay_windows (w
->vchild
);
8008 redisplay_window (window
, 0);
8015 /* Set cursor position of W. PT is assumed to be displayed in ROW.
8016 DELTA is the number of bytes by which positions recorded in ROW
8017 differ from current buffer positions. */
8020 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
8022 struct glyph_row
*row
;
8023 struct glyph_matrix
*matrix
;
8024 int delta
, delta_bytes
, dy
, dvpos
;
8026 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
8027 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
8029 int pt_old
= PT
- delta
;
8031 /* Skip over glyphs not having an object at the start of the row.
8032 These are special glyphs like truncation marks on terminal
8034 if (row
->displays_text_p
)
8037 && glyph
->charpos
< 0)
8039 x
+= glyph
->pixel_width
;
8045 && (!BUFFERP (glyph
->object
)
8046 || glyph
->charpos
< pt_old
))
8048 x
+= glyph
->pixel_width
;
8052 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
8054 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
8055 w
->cursor
.y
= row
->y
+ dy
;
8057 if (w
== XWINDOW (selected_window
))
8059 if (!row
->continued_p
8060 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
8063 this_line_buffer
= XBUFFER (w
->buffer
);
8065 CHARPOS (this_line_start_pos
)
8066 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
8067 BYTEPOS (this_line_start_pos
)
8068 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
8070 CHARPOS (this_line_end_pos
)
8071 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
8072 BYTEPOS (this_line_end_pos
)
8073 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
8075 this_line_y
= w
->cursor
.y
;
8076 this_line_pixel_height
= row
->height
;
8077 this_line_vpos
= w
->cursor
.vpos
;
8078 this_line_start_x
= row
->x
;
8081 CHARPOS (this_line_start_pos
) = 0;
8086 /* Run window scroll functions, if any, for WINDOW with new window
8087 start STARTP. Sets the window start of WINDOW to that position.
8089 We assume that the window's buffer is really current. */
8091 static INLINE
struct text_pos
8092 run_window_scroll_functions (window
, startp
)
8094 struct text_pos startp
;
8096 struct window
*w
= XWINDOW (window
);
8097 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
8099 if (current_buffer
!= XBUFFER (w
->buffer
))
8102 if (!NILP (Vwindow_scroll_functions
))
8104 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
8105 make_number (CHARPOS (startp
)));
8106 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
8107 /* In case the hook functions switch buffers. */
8108 if (current_buffer
!= XBUFFER (w
->buffer
))
8109 set_buffer_internal_1 (XBUFFER (w
->buffer
));
8116 /* Modify the desired matrix of window W and W->vscroll so that the
8117 line containing the cursor is fully visible. */
8120 make_cursor_line_fully_visible (w
)
8123 struct glyph_matrix
*matrix
;
8124 struct glyph_row
*row
;
8125 int header_line_height
;
8127 /* It's not always possible to find the cursor, e.g, when a window
8128 is full of overlay strings. Don't do anything in that case. */
8129 if (w
->cursor
.vpos
< 0)
8132 matrix
= w
->desired_matrix
;
8133 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
8135 /* If row->y == top y of window display area, the window isn't tall
8136 enough to display a single line. There is nothing we can do
8138 header_line_height
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
);
8139 if (row
->y
== header_line_height
)
8142 if (MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (w
, row
))
8144 int dy
= row
->height
- row
->visible_height
;
8147 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
8149 else if (MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P (w
, row
))
8151 int dy
= - (row
->height
- row
->visible_height
);
8154 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
8157 /* When we change the cursor y-position of the selected window,
8158 change this_line_y as well so that the display optimization for
8159 the cursor line of the selected window in redisplay_internal uses
8160 the correct y-position. */
8161 if (w
== XWINDOW (selected_window
))
8162 this_line_y
= w
->cursor
.y
;
8166 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
8167 non-zero means only WINDOW is redisplayed in redisplay_internal.
8168 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
8169 in redisplay_window to bring a partially visible line into view in
8170 the case that only the cursor has moved.
8174 1 if scrolling succeeded
8176 0 if scrolling didn't find point.
8178 -1 if new fonts have been loaded so that we must interrupt
8179 redisplay, adjust glyph matrices, and try again. */
8182 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
8183 scroll_step
, temp_scroll_step
)
8185 int just_this_one_p
;
8186 int scroll_conservatively
, scroll_step
;
8187 int temp_scroll_step
;
8189 struct window
*w
= XWINDOW (window
);
8190 struct frame
*f
= XFRAME (w
->frame
);
8191 struct text_pos scroll_margin_pos
;
8192 struct text_pos pos
;
8193 struct text_pos startp
;
8195 Lisp_Object window_end
;
8196 int this_scroll_margin
;
8199 int line_height
, rc
;
8200 int amount_to_scroll
= 0;
8201 Lisp_Object aggressive
;
8205 debug_method_add (w
, "try_scrolling");
8208 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
8210 /* Compute scroll margin height in pixels. We scroll when point is
8211 within this distance from the top or bottom of the window. */
8212 if (scroll_margin
> 0)
8214 this_scroll_margin
= min (scroll_margin
, XINT (w
->height
) / 4);
8215 this_scroll_margin
*= CANON_Y_UNIT (f
);
8218 this_scroll_margin
= 0;
8220 /* Compute how much we should try to scroll maximally to bring point
8223 scroll_max
= scroll_step
;
8224 else if (scroll_conservatively
)
8225 scroll_max
= scroll_conservatively
;
8226 else if (temp_scroll_step
)
8227 scroll_max
= temp_scroll_step
;
8228 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
8229 || NUMBERP (current_buffer
->scroll_up_aggressively
))
8230 /* We're trying to scroll because of aggressive scrolling
8231 but no scroll_step is set. Choose an arbitrary one. Maybe
8232 there should be a variable for this. */
8236 scroll_max
*= CANON_Y_UNIT (f
);
8238 /* Decide whether we have to scroll down. Start at the window end
8239 and move this_scroll_margin up to find the position of the scroll
8241 window_end
= Fwindow_end (window
, Qt
);
8242 CHARPOS (scroll_margin_pos
) = XINT (window_end
);
8243 BYTEPOS (scroll_margin_pos
) = CHAR_TO_BYTE (CHARPOS (scroll_margin_pos
));
8244 if (this_scroll_margin
)
8246 start_display (&it
, w
, scroll_margin_pos
);
8247 move_it_vertically (&it
, - this_scroll_margin
);
8248 scroll_margin_pos
= it
.current
.pos
;
8251 if (PT
>= CHARPOS (scroll_margin_pos
))
8255 /* Point is in the scroll margin at the bottom of the window, or
8256 below. Compute a new window start that makes point visible. */
8258 /* Compute the distance from the scroll margin to PT.
8259 Give up if the distance is greater than scroll_max. */
8260 start_display (&it
, w
, scroll_margin_pos
);
8262 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
8263 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
8264 line_height
= (it
.max_ascent
+ it
.max_descent
8265 ? it
.max_ascent
+ it
.max_descent
8267 dy
= it
.current_y
+ line_height
- y0
;
8268 if (dy
> scroll_max
)
8271 /* Move the window start down. If scrolling conservatively,
8272 move it just enough down to make point visible. If
8273 scroll_step is set, move it down by scroll_step. */
8274 start_display (&it
, w
, startp
);
8276 if (scroll_conservatively
)
8277 amount_to_scroll
= dy
;
8278 else if (scroll_step
|| temp_scroll_step
)
8279 amount_to_scroll
= scroll_max
;
8282 aggressive
= current_buffer
->scroll_down_aggressively
;
8283 height
= (WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE (w
)
8284 - WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
));
8285 if (NUMBERP (aggressive
))
8286 amount_to_scroll
= XFLOATINT (aggressive
) * height
;
8289 if (amount_to_scroll
<= 0)
8292 move_it_vertically (&it
, amount_to_scroll
);
8293 startp
= it
.current
.pos
;
8297 /* See if point is inside the scroll margin at the top of the
8299 scroll_margin_pos
= startp
;
8300 if (this_scroll_margin
)
8302 start_display (&it
, w
, startp
);
8303 move_it_vertically (&it
, this_scroll_margin
);
8304 scroll_margin_pos
= it
.current
.pos
;
8307 if (PT
< CHARPOS (scroll_margin_pos
))
8309 /* Point is in the scroll margin at the top of the window or
8310 above what is displayed in the window. */
8313 /* Compute the vertical distance from PT to the scroll
8314 margin position. Give up if distance is greater than
8316 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
8317 start_display (&it
, w
, pos
);
8319 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
8320 it
.last_visible_y
, -1,
8321 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
8322 dy
= it
.current_y
- y0
;
8323 if (dy
> scroll_max
)
8326 /* Compute new window start. */
8327 start_display (&it
, w
, startp
);
8329 if (scroll_conservatively
)
8330 amount_to_scroll
= dy
;
8331 else if (scroll_step
|| temp_scroll_step
)
8332 amount_to_scroll
= scroll_max
;
8335 aggressive
= current_buffer
->scroll_up_aggressively
;
8336 height
= (WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE (w
)
8337 - WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
));
8338 if (NUMBERP (aggressive
))
8339 amount_to_scroll
= XFLOATINT (aggressive
) * height
;
8342 if (amount_to_scroll
<= 0)
8345 move_it_vertically (&it
, - amount_to_scroll
);
8346 startp
= it
.current
.pos
;
8350 /* Run window scroll functions. */
8351 startp
= run_window_scroll_functions (window
, startp
);
8353 /* Display the window. Give up if new fonts are loaded, or if point
8355 if (!try_window (window
, startp
))
8357 else if (w
->cursor
.vpos
< 0)
8359 clear_glyph_matrix (w
->desired_matrix
);
8364 /* Maybe forget recorded base line for line number display. */
8365 if (!just_this_one_p
8366 || current_buffer
->clip_changed
8367 || BEG_UNCHANGED
< CHARPOS (startp
))
8368 w
->base_line_number
= Qnil
;
8370 /* If cursor ends up on a partially visible line, shift display
8371 lines up or down. */
8372 make_cursor_line_fully_visible (w
);
8380 /* Compute a suitable window start for window W if display of W starts
8381 on a continuation line. Value is non-zero if a new window start
8384 The new window start will be computed, based on W's width, starting
8385 from the start of the continued line. It is the start of the
8386 screen line with the minimum distance from the old start W->start. */
8389 compute_window_start_on_continuation_line (w
)
8392 struct text_pos pos
, start_pos
;
8393 int window_start_changed_p
= 0;
8395 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
8397 /* If window start is on a continuation line... Window start may be
8398 < BEGV in case there's invisible text at the start of the
8399 buffer (M-x rmail, for example). */
8400 if (CHARPOS (start_pos
) > BEGV
8401 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
8404 struct glyph_row
*row
;
8406 /* Handle the case that the window start is out of range. */
8407 if (CHARPOS (start_pos
) < BEGV
)
8408 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
8409 else if (CHARPOS (start_pos
) > ZV
)
8410 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
8412 /* Find the start of the continued line. This should be fast
8413 because scan_buffer is fast (newline cache). */
8414 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
8415 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
8416 row
, DEFAULT_FACE_ID
);
8417 reseat_at_previous_visible_line_start (&it
);
8419 /* If the line start is "too far" away from the window start,
8420 say it takes too much time to compute a new window start. */
8421 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
8422 < XFASTINT (w
->height
) * XFASTINT (w
->width
))
8424 int min_distance
, distance
;
8426 /* Move forward by display lines to find the new window
8427 start. If window width was enlarged, the new start can
8428 be expected to be > the old start. If window width was
8429 decreased, the new window start will be < the old start.
8430 So, we're looking for the display line start with the
8431 minimum distance from the old window start. */
8432 pos
= it
.current
.pos
;
8433 min_distance
= INFINITY
;
8434 while ((distance
= abs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
8435 distance
< min_distance
)
8437 min_distance
= distance
;
8438 pos
= it
.current
.pos
;
8439 move_it_by_lines (&it
, 1, 0);
8442 /* Set the window start there. */
8443 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
8444 window_start_changed_p
= 1;
8448 return window_start_changed_p
;
8452 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
8453 selected_window is redisplayed. */
8456 redisplay_window (window
, just_this_one_p
)
8458 int just_this_one_p
;
8460 struct window
*w
= XWINDOW (window
);
8461 struct frame
*f
= XFRAME (w
->frame
);
8462 struct buffer
*buffer
= XBUFFER (w
->buffer
);
8463 struct buffer
*old
= current_buffer
;
8464 struct text_pos lpoint
, opoint
, startp
;
8465 int update_mode_line
;
8468 /* Record it now because it's overwritten. */
8469 int current_matrix_up_to_date_p
= 0;
8470 int really_switched_buffer
= 0;
8471 int temp_scroll_step
= 0;
8472 int count
= specpdl_ptr
- specpdl
;
8474 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
8477 /* W must be a leaf window here. */
8478 xassert (!NILP (w
->buffer
));
8480 *w
->desired_matrix
->method
= 0;
8483 specbind (Qinhibit_point_motion_hooks
, Qt
);
8485 reconsider_clip_changes (w
, buffer
);
8487 /* Has the mode line to be updated? */
8488 update_mode_line
= (!NILP (w
->update_mode_line
)
8489 || update_mode_lines
8490 || buffer
->clip_changed
);
8492 if (MINI_WINDOW_P (w
))
8494 if (w
== XWINDOW (echo_area_window
)
8495 && !NILP (echo_area_buffer
[0]))
8497 if (update_mode_line
)
8498 /* We may have to update a tty frame's menu bar or a
8499 tool-bar. Example `M-x C-h C-h C-g'. */
8500 goto finish_menu_bars
;
8502 /* We've already displayed the echo area glyphs in this window. */
8503 goto finish_scroll_bars
;
8505 else if (w
!= XWINDOW (minibuf_window
))
8507 /* W is a mini-buffer window, but it's not the currently
8508 active one, so clear it. */
8509 int yb
= window_text_bottom_y (w
);
8510 struct glyph_row
*row
;
8513 for (y
= 0, row
= w
->desired_matrix
->rows
;
8515 y
+= row
->height
, ++row
)
8516 blank_row (w
, row
, y
);
8517 goto finish_scroll_bars
;
8521 /* Otherwise set up data on this window; select its buffer and point
8523 if (update_mode_line
)
8525 /* Really select the buffer, for the sake of buffer-local
8527 set_buffer_internal_1 (XBUFFER (w
->buffer
));
8528 really_switched_buffer
= 1;
8531 set_buffer_temp (XBUFFER (w
->buffer
));
8532 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
8534 current_matrix_up_to_date_p
8535 = (!NILP (w
->window_end_valid
)
8536 && !current_buffer
->clip_changed
8537 && XFASTINT (w
->last_modified
) >= MODIFF
8538 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
8540 /* When windows_or_buffers_changed is non-zero, we can't rely on
8541 the window end being valid, so set it to nil there. */
8542 if (windows_or_buffers_changed
)
8544 /* If window starts on a continuation line, maybe adjust the
8545 window start in case the window's width changed. */
8546 if (XMARKER (w
->start
)->buffer
== current_buffer
)
8547 compute_window_start_on_continuation_line (w
);
8549 w
->window_end_valid
= Qnil
;
8552 /* Some sanity checks. */
8553 CHECK_WINDOW_END (w
);
8554 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
8556 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
8559 /* If %c is in mode line, update it if needed. */
8560 if (!NILP (w
->column_number_displayed
)
8561 /* This alternative quickly identifies a common case
8562 where no change is needed. */
8563 && !(PT
== XFASTINT (w
->last_point
)
8564 && XFASTINT (w
->last_modified
) >= MODIFF
8565 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
8566 && XFASTINT (w
->column_number_displayed
) != current_column ())
8567 update_mode_line
= 1;
8569 /* Count number of windows showing the selected buffer. An indirect
8570 buffer counts as its base buffer. */
8571 if (!just_this_one_p
)
8573 struct buffer
*current_base
, *window_base
;
8574 current_base
= current_buffer
;
8575 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
8576 if (current_base
->base_buffer
)
8577 current_base
= current_base
->base_buffer
;
8578 if (window_base
->base_buffer
)
8579 window_base
= window_base
->base_buffer
;
8580 if (current_base
== window_base
)
8584 /* Point refers normally to the selected window. For any other
8585 window, set up appropriate value. */
8586 if (!EQ (window
, selected_window
))
8588 int new_pt
= XMARKER (w
->pointm
)->charpos
;
8589 int new_pt_byte
= marker_byte_position (w
->pointm
);
8593 new_pt_byte
= BEGV_BYTE
;
8594 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
8596 else if (new_pt
> (ZV
- 1))
8599 new_pt_byte
= ZV_BYTE
;
8600 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
8603 /* We don't use SET_PT so that the point-motion hooks don't run. */
8604 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
8607 /* If any of the character widths specified in the display table
8608 have changed, invalidate the width run cache. It's true that
8609 this may be a bit late to catch such changes, but the rest of
8610 redisplay goes (non-fatally) haywire when the display table is
8611 changed, so why should we worry about doing any better? */
8612 if (current_buffer
->width_run_cache
)
8614 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
8616 if (! disptab_matches_widthtab (disptab
,
8617 XVECTOR (current_buffer
->width_table
)))
8619 invalidate_region_cache (current_buffer
,
8620 current_buffer
->width_run_cache
,
8622 recompute_width_table (current_buffer
, disptab
);
8626 /* If window-start is screwed up, choose a new one. */
8627 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
8630 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
8632 /* If someone specified a new starting point but did not insist,
8633 check whether it can be used. */
8634 if (!NILP (w
->optional_new_start
)
8635 && CHARPOS (startp
) >= BEGV
8636 && CHARPOS (startp
) <= ZV
)
8638 w
->optional_new_start
= Qnil
;
8639 /* This takes a mini-buffer prompt into account. */
8640 start_display (&it
, w
, startp
);
8641 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
8642 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
8643 if (IT_CHARPOS (it
) == PT
)
8644 w
->force_start
= Qt
;
8647 /* Handle case where place to start displaying has been specified,
8648 unless the specified location is outside the accessible range. */
8649 if (!NILP (w
->force_start
)
8650 || w
->frozen_window_start_p
)
8652 w
->force_start
= Qnil
;
8654 w
->window_end_valid
= Qnil
;
8656 /* Forget any recorded base line for line number display. */
8657 if (!current_matrix_up_to_date_p
8658 || current_buffer
->clip_changed
)
8659 w
->base_line_number
= Qnil
;
8661 /* Redisplay the mode line. Select the buffer properly for that.
8662 Also, run the hook window-scroll-functions
8663 because we have scrolled. */
8664 /* Note, we do this after clearing force_start because
8665 if there's an error, it is better to forget about force_start
8666 than to get into an infinite loop calling the hook functions
8667 and having them get more errors. */
8668 if (!update_mode_line
8669 || ! NILP (Vwindow_scroll_functions
))
8671 if (!really_switched_buffer
)
8673 set_buffer_temp (old
);
8674 set_buffer_internal_1 (XBUFFER (w
->buffer
));
8675 really_switched_buffer
= 1;
8678 update_mode_line
= 1;
8679 w
->update_mode_line
= Qt
;
8680 startp
= run_window_scroll_functions (window
, startp
);
8683 XSETFASTINT (w
->last_modified
, 0);
8684 XSETFASTINT (w
->last_overlay_modified
, 0);
8685 if (CHARPOS (startp
) < BEGV
)
8686 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
8687 else if (CHARPOS (startp
) > ZV
)
8688 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
8690 /* Redisplay, then check if cursor has been set during the
8691 redisplay. Give up if new fonts were loaded. */
8692 if (!try_window (window
, startp
))
8694 w
->force_start
= Qt
;
8695 clear_glyph_matrix (w
->desired_matrix
);
8696 goto restore_buffers
;
8699 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
8701 /* If point does not appear, or on a line that is not fully
8702 visible, move point so it does appear. The desired
8703 matrix has been built above, so we can use it. */
8704 int height
= window_box_height (w
) / 2;
8705 struct glyph_row
*row
= MATRIX_ROW (w
->desired_matrix
, 0);
8707 while (row
->y
< height
)
8710 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
8711 MATRIX_ROW_START_BYTEPOS (row
));
8713 if (w
!= XWINDOW (selected_window
))
8714 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
8715 else if (current_buffer
== old
)
8716 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
8718 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
8720 /* If we are highlighting the region, then we just changed
8721 the region, so redisplay to show it. */
8722 if (!NILP (Vtransient_mark_mode
)
8723 && !NILP (current_buffer
->mark_active
))
8725 clear_glyph_matrix (w
->desired_matrix
);
8726 if (!try_window (window
, startp
))
8727 goto restore_buffers
;
8731 make_cursor_line_fully_visible (w
);
8733 debug_method_add (w
, "forced window start");
8738 /* Handle case where text has not changed, only point, and it has
8739 not moved off the frame. */
8740 if (current_matrix_up_to_date_p
8741 /* Point may be in this window. */
8742 && PT
>= CHARPOS (startp
)
8743 /* If we don't check this, we are called to move the cursor in a
8744 horizontally split window with a current matrix that doesn't
8746 && !windows_or_buffers_changed
8747 /* Selective display hasn't changed. */
8748 && !current_buffer
->clip_changed
8749 /* If force-mode-line-update was called, really redisplay;
8750 that's how redisplay is forced after e.g. changing
8751 buffer-invisibility-spec. */
8752 && NILP (w
->update_mode_line
)
8753 /* Can't use this case if highlighting a region. When a
8754 region exists, cursor movement has to do more than just
8756 && !(!NILP (Vtransient_mark_mode
)
8757 && !NILP (current_buffer
->mark_active
))
8758 && NILP (w
->region_showing
)
8759 && NILP (Vshow_trailing_whitespace
)
8760 /* Right after splitting windows, last_point may be nil. */
8761 && INTEGERP (w
->last_point
)
8762 /* This code is not used for mini-buffer for the sake of the case
8763 of redisplaying to replace an echo area message; since in
8764 that case the mini-buffer contents per se are usually
8765 unchanged. This code is of no real use in the mini-buffer
8766 since the handling of this_line_start_pos, etc., in redisplay
8767 handles the same cases. */
8768 && !EQ (window
, minibuf_window
)
8769 /* When splitting windows or for new windows, it happens that
8770 redisplay is called with a nil window_end_vpos or one being
8771 larger than the window. This should really be fixed in
8772 window.c. I don't have this on my list, now, so we do
8773 approximately the same as the old redisplay code. --gerd. */
8774 && INTEGERP (w
->window_end_vpos
)
8775 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
8776 && (FRAME_WINDOW_P (f
)
8777 || !MARKERP (Voverlay_arrow_position
)
8778 || current_buffer
!= XMARKER (Voverlay_arrow_position
)->buffer
))
8780 int this_scroll_margin
;
8781 struct glyph_row
*row
;
8785 debug_method_add (w
, "cursor movement");
8788 /* Scroll if point within this distance from the top or bottom
8789 of the window. This is a pixel value. */
8790 this_scroll_margin
= max (0, scroll_margin
);
8791 this_scroll_margin
= min (this_scroll_margin
, XFASTINT (w
->height
) / 4);
8792 this_scroll_margin
*= CANON_Y_UNIT (f
);
8794 /* Start with the row the cursor was displayed during the last
8795 not paused redisplay. Give up if that row is not valid. */
8796 if (w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
8798 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
8799 if (row
->mode_line_p
)
8801 if (!row
->enabled_p
)
8805 if (PT
> XFASTINT (w
->last_point
))
8807 /* Point has moved forward. */
8808 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
8810 while ((MATRIX_ROW_END_CHARPOS (row
) < PT
8811 /* The end position of a row equals the start
8812 position of the next row. If PT is there, we
8813 would rather display it in the next line, except
8814 when this line ends in ZV. */
8815 || (MATRIX_ROW_END_CHARPOS (row
) == PT
8816 && (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)
8817 || !row
->ends_at_zv_p
)))
8818 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
8820 xassert (row
->enabled_p
);
8824 /* If within the scroll margin, scroll. Note that
8825 MATRIX_ROW_BOTTOM_Y gives the pixel position at which the
8826 next line would be drawn, and that this_scroll_margin can
8828 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
8829 || PT
> MATRIX_ROW_END_CHARPOS (row
)
8830 /* Line is completely visible last line in window and PT
8831 is to be set in the next line. */
8832 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
8833 && PT
== MATRIX_ROW_END_CHARPOS (row
)
8834 && !row
->ends_at_zv_p
8835 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
8838 else if (PT
< XFASTINT (w
->last_point
))
8840 /* Cursor has to be moved backward. Note that PT >=
8841 CHARPOS (startp) because of the outer if-statement. */
8842 while (!row
->mode_line_p
8843 && (MATRIX_ROW_START_CHARPOS (row
) > PT
8844 || (MATRIX_ROW_START_CHARPOS (row
) == PT
8845 && MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)))
8846 && (row
->y
> this_scroll_margin
8847 || CHARPOS (startp
) == BEGV
))
8849 xassert (row
->enabled_p
);
8853 /* Consider the following case: Window starts at BEGV, there
8854 is invisible, intangible text at BEGV, so that display
8855 starts at some point START > BEGV. It can happen that
8856 we are called with PT somewhere between BEGV and START.
8857 Try to handle that case. */
8858 if (row
< w
->current_matrix
->rows
8859 || row
->mode_line_p
)
8861 row
= w
->current_matrix
->rows
;
8862 if (row
->mode_line_p
)
8866 /* Due to newlines in overlay strings, we may have to skip
8867 forward over overlay strings. */
8868 while (MATRIX_ROW_END_CHARPOS (row
) == PT
8869 && MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P (row
)
8870 && !row
->ends_at_zv_p
)
8873 /* If within the scroll margin, scroll. */
8874 if (row
->y
< this_scroll_margin
8875 && CHARPOS (startp
) != BEGV
)
8879 /* if PT is not in the glyph row, give up. */
8880 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
8881 || PT
> MATRIX_ROW_END_CHARPOS (row
))
8884 /* If we end up in a partially visible line, let's make it fully
8885 visible. This can be done most easily by using the existing
8887 if (MATRIX_ROW_PARTIALLY_VISIBLE_P (row
))
8889 temp_scroll_step
= 1;
8895 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
8899 /* If current starting point was originally the beginning of a line
8900 but no longer is, find a new starting point. */
8901 else if (!NILP (w
->start_at_line_beg
)
8902 && !(CHARPOS (startp
) <= BEGV
8903 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
8906 debug_method_add (w
, "recenter 1");
8911 /* Try scrolling with try_window_id. */
8912 else if (/* Windows and buffers haven't changed. */
8913 !windows_or_buffers_changed
8914 /* Window must be either use window-based redisplay or
8916 && (FRAME_WINDOW_P (f
)
8917 || (line_ins_del_ok
&& WINDOW_FULL_WIDTH_P (w
)))
8918 && !MINI_WINDOW_P (w
)
8919 /* Point is not known NOT to appear in window. */
8920 && PT
>= CHARPOS (startp
)
8921 && XFASTINT (w
->last_modified
)
8922 /* Window is not hscrolled. */
8923 && XFASTINT (w
->hscroll
) == 0
8924 /* Selective display has not changed. */
8925 && !current_buffer
->clip_changed
8926 /* Current matrix is up to date. */
8927 && !NILP (w
->window_end_valid
)
8928 /* Can't use this case if highlighting a region because
8929 a cursor movement will do more than just set the cursor. */
8930 && !(!NILP (Vtransient_mark_mode
)
8931 && !NILP (current_buffer
->mark_active
))
8932 && NILP (w
->region_showing
)
8933 && NILP (Vshow_trailing_whitespace
)
8934 /* Overlay arrow position and string not changed. */
8935 && EQ (last_arrow_position
, COERCE_MARKER (Voverlay_arrow_position
))
8936 && EQ (last_arrow_string
, Voverlay_arrow_string
)
8937 /* Value is > 0 if update has been done, it is -1 if we
8938 know that the same window start will not work. It is 0
8939 if unsuccessful for some other reason. */
8940 && (tem
= try_window_id (w
)) != 0)
8943 debug_method_add (w
, "try_window_id");
8946 if (fonts_changed_p
)
8947 goto restore_buffers
;
8950 /* Otherwise try_window_id has returned -1 which means that we
8951 don't want the alternative below this comment to execute. */
8953 else if (CHARPOS (startp
) >= BEGV
8954 && CHARPOS (startp
) <= ZV
8955 && PT
>= CHARPOS (startp
)
8956 && (CHARPOS (startp
) < ZV
8957 /* Avoid starting at end of buffer. */
8958 || CHARPOS (startp
) == BEGV
8959 || (XFASTINT (w
->last_modified
) >= MODIFF
8960 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
8963 debug_method_add (w
, "same window start");
8966 /* Try to redisplay starting at same place as before.
8967 If point has not moved off frame, accept the results. */
8968 if (!current_matrix_up_to_date_p
8969 /* Don't use try_window_reusing_current_matrix in this case
8970 because it can have changed the buffer. */
8971 || !NILP (Vwindow_scroll_functions
)
8972 || MINI_WINDOW_P (w
)
8973 || !try_window_reusing_current_matrix (w
))
8975 IF_DEBUG (debug_method_add (w
, "1"));
8976 try_window (window
, startp
);
8979 if (fonts_changed_p
)
8980 goto restore_buffers
;
8982 if (w
->cursor
.vpos
>= 0)
8984 if (!just_this_one_p
8985 || current_buffer
->clip_changed
8986 || BEG_UNCHANGED
< CHARPOS (startp
))
8987 /* Forget any recorded base line for line number display. */
8988 w
->base_line_number
= Qnil
;
8990 make_cursor_line_fully_visible (w
);
8994 clear_glyph_matrix (w
->desired_matrix
);
8999 XSETFASTINT (w
->last_modified
, 0);
9000 XSETFASTINT (w
->last_overlay_modified
, 0);
9002 /* Redisplay the mode line. Select the buffer properly for that. */
9003 if (!update_mode_line
)
9005 if (!really_switched_buffer
)
9007 set_buffer_temp (old
);
9008 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9009 really_switched_buffer
= 1;
9011 update_mode_line
= 1;
9012 w
->update_mode_line
= Qt
;
9015 /* Try to scroll by specified few lines. */
9016 if ((scroll_conservatively
9019 || NUMBERP (current_buffer
->scroll_up_aggressively
)
9020 || NUMBERP (current_buffer
->scroll_down_aggressively
))
9021 && !current_buffer
->clip_changed
9022 && CHARPOS (startp
) >= BEGV
9023 && CHARPOS (startp
) <= ZV
)
9025 /* The function returns -1 if new fonts were loaded, 1 if
9026 successful, 0 if not successful. */
9027 int rc
= try_scrolling (window
, just_this_one_p
,
9028 scroll_conservatively
,
9034 goto restore_buffers
;
9037 /* Finally, just choose place to start which centers point */
9042 debug_method_add (w
, "recenter");
9045 /* w->vscroll = 0; */
9047 /* Forget any previously recorded base line for line number display. */
9048 if (!current_matrix_up_to_date_p
9049 || current_buffer
->clip_changed
)
9050 w
->base_line_number
= Qnil
;
9052 /* Move backward half the height of the window. */
9053 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
9054 it
.current_y
= it
.last_visible_y
;
9055 move_it_vertically_backward (&it
, it
.last_visible_y
/ 2);
9056 xassert (IT_CHARPOS (it
) >= BEGV
);
9058 /* The function move_it_vertically_backward may move over more
9059 than the specified y-distance. If it->w is small, e.g. a
9060 mini-buffer window, we may end up in front of the window's
9061 display area. Start displaying at the start of the line
9062 containing PT in this case. */
9063 if (it
.current_y
<= 0)
9065 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
9066 move_it_vertically (&it
, 0);
9067 xassert (IT_CHARPOS (it
) <= PT
);
9071 it
.current_x
= it
.hpos
= 0;
9073 /* Set startp here explicitly in case that helps avoid an infinite loop
9074 in case the window-scroll-functions functions get errors. */
9075 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
9077 /* Run scroll hooks. */
9078 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
9080 /* Redisplay the window. */
9081 if (!current_matrix_up_to_date_p
9082 || windows_or_buffers_changed
9083 /* Don't use try_window_reusing_current_matrix in this case
9084 because it can have changed the buffer. */
9085 || !NILP (Vwindow_scroll_functions
)
9087 || MINI_WINDOW_P (w
)
9088 || !try_window_reusing_current_matrix (w
))
9089 try_window (window
, startp
);
9091 /* If new fonts have been loaded (due to fontsets), give up. We
9092 have to start a new redisplay since we need to re-adjust glyph
9094 if (fonts_changed_p
)
9095 goto restore_buffers
;
9097 /* If cursor did not appear assume that the middle of the window is
9098 in the first line of the window. Do it again with the next line.
9099 (Imagine a window of height 100, displaying two lines of height
9100 60. Moving back 50 from it->last_visible_y will end in the first
9102 if (w
->cursor
.vpos
< 0)
9104 if (!NILP (w
->window_end_valid
)
9105 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
9107 clear_glyph_matrix (w
->desired_matrix
);
9108 move_it_by_lines (&it
, 1, 0);
9109 try_window (window
, it
.current
.pos
);
9111 else if (PT
< IT_CHARPOS (it
))
9113 clear_glyph_matrix (w
->desired_matrix
);
9114 move_it_by_lines (&it
, -1, 0);
9115 try_window (window
, it
.current
.pos
);
9119 /* Not much we can do about it. */
9123 /* Consider the following case: Window starts at BEGV, there is
9124 invisible, intangible text at BEGV, so that display starts at
9125 some point START > BEGV. It can happen that we are called with
9126 PT somewhere between BEGV and START. Try to handle that case. */
9127 if (w
->cursor
.vpos
< 0)
9129 struct glyph_row
*row
= w
->current_matrix
->rows
;
9130 if (row
->mode_line_p
)
9132 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
9135 make_cursor_line_fully_visible (w
);
9139 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
9140 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
9141 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
9144 /* Display the mode line, if we must. */
9145 if ((update_mode_line
9146 /* If window not full width, must redo its mode line
9147 if (a) the window to its side is being redone and
9148 (b) we do a frame-based redisplay. This is a consequence
9149 of how inverted lines are drawn in frame-based redisplay. */
9150 || (!just_this_one_p
9151 && !FRAME_WINDOW_P (f
)
9152 && !WINDOW_FULL_WIDTH_P (w
))
9153 /* Line number to display. */
9154 || INTEGERP (w
->base_line_pos
)
9155 /* Column number is displayed and different from the one displayed. */
9156 || (!NILP (w
->column_number_displayed
)
9157 && XFASTINT (w
->column_number_displayed
) != current_column ()))
9158 /* This means that the window has a mode line. */
9159 && (WINDOW_WANTS_MODELINE_P (w
)
9160 || WINDOW_WANTS_HEADER_LINE_P (w
)))
9162 display_mode_lines (w
);
9164 /* If mode line height has changed, arrange for a thorough
9165 immediate redisplay using the correct mode line height. */
9166 if (WINDOW_WANTS_MODELINE_P (w
)
9167 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
9169 fonts_changed_p
= 1;
9170 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
9171 = DESIRED_MODE_LINE_HEIGHT (w
);
9174 /* If top line height has changed, arrange for a thorough
9175 immediate redisplay using the correct mode line height. */
9176 if (WINDOW_WANTS_HEADER_LINE_P (w
)
9177 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
9179 fonts_changed_p
= 1;
9180 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
9181 = DESIRED_HEADER_LINE_HEIGHT (w
);
9184 if (fonts_changed_p
)
9185 goto restore_buffers
;
9188 if (!line_number_displayed
9189 && !BUFFERP (w
->base_line_pos
))
9191 w
->base_line_pos
= Qnil
;
9192 w
->base_line_number
= Qnil
;
9197 /* When we reach a frame's selected window, redo the frame's menu bar. */
9198 if (update_mode_line
9199 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
9201 int redisplay_menu_p
= 0;
9203 if (FRAME_WINDOW_P (f
))
9205 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
9206 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
9208 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
9212 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
9214 if (redisplay_menu_p
)
9215 display_menu_bar (w
);
9217 #ifdef HAVE_WINDOW_SYSTEM
9218 if (WINDOWP (f
->tool_bar_window
)
9219 && (FRAME_TOOL_BAR_LINES (f
) > 0
9220 || auto_resize_tool_bars_p
))
9221 redisplay_tool_bar (f
);
9227 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
))
9229 int start
, end
, whole
;
9231 /* Calculate the start and end positions for the current window.
9232 At some point, it would be nice to choose between scrollbars
9233 which reflect the whole buffer size, with special markers
9234 indicating narrowing, and scrollbars which reflect only the
9237 Note that mini-buffers sometimes aren't displaying any text. */
9238 if (!MINI_WINDOW_P (w
)
9239 || (w
== XWINDOW (minibuf_window
)
9240 && NILP (echo_area_buffer
[0])))
9243 start
= marker_position (w
->start
) - BEGV
;
9244 /* I don't think this is guaranteed to be right. For the
9245 moment, we'll pretend it is. */
9246 end
= (Z
- XFASTINT (w
->window_end_pos
)) - BEGV
;
9250 if (whole
< (end
- start
))
9251 whole
= end
- start
;
9254 start
= end
= whole
= 0;
9256 /* Indicate what this scroll bar ought to be displaying now. */
9257 (*set_vertical_scroll_bar_hook
) (w
, end
- start
, whole
, start
);
9259 /* Note that we actually used the scroll bar attached to this
9260 window, so it shouldn't be deleted at the end of redisplay. */
9261 (*redeem_scroll_bar_hook
) (w
);
9266 /* Restore current_buffer and value of point in it. */
9267 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
9268 if (really_switched_buffer
)
9269 set_buffer_internal_1 (old
);
9271 set_buffer_temp (old
);
9272 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
9274 unbind_to (count
, Qnil
);
9278 /* Build the complete desired matrix of WINDOW with a window start
9279 buffer position POS. Value is non-zero if successful. It is zero
9280 if fonts were loaded during redisplay which makes re-adjusting
9281 glyph matrices necessary. */
9284 try_window (window
, pos
)
9286 struct text_pos pos
;
9288 struct window
*w
= XWINDOW (window
);
9290 struct glyph_row
*last_text_row
= NULL
;
9292 /* Make POS the new window start. */
9293 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
9295 /* Mark cursor position as unknown. No overlay arrow seen. */
9296 w
->cursor
.vpos
= -1;
9297 overlay_arrow_seen
= 0;
9299 /* Initialize iterator and info to start at POS. */
9300 start_display (&it
, w
, pos
);
9302 /* Display all lines of W. */
9303 while (it
.current_y
< it
.last_visible_y
)
9305 if (display_line (&it
))
9306 last_text_row
= it
.glyph_row
- 1;
9307 if (fonts_changed_p
)
9311 /* If bottom moved off end of frame, change mode line percentage. */
9312 if (XFASTINT (w
->window_end_pos
) <= 0
9313 && Z
!= IT_CHARPOS (it
))
9314 w
->update_mode_line
= Qt
;
9316 /* Set window_end_pos to the offset of the last character displayed
9317 on the window from the end of current_buffer. Set
9318 window_end_vpos to its row number. */
9321 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
9322 w
->window_end_bytepos
9323 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
9324 XSETFASTINT (w
->window_end_pos
,
9325 Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
9326 XSETFASTINT (w
->window_end_vpos
,
9327 MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
9328 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
9333 w
->window_end_bytepos
= 0;
9334 XSETFASTINT (w
->window_end_pos
, 0);
9335 XSETFASTINT (w
->window_end_vpos
, 0);
9338 /* But that is not valid info until redisplay finishes. */
9339 w
->window_end_valid
= Qnil
;
9345 /************************************************************************
9346 Window redisplay reusing current matrix when buffer has not changed
9347 ************************************************************************/
9349 /* Try redisplay of window W showing an unchanged buffer with a
9350 different window start than the last time it was displayed by
9351 reusing its current matrix. Value is non-zero if successful.
9352 W->start is the new window start. */
9355 try_window_reusing_current_matrix (w
)
9358 struct frame
*f
= XFRAME (w
->frame
);
9359 struct glyph_row
*row
, *bottom_row
;
9362 struct text_pos start
, new_start
;
9363 int nrows_scrolled
, i
;
9364 struct glyph_row
*last_text_row
;
9365 struct glyph_row
*last_reused_text_row
;
9366 struct glyph_row
*start_row
;
9367 int start_vpos
, min_y
, max_y
;
9369 /* Right now this function doesn't handle terminal frames. */
9370 if (!FRAME_WINDOW_P (f
))
9373 /* Can't do this if region may have changed. */
9374 if ((!NILP (Vtransient_mark_mode
)
9375 && !NILP (current_buffer
->mark_active
))
9376 || !NILP (w
->region_showing
)
9377 || !NILP (Vshow_trailing_whitespace
))
9380 /* If top-line visibility has changed, give up. */
9381 if (WINDOW_WANTS_HEADER_LINE_P (w
)
9382 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
9385 /* Give up if old or new display is scrolled vertically. We could
9386 make this function handle this, but right now it doesn't. */
9387 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
9388 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (start_row
))
9391 /* The variable new_start now holds the new window start. The old
9392 start `start' can be determined from the current matrix. */
9393 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
9394 start
= start_row
->start
.pos
;
9395 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
9397 /* Clear the desired matrix for the display below. */
9398 clear_glyph_matrix (w
->desired_matrix
);
9400 if (CHARPOS (new_start
) <= CHARPOS (start
))
9404 IF_DEBUG (debug_method_add (w
, "twu1"));
9406 /* Display up to a row that can be reused. The variable
9407 last_text_row is set to the last row displayed that displays
9409 start_display (&it
, w
, new_start
);
9410 first_row_y
= it
.current_y
;
9411 w
->cursor
.vpos
= -1;
9412 last_text_row
= last_reused_text_row
= NULL
;
9413 while (it
.current_y
< it
.last_visible_y
9414 && IT_CHARPOS (it
) < CHARPOS (start
)
9415 && !fonts_changed_p
)
9416 if (display_line (&it
))
9417 last_text_row
= it
.glyph_row
- 1;
9419 /* A value of current_y < last_visible_y means that we stopped
9420 at the previous window start, which in turn means that we
9421 have at least one reusable row. */
9422 if (it
.current_y
< it
.last_visible_y
)
9424 nrows_scrolled
= it
.vpos
;
9426 /* Find PT if not already found in the lines displayed. */
9427 if (w
->cursor
.vpos
< 0)
9429 int dy
= it
.current_y
- first_row_y
;
9431 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
9432 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
9434 if (PT
>= MATRIX_ROW_START_CHARPOS (row
)
9435 && PT
< MATRIX_ROW_END_CHARPOS (row
))
9437 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
9438 dy
, nrows_scrolled
);
9442 if (MATRIX_ROW_BOTTOM_Y (row
) + dy
>= it
.last_visible_y
)
9448 /* Give up if point was not found. This shouldn't
9449 happen often; not more often than with try_window
9451 if (w
->cursor
.vpos
< 0)
9453 clear_glyph_matrix (w
->desired_matrix
);
9458 /* Scroll the display. Do it before the current matrix is
9459 changed. The problem here is that update has not yet
9460 run, i.e. part of the current matrix is not up to date.
9461 scroll_run_hook will clear the cursor, and use the
9462 current matrix to get the height of the row the cursor is
9464 run
.current_y
= first_row_y
;
9465 run
.desired_y
= it
.current_y
;
9466 run
.height
= it
.last_visible_y
- it
.current_y
;
9470 rif
->update_window_begin_hook (w
);
9471 rif
->scroll_run_hook (w
, &run
);
9472 rif
->update_window_end_hook (w
, 0);
9476 /* Shift current matrix down by nrows_scrolled lines. */
9477 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
9478 rotate_matrix (w
->current_matrix
,
9480 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
9483 /* Disable lines not reused. */
9484 for (i
= 0; i
< it
.vpos
; ++i
)
9485 MATRIX_ROW (w
->current_matrix
, i
)->enabled_p
= 0;
9487 /* Re-compute Y positions. */
9488 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
) + nrows_scrolled
;
9489 min_y
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
);
9490 max_y
= it
.last_visible_y
;
9491 while (row
< bottom_row
)
9493 row
->y
= it
.current_y
;
9496 row
->visible_height
= row
->height
- (min_y
- row
->y
);
9497 else if (row
->y
+ row
->height
> max_y
)
9499 = row
->height
- (row
->y
+ row
->height
- max_y
);
9501 row
->visible_height
= row
->height
;
9503 it
.current_y
+= row
->height
;
9506 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
9507 last_reused_text_row
= row
;
9508 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
9514 /* Update window_end_pos etc.; last_reused_text_row is the last
9515 reused row from the current matrix containing text, if any.
9516 The value of last_text_row is the last displayed line
9518 if (last_reused_text_row
)
9520 w
->window_end_bytepos
9521 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
9522 XSETFASTINT (w
->window_end_pos
,
9523 Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
9524 XSETFASTINT (w
->window_end_vpos
,
9525 MATRIX_ROW_VPOS (last_reused_text_row
,
9526 w
->current_matrix
));
9528 else if (last_text_row
)
9530 w
->window_end_bytepos
9531 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
9532 XSETFASTINT (w
->window_end_pos
,
9533 Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
9534 XSETFASTINT (w
->window_end_vpos
,
9535 MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
9539 /* This window must be completely empty. */
9540 w
->window_end_bytepos
= 0;
9541 XSETFASTINT (w
->window_end_pos
, 0);
9542 XSETFASTINT (w
->window_end_vpos
, 0);
9544 w
->window_end_valid
= Qnil
;
9546 /* Update hint: don't try scrolling again in update_window. */
9547 w
->desired_matrix
->no_scrolling_p
= 1;
9550 debug_method_add (w
, "try_window_reusing_current_matrix 1");
9554 else if (CHARPOS (new_start
) > CHARPOS (start
))
9556 struct glyph_row
*pt_row
, *row
;
9557 struct glyph_row
*first_reusable_row
;
9558 struct glyph_row
*first_row_to_display
;
9560 int yb
= window_text_bottom_y (w
);
9562 IF_DEBUG (debug_method_add (w
, "twu2"));
9564 /* Find the row starting at new_start, if there is one. Don't
9565 reuse a partially visible line at the end. */
9566 first_reusable_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
9567 while (first_reusable_row
->enabled_p
9568 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
9569 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
9570 < CHARPOS (new_start
)))
9571 ++first_reusable_row
;
9573 /* Give up if there is no row to reuse. */
9574 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
9575 || !first_reusable_row
->enabled_p
9576 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
9577 != CHARPOS (new_start
)))
9580 /* We can reuse fully visible rows beginning with
9581 first_reusable_row to the end of the window. Set
9582 first_row_to_display to the first row that cannot be reused.
9583 Set pt_row to the row containing point, if there is any. */
9584 first_row_to_display
= first_reusable_row
;
9586 while (MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
)
9588 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
9589 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
9590 pt_row
= first_row_to_display
;
9592 ++first_row_to_display
;
9595 /* Start displaying at the start of first_row_to_display. */
9596 xassert (first_row_to_display
->y
< yb
);
9597 init_to_row_start (&it
, w
, first_row_to_display
);
9598 nrows_scrolled
= MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
);
9599 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
9601 it
.current_y
= first_row_to_display
->y
- first_reusable_row
->y
;
9603 /* Display lines beginning with first_row_to_display in the
9604 desired matrix. Set last_text_row to the last row displayed
9605 that displays text. */
9606 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
9608 w
->cursor
.vpos
= -1;
9609 last_text_row
= NULL
;
9610 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
9611 if (display_line (&it
))
9612 last_text_row
= it
.glyph_row
- 1;
9614 /* Give up If point isn't in a row displayed or reused. */
9615 if (w
->cursor
.vpos
< 0)
9617 clear_glyph_matrix (w
->desired_matrix
);
9621 /* If point is in a reused row, adjust y and vpos of the cursor
9625 w
->cursor
.vpos
-= MATRIX_ROW_VPOS (first_reusable_row
,
9627 w
->cursor
.y
-= first_reusable_row
->y
;
9630 /* Scroll the display. */
9631 run
.current_y
= first_reusable_row
->y
;
9632 run
.desired_y
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
);
9633 run
.height
= it
.last_visible_y
- run
.current_y
;
9636 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
9638 rif
->update_window_begin_hook (w
);
9639 rif
->scroll_run_hook (w
, &run
);
9640 rif
->update_window_end_hook (w
, 0);
9644 /* Adjust Y positions of reused rows. */
9645 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
9646 row
= first_reusable_row
;
9647 dy
= first_reusable_row
->y
;
9648 min_y
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
);
9649 max_y
= it
.last_visible_y
;
9650 while (row
< first_row_to_display
)
9654 row
->visible_height
= row
->height
- (min_y
- row
->y
);
9655 else if (row
->y
+ row
->height
> max_y
)
9657 = row
->height
- (row
->y
+ row
->height
- max_y
);
9659 row
->visible_height
= row
->height
;
9663 /* Disable rows not reused. */
9664 while (row
< bottom_row
)
9670 /* Scroll the current matrix. */
9671 xassert (nrows_scrolled
> 0);
9672 rotate_matrix (w
->current_matrix
,
9674 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
9677 /* Adjust window end. A null value of last_text_row means that
9678 the window end is in reused rows which in turn means that
9679 only its vpos can have changed. */
9682 w
->window_end_bytepos
9683 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
9684 XSETFASTINT (w
->window_end_pos
,
9685 Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
9686 XSETFASTINT (w
->window_end_vpos
,
9687 MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
9691 XSETFASTINT (w
->window_end_vpos
,
9692 XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
9695 w
->window_end_valid
= Qnil
;
9696 w
->desired_matrix
->no_scrolling_p
= 1;
9699 debug_method_add (w
, "try_window_reusing_current_matrix 2");
9709 /************************************************************************
9710 Window redisplay reusing current matrix when buffer has changed
9711 ************************************************************************/
9713 static struct glyph_row
*get_last_unchanged_at_beg_row
P_ ((struct window
*));
9714 static struct glyph_row
*get_first_unchanged_at_end_row
P_ ((struct window
*,
9716 static struct glyph_row
*
9717 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
9718 struct glyph_row
*));
9721 /* Return the last row in MATRIX displaying text. If row START is
9722 non-null, start searching with that row. IT gives the dimensions
9723 of the display. Value is null if matrix is empty; otherwise it is
9724 a pointer to the row found. */
9726 static struct glyph_row
*
9727 find_last_row_displaying_text (matrix
, it
, start
)
9728 struct glyph_matrix
*matrix
;
9730 struct glyph_row
*start
;
9732 struct glyph_row
*row
, *row_found
;
9734 /* Set row_found to the last row in IT->w's current matrix
9735 displaying text. The loop looks funny but think of partially
9738 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
9739 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
9741 xassert (row
->enabled_p
);
9743 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
9752 /* Return the last row in the current matrix of W that is not affected
9753 by changes at the start of current_buffer that occurred since the
9754 last time W was redisplayed. Value is null if no such row exists.
9756 The global variable beg_unchanged has to contain the number of
9757 bytes unchanged at the start of current_buffer. BEG +
9758 beg_unchanged is the buffer position of the first changed byte in
9759 current_buffer. Characters at positions < BEG + beg_unchanged are
9760 at the same buffer positions as they were when the current matrix
9763 static struct glyph_row
*
9764 get_last_unchanged_at_beg_row (w
)
9767 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
9768 struct glyph_row
*row
;
9769 struct glyph_row
*row_found
= NULL
;
9770 int yb
= window_text_bottom_y (w
);
9772 /* Find the last row displaying unchanged text. */
9773 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
9774 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
9775 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
)
9777 if (/* If row ends before first_changed_pos, it is unchanged,
9778 except in some case. */
9779 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
9780 /* When row ends in ZV and we write at ZV it is not
9782 && !row
->ends_at_zv_p
9783 /* When first_changed_pos is the end of a continued line,
9784 row is not unchanged because it may be no longer
9786 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
9787 && row
->continued_p
))
9790 /* Stop if last visible row. */
9791 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
9801 /* Find the first glyph row in the current matrix of W that is not
9802 affected by changes at the end of current_buffer since the last
9803 time the window was redisplayed. Return in *DELTA the number of
9804 chars by which buffer positions in unchanged text at the end of
9805 current_buffer must be adjusted. Return in *DELTA_BYTES the
9806 corresponding number of bytes. Value is null if no such row
9807 exists, i.e. all rows are affected by changes. */
9809 static struct glyph_row
*
9810 get_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
9812 int *delta
, *delta_bytes
;
9814 struct glyph_row
*row
;
9815 struct glyph_row
*row_found
= NULL
;
9817 *delta
= *delta_bytes
= 0;
9819 /* A value of window_end_pos >= end_unchanged means that the window
9820 end is in the range of changed text. If so, there is no
9821 unchanged row at the end of W's current matrix. */
9822 xassert (!NILP (w
->window_end_valid
));
9823 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
9826 /* Set row to the last row in W's current matrix displaying text. */
9827 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
9829 /* If matrix is entirely empty, no unchanged row exists. */
9830 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
9832 /* The value of row is the last glyph row in the matrix having a
9833 meaningful buffer position in it. The end position of row
9834 corresponds to window_end_pos. This allows us to translate
9835 buffer positions in the current matrix to current buffer
9836 positions for characters not in changed text. */
9837 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
9838 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
9839 int last_unchanged_pos
, last_unchanged_pos_old
;
9840 struct glyph_row
*first_text_row
9841 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
9844 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
9846 /* Set last_unchanged_pos to the buffer position of the last
9847 character in the buffer that has not been changed. Z is the
9848 index + 1 of the last byte in current_buffer, i.e. by
9849 subtracting end_unchanged we get the index of the last
9850 unchanged character, and we have to add BEG to get its buffer
9852 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
9853 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
9855 /* Search backward from ROW for a row displaying a line that
9856 starts at a minimum position >= last_unchanged_pos_old. */
9857 while (row
>= first_text_row
)
9859 xassert (row
->enabled_p
);
9860 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (row
));
9862 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
9868 xassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
9873 /* Make sure that glyph rows in the current matrix of window W
9874 reference the same glyph memory as corresponding rows in the
9875 frame's frame matrix. This function is called after scrolling W's
9876 current matrix on a terminal frame in try_window_id and
9877 try_window_reusing_current_matrix. */
9880 sync_frame_with_window_matrix_rows (w
)
9883 struct frame
*f
= XFRAME (w
->frame
);
9884 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
9886 /* Preconditions: W must be a leaf window and full-width. Its frame
9887 must have a frame matrix. */
9888 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
9889 xassert (WINDOW_FULL_WIDTH_P (w
));
9890 xassert (!FRAME_WINDOW_P (f
));
9892 /* If W is a full-width window, glyph pointers in W's current matrix
9893 have, by definition, to be the same as glyph pointers in the
9894 corresponding frame matrix. */
9895 window_row
= w
->current_matrix
->rows
;
9896 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
9897 frame_row
= f
->current_matrix
->rows
+ XFASTINT (w
->top
);
9898 while (window_row
< window_row_end
)
9902 for (area
= LEFT_MARGIN_AREA
; area
<= LAST_AREA
; ++area
)
9903 frame_row
->glyphs
[area
] = window_row
->glyphs
[area
];
9905 /* Disable frame rows whose corresponding window rows have
9906 been disabled in try_window_id. */
9907 if (!window_row
->enabled_p
)
9908 frame_row
->enabled_p
= 0;
9910 ++window_row
, ++frame_row
;
9915 /* Find the glyph row in window W containing CHARPOS. Consider all
9916 rows between START and END (not inclusive). END null means search
9917 all rows to the end of the display area of W. Value is the row
9918 containing CHARPOS or null. */
9920 static struct glyph_row
*
9921 row_containing_pos (w
, charpos
, start
, end
)
9924 struct glyph_row
*start
, *end
;
9926 struct glyph_row
*row
= start
;
9929 /* If we happen to start on a header-line, skip that. */
9930 if (row
->mode_line_p
)
9933 if ((end
&& row
>= end
) || !row
->enabled_p
)
9936 last_y
= window_text_bottom_y (w
);
9938 while ((end
== NULL
|| row
< end
)
9939 && (MATRIX_ROW_END_CHARPOS (row
) < charpos
9940 /* The end position of a row equals the start
9941 position of the next row. If CHARPOS is there, we
9942 would rather display it in the next line, except
9943 when this line ends in ZV. */
9944 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
9945 && (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)
9946 || !row
->ends_at_zv_p
)))
9947 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
9950 /* Give up if CHARPOS not found. */
9951 if ((end
&& row
>= end
)
9952 || charpos
< MATRIX_ROW_START_CHARPOS (row
)
9953 || charpos
> MATRIX_ROW_END_CHARPOS (row
))
9960 /* Try to redisplay window W by reusing its existing display. W's
9961 current matrix must be up to date when this function is called,
9962 i.e. window_end_valid must not be nil.
9966 1 if display has been updated
9967 0 if otherwise unsuccessful
9968 -1 if redisplay with same window start is known not to succeed
9970 The following steps are performed:
9972 1. Find the last row in the current matrix of W that is not
9973 affected by changes at the start of current_buffer. If no such row
9976 2. Find the first row in W's current matrix that is not affected by
9977 changes at the end of current_buffer. Maybe there is no such row.
9979 3. Display lines beginning with the row + 1 found in step 1 to the
9980 row found in step 2 or, if step 2 didn't find a row, to the end of
9983 4. If cursor is not known to appear on the window, give up.
9985 5. If display stopped at the row found in step 2, scroll the
9986 display and current matrix as needed.
9988 6. Maybe display some lines at the end of W, if we must. This can
9989 happen under various circumstances, like a partially visible line
9990 becoming fully visible, or because newly displayed lines are displayed
9991 in smaller font sizes.
9993 7. Update W's window end information. */
9995 /* Check that window end is what we expect it to be. */
10001 struct frame
*f
= XFRAME (w
->frame
);
10002 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
10003 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
10004 struct glyph_row
*last_unchanged_at_beg_row
;
10005 struct glyph_row
*first_unchanged_at_end_row
;
10006 struct glyph_row
*row
;
10007 struct glyph_row
*bottom_row
;
10010 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
10011 struct text_pos start_pos
;
10013 int first_unchanged_at_end_vpos
= 0;
10014 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
10015 struct text_pos start
;
10017 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10019 /* Check pre-conditions. Window end must be valid, otherwise
10020 the current matrix would not be up to date. */
10021 xassert (!NILP (w
->window_end_valid
));
10022 xassert (FRAME_WINDOW_P (XFRAME (w
->frame
))
10023 || (line_ins_del_ok
&& WINDOW_FULL_WIDTH_P (w
)));
10025 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
10026 only if buffer has really changed. The reason is that the gap is
10027 initially at Z for freshly visited files. The code below would
10028 set end_unchanged to 0 in that case. */
10031 if (GPT
- BEG
< BEG_UNCHANGED
)
10032 BEG_UNCHANGED
= GPT
- BEG
;
10033 if (Z
- GPT
< END_UNCHANGED
)
10034 END_UNCHANGED
= Z
- GPT
;
10037 /* If window starts after a line end, and the last change is in
10038 front of that newline, then changes don't affect the display.
10039 This case happens with stealth-fontification. */
10040 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
10041 if (CHARPOS (start
) > BEGV
10042 && Z
- END_UNCHANGED
< CHARPOS (start
) - 1
10043 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n'
10044 && PT
< MATRIX_ROW_END_CHARPOS (row
))
10046 /* We have to update window end positions because the buffer's
10047 size has changed. */
10049 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
10050 w
->window_end_bytepos
10051 = make_number (Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
));
10055 /* Return quickly if changes are all below what is displayed in the
10056 window, and if PT is in the window. */
10057 if (BEG_UNCHANGED
> MATRIX_ROW_END_CHARPOS (row
)
10058 && PT
< MATRIX_ROW_END_CHARPOS (row
))
10060 /* We have to update window end positions because the buffer's
10061 size has changed. */
10063 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
10064 w
->window_end_bytepos
10065 = make_number (Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
));
10069 /* Check that window start agrees with the start of the first glyph
10070 row in its current matrix. Check this after we know the window
10071 start is not in changed text, otherwise positions would not be
10073 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
10074 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
10077 /* Compute the position at which we have to start displaying new
10078 lines. Some of the lines at the top of the window might be
10079 reusable because they are not displaying changed text. Find the
10080 last row in W's current matrix not affected by changes at the
10081 start of current_buffer. Value is null if changes start in the
10082 first line of window. */
10083 last_unchanged_at_beg_row
= get_last_unchanged_at_beg_row (w
);
10084 if (last_unchanged_at_beg_row
)
10086 init_to_row_end (&it
, w
, last_unchanged_at_beg_row
);
10087 start_pos
= it
.current
.pos
;
10089 /* Start displaying new lines in the desired matrix at the same
10090 vpos we would use in the current matrix, i.e. below
10091 last_unchanged_at_beg_row. */
10092 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
10094 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
10095 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
10097 xassert (it
.hpos
== 0 && it
.current_x
== 0);
10101 /* There are no reusable lines at the start of the window.
10102 Start displaying in the first line. */
10103 start_display (&it
, w
, start
);
10104 start_pos
= it
.current
.pos
;
10107 /* Find the first row that is not affected by changes at the end of
10108 the buffer. Value will be null if there is no unchanged row, in
10109 which case we must redisplay to the end of the window. delta
10110 will be set to the value by which buffer positions beginning with
10111 first_unchanged_at_end_row have to be adjusted due to text
10113 first_unchanged_at_end_row
10114 = get_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
10115 IF_DEBUG (debug_delta
= delta
);
10116 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
10118 /* Set stop_pos to the buffer position up to which we will have to
10119 display new lines. If first_unchanged_at_end_row != NULL, this
10120 is the buffer position of the start of the line displayed in that
10121 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
10122 that we don't stop at a buffer position. */
10124 if (first_unchanged_at_end_row
)
10126 xassert (last_unchanged_at_beg_row
== NULL
10127 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
10129 /* If this is a continuation line, move forward to the next one
10130 that isn't. Changes in lines above affect this line.
10131 Caution: this may move first_unchanged_at_end_row to a row
10132 not displaying text. */
10133 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
10134 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
10135 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
10136 < it
.last_visible_y
))
10137 ++first_unchanged_at_end_row
;
10139 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
10140 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
10141 >= it
.last_visible_y
))
10142 first_unchanged_at_end_row
= NULL
;
10145 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
10147 first_unchanged_at_end_vpos
10148 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
10149 xassert (stop_pos
>= Z
- END_UNCHANGED
);
10152 else if (last_unchanged_at_beg_row
== NULL
)
10158 /* Either there is no unchanged row at the end, or the one we have
10159 now displays text. This is a necessary condition for the window
10160 end pos calculation at the end of this function. */
10161 xassert (first_unchanged_at_end_row
== NULL
10162 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
10164 debug_last_unchanged_at_beg_vpos
10165 = (last_unchanged_at_beg_row
10166 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
10168 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
10170 #endif /* GLYPH_DEBUG != 0 */
10173 /* Display new lines. Set last_text_row to the last new line
10174 displayed which has text on it, i.e. might end up as being the
10175 line where the window_end_vpos is. */
10176 w
->cursor
.vpos
= -1;
10177 last_text_row
= NULL
;
10178 overlay_arrow_seen
= 0;
10179 while (it
.current_y
< it
.last_visible_y
10180 && !fonts_changed_p
10181 && (first_unchanged_at_end_row
== NULL
10182 || IT_CHARPOS (it
) < stop_pos
))
10184 if (display_line (&it
))
10185 last_text_row
= it
.glyph_row
- 1;
10188 if (fonts_changed_p
)
10192 /* Compute differences in buffer positions, y-positions etc. for
10193 lines reused at the bottom of the window. Compute what we can
10195 if (first_unchanged_at_end_row
10196 /* No lines reused because we displayed everything up to the
10197 bottom of the window. */
10198 && it
.current_y
< it
.last_visible_y
)
10201 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
10203 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
10204 run
.current_y
= first_unchanged_at_end_row
->y
;
10205 run
.desired_y
= run
.current_y
+ dy
;
10206 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
10210 delta
= dvpos
= dy
= run
.current_y
= run
.desired_y
= run
.height
= 0;
10211 first_unchanged_at_end_row
= NULL
;
10213 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
10216 /* Find the cursor if not already found. We have to decide whether
10217 PT will appear on this window (it sometimes doesn't, but this is
10218 not a very frequent case.) This decision has to be made before
10219 the current matrix is altered. A value of cursor.vpos < 0 means
10220 that PT is either in one of the lines beginning at
10221 first_unchanged_at_end_row or below the window. Don't care for
10222 lines that might be displayed later at the window end; as
10223 mentioned, this is not a frequent case. */
10224 if (w
->cursor
.vpos
< 0)
10226 /* Cursor in unchanged rows at the top? */
10227 if (PT
< CHARPOS (start_pos
)
10228 && last_unchanged_at_beg_row
)
10230 row
= row_containing_pos (w
, PT
,
10231 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
10232 last_unchanged_at_beg_row
+ 1);
10233 xassert (row
&& row
<= last_unchanged_at_beg_row
);
10234 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
10237 /* Start from first_unchanged_at_end_row looking for PT. */
10238 else if (first_unchanged_at_end_row
)
10240 row
= row_containing_pos (w
, PT
- delta
,
10241 first_unchanged_at_end_row
, NULL
);
10243 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
10244 delta_bytes
, dy
, dvpos
);
10247 /* Give up if cursor was not found. */
10248 if (w
->cursor
.vpos
< 0)
10250 clear_glyph_matrix (w
->desired_matrix
);
10255 /* Don't let the cursor end in the scroll margins. */
10257 int this_scroll_margin
, cursor_height
;
10259 this_scroll_margin
= max (0, scroll_margin
);
10260 this_scroll_margin
= min (this_scroll_margin
,
10261 XFASTINT (w
->height
) / 4);
10262 this_scroll_margin
*= CANON_Y_UNIT (it
.f
);
10263 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
10265 if ((w
->cursor
.y
< this_scroll_margin
10266 && CHARPOS (start
) > BEGV
)
10267 /* Don't take scroll margin into account at the bottom because
10268 old redisplay didn't do it either. */
10269 || w
->cursor
.y
+ cursor_height
> it
.last_visible_y
)
10271 w
->cursor
.vpos
= -1;
10272 clear_glyph_matrix (w
->desired_matrix
);
10277 /* Scroll the display. Do it before changing the current matrix so
10278 that xterm.c doesn't get confused about where the cursor glyph is
10284 if (FRAME_WINDOW_P (f
))
10286 rif
->update_window_begin_hook (w
);
10287 rif
->scroll_run_hook (w
, &run
);
10288 rif
->update_window_end_hook (w
, 0);
10292 /* Terminal frame. In this case, dvpos gives the number of
10293 lines to scroll by; dvpos < 0 means scroll up. */
10294 int first_unchanged_at_end_vpos
10295 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
10296 int from
= XFASTINT (w
->top
) + first_unchanged_at_end_vpos
;
10297 int end
= XFASTINT (w
->top
) + window_internal_height (w
);
10299 /* Perform the operation on the screen. */
10302 /* Scroll last_unchanged_at_beg_row to the end of the
10303 window down dvpos lines. */
10304 set_terminal_window (end
);
10306 /* On dumb terminals delete dvpos lines at the end
10307 before inserting dvpos empty lines. */
10308 if (!scroll_region_ok
)
10309 ins_del_lines (end
- dvpos
, -dvpos
);
10311 /* Insert dvpos empty lines in front of
10312 last_unchanged_at_beg_row. */
10313 ins_del_lines (from
, dvpos
);
10315 else if (dvpos
< 0)
10317 /* Scroll up last_unchanged_at_beg_vpos to the end of
10318 the window to last_unchanged_at_beg_vpos - |dvpos|. */
10319 set_terminal_window (end
);
10321 /* Delete dvpos lines in front of
10322 last_unchanged_at_beg_vpos. ins_del_lines will set
10323 the cursor to the given vpos and emit |dvpos| delete
10325 ins_del_lines (from
+ dvpos
, dvpos
);
10327 /* On a dumb terminal insert dvpos empty lines at the
10329 if (!scroll_region_ok
)
10330 ins_del_lines (end
+ dvpos
, -dvpos
);
10333 set_terminal_window (0);
10339 /* Shift reused rows of the current matrix to the right position.
10340 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
10342 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
10343 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
10346 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
10347 bottom_vpos
, dvpos
);
10348 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
10351 else if (dvpos
> 0)
10353 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
10354 bottom_vpos
, dvpos
);
10355 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
10356 first_unchanged_at_end_vpos
+ dvpos
, 0);
10359 /* For frame-based redisplay, make sure that current frame and window
10360 matrix are in sync with respect to glyph memory. */
10361 if (!FRAME_WINDOW_P (f
))
10362 sync_frame_with_window_matrix_rows (w
);
10364 /* Adjust buffer positions in reused rows. */
10366 increment_glyph_matrix_buffer_positions (current_matrix
,
10367 first_unchanged_at_end_vpos
+ dvpos
,
10368 bottom_vpos
, delta
, delta_bytes
);
10370 /* Adjust Y positions. */
10372 shift_glyph_matrix (w
, current_matrix
,
10373 first_unchanged_at_end_vpos
+ dvpos
,
10376 if (first_unchanged_at_end_row
)
10377 first_unchanged_at_end_row
+= dvpos
;
10379 /* If scrolling up, there may be some lines to display at the end of
10381 last_text_row_at_end
= NULL
;
10384 /* Set last_row to the glyph row in the current matrix where the
10385 window end line is found. It has been moved up or down in
10386 the matrix by dvpos. */
10387 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
10388 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
10390 /* If last_row is the window end line, it should display text. */
10391 xassert (last_row
->displays_text_p
);
10393 /* If window end line was partially visible before, begin
10394 displaying at that line. Otherwise begin displaying with the
10395 line following it. */
10396 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
10398 init_to_row_start (&it
, w
, last_row
);
10399 it
.vpos
= last_vpos
;
10400 it
.current_y
= last_row
->y
;
10404 init_to_row_end (&it
, w
, last_row
);
10405 it
.vpos
= 1 + last_vpos
;
10406 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
10410 /* We may start in a continuation line. If so, we have to get
10411 the right continuation_lines_width and current_x. */
10412 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
10413 it
.hpos
= it
.current_x
= 0;
10415 /* Display the rest of the lines at the window end. */
10416 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
10417 while (it
.current_y
< it
.last_visible_y
10418 && !fonts_changed_p
)
10420 /* Is it always sure that the display agrees with lines in
10421 the current matrix? I don't think so, so we mark rows
10422 displayed invalid in the current matrix by setting their
10423 enabled_p flag to zero. */
10424 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
10425 if (display_line (&it
))
10426 last_text_row_at_end
= it
.glyph_row
- 1;
10430 /* Update window_end_pos and window_end_vpos. */
10431 if (first_unchanged_at_end_row
10432 && first_unchanged_at_end_row
->y
< it
.last_visible_y
10433 && !last_text_row_at_end
)
10435 /* Window end line if one of the preserved rows from the current
10436 matrix. Set row to the last row displaying text in current
10437 matrix starting at first_unchanged_at_end_row, after
10439 xassert (first_unchanged_at_end_row
->displays_text_p
);
10440 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
10441 first_unchanged_at_end_row
);
10442 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
10444 XSETFASTINT (w
->window_end_pos
, Z
- MATRIX_ROW_END_CHARPOS (row
));
10445 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
10446 XSETFASTINT (w
->window_end_vpos
,
10447 MATRIX_ROW_VPOS (row
, w
->current_matrix
));
10449 else if (last_text_row_at_end
)
10451 XSETFASTINT (w
->window_end_pos
,
10452 Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
10453 w
->window_end_bytepos
10454 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
10455 XSETFASTINT (w
->window_end_vpos
,
10456 MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
10458 else if (last_text_row
)
10460 /* We have displayed either to the end of the window or at the
10461 end of the window, i.e. the last row with text is to be found
10462 in the desired matrix. */
10463 XSETFASTINT (w
->window_end_pos
,
10464 Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
10465 w
->window_end_bytepos
10466 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
10467 XSETFASTINT (w
->window_end_vpos
,
10468 MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
10470 else if (first_unchanged_at_end_row
== NULL
10471 && last_text_row
== NULL
10472 && last_text_row_at_end
== NULL
)
10474 /* Displayed to end of window, but no line containing text was
10475 displayed. Lines were deleted at the end of the window. */
10477 int header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
10479 for (vpos
= XFASTINT (w
->window_end_vpos
); vpos
> 0; --vpos
)
10480 if ((w
->desired_matrix
->rows
[vpos
+ header_line_p
].enabled_p
10481 && w
->desired_matrix
->rows
[vpos
+ header_line_p
].displays_text_p
)
10482 || (!w
->desired_matrix
->rows
[vpos
+ header_line_p
].enabled_p
10483 && w
->current_matrix
->rows
[vpos
+ header_line_p
].displays_text_p
))
10486 w
->window_end_vpos
= make_number (vpos
);
10491 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
10492 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
10494 /* Record that display has not been completed. */
10495 w
->window_end_valid
= Qnil
;
10496 w
->desired_matrix
->no_scrolling_p
= 1;
10502 /***********************************************************************
10503 More debugging support
10504 ***********************************************************************/
10508 void dump_glyph_row
P_ ((struct glyph_matrix
*, int, int));
10509 static void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
10512 /* Dump the contents of glyph matrix MATRIX on stderr. If
10513 WITH_GLYPHS_P is non-zero, dump glyph contents as well. */
10516 dump_glyph_matrix (matrix
, with_glyphs_p
)
10517 struct glyph_matrix
*matrix
;
10521 for (i
= 0; i
< matrix
->nrows
; ++i
)
10522 dump_glyph_row (matrix
, i
, with_glyphs_p
);
10526 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
10527 WITH_GLYPH_SP non-zero means dump glyph contents, too. */
10530 dump_glyph_row (matrix
, vpos
, with_glyphs_p
)
10531 struct glyph_matrix
*matrix
;
10532 int vpos
, with_glyphs_p
;
10534 struct glyph_row
*row
;
10536 if (vpos
< 0 || vpos
>= matrix
->nrows
)
10539 row
= MATRIX_ROW (matrix
, vpos
);
10541 fprintf (stderr
, "Row Start End Used oEI><O\\CTZF X Y W\n");
10542 fprintf (stderr
, "=============================================\n");
10544 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d\n",
10545 row
- matrix
->rows
,
10546 MATRIX_ROW_START_CHARPOS (row
),
10547 MATRIX_ROW_END_CHARPOS (row
),
10548 row
->used
[TEXT_AREA
],
10549 row
->contains_overlapping_glyphs_p
,
10552 row
->truncated_on_left_p
,
10553 row
->truncated_on_right_p
,
10554 row
->overlay_arrow_p
,
10556 MATRIX_ROW_CONTINUATION_LINE_P (row
),
10557 row
->displays_text_p
,
10563 fprintf (stderr
, "%9d %5d\n", row
->start
.overlay_string_index
,
10564 row
->end
.overlay_string_index
);
10565 fprintf (stderr
, "%9d %5d\n",
10566 CHARPOS (row
->start
.string_pos
),
10567 CHARPOS (row
->end
.string_pos
));
10568 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
10569 row
->end
.dpvec_index
);
10573 struct glyph
*glyph
, *glyph_end
;
10574 int prev_had_glyphs_p
;
10576 glyph
= row
->glyphs
[TEXT_AREA
];
10577 glyph_end
= glyph
+ row
->used
[TEXT_AREA
];
10579 /* Glyph for a line end in text. */
10580 if (glyph
== glyph_end
&& glyph
->charpos
> 0)
10583 if (glyph
< glyph_end
)
10585 fprintf (stderr
, " Glyph Type Pos W Code C Face LR\n");
10586 prev_had_glyphs_p
= 1;
10589 prev_had_glyphs_p
= 0;
10591 while (glyph
< glyph_end
)
10593 if (glyph
->type
== CHAR_GLYPH
)
10596 " %5d %4c %6d %3d 0x%05x %c %4d %1.1d%1.1d\n",
10597 glyph
- row
->glyphs
[TEXT_AREA
],
10600 glyph
->pixel_width
,
10602 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
10606 glyph
->left_box_line_p
,
10607 glyph
->right_box_line_p
);
10609 else if (glyph
->type
== STRETCH_GLYPH
)
10612 " %5d %4c %6d %3d 0x%05x %c %4d %1.1d%1.1d\n",
10613 glyph
- row
->glyphs
[TEXT_AREA
],
10616 glyph
->pixel_width
,
10620 glyph
->left_box_line_p
,
10621 glyph
->right_box_line_p
);
10623 else if (glyph
->type
== IMAGE_GLYPH
)
10626 " %5d %4c %6d %3d 0x%05x %c %4d %1.1d%1.1d\n",
10627 glyph
- row
->glyphs
[TEXT_AREA
],
10630 glyph
->pixel_width
,
10634 glyph
->left_box_line_p
,
10635 glyph
->right_box_line_p
);
10643 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
10644 Sdump_glyph_matrix
, 0, 1, "p",
10645 "Dump the current matrix of the selected window to stderr.\n\
10646 Shows contents of glyph row structures. With non-nil optional\n\
10647 parameter WITH-GLYPHS-P, dump glyphs as well.")
10650 struct window
*w
= XWINDOW (selected_window
);
10651 struct buffer
*buffer
= XBUFFER (w
->buffer
);
10653 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
10654 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
10655 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
10656 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
10657 fprintf (stderr
, "=============================================\n");
10658 dump_glyph_matrix (w
->current_matrix
, !NILP (with_glyphs_p
));
10663 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 1, "",
10664 "Dump glyph row ROW to stderr.")
10668 CHECK_NUMBER (row
, 0);
10669 dump_glyph_row (XWINDOW (selected_window
)->current_matrix
, XINT (row
), 1);
10674 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
,
10678 struct frame
*sf
= SELECTED_FRAME ();
10679 struct glyph_matrix
*m
= (XWINDOW (sf
->tool_bar_window
)
10681 dump_glyph_row (m
, 0, 1);
10686 DEFUN ("trace-redisplay-toggle", Ftrace_redisplay_toggle
,
10687 Strace_redisplay_toggle
, 0, 0, "",
10688 "Toggle tracing of redisplay.")
10691 trace_redisplay_p
= !trace_redisplay_p
;
10696 #endif /* GLYPH_DEBUG */
10700 /***********************************************************************
10701 Building Desired Matrix Rows
10702 ***********************************************************************/
10704 /* Return a temporary glyph row holding the glyphs of an overlay
10705 arrow. Only used for non-window-redisplay windows. */
10707 static struct glyph_row
*
10708 get_overlay_arrow_glyph_row (w
)
10711 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
10712 struct buffer
*buffer
= XBUFFER (w
->buffer
);
10713 struct buffer
*old
= current_buffer
;
10714 unsigned char *arrow_string
= XSTRING (Voverlay_arrow_string
)->data
;
10715 int arrow_len
= XSTRING (Voverlay_arrow_string
)->size
;
10716 unsigned char *arrow_end
= arrow_string
+ arrow_len
;
10720 int n_glyphs_before
;
10722 set_buffer_temp (buffer
);
10723 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
10724 it
.glyph_row
->used
[TEXT_AREA
] = 0;
10725 SET_TEXT_POS (it
.position
, 0, 0);
10727 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
10729 while (p
< arrow_end
)
10731 Lisp_Object face
, ilisp
;
10733 /* Get the next character. */
10735 it
.c
= string_char_and_length (p
, arrow_len
, &it
.len
);
10737 it
.c
= *p
, it
.len
= 1;
10740 /* Get its face. */
10741 XSETFASTINT (ilisp
, p
- arrow_string
);
10742 face
= Fget_text_property (ilisp
, Qface
, Voverlay_arrow_string
);
10743 it
.face_id
= compute_char_face (f
, it
.c
, face
);
10745 /* Compute its width, get its glyphs. */
10746 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
10747 SET_TEXT_POS (it
.position
, -1, -1);
10748 PRODUCE_GLYPHS (&it
);
10750 /* If this character doesn't fit any more in the line, we have
10751 to remove some glyphs. */
10752 if (it
.current_x
> it
.last_visible_x
)
10754 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
10759 set_buffer_temp (old
);
10760 return it
.glyph_row
;
10764 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
10765 glyphs are only inserted for terminal frames since we can't really
10766 win with truncation glyphs when partially visible glyphs are
10767 involved. Which glyphs to insert is determined by
10768 produce_special_glyphs. */
10771 insert_left_trunc_glyphs (it
)
10774 struct it truncate_it
;
10775 struct glyph
*from
, *end
, *to
, *toend
;
10777 xassert (!FRAME_WINDOW_P (it
->f
));
10779 /* Get the truncation glyphs. */
10781 truncate_it
.charset
= -1;
10782 truncate_it
.current_x
= 0;
10783 truncate_it
.face_id
= DEFAULT_FACE_ID
;
10784 truncate_it
.glyph_row
= &scratch_glyph_row
;
10785 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
10786 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
10787 truncate_it
.object
= 0;
10788 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
10790 /* Overwrite glyphs from IT with truncation glyphs. */
10791 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
10792 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
10793 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
10794 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
10799 /* There may be padding glyphs left over. Remove them. */
10801 while (from
< toend
&& CHAR_GLYPH_PADDING_P (*from
))
10803 while (from
< toend
)
10806 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
10810 /* Compute the pixel height and width of IT->glyph_row.
10812 Most of the time, ascent and height of a display line will be equal
10813 to the max_ascent and max_height values of the display iterator
10814 structure. This is not the case if
10816 1. We hit ZV without displaying anything. In this case, max_ascent
10817 and max_height will be zero.
10819 2. We have some glyphs that don't contribute to the line height.
10820 (The glyph row flag contributes_to_line_height_p is for future
10821 pixmap extensions).
10823 The first case is easily covered by using default values because in
10824 these cases, the line height does not really matter, except that it
10825 must not be zero. */
10828 compute_line_metrics (it
)
10831 struct glyph_row
*row
= it
->glyph_row
;
10834 if (FRAME_WINDOW_P (it
->f
))
10836 int i
, header_line_height
;
10838 /* The line may consist of one space only, that was added to
10839 place the cursor on it. If so, the row's height hasn't been
10841 if (row
->height
== 0)
10843 if (it
->max_ascent
+ it
->max_descent
== 0)
10844 it
->max_descent
= it
->max_phys_descent
= CANON_Y_UNIT (it
->f
);
10845 row
->ascent
= it
->max_ascent
;
10846 row
->height
= it
->max_ascent
+ it
->max_descent
;
10847 row
->phys_ascent
= it
->max_phys_ascent
;
10848 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
10851 /* Compute the width of this line. */
10852 row
->pixel_width
= row
->x
;
10853 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
10854 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10856 xassert (row
->pixel_width
>= 0);
10857 xassert (row
->ascent
>= 0 && row
->height
> 0);
10859 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
10860 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
10862 /* If first line's physical ascent is larger than its logical
10863 ascent, use the physical ascent, and make the row taller.
10864 This makes accented characters fully visible. */
10865 if (row
== it
->w
->desired_matrix
->rows
10866 && row
->phys_ascent
> row
->ascent
)
10868 row
->height
+= row
->phys_ascent
- row
->ascent
;
10869 row
->ascent
= row
->phys_ascent
;
10872 /* Compute how much of the line is visible. */
10873 row
->visible_height
= row
->height
;
10875 header_line_height
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (it
->w
);
10876 if (row
->y
< header_line_height
)
10877 row
->visible_height
-= header_line_height
- row
->y
;
10880 int max_y
= WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE (it
->w
);
10881 if (row
->y
+ row
->height
> max_y
)
10882 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
10887 row
->pixel_width
= row
->used
[TEXT_AREA
];
10888 row
->ascent
= row
->phys_ascent
= 0;
10889 row
->height
= row
->phys_height
= row
->visible_height
= 1;
10892 /* Compute a hash code for this row. */
10894 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
10895 for (i
= 0; i
< row
->used
[area
]; ++i
)
10896 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
10897 + row
->glyphs
[area
][i
].u
.val
10898 + row
->glyphs
[area
][i
].face_id
10899 + row
->glyphs
[area
][i
].padding_p
10900 + (row
->glyphs
[area
][i
].type
<< 2));
10902 it
->max_ascent
= it
->max_descent
= 0;
10903 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
10907 /* Append one space to the glyph row of iterator IT if doing a
10908 window-based redisplay. DEFAULT_FACE_P non-zero means let the
10909 space have the default face, otherwise let it have the same face as
10910 IT->face_id. Value is non-zero if a space was added.
10912 This function is called to make sure that there is always one glyph
10913 at the end of a glyph row that the cursor can be set on under
10914 window-systems. (If there weren't such a glyph we would not know
10915 how wide and tall a box cursor should be displayed).
10917 At the same time this space let's a nicely handle clearing to the
10918 end of the line if the row ends in italic text. */
10921 append_space (it
, default_face_p
)
10923 int default_face_p
;
10925 if (FRAME_WINDOW_P (it
->f
))
10927 int n
= it
->glyph_row
->used
[TEXT_AREA
];
10929 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
10930 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
10932 /* Save some values that must not be changed. */
10933 int saved_x
= it
->current_x
;
10934 struct text_pos saved_pos
;
10935 int saved_what
= it
->what
;
10936 int saved_face_id
= it
->face_id
;
10937 int saved_charset
= it
->charset
;
10938 Lisp_Object saved_object
;
10940 saved_object
= it
->object
;
10941 saved_pos
= it
->position
;
10943 it
->what
= IT_CHARACTER
;
10944 bzero (&it
->position
, sizeof it
->position
);
10948 it
->charset
= CHARSET_ASCII
;
10950 if (default_face_p
)
10951 it
->face_id
= DEFAULT_FACE_ID
;
10952 if (it
->multibyte_p
)
10953 it
->face_id
= FACE_FOR_CHARSET (it
->f
, it
->face_id
, CHARSET_ASCII
);
10955 it
->face_id
= FACE_FOR_CHARSET (it
->f
, it
->face_id
, -1);
10957 PRODUCE_GLYPHS (it
);
10959 it
->current_x
= saved_x
;
10960 it
->object
= saved_object
;
10961 it
->position
= saved_pos
;
10962 it
->what
= saved_what
;
10963 it
->face_id
= saved_face_id
;
10964 it
->charset
= saved_charset
;
10973 /* Extend the face of the last glyph in the text area of IT->glyph_row
10974 to the end of the display line. Called from display_line.
10975 If the glyph row is empty, add a space glyph to it so that we
10976 know the face to draw. Set the glyph row flag fill_line_p. */
10979 extend_face_to_end_of_line (it
)
10983 struct frame
*f
= it
->f
;
10985 /* If line is already filled, do nothing. */
10986 if (it
->current_x
>= it
->last_visible_x
)
10989 /* Face extension extends the background and box of IT->face_id
10990 to the end of the line. If the background equals the background
10991 of the frame, we haven't to do anything. */
10992 face
= FACE_FROM_ID (f
, it
->face_id
);
10993 if (FRAME_WINDOW_P (f
)
10994 && face
->box
== FACE_NO_BOX
10995 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
10999 /* Set the glyph row flag indicating that the face of the last glyph
11000 in the text area has to be drawn to the end of the text area. */
11001 it
->glyph_row
->fill_line_p
= 1;
11003 /* If current charset of IT is not ASCII, make sure we have the
11004 ASCII face. This will be automatically undone the next time
11005 get_next_display_element returns a character from a different
11006 charset. Note that the charset will always be ASCII in unibyte
11008 if (it
->charset
!= CHARSET_ASCII
)
11010 it
->charset
= CHARSET_ASCII
;
11011 it
->face_id
= FACE_FOR_CHARSET (f
, it
->face_id
, CHARSET_ASCII
);
11014 if (FRAME_WINDOW_P (f
))
11016 /* If the row is empty, add a space with the current face of IT,
11017 so that we know which face to draw. */
11018 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
11020 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
11021 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
11022 it
->glyph_row
->used
[TEXT_AREA
] = 1;
11027 /* Save some values that must not be changed. */
11028 int saved_x
= it
->current_x
;
11029 struct text_pos saved_pos
;
11030 Lisp_Object saved_object
;
11031 int saved_what
= it
->what
;
11033 saved_object
= it
->object
;
11034 saved_pos
= it
->position
;
11036 it
->what
= IT_CHARACTER
;
11037 bzero (&it
->position
, sizeof it
->position
);
11042 PRODUCE_GLYPHS (it
);
11044 while (it
->current_x
<= it
->last_visible_x
)
11045 PRODUCE_GLYPHS (it
);
11047 /* Don't count these blanks really. It would let us insert a left
11048 truncation glyph below and make us set the cursor on them, maybe. */
11049 it
->current_x
= saved_x
;
11050 it
->object
= saved_object
;
11051 it
->position
= saved_pos
;
11052 it
->what
= saved_what
;
11057 /* Value is non-zero if text starting at CHARPOS in current_buffer is
11058 trailing whitespace. */
11061 trailing_whitespace_p (charpos
)
11064 int bytepos
= CHAR_TO_BYTE (charpos
);
11067 while (bytepos
< ZV_BYTE
11068 && (c
= FETCH_CHAR (bytepos
),
11069 c
== ' ' || c
== '\t'))
11072 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
11074 if (bytepos
!= PT_BYTE
)
11081 /* Highlight trailing whitespace, if any, in ROW. */
11084 highlight_trailing_whitespace (f
, row
)
11086 struct glyph_row
*row
;
11088 int used
= row
->used
[TEXT_AREA
];
11092 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
11093 struct glyph
*glyph
= start
+ used
- 1;
11095 /* Skip over the space glyph inserted to display the
11096 cursor at the end of a line. */
11097 if (glyph
->type
== CHAR_GLYPH
11098 && glyph
->u
.ch
== ' '
11099 && glyph
->object
== 0)
11102 /* If last glyph is a space or stretch, and it's trailing
11103 whitespace, set the face of all trailing whitespace glyphs in
11104 IT->glyph_row to `trailing-whitespace'. */
11106 && BUFFERP (glyph
->object
)
11107 && (glyph
->type
== STRETCH_GLYPH
11108 || (glyph
->type
== CHAR_GLYPH
11109 && glyph
->u
.ch
== ' '))
11110 && trailing_whitespace_p (glyph
->charpos
))
11112 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
,
11115 while (glyph
>= start
11116 && BUFFERP (glyph
->object
)
11117 && (glyph
->type
== STRETCH_GLYPH
11118 || (glyph
->type
== CHAR_GLYPH
11119 && glyph
->u
.ch
== ' ')))
11120 (glyph
--)->face_id
= face_id
;
11126 /* Construct the glyph row IT->glyph_row in the desired matrix of
11127 IT->w from text at the current position of IT. See dispextern.h
11128 for an overview of struct it. Value is non-zero if
11129 IT->glyph_row displays text, as opposed to a line displaying ZV
11136 struct glyph_row
*row
= it
->glyph_row
;
11138 /* We always start displaying at hpos zero even if hscrolled. */
11139 xassert (it
->hpos
== 0 && it
->current_x
== 0);
11141 /* We must not display in a row that's not a text row. */
11142 xassert (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
11143 < it
->w
->desired_matrix
->nrows
);
11145 /* Is IT->w showing the region? */
11146 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
11148 /* Clear the result glyph row and enable it. */
11149 prepare_desired_row (row
);
11151 row
->y
= it
->current_y
;
11152 row
->start
= it
->current
;
11153 row
->continuation_lines_width
= it
->continuation_lines_width
;
11154 row
->displays_text_p
= 1;
11156 /* Arrange the overlays nicely for our purposes. Usually, we call
11157 display_line on only one line at a time, in which case this
11158 can't really hurt too much, or we call it on lines which appear
11159 one after another in the buffer, in which case all calls to
11160 recenter_overlay_lists but the first will be pretty cheap. */
11161 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
11163 /* Move over display elements that are not visible because we are
11164 hscrolled. This may stop at an x-position < IT->first_visible_x
11165 if the first glyph is partially visible or if we hit a line end. */
11166 if (it
->current_x
< it
->first_visible_x
)
11167 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
11168 MOVE_TO_POS
| MOVE_TO_X
);
11170 /* Get the initial row height. This is either the height of the
11171 text hscrolled, if there is any, or zero. */
11172 row
->ascent
= it
->max_ascent
;
11173 row
->height
= it
->max_ascent
+ it
->max_descent
;
11174 row
->phys_ascent
= it
->max_phys_ascent
;
11175 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
11177 /* Loop generating characters. The loop is left with IT on the next
11178 character to display. */
11181 int n_glyphs_before
, hpos_before
, x_before
;
11184 /* Retrieve the next thing to display. Value is zero if end of
11186 if (!get_next_display_element (it
))
11188 /* Maybe add a space at the end of this line that is used to
11189 display the cursor there under X. Set the charpos of the
11190 first glyph of blank lines not corresponding to any text
11192 if ((append_space (it
, 1) && row
->used
[TEXT_AREA
] == 1)
11193 || row
->used
[TEXT_AREA
] == 0)
11195 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
11196 row
->displays_text_p
= 0;
11198 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
))
11199 row
->indicate_empty_line_p
= 1;
11202 it
->continuation_lines_width
= 0;
11203 row
->ends_at_zv_p
= 1;
11207 /* Now, get the metrics of what we want to display. This also
11208 generates glyphs in `row' (which is IT->glyph_row). */
11209 n_glyphs_before
= row
->used
[TEXT_AREA
];
11211 PRODUCE_GLYPHS (it
);
11213 /* If this display element was in marginal areas, continue with
11215 if (it
->area
!= TEXT_AREA
)
11217 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
11218 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
11219 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
11220 row
->phys_height
= max (row
->phys_height
,
11221 it
->max_phys_ascent
+ it
->max_phys_descent
);
11222 set_iterator_to_next (it
);
11226 /* Does the display element fit on the line? If we truncate
11227 lines, we should draw past the right edge of the window. If
11228 we don't truncate, we want to stop so that we can display the
11229 continuation glyph before the right margin. If lines are
11230 continued, there are two possible strategies for characters
11231 resulting in more than 1 glyph (e.g. tabs): Display as many
11232 glyphs as possible in this line and leave the rest for the
11233 continuation line, or display the whole element in the next
11234 line. Original redisplay did the former, so we do it also. */
11235 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11236 hpos_before
= it
->hpos
;
11240 && it
->current_x
< it
->last_visible_x
)
11243 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
11244 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
11245 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
11246 row
->phys_height
= max (row
->phys_height
,
11247 it
->max_phys_ascent
+ it
->max_phys_descent
);
11248 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
11249 row
->x
= x
- it
->first_visible_x
;
11254 struct glyph
*glyph
;
11256 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
11258 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11259 new_x
= x
+ glyph
->pixel_width
;
11261 if (/* Lines are continued. */
11262 !it
->truncate_lines_p
11263 && (/* Glyph doesn't fit on the line. */
11264 new_x
> it
->last_visible_x
11265 /* Or it fits exactly on a window system frame. */
11266 || (new_x
== it
->last_visible_x
11267 && FRAME_WINDOW_P (it
->f
))))
11269 /* End of a continued line. */
11272 || (new_x
== it
->last_visible_x
11273 && FRAME_WINDOW_P (it
->f
)))
11275 /* Current glyph fits exactly on the line. We
11276 must continue the line because we can't draw
11277 the cursor after the glyph. */
11278 row
->continued_p
= 1;
11279 it
->current_x
= new_x
;
11280 it
->continuation_lines_width
+= new_x
;
11282 if (i
== nglyphs
- 1)
11283 set_iterator_to_next (it
);
11287 /* Display element draws past the right edge of
11288 the window. Restore positions to values
11289 before the element. The next line starts
11290 with current_x before the glyph that could
11291 not be displayed, so that TAB works right. */
11292 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
11294 /* Display continuation glyphs. */
11295 if (!FRAME_WINDOW_P (it
->f
))
11296 produce_special_glyphs (it
, IT_CONTINUATION
);
11297 row
->continued_p
= 1;
11300 it
->continuation_lines_width
+= x
;
11304 else if (new_x
> it
->first_visible_x
)
11306 /* Increment number of glyphs actually displayed. */
11309 if (x
< it
->first_visible_x
)
11310 /* Glyph is partially visible, i.e. row starts at
11311 negative X position. */
11312 row
->x
= x
- it
->first_visible_x
;
11316 /* Glyph is completely off the left margin of the
11317 window. This should not happen because of the
11318 move_it_in_display_line at the start of
11324 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
11325 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
11326 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
11327 row
->phys_height
= max (row
->phys_height
,
11328 it
->max_phys_ascent
+ it
->max_phys_descent
);
11330 /* End of this display line if row is continued. */
11331 if (row
->continued_p
)
11335 /* Is this a line end? If yes, we're also done, after making
11336 sure that a non-default face is extended up to the right
11337 margin of the window. */
11338 if (ITERATOR_AT_END_OF_LINE_P (it
))
11340 int used_before
= row
->used
[TEXT_AREA
];
11342 /* Add a space at the end of the line that is used to
11343 display the cursor there. */
11344 append_space (it
, 0);
11346 /* Extend the face to the end of the line. */
11347 extend_face_to_end_of_line (it
);
11349 /* Make sure we have the position. */
11350 if (used_before
== 0)
11351 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
11353 /* Consume the line end. This skips over invisible lines. */
11354 set_iterator_to_next (it
);
11355 it
->continuation_lines_width
= 0;
11359 /* Proceed with next display element. Note that this skips
11360 over lines invisible because of selective display. */
11361 set_iterator_to_next (it
);
11363 /* If we truncate lines, we are done when the last displayed
11364 glyphs reach past the right margin of the window. */
11365 if (it
->truncate_lines_p
11366 && (FRAME_WINDOW_P (it
->f
)
11367 ? (it
->current_x
>= it
->last_visible_x
)
11368 : (it
->current_x
> it
->last_visible_x
)))
11370 /* Maybe add truncation glyphs. */
11371 if (!FRAME_WINDOW_P (it
->f
))
11373 --it
->glyph_row
->used
[TEXT_AREA
];
11374 produce_special_glyphs (it
, IT_TRUNCATION
);
11377 row
->truncated_on_right_p
= 1;
11378 it
->continuation_lines_width
= 0;
11379 reseat_at_next_visible_line_start (it
, 0);
11380 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
11381 it
->hpos
= hpos_before
;
11382 it
->current_x
= x_before
;
11387 /* If line is not empty and hscrolled, maybe insert truncation glyphs
11388 at the left window margin. */
11389 if (it
->first_visible_x
11390 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
11392 if (!FRAME_WINDOW_P (it
->f
))
11393 insert_left_trunc_glyphs (it
);
11394 row
->truncated_on_left_p
= 1;
11397 /* If the start of this line is the overlay arrow-position, then
11398 mark this glyph row as the one containing the overlay arrow.
11399 This is clearly a mess with variable size fonts. It would be
11400 better to let it be displayed like cursors under X. */
11401 if (MARKERP (Voverlay_arrow_position
)
11402 && current_buffer
== XMARKER (Voverlay_arrow_position
)->buffer
11403 && (MATRIX_ROW_START_CHARPOS (row
)
11404 == marker_position (Voverlay_arrow_position
))
11405 && STRINGP (Voverlay_arrow_string
)
11406 && ! overlay_arrow_seen
)
11408 /* Overlay arrow in window redisplay is a bitmap. */
11409 if (!FRAME_WINDOW_P (it
->f
))
11411 struct glyph_row
*arrow_row
= get_overlay_arrow_glyph_row (it
->w
);
11412 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
11413 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
11414 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
11415 struct glyph
*p2
, *end
;
11417 /* Copy the arrow glyphs. */
11418 while (glyph
< arrow_end
)
11421 /* Throw away padding glyphs. */
11423 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
11424 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
11430 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
11434 overlay_arrow_seen
= 1;
11435 row
->overlay_arrow_p
= 1;
11438 /* Compute pixel dimensions of this line. */
11439 compute_line_metrics (it
);
11441 /* Remember the position at which this line ends. */
11442 row
->end
= it
->current
;
11444 /* Maybe set the cursor. If you change this, it's probably a good
11445 idea to also change the code in redisplay_window for cursor
11446 movement in an unchanged window. */
11447 if (it
->w
->cursor
.vpos
< 0
11448 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
11449 && MATRIX_ROW_END_CHARPOS (row
) >= PT
11450 && !(MATRIX_ROW_END_CHARPOS (row
) == PT
11451 && (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)
11452 || !row
->ends_at_zv_p
)))
11453 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
11455 /* Highlight trailing whitespace. */
11456 if (!NILP (Vshow_trailing_whitespace
))
11457 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
11459 /* Prepare for the next line. This line starts horizontally at (X
11460 HPOS) = (0 0). Vertical positions are incremented. As a
11461 convenience for the caller, IT->glyph_row is set to the next
11463 it
->current_x
= it
->hpos
= 0;
11464 it
->current_y
+= row
->height
;
11467 return row
->displays_text_p
;
11472 /***********************************************************************
11474 ***********************************************************************/
11476 /* Redisplay the menu bar in the frame for window W.
11478 The menu bar of X frames that don't have X toolkit support is
11479 displayed in a special window W->frame->menu_bar_window.
11481 The menu bar of terminal frames is treated specially as far as
11482 glyph matrices are concerned. Menu bar lines are not part of
11483 windows, so the update is done directly on the frame matrix rows
11484 for the menu bar. */
11487 display_menu_bar (w
)
11490 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
11495 /* Don't do all this for graphical frames. */
11497 if (!NILP (Vwindow_system
))
11500 #ifdef USE_X_TOOLKIT
11505 #ifdef USE_X_TOOLKIT
11506 xassert (!FRAME_WINDOW_P (f
));
11507 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
11508 it
.first_visible_x
= 0;
11509 it
.last_visible_x
= FRAME_WINDOW_WIDTH (f
) * CANON_X_UNIT (f
);
11510 #else /* not USE_X_TOOLKIT */
11511 if (FRAME_WINDOW_P (f
))
11513 /* Menu bar lines are displayed in the desired matrix of the
11514 dummy window menu_bar_window. */
11515 struct window
*menu_w
;
11516 xassert (WINDOWP (f
->menu_bar_window
));
11517 menu_w
= XWINDOW (f
->menu_bar_window
);
11518 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
11520 it
.first_visible_x
= 0;
11521 it
.last_visible_x
= FRAME_WINDOW_WIDTH (f
) * CANON_X_UNIT (f
);
11525 /* This is a TTY frame, i.e. character hpos/vpos are used as
11527 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
11529 it
.first_visible_x
= 0;
11530 it
.last_visible_x
= FRAME_WIDTH (f
);
11532 #endif /* not USE_X_TOOLKIT */
11534 /* Clear all rows of the menu bar. */
11535 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
11537 struct glyph_row
*row
= it
.glyph_row
+ i
;
11538 clear_glyph_row (row
);
11539 row
->enabled_p
= 1;
11540 row
->full_width_p
= 1;
11543 /* Make the first line of the menu bar appear in reverse video. */
11544 it
.glyph_row
->inverse_p
= mode_line_inverse_video
!= 0;
11546 /* Display all items of the menu bar. */
11547 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
11548 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
11550 Lisp_Object string
;
11552 /* Stop at nil string. */
11553 string
= XVECTOR (items
)->contents
[i
+ 1];
11557 /* Remember where item was displayed. */
11558 XSETFASTINT (XVECTOR (items
)->contents
[i
+ 3], it
.hpos
);
11560 /* Display the item, pad with one space. */
11561 if (it
.current_x
< it
.last_visible_x
)
11562 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
11563 XSTRING (string
)->size
+ 1, 0, 0, -1);
11566 /* Fill out the line with spaces. */
11567 if (it
.current_x
< it
.last_visible_x
)
11568 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
11570 /* Compute the total height of the lines. */
11571 compute_line_metrics (&it
);
11576 /***********************************************************************
11578 ***********************************************************************/
11580 /* Display the mode and/or top line of window W. */
11583 display_mode_lines (w
)
11586 /* These will be set while the mode line specs are processed. */
11587 line_number_displayed
= 0;
11588 w
->column_number_displayed
= Qnil
;
11590 if (WINDOW_WANTS_MODELINE_P (w
))
11591 display_mode_line (w
, MODE_LINE_FACE_ID
,
11592 current_buffer
->mode_line_format
);
11594 if (WINDOW_WANTS_HEADER_LINE_P (w
))
11595 display_mode_line (w
, HEADER_LINE_FACE_ID
,
11596 current_buffer
->header_line_format
);
11600 /* Display mode or top line of window W. FACE_ID specifies which line
11601 to display; it is either MODE_LINE_FACE_ID or HEADER_LINE_FACE_ID.
11602 FORMAT is the mode line format to display. */
11605 display_mode_line (w
, face_id
, format
)
11607 enum face_id face_id
;
11608 Lisp_Object format
;
11613 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
11614 prepare_desired_row (it
.glyph_row
);
11616 /* Temporarily make frame's keyboard the current kboard so that
11617 kboard-local variables in the mode_line_format will get the right
11619 push_frame_kboard (it
.f
);
11620 display_mode_element (&it
, 0, 0, 0, format
);
11621 pop_frame_kboard ();
11623 /* Fill up with spaces. */
11624 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
11626 compute_line_metrics (&it
);
11627 it
.glyph_row
->full_width_p
= 1;
11628 it
.glyph_row
->mode_line_p
= 1;
11629 it
.glyph_row
->inverse_p
= mode_line_inverse_video
!= 0;
11630 it
.glyph_row
->continued_p
= 0;
11631 it
.glyph_row
->truncated_on_left_p
= 0;
11632 it
.glyph_row
->truncated_on_right_p
= 0;
11634 /* Make a 3D mode-line have a shadow at its right end. */
11635 face
= FACE_FROM_ID (it
.f
, face_id
);
11636 extend_face_to_end_of_line (&it
);
11637 if (face
->box
!= FACE_NO_BOX
)
11639 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
11640 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
11641 last
->right_box_line_p
= 1;
11646 /* Contribute ELT to the mode line for window IT->w. How it
11647 translates into text depends on its data type.
11649 IT describes the display environment in which we display, as usual.
11651 DEPTH is the depth in recursion. It is used to prevent
11652 infinite recursion here.
11654 FIELD_WIDTH is the number of characters the display of ELT should
11655 occupy in the mode line, and PRECISION is the maximum number of
11656 characters to display from ELT's representation. See
11657 display_string for details. *
11659 Returns the hpos of the end of the text generated by ELT. */
11662 display_mode_element (it
, depth
, field_width
, precision
, elt
)
11665 int field_width
, precision
;
11668 int n
= 0, field
, prec
;
11676 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
11680 /* A string: output it and check for %-constructs within it. */
11682 unsigned char *this = XSTRING (elt
)->data
;
11683 unsigned char *lisp_string
= this;
11685 while ((precision
<= 0 || n
< precision
)
11687 && (frame_title_ptr
11688 || it
->current_x
< it
->last_visible_x
))
11690 unsigned char *last
= this;
11692 /* Advance to end of string or next format specifier. */
11693 while ((c
= *this++) != '\0' && c
!= '%')
11696 if (this - 1 != last
)
11698 /* Output to end of string or up to '%'. Field width
11699 is length of string. Don't output more than
11700 PRECISION allows us. */
11701 prec
= --this - last
;
11702 if (precision
> 0 && prec
> precision
- n
)
11703 prec
= precision
- n
;
11705 if (frame_title_ptr
)
11706 n
+= store_frame_title (last
, prec
, prec
);
11708 n
+= display_string (NULL
, elt
, Qnil
, 0, last
- lisp_string
,
11709 it
, 0, prec
, 0, -1);
11711 else /* c == '%' */
11713 unsigned char *percent_position
= this;
11715 /* Get the specified minimum width. Zero means
11718 while ((c
= *this++) >= '0' && c
<= '9')
11719 field
= field
* 10 + c
- '0';
11721 /* Don't pad beyond the total padding allowed. */
11722 if (field_width
- n
> 0 && field
> field_width
- n
)
11723 field
= field_width
- n
;
11725 /* Note that either PRECISION <= 0 or N < PRECISION. */
11726 prec
= precision
- n
;
11729 n
+= display_mode_element (it
, depth
, field
, prec
,
11730 Vglobal_mode_string
);
11733 unsigned char *spec
11734 = decode_mode_spec (it
->w
, c
, field
, prec
);
11736 if (frame_title_ptr
)
11737 n
+= store_frame_title (spec
, field
, prec
);
11741 = it
->glyph_row
->used
[TEXT_AREA
];
11743 = percent_position
- XSTRING (elt
)->data
;
11745 = display_string (spec
, Qnil
, elt
, charpos
, 0, it
,
11746 field
, prec
, 0, -1);
11748 /* Assign to the glyphs written above the
11749 string where the `%x' came from, position
11753 struct glyph
*glyph
11754 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
11758 for (i
= 0; i
< nwritten
; ++i
)
11760 glyph
[i
].object
= elt
;
11761 glyph
[i
].charpos
= charpos
;
11774 /* A symbol: process the value of the symbol recursively
11775 as if it appeared here directly. Avoid error if symbol void.
11776 Special case: if value of symbol is a string, output the string
11779 register Lisp_Object tem
;
11780 tem
= Fboundp (elt
);
11783 tem
= Fsymbol_value (elt
);
11784 /* If value is a string, output that string literally:
11785 don't check for % within it. */
11788 prec
= XSTRING (tem
)->size
;
11789 if (precision
> 0 && prec
> precision
- n
)
11790 prec
= precision
- n
;
11791 if (frame_title_ptr
)
11792 n
+= store_frame_title (XSTRING (tem
)->data
, -1, prec
);
11794 n
+= display_string (NULL
, tem
, Qnil
, 0, 0, it
,
11797 else if (!EQ (tem
, elt
))
11799 /* Give up right away for nil or t. */
11809 register Lisp_Object car
, tem
;
11811 /* A cons cell: three distinct cases.
11812 If first element is a string or a cons, process all the elements
11813 and effectively concatenate them.
11814 If first element is a negative number, truncate displaying cdr to
11815 at most that many characters. If positive, pad (with spaces)
11816 to at least that many characters.
11817 If first element is a symbol, process the cadr or caddr recursively
11818 according to whether the symbol's value is non-nil or nil. */
11820 if (EQ (car
, QCeval
) && CONSP (XCDR (elt
)))
11822 /* An element of the form (:eval FORM) means evaluate FORM
11823 and use the result as mode line elements. */
11824 struct gcpro gcpro1
;
11827 spec
= eval_form (XCAR (XCDR (elt
)));
11829 n
+= display_mode_element (it
, depth
, field_width
- n
,
11830 precision
- n
, spec
);
11833 else if (SYMBOLP (car
))
11835 tem
= Fboundp (car
);
11839 /* elt is now the cdr, and we know it is a cons cell.
11840 Use its car if CAR has a non-nil value. */
11843 tem
= Fsymbol_value (car
);
11850 /* Symbol's value is nil (or symbol is unbound)
11851 Get the cddr of the original list
11852 and if possible find the caddr and use that. */
11856 else if (!CONSP (elt
))
11861 else if (INTEGERP (car
))
11863 register int lim
= XINT (car
);
11867 /* Negative int means reduce maximum width. */
11868 if (precision
<= 0)
11871 precision
= min (precision
, -lim
);
11875 /* Padding specified. Don't let it be more than
11876 current maximum. */
11878 lim
= min (precision
, lim
);
11880 /* If that's more padding than already wanted, queue it.
11881 But don't reduce padding already specified even if
11882 that is beyond the current truncation point. */
11883 field_width
= max (lim
, field_width
);
11887 else if (STRINGP (car
) || CONSP (car
))
11889 register int limit
= 50;
11890 /* Limit is to protect against circular lists. */
11893 && (precision
<= 0 || n
< precision
))
11895 n
+= display_mode_element (it
, depth
, field_width
- n
,
11896 precision
- n
, XCAR (elt
));
11905 if (frame_title_ptr
)
11906 n
+= store_frame_title ("*invalid*", 0, precision
- n
);
11908 n
+= display_string ("*invalid*", Qnil
, Qnil
, 0, 0, it
, 0,
11909 precision
- n
, 0, 0);
11913 /* Pad to FIELD_WIDTH. */
11914 if (field_width
> 0 && n
< field_width
)
11916 if (frame_title_ptr
)
11917 n
+= store_frame_title ("", field_width
- n
, 0);
11919 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
11927 /* Write a null-terminated, right justified decimal representation of
11928 the positive integer D to BUF using a minimal field width WIDTH. */
11931 pint2str (buf
, width
, d
)
11932 register char *buf
;
11933 register int width
;
11936 register char *p
= buf
;
11944 *p
++ = d
% 10 + '0';
11949 for (width
-= (int) (p
- buf
); width
> 0; --width
)
11960 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
11961 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
11962 type of CODING_SYSTEM. Return updated pointer into BUF. */
11964 static unsigned char invalid_eol_type
[] = "(*invalid*)";
11967 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
11968 Lisp_Object coding_system
;
11969 register char *buf
;
11973 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
11974 unsigned char *eol_str
;
11976 /* The EOL conversion we are using. */
11977 Lisp_Object eoltype
;
11979 val
= coding_system
;
11981 if (NILP (val
)) /* Not yet decided. */
11986 eoltype
= eol_mnemonic_undecided
;
11987 /* Don't mention EOL conversion if it isn't decided. */
11991 Lisp_Object eolvalue
;
11993 eolvalue
= Fget (coding_system
, Qeol_type
);
11995 while (!NILP (val
) && SYMBOLP (val
))
11997 val
= Fget (val
, Qcoding_system
);
11998 if (NILP (eolvalue
))
11999 eolvalue
= Fget (val
, Qeol_type
);
12003 *buf
++ = XFASTINT (XVECTOR (val
)->contents
[1]);
12007 /* The EOL conversion that is normal on this system. */
12009 if (NILP (eolvalue
)) /* Not yet decided. */
12010 eoltype
= eol_mnemonic_undecided
;
12011 else if (VECTORP (eolvalue
)) /* Not yet decided. */
12012 eoltype
= eol_mnemonic_undecided
;
12013 else /* INTEGERP (eolvalue) -- 0:LF, 1:CRLF, 2:CR */
12014 eoltype
= (XFASTINT (eolvalue
) == 0
12015 ? eol_mnemonic_unix
12016 : (XFASTINT (eolvalue
) == 1
12017 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
12023 /* Mention the EOL conversion if it is not the usual one. */
12024 if (STRINGP (eoltype
))
12026 eol_str
= XSTRING (eoltype
)->data
;
12027 eol_str_len
= XSTRING (eoltype
)->size
;
12029 else if (INTEGERP (eoltype
)
12030 && CHAR_VALID_P (XINT (eoltype
), 0))
12032 eol_str_len
= CHAR_STRING (XINT (eoltype
), eol_str
);
12036 eol_str
= invalid_eol_type
;
12037 eol_str_len
= sizeof (invalid_eol_type
) - 1;
12039 bcopy (eol_str
, buf
, eol_str_len
);
12040 buf
+= eol_str_len
;
12046 /* Return a string for the output of a mode line %-spec for window W,
12047 generated by character C. PRECISION >= 0 means don't return a
12048 string longer than that value. FIELD_WIDTH > 0 means pad the
12049 string returned with spaces to that value. */
12051 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
12054 decode_mode_spec (w
, c
, field_width
, precision
)
12057 int field_width
, precision
;
12060 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
12061 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
12062 struct buffer
*b
= XBUFFER (w
->buffer
);
12069 if (!NILP (b
->read_only
))
12071 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
12076 /* This differs from %* only for a modified read-only buffer. */
12077 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
12079 if (!NILP (b
->read_only
))
12084 /* This differs from %* in ignoring read-only-ness. */
12085 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
12097 if (command_loop_level
> 5)
12099 p
= decode_mode_spec_buf
;
12100 for (i
= 0; i
< command_loop_level
; i
++)
12103 return decode_mode_spec_buf
;
12111 if (command_loop_level
> 5)
12113 p
= decode_mode_spec_buf
;
12114 for (i
= 0; i
< command_loop_level
; i
++)
12117 return decode_mode_spec_buf
;
12124 /* Let lots_of_dashes be a string of infinite length. */
12125 if (field_width
<= 0
12126 || field_width
> sizeof (lots_of_dashes
))
12128 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
12129 decode_mode_spec_buf
[i
] = '-';
12130 decode_mode_spec_buf
[i
] = '\0';
12131 return decode_mode_spec_buf
;
12134 return lots_of_dashes
;
12143 int col
= current_column ();
12144 XSETFASTINT (w
->column_number_displayed
, col
);
12145 pint2str (decode_mode_spec_buf
, field_width
, col
);
12146 return decode_mode_spec_buf
;
12150 /* %F displays the frame name. */
12151 if (!NILP (f
->title
))
12152 return (char *) XSTRING (f
->title
)->data
;
12153 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
12154 return (char *) XSTRING (f
->name
)->data
;
12163 int startpos
= XMARKER (w
->start
)->charpos
;
12164 int startpos_byte
= marker_byte_position (w
->start
);
12165 int line
, linepos
, linepos_byte
, topline
;
12167 int height
= XFASTINT (w
->height
);
12169 /* If we decided that this buffer isn't suitable for line numbers,
12170 don't forget that too fast. */
12171 if (EQ (w
->base_line_pos
, w
->buffer
))
12173 /* But do forget it, if the window shows a different buffer now. */
12174 else if (BUFFERP (w
->base_line_pos
))
12175 w
->base_line_pos
= Qnil
;
12177 /* If the buffer is very big, don't waste time. */
12178 if (BUF_ZV (b
) - BUF_BEGV (b
) > line_number_display_limit
)
12180 w
->base_line_pos
= Qnil
;
12181 w
->base_line_number
= Qnil
;
12185 if (!NILP (w
->base_line_number
)
12186 && !NILP (w
->base_line_pos
)
12187 && XFASTINT (w
->base_line_pos
) <= startpos
)
12189 line
= XFASTINT (w
->base_line_number
);
12190 linepos
= XFASTINT (w
->base_line_pos
);
12191 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
12196 linepos
= BUF_BEGV (b
);
12197 linepos_byte
= BUF_BEGV_BYTE (b
);
12200 /* Count lines from base line to window start position. */
12201 nlines
= display_count_lines (linepos
, linepos_byte
,
12205 topline
= nlines
+ line
;
12207 /* Determine a new base line, if the old one is too close
12208 or too far away, or if we did not have one.
12209 "Too close" means it's plausible a scroll-down would
12210 go back past it. */
12211 if (startpos
== BUF_BEGV (b
))
12213 XSETFASTINT (w
->base_line_number
, topline
);
12214 XSETFASTINT (w
->base_line_pos
, BUF_BEGV (b
));
12216 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
12217 || linepos
== BUF_BEGV (b
))
12219 int limit
= BUF_BEGV (b
);
12220 int limit_byte
= BUF_BEGV_BYTE (b
);
12222 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
12224 if (startpos
- distance
> limit
)
12226 limit
= startpos
- distance
;
12227 limit_byte
= CHAR_TO_BYTE (limit
);
12230 nlines
= display_count_lines (startpos
, startpos_byte
,
12232 - (height
* 2 + 30),
12234 /* If we couldn't find the lines we wanted within
12235 line_number_display_limit_width chars per line,
12236 give up on line numbers for this window. */
12237 if (position
== limit_byte
&& limit
== startpos
- distance
)
12239 w
->base_line_pos
= w
->buffer
;
12240 w
->base_line_number
= Qnil
;
12244 XSETFASTINT (w
->base_line_number
, topline
- nlines
);
12245 XSETFASTINT (w
->base_line_pos
, BYTE_TO_CHAR (position
));
12248 /* Now count lines from the start pos to point. */
12249 nlines
= display_count_lines (startpos
, startpos_byte
,
12250 PT_BYTE
, PT
, &junk
);
12252 /* Record that we did display the line number. */
12253 line_number_displayed
= 1;
12255 /* Make the string to show. */
12256 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
12257 return decode_mode_spec_buf
;
12260 char* p
= decode_mode_spec_buf
;
12261 int pad
= field_width
- 2;
12266 return decode_mode_spec_buf
;
12272 obj
= b
->mode_name
;
12276 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
12282 int pos
= marker_position (w
->start
);
12283 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
12285 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
12287 if (pos
<= BUF_BEGV (b
))
12292 else if (pos
<= BUF_BEGV (b
))
12296 if (total
> 1000000)
12297 /* Do it differently for a large value, to avoid overflow. */
12298 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
12300 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
12301 /* We can't normally display a 3-digit number,
12302 so get us a 2-digit number that is close. */
12305 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
12306 return decode_mode_spec_buf
;
12310 /* Display percentage of size above the bottom of the screen. */
12313 int toppos
= marker_position (w
->start
);
12314 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
12315 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
12317 if (botpos
>= BUF_ZV (b
))
12319 if (toppos
<= BUF_BEGV (b
))
12326 if (total
> 1000000)
12327 /* Do it differently for a large value, to avoid overflow. */
12328 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
12330 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
12331 /* We can't normally display a 3-digit number,
12332 so get us a 2-digit number that is close. */
12335 if (toppos
<= BUF_BEGV (b
))
12336 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
12338 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
12339 return decode_mode_spec_buf
;
12344 /* status of process */
12345 obj
= Fget_buffer_process (w
->buffer
);
12347 return "no process";
12348 #ifdef subprocesses
12349 obj
= Fsymbol_name (Fprocess_status (obj
));
12353 case 't': /* indicate TEXT or BINARY */
12354 #ifdef MODE_LINE_BINARY_TEXT
12355 return MODE_LINE_BINARY_TEXT (b
);
12361 /* coding-system (not including end-of-line format) */
12363 /* coding-system (including end-of-line type) */
12365 int eol_flag
= (c
== 'Z');
12366 char *p
= decode_mode_spec_buf
;
12368 if (! FRAME_WINDOW_P (f
))
12370 /* No need to mention EOL here--the terminal never needs
12371 to do EOL conversion. */
12372 p
= decode_mode_spec_coding (keyboard_coding
.symbol
, p
, 0);
12373 p
= decode_mode_spec_coding (terminal_coding
.symbol
, p
, 0);
12375 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
12378 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
12379 #ifdef subprocesses
12380 obj
= Fget_buffer_process (Fcurrent_buffer ());
12381 if (PROCESSP (obj
))
12383 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
12385 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
12388 #endif /* subprocesses */
12391 return decode_mode_spec_buf
;
12396 return (char *) XSTRING (obj
)->data
;
12402 /* Count up to COUNT lines starting from START / START_BYTE.
12403 But don't go beyond LIMIT_BYTE.
12404 Return the number of lines thus found (always nonnegative).
12406 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
12409 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
12410 int start
, start_byte
, limit_byte
, count
;
12413 register unsigned char *cursor
;
12414 unsigned char *base
;
12416 register int ceiling
;
12417 register unsigned char *ceiling_addr
;
12418 int orig_count
= count
;
12420 /* If we are not in selective display mode,
12421 check only for newlines. */
12422 int selective_display
= (!NILP (current_buffer
->selective_display
)
12423 && !INTEGERP (current_buffer
->selective_display
));
12427 while (start_byte
< limit_byte
)
12429 ceiling
= BUFFER_CEILING_OF (start_byte
);
12430 ceiling
= min (limit_byte
- 1, ceiling
);
12431 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
12432 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
12435 if (selective_display
)
12436 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
12439 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
12442 if (cursor
!= ceiling_addr
)
12446 start_byte
+= cursor
- base
+ 1;
12447 *byte_pos_ptr
= start_byte
;
12451 if (++cursor
== ceiling_addr
)
12457 start_byte
+= cursor
- base
;
12462 while (start_byte
> limit_byte
)
12464 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
12465 ceiling
= max (limit_byte
, ceiling
);
12466 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
12467 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
12470 if (selective_display
)
12471 while (--cursor
!= ceiling_addr
12472 && *cursor
!= '\n' && *cursor
!= 015)
12475 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
12478 if (cursor
!= ceiling_addr
)
12482 start_byte
+= cursor
- base
+ 1;
12483 *byte_pos_ptr
= start_byte
;
12484 /* When scanning backwards, we should
12485 not count the newline posterior to which we stop. */
12486 return - orig_count
- 1;
12492 /* Here we add 1 to compensate for the last decrement
12493 of CURSOR, which took it past the valid range. */
12494 start_byte
+= cursor
- base
+ 1;
12498 *byte_pos_ptr
= limit_byte
;
12501 return - orig_count
+ count
;
12502 return orig_count
- count
;
12508 /***********************************************************************
12510 ***********************************************************************/
12512 /* Display a NUL-terminated string, starting with index START.
12514 If STRING is non-null, display that C string. Otherwise, the Lisp
12515 string LISP_STRING is displayed.
12517 If FACE_STRING is not nil, FACE_STRING_POS is a position in
12518 FACE_STRING. Display STRING or LISP_STRING with the face at
12519 FACE_STRING_POS in FACE_STRING:
12521 Display the string in the environment given by IT, but use the
12522 standard display table, temporarily.
12524 FIELD_WIDTH is the minimum number of output glyphs to produce.
12525 If STRING has fewer characters than FIELD_WIDTH, pad to the right
12526 with spaces. If STRING has more characters, more than FIELD_WIDTH
12527 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
12529 PRECISION is the maximum number of characters to output from
12530 STRING. PRECISION < 0 means don't truncate the string.
12532 This is roughly equivalent to printf format specifiers:
12534 FIELD_WIDTH PRECISION PRINTF
12535 ----------------------------------------
12541 MULTIBYTE zero means do not display multibyte chars, > 0 means do
12542 display them, and < 0 means obey the current buffer's value of
12543 enable_multibyte_characters.
12545 Value is the number of glyphs produced. */
12548 display_string (string
, lisp_string
, face_string
, face_string_pos
,
12549 start
, it
, field_width
, precision
, max_x
, multibyte
)
12550 unsigned char *string
;
12551 Lisp_Object lisp_string
;
12552 Lisp_Object face_string
;
12553 int face_string_pos
;
12556 int field_width
, precision
, max_x
;
12559 int hpos_at_start
= it
->hpos
;
12560 int saved_face_id
= it
->face_id
;
12561 struct glyph_row
*row
= it
->glyph_row
;
12563 /* Initialize the iterator IT for iteration over STRING beginning
12564 with index START. We assume that IT may be modified here (which
12565 means that display_line has to do something when displaying a
12566 mini-buffer prompt, which it does). */
12567 reseat_to_string (it
, string
, lisp_string
, start
,
12568 precision
, field_width
, multibyte
);
12570 /* If displaying STRING, set up the face of the iterator
12571 from LISP_STRING, if that's given. */
12572 if (STRINGP (face_string
))
12578 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
12579 0, it
->region_beg_charpos
,
12580 it
->region_end_charpos
,
12581 &endptr
, it
->base_face_id
);
12582 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
12583 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
12586 /* Set max_x to the maximum allowed X position. Don't let it go
12587 beyond the right edge of the window. */
12589 max_x
= it
->last_visible_x
;
12591 max_x
= min (max_x
, it
->last_visible_x
);
12593 /* Skip over display elements that are not visible. because IT->w is
12595 if (it
->current_x
< it
->first_visible_x
)
12596 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
12597 MOVE_TO_POS
| MOVE_TO_X
);
12599 row
->ascent
= it
->max_ascent
;
12600 row
->height
= it
->max_ascent
+ it
->max_descent
;
12601 row
->phys_ascent
= it
->max_phys_ascent
;
12602 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
12604 /* This condition is for the case that we are called with current_x
12605 past last_visible_x. */
12606 while (it
->current_x
< max_x
)
12608 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
12610 /* Get the next display element. */
12611 if (!get_next_display_element (it
))
12614 /* Produce glyphs. */
12615 x_before
= it
->current_x
;
12616 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
12617 PRODUCE_GLYPHS (it
);
12619 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
12622 while (i
< nglyphs
)
12624 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12626 if (!it
->truncate_lines_p
12627 && x
+ glyph
->pixel_width
> max_x
)
12629 /* End of continued line or max_x reached. */
12630 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
12634 else if (x
+ glyph
->pixel_width
> it
->first_visible_x
)
12636 /* Glyph is at least partially visible. */
12638 if (x
< it
->first_visible_x
)
12639 it
->glyph_row
->x
= x
- it
->first_visible_x
;
12643 /* Glyph is off the left margin of the display area.
12644 Should not happen. */
12648 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
12649 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
12650 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
12651 row
->phys_height
= max (row
->phys_height
,
12652 it
->max_phys_ascent
+ it
->max_phys_descent
);
12653 x
+= glyph
->pixel_width
;
12657 /* Stop if max_x reached. */
12661 /* Stop at line ends. */
12662 if (ITERATOR_AT_END_OF_LINE_P (it
))
12664 it
->continuation_lines_width
= 0;
12668 set_iterator_to_next (it
);
12670 /* Stop if truncating at the right edge. */
12671 if (it
->truncate_lines_p
12672 && it
->current_x
>= it
->last_visible_x
)
12674 /* Add truncation mark, but don't do it if the line is
12675 truncated at a padding space. */
12676 if (IT_CHARPOS (*it
) < it
->string_nchars
)
12678 if (!FRAME_WINDOW_P (it
->f
))
12679 produce_special_glyphs (it
, IT_TRUNCATION
);
12680 it
->glyph_row
->truncated_on_right_p
= 1;
12686 /* Maybe insert a truncation at the left. */
12687 if (it
->first_visible_x
12688 && IT_CHARPOS (*it
) > 0)
12690 if (!FRAME_WINDOW_P (it
->f
))
12691 insert_left_trunc_glyphs (it
);
12692 it
->glyph_row
->truncated_on_left_p
= 1;
12695 it
->face_id
= saved_face_id
;
12697 /* Value is number of columns displayed. */
12698 return it
->hpos
- hpos_at_start
;
12703 /* This is like a combination of memq and assq. Return 1 if PROPVAL
12704 appears as an element of LIST or as the car of an element of LIST.
12705 If PROPVAL is a list, compare each element against LIST in that
12706 way, and return 1 if any element of PROPVAL is found in LIST.
12707 Otherwise return 0. This function cannot quit. */
12710 invisible_p (propval
, list
)
12711 register Lisp_Object propval
;
12714 register Lisp_Object tail
, proptail
;
12715 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
12717 register Lisp_Object tem
;
12719 if (EQ (propval
, tem
))
12721 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
12724 if (CONSP (propval
))
12725 for (proptail
= propval
; CONSP (proptail
);
12726 proptail
= XCDR (proptail
))
12728 Lisp_Object propelt
;
12729 propelt
= XCAR (proptail
);
12730 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
12732 register Lisp_Object tem
;
12734 if (EQ (propelt
, tem
))
12736 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
12744 /* Return 1 if PROPVAL appears as the car of an element of LIST and
12745 the cdr of that element is non-nil. If PROPVAL is a list, check
12746 each element of PROPVAL in that way, and the first time some
12747 element is found, return 1 if the cdr of that element is non-nil.
12748 Otherwise return 0. This function cannot quit. */
12751 invisible_ellipsis_p (propval
, list
)
12752 register Lisp_Object propval
;
12755 register Lisp_Object tail
, proptail
;
12757 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
12759 register Lisp_Object tem
;
12761 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
12762 return ! NILP (XCDR (tem
));
12765 if (CONSP (propval
))
12766 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
12768 Lisp_Object propelt
;
12769 propelt
= XCAR (proptail
);
12770 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
12772 register Lisp_Object tem
;
12774 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
12775 return ! NILP (XCDR (tem
));
12784 /***********************************************************************
12786 ***********************************************************************/
12791 Vwith_echo_area_save_vector
= Qnil
;
12792 staticpro (&Vwith_echo_area_save_vector
);
12794 Vmessage_stack
= Qnil
;
12795 staticpro (&Vmessage_stack
);
12797 Qinhibit_redisplay
= intern ("inhibit-redisplay");
12798 staticpro (&Qinhibit_redisplay
);
12801 defsubr (&Sdump_glyph_matrix
);
12802 defsubr (&Sdump_glyph_row
);
12803 defsubr (&Sdump_tool_bar_row
);
12804 defsubr (&Strace_redisplay_toggle
);
12807 staticpro (&Qmenu_bar_update_hook
);
12808 Qmenu_bar_update_hook
= intern ("menu-bar-update-hook");
12810 staticpro (&Qoverriding_terminal_local_map
);
12811 Qoverriding_terminal_local_map
= intern ("overriding-terminal-local-map");
12813 staticpro (&Qoverriding_local_map
);
12814 Qoverriding_local_map
= intern ("overriding-local-map");
12816 staticpro (&Qwindow_scroll_functions
);
12817 Qwindow_scroll_functions
= intern ("window-scroll-functions");
12819 staticpro (&Qredisplay_end_trigger_functions
);
12820 Qredisplay_end_trigger_functions
= intern ("redisplay-end-trigger-functions");
12822 staticpro (&Qinhibit_point_motion_hooks
);
12823 Qinhibit_point_motion_hooks
= intern ("inhibit-point-motion-hooks");
12825 Qdisplay
= intern ("display");
12826 staticpro (&Qdisplay
);
12827 Qspace_width
= intern ("space-width");
12828 staticpro (&Qspace_width
);
12829 Qraise
= intern ("raise");
12830 staticpro (&Qraise
);
12831 Qspace
= intern ("space");
12832 staticpro (&Qspace
);
12833 Qmargin
= intern ("margin");
12834 staticpro (&Qmargin
);
12835 Qleft_margin
= intern ("left-margin");
12836 staticpro (&Qleft_margin
);
12837 Qright_margin
= intern ("right-margin");
12838 staticpro (&Qright_margin
);
12839 Qalign_to
= intern ("align-to");
12840 staticpro (&Qalign_to
);
12841 QCalign_to
= intern (":align-to");
12842 staticpro (&QCalign_to
);
12843 Qrelative_width
= intern ("relative-width");
12844 staticpro (&Qrelative_width
);
12845 QCrelative_width
= intern (":relative-width");
12846 staticpro (&QCrelative_width
);
12847 QCrelative_height
= intern (":relative-height");
12848 staticpro (&QCrelative_height
);
12849 QCeval
= intern (":eval");
12850 staticpro (&QCeval
);
12851 Qwhen
= intern ("when");
12852 staticpro (&Qwhen
);
12853 QCfile
= intern (":file");
12854 staticpro (&QCfile
);
12855 Qfontified
= intern ("fontified");
12856 staticpro (&Qfontified
);
12857 Qfontification_functions
= intern ("fontification-functions");
12858 staticpro (&Qfontification_functions
);
12859 Qtrailing_whitespace
= intern ("trailing-whitespace");
12860 staticpro (&Qtrailing_whitespace
);
12861 Qimage
= intern ("image");
12862 staticpro (&Qimage
);
12864 last_arrow_position
= Qnil
;
12865 last_arrow_string
= Qnil
;
12866 staticpro (&last_arrow_position
);
12867 staticpro (&last_arrow_string
);
12869 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
12870 staticpro (&echo_buffer
[0]);
12871 staticpro (&echo_buffer
[1]);
12873 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
12874 staticpro (&echo_area_buffer
[0]);
12875 staticpro (&echo_area_buffer
[1]);
12877 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
12878 "Non-nil means highlight trailing whitespace.\n\
12879 The face used for trailing whitespace is `trailing-whitespace'.");
12880 Vshow_trailing_whitespace
= Qnil
;
12882 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
12883 "Non-nil means don't actually do any redisplay.\n\
12884 This is used for internal purposes.");
12885 Vinhibit_redisplay
= Qnil
;
12887 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
12888 "String (or mode line construct) included (normally) in `mode-line-format'.");
12889 Vglobal_mode_string
= Qnil
;
12891 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
12892 "Marker for where to display an arrow on top of the buffer text.\n\
12893 This must be the beginning of a line in order to work.\n\
12894 See also `overlay-arrow-string'.");
12895 Voverlay_arrow_position
= Qnil
;
12897 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
12898 "String to display as an arrow. See also `overlay-arrow-position'.");
12899 Voverlay_arrow_string
= Qnil
;
12901 DEFVAR_INT ("scroll-step", &scroll_step
,
12902 "*The number of lines to try scrolling a window by when point moves out.\n\
12903 If that fails to bring point back on frame, point is centered instead.\n\
12904 If this is zero, point is always centered after it moves off frame.");
12906 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
12907 "*Scroll up to this many lines, to bring point back on screen.");
12908 scroll_conservatively
= 0;
12910 DEFVAR_INT ("scroll-margin", &scroll_margin
,
12911 "*Number of lines of margin at the top and bottom of a window.\n\
12912 Recenter the window whenever point gets within this many lines\n\
12913 of the top or bottom of the window.");
12917 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, "Don't ask");
12920 DEFVAR_BOOL ("truncate-partial-width-windows",
12921 &truncate_partial_width_windows
,
12922 "*Non-nil means truncate lines in all windows less than full frame wide.");
12923 truncate_partial_width_windows
= 1;
12925 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
12926 "*Non-nil means use inverse video for the mode line.");
12927 mode_line_inverse_video
= 1;
12929 DEFVAR_INT ("line-number-display-limit", &line_number_display_limit
,
12930 "*Maximum buffer size for which line number should be displayed.\n\
12931 If the buffer is bigger than this, the line number does not appear\n\
12932 in the mode line.");
12933 line_number_display_limit
= 1000000;
12935 DEFVAR_INT ("line-number-display-limit-width", &line_number_display_limit_width
,
12936 "*Maximum line width (in characters) for line number display.\n\
12937 If the average length of the lines near point is bigger than this, then the\n\
12938 line number may be omitted from the mode line.");
12939 line_number_display_limit_width
= 200;
12941 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
12942 "*Non-nil means highlight region even in nonselected windows.");
12943 highlight_nonselected_windows
= 0;
12945 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
12946 "Non-nil if more than one frame is visible on this display.\n\
12947 Minibuffer-only frames don't count, but iconified frames do.\n\
12948 This variable is not guaranteed to be accurate except while processing\n\
12949 `frame-title-format' and `icon-title-format'.");
12951 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
12952 "Template for displaying the title bar of visible frames.\n\
12953 \(Assuming the window manager supports this feature.)\n\
12954 This variable has the same structure as `mode-line-format' (which see),\n\
12955 and is used only on frames for which no explicit name has been set\n\
12956 \(see `modify-frame-parameters').");
12957 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
12958 "Template for displaying the title bar of an iconified frame.\n\
12959 \(Assuming the window manager supports this feature.)\n\
12960 This variable has the same structure as `mode-line-format' (which see),\n\
12961 and is used only on frames for which no explicit name has been set\n\
12962 \(see `modify-frame-parameters').");
12964 = Vframe_title_format
12965 = Fcons (intern ("multiple-frames"),
12966 Fcons (build_string ("%b"),
12967 Fcons (Fcons (build_string (""),
12968 Fcons (intern ("invocation-name"),
12969 Fcons (build_string ("@"),
12970 Fcons (intern ("system-name"),
12974 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
12975 "Maximum number of lines to keep in the message log buffer.\n\
12976 If nil, disable message logging. If t, log messages but don't truncate\n\
12977 the buffer when it becomes large.");
12978 XSETFASTINT (Vmessage_log_max
, 50);
12980 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
12981 "Functions called before redisplay, if window sizes have changed.\n\
12982 The value should be a list of functions that take one argument.\n\
12983 Just before redisplay, for each frame, if any of its windows have changed\n\
12984 size since the last redisplay, or have been split or deleted,\n\
12985 all the functions in the list are called, with the frame as argument.");
12986 Vwindow_size_change_functions
= Qnil
;
12988 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
12989 "List of Functions to call before redisplaying a window with scrolling.\n\
12990 Each function is called with two arguments, the window\n\
12991 and its new display-start position. Note that the value of `window-end'\n\
12992 is not valid when these functions are called.");
12993 Vwindow_scroll_functions
= Qnil
;
12995 DEFVAR_BOOL ("auto-resize-tool-bars", &auto_resize_tool_bars_p
,
12996 "*Non-nil means automatically resize tool-bars.\n\
12997 This increases a tool-bar's height if not all tool-bar items are visible.\n\
12998 It decreases a tool-bar's height when it would display blank lines\n\
13000 auto_resize_tool_bars_p
= 1;
13002 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
13003 "*Non-nil means raise tool-bar buttons when the mouse moves over them.");
13004 auto_raise_tool_bar_buttons_p
= 1;
13006 DEFVAR_INT ("tool-bar-button-margin", &tool_bar_button_margin
,
13007 "*Margin around tool-bar buttons in pixels.");
13008 tool_bar_button_margin
= 1;
13010 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
13011 "Relief thickness of tool-bar buttons.");
13012 tool_bar_button_relief
= 3;
13014 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
13015 "List of functions to call to fontify regions of text.\n\
13016 Each function is called with one argument POS. Functions must\n\
13017 fontify a region starting at POS in the current buffer, and give\n\
13018 fontified regions the property `fontified'.\n\
13019 This variable automatically becomes buffer-local when set.");
13020 Vfontification_functions
= Qnil
;
13021 Fmake_local_variable (Qfontification_functions
);
13023 DEFVAR_BOOL ("unibyte-display-via-language-environment",
13024 &unibyte_display_via_language_environment
,
13025 "*Non-nil means display unibyte text according to language environment.\n\
13026 Specifically this means that unibyte non-ASCII characters\n\
13027 are displayed by converting them to the equivalent multibyte characters\n\
13028 according to the current language environment. As a result, they are\n\
13029 displayed according to the current fontset.");
13030 unibyte_display_via_language_environment
= 0;
13032 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
13033 "*Maximum height for resizing mini-windows.\n\
13034 If a float, it specifies a fraction of the mini-window frame's height.\n\
13035 If an integer, it specifies a number of lines.\n\
13036 If nil, don't resize.");
13037 Vmax_mini_window_height
= make_float (0.25);
13041 /* Initialize this module when Emacs starts. */
13046 Lisp_Object root_window
;
13047 struct window
*mini_w
;
13049 CHARPOS (this_line_start_pos
) = 0;
13051 mini_w
= XWINDOW (minibuf_window
);
13052 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
13054 if (!noninteractive
)
13056 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
13059 XSETFASTINT (XWINDOW (root_window
)->top
, FRAME_TOP_MARGIN (f
));
13060 set_window_height (root_window
,
13061 FRAME_HEIGHT (f
) - 1 - FRAME_TOP_MARGIN (f
),
13063 XSETFASTINT (mini_w
->top
, FRAME_HEIGHT (f
) - 1);
13064 set_window_height (minibuf_window
, 1, 0);
13066 XSETFASTINT (XWINDOW (root_window
)->width
, FRAME_WIDTH (f
));
13067 XSETFASTINT (mini_w
->width
, FRAME_WIDTH (f
));
13069 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
13070 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
13071 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
13073 /* The default ellipsis glyphs `...'. */
13074 for (i
= 0; i
< 3; ++i
)
13075 XSETFASTINT (default_invis_vector
[i
], '.');
13078 #ifdef HAVE_WINDOW_SYSTEM
13080 /* Allocate the buffer for frame titles. */
13082 frame_title_buf
= (char *) xmalloc (size
);
13083 frame_title_buf_end
= frame_title_buf
+ size
;
13084 frame_title_ptr
= NULL
;
13086 #endif /* HAVE_WINDOW_SYSTEM */