1 /* Display generation from window structure and buffer text.
2 Copyright (C) 1985,86,87,88,93,94,95,97,98,99,2000,01,02,03,04
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 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 do? 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 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 an iterator structure (struct it)
126 Iteration over things to be displayed is then simple. It is
127 started by initializing an iterator with a call to init_iterator.
128 Calls to get_next_display_element fill the iterator structure with
129 relevant information about the next thing to display. Calls to
130 set_iterator_to_next move the iterator to the next thing.
132 Besides this, an iterator also contains information about the
133 display environment in which glyphs for display elements are to be
134 produced. It has fields for the width and height of the display,
135 the information whether long lines are truncated or continued, a
136 current X and Y position, and lots of other stuff you can better
139 Glyphs in a desired matrix are normally constructed in a loop
140 calling get_next_display_element and then produce_glyphs. The call
141 to produce_glyphs will fill the iterator structure with pixel
142 information about the element being displayed and at the same time
143 produce glyphs for it. If the display element fits on the line
144 being displayed, set_iterator_to_next is called next, otherwise the
145 glyphs produced are discarded.
150 That just couldn't be all, could it? What about terminal types not
151 supporting operations on sub-windows of the screen? To update the
152 display on such a terminal, window-based glyph matrices are not
153 well suited. To be able to reuse part of the display (scrolling
154 lines up and down), we must instead have a view of the whole
155 screen. This is what `frame matrices' are for. They are a trick.
157 Frames on terminals like above have a glyph pool. Windows on such
158 a frame sub-allocate their glyph memory from their frame's glyph
159 pool. The frame itself is given its own glyph matrices. By
160 coincidence---or maybe something else---rows in window glyph
161 matrices are slices of corresponding rows in frame matrices. Thus
162 writing to window matrices implicitly updates a frame matrix which
163 provides us with the view of the whole screen that we originally
164 wanted to have without having to move many bytes around. To be
165 honest, there is a little bit more done, but not much more. If you
166 plan to extend that code, take a look at dispnew.c. The function
167 build_frame_matrix is a good starting point. */
173 #include "keyboard.h"
176 #include "termchar.h"
177 #include "dispextern.h"
181 #include "commands.h"
185 #include "termhooks.h"
186 #include "intervals.h"
189 #include "region-cache.h"
191 #include "blockinput.h"
193 #ifdef HAVE_X_WINDOWS
203 #ifndef FRAME_X_OUTPUT
204 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
207 #define INFINITY 10000000
209 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
211 extern void set_frame_menubar
P_ ((struct frame
*f
, int, int));
212 extern int pending_menu_activation
;
215 extern int interrupt_input
;
216 extern int command_loop_level
;
218 extern int minibuffer_auto_raise
;
219 extern Lisp_Object Vminibuffer_list
;
221 extern Lisp_Object Qface
;
222 extern Lisp_Object Qmode_line
, Qmode_line_inactive
, Qheader_line
;
224 extern Lisp_Object Voverriding_local_map
;
225 extern Lisp_Object Voverriding_local_map_menu_flag
;
226 extern Lisp_Object Qmenu_item
;
227 extern Lisp_Object Qwhen
;
228 extern Lisp_Object Qhelp_echo
;
230 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
231 Lisp_Object Qwindow_scroll_functions
, Vwindow_scroll_functions
;
232 Lisp_Object Qredisplay_end_trigger_functions
;
233 Lisp_Object Qinhibit_point_motion_hooks
;
234 Lisp_Object QCeval
, QCfile
, QCdata
, QCpropertize
;
235 Lisp_Object Qfontified
;
236 Lisp_Object Qgrow_only
;
237 Lisp_Object Qinhibit_eval_during_redisplay
;
238 Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
241 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
244 Lisp_Object Qarrow
, Qhand
, Qtext
;
246 Lisp_Object Qrisky_local_variable
;
248 /* Holds the list (error). */
249 Lisp_Object list_of_error
;
251 /* Functions called to fontify regions of text. */
253 Lisp_Object Vfontification_functions
;
254 Lisp_Object Qfontification_functions
;
256 /* Non-zero means automatically select any window when the mouse
257 cursor moves into it. */
258 int mouse_autoselect_window
;
260 /* Non-zero means draw tool bar buttons raised when the mouse moves
263 int auto_raise_tool_bar_buttons_p
;
265 /* Margin around tool bar buttons in pixels. */
267 Lisp_Object Vtool_bar_button_margin
;
269 /* Thickness of shadow to draw around tool bar buttons. */
271 EMACS_INT tool_bar_button_relief
;
273 /* Non-zero means automatically resize tool-bars so that all tool-bar
274 items are visible, and no blank lines remain. */
276 int auto_resize_tool_bars_p
;
278 /* Non-zero means draw block and hollow cursor as wide as the glyph
279 under it. For example, if a block cursor is over a tab, it will be
280 drawn as wide as that tab on the display. */
282 int x_stretch_cursor_p
;
284 /* Non-nil means don't actually do any redisplay. */
286 Lisp_Object Vinhibit_redisplay
, Qinhibit_redisplay
;
288 /* Non-zero means Lisp evaluation during redisplay is inhibited. */
290 int inhibit_eval_during_redisplay
;
292 /* Names of text properties relevant for redisplay. */
294 Lisp_Object Qdisplay
;
295 extern Lisp_Object Qface
, Qinvisible
, Qwidth
;
297 /* Symbols used in text property values. */
299 Lisp_Object Vdisplay_pixels_per_inch
;
300 Lisp_Object Qspace
, QCalign_to
, QCrelative_width
, QCrelative_height
;
301 Lisp_Object Qleft_margin
, Qright_margin
, Qspace_width
, Qraise
;
304 Lisp_Object Qmargin
, Qpointer
;
305 Lisp_Object Qline_height
, Qtotal
;
306 extern Lisp_Object Qheight
;
307 extern Lisp_Object QCwidth
, QCheight
, QCascent
;
308 extern Lisp_Object Qscroll_bar
;
310 /* Non-nil means highlight trailing whitespace. */
312 Lisp_Object Vshow_trailing_whitespace
;
314 #ifdef HAVE_WINDOW_SYSTEM
315 extern Lisp_Object Voverflow_newline_into_fringe
;
317 /* Test if overflow newline into fringe. Called with iterator IT
318 at or past right window margin, and with IT->current_x set. */
320 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) \
321 (!NILP (Voverflow_newline_into_fringe) \
322 && FRAME_WINDOW_P (it->f) \
323 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) > 0 \
324 && it->current_x == it->last_visible_x)
326 #endif /* HAVE_WINDOW_SYSTEM */
328 /* Non-nil means show the text cursor in void text areas
329 i.e. in blank areas after eol and eob. This used to be
330 the default in 21.3. */
332 Lisp_Object Vvoid_text_area_pointer
;
334 /* Name of the face used to highlight trailing whitespace. */
336 Lisp_Object Qtrailing_whitespace
;
338 /* The symbol `image' which is the car of the lists used to represent
343 /* The image map types. */
344 Lisp_Object QCmap
, QCpointer
;
345 Lisp_Object Qrect
, Qcircle
, Qpoly
;
347 /* Non-zero means print newline to stdout before next mini-buffer
350 int noninteractive_need_newline
;
352 /* Non-zero means print newline to message log before next message. */
354 static int message_log_need_newline
;
356 /* Three markers that message_dolog uses.
357 It could allocate them itself, but that causes trouble
358 in handling memory-full errors. */
359 static Lisp_Object message_dolog_marker1
;
360 static Lisp_Object message_dolog_marker2
;
361 static Lisp_Object message_dolog_marker3
;
363 /* The buffer position of the first character appearing entirely or
364 partially on the line of the selected window which contains the
365 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
366 redisplay optimization in redisplay_internal. */
368 static struct text_pos this_line_start_pos
;
370 /* Number of characters past the end of the line above, including the
371 terminating newline. */
373 static struct text_pos this_line_end_pos
;
375 /* The vertical positions and the height of this line. */
377 static int this_line_vpos
;
378 static int this_line_y
;
379 static int this_line_pixel_height
;
381 /* X position at which this display line starts. Usually zero;
382 negative if first character is partially visible. */
384 static int this_line_start_x
;
386 /* Buffer that this_line_.* variables are referring to. */
388 static struct buffer
*this_line_buffer
;
390 /* Nonzero means truncate lines in all windows less wide than the
393 int truncate_partial_width_windows
;
395 /* A flag to control how to display unibyte 8-bit character. */
397 int unibyte_display_via_language_environment
;
399 /* Nonzero means we have more than one non-mini-buffer-only frame.
400 Not guaranteed to be accurate except while parsing
401 frame-title-format. */
405 Lisp_Object Vglobal_mode_string
;
408 /* List of variables (symbols) which hold markers for overlay arrows.
409 The symbols on this list are examined during redisplay to determine
410 where to display overlay arrows. */
412 Lisp_Object Voverlay_arrow_variable_list
;
414 /* Marker for where to display an arrow on top of the buffer text. */
416 Lisp_Object Voverlay_arrow_position
;
418 /* String to display for the arrow. Only used on terminal frames. */
420 Lisp_Object Voverlay_arrow_string
;
422 /* Values of those variables at last redisplay are stored as
423 properties on `overlay-arrow-position' symbol. However, if
424 Voverlay_arrow_position is a marker, last-arrow-position is its
425 numerical position. */
427 Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
429 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
430 properties on a symbol in overlay-arrow-variable-list. */
432 Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
434 /* Like mode-line-format, but for the title bar on a visible frame. */
436 Lisp_Object Vframe_title_format
;
438 /* Like mode-line-format, but for the title bar on an iconified frame. */
440 Lisp_Object Vicon_title_format
;
442 /* List of functions to call when a window's size changes. These
443 functions get one arg, a frame on which one or more windows' sizes
446 static Lisp_Object Vwindow_size_change_functions
;
448 Lisp_Object Qmenu_bar_update_hook
, Vmenu_bar_update_hook
;
450 /* Nonzero if overlay arrow has been displayed once in this window. */
452 static int overlay_arrow_seen
;
454 /* Nonzero means highlight the region even in nonselected windows. */
456 int highlight_nonselected_windows
;
458 /* If cursor motion alone moves point off frame, try scrolling this
459 many lines up or down if that will bring it back. */
461 static EMACS_INT scroll_step
;
463 /* Nonzero means scroll just far enough to bring point back on the
464 screen, when appropriate. */
466 static EMACS_INT scroll_conservatively
;
468 /* Recenter the window whenever point gets within this many lines of
469 the top or bottom of the window. This value is translated into a
470 pixel value by multiplying it with FRAME_LINE_HEIGHT, which means
471 that there is really a fixed pixel height scroll margin. */
473 EMACS_INT scroll_margin
;
475 /* Number of windows showing the buffer of the selected window (or
476 another buffer with the same base buffer). keyboard.c refers to
481 /* Vector containing glyphs for an ellipsis `...'. */
483 static Lisp_Object default_invis_vector
[3];
485 /* Zero means display the mode-line/header-line/menu-bar in the default face
486 (this slightly odd definition is for compatibility with previous versions
487 of emacs), non-zero means display them using their respective faces.
489 This variable is deprecated. */
491 int mode_line_inverse_video
;
493 /* Prompt to display in front of the mini-buffer contents. */
495 Lisp_Object minibuf_prompt
;
497 /* Width of current mini-buffer prompt. Only set after display_line
498 of the line that contains the prompt. */
500 int minibuf_prompt_width
;
502 /* This is the window where the echo area message was displayed. It
503 is always a mini-buffer window, but it may not be the same window
504 currently active as a mini-buffer. */
506 Lisp_Object echo_area_window
;
508 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
509 pushes the current message and the value of
510 message_enable_multibyte on the stack, the function restore_message
511 pops the stack and displays MESSAGE again. */
513 Lisp_Object Vmessage_stack
;
515 /* Nonzero means multibyte characters were enabled when the echo area
516 message was specified. */
518 int message_enable_multibyte
;
520 /* Nonzero if we should redraw the mode lines on the next redisplay. */
522 int update_mode_lines
;
524 /* Nonzero if window sizes or contents have changed since last
525 redisplay that finished. */
527 int windows_or_buffers_changed
;
529 /* Nonzero means a frame's cursor type has been changed. */
531 int cursor_type_changed
;
533 /* Nonzero after display_mode_line if %l was used and it displayed a
536 int line_number_displayed
;
538 /* Maximum buffer size for which to display line numbers. */
540 Lisp_Object Vline_number_display_limit
;
542 /* Line width to consider when repositioning for line number display. */
544 static EMACS_INT line_number_display_limit_width
;
546 /* Number of lines to keep in the message log buffer. t means
547 infinite. nil means don't log at all. */
549 Lisp_Object Vmessage_log_max
;
551 /* The name of the *Messages* buffer, a string. */
553 static Lisp_Object Vmessages_buffer_name
;
555 /* Current, index 0, and last displayed echo area message. Either
556 buffers from echo_buffers, or nil to indicate no message. */
558 Lisp_Object echo_area_buffer
[2];
560 /* The buffers referenced from echo_area_buffer. */
562 static Lisp_Object echo_buffer
[2];
564 /* A vector saved used in with_area_buffer to reduce consing. */
566 static Lisp_Object Vwith_echo_area_save_vector
;
568 /* Non-zero means display_echo_area should display the last echo area
569 message again. Set by redisplay_preserve_echo_area. */
571 static int display_last_displayed_message_p
;
573 /* Nonzero if echo area is being used by print; zero if being used by
576 int message_buf_print
;
578 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
580 Lisp_Object Qinhibit_menubar_update
;
581 int inhibit_menubar_update
;
583 /* Maximum height for resizing mini-windows. Either a float
584 specifying a fraction of the available height, or an integer
585 specifying a number of lines. */
587 Lisp_Object Vmax_mini_window_height
;
589 /* Non-zero means messages should be displayed with truncated
590 lines instead of being continued. */
592 int message_truncate_lines
;
593 Lisp_Object Qmessage_truncate_lines
;
595 /* Set to 1 in clear_message to make redisplay_internal aware
596 of an emptied echo area. */
598 static int message_cleared_p
;
600 /* Non-zero means we want a hollow cursor in windows that are not
601 selected. Zero means there's no cursor in such windows. */
603 Lisp_Object Vcursor_in_non_selected_windows
;
604 Lisp_Object Qcursor_in_non_selected_windows
;
606 /* How to blink the default frame cursor off. */
607 Lisp_Object Vblink_cursor_alist
;
609 /* A scratch glyph row with contents used for generating truncation
610 glyphs. Also used in direct_output_for_insert. */
612 #define MAX_SCRATCH_GLYPHS 100
613 struct glyph_row scratch_glyph_row
;
614 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
616 /* Ascent and height of the last line processed by move_it_to. */
618 static int last_max_ascent
, last_height
;
620 /* Non-zero if there's a help-echo in the echo area. */
622 int help_echo_showing_p
;
624 /* If >= 0, computed, exact values of mode-line and header-line height
625 to use in the macros CURRENT_MODE_LINE_HEIGHT and
626 CURRENT_HEADER_LINE_HEIGHT. */
628 int current_mode_line_height
, current_header_line_height
;
630 /* The maximum distance to look ahead for text properties. Values
631 that are too small let us call compute_char_face and similar
632 functions too often which is expensive. Values that are too large
633 let us call compute_char_face and alike too often because we
634 might not be interested in text properties that far away. */
636 #define TEXT_PROP_DISTANCE_LIMIT 100
640 /* Variables to turn off display optimizations from Lisp. */
642 int inhibit_try_window_id
, inhibit_try_window_reusing
;
643 int inhibit_try_cursor_movement
;
645 /* Non-zero means print traces of redisplay if compiled with
648 int trace_redisplay_p
;
650 #endif /* GLYPH_DEBUG */
652 #ifdef DEBUG_TRACE_MOVE
653 /* Non-zero means trace with TRACE_MOVE to stderr. */
656 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
658 #define TRACE_MOVE(x) (void) 0
661 /* Non-zero means automatically scroll windows horizontally to make
664 int automatic_hscrolling_p
;
666 /* How close to the margin can point get before the window is scrolled
668 EMACS_INT hscroll_margin
;
670 /* How much to scroll horizontally when point is inside the above margin. */
671 Lisp_Object Vhscroll_step
;
673 /* The variable `resize-mini-windows'. If nil, don't resize
674 mini-windows. If t, always resize them to fit the text they
675 display. If `grow-only', let mini-windows grow only until they
678 Lisp_Object Vresize_mini_windows
;
680 /* Buffer being redisplayed -- for redisplay_window_error. */
682 struct buffer
*displayed_buffer
;
684 /* Value returned from text property handlers (see below). */
689 HANDLED_RECOMPUTE_PROPS
,
690 HANDLED_OVERLAY_STRING_CONSUMED
,
694 /* A description of text properties that redisplay is interested
699 /* The name of the property. */
702 /* A unique index for the property. */
705 /* A handler function called to set up iterator IT from the property
706 at IT's current position. Value is used to steer handle_stop. */
707 enum prop_handled (*handler
) P_ ((struct it
*it
));
710 static enum prop_handled handle_face_prop
P_ ((struct it
*));
711 static enum prop_handled handle_invisible_prop
P_ ((struct it
*));
712 static enum prop_handled handle_display_prop
P_ ((struct it
*));
713 static enum prop_handled handle_composition_prop
P_ ((struct it
*));
714 static enum prop_handled handle_overlay_change
P_ ((struct it
*));
715 static enum prop_handled handle_fontified_prop
P_ ((struct it
*));
717 /* Properties handled by iterators. */
719 static struct props it_props
[] =
721 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
722 /* Handle `face' before `display' because some sub-properties of
723 `display' need to know the face. */
724 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
725 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
726 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
727 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
731 /* Value is the position described by X. If X is a marker, value is
732 the marker_position of X. Otherwise, value is X. */
734 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
736 /* Enumeration returned by some move_it_.* functions internally. */
740 /* Not used. Undefined value. */
743 /* Move ended at the requested buffer position or ZV. */
744 MOVE_POS_MATCH_OR_ZV
,
746 /* Move ended at the requested X pixel position. */
749 /* Move within a line ended at the end of a line that must be
753 /* Move within a line ended at the end of a line that would
754 be displayed truncated. */
757 /* Move within a line ended at a line end. */
761 /* This counter is used to clear the face cache every once in a while
762 in redisplay_internal. It is incremented for each redisplay.
763 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
766 #define CLEAR_FACE_CACHE_COUNT 500
767 static int clear_face_cache_count
;
769 /* Record the previous terminal frame we displayed. */
771 static struct frame
*previous_terminal_frame
;
773 /* Non-zero while redisplay_internal is in progress. */
777 /* Non-zero means don't free realized faces. Bound while freeing
778 realized faces is dangerous because glyph matrices might still
781 int inhibit_free_realized_faces
;
782 Lisp_Object Qinhibit_free_realized_faces
;
784 /* If a string, XTread_socket generates an event to display that string.
785 (The display is done in read_char.) */
787 Lisp_Object help_echo_string
;
788 Lisp_Object help_echo_window
;
789 Lisp_Object help_echo_object
;
792 /* Temporary variable for XTread_socket. */
794 Lisp_Object previous_help_echo_string
;
796 /* Null glyph slice */
798 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
801 /* Function prototypes. */
803 static void setup_for_ellipsis
P_ ((struct it
*));
804 static void mark_window_display_accurate_1
P_ ((struct window
*, int));
805 static int single_display_prop_string_p
P_ ((Lisp_Object
, Lisp_Object
));
806 static int display_prop_string_p
P_ ((Lisp_Object
, Lisp_Object
));
807 static int cursor_row_p
P_ ((struct window
*, struct glyph_row
*));
808 static int redisplay_mode_lines
P_ ((Lisp_Object
, int));
809 static char *decode_mode_spec_coding
P_ ((Lisp_Object
, char *, int));
812 static int invisible_text_between_p
P_ ((struct it
*, int, int));
815 static int next_element_from_ellipsis
P_ ((struct it
*));
816 static void pint2str
P_ ((char *, int, int));
817 static void pint2hrstr
P_ ((char *, int, int));
818 static struct text_pos run_window_scroll_functions
P_ ((Lisp_Object
,
820 static void reconsider_clip_changes
P_ ((struct window
*, struct buffer
*));
821 static int text_outside_line_unchanged_p
P_ ((struct window
*, int, int));
822 static void store_frame_title_char
P_ ((char));
823 static int store_frame_title
P_ ((const unsigned char *, int, int));
824 static void x_consider_frame_title
P_ ((Lisp_Object
));
825 static void handle_stop
P_ ((struct it
*));
826 static int tool_bar_lines_needed
P_ ((struct frame
*));
827 static int single_display_prop_intangible_p
P_ ((Lisp_Object
));
828 static void ensure_echo_area_buffers
P_ ((void));
829 static Lisp_Object unwind_with_echo_area_buffer
P_ ((Lisp_Object
));
830 static Lisp_Object with_echo_area_buffer_unwind_data
P_ ((struct window
*));
831 static int with_echo_area_buffer
P_ ((struct window
*, int,
832 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
833 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
834 static void clear_garbaged_frames
P_ ((void));
835 static int current_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
836 static int truncate_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
837 static int set_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
838 static int display_echo_area
P_ ((struct window
*));
839 static int display_echo_area_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
840 static int resize_mini_window_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
841 static Lisp_Object unwind_redisplay
P_ ((Lisp_Object
));
842 static int string_char_and_length
P_ ((const unsigned char *, int, int *));
843 static struct text_pos display_prop_end
P_ ((struct it
*, Lisp_Object
,
845 static int compute_window_start_on_continuation_line
P_ ((struct window
*));
846 static Lisp_Object safe_eval_handler
P_ ((Lisp_Object
));
847 static void insert_left_trunc_glyphs
P_ ((struct it
*));
848 static struct glyph_row
*get_overlay_arrow_glyph_row
P_ ((struct window
*,
850 static void extend_face_to_end_of_line
P_ ((struct it
*));
851 static int append_space_for_newline
P_ ((struct it
*, int));
852 static int make_cursor_line_fully_visible
P_ ((struct window
*, int));
853 static int try_scrolling
P_ ((Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int));
854 static int try_cursor_movement
P_ ((Lisp_Object
, struct text_pos
, int *));
855 static int trailing_whitespace_p
P_ ((int));
856 static int message_log_check_duplicate
P_ ((int, int, int, int));
857 static void push_it
P_ ((struct it
*));
858 static void pop_it
P_ ((struct it
*));
859 static void sync_frame_with_window_matrix_rows
P_ ((struct window
*));
860 static void select_frame_for_redisplay
P_ ((Lisp_Object
));
861 static void redisplay_internal
P_ ((int));
862 static int echo_area_display
P_ ((int));
863 static void redisplay_windows
P_ ((Lisp_Object
));
864 static void redisplay_window
P_ ((Lisp_Object
, int));
865 static Lisp_Object
redisplay_window_error ();
866 static Lisp_Object redisplay_window_0
P_ ((Lisp_Object
));
867 static Lisp_Object redisplay_window_1
P_ ((Lisp_Object
));
868 static void update_menu_bar
P_ ((struct frame
*, int));
869 static int try_window_reusing_current_matrix
P_ ((struct window
*));
870 static int try_window_id
P_ ((struct window
*));
871 static int display_line
P_ ((struct it
*));
872 static int display_mode_lines
P_ ((struct window
*));
873 static int display_mode_line
P_ ((struct window
*, enum face_id
, Lisp_Object
));
874 static int display_mode_element
P_ ((struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int));
875 static int store_mode_line_string
P_ ((char *, Lisp_Object
, int, int, int, Lisp_Object
));
876 static char *decode_mode_spec
P_ ((struct window
*, int, int, int, int *));
877 static void display_menu_bar
P_ ((struct window
*));
878 static int display_count_lines
P_ ((int, int, int, int, int *));
879 static int display_string
P_ ((unsigned char *, Lisp_Object
, Lisp_Object
,
880 int, int, struct it
*, int, int, int, int));
881 static void compute_line_metrics
P_ ((struct it
*));
882 static void run_redisplay_end_trigger_hook
P_ ((struct it
*));
883 static int get_overlay_strings
P_ ((struct it
*, int));
884 static void next_overlay_string
P_ ((struct it
*));
885 static void reseat
P_ ((struct it
*, struct text_pos
, int));
886 static void reseat_1
P_ ((struct it
*, struct text_pos
, int));
887 static void back_to_previous_visible_line_start
P_ ((struct it
*));
888 static void reseat_at_previous_visible_line_start
P_ ((struct it
*));
889 static void reseat_at_next_visible_line_start
P_ ((struct it
*, int));
890 static int next_element_from_display_vector
P_ ((struct it
*));
891 static int next_element_from_string
P_ ((struct it
*));
892 static int next_element_from_c_string
P_ ((struct it
*));
893 static int next_element_from_buffer
P_ ((struct it
*));
894 static int next_element_from_composition
P_ ((struct it
*));
895 static int next_element_from_image
P_ ((struct it
*));
896 static int next_element_from_stretch
P_ ((struct it
*));
897 static void load_overlay_strings
P_ ((struct it
*, int));
898 static int init_from_display_pos
P_ ((struct it
*, struct window
*,
899 struct display_pos
*));
900 static void reseat_to_string
P_ ((struct it
*, unsigned char *,
901 Lisp_Object
, int, int, int, int));
902 static enum move_it_result move_it_in_display_line_to
P_ ((struct it
*,
904 void move_it_vertically_backward
P_ ((struct it
*, int));
905 static void init_to_row_start
P_ ((struct it
*, struct window
*,
906 struct glyph_row
*));
907 static int init_to_row_end
P_ ((struct it
*, struct window
*,
908 struct glyph_row
*));
909 static void back_to_previous_line_start
P_ ((struct it
*));
910 static int forward_to_next_line_start
P_ ((struct it
*, int *));
911 static struct text_pos string_pos_nchars_ahead
P_ ((struct text_pos
,
913 static struct text_pos string_pos
P_ ((int, Lisp_Object
));
914 static struct text_pos c_string_pos
P_ ((int, unsigned char *, int));
915 static int number_of_chars
P_ ((unsigned char *, int));
916 static void compute_stop_pos
P_ ((struct it
*));
917 static void compute_string_pos
P_ ((struct text_pos
*, struct text_pos
,
919 static int face_before_or_after_it_pos
P_ ((struct it
*, int));
920 static int next_overlay_change
P_ ((int));
921 static int handle_single_display_prop
P_ ((struct it
*, Lisp_Object
,
922 Lisp_Object
, struct text_pos
*,
924 static int underlying_face_id
P_ ((struct it
*));
925 static int in_ellipses_for_invisible_text_p
P_ ((struct display_pos
*,
928 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
929 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
931 #ifdef HAVE_WINDOW_SYSTEM
933 static void update_tool_bar
P_ ((struct frame
*, int));
934 static void build_desired_tool_bar_string
P_ ((struct frame
*f
));
935 static int redisplay_tool_bar
P_ ((struct frame
*));
936 static void display_tool_bar_line
P_ ((struct it
*));
937 static void notice_overwritten_cursor
P_ ((struct window
*,
939 int, int, int, int));
943 #endif /* HAVE_WINDOW_SYSTEM */
946 /***********************************************************************
947 Window display dimensions
948 ***********************************************************************/
950 /* Return the bottom boundary y-position for text lines in window W.
951 This is the first y position at which a line cannot start.
952 It is relative to the top of the window.
954 This is the height of W minus the height of a mode line, if any. */
957 window_text_bottom_y (w
)
960 int height
= WINDOW_TOTAL_HEIGHT (w
);
962 if (WINDOW_WANTS_MODELINE_P (w
))
963 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
967 /* Return the pixel width of display area AREA of window W. AREA < 0
968 means return the total width of W, not including fringes to
969 the left and right of the window. */
972 window_box_width (w
, area
)
976 int cols
= XFASTINT (w
->total_cols
);
979 if (!w
->pseudo_window_p
)
981 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
983 if (area
== TEXT_AREA
)
985 if (INTEGERP (w
->left_margin_cols
))
986 cols
-= XFASTINT (w
->left_margin_cols
);
987 if (INTEGERP (w
->right_margin_cols
))
988 cols
-= XFASTINT (w
->right_margin_cols
);
989 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
991 else if (area
== LEFT_MARGIN_AREA
)
993 cols
= (INTEGERP (w
->left_margin_cols
)
994 ? XFASTINT (w
->left_margin_cols
) : 0);
997 else if (area
== RIGHT_MARGIN_AREA
)
999 cols
= (INTEGERP (w
->right_margin_cols
)
1000 ? XFASTINT (w
->right_margin_cols
) : 0);
1005 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1009 /* Return the pixel height of the display area of window W, not
1010 including mode lines of W, if any. */
1013 window_box_height (w
)
1016 struct frame
*f
= XFRAME (w
->frame
);
1017 int height
= WINDOW_TOTAL_HEIGHT (w
);
1019 xassert (height
>= 0);
1021 /* Note: the code below that determines the mode-line/header-line
1022 height is essentially the same as that contained in the macro
1023 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1024 the appropriate glyph row has its `mode_line_p' flag set,
1025 and if it doesn't, uses estimate_mode_line_height instead. */
1027 if (WINDOW_WANTS_MODELINE_P (w
))
1029 struct glyph_row
*ml_row
1030 = (w
->current_matrix
&& w
->current_matrix
->rows
1031 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1033 if (ml_row
&& ml_row
->mode_line_p
)
1034 height
-= ml_row
->height
;
1036 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1039 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1041 struct glyph_row
*hl_row
1042 = (w
->current_matrix
&& w
->current_matrix
->rows
1043 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1045 if (hl_row
&& hl_row
->mode_line_p
)
1046 height
-= hl_row
->height
;
1048 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1051 /* With a very small font and a mode-line that's taller than
1052 default, we might end up with a negative height. */
1053 return max (0, height
);
1056 /* Return the window-relative coordinate of the left edge of display
1057 area AREA of window W. AREA < 0 means return the left edge of the
1058 whole window, to the right of the left fringe of W. */
1061 window_box_left_offset (w
, area
)
1067 if (w
->pseudo_window_p
)
1070 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1072 if (area
== TEXT_AREA
)
1073 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1074 + window_box_width (w
, LEFT_MARGIN_AREA
));
1075 else if (area
== RIGHT_MARGIN_AREA
)
1076 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1077 + window_box_width (w
, LEFT_MARGIN_AREA
)
1078 + window_box_width (w
, TEXT_AREA
)
1079 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1081 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1082 else if (area
== LEFT_MARGIN_AREA
1083 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1084 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1090 /* Return the window-relative coordinate of the right edge of display
1091 area AREA of window W. AREA < 0 means return the left edge of the
1092 whole window, to the left of the right fringe of W. */
1095 window_box_right_offset (w
, area
)
1099 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1102 /* Return the frame-relative coordinate of the left edge of display
1103 area AREA of window W. AREA < 0 means return the left edge of the
1104 whole window, to the right of the left fringe of W. */
1107 window_box_left (w
, area
)
1111 struct frame
*f
= XFRAME (w
->frame
);
1114 if (w
->pseudo_window_p
)
1115 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1117 x
= (WINDOW_LEFT_EDGE_X (w
)
1118 + window_box_left_offset (w
, area
));
1124 /* Return the frame-relative coordinate of the right edge of display
1125 area AREA of window W. AREA < 0 means return the left edge of the
1126 whole window, to the left of the right fringe of W. */
1129 window_box_right (w
, area
)
1133 return window_box_left (w
, area
) + window_box_width (w
, area
);
1136 /* Get the bounding box of the display area AREA of window W, without
1137 mode lines, in frame-relative coordinates. AREA < 0 means the
1138 whole window, not including the left and right fringes of
1139 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1140 coordinates of the upper-left corner of the box. Return in
1141 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1144 window_box (w
, area
, box_x
, box_y
, box_width
, box_height
)
1147 int *box_x
, *box_y
, *box_width
, *box_height
;
1150 *box_width
= window_box_width (w
, area
);
1152 *box_height
= window_box_height (w
);
1154 *box_x
= window_box_left (w
, area
);
1157 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1158 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1159 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1164 /* Get the bounding box of the display area AREA of window W, without
1165 mode lines. AREA < 0 means the whole window, not including the
1166 left and right fringe of the window. Return in *TOP_LEFT_X
1167 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1168 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1169 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1173 window_box_edges (w
, area
, top_left_x
, top_left_y
,
1174 bottom_right_x
, bottom_right_y
)
1177 int *top_left_x
, *top_left_y
, *bottom_right_x
, *bottom_right_y
;
1179 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1181 *bottom_right_x
+= *top_left_x
;
1182 *bottom_right_y
+= *top_left_y
;
1187 /***********************************************************************
1189 ***********************************************************************/
1191 /* Return the bottom y-position of the line the iterator IT is in.
1192 This can modify IT's settings. */
1198 int line_height
= it
->max_ascent
+ it
->max_descent
;
1199 int line_top_y
= it
->current_y
;
1201 if (line_height
== 0)
1204 line_height
= last_height
;
1205 else if (IT_CHARPOS (*it
) < ZV
)
1207 move_it_by_lines (it
, 1, 1);
1208 line_height
= (it
->max_ascent
|| it
->max_descent
1209 ? it
->max_ascent
+ it
->max_descent
1214 struct glyph_row
*row
= it
->glyph_row
;
1216 /* Use the default character height. */
1217 it
->glyph_row
= NULL
;
1218 it
->what
= IT_CHARACTER
;
1221 PRODUCE_GLYPHS (it
);
1222 line_height
= it
->ascent
+ it
->descent
;
1223 it
->glyph_row
= row
;
1227 return line_top_y
+ line_height
;
1231 /* Return 1 if position CHARPOS is visible in window W. Set *FULLY to
1232 1 if POS is visible and the line containing POS is fully visible.
1233 EXACT_MODE_LINE_HEIGHTS_P non-zero means compute exact mode-line
1234 and header-lines heights. */
1237 pos_visible_p (w
, charpos
, fully
, x
, y
, exact_mode_line_heights_p
)
1239 int charpos
, *fully
, *x
, *y
, exact_mode_line_heights_p
;
1242 struct text_pos top
;
1244 struct buffer
*old_buffer
= NULL
;
1246 if (XBUFFER (w
->buffer
) != current_buffer
)
1248 old_buffer
= current_buffer
;
1249 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1252 *fully
= visible_p
= 0;
1253 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1255 /* Compute exact mode line heights, if requested. */
1256 if (exact_mode_line_heights_p
)
1258 if (WINDOW_WANTS_MODELINE_P (w
))
1259 current_mode_line_height
1260 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1261 current_buffer
->mode_line_format
);
1263 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1264 current_header_line_height
1265 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1266 current_buffer
->header_line_format
);
1269 start_display (&it
, w
, top
);
1270 move_it_to (&it
, charpos
, 0, it
.last_visible_y
, -1,
1271 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
1273 /* Note that we may overshoot because of invisible text. */
1274 if (IT_CHARPOS (it
) >= charpos
)
1276 int top_y
= it
.current_y
;
1277 int bottom_y
= line_bottom_y (&it
);
1278 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1280 if (top_y
< window_top_y
)
1281 visible_p
= bottom_y
> window_top_y
;
1282 else if (top_y
< it
.last_visible_y
)
1285 *fully
= bottom_y
<= it
.last_visible_y
;
1290 *y
= max (top_y
+ it
.max_ascent
- it
.ascent
, window_top_y
);
1293 else if (it
.current_y
+ it
.max_ascent
+ it
.max_descent
> it
.last_visible_y
)
1298 move_it_by_lines (&it
, 1, 0);
1299 if (charpos
< IT_CHARPOS (it
))
1304 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1306 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1312 set_buffer_internal_1 (old_buffer
);
1314 current_header_line_height
= current_mode_line_height
= -1;
1320 /* Return the next character from STR which is MAXLEN bytes long.
1321 Return in *LEN the length of the character. This is like
1322 STRING_CHAR_AND_LENGTH but never returns an invalid character. If
1323 we find one, we return a `?', but with the length of the invalid
1327 string_char_and_length (str
, maxlen
, len
)
1328 const unsigned char *str
;
1333 c
= STRING_CHAR_AND_LENGTH (str
, maxlen
, *len
);
1334 if (!CHAR_VALID_P (c
, 1))
1335 /* We may not change the length here because other places in Emacs
1336 don't use this function, i.e. they silently accept invalid
1345 /* Given a position POS containing a valid character and byte position
1346 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1348 static struct text_pos
1349 string_pos_nchars_ahead (pos
, string
, nchars
)
1350 struct text_pos pos
;
1354 xassert (STRINGP (string
) && nchars
>= 0);
1356 if (STRING_MULTIBYTE (string
))
1358 int rest
= SBYTES (string
) - BYTEPOS (pos
);
1359 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1364 string_char_and_length (p
, rest
, &len
);
1365 p
+= len
, rest
-= len
;
1366 xassert (rest
>= 0);
1368 BYTEPOS (pos
) += len
;
1372 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1378 /* Value is the text position, i.e. character and byte position,
1379 for character position CHARPOS in STRING. */
1381 static INLINE
struct text_pos
1382 string_pos (charpos
, string
)
1386 struct text_pos pos
;
1387 xassert (STRINGP (string
));
1388 xassert (charpos
>= 0);
1389 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1394 /* Value is a text position, i.e. character and byte position, for
1395 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1396 means recognize multibyte characters. */
1398 static struct text_pos
1399 c_string_pos (charpos
, s
, multibyte_p
)
1404 struct text_pos pos
;
1406 xassert (s
!= NULL
);
1407 xassert (charpos
>= 0);
1411 int rest
= strlen (s
), len
;
1413 SET_TEXT_POS (pos
, 0, 0);
1416 string_char_and_length (s
, rest
, &len
);
1417 s
+= len
, rest
-= len
;
1418 xassert (rest
>= 0);
1420 BYTEPOS (pos
) += len
;
1424 SET_TEXT_POS (pos
, charpos
, charpos
);
1430 /* Value is the number of characters in C string S. MULTIBYTE_P
1431 non-zero means recognize multibyte characters. */
1434 number_of_chars (s
, multibyte_p
)
1442 int rest
= strlen (s
), len
;
1443 unsigned char *p
= (unsigned char *) s
;
1445 for (nchars
= 0; rest
> 0; ++nchars
)
1447 string_char_and_length (p
, rest
, &len
);
1448 rest
-= len
, p
+= len
;
1452 nchars
= strlen (s
);
1458 /* Compute byte position NEWPOS->bytepos corresponding to
1459 NEWPOS->charpos. POS is a known position in string STRING.
1460 NEWPOS->charpos must be >= POS.charpos. */
1463 compute_string_pos (newpos
, pos
, string
)
1464 struct text_pos
*newpos
, pos
;
1467 xassert (STRINGP (string
));
1468 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1470 if (STRING_MULTIBYTE (string
))
1471 *newpos
= string_pos_nchars_ahead (pos
, string
,
1472 CHARPOS (*newpos
) - CHARPOS (pos
));
1474 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1478 Return an estimation of the pixel height of mode or top lines on
1479 frame F. FACE_ID specifies what line's height to estimate. */
1482 estimate_mode_line_height (f
, face_id
)
1484 enum face_id face_id
;
1486 #ifdef HAVE_WINDOW_SYSTEM
1487 if (FRAME_WINDOW_P (f
))
1489 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1491 /* This function is called so early when Emacs starts that the face
1492 cache and mode line face are not yet initialized. */
1493 if (FRAME_FACE_CACHE (f
))
1495 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1499 height
= FONT_HEIGHT (face
->font
);
1500 if (face
->box_line_width
> 0)
1501 height
+= 2 * face
->box_line_width
;
1512 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1513 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1514 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1515 not force the value into range. */
1518 pixel_to_glyph_coords (f
, pix_x
, pix_y
, x
, y
, bounds
, noclip
)
1520 register int pix_x
, pix_y
;
1522 NativeRectangle
*bounds
;
1526 #ifdef HAVE_WINDOW_SYSTEM
1527 if (FRAME_WINDOW_P (f
))
1529 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1530 even for negative values. */
1532 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1534 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1536 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1537 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1540 STORE_NATIVE_RECT (*bounds
,
1541 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1542 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1543 FRAME_COLUMN_WIDTH (f
) - 1,
1544 FRAME_LINE_HEIGHT (f
) - 1);
1550 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1551 pix_x
= FRAME_TOTAL_COLS (f
);
1555 else if (pix_y
> FRAME_LINES (f
))
1556 pix_y
= FRAME_LINES (f
);
1566 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1567 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1568 can't tell the positions because W's display is not up to date,
1572 glyph_to_pixel_coords (w
, hpos
, vpos
, frame_x
, frame_y
)
1575 int *frame_x
, *frame_y
;
1577 #ifdef HAVE_WINDOW_SYSTEM
1578 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1582 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1583 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1585 if (display_completed
)
1587 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1588 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1589 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1595 hpos
+= glyph
->pixel_width
;
1599 /* If first glyph is partially visible, its first visible position is still 0. */
1611 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1612 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1623 #ifdef HAVE_WINDOW_SYSTEM
1625 /* Find the glyph under window-relative coordinates X/Y in window W.
1626 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1627 strings. Return in *HPOS and *VPOS the row and column number of
1628 the glyph found. Return in *AREA the glyph area containing X.
1629 Value is a pointer to the glyph found or null if X/Y is not on
1630 text, or we can't tell because W's current matrix is not up to
1633 static struct glyph
*
1634 x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, dx
, dy
, area
)
1637 int *hpos
, *vpos
, *dx
, *dy
, *area
;
1639 struct glyph
*glyph
, *end
;
1640 struct glyph_row
*row
= NULL
;
1643 /* Find row containing Y. Give up if some row is not enabled. */
1644 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1646 row
= MATRIX_ROW (w
->current_matrix
, i
);
1647 if (!row
->enabled_p
)
1649 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1656 /* Give up if Y is not in the window. */
1657 if (i
== w
->current_matrix
->nrows
)
1660 /* Get the glyph area containing X. */
1661 if (w
->pseudo_window_p
)
1668 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1670 *area
= LEFT_MARGIN_AREA
;
1671 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1673 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1676 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1680 *area
= RIGHT_MARGIN_AREA
;
1681 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1685 /* Find glyph containing X. */
1686 glyph
= row
->glyphs
[*area
];
1687 end
= glyph
+ row
->used
[*area
];
1689 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1691 x
-= glyph
->pixel_width
;
1701 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1704 *hpos
= glyph
- row
->glyphs
[*area
];
1710 Convert frame-relative x/y to coordinates relative to window W.
1711 Takes pseudo-windows into account. */
1714 frame_to_window_pixel_xy (w
, x
, y
)
1718 if (w
->pseudo_window_p
)
1720 /* A pseudo-window is always full-width, and starts at the
1721 left edge of the frame, plus a frame border. */
1722 struct frame
*f
= XFRAME (w
->frame
);
1723 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1724 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1728 *x
-= WINDOW_LEFT_EDGE_X (w
);
1729 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1734 Return in *R the clipping rectangle for glyph string S. */
1737 get_glyph_string_clip_rect (s
, nr
)
1738 struct glyph_string
*s
;
1739 NativeRectangle
*nr
;
1743 if (s
->row
->full_width_p
)
1745 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1746 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1747 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1749 /* Unless displaying a mode or menu bar line, which are always
1750 fully visible, clip to the visible part of the row. */
1751 if (s
->w
->pseudo_window_p
)
1752 r
.height
= s
->row
->visible_height
;
1754 r
.height
= s
->height
;
1758 /* This is a text line that may be partially visible. */
1759 r
.x
= window_box_left (s
->w
, s
->area
);
1760 r
.width
= window_box_width (s
->w
, s
->area
);
1761 r
.height
= s
->row
->visible_height
;
1764 /* If S draws overlapping rows, it's sufficient to use the top and
1765 bottom of the window for clipping because this glyph string
1766 intentionally draws over other lines. */
1767 if (s
->for_overlaps_p
)
1769 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1770 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1774 /* Don't use S->y for clipping because it doesn't take partially
1775 visible lines into account. For example, it can be negative for
1776 partially visible lines at the top of a window. */
1777 if (!s
->row
->full_width_p
1778 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1779 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1781 r
.y
= max (0, s
->row
->y
);
1783 /* If drawing a tool-bar window, draw it over the internal border
1784 at the top of the window. */
1785 if (s
->w
== XWINDOW (s
->f
->tool_bar_window
))
1786 r
.y
-= FRAME_INTERNAL_BORDER_WIDTH (s
->f
);
1789 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1791 /* If drawing the cursor, don't let glyph draw outside its
1792 advertised boundaries. Cleartype does this under some circumstances. */
1793 if (s
->hl
== DRAW_CURSOR
)
1795 struct glyph
*glyph
= s
->first_glyph
;
1800 r
.width
-= s
->x
- r
.x
;
1803 r
.width
= min (r
.width
, glyph
->pixel_width
);
1805 /* Don't draw cursor glyph taller than our actual glyph. */
1806 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1807 if (height
< r
.height
)
1809 int max_y
= r
.y
+ r
.height
;
1810 r
.y
= min (max_y
, s
->ybase
+ glyph
->descent
- height
);
1811 r
.height
= min (max_y
- r
.y
, height
);
1815 #ifdef CONVERT_FROM_XRECT
1816 CONVERT_FROM_XRECT (r
, *nr
);
1822 #endif /* HAVE_WINDOW_SYSTEM */
1825 /***********************************************************************
1826 Lisp form evaluation
1827 ***********************************************************************/
1829 /* Error handler for safe_eval and safe_call. */
1832 safe_eval_handler (arg
)
1835 add_to_log ("Error during redisplay: %s", arg
, Qnil
);
1840 /* Evaluate SEXPR and return the result, or nil if something went
1841 wrong. Prevent redisplay during the evaluation. */
1849 if (inhibit_eval_during_redisplay
)
1853 int count
= SPECPDL_INDEX ();
1854 struct gcpro gcpro1
;
1857 specbind (Qinhibit_redisplay
, Qt
);
1858 /* Use Qt to ensure debugger does not run,
1859 so there is no possibility of wanting to redisplay. */
1860 val
= internal_condition_case_1 (Feval
, sexpr
, Qt
,
1863 val
= unbind_to (count
, val
);
1870 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
1871 Return the result, or nil if something went wrong. Prevent
1872 redisplay during the evaluation. */
1875 safe_call (nargs
, args
)
1881 if (inhibit_eval_during_redisplay
)
1885 int count
= SPECPDL_INDEX ();
1886 struct gcpro gcpro1
;
1889 gcpro1
.nvars
= nargs
;
1890 specbind (Qinhibit_redisplay
, Qt
);
1891 /* Use Qt to ensure debugger does not run,
1892 so there is no possibility of wanting to redisplay. */
1893 val
= internal_condition_case_2 (Ffuncall
, nargs
, args
, Qt
,
1896 val
= unbind_to (count
, val
);
1903 /* Call function FN with one argument ARG.
1904 Return the result, or nil if something went wrong. */
1907 safe_call1 (fn
, arg
)
1908 Lisp_Object fn
, arg
;
1910 Lisp_Object args
[2];
1913 return safe_call (2, args
);
1918 /***********************************************************************
1920 ***********************************************************************/
1924 /* Define CHECK_IT to perform sanity checks on iterators.
1925 This is for debugging. It is too slow to do unconditionally. */
1931 if (it
->method
== next_element_from_string
)
1933 xassert (STRINGP (it
->string
));
1934 xassert (IT_STRING_CHARPOS (*it
) >= 0);
1938 xassert (IT_STRING_CHARPOS (*it
) < 0);
1939 if (it
->method
== next_element_from_buffer
)
1941 /* Check that character and byte positions agree. */
1942 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
1947 xassert (it
->current
.dpvec_index
>= 0);
1949 xassert (it
->current
.dpvec_index
< 0);
1952 #define CHECK_IT(IT) check_it ((IT))
1956 #define CHECK_IT(IT) (void) 0
1963 /* Check that the window end of window W is what we expect it
1964 to be---the last row in the current matrix displaying text. */
1967 check_window_end (w
)
1970 if (!MINI_WINDOW_P (w
)
1971 && !NILP (w
->window_end_valid
))
1973 struct glyph_row
*row
;
1974 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
1975 XFASTINT (w
->window_end_vpos
)),
1977 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
1978 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
1982 #define CHECK_WINDOW_END(W) check_window_end ((W))
1984 #else /* not GLYPH_DEBUG */
1986 #define CHECK_WINDOW_END(W) (void) 0
1988 #endif /* not GLYPH_DEBUG */
1992 /***********************************************************************
1993 Iterator initialization
1994 ***********************************************************************/
1996 /* Initialize IT for displaying current_buffer in window W, starting
1997 at character position CHARPOS. CHARPOS < 0 means that no buffer
1998 position is specified which is useful when the iterator is assigned
1999 a position later. BYTEPOS is the byte position corresponding to
2000 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2002 If ROW is not null, calls to produce_glyphs with IT as parameter
2003 will produce glyphs in that row.
2005 BASE_FACE_ID is the id of a base face to use. It must be one of
2006 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2007 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2008 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2010 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2011 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2012 will be initialized to use the corresponding mode line glyph row of
2013 the desired matrix of W. */
2016 init_iterator (it
, w
, charpos
, bytepos
, row
, base_face_id
)
2019 int charpos
, bytepos
;
2020 struct glyph_row
*row
;
2021 enum face_id base_face_id
;
2023 int highlight_region_p
;
2025 /* Some precondition checks. */
2026 xassert (w
!= NULL
&& it
!= NULL
);
2027 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2030 /* If face attributes have been changed since the last redisplay,
2031 free realized faces now because they depend on face definitions
2032 that might have changed. Don't free faces while there might be
2033 desired matrices pending which reference these faces. */
2034 if (face_change_count
&& !inhibit_free_realized_faces
)
2036 face_change_count
= 0;
2037 free_all_realized_faces (Qnil
);
2040 /* Use one of the mode line rows of W's desired matrix if
2044 if (base_face_id
== MODE_LINE_FACE_ID
2045 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2046 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2047 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2048 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2052 bzero (it
, sizeof *it
);
2053 it
->current
.overlay_string_index
= -1;
2054 it
->current
.dpvec_index
= -1;
2055 it
->base_face_id
= base_face_id
;
2057 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2059 /* The window in which we iterate over current_buffer: */
2060 XSETWINDOW (it
->window
, w
);
2062 it
->f
= XFRAME (w
->frame
);
2064 /* Extra space between lines (on window systems only). */
2065 if (base_face_id
== DEFAULT_FACE_ID
2066 && FRAME_WINDOW_P (it
->f
))
2068 if (NATNUMP (current_buffer
->extra_line_spacing
))
2069 it
->extra_line_spacing
= XFASTINT (current_buffer
->extra_line_spacing
);
2070 else if (FLOATP (current_buffer
->extra_line_spacing
))
2071 it
->extra_line_spacing
= (XFLOAT_DATA (current_buffer
->extra_line_spacing
)
2072 * FRAME_LINE_HEIGHT (it
->f
));
2073 else if (it
->f
->extra_line_spacing
> 0)
2074 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2077 /* If realized faces have been removed, e.g. because of face
2078 attribute changes of named faces, recompute them. When running
2079 in batch mode, the face cache of Vterminal_frame is null. If
2080 we happen to get called, make a dummy face cache. */
2081 if (noninteractive
&& FRAME_FACE_CACHE (it
->f
) == NULL
)
2082 init_frame_faces (it
->f
);
2083 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2084 recompute_basic_faces (it
->f
);
2086 /* Current value of the `slice', `space-width', and 'height' properties. */
2087 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2088 it
->space_width
= Qnil
;
2089 it
->font_height
= Qnil
;
2090 it
->override_ascent
= -1;
2092 /* Are control characters displayed as `^C'? */
2093 it
->ctl_arrow_p
= !NILP (current_buffer
->ctl_arrow
);
2095 /* -1 means everything between a CR and the following line end
2096 is invisible. >0 means lines indented more than this value are
2098 it
->selective
= (INTEGERP (current_buffer
->selective_display
)
2099 ? XFASTINT (current_buffer
->selective_display
)
2100 : (!NILP (current_buffer
->selective_display
)
2102 it
->selective_display_ellipsis_p
2103 = !NILP (current_buffer
->selective_display_ellipses
);
2105 /* Display table to use. */
2106 it
->dp
= window_display_table (w
);
2108 /* Are multibyte characters enabled in current_buffer? */
2109 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
2111 /* Non-zero if we should highlight the region. */
2113 = (!NILP (Vtransient_mark_mode
)
2114 && !NILP (current_buffer
->mark_active
)
2115 && XMARKER (current_buffer
->mark
)->buffer
!= 0);
2117 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2118 start and end of a visible region in window IT->w. Set both to
2119 -1 to indicate no region. */
2120 if (highlight_region_p
2121 /* Maybe highlight only in selected window. */
2122 && (/* Either show region everywhere. */
2123 highlight_nonselected_windows
2124 /* Or show region in the selected window. */
2125 || w
== XWINDOW (selected_window
)
2126 /* Or show the region if we are in the mini-buffer and W is
2127 the window the mini-buffer refers to. */
2128 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2129 && WINDOWP (minibuf_selected_window
)
2130 && w
== XWINDOW (minibuf_selected_window
))))
2132 int charpos
= marker_position (current_buffer
->mark
);
2133 it
->region_beg_charpos
= min (PT
, charpos
);
2134 it
->region_end_charpos
= max (PT
, charpos
);
2137 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2139 /* Get the position at which the redisplay_end_trigger hook should
2140 be run, if it is to be run at all. */
2141 if (MARKERP (w
->redisplay_end_trigger
)
2142 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2143 it
->redisplay_end_trigger_charpos
2144 = marker_position (w
->redisplay_end_trigger
);
2145 else if (INTEGERP (w
->redisplay_end_trigger
))
2146 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2148 /* Correct bogus values of tab_width. */
2149 it
->tab_width
= XINT (current_buffer
->tab_width
);
2150 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2153 /* Are lines in the display truncated? */
2154 it
->truncate_lines_p
2155 = (base_face_id
!= DEFAULT_FACE_ID
2156 || XINT (it
->w
->hscroll
)
2157 || (truncate_partial_width_windows
2158 && !WINDOW_FULL_WIDTH_P (it
->w
))
2159 || !NILP (current_buffer
->truncate_lines
));
2161 /* Get dimensions of truncation and continuation glyphs. These are
2162 displayed as fringe bitmaps under X, so we don't need them for such
2164 if (!FRAME_WINDOW_P (it
->f
))
2166 if (it
->truncate_lines_p
)
2168 /* We will need the truncation glyph. */
2169 xassert (it
->glyph_row
== NULL
);
2170 produce_special_glyphs (it
, IT_TRUNCATION
);
2171 it
->truncation_pixel_width
= it
->pixel_width
;
2175 /* We will need the continuation glyph. */
2176 xassert (it
->glyph_row
== NULL
);
2177 produce_special_glyphs (it
, IT_CONTINUATION
);
2178 it
->continuation_pixel_width
= it
->pixel_width
;
2181 /* Reset these values to zero because the produce_special_glyphs
2182 above has changed them. */
2183 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2184 it
->phys_ascent
= it
->phys_descent
= 0;
2187 /* Set this after getting the dimensions of truncation and
2188 continuation glyphs, so that we don't produce glyphs when calling
2189 produce_special_glyphs, above. */
2190 it
->glyph_row
= row
;
2191 it
->area
= TEXT_AREA
;
2193 /* Get the dimensions of the display area. The display area
2194 consists of the visible window area plus a horizontally scrolled
2195 part to the left of the window. All x-values are relative to the
2196 start of this total display area. */
2197 if (base_face_id
!= DEFAULT_FACE_ID
)
2199 /* Mode lines, menu bar in terminal frames. */
2200 it
->first_visible_x
= 0;
2201 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2206 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2207 it
->last_visible_x
= (it
->first_visible_x
2208 + window_box_width (w
, TEXT_AREA
));
2210 /* If we truncate lines, leave room for the truncator glyph(s) at
2211 the right margin. Otherwise, leave room for the continuation
2212 glyph(s). Truncation and continuation glyphs are not inserted
2213 for window-based redisplay. */
2214 if (!FRAME_WINDOW_P (it
->f
))
2216 if (it
->truncate_lines_p
)
2217 it
->last_visible_x
-= it
->truncation_pixel_width
;
2219 it
->last_visible_x
-= it
->continuation_pixel_width
;
2222 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2223 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2226 /* Leave room for a border glyph. */
2227 if (!FRAME_WINDOW_P (it
->f
)
2228 && !WINDOW_RIGHTMOST_P (it
->w
))
2229 it
->last_visible_x
-= 1;
2231 it
->last_visible_y
= window_text_bottom_y (w
);
2233 /* For mode lines and alike, arrange for the first glyph having a
2234 left box line if the face specifies a box. */
2235 if (base_face_id
!= DEFAULT_FACE_ID
)
2239 it
->face_id
= base_face_id
;
2241 /* If we have a boxed mode line, make the first character appear
2242 with a left box line. */
2243 face
= FACE_FROM_ID (it
->f
, base_face_id
);
2244 if (face
->box
!= FACE_NO_BOX
)
2245 it
->start_of_box_run_p
= 1;
2248 /* If a buffer position was specified, set the iterator there,
2249 getting overlays and face properties from that position. */
2250 if (charpos
>= BUF_BEG (current_buffer
))
2252 it
->end_charpos
= ZV
;
2254 IT_CHARPOS (*it
) = charpos
;
2256 /* Compute byte position if not specified. */
2257 if (bytepos
< charpos
)
2258 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2260 IT_BYTEPOS (*it
) = bytepos
;
2262 it
->start
= it
->current
;
2264 /* Compute faces etc. */
2265 reseat (it
, it
->current
.pos
, 1);
2272 /* Initialize IT for the display of window W with window start POS. */
2275 start_display (it
, w
, pos
)
2278 struct text_pos pos
;
2280 struct glyph_row
*row
;
2281 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2283 row
= w
->desired_matrix
->rows
+ first_vpos
;
2284 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2285 it
->first_vpos
= first_vpos
;
2287 if (!it
->truncate_lines_p
)
2289 int start_at_line_beg_p
;
2290 int first_y
= it
->current_y
;
2292 /* If window start is not at a line start, skip forward to POS to
2293 get the correct continuation lines width. */
2294 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2295 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2296 if (!start_at_line_beg_p
)
2300 reseat_at_previous_visible_line_start (it
);
2301 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2303 new_x
= it
->current_x
+ it
->pixel_width
;
2305 /* If lines are continued, this line may end in the middle
2306 of a multi-glyph character (e.g. a control character
2307 displayed as \003, or in the middle of an overlay
2308 string). In this case move_it_to above will not have
2309 taken us to the start of the continuation line but to the
2310 end of the continued line. */
2311 if (it
->current_x
> 0
2312 && !it
->truncate_lines_p
/* Lines are continued. */
2313 && (/* And glyph doesn't fit on the line. */
2314 new_x
> it
->last_visible_x
2315 /* Or it fits exactly and we're on a window
2317 || (new_x
== it
->last_visible_x
2318 && FRAME_WINDOW_P (it
->f
))))
2320 if (it
->current
.dpvec_index
>= 0
2321 || it
->current
.overlay_string_index
>= 0)
2323 set_iterator_to_next (it
, 1);
2324 move_it_in_display_line_to (it
, -1, -1, 0);
2327 it
->continuation_lines_width
+= it
->current_x
;
2330 /* We're starting a new display line, not affected by the
2331 height of the continued line, so clear the appropriate
2332 fields in the iterator structure. */
2333 it
->max_ascent
= it
->max_descent
= 0;
2334 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2336 it
->current_y
= first_y
;
2338 it
->current_x
= it
->hpos
= 0;
2342 #if 0 /* Don't assert the following because start_display is sometimes
2343 called intentionally with a window start that is not at a
2344 line start. Please leave this code in as a comment. */
2346 /* Window start should be on a line start, now. */
2347 xassert (it
->continuation_lines_width
2348 || IT_CHARPOS (it
) == BEGV
2349 || FETCH_BYTE (IT_BYTEPOS (it
) - 1) == '\n');
2354 /* Return 1 if POS is a position in ellipses displayed for invisible
2355 text. W is the window we display, for text property lookup. */
2358 in_ellipses_for_invisible_text_p (pos
, w
)
2359 struct display_pos
*pos
;
2362 Lisp_Object prop
, window
;
2364 int charpos
= CHARPOS (pos
->pos
);
2366 /* If POS specifies a position in a display vector, this might
2367 be for an ellipsis displayed for invisible text. We won't
2368 get the iterator set up for delivering that ellipsis unless
2369 we make sure that it gets aware of the invisible text. */
2370 if (pos
->dpvec_index
>= 0
2371 && pos
->overlay_string_index
< 0
2372 && CHARPOS (pos
->string_pos
) < 0
2374 && (XSETWINDOW (window
, w
),
2375 prop
= Fget_char_property (make_number (charpos
),
2376 Qinvisible
, window
),
2377 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2379 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2381 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2388 /* Initialize IT for stepping through current_buffer in window W,
2389 starting at position POS that includes overlay string and display
2390 vector/ control character translation position information. Value
2391 is zero if there are overlay strings with newlines at POS. */
2394 init_from_display_pos (it
, w
, pos
)
2397 struct display_pos
*pos
;
2399 int charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2400 int i
, overlay_strings_with_newlines
= 0;
2402 /* If POS specifies a position in a display vector, this might
2403 be for an ellipsis displayed for invisible text. We won't
2404 get the iterator set up for delivering that ellipsis unless
2405 we make sure that it gets aware of the invisible text. */
2406 if (in_ellipses_for_invisible_text_p (pos
, w
))
2412 /* Keep in mind: the call to reseat in init_iterator skips invisible
2413 text, so we might end up at a position different from POS. This
2414 is only a problem when POS is a row start after a newline and an
2415 overlay starts there with an after-string, and the overlay has an
2416 invisible property. Since we don't skip invisible text in
2417 display_line and elsewhere immediately after consuming the
2418 newline before the row start, such a POS will not be in a string,
2419 but the call to init_iterator below will move us to the
2421 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2423 for (i
= 0; i
< it
->n_overlay_strings
; ++i
)
2425 const char *s
= SDATA (it
->overlay_strings
[i
]);
2426 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2428 while (s
< e
&& *s
!= '\n')
2433 overlay_strings_with_newlines
= 1;
2438 /* If position is within an overlay string, set up IT to the right
2440 if (pos
->overlay_string_index
>= 0)
2444 /* If the first overlay string happens to have a `display'
2445 property for an image, the iterator will be set up for that
2446 image, and we have to undo that setup first before we can
2447 correct the overlay string index. */
2448 if (it
->method
== next_element_from_image
)
2451 /* We already have the first chunk of overlay strings in
2452 IT->overlay_strings. Load more until the one for
2453 pos->overlay_string_index is in IT->overlay_strings. */
2454 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2456 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2457 it
->current
.overlay_string_index
= 0;
2460 load_overlay_strings (it
, 0);
2461 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2465 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2466 relative_index
= (it
->current
.overlay_string_index
2467 % OVERLAY_STRING_CHUNK_SIZE
);
2468 it
->string
= it
->overlay_strings
[relative_index
];
2469 xassert (STRINGP (it
->string
));
2470 it
->current
.string_pos
= pos
->string_pos
;
2471 it
->method
= next_element_from_string
;
2474 #if 0 /* This is bogus because POS not having an overlay string
2475 position does not mean it's after the string. Example: A
2476 line starting with a before-string and initialization of IT
2477 to the previous row's end position. */
2478 else if (it
->current
.overlay_string_index
>= 0)
2480 /* If POS says we're already after an overlay string ending at
2481 POS, make sure to pop the iterator because it will be in
2482 front of that overlay string. When POS is ZV, we've thereby
2483 also ``processed'' overlay strings at ZV. */
2486 it
->current
.overlay_string_index
= -1;
2487 it
->method
= next_element_from_buffer
;
2488 if (CHARPOS (pos
->pos
) == ZV
)
2489 it
->overlay_strings_at_end_processed_p
= 1;
2493 if (CHARPOS (pos
->string_pos
) >= 0)
2495 /* Recorded position is not in an overlay string, but in another
2496 string. This can only be a string from a `display' property.
2497 IT should already be filled with that string. */
2498 it
->current
.string_pos
= pos
->string_pos
;
2499 xassert (STRINGP (it
->string
));
2502 /* Restore position in display vector translations, control
2503 character translations or ellipses. */
2504 if (pos
->dpvec_index
>= 0)
2506 if (it
->dpvec
== NULL
)
2507 get_next_display_element (it
);
2508 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2509 it
->current
.dpvec_index
= pos
->dpvec_index
;
2513 return !overlay_strings_with_newlines
;
2517 /* Initialize IT for stepping through current_buffer in window W
2518 starting at ROW->start. */
2521 init_to_row_start (it
, w
, row
)
2524 struct glyph_row
*row
;
2526 init_from_display_pos (it
, w
, &row
->start
);
2527 it
->start
= row
->start
;
2528 it
->continuation_lines_width
= row
->continuation_lines_width
;
2533 /* Initialize IT for stepping through current_buffer in window W
2534 starting in the line following ROW, i.e. starting at ROW->end.
2535 Value is zero if there are overlay strings with newlines at ROW's
2539 init_to_row_end (it
, w
, row
)
2542 struct glyph_row
*row
;
2546 if (init_from_display_pos (it
, w
, &row
->end
))
2548 if (row
->continued_p
)
2549 it
->continuation_lines_width
2550 = row
->continuation_lines_width
+ row
->pixel_width
;
2561 /***********************************************************************
2563 ***********************************************************************/
2565 /* Called when IT reaches IT->stop_charpos. Handle text property and
2566 overlay changes. Set IT->stop_charpos to the next position where
2573 enum prop_handled handled
;
2574 int handle_overlay_change_p
= 1;
2578 it
->current
.dpvec_index
= -1;
2582 handled
= HANDLED_NORMALLY
;
2584 /* Call text property handlers. */
2585 for (p
= it_props
; p
->handler
; ++p
)
2587 handled
= p
->handler (it
);
2589 if (handled
== HANDLED_RECOMPUTE_PROPS
)
2591 else if (handled
== HANDLED_RETURN
)
2593 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
2594 handle_overlay_change_p
= 0;
2597 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
2599 /* Don't check for overlay strings below when set to deliver
2600 characters from a display vector. */
2601 if (it
->method
== next_element_from_display_vector
)
2602 handle_overlay_change_p
= 0;
2604 /* Handle overlay changes. */
2605 if (handle_overlay_change_p
)
2606 handled
= handle_overlay_change (it
);
2608 /* Determine where to stop next. */
2609 if (handled
== HANDLED_NORMALLY
)
2610 compute_stop_pos (it
);
2613 while (handled
== HANDLED_RECOMPUTE_PROPS
);
2617 /* Compute IT->stop_charpos from text property and overlay change
2618 information for IT's current position. */
2621 compute_stop_pos (it
)
2624 register INTERVAL iv
, next_iv
;
2625 Lisp_Object object
, limit
, position
;
2627 /* If nowhere else, stop at the end. */
2628 it
->stop_charpos
= it
->end_charpos
;
2630 if (STRINGP (it
->string
))
2632 /* Strings are usually short, so don't limit the search for
2634 object
= it
->string
;
2636 position
= make_number (IT_STRING_CHARPOS (*it
));
2642 /* If next overlay change is in front of the current stop pos
2643 (which is IT->end_charpos), stop there. Note: value of
2644 next_overlay_change is point-max if no overlay change
2646 charpos
= next_overlay_change (IT_CHARPOS (*it
));
2647 if (charpos
< it
->stop_charpos
)
2648 it
->stop_charpos
= charpos
;
2650 /* If showing the region, we have to stop at the region
2651 start or end because the face might change there. */
2652 if (it
->region_beg_charpos
> 0)
2654 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
2655 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
2656 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
2657 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
2660 /* Set up variables for computing the stop position from text
2661 property changes. */
2662 XSETBUFFER (object
, current_buffer
);
2663 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
2664 position
= make_number (IT_CHARPOS (*it
));
2668 /* Get the interval containing IT's position. Value is a null
2669 interval if there isn't such an interval. */
2670 iv
= validate_interval_range (object
, &position
, &position
, 0);
2671 if (!NULL_INTERVAL_P (iv
))
2673 Lisp_Object values_here
[LAST_PROP_IDX
];
2676 /* Get properties here. */
2677 for (p
= it_props
; p
->handler
; ++p
)
2678 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
2680 /* Look for an interval following iv that has different
2682 for (next_iv
= next_interval (iv
);
2683 (!NULL_INTERVAL_P (next_iv
)
2685 || XFASTINT (limit
) > next_iv
->position
));
2686 next_iv
= next_interval (next_iv
))
2688 for (p
= it_props
; p
->handler
; ++p
)
2690 Lisp_Object new_value
;
2692 new_value
= textget (next_iv
->plist
, *p
->name
);
2693 if (!EQ (values_here
[p
->idx
], new_value
))
2701 if (!NULL_INTERVAL_P (next_iv
))
2703 if (INTEGERP (limit
)
2704 && next_iv
->position
>= XFASTINT (limit
))
2705 /* No text property change up to limit. */
2706 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
2708 /* Text properties change in next_iv. */
2709 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
2713 xassert (STRINGP (it
->string
)
2714 || (it
->stop_charpos
>= BEGV
2715 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
2719 /* Return the position of the next overlay change after POS in
2720 current_buffer. Value is point-max if no overlay change
2721 follows. This is like `next-overlay-change' but doesn't use
2725 next_overlay_change (pos
)
2730 Lisp_Object
*overlays
;
2733 /* Get all overlays at the given position. */
2734 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
2736 /* If any of these overlays ends before endpos,
2737 use its ending point instead. */
2738 for (i
= 0; i
< noverlays
; ++i
)
2743 oend
= OVERLAY_END (overlays
[i
]);
2744 oendpos
= OVERLAY_POSITION (oend
);
2745 endpos
= min (endpos
, oendpos
);
2753 /***********************************************************************
2755 ***********************************************************************/
2757 /* Handle changes in the `fontified' property of the current buffer by
2758 calling hook functions from Qfontification_functions to fontify
2761 static enum prop_handled
2762 handle_fontified_prop (it
)
2765 Lisp_Object prop
, pos
;
2766 enum prop_handled handled
= HANDLED_NORMALLY
;
2768 /* Get the value of the `fontified' property at IT's current buffer
2769 position. (The `fontified' property doesn't have a special
2770 meaning in strings.) If the value is nil, call functions from
2771 Qfontification_functions. */
2772 if (!STRINGP (it
->string
)
2774 && !NILP (Vfontification_functions
)
2775 && !NILP (Vrun_hooks
)
2776 && (pos
= make_number (IT_CHARPOS (*it
)),
2777 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
2780 int count
= SPECPDL_INDEX ();
2783 val
= Vfontification_functions
;
2784 specbind (Qfontification_functions
, Qnil
);
2786 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
2787 safe_call1 (val
, pos
);
2790 Lisp_Object globals
, fn
;
2791 struct gcpro gcpro1
, gcpro2
;
2794 GCPRO2 (val
, globals
);
2796 for (; CONSP (val
); val
= XCDR (val
))
2802 /* A value of t indicates this hook has a local
2803 binding; it means to run the global binding too.
2804 In a global value, t should not occur. If it
2805 does, we must ignore it to avoid an endless
2807 for (globals
= Fdefault_value (Qfontification_functions
);
2809 globals
= XCDR (globals
))
2811 fn
= XCAR (globals
);
2813 safe_call1 (fn
, pos
);
2817 safe_call1 (fn
, pos
);
2823 unbind_to (count
, Qnil
);
2825 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
2826 something. This avoids an endless loop if they failed to
2827 fontify the text for which reason ever. */
2828 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
2829 handled
= HANDLED_RECOMPUTE_PROPS
;
2837 /***********************************************************************
2839 ***********************************************************************/
2841 /* Set up iterator IT from face properties at its current position.
2842 Called from handle_stop. */
2844 static enum prop_handled
2845 handle_face_prop (it
)
2848 int new_face_id
, next_stop
;
2850 if (!STRINGP (it
->string
))
2853 = face_at_buffer_position (it
->w
,
2855 it
->region_beg_charpos
,
2856 it
->region_end_charpos
,
2859 + TEXT_PROP_DISTANCE_LIMIT
),
2862 /* Is this a start of a run of characters with box face?
2863 Caveat: this can be called for a freshly initialized
2864 iterator; face_id is -1 in this case. We know that the new
2865 face will not change until limit, i.e. if the new face has a
2866 box, all characters up to limit will have one. But, as
2867 usual, we don't know whether limit is really the end. */
2868 if (new_face_id
!= it
->face_id
)
2870 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
2872 /* If new face has a box but old face has not, this is
2873 the start of a run of characters with box, i.e. it has
2874 a shadow on the left side. The value of face_id of the
2875 iterator will be -1 if this is the initial call that gets
2876 the face. In this case, we have to look in front of IT's
2877 position and see whether there is a face != new_face_id. */
2878 it
->start_of_box_run_p
2879 = (new_face
->box
!= FACE_NO_BOX
2880 && (it
->face_id
>= 0
2881 || IT_CHARPOS (*it
) == BEG
2882 || new_face_id
!= face_before_it_pos (it
)));
2883 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
2888 int base_face_id
, bufpos
;
2890 if (it
->current
.overlay_string_index
>= 0)
2891 bufpos
= IT_CHARPOS (*it
);
2895 /* For strings from a buffer, i.e. overlay strings or strings
2896 from a `display' property, use the face at IT's current
2897 buffer position as the base face to merge with, so that
2898 overlay strings appear in the same face as surrounding
2899 text, unless they specify their own faces. */
2900 base_face_id
= underlying_face_id (it
);
2902 new_face_id
= face_at_string_position (it
->w
,
2904 IT_STRING_CHARPOS (*it
),
2906 it
->region_beg_charpos
,
2907 it
->region_end_charpos
,
2911 #if 0 /* This shouldn't be neccessary. Let's check it. */
2912 /* If IT is used to display a mode line we would really like to
2913 use the mode line face instead of the frame's default face. */
2914 if (it
->glyph_row
== MATRIX_MODE_LINE_ROW (it
->w
->desired_matrix
)
2915 && new_face_id
== DEFAULT_FACE_ID
)
2916 new_face_id
= CURRENT_MODE_LINE_FACE_ID (it
->w
);
2919 /* Is this a start of a run of characters with box? Caveat:
2920 this can be called for a freshly allocated iterator; face_id
2921 is -1 is this case. We know that the new face will not
2922 change until the next check pos, i.e. if the new face has a
2923 box, all characters up to that position will have a
2924 box. But, as usual, we don't know whether that position
2925 is really the end. */
2926 if (new_face_id
!= it
->face_id
)
2928 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
2929 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
2931 /* If new face has a box but old face hasn't, this is the
2932 start of a run of characters with box, i.e. it has a
2933 shadow on the left side. */
2934 it
->start_of_box_run_p
2935 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
2936 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
2940 it
->face_id
= new_face_id
;
2941 return HANDLED_NORMALLY
;
2945 /* Return the ID of the face ``underlying'' IT's current position,
2946 which is in a string. If the iterator is associated with a
2947 buffer, return the face at IT's current buffer position.
2948 Otherwise, use the iterator's base_face_id. */
2951 underlying_face_id (it
)
2954 int face_id
= it
->base_face_id
, i
;
2956 xassert (STRINGP (it
->string
));
2958 for (i
= it
->sp
- 1; i
>= 0; --i
)
2959 if (NILP (it
->stack
[i
].string
))
2960 face_id
= it
->stack
[i
].face_id
;
2966 /* Compute the face one character before or after the current position
2967 of IT. BEFORE_P non-zero means get the face in front of IT's
2968 position. Value is the id of the face. */
2971 face_before_or_after_it_pos (it
, before_p
)
2976 int next_check_charpos
;
2977 struct text_pos pos
;
2979 xassert (it
->s
== NULL
);
2981 if (STRINGP (it
->string
))
2983 int bufpos
, base_face_id
;
2985 /* No face change past the end of the string (for the case
2986 we are padding with spaces). No face change before the
2988 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
2989 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
2992 /* Set pos to the position before or after IT's current position. */
2994 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
2996 /* For composition, we must check the character after the
2998 pos
= (it
->what
== IT_COMPOSITION
2999 ? string_pos (IT_STRING_CHARPOS (*it
) + it
->cmp_len
, it
->string
)
3000 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3002 if (it
->current
.overlay_string_index
>= 0)
3003 bufpos
= IT_CHARPOS (*it
);
3007 base_face_id
= underlying_face_id (it
);
3009 /* Get the face for ASCII, or unibyte. */
3010 face_id
= face_at_string_position (it
->w
,
3014 it
->region_beg_charpos
,
3015 it
->region_end_charpos
,
3016 &next_check_charpos
,
3019 /* Correct the face for charsets different from ASCII. Do it
3020 for the multibyte case only. The face returned above is
3021 suitable for unibyte text if IT->string is unibyte. */
3022 if (STRING_MULTIBYTE (it
->string
))
3024 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3025 int rest
= SBYTES (it
->string
) - BYTEPOS (pos
);
3027 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3029 c
= string_char_and_length (p
, rest
, &len
);
3030 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
);
3035 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3036 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3039 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3040 pos
= it
->current
.pos
;
3043 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3046 if (it
->what
== IT_COMPOSITION
)
3047 /* For composition, we must check the position after the
3049 pos
.charpos
+= it
->cmp_len
, pos
.bytepos
+= it
->len
;
3051 INC_TEXT_POS (pos
, it
->multibyte_p
);
3054 /* Determine face for CHARSET_ASCII, or unibyte. */
3055 face_id
= face_at_buffer_position (it
->w
,
3057 it
->region_beg_charpos
,
3058 it
->region_end_charpos
,
3059 &next_check_charpos
,
3062 /* Correct the face for charsets different from ASCII. Do it
3063 for the multibyte case only. The face returned above is
3064 suitable for unibyte text if current_buffer is unibyte. */
3065 if (it
->multibyte_p
)
3067 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3068 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3069 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
);
3078 /***********************************************************************
3080 ***********************************************************************/
3082 /* Set up iterator IT from invisible properties at its current
3083 position. Called from handle_stop. */
3085 static enum prop_handled
3086 handle_invisible_prop (it
)
3089 enum prop_handled handled
= HANDLED_NORMALLY
;
3091 if (STRINGP (it
->string
))
3093 extern Lisp_Object Qinvisible
;
3094 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3096 /* Get the value of the invisible text property at the
3097 current position. Value will be nil if there is no such
3099 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3100 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3103 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3105 handled
= HANDLED_RECOMPUTE_PROPS
;
3107 /* Get the position at which the next change of the
3108 invisible text property can be found in IT->string.
3109 Value will be nil if the property value is the same for
3110 all the rest of IT->string. */
3111 XSETINT (limit
, SCHARS (it
->string
));
3112 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3115 /* Text at current position is invisible. The next
3116 change in the property is at position end_charpos.
3117 Move IT's current position to that position. */
3118 if (INTEGERP (end_charpos
)
3119 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3121 struct text_pos old
;
3122 old
= it
->current
.string_pos
;
3123 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3124 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3128 /* The rest of the string is invisible. If this is an
3129 overlay string, proceed with the next overlay string
3130 or whatever comes and return a character from there. */
3131 if (it
->current
.overlay_string_index
>= 0)
3133 next_overlay_string (it
);
3134 /* Don't check for overlay strings when we just
3135 finished processing them. */
3136 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3140 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3141 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3148 int invis_p
, newpos
, next_stop
, start_charpos
;
3149 Lisp_Object pos
, prop
, overlay
;
3151 /* First of all, is there invisible text at this position? */
3152 start_charpos
= IT_CHARPOS (*it
);
3153 pos
= make_number (IT_CHARPOS (*it
));
3154 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3156 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3158 /* If we are on invisible text, skip over it. */
3159 if (invis_p
&& IT_CHARPOS (*it
) < it
->end_charpos
)
3161 /* Record whether we have to display an ellipsis for the
3163 int display_ellipsis_p
= invis_p
== 2;
3165 handled
= HANDLED_RECOMPUTE_PROPS
;
3167 /* Loop skipping over invisible text. The loop is left at
3168 ZV or with IT on the first char being visible again. */
3171 /* Try to skip some invisible text. Return value is the
3172 position reached which can be equal to IT's position
3173 if there is nothing invisible here. This skips both
3174 over invisible text properties and overlays with
3175 invisible property. */
3176 newpos
= skip_invisible (IT_CHARPOS (*it
),
3177 &next_stop
, ZV
, it
->window
);
3179 /* If we skipped nothing at all we weren't at invisible
3180 text in the first place. If everything to the end of
3181 the buffer was skipped, end the loop. */
3182 if (newpos
== IT_CHARPOS (*it
) || newpos
>= ZV
)
3186 /* We skipped some characters but not necessarily
3187 all there are. Check if we ended up on visible
3188 text. Fget_char_property returns the property of
3189 the char before the given position, i.e. if we
3190 get invis_p = 0, this means that the char at
3191 newpos is visible. */
3192 pos
= make_number (newpos
);
3193 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3194 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3197 /* If we ended up on invisible text, proceed to
3198 skip starting with next_stop. */
3200 IT_CHARPOS (*it
) = next_stop
;
3204 /* The position newpos is now either ZV or on visible text. */
3205 IT_CHARPOS (*it
) = newpos
;
3206 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3208 /* If there are before-strings at the start of invisible
3209 text, and the text is invisible because of a text
3210 property, arrange to show before-strings because 20.x did
3211 it that way. (If the text is invisible because of an
3212 overlay property instead of a text property, this is
3213 already handled in the overlay code.) */
3215 && get_overlay_strings (it
, start_charpos
))
3217 handled
= HANDLED_RECOMPUTE_PROPS
;
3218 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3220 else if (display_ellipsis_p
)
3221 setup_for_ellipsis (it
);
3229 /* Make iterator IT return `...' next. */
3232 setup_for_ellipsis (it
)
3236 && VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3238 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3239 it
->dpvec
= v
->contents
;
3240 it
->dpend
= v
->contents
+ v
->size
;
3244 /* Default `...'. */
3245 it
->dpvec
= default_invis_vector
;
3246 it
->dpend
= default_invis_vector
+ 3;
3249 /* The ellipsis display does not replace the display of the
3250 character at the new position. Indicate this by setting
3251 IT->dpvec_char_len to zero. */
3252 it
->dpvec_char_len
= 0;
3254 it
->current
.dpvec_index
= 0;
3255 it
->method
= next_element_from_display_vector
;
3260 /***********************************************************************
3262 ***********************************************************************/
3264 /* Set up iterator IT from `display' property at its current position.
3265 Called from handle_stop. */
3267 static enum prop_handled
3268 handle_display_prop (it
)
3271 Lisp_Object prop
, object
;
3272 struct text_pos
*position
;
3273 int display_replaced_p
= 0;
3275 if (STRINGP (it
->string
))
3277 object
= it
->string
;
3278 position
= &it
->current
.string_pos
;
3282 object
= it
->w
->buffer
;
3283 position
= &it
->current
.pos
;
3286 /* Reset those iterator values set from display property values. */
3287 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3288 it
->space_width
= Qnil
;
3289 it
->font_height
= Qnil
;
3292 /* We don't support recursive `display' properties, i.e. string
3293 values that have a string `display' property, that have a string
3294 `display' property etc. */
3295 if (!it
->string_from_display_prop_p
)
3296 it
->area
= TEXT_AREA
;
3298 prop
= Fget_char_property (make_number (position
->charpos
),
3301 return HANDLED_NORMALLY
;
3304 /* Simple properties. */
3305 && !EQ (XCAR (prop
), Qimage
)
3306 && !EQ (XCAR (prop
), Qspace
)
3307 && !EQ (XCAR (prop
), Qwhen
)
3308 && !EQ (XCAR (prop
), Qslice
)
3309 && !EQ (XCAR (prop
), Qspace_width
)
3310 && !EQ (XCAR (prop
), Qheight
)
3311 && !EQ (XCAR (prop
), Qraise
)
3312 /* Marginal area specifications. */
3313 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3314 && !EQ (XCAR (prop
), Qleft_fringe
)
3315 && !EQ (XCAR (prop
), Qright_fringe
)
3316 && !NILP (XCAR (prop
)))
3318 for (; CONSP (prop
); prop
= XCDR (prop
))
3320 if (handle_single_display_prop (it
, XCAR (prop
), object
,
3321 position
, display_replaced_p
))
3322 display_replaced_p
= 1;
3325 else if (VECTORP (prop
))
3328 for (i
= 0; i
< ASIZE (prop
); ++i
)
3329 if (handle_single_display_prop (it
, AREF (prop
, i
), object
,
3330 position
, display_replaced_p
))
3331 display_replaced_p
= 1;
3335 if (handle_single_display_prop (it
, prop
, object
, position
, 0))
3336 display_replaced_p
= 1;
3339 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
3343 /* Value is the position of the end of the `display' property starting
3344 at START_POS in OBJECT. */
3346 static struct text_pos
3347 display_prop_end (it
, object
, start_pos
)
3350 struct text_pos start_pos
;
3353 struct text_pos end_pos
;
3355 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
3356 Qdisplay
, object
, Qnil
);
3357 CHARPOS (end_pos
) = XFASTINT (end
);
3358 if (STRINGP (object
))
3359 compute_string_pos (&end_pos
, start_pos
, it
->string
);
3361 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
3367 /* Set up IT from a single `display' sub-property value PROP. OBJECT
3368 is the object in which the `display' property was found. *POSITION
3369 is the position at which it was found. DISPLAY_REPLACED_P non-zero
3370 means that we previously saw a display sub-property which already
3371 replaced text display with something else, for example an image;
3372 ignore such properties after the first one has been processed.
3374 If PROP is a `space' or `image' sub-property, set *POSITION to the
3375 end position of the `display' property.
3377 Value is non-zero if something was found which replaces the display
3378 of buffer or string text. */
3381 handle_single_display_prop (it
, prop
, object
, position
,
3382 display_replaced_before_p
)
3386 struct text_pos
*position
;
3387 int display_replaced_before_p
;
3390 int replaces_text_display_p
= 0;
3393 /* If PROP is a list of the form `(when FORM . VALUE)', FORM is
3394 evaluated. If the result is nil, VALUE is ignored. */
3396 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
3405 if (!NILP (form
) && !EQ (form
, Qt
))
3407 int count
= SPECPDL_INDEX ();
3408 struct gcpro gcpro1
;
3410 /* Bind `object' to the object having the `display' property, a
3411 buffer or string. Bind `position' to the position in the
3412 object where the property was found, and `buffer-position'
3413 to the current position in the buffer. */
3414 specbind (Qobject
, object
);
3415 specbind (Qposition
, make_number (CHARPOS (*position
)));
3416 specbind (Qbuffer_position
,
3417 make_number (STRINGP (object
)
3418 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
3420 form
= safe_eval (form
);
3422 unbind_to (count
, Qnil
);
3429 && EQ (XCAR (prop
), Qheight
)
3430 && CONSP (XCDR (prop
)))
3432 if (FRAME_TERMCAP_P (it
->f
) || FRAME_MSDOS_P (it
->f
))
3435 /* `(height HEIGHT)'. */
3436 it
->font_height
= XCAR (XCDR (prop
));
3437 if (!NILP (it
->font_height
))
3439 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3440 int new_height
= -1;
3442 if (CONSP (it
->font_height
)
3443 && (EQ (XCAR (it
->font_height
), Qplus
)
3444 || EQ (XCAR (it
->font_height
), Qminus
))
3445 && CONSP (XCDR (it
->font_height
))
3446 && INTEGERP (XCAR (XCDR (it
->font_height
))))
3448 /* `(+ N)' or `(- N)' where N is an integer. */
3449 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
3450 if (EQ (XCAR (it
->font_height
), Qplus
))
3452 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
3454 else if (FUNCTIONP (it
->font_height
))
3456 /* Call function with current height as argument.
3457 Value is the new height. */
3459 height
= safe_call1 (it
->font_height
,
3460 face
->lface
[LFACE_HEIGHT_INDEX
]);
3461 if (NUMBERP (height
))
3462 new_height
= XFLOATINT (height
);
3464 else if (NUMBERP (it
->font_height
))
3466 /* Value is a multiple of the canonical char height. */
3469 face
= FACE_FROM_ID (it
->f
, DEFAULT_FACE_ID
);
3470 new_height
= (XFLOATINT (it
->font_height
)
3471 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
3475 /* Evaluate IT->font_height with `height' bound to the
3476 current specified height to get the new height. */
3478 int count
= SPECPDL_INDEX ();
3480 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
3481 value
= safe_eval (it
->font_height
);
3482 unbind_to (count
, Qnil
);
3484 if (NUMBERP (value
))
3485 new_height
= XFLOATINT (value
);
3489 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
3492 else if (CONSP (prop
)
3493 && EQ (XCAR (prop
), Qspace_width
)
3494 && CONSP (XCDR (prop
)))
3496 /* `(space_width WIDTH)'. */
3497 if (FRAME_TERMCAP_P (it
->f
) || FRAME_MSDOS_P (it
->f
))
3500 value
= XCAR (XCDR (prop
));
3501 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
3502 it
->space_width
= value
;
3504 else if (CONSP (prop
)
3505 && EQ (XCAR (prop
), Qslice
))
3507 /* `(slice X Y WIDTH HEIGHT)'. */
3510 if (FRAME_TERMCAP_P (it
->f
) || FRAME_MSDOS_P (it
->f
))
3513 if (tem
= XCDR (prop
), CONSP (tem
))
3515 it
->slice
.x
= XCAR (tem
);
3516 if (tem
= XCDR (tem
), CONSP (tem
))
3518 it
->slice
.y
= XCAR (tem
);
3519 if (tem
= XCDR (tem
), CONSP (tem
))
3521 it
->slice
.width
= XCAR (tem
);
3522 if (tem
= XCDR (tem
), CONSP (tem
))
3523 it
->slice
.height
= XCAR (tem
);
3528 else if (CONSP (prop
)
3529 && EQ (XCAR (prop
), Qraise
)
3530 && CONSP (XCDR (prop
)))
3532 /* `(raise FACTOR)'. */
3533 if (FRAME_TERMCAP_P (it
->f
) || FRAME_MSDOS_P (it
->f
))
3536 #ifdef HAVE_WINDOW_SYSTEM
3537 value
= XCAR (XCDR (prop
));
3538 if (NUMBERP (value
))
3540 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3541 it
->voffset
= - (XFLOATINT (value
)
3542 * (FONT_HEIGHT (face
->font
)));
3544 #endif /* HAVE_WINDOW_SYSTEM */
3546 else if (!it
->string_from_display_prop_p
)
3548 /* `((margin left-margin) VALUE)' or `((margin right-margin)
3549 VALUE) or `((margin nil) VALUE)' or VALUE. */
3550 Lisp_Object location
, value
;
3551 struct text_pos start_pos
;
3554 /* Characters having this form of property are not displayed, so
3555 we have to find the end of the property. */
3556 start_pos
= *position
;
3557 *position
= display_prop_end (it
, object
, start_pos
);
3560 /* Let's stop at the new position and assume that all
3561 text properties change there. */
3562 it
->stop_charpos
= position
->charpos
;
3565 && (EQ (XCAR (prop
), Qleft_fringe
)
3566 || EQ (XCAR (prop
), Qright_fringe
))
3567 && CONSP (XCDR (prop
)))
3569 unsigned face_id
= DEFAULT_FACE_ID
;
3571 /* Save current settings of IT so that we can restore them
3572 when we are finished with the glyph property value. */
3574 /* `(left-fringe BITMAP FACE)'. */
3575 if (FRAME_TERMCAP_P (it
->f
) || FRAME_MSDOS_P (it
->f
))
3578 #ifdef HAVE_WINDOW_SYSTEM
3579 value
= XCAR (XCDR (prop
));
3580 if (!NUMBERP (value
)
3581 || !valid_fringe_bitmap_id_p (XINT (value
)))
3584 if (CONSP (XCDR (XCDR (prop
))))
3586 Lisp_Object face_name
= XCAR (XCDR (XCDR (prop
)));
3588 face_id
= lookup_named_face (it
->f
, face_name
, 'A');
3595 it
->area
= TEXT_AREA
;
3596 it
->what
= IT_IMAGE
;
3597 it
->image_id
= -1; /* no image */
3598 it
->position
= start_pos
;
3599 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
3600 it
->method
= next_element_from_image
;
3601 it
->face_id
= face_id
;
3603 /* Say that we haven't consumed the characters with
3604 `display' property yet. The call to pop_it in
3605 set_iterator_to_next will clean this up. */
3606 *position
= start_pos
;
3608 if (EQ (XCAR (prop
), Qleft_fringe
))
3610 it
->left_user_fringe_bitmap
= XINT (value
);
3611 it
->left_user_fringe_face_id
= face_id
;
3615 it
->right_user_fringe_bitmap
= XINT (value
);
3616 it
->right_user_fringe_face_id
= face_id
;
3618 #endif /* HAVE_WINDOW_SYSTEM */
3622 location
= Qunbound
;
3623 if (CONSP (prop
) && CONSP (XCAR (prop
)))
3627 value
= XCDR (prop
);
3629 value
= XCAR (value
);
3632 if (EQ (XCAR (tem
), Qmargin
)
3633 && (tem
= XCDR (tem
),
3634 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
3636 || EQ (tem
, Qleft_margin
)
3637 || EQ (tem
, Qright_margin
))))
3641 if (EQ (location
, Qunbound
))
3647 valid_p
= (STRINGP (value
)
3648 #ifdef HAVE_WINDOW_SYSTEM
3649 || (!FRAME_TERMCAP_P (it
->f
) && valid_image_p (value
))
3650 #endif /* not HAVE_WINDOW_SYSTEM */
3651 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
3653 if ((EQ (location
, Qleft_margin
)
3654 || EQ (location
, Qright_margin
)
3657 && !display_replaced_before_p
)
3659 replaces_text_display_p
= 1;
3661 /* Save current settings of IT so that we can restore them
3662 when we are finished with the glyph property value. */
3665 if (NILP (location
))
3666 it
->area
= TEXT_AREA
;
3667 else if (EQ (location
, Qleft_margin
))
3668 it
->area
= LEFT_MARGIN_AREA
;
3670 it
->area
= RIGHT_MARGIN_AREA
;
3672 if (STRINGP (value
))
3675 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
3676 it
->current
.overlay_string_index
= -1;
3677 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
3678 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
3679 it
->method
= next_element_from_string
;
3680 it
->stop_charpos
= 0;
3681 it
->string_from_display_prop_p
= 1;
3682 /* Say that we haven't consumed the characters with
3683 `display' property yet. The call to pop_it in
3684 set_iterator_to_next will clean this up. */
3685 *position
= start_pos
;
3687 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
3689 it
->method
= next_element_from_stretch
;
3691 it
->current
.pos
= it
->position
= start_pos
;
3693 #ifdef HAVE_WINDOW_SYSTEM
3696 it
->what
= IT_IMAGE
;
3697 it
->image_id
= lookup_image (it
->f
, value
);
3698 it
->position
= start_pos
;
3699 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
3700 it
->method
= next_element_from_image
;
3702 /* Say that we haven't consumed the characters with
3703 `display' property yet. The call to pop_it in
3704 set_iterator_to_next will clean this up. */
3705 *position
= start_pos
;
3707 #endif /* HAVE_WINDOW_SYSTEM */
3710 /* Invalid property or property not supported. Restore
3711 the position to what it was before. */
3712 *position
= start_pos
;
3715 return replaces_text_display_p
;
3719 /* Check if PROP is a display sub-property value whose text should be
3720 treated as intangible. */
3723 single_display_prop_intangible_p (prop
)
3726 /* Skip over `when FORM'. */
3727 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
3741 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
3742 we don't need to treat text as intangible. */
3743 if (EQ (XCAR (prop
), Qmargin
))
3751 || EQ (XCAR (prop
), Qleft_margin
)
3752 || EQ (XCAR (prop
), Qright_margin
))
3756 return (CONSP (prop
)
3757 && (EQ (XCAR (prop
), Qimage
)
3758 || EQ (XCAR (prop
), Qspace
)));
3762 /* Check if PROP is a display property value whose text should be
3763 treated as intangible. */
3766 display_prop_intangible_p (prop
)
3770 && CONSP (XCAR (prop
))
3771 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
3773 /* A list of sub-properties. */
3774 while (CONSP (prop
))
3776 if (single_display_prop_intangible_p (XCAR (prop
)))
3781 else if (VECTORP (prop
))
3783 /* A vector of sub-properties. */
3785 for (i
= 0; i
< ASIZE (prop
); ++i
)
3786 if (single_display_prop_intangible_p (AREF (prop
, i
)))
3790 return single_display_prop_intangible_p (prop
);
3796 /* Return 1 if PROP is a display sub-property value containing STRING. */
3799 single_display_prop_string_p (prop
, string
)
3800 Lisp_Object prop
, string
;
3802 if (EQ (string
, prop
))
3805 /* Skip over `when FORM'. */
3806 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
3815 /* Skip over `margin LOCATION'. */
3816 if (EQ (XCAR (prop
), Qmargin
))
3827 return CONSP (prop
) && EQ (XCAR (prop
), string
);
3831 /* Return 1 if STRING appears in the `display' property PROP. */
3834 display_prop_string_p (prop
, string
)
3835 Lisp_Object prop
, string
;
3838 && CONSP (XCAR (prop
))
3839 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
3841 /* A list of sub-properties. */
3842 while (CONSP (prop
))
3844 if (single_display_prop_string_p (XCAR (prop
), string
))
3849 else if (VECTORP (prop
))
3851 /* A vector of sub-properties. */
3853 for (i
= 0; i
< ASIZE (prop
); ++i
)
3854 if (single_display_prop_string_p (AREF (prop
, i
), string
))
3858 return single_display_prop_string_p (prop
, string
);
3864 /* Determine from which buffer position in W's buffer STRING comes
3865 from. AROUND_CHARPOS is an approximate position where it could
3866 be from. Value is the buffer position or 0 if it couldn't be
3869 W's buffer must be current.
3871 This function is necessary because we don't record buffer positions
3872 in glyphs generated from strings (to keep struct glyph small).
3873 This function may only use code that doesn't eval because it is
3874 called asynchronously from note_mouse_highlight. */
3877 string_buffer_position (w
, string
, around_charpos
)
3882 Lisp_Object limit
, prop
, pos
;
3883 const int MAX_DISTANCE
= 1000;
3886 pos
= make_number (around_charpos
);
3887 limit
= make_number (min (XINT (pos
) + MAX_DISTANCE
, ZV
));
3888 while (!found
&& !EQ (pos
, limit
))
3890 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
3891 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
3894 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
, limit
);
3899 pos
= make_number (around_charpos
);
3900 limit
= make_number (max (XINT (pos
) - MAX_DISTANCE
, BEGV
));
3901 while (!found
&& !EQ (pos
, limit
))
3903 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
3904 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
3907 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
3912 return found
? XINT (pos
) : 0;
3917 /***********************************************************************
3918 `composition' property
3919 ***********************************************************************/
3921 /* Set up iterator IT from `composition' property at its current
3922 position. Called from handle_stop. */
3924 static enum prop_handled
3925 handle_composition_prop (it
)
3928 Lisp_Object prop
, string
;
3929 int pos
, pos_byte
, end
;
3930 enum prop_handled handled
= HANDLED_NORMALLY
;
3932 if (STRINGP (it
->string
))
3934 pos
= IT_STRING_CHARPOS (*it
);
3935 pos_byte
= IT_STRING_BYTEPOS (*it
);
3936 string
= it
->string
;
3940 pos
= IT_CHARPOS (*it
);
3941 pos_byte
= IT_BYTEPOS (*it
);
3945 /* If there's a valid composition and point is not inside of the
3946 composition (in the case that the composition is from the current
3947 buffer), draw a glyph composed from the composition components. */
3948 if (find_composition (pos
, -1, &pos
, &end
, &prop
, string
)
3949 && COMPOSITION_VALID_P (pos
, end
, prop
)
3950 && (STRINGP (it
->string
) || (PT
<= pos
|| PT
>= end
)))
3952 int id
= get_composition_id (pos
, pos_byte
, end
- pos
, prop
, string
);
3956 it
->method
= next_element_from_composition
;
3958 it
->cmp_len
= COMPOSITION_LENGTH (prop
);
3959 /* For a terminal, draw only the first character of the
3961 it
->c
= COMPOSITION_GLYPH (composition_table
[id
], 0);
3962 it
->len
= (STRINGP (it
->string
)
3963 ? string_char_to_byte (it
->string
, end
)
3964 : CHAR_TO_BYTE (end
)) - pos_byte
;
3965 it
->stop_charpos
= end
;
3966 handled
= HANDLED_RETURN
;
3975 /***********************************************************************
3977 ***********************************************************************/
3979 /* The following structure is used to record overlay strings for
3980 later sorting in load_overlay_strings. */
3982 struct overlay_entry
3984 Lisp_Object overlay
;
3991 /* Set up iterator IT from overlay strings at its current position.
3992 Called from handle_stop. */
3994 static enum prop_handled
3995 handle_overlay_change (it
)
3998 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
3999 return HANDLED_RECOMPUTE_PROPS
;
4001 return HANDLED_NORMALLY
;
4005 /* Set up the next overlay string for delivery by IT, if there is an
4006 overlay string to deliver. Called by set_iterator_to_next when the
4007 end of the current overlay string is reached. If there are more
4008 overlay strings to display, IT->string and
4009 IT->current.overlay_string_index are set appropriately here.
4010 Otherwise IT->string is set to nil. */
4013 next_overlay_string (it
)
4016 ++it
->current
.overlay_string_index
;
4017 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4019 /* No more overlay strings. Restore IT's settings to what
4020 they were before overlay strings were processed, and
4021 continue to deliver from current_buffer. */
4022 int display_ellipsis_p
= it
->stack
[it
->sp
- 1].display_ellipsis_p
;
4025 xassert (it
->stop_charpos
>= BEGV
4026 && it
->stop_charpos
<= it
->end_charpos
);
4028 it
->current
.overlay_string_index
= -1;
4029 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
4030 it
->n_overlay_strings
= 0;
4031 it
->method
= next_element_from_buffer
;
4033 /* If we're at the end of the buffer, record that we have
4034 processed the overlay strings there already, so that
4035 next_element_from_buffer doesn't try it again. */
4036 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
4037 it
->overlay_strings_at_end_processed_p
= 1;
4039 /* If we have to display `...' for invisible text, set
4040 the iterator up for that. */
4041 if (display_ellipsis_p
)
4042 setup_for_ellipsis (it
);
4046 /* There are more overlay strings to process. If
4047 IT->current.overlay_string_index has advanced to a position
4048 where we must load IT->overlay_strings with more strings, do
4050 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4052 if (it
->current
.overlay_string_index
&& i
== 0)
4053 load_overlay_strings (it
, 0);
4055 /* Initialize IT to deliver display elements from the overlay
4057 it
->string
= it
->overlay_strings
[i
];
4058 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4059 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4060 it
->method
= next_element_from_string
;
4061 it
->stop_charpos
= 0;
4068 /* Compare two overlay_entry structures E1 and E2. Used as a
4069 comparison function for qsort in load_overlay_strings. Overlay
4070 strings for the same position are sorted so that
4072 1. All after-strings come in front of before-strings, except
4073 when they come from the same overlay.
4075 2. Within after-strings, strings are sorted so that overlay strings
4076 from overlays with higher priorities come first.
4078 2. Within before-strings, strings are sorted so that overlay
4079 strings from overlays with higher priorities come last.
4081 Value is analogous to strcmp. */
4085 compare_overlay_entries (e1
, e2
)
4088 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4089 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4092 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4094 /* Let after-strings appear in front of before-strings if
4095 they come from different overlays. */
4096 if (EQ (entry1
->overlay
, entry2
->overlay
))
4097 result
= entry1
->after_string_p
? 1 : -1;
4099 result
= entry1
->after_string_p
? -1 : 1;
4101 else if (entry1
->after_string_p
)
4102 /* After-strings sorted in order of decreasing priority. */
4103 result
= entry2
->priority
- entry1
->priority
;
4105 /* Before-strings sorted in order of increasing priority. */
4106 result
= entry1
->priority
- entry2
->priority
;
4112 /* Load the vector IT->overlay_strings with overlay strings from IT's
4113 current buffer position, or from CHARPOS if that is > 0. Set
4114 IT->n_overlays to the total number of overlay strings found.
4116 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4117 a time. On entry into load_overlay_strings,
4118 IT->current.overlay_string_index gives the number of overlay
4119 strings that have already been loaded by previous calls to this
4122 IT->add_overlay_start contains an additional overlay start
4123 position to consider for taking overlay strings from, if non-zero.
4124 This position comes into play when the overlay has an `invisible'
4125 property, and both before and after-strings. When we've skipped to
4126 the end of the overlay, because of its `invisible' property, we
4127 nevertheless want its before-string to appear.
4128 IT->add_overlay_start will contain the overlay start position
4131 Overlay strings are sorted so that after-string strings come in
4132 front of before-string strings. Within before and after-strings,
4133 strings are sorted by overlay priority. See also function
4134 compare_overlay_entries. */
4137 load_overlay_strings (it
, charpos
)
4141 extern Lisp_Object Qafter_string
, Qbefore_string
, Qwindow
, Qpriority
;
4142 Lisp_Object overlay
, window
, str
, invisible
;
4143 struct Lisp_Overlay
*ov
;
4146 int n
= 0, i
, j
, invis_p
;
4147 struct overlay_entry
*entries
4148 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4151 charpos
= IT_CHARPOS (*it
);
4153 /* Append the overlay string STRING of overlay OVERLAY to vector
4154 `entries' which has size `size' and currently contains `n'
4155 elements. AFTER_P non-zero means STRING is an after-string of
4157 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4160 Lisp_Object priority; \
4164 int new_size = 2 * size; \
4165 struct overlay_entry *old = entries; \
4167 (struct overlay_entry *) alloca (new_size \
4168 * sizeof *entries); \
4169 bcopy (old, entries, size * sizeof *entries); \
4173 entries[n].string = (STRING); \
4174 entries[n].overlay = (OVERLAY); \
4175 priority = Foverlay_get ((OVERLAY), Qpriority); \
4176 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4177 entries[n].after_string_p = (AFTER_P); \
4182 /* Process overlay before the overlay center. */
4183 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4185 XSETMISC (overlay
, ov
);
4186 xassert (OVERLAYP (overlay
));
4187 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4188 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4193 /* Skip this overlay if it doesn't start or end at IT's current
4195 if (end
!= charpos
&& start
!= charpos
)
4198 /* Skip this overlay if it doesn't apply to IT->w. */
4199 window
= Foverlay_get (overlay
, Qwindow
);
4200 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4203 /* If the text ``under'' the overlay is invisible, both before-
4204 and after-strings from this overlay are visible; start and
4205 end position are indistinguishable. */
4206 invisible
= Foverlay_get (overlay
, Qinvisible
);
4207 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4209 /* If overlay has a non-empty before-string, record it. */
4210 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4211 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4213 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4215 /* If overlay has a non-empty after-string, record it. */
4216 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4217 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4219 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4222 /* Process overlays after the overlay center. */
4223 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4225 XSETMISC (overlay
, ov
);
4226 xassert (OVERLAYP (overlay
));
4227 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4228 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4230 if (start
> charpos
)
4233 /* Skip this overlay if it doesn't start or end at IT's current
4235 if (end
!= charpos
&& start
!= charpos
)
4238 /* Skip this overlay if it doesn't apply to IT->w. */
4239 window
= Foverlay_get (overlay
, Qwindow
);
4240 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4243 /* If the text ``under'' the overlay is invisible, it has a zero
4244 dimension, and both before- and after-strings apply. */
4245 invisible
= Foverlay_get (overlay
, Qinvisible
);
4246 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4248 /* If overlay has a non-empty before-string, record it. */
4249 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4250 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4252 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4254 /* If overlay has a non-empty after-string, record it. */
4255 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4256 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4258 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4261 #undef RECORD_OVERLAY_STRING
4265 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
4267 /* Record the total number of strings to process. */
4268 it
->n_overlay_strings
= n
;
4270 /* IT->current.overlay_string_index is the number of overlay strings
4271 that have already been consumed by IT. Copy some of the
4272 remaining overlay strings to IT->overlay_strings. */
4274 j
= it
->current
.overlay_string_index
;
4275 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
4276 it
->overlay_strings
[i
++] = entries
[j
++].string
;
4282 /* Get the first chunk of overlay strings at IT's current buffer
4283 position, or at CHARPOS if that is > 0. Value is non-zero if at
4284 least one overlay string was found. */
4287 get_overlay_strings (it
, charpos
)
4291 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
4292 process. This fills IT->overlay_strings with strings, and sets
4293 IT->n_overlay_strings to the total number of strings to process.
4294 IT->pos.overlay_string_index has to be set temporarily to zero
4295 because load_overlay_strings needs this; it must be set to -1
4296 when no overlay strings are found because a zero value would
4297 indicate a position in the first overlay string. */
4298 it
->current
.overlay_string_index
= 0;
4299 load_overlay_strings (it
, charpos
);
4301 /* If we found overlay strings, set up IT to deliver display
4302 elements from the first one. Otherwise set up IT to deliver
4303 from current_buffer. */
4304 if (it
->n_overlay_strings
)
4306 /* Make sure we know settings in current_buffer, so that we can
4307 restore meaningful values when we're done with the overlay
4309 compute_stop_pos (it
);
4310 xassert (it
->face_id
>= 0);
4312 /* Save IT's settings. They are restored after all overlay
4313 strings have been processed. */
4314 xassert (it
->sp
== 0);
4317 /* Set up IT to deliver display elements from the first overlay
4319 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4320 it
->string
= it
->overlay_strings
[0];
4321 it
->stop_charpos
= 0;
4322 xassert (STRINGP (it
->string
));
4323 it
->end_charpos
= SCHARS (it
->string
);
4324 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4325 it
->method
= next_element_from_string
;
4330 it
->current
.overlay_string_index
= -1;
4331 it
->method
= next_element_from_buffer
;
4336 /* Value is non-zero if we found at least one overlay string. */
4337 return STRINGP (it
->string
);
4342 /***********************************************************************
4343 Saving and restoring state
4344 ***********************************************************************/
4346 /* Save current settings of IT on IT->stack. Called, for example,
4347 before setting up IT for an overlay string, to be able to restore
4348 IT's settings to what they were after the overlay string has been
4355 struct iterator_stack_entry
*p
;
4357 xassert (it
->sp
< 2);
4358 p
= it
->stack
+ it
->sp
;
4360 p
->stop_charpos
= it
->stop_charpos
;
4361 xassert (it
->face_id
>= 0);
4362 p
->face_id
= it
->face_id
;
4363 p
->string
= it
->string
;
4364 p
->pos
= it
->current
;
4365 p
->end_charpos
= it
->end_charpos
;
4366 p
->string_nchars
= it
->string_nchars
;
4368 p
->multibyte_p
= it
->multibyte_p
;
4369 p
->slice
= it
->slice
;
4370 p
->space_width
= it
->space_width
;
4371 p
->font_height
= it
->font_height
;
4372 p
->voffset
= it
->voffset
;
4373 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
4374 p
->display_ellipsis_p
= 0;
4379 /* Restore IT's settings from IT->stack. Called, for example, when no
4380 more overlay strings must be processed, and we return to delivering
4381 display elements from a buffer, or when the end of a string from a
4382 `display' property is reached and we return to delivering display
4383 elements from an overlay string, or from a buffer. */
4389 struct iterator_stack_entry
*p
;
4391 xassert (it
->sp
> 0);
4393 p
= it
->stack
+ it
->sp
;
4394 it
->stop_charpos
= p
->stop_charpos
;
4395 it
->face_id
= p
->face_id
;
4396 it
->string
= p
->string
;
4397 it
->current
= p
->pos
;
4398 it
->end_charpos
= p
->end_charpos
;
4399 it
->string_nchars
= p
->string_nchars
;
4401 it
->multibyte_p
= p
->multibyte_p
;
4402 it
->slice
= p
->slice
;
4403 it
->space_width
= p
->space_width
;
4404 it
->font_height
= p
->font_height
;
4405 it
->voffset
= p
->voffset
;
4406 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
4411 /***********************************************************************
4413 ***********************************************************************/
4415 /* Set IT's current position to the previous line start. */
4418 back_to_previous_line_start (it
)
4421 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
4422 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
4426 /* Move IT to the next line start.
4428 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
4429 we skipped over part of the text (as opposed to moving the iterator
4430 continuously over the text). Otherwise, don't change the value
4433 Newlines may come from buffer text, overlay strings, or strings
4434 displayed via the `display' property. That's the reason we can't
4435 simply use find_next_newline_no_quit.
4437 Note that this function may not skip over invisible text that is so
4438 because of text properties and immediately follows a newline. If
4439 it would, function reseat_at_next_visible_line_start, when called
4440 from set_iterator_to_next, would effectively make invisible
4441 characters following a newline part of the wrong glyph row, which
4442 leads to wrong cursor motion. */
4445 forward_to_next_line_start (it
, skipped_p
)
4449 int old_selective
, newline_found_p
, n
;
4450 const int MAX_NEWLINE_DISTANCE
= 500;
4452 /* If already on a newline, just consume it to avoid unintended
4453 skipping over invisible text below. */
4454 if (it
->what
== IT_CHARACTER
4456 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
4458 set_iterator_to_next (it
, 0);
4463 /* Don't handle selective display in the following. It's (a)
4464 unnecessary because it's done by the caller, and (b) leads to an
4465 infinite recursion because next_element_from_ellipsis indirectly
4466 calls this function. */
4467 old_selective
= it
->selective
;
4470 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
4471 from buffer text. */
4472 for (n
= newline_found_p
= 0;
4473 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
4474 n
+= STRINGP (it
->string
) ? 0 : 1)
4476 if (!get_next_display_element (it
))
4478 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
4479 set_iterator_to_next (it
, 0);
4482 /* If we didn't find a newline near enough, see if we can use a
4484 if (!newline_found_p
)
4486 int start
= IT_CHARPOS (*it
);
4487 int limit
= find_next_newline_no_quit (start
, 1);
4490 xassert (!STRINGP (it
->string
));
4492 /* If there isn't any `display' property in sight, and no
4493 overlays, we can just use the position of the newline in
4495 if (it
->stop_charpos
>= limit
4496 || ((pos
= Fnext_single_property_change (make_number (start
),
4498 Qnil
, make_number (limit
)),
4500 && next_overlay_change (start
) == ZV
))
4502 IT_CHARPOS (*it
) = limit
;
4503 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
4504 *skipped_p
= newline_found_p
= 1;
4508 while (get_next_display_element (it
)
4509 && !newline_found_p
)
4511 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
4512 set_iterator_to_next (it
, 0);
4517 it
->selective
= old_selective
;
4518 return newline_found_p
;
4522 /* Set IT's current position to the previous visible line start. Skip
4523 invisible text that is so either due to text properties or due to
4524 selective display. Caution: this does not change IT->current_x and
4528 back_to_previous_visible_line_start (it
)
4533 /* Go back one newline if not on BEGV already. */
4534 if (IT_CHARPOS (*it
) > BEGV
)
4535 back_to_previous_line_start (it
);
4537 /* Move over lines that are invisible because of selective display
4538 or text properties. */
4539 while (IT_CHARPOS (*it
) > BEGV
4544 /* If selective > 0, then lines indented more than that values
4546 if (it
->selective
> 0
4547 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
4548 (double) it
->selective
)) /* iftc */
4554 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
)),
4555 Qinvisible
, it
->window
);
4556 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
4562 struct it it2
= *it
;
4564 if (handle_display_prop (&it2
) == HANDLED_RETURN
)
4568 /* Back one more newline if the current one is invisible. */
4570 back_to_previous_line_start (it
);
4573 xassert (IT_CHARPOS (*it
) >= BEGV
);
4574 xassert (IT_CHARPOS (*it
) == BEGV
4575 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
4580 /* Reseat iterator IT at the previous visible line start. Skip
4581 invisible text that is so either due to text properties or due to
4582 selective display. At the end, update IT's overlay information,
4583 face information etc. */
4586 reseat_at_previous_visible_line_start (it
)
4589 back_to_previous_visible_line_start (it
);
4590 reseat (it
, it
->current
.pos
, 1);
4595 /* Reseat iterator IT on the next visible line start in the current
4596 buffer. ON_NEWLINE_P non-zero means position IT on the newline
4597 preceding the line start. Skip over invisible text that is so
4598 because of selective display. Compute faces, overlays etc at the
4599 new position. Note that this function does not skip over text that
4600 is invisible because of text properties. */
4603 reseat_at_next_visible_line_start (it
, on_newline_p
)
4607 int newline_found_p
, skipped_p
= 0;
4609 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
4611 /* Skip over lines that are invisible because they are indented
4612 more than the value of IT->selective. */
4613 if (it
->selective
> 0)
4614 while (IT_CHARPOS (*it
) < ZV
4615 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
4616 (double) it
->selective
)) /* iftc */
4618 xassert (FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
4619 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
4622 /* Position on the newline if that's what's requested. */
4623 if (on_newline_p
&& newline_found_p
)
4625 if (STRINGP (it
->string
))
4627 if (IT_STRING_CHARPOS (*it
) > 0)
4629 --IT_STRING_CHARPOS (*it
);
4630 --IT_STRING_BYTEPOS (*it
);
4633 else if (IT_CHARPOS (*it
) > BEGV
)
4637 reseat (it
, it
->current
.pos
, 0);
4641 reseat (it
, it
->current
.pos
, 0);
4648 /***********************************************************************
4649 Changing an iterator's position
4650 ***********************************************************************/
4652 /* Change IT's current position to POS in current_buffer. If FORCE_P
4653 is non-zero, always check for text properties at the new position.
4654 Otherwise, text properties are only looked up if POS >=
4655 IT->check_charpos of a property. */
4658 reseat (it
, pos
, force_p
)
4660 struct text_pos pos
;
4663 int original_pos
= IT_CHARPOS (*it
);
4665 reseat_1 (it
, pos
, 0);
4667 /* Determine where to check text properties. Avoid doing it
4668 where possible because text property lookup is very expensive. */
4670 || CHARPOS (pos
) > it
->stop_charpos
4671 || CHARPOS (pos
) < original_pos
)
4678 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
4679 IT->stop_pos to POS, also. */
4682 reseat_1 (it
, pos
, set_stop_p
)
4684 struct text_pos pos
;
4687 /* Don't call this function when scanning a C string. */
4688 xassert (it
->s
== NULL
);
4690 /* POS must be a reasonable value. */
4691 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
4693 it
->current
.pos
= it
->position
= pos
;
4694 XSETBUFFER (it
->object
, current_buffer
);
4695 it
->end_charpos
= ZV
;
4697 it
->current
.dpvec_index
= -1;
4698 it
->current
.overlay_string_index
= -1;
4699 IT_STRING_CHARPOS (*it
) = -1;
4700 IT_STRING_BYTEPOS (*it
) = -1;
4702 it
->method
= next_element_from_buffer
;
4703 /* RMS: I added this to fix a bug in move_it_vertically_backward
4704 where it->area continued to relate to the starting point
4705 for the backward motion. Bug report from
4706 Nick Roberts <nick@nick.uklinux.net> on 19 May 2003.
4707 However, I am not sure whether reseat still does the right thing
4708 in general after this change. */
4709 it
->area
= TEXT_AREA
;
4710 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
4712 it
->face_before_selective_p
= 0;
4715 it
->stop_charpos
= CHARPOS (pos
);
4719 /* Set up IT for displaying a string, starting at CHARPOS in window W.
4720 If S is non-null, it is a C string to iterate over. Otherwise,
4721 STRING gives a Lisp string to iterate over.
4723 If PRECISION > 0, don't return more then PRECISION number of
4724 characters from the string.
4726 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
4727 characters have been returned. FIELD_WIDTH < 0 means an infinite
4730 MULTIBYTE = 0 means disable processing of multibyte characters,
4731 MULTIBYTE > 0 means enable it,
4732 MULTIBYTE < 0 means use IT->multibyte_p.
4734 IT must be initialized via a prior call to init_iterator before
4735 calling this function. */
4738 reseat_to_string (it
, s
, string
, charpos
, precision
, field_width
, multibyte
)
4743 int precision
, field_width
, multibyte
;
4745 /* No region in strings. */
4746 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
4748 /* No text property checks performed by default, but see below. */
4749 it
->stop_charpos
= -1;
4751 /* Set iterator position and end position. */
4752 bzero (&it
->current
, sizeof it
->current
);
4753 it
->current
.overlay_string_index
= -1;
4754 it
->current
.dpvec_index
= -1;
4755 xassert (charpos
>= 0);
4757 /* If STRING is specified, use its multibyteness, otherwise use the
4758 setting of MULTIBYTE, if specified. */
4760 it
->multibyte_p
= multibyte
> 0;
4764 xassert (STRINGP (string
));
4765 it
->string
= string
;
4767 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
4768 it
->method
= next_element_from_string
;
4769 it
->current
.string_pos
= string_pos (charpos
, string
);
4776 /* Note that we use IT->current.pos, not it->current.string_pos,
4777 for displaying C strings. */
4778 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
4779 if (it
->multibyte_p
)
4781 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
4782 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
4786 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
4787 it
->end_charpos
= it
->string_nchars
= strlen (s
);
4790 it
->method
= next_element_from_c_string
;
4793 /* PRECISION > 0 means don't return more than PRECISION characters
4795 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
4796 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
4798 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
4799 characters have been returned. FIELD_WIDTH == 0 means don't pad,
4800 FIELD_WIDTH < 0 means infinite field width. This is useful for
4801 padding with `-' at the end of a mode line. */
4802 if (field_width
< 0)
4803 field_width
= INFINITY
;
4804 if (field_width
> it
->end_charpos
- charpos
)
4805 it
->end_charpos
= charpos
+ field_width
;
4807 /* Use the standard display table for displaying strings. */
4808 if (DISP_TABLE_P (Vstandard_display_table
))
4809 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
4811 it
->stop_charpos
= charpos
;
4817 /***********************************************************************
4819 ***********************************************************************/
4821 /* Load IT's display element fields with information about the next
4822 display element from the current position of IT. Value is zero if
4823 end of buffer (or C string) is reached. */
4826 get_next_display_element (it
)
4829 /* Non-zero means that we found a display element. Zero means that
4830 we hit the end of what we iterate over. Performance note: the
4831 function pointer `method' used here turns out to be faster than
4832 using a sequence of if-statements. */
4833 int success_p
= (*it
->method
) (it
);
4835 if (it
->what
== IT_CHARACTER
)
4837 /* Map via display table or translate control characters.
4838 IT->c, IT->len etc. have been set to the next character by
4839 the function call above. If we have a display table, and it
4840 contains an entry for IT->c, translate it. Don't do this if
4841 IT->c itself comes from a display table, otherwise we could
4842 end up in an infinite recursion. (An alternative could be to
4843 count the recursion depth of this function and signal an
4844 error when a certain maximum depth is reached.) Is it worth
4846 if (success_p
&& it
->dpvec
== NULL
)
4851 && (dv
= DISP_CHAR_VECTOR (it
->dp
, it
->c
),
4854 struct Lisp_Vector
*v
= XVECTOR (dv
);
4856 /* Return the first character from the display table
4857 entry, if not empty. If empty, don't display the
4858 current character. */
4861 it
->dpvec_char_len
= it
->len
;
4862 it
->dpvec
= v
->contents
;
4863 it
->dpend
= v
->contents
+ v
->size
;
4864 it
->current
.dpvec_index
= 0;
4865 it
->method
= next_element_from_display_vector
;
4866 success_p
= get_next_display_element (it
);
4870 set_iterator_to_next (it
, 0);
4871 success_p
= get_next_display_element (it
);
4875 /* Translate control characters into `\003' or `^C' form.
4876 Control characters coming from a display table entry are
4877 currently not translated because we use IT->dpvec to hold
4878 the translation. This could easily be changed but I
4879 don't believe that it is worth doing.
4881 If it->multibyte_p is nonzero, eight-bit characters and
4882 non-printable multibyte characters are also translated to
4885 If it->multibyte_p is zero, eight-bit characters that
4886 don't have corresponding multibyte char code are also
4887 translated to octal form. */
4888 else if ((it
->c
< ' '
4889 && (it
->area
!= TEXT_AREA
4890 || (it
->c
!= '\n' && it
->c
!= '\t')))
4894 || !CHAR_PRINTABLE_P (it
->c
))
4896 && it
->c
== unibyte_char_to_multibyte (it
->c
))))
4898 /* IT->c is a control character which must be displayed
4899 either as '\003' or as `^C' where the '\\' and '^'
4900 can be defined in the display table. Fill
4901 IT->ctl_chars with glyphs for what we have to
4902 display. Then, set IT->dpvec to these glyphs. */
4905 if (it
->c
< 128 && it
->ctl_arrow_p
)
4907 /* Set IT->ctl_chars[0] to the glyph for `^'. */
4909 && INTEGERP (DISP_CTRL_GLYPH (it
->dp
))
4910 && GLYPH_CHAR_VALID_P (XINT (DISP_CTRL_GLYPH (it
->dp
))))
4911 g
= XINT (DISP_CTRL_GLYPH (it
->dp
));
4913 g
= FAST_MAKE_GLYPH ('^', 0);
4914 XSETINT (it
->ctl_chars
[0], g
);
4916 g
= FAST_MAKE_GLYPH (it
->c
^ 0100, 0);
4917 XSETINT (it
->ctl_chars
[1], g
);
4919 /* Set up IT->dpvec and return first character from it. */
4920 it
->dpvec_char_len
= it
->len
;
4921 it
->dpvec
= it
->ctl_chars
;
4922 it
->dpend
= it
->dpvec
+ 2;
4923 it
->current
.dpvec_index
= 0;
4924 it
->method
= next_element_from_display_vector
;
4925 get_next_display_element (it
);
4929 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
4934 /* Set IT->ctl_chars[0] to the glyph for `\\'. */
4936 && INTEGERP (DISP_ESCAPE_GLYPH (it
->dp
))
4937 && GLYPH_CHAR_VALID_P (XFASTINT (DISP_ESCAPE_GLYPH (it
->dp
))))
4938 escape_glyph
= XFASTINT (DISP_ESCAPE_GLYPH (it
->dp
));
4940 escape_glyph
= FAST_MAKE_GLYPH ('\\', 0);
4942 if (SINGLE_BYTE_CHAR_P (it
->c
))
4943 str
[0] = it
->c
, len
= 1;
4946 len
= CHAR_STRING_NO_SIGNAL (it
->c
, str
);
4949 /* It's an invalid character, which
4950 shouldn't happen actually, but due to
4951 bugs it may happen. Let's print the char
4952 as is, there's not much meaningful we can
4955 str
[1] = it
->c
>> 8;
4956 str
[2] = it
->c
>> 16;
4957 str
[3] = it
->c
>> 24;
4962 for (i
= 0; i
< len
; i
++)
4964 XSETINT (it
->ctl_chars
[i
* 4], escape_glyph
);
4965 /* Insert three more glyphs into IT->ctl_chars for
4966 the octal display of the character. */
4967 g
= FAST_MAKE_GLYPH (((str
[i
] >> 6) & 7) + '0', 0);
4968 XSETINT (it
->ctl_chars
[i
* 4 + 1], g
);
4969 g
= FAST_MAKE_GLYPH (((str
[i
] >> 3) & 7) + '0', 0);
4970 XSETINT (it
->ctl_chars
[i
* 4 + 2], g
);
4971 g
= FAST_MAKE_GLYPH ((str
[i
] & 7) + '0', 0);
4972 XSETINT (it
->ctl_chars
[i
* 4 + 3], g
);
4975 /* Set up IT->dpvec and return the first character
4977 it
->dpvec_char_len
= it
->len
;
4978 it
->dpvec
= it
->ctl_chars
;
4979 it
->dpend
= it
->dpvec
+ len
* 4;
4980 it
->current
.dpvec_index
= 0;
4981 it
->method
= next_element_from_display_vector
;
4982 get_next_display_element (it
);
4987 /* Adjust face id for a multibyte character. There are no
4988 multibyte character in unibyte text. */
4991 && FRAME_WINDOW_P (it
->f
))
4993 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4994 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->c
);
4998 /* Is this character the last one of a run of characters with
4999 box? If yes, set IT->end_of_box_run_p to 1. */
5006 it
->end_of_box_run_p
5007 = ((face_id
= face_after_it_pos (it
),
5008 face_id
!= it
->face_id
)
5009 && (face
= FACE_FROM_ID (it
->f
, face_id
),
5010 face
->box
== FACE_NO_BOX
));
5013 /* Value is 0 if end of buffer or string reached. */
5018 /* Move IT to the next display element.
5020 RESEAT_P non-zero means if called on a newline in buffer text,
5021 skip to the next visible line start.
5023 Functions get_next_display_element and set_iterator_to_next are
5024 separate because I find this arrangement easier to handle than a
5025 get_next_display_element function that also increments IT's
5026 position. The way it is we can first look at an iterator's current
5027 display element, decide whether it fits on a line, and if it does,
5028 increment the iterator position. The other way around we probably
5029 would either need a flag indicating whether the iterator has to be
5030 incremented the next time, or we would have to implement a
5031 decrement position function which would not be easy to write. */
5034 set_iterator_to_next (it
, reseat_p
)
5038 /* Reset flags indicating start and end of a sequence of characters
5039 with box. Reset them at the start of this function because
5040 moving the iterator to a new position might set them. */
5041 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
5043 if (it
->method
== next_element_from_buffer
)
5045 /* The current display element of IT is a character from
5046 current_buffer. Advance in the buffer, and maybe skip over
5047 invisible lines that are so because of selective display. */
5048 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
5049 reseat_at_next_visible_line_start (it
, 0);
5052 xassert (it
->len
!= 0);
5053 IT_BYTEPOS (*it
) += it
->len
;
5054 IT_CHARPOS (*it
) += 1;
5055 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
5058 else if (it
->method
== next_element_from_composition
)
5060 xassert (it
->cmp_id
>= 0 && it
->cmp_id
< n_compositions
);
5061 if (STRINGP (it
->string
))
5063 IT_STRING_BYTEPOS (*it
) += it
->len
;
5064 IT_STRING_CHARPOS (*it
) += it
->cmp_len
;
5065 it
->method
= next_element_from_string
;
5066 goto consider_string_end
;
5070 IT_BYTEPOS (*it
) += it
->len
;
5071 IT_CHARPOS (*it
) += it
->cmp_len
;
5072 it
->method
= next_element_from_buffer
;
5075 else if (it
->method
== next_element_from_c_string
)
5077 /* Current display element of IT is from a C string. */
5078 IT_BYTEPOS (*it
) += it
->len
;
5079 IT_CHARPOS (*it
) += 1;
5081 else if (it
->method
== next_element_from_display_vector
)
5083 /* Current display element of IT is from a display table entry.
5084 Advance in the display table definition. Reset it to null if
5085 end reached, and continue with characters from buffers/
5087 ++it
->current
.dpvec_index
;
5089 /* Restore face of the iterator to what they were before the
5090 display vector entry (these entries may contain faces). */
5091 it
->face_id
= it
->saved_face_id
;
5093 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
5096 it
->method
= next_element_from_c_string
;
5097 else if (STRINGP (it
->string
))
5098 it
->method
= next_element_from_string
;
5100 it
->method
= next_element_from_buffer
;
5103 it
->current
.dpvec_index
= -1;
5105 /* Skip over characters which were displayed via IT->dpvec. */
5106 if (it
->dpvec_char_len
< 0)
5107 reseat_at_next_visible_line_start (it
, 1);
5108 else if (it
->dpvec_char_len
> 0)
5110 it
->len
= it
->dpvec_char_len
;
5111 set_iterator_to_next (it
, reseat_p
);
5115 else if (it
->method
== next_element_from_string
)
5117 /* Current display element is a character from a Lisp string. */
5118 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
5119 IT_STRING_BYTEPOS (*it
) += it
->len
;
5120 IT_STRING_CHARPOS (*it
) += 1;
5122 consider_string_end
:
5124 if (it
->current
.overlay_string_index
>= 0)
5126 /* IT->string is an overlay string. Advance to the
5127 next, if there is one. */
5128 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
5129 next_overlay_string (it
);
5133 /* IT->string is not an overlay string. If we reached
5134 its end, and there is something on IT->stack, proceed
5135 with what is on the stack. This can be either another
5136 string, this time an overlay string, or a buffer. */
5137 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
5141 if (!STRINGP (it
->string
))
5142 it
->method
= next_element_from_buffer
;
5144 goto consider_string_end
;
5148 else if (it
->method
== next_element_from_image
5149 || it
->method
== next_element_from_stretch
)
5151 /* The position etc with which we have to proceed are on
5152 the stack. The position may be at the end of a string,
5153 if the `display' property takes up the whole string. */
5156 if (STRINGP (it
->string
))
5158 it
->method
= next_element_from_string
;
5159 goto consider_string_end
;
5162 it
->method
= next_element_from_buffer
;
5165 /* There are no other methods defined, so this should be a bug. */
5168 xassert (it
->method
!= next_element_from_string
5169 || (STRINGP (it
->string
)
5170 && IT_STRING_CHARPOS (*it
) >= 0));
5174 /* Load IT's display element fields with information about the next
5175 display element which comes from a display table entry or from the
5176 result of translating a control character to one of the forms `^C'
5177 or `\003'. IT->dpvec holds the glyphs to return as characters. */
5180 next_element_from_display_vector (it
)
5184 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
5186 /* Remember the current face id in case glyphs specify faces.
5187 IT's face is restored in set_iterator_to_next. */
5188 it
->saved_face_id
= it
->face_id
;
5190 if (INTEGERP (*it
->dpvec
)
5191 && GLYPH_CHAR_VALID_P (XFASTINT (*it
->dpvec
)))
5196 g
= XFASTINT (it
->dpvec
[it
->current
.dpvec_index
]);
5197 it
->c
= FAST_GLYPH_CHAR (g
);
5198 it
->len
= CHAR_BYTES (it
->c
);
5200 /* The entry may contain a face id to use. Such a face id is
5201 the id of a Lisp face, not a realized face. A face id of
5202 zero means no face is specified. */
5203 lface_id
= FAST_GLYPH_FACE (g
);
5206 /* The function returns -1 if lface_id is invalid. */
5207 int face_id
= ascii_face_of_lisp_face (it
->f
, lface_id
);
5209 it
->face_id
= face_id
;
5213 /* Display table entry is invalid. Return a space. */
5214 it
->c
= ' ', it
->len
= 1;
5216 /* Don't change position and object of the iterator here. They are
5217 still the values of the character that had this display table
5218 entry or was translated, and that's what we want. */
5219 it
->what
= IT_CHARACTER
;
5224 /* Load IT with the next display element from Lisp string IT->string.
5225 IT->current.string_pos is the current position within the string.
5226 If IT->current.overlay_string_index >= 0, the Lisp string is an
5230 next_element_from_string (it
)
5233 struct text_pos position
;
5235 xassert (STRINGP (it
->string
));
5236 xassert (IT_STRING_CHARPOS (*it
) >= 0);
5237 position
= it
->current
.string_pos
;
5239 /* Time to check for invisible text? */
5240 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
5241 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
5245 /* Since a handler may have changed IT->method, we must
5247 return get_next_display_element (it
);
5250 if (it
->current
.overlay_string_index
>= 0)
5252 /* Get the next character from an overlay string. In overlay
5253 strings, There is no field width or padding with spaces to
5255 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
5260 else if (STRING_MULTIBYTE (it
->string
))
5262 int remaining
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
5263 const unsigned char *s
= (SDATA (it
->string
)
5264 + IT_STRING_BYTEPOS (*it
));
5265 it
->c
= string_char_and_length (s
, remaining
, &it
->len
);
5269 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
5275 /* Get the next character from a Lisp string that is not an
5276 overlay string. Such strings come from the mode line, for
5277 example. We may have to pad with spaces, or truncate the
5278 string. See also next_element_from_c_string. */
5279 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
5284 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
5286 /* Pad with spaces. */
5287 it
->c
= ' ', it
->len
= 1;
5288 CHARPOS (position
) = BYTEPOS (position
) = -1;
5290 else if (STRING_MULTIBYTE (it
->string
))
5292 int maxlen
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
5293 const unsigned char *s
= (SDATA (it
->string
)
5294 + IT_STRING_BYTEPOS (*it
));
5295 it
->c
= string_char_and_length (s
, maxlen
, &it
->len
);
5299 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
5304 /* Record what we have and where it came from. Note that we store a
5305 buffer position in IT->position although it could arguably be a
5307 it
->what
= IT_CHARACTER
;
5308 it
->object
= it
->string
;
5309 it
->position
= position
;
5314 /* Load IT with next display element from C string IT->s.
5315 IT->string_nchars is the maximum number of characters to return
5316 from the string. IT->end_charpos may be greater than
5317 IT->string_nchars when this function is called, in which case we
5318 may have to return padding spaces. Value is zero if end of string
5319 reached, including padding spaces. */
5322 next_element_from_c_string (it
)
5328 it
->what
= IT_CHARACTER
;
5329 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
5332 /* IT's position can be greater IT->string_nchars in case a field
5333 width or precision has been specified when the iterator was
5335 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
5337 /* End of the game. */
5341 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
5343 /* Pad with spaces. */
5344 it
->c
= ' ', it
->len
= 1;
5345 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
5347 else if (it
->multibyte_p
)
5349 /* Implementation note: The calls to strlen apparently aren't a
5350 performance problem because there is no noticeable performance
5351 difference between Emacs running in unibyte or multibyte mode. */
5352 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
5353 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
),
5357 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
5363 /* Set up IT to return characters from an ellipsis, if appropriate.
5364 The definition of the ellipsis glyphs may come from a display table
5365 entry. This function Fills IT with the first glyph from the
5366 ellipsis if an ellipsis is to be displayed. */
5369 next_element_from_ellipsis (it
)
5372 if (it
->selective_display_ellipsis_p
)
5374 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
5376 /* Use the display table definition for `...'. Invalid glyphs
5377 will be handled by the method returning elements from dpvec. */
5378 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
5379 it
->dpvec_char_len
= it
->len
;
5380 it
->dpvec
= v
->contents
;
5381 it
->dpend
= v
->contents
+ v
->size
;
5382 it
->current
.dpvec_index
= 0;
5383 it
->method
= next_element_from_display_vector
;
5387 /* Use default `...' which is stored in default_invis_vector. */
5388 it
->dpvec_char_len
= it
->len
;
5389 it
->dpvec
= default_invis_vector
;
5390 it
->dpend
= default_invis_vector
+ 3;
5391 it
->current
.dpvec_index
= 0;
5392 it
->method
= next_element_from_display_vector
;
5397 /* The face at the current position may be different from the
5398 face we find after the invisible text. Remember what it
5399 was in IT->saved_face_id, and signal that it's there by
5400 setting face_before_selective_p. */
5401 it
->saved_face_id
= it
->face_id
;
5402 it
->method
= next_element_from_buffer
;
5403 reseat_at_next_visible_line_start (it
, 1);
5404 it
->face_before_selective_p
= 1;
5407 return get_next_display_element (it
);
5411 /* Deliver an image display element. The iterator IT is already
5412 filled with image information (done in handle_display_prop). Value
5417 next_element_from_image (it
)
5420 it
->what
= IT_IMAGE
;
5425 /* Fill iterator IT with next display element from a stretch glyph
5426 property. IT->object is the value of the text property. Value is
5430 next_element_from_stretch (it
)
5433 it
->what
= IT_STRETCH
;
5438 /* Load IT with the next display element from current_buffer. Value
5439 is zero if end of buffer reached. IT->stop_charpos is the next
5440 position at which to stop and check for text properties or buffer
5444 next_element_from_buffer (it
)
5449 /* Check this assumption, otherwise, we would never enter the
5450 if-statement, below. */
5451 xassert (IT_CHARPOS (*it
) >= BEGV
5452 && IT_CHARPOS (*it
) <= it
->stop_charpos
);
5454 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
5456 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
5458 int overlay_strings_follow_p
;
5460 /* End of the game, except when overlay strings follow that
5461 haven't been returned yet. */
5462 if (it
->overlay_strings_at_end_processed_p
)
5463 overlay_strings_follow_p
= 0;
5466 it
->overlay_strings_at_end_processed_p
= 1;
5467 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
5470 if (overlay_strings_follow_p
)
5471 success_p
= get_next_display_element (it
);
5475 it
->position
= it
->current
.pos
;
5482 return get_next_display_element (it
);
5487 /* No face changes, overlays etc. in sight, so just return a
5488 character from current_buffer. */
5491 /* Maybe run the redisplay end trigger hook. Performance note:
5492 This doesn't seem to cost measurable time. */
5493 if (it
->redisplay_end_trigger_charpos
5495 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
5496 run_redisplay_end_trigger_hook (it
);
5498 /* Get the next character, maybe multibyte. */
5499 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
5500 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
5502 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT_BYTE
? ZV_BYTE
: GPT_BYTE
)
5503 - IT_BYTEPOS (*it
));
5504 it
->c
= string_char_and_length (p
, maxlen
, &it
->len
);
5507 it
->c
= *p
, it
->len
= 1;
5509 /* Record what we have and where it came from. */
5510 it
->what
= IT_CHARACTER
;;
5511 it
->object
= it
->w
->buffer
;
5512 it
->position
= it
->current
.pos
;
5514 /* Normally we return the character found above, except when we
5515 really want to return an ellipsis for selective display. */
5520 /* A value of selective > 0 means hide lines indented more
5521 than that number of columns. */
5522 if (it
->selective
> 0
5523 && IT_CHARPOS (*it
) + 1 < ZV
5524 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
5525 IT_BYTEPOS (*it
) + 1,
5526 (double) it
->selective
)) /* iftc */
5528 success_p
= next_element_from_ellipsis (it
);
5529 it
->dpvec_char_len
= -1;
5532 else if (it
->c
== '\r' && it
->selective
== -1)
5534 /* A value of selective == -1 means that everything from the
5535 CR to the end of the line is invisible, with maybe an
5536 ellipsis displayed for it. */
5537 success_p
= next_element_from_ellipsis (it
);
5538 it
->dpvec_char_len
= -1;
5543 /* Value is zero if end of buffer reached. */
5544 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
5549 /* Run the redisplay end trigger hook for IT. */
5552 run_redisplay_end_trigger_hook (it
)
5555 Lisp_Object args
[3];
5557 /* IT->glyph_row should be non-null, i.e. we should be actually
5558 displaying something, or otherwise we should not run the hook. */
5559 xassert (it
->glyph_row
);
5561 /* Set up hook arguments. */
5562 args
[0] = Qredisplay_end_trigger_functions
;
5563 args
[1] = it
->window
;
5564 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
5565 it
->redisplay_end_trigger_charpos
= 0;
5567 /* Since we are *trying* to run these functions, don't try to run
5568 them again, even if they get an error. */
5569 it
->w
->redisplay_end_trigger
= Qnil
;
5570 Frun_hook_with_args (3, args
);
5572 /* Notice if it changed the face of the character we are on. */
5573 handle_face_prop (it
);
5577 /* Deliver a composition display element. The iterator IT is already
5578 filled with composition information (done in
5579 handle_composition_prop). Value is always 1. */
5582 next_element_from_composition (it
)
5585 it
->what
= IT_COMPOSITION
;
5586 it
->position
= (STRINGP (it
->string
)
5587 ? it
->current
.string_pos
5594 /***********************************************************************
5595 Moving an iterator without producing glyphs
5596 ***********************************************************************/
5598 /* Move iterator IT to a specified buffer or X position within one
5599 line on the display without producing glyphs.
5601 OP should be a bit mask including some or all of these bits:
5602 MOVE_TO_X: Stop on reaching x-position TO_X.
5603 MOVE_TO_POS: Stop on reaching buffer or string position TO_CHARPOS.
5604 Regardless of OP's value, stop in reaching the end of the display line.
5606 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
5607 This means, in particular, that TO_X includes window's horizontal
5610 The return value has several possible values that
5611 say what condition caused the scan to stop:
5613 MOVE_POS_MATCH_OR_ZV
5614 - when TO_POS or ZV was reached.
5617 -when TO_X was reached before TO_POS or ZV were reached.
5620 - when we reached the end of the display area and the line must
5624 - when we reached the end of the display area and the line is
5628 - when we stopped at a line end, i.e. a newline or a CR and selective
5631 static enum move_it_result
5632 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
)
5634 int to_charpos
, to_x
, op
;
5636 enum move_it_result result
= MOVE_UNDEFINED
;
5637 struct glyph_row
*saved_glyph_row
;
5639 /* Don't produce glyphs in produce_glyphs. */
5640 saved_glyph_row
= it
->glyph_row
;
5641 it
->glyph_row
= NULL
;
5643 #define BUFFER_POS_REACHED_P() \
5644 ((op & MOVE_TO_POS) != 0 \
5645 && BUFFERP (it->object) \
5646 && IT_CHARPOS (*it) >= to_charpos)
5650 int x
, i
, ascent
= 0, descent
= 0;
5652 /* Stop when ZV or TO_CHARPOS reached. */
5653 if (!get_next_display_element (it
)
5654 || BUFFER_POS_REACHED_P ())
5656 result
= MOVE_POS_MATCH_OR_ZV
;
5660 /* The call to produce_glyphs will get the metrics of the
5661 display element IT is loaded with. We record in x the
5662 x-position before this display element in case it does not
5666 /* Remember the line height so far in case the next element doesn't
5668 if (!it
->truncate_lines_p
)
5670 ascent
= it
->max_ascent
;
5671 descent
= it
->max_descent
;
5674 PRODUCE_GLYPHS (it
);
5676 if (it
->area
!= TEXT_AREA
)
5678 set_iterator_to_next (it
, 1);
5682 /* The number of glyphs we get back in IT->nglyphs will normally
5683 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
5684 character on a terminal frame, or (iii) a line end. For the
5685 second case, IT->nglyphs - 1 padding glyphs will be present
5686 (on X frames, there is only one glyph produced for a
5687 composite character.
5689 The behavior implemented below means, for continuation lines,
5690 that as many spaces of a TAB as fit on the current line are
5691 displayed there. For terminal frames, as many glyphs of a
5692 multi-glyph character are displayed in the current line, too.
5693 This is what the old redisplay code did, and we keep it that
5694 way. Under X, the whole shape of a complex character must
5695 fit on the line or it will be completely displayed in the
5698 Note that both for tabs and padding glyphs, all glyphs have
5702 /* More than one glyph or glyph doesn't fit on line. All
5703 glyphs have the same width. */
5704 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
5707 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
5709 new_x
= x
+ single_glyph_width
;
5711 /* We want to leave anything reaching TO_X to the caller. */
5712 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
5715 result
= MOVE_X_REACHED
;
5718 else if (/* Lines are continued. */
5719 !it
->truncate_lines_p
5720 && (/* And glyph doesn't fit on the line. */
5721 new_x
> it
->last_visible_x
5722 /* Or it fits exactly and we're on a window
5724 || (new_x
== it
->last_visible_x
5725 && FRAME_WINDOW_P (it
->f
))))
5727 if (/* IT->hpos == 0 means the very first glyph
5728 doesn't fit on the line, e.g. a wide image. */
5730 || (new_x
== it
->last_visible_x
5731 && FRAME_WINDOW_P (it
->f
)))
5734 it
->current_x
= new_x
;
5735 if (i
== it
->nglyphs
- 1)
5737 set_iterator_to_next (it
, 1);
5738 #ifdef HAVE_WINDOW_SYSTEM
5739 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
5741 if (!get_next_display_element (it
)
5742 || BUFFER_POS_REACHED_P ())
5744 result
= MOVE_POS_MATCH_OR_ZV
;
5747 if (ITERATOR_AT_END_OF_LINE_P (it
))
5749 result
= MOVE_NEWLINE_OR_CR
;
5753 #endif /* HAVE_WINDOW_SYSTEM */
5759 it
->max_ascent
= ascent
;
5760 it
->max_descent
= descent
;
5763 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
5765 result
= MOVE_LINE_CONTINUED
;
5768 else if (new_x
> it
->first_visible_x
)
5770 /* Glyph is visible. Increment number of glyphs that
5771 would be displayed. */
5776 /* Glyph is completely off the left margin of the display
5777 area. Nothing to do. */
5781 if (result
!= MOVE_UNDEFINED
)
5784 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
5786 /* Stop when TO_X specified and reached. This check is
5787 necessary here because of lines consisting of a line end,
5788 only. The line end will not produce any glyphs and we
5789 would never get MOVE_X_REACHED. */
5790 xassert (it
->nglyphs
== 0);
5791 result
= MOVE_X_REACHED
;
5795 /* Is this a line end? If yes, we're done. */
5796 if (ITERATOR_AT_END_OF_LINE_P (it
))
5798 result
= MOVE_NEWLINE_OR_CR
;
5802 /* The current display element has been consumed. Advance
5804 set_iterator_to_next (it
, 1);
5806 /* Stop if lines are truncated and IT's current x-position is
5807 past the right edge of the window now. */
5808 if (it
->truncate_lines_p
5809 && it
->current_x
>= it
->last_visible_x
)
5811 #ifdef HAVE_WINDOW_SYSTEM
5812 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
5814 if (!get_next_display_element (it
)
5815 || BUFFER_POS_REACHED_P ())
5817 result
= MOVE_POS_MATCH_OR_ZV
;
5820 if (ITERATOR_AT_END_OF_LINE_P (it
))
5822 result
= MOVE_NEWLINE_OR_CR
;
5826 #endif /* HAVE_WINDOW_SYSTEM */
5827 result
= MOVE_LINE_TRUNCATED
;
5832 #undef BUFFER_POS_REACHED_P
5834 /* Restore the iterator settings altered at the beginning of this
5836 it
->glyph_row
= saved_glyph_row
;
5841 /* Move IT forward until it satisfies one or more of the criteria in
5842 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
5844 OP is a bit-mask that specifies where to stop, and in particular,
5845 which of those four position arguments makes a difference. See the
5846 description of enum move_operation_enum.
5848 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
5849 screen line, this function will set IT to the next position >
5853 move_it_to (it
, to_charpos
, to_x
, to_y
, to_vpos
, op
)
5855 int to_charpos
, to_x
, to_y
, to_vpos
;
5858 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
5864 if (op
& MOVE_TO_VPOS
)
5866 /* If no TO_CHARPOS and no TO_X specified, stop at the
5867 start of the line TO_VPOS. */
5868 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
5870 if (it
->vpos
== to_vpos
)
5876 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
5880 /* TO_VPOS >= 0 means stop at TO_X in the line at
5881 TO_VPOS, or at TO_POS, whichever comes first. */
5882 if (it
->vpos
== to_vpos
)
5888 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
5890 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
5895 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
5897 /* We have reached TO_X but not in the line we want. */
5898 skip
= move_it_in_display_line_to (it
, to_charpos
,
5900 if (skip
== MOVE_POS_MATCH_OR_ZV
)
5908 else if (op
& MOVE_TO_Y
)
5910 struct it it_backup
;
5912 /* TO_Y specified means stop at TO_X in the line containing
5913 TO_Y---or at TO_CHARPOS if this is reached first. The
5914 problem is that we can't really tell whether the line
5915 contains TO_Y before we have completely scanned it, and
5916 this may skip past TO_X. What we do is to first scan to
5919 If TO_X is not specified, use a TO_X of zero. The reason
5920 is to make the outcome of this function more predictable.
5921 If we didn't use TO_X == 0, we would stop at the end of
5922 the line which is probably not what a caller would expect
5924 skip
= move_it_in_display_line_to (it
, to_charpos
,
5928 | (op
& MOVE_TO_POS
)));
5930 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
5931 if (skip
== MOVE_POS_MATCH_OR_ZV
)
5937 /* If TO_X was reached, we would like to know whether TO_Y
5938 is in the line. This can only be said if we know the
5939 total line height which requires us to scan the rest of
5941 if (skip
== MOVE_X_REACHED
)
5944 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
5945 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
5947 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
5950 /* Now, decide whether TO_Y is in this line. */
5951 line_height
= it
->max_ascent
+ it
->max_descent
;
5952 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
5954 if (to_y
>= it
->current_y
5955 && to_y
< it
->current_y
+ line_height
)
5957 if (skip
== MOVE_X_REACHED
)
5958 /* If TO_Y is in this line and TO_X was reached above,
5959 we scanned too far. We have to restore IT's settings
5960 to the ones before skipping. */
5964 else if (skip
== MOVE_X_REACHED
)
5967 if (skip
== MOVE_POS_MATCH_OR_ZV
)
5975 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
5979 case MOVE_POS_MATCH_OR_ZV
:
5983 case MOVE_NEWLINE_OR_CR
:
5984 set_iterator_to_next (it
, 1);
5985 it
->continuation_lines_width
= 0;
5988 case MOVE_LINE_TRUNCATED
:
5989 it
->continuation_lines_width
= 0;
5990 reseat_at_next_visible_line_start (it
, 0);
5991 if ((op
& MOVE_TO_POS
) != 0
5992 && IT_CHARPOS (*it
) > to_charpos
)
5999 case MOVE_LINE_CONTINUED
:
6000 it
->continuation_lines_width
+= it
->current_x
;
6007 /* Reset/increment for the next run. */
6008 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
6009 it
->current_x
= it
->hpos
= 0;
6010 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
6012 last_height
= it
->max_ascent
+ it
->max_descent
;
6013 last_max_ascent
= it
->max_ascent
;
6014 it
->max_ascent
= it
->max_descent
= 0;
6019 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
6023 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
6025 If DY > 0, move IT backward at least that many pixels. DY = 0
6026 means move IT backward to the preceding line start or BEGV. This
6027 function may move over more than DY pixels if IT->current_y - DY
6028 ends up in the middle of a line; in this case IT->current_y will be
6029 set to the top of the line moved to. */
6032 move_it_vertically_backward (it
, dy
)
6038 int start_pos
= IT_CHARPOS (*it
);
6042 /* Estimate how many newlines we must move back. */
6043 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
6045 /* Set the iterator's position that many lines back. */
6046 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
6047 back_to_previous_visible_line_start (it
);
6049 /* Reseat the iterator here. When moving backward, we don't want
6050 reseat to skip forward over invisible text, set up the iterator
6051 to deliver from overlay strings at the new position etc. So,
6052 use reseat_1 here. */
6053 reseat_1 (it
, it
->current
.pos
, 1);
6055 /* We are now surely at a line start. */
6056 it
->current_x
= it
->hpos
= 0;
6057 it
->continuation_lines_width
= 0;
6059 /* Move forward and see what y-distance we moved. First move to the
6060 start of the next line so that we get its height. We need this
6061 height to be able to tell whether we reached the specified
6064 it2
.max_ascent
= it2
.max_descent
= 0;
6065 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
6066 MOVE_TO_POS
| MOVE_TO_VPOS
);
6067 xassert (IT_CHARPOS (*it
) >= BEGV
);
6070 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
6071 xassert (IT_CHARPOS (*it
) >= BEGV
);
6072 /* H is the actual vertical distance from the position in *IT
6073 and the starting position. */
6074 h
= it2
.current_y
- it
->current_y
;
6075 /* NLINES is the distance in number of lines. */
6076 nlines
= it2
.vpos
- it
->vpos
;
6078 /* Correct IT's y and vpos position
6079 so that they are relative to the starting point. */
6085 /* DY == 0 means move to the start of the screen line. The
6086 value of nlines is > 0 if continuation lines were involved. */
6088 move_it_by_lines (it
, nlines
, 1);
6089 xassert (IT_CHARPOS (*it
) <= start_pos
);
6093 /* The y-position we try to reach, relative to *IT.
6094 Note that H has been subtracted in front of the if-statement. */
6095 int target_y
= it
->current_y
+ h
- dy
;
6096 int y0
= it3
.current_y
;
6097 int y1
= line_bottom_y (&it3
);
6098 int line_height
= y1
- y0
;
6100 /* If we did not reach target_y, try to move further backward if
6101 we can. If we moved too far backward, try to move forward. */
6102 if (target_y
< it
->current_y
6103 /* This is heuristic. In a window that's 3 lines high, with
6104 a line height of 13 pixels each, recentering with point
6105 on the bottom line will try to move -39/2 = 19 pixels
6106 backward. Try to avoid moving into the first line. */
6107 && it
->current_y
- target_y
> line_height
/ 3 * 2
6108 && IT_CHARPOS (*it
) > BEGV
)
6110 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
6111 target_y
- it
->current_y
));
6112 move_it_vertically (it
, target_y
- it
->current_y
);
6113 xassert (IT_CHARPOS (*it
) >= BEGV
);
6115 else if (target_y
>= it
->current_y
+ line_height
6116 && IT_CHARPOS (*it
) < ZV
)
6118 /* Should move forward by at least one line, maybe more.
6120 Note: Calling move_it_by_lines can be expensive on
6121 terminal frames, where compute_motion is used (via
6122 vmotion) to do the job, when there are very long lines
6123 and truncate-lines is nil. That's the reason for
6124 treating terminal frames specially here. */
6126 if (!FRAME_WINDOW_P (it
->f
))
6127 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
6132 move_it_by_lines (it
, 1, 1);
6134 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
6137 xassert (IT_CHARPOS (*it
) >= BEGV
);
6143 /* Move IT by a specified amount of pixel lines DY. DY negative means
6144 move backwards. DY = 0 means move to start of screen line. At the
6145 end, IT will be on the start of a screen line. */
6148 move_it_vertically (it
, dy
)
6153 move_it_vertically_backward (it
, -dy
);
6156 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
6157 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
6158 MOVE_TO_POS
| MOVE_TO_Y
);
6159 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
6161 /* If buffer ends in ZV without a newline, move to the start of
6162 the line to satisfy the post-condition. */
6163 if (IT_CHARPOS (*it
) == ZV
6164 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
6165 move_it_by_lines (it
, 0, 0);
6170 /* Move iterator IT past the end of the text line it is in. */
6173 move_it_past_eol (it
)
6176 enum move_it_result rc
;
6178 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
6179 if (rc
== MOVE_NEWLINE_OR_CR
)
6180 set_iterator_to_next (it
, 0);
6184 #if 0 /* Currently not used. */
6186 /* Return non-zero if some text between buffer positions START_CHARPOS
6187 and END_CHARPOS is invisible. IT->window is the window for text
6191 invisible_text_between_p (it
, start_charpos
, end_charpos
)
6193 int start_charpos
, end_charpos
;
6195 Lisp_Object prop
, limit
;
6196 int invisible_found_p
;
6198 xassert (it
!= NULL
&& start_charpos
<= end_charpos
);
6200 /* Is text at START invisible? */
6201 prop
= Fget_char_property (make_number (start_charpos
), Qinvisible
,
6203 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6204 invisible_found_p
= 1;
6207 limit
= Fnext_single_char_property_change (make_number (start_charpos
),
6209 make_number (end_charpos
));
6210 invisible_found_p
= XFASTINT (limit
) < end_charpos
;
6213 return invisible_found_p
;
6219 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
6220 negative means move up. DVPOS == 0 means move to the start of the
6221 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
6222 NEED_Y_P is zero, IT->current_y will be left unchanged.
6224 Further optimization ideas: If we would know that IT->f doesn't use
6225 a face with proportional font, we could be faster for
6226 truncate-lines nil. */
6229 move_it_by_lines (it
, dvpos
, need_y_p
)
6231 int dvpos
, need_y_p
;
6233 struct position pos
;
6235 if (!FRAME_WINDOW_P (it
->f
))
6237 struct text_pos textpos
;
6239 /* We can use vmotion on frames without proportional fonts. */
6240 pos
= *vmotion (IT_CHARPOS (*it
), dvpos
, it
->w
);
6241 SET_TEXT_POS (textpos
, pos
.bufpos
, pos
.bytepos
);
6242 reseat (it
, textpos
, 1);
6243 it
->vpos
+= pos
.vpos
;
6244 it
->current_y
+= pos
.vpos
;
6246 else if (dvpos
== 0)
6248 /* DVPOS == 0 means move to the start of the screen line. */
6249 move_it_vertically_backward (it
, 0);
6250 xassert (it
->current_x
== 0 && it
->hpos
== 0);
6253 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
6257 int start_charpos
, i
;
6259 /* Start at the beginning of the screen line containing IT's
6261 move_it_vertically_backward (it
, 0);
6263 /* Go back -DVPOS visible lines and reseat the iterator there. */
6264 start_charpos
= IT_CHARPOS (*it
);
6265 for (i
= -dvpos
; i
&& IT_CHARPOS (*it
) > BEGV
; --i
)
6266 back_to_previous_visible_line_start (it
);
6267 reseat (it
, it
->current
.pos
, 1);
6268 it
->current_x
= it
->hpos
= 0;
6270 /* Above call may have moved too far if continuation lines
6271 are involved. Scan forward and see if it did. */
6273 it2
.vpos
= it2
.current_y
= 0;
6274 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
6275 it
->vpos
-= it2
.vpos
;
6276 it
->current_y
-= it2
.current_y
;
6277 it
->current_x
= it
->hpos
= 0;
6279 /* If we moved too far, move IT some lines forward. */
6280 if (it2
.vpos
> -dvpos
)
6282 int delta
= it2
.vpos
+ dvpos
;
6283 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
6288 /* Return 1 if IT points into the middle of a display vector. */
6291 in_display_vector_p (it
)
6294 return (it
->method
== next_element_from_display_vector
6295 && it
->current
.dpvec_index
> 0
6296 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
6300 /***********************************************************************
6302 ***********************************************************************/
6305 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
6309 add_to_log (format
, arg1
, arg2
)
6311 Lisp_Object arg1
, arg2
;
6313 Lisp_Object args
[3];
6314 Lisp_Object msg
, fmt
;
6317 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
6320 /* Do nothing if called asynchronously. Inserting text into
6321 a buffer may call after-change-functions and alike and
6322 that would means running Lisp asynchronously. */
6323 if (handling_signal
)
6327 GCPRO4 (fmt
, msg
, arg1
, arg2
);
6329 args
[0] = fmt
= build_string (format
);
6332 msg
= Fformat (3, args
);
6334 len
= SBYTES (msg
) + 1;
6335 SAFE_ALLOCA (buffer
, char *, len
);
6336 bcopy (SDATA (msg
), buffer
, len
);
6338 message_dolog (buffer
, len
- 1, 1, 0);
6345 /* Output a newline in the *Messages* buffer if "needs" one. */
6348 message_log_maybe_newline ()
6350 if (message_log_need_newline
)
6351 message_dolog ("", 0, 1, 0);
6355 /* Add a string M of length NBYTES to the message log, optionally
6356 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
6357 nonzero, means interpret the contents of M as multibyte. This
6358 function calls low-level routines in order to bypass text property
6359 hooks, etc. which might not be safe to run. */
6362 message_dolog (m
, nbytes
, nlflag
, multibyte
)
6364 int nbytes
, nlflag
, multibyte
;
6366 if (!NILP (Vmemory_full
))
6369 if (!NILP (Vmessage_log_max
))
6371 struct buffer
*oldbuf
;
6372 Lisp_Object oldpoint
, oldbegv
, oldzv
;
6373 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
6374 int point_at_end
= 0;
6376 Lisp_Object old_deactivate_mark
, tem
;
6377 struct gcpro gcpro1
;
6379 old_deactivate_mark
= Vdeactivate_mark
;
6380 oldbuf
= current_buffer
;
6381 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
6382 current_buffer
->undo_list
= Qt
;
6384 oldpoint
= message_dolog_marker1
;
6385 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
6386 oldbegv
= message_dolog_marker2
;
6387 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
6388 oldzv
= message_dolog_marker3
;
6389 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
6390 GCPRO1 (old_deactivate_mark
);
6398 BEGV_BYTE
= BEG_BYTE
;
6401 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
6403 /* Insert the string--maybe converting multibyte to single byte
6404 or vice versa, so that all the text fits the buffer. */
6406 && NILP (current_buffer
->enable_multibyte_characters
))
6408 int i
, c
, char_bytes
;
6409 unsigned char work
[1];
6411 /* Convert a multibyte string to single-byte
6412 for the *Message* buffer. */
6413 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
6415 c
= string_char_and_length (m
+ i
, nbytes
- i
, &char_bytes
);
6416 work
[0] = (SINGLE_BYTE_CHAR_P (c
)
6418 : multibyte_char_to_unibyte (c
, Qnil
));
6419 insert_1_both (work
, 1, 1, 1, 0, 0);
6422 else if (! multibyte
6423 && ! NILP (current_buffer
->enable_multibyte_characters
))
6425 int i
, c
, char_bytes
;
6426 unsigned char *msg
= (unsigned char *) m
;
6427 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
6428 /* Convert a single-byte string to multibyte
6429 for the *Message* buffer. */
6430 for (i
= 0; i
< nbytes
; i
++)
6432 c
= unibyte_char_to_multibyte (msg
[i
]);
6433 char_bytes
= CHAR_STRING (c
, str
);
6434 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
6438 insert_1 (m
, nbytes
, 1, 0, 0);
6442 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
6443 insert_1 ("\n", 1, 1, 0, 0);
6445 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
6447 this_bol_byte
= PT_BYTE
;
6449 /* See if this line duplicates the previous one.
6450 If so, combine duplicates. */
6453 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
6455 prev_bol_byte
= PT_BYTE
;
6457 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
6458 this_bol
, this_bol_byte
);
6461 del_range_both (prev_bol
, prev_bol_byte
,
6462 this_bol
, this_bol_byte
, 0);
6468 /* If you change this format, don't forget to also
6469 change message_log_check_duplicate. */
6470 sprintf (dupstr
, " [%d times]", dup
);
6471 duplen
= strlen (dupstr
);
6472 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
6473 insert_1 (dupstr
, duplen
, 1, 0, 1);
6478 /* If we have more than the desired maximum number of lines
6479 in the *Messages* buffer now, delete the oldest ones.
6480 This is safe because we don't have undo in this buffer. */
6482 if (NATNUMP (Vmessage_log_max
))
6484 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
6485 -XFASTINT (Vmessage_log_max
) - 1, 0);
6486 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
6489 BEGV
= XMARKER (oldbegv
)->charpos
;
6490 BEGV_BYTE
= marker_byte_position (oldbegv
);
6499 ZV
= XMARKER (oldzv
)->charpos
;
6500 ZV_BYTE
= marker_byte_position (oldzv
);
6504 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
6506 /* We can't do Fgoto_char (oldpoint) because it will run some
6508 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
6509 XMARKER (oldpoint
)->bytepos
);
6512 unchain_marker (XMARKER (oldpoint
));
6513 unchain_marker (XMARKER (oldbegv
));
6514 unchain_marker (XMARKER (oldzv
));
6516 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
6517 set_buffer_internal (oldbuf
);
6519 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
6520 message_log_need_newline
= !nlflag
;
6521 Vdeactivate_mark
= old_deactivate_mark
;
6526 /* We are at the end of the buffer after just having inserted a newline.
6527 (Note: We depend on the fact we won't be crossing the gap.)
6528 Check to see if the most recent message looks a lot like the previous one.
6529 Return 0 if different, 1 if the new one should just replace it, or a
6530 value N > 1 if we should also append " [N times]". */
6533 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
6534 int prev_bol
, this_bol
;
6535 int prev_bol_byte
, this_bol_byte
;
6538 int len
= Z_BYTE
- 1 - this_bol_byte
;
6540 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
6541 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
6543 for (i
= 0; i
< len
; i
++)
6545 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
6553 if (*p1
++ == ' ' && *p1
++ == '[')
6556 while (*p1
>= '0' && *p1
<= '9')
6557 n
= n
* 10 + *p1
++ - '0';
6558 if (strncmp (p1
, " times]\n", 8) == 0)
6565 /* Display an echo area message M with a specified length of NBYTES
6566 bytes. The string may include null characters. If M is 0, clear
6567 out any existing message, and let the mini-buffer text show
6570 The buffer M must continue to exist until after the echo area gets
6571 cleared or some other message gets displayed there. This means do
6572 not pass text that is stored in a Lisp string; do not pass text in
6573 a buffer that was alloca'd. */
6576 message2 (m
, nbytes
, multibyte
)
6581 /* First flush out any partial line written with print. */
6582 message_log_maybe_newline ();
6584 message_dolog (m
, nbytes
, 1, multibyte
);
6585 message2_nolog (m
, nbytes
, multibyte
);
6589 /* The non-logging counterpart of message2. */
6592 message2_nolog (m
, nbytes
, multibyte
)
6594 int nbytes
, multibyte
;
6596 struct frame
*sf
= SELECTED_FRAME ();
6597 message_enable_multibyte
= multibyte
;
6601 if (noninteractive_need_newline
)
6602 putc ('\n', stderr
);
6603 noninteractive_need_newline
= 0;
6605 fwrite (m
, nbytes
, 1, stderr
);
6606 if (cursor_in_echo_area
== 0)
6607 fprintf (stderr
, "\n");
6610 /* A null message buffer means that the frame hasn't really been
6611 initialized yet. Error messages get reported properly by
6612 cmd_error, so this must be just an informative message; toss it. */
6613 else if (INTERACTIVE
6614 && sf
->glyphs_initialized_p
6615 && FRAME_MESSAGE_BUF (sf
))
6617 Lisp_Object mini_window
;
6620 /* Get the frame containing the mini-buffer
6621 that the selected frame is using. */
6622 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
6623 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
6625 FRAME_SAMPLE_VISIBILITY (f
);
6626 if (FRAME_VISIBLE_P (sf
)
6627 && ! FRAME_VISIBLE_P (f
))
6628 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
6632 set_message (m
, Qnil
, nbytes
, multibyte
);
6633 if (minibuffer_auto_raise
)
6634 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
6637 clear_message (1, 1);
6639 do_pending_window_change (0);
6640 echo_area_display (1);
6641 do_pending_window_change (0);
6642 if (frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
6643 (*frame_up_to_date_hook
) (f
);
6648 /* Display an echo area message M with a specified length of NBYTES
6649 bytes. The string may include null characters. If M is not a
6650 string, clear out any existing message, and let the mini-buffer
6651 text show through. */
6654 message3 (m
, nbytes
, multibyte
)
6659 struct gcpro gcpro1
;
6663 /* First flush out any partial line written with print. */
6664 message_log_maybe_newline ();
6666 message_dolog (SDATA (m
), nbytes
, 1, multibyte
);
6667 message3_nolog (m
, nbytes
, multibyte
);
6673 /* The non-logging version of message3. */
6676 message3_nolog (m
, nbytes
, multibyte
)
6678 int nbytes
, multibyte
;
6680 struct frame
*sf
= SELECTED_FRAME ();
6681 message_enable_multibyte
= multibyte
;
6685 if (noninteractive_need_newline
)
6686 putc ('\n', stderr
);
6687 noninteractive_need_newline
= 0;
6689 fwrite (SDATA (m
), nbytes
, 1, stderr
);
6690 if (cursor_in_echo_area
== 0)
6691 fprintf (stderr
, "\n");
6694 /* A null message buffer means that the frame hasn't really been
6695 initialized yet. Error messages get reported properly by
6696 cmd_error, so this must be just an informative message; toss it. */
6697 else if (INTERACTIVE
6698 && sf
->glyphs_initialized_p
6699 && FRAME_MESSAGE_BUF (sf
))
6701 Lisp_Object mini_window
;
6705 /* Get the frame containing the mini-buffer
6706 that the selected frame is using. */
6707 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
6708 frame
= XWINDOW (mini_window
)->frame
;
6711 FRAME_SAMPLE_VISIBILITY (f
);
6712 if (FRAME_VISIBLE_P (sf
)
6713 && !FRAME_VISIBLE_P (f
))
6714 Fmake_frame_visible (frame
);
6716 if (STRINGP (m
) && SCHARS (m
) > 0)
6718 set_message (NULL
, m
, nbytes
, multibyte
);
6719 if (minibuffer_auto_raise
)
6720 Fraise_frame (frame
);
6723 clear_message (1, 1);
6725 do_pending_window_change (0);
6726 echo_area_display (1);
6727 do_pending_window_change (0);
6728 if (frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
6729 (*frame_up_to_date_hook
) (f
);
6734 /* Display a null-terminated echo area message M. If M is 0, clear
6735 out any existing message, and let the mini-buffer text show through.
6737 The buffer M must continue to exist until after the echo area gets
6738 cleared or some other message gets displayed there. Do not pass
6739 text that is stored in a Lisp string. Do not pass text in a buffer
6740 that was alloca'd. */
6746 message2 (m
, (m
? strlen (m
) : 0), 0);
6750 /* The non-logging counterpart of message1. */
6756 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
6759 /* Display a message M which contains a single %s
6760 which gets replaced with STRING. */
6763 message_with_string (m
, string
, log
)
6768 CHECK_STRING (string
);
6774 if (noninteractive_need_newline
)
6775 putc ('\n', stderr
);
6776 noninteractive_need_newline
= 0;
6777 fprintf (stderr
, m
, SDATA (string
));
6778 if (cursor_in_echo_area
== 0)
6779 fprintf (stderr
, "\n");
6783 else if (INTERACTIVE
)
6785 /* The frame whose minibuffer we're going to display the message on.
6786 It may be larger than the selected frame, so we need
6787 to use its buffer, not the selected frame's buffer. */
6788 Lisp_Object mini_window
;
6789 struct frame
*f
, *sf
= SELECTED_FRAME ();
6791 /* Get the frame containing the minibuffer
6792 that the selected frame is using. */
6793 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
6794 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
6796 /* A null message buffer means that the frame hasn't really been
6797 initialized yet. Error messages get reported properly by
6798 cmd_error, so this must be just an informative message; toss it. */
6799 if (FRAME_MESSAGE_BUF (f
))
6801 Lisp_Object args
[2], message
;
6802 struct gcpro gcpro1
, gcpro2
;
6804 args
[0] = build_string (m
);
6805 args
[1] = message
= string
;
6806 GCPRO2 (args
[0], message
);
6809 message
= Fformat (2, args
);
6812 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
6814 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
6818 /* Print should start at the beginning of the message
6819 buffer next time. */
6820 message_buf_print
= 0;
6826 /* Dump an informative message to the minibuf. If M is 0, clear out
6827 any existing message, and let the mini-buffer text show through. */
6831 message (m
, a1
, a2
, a3
)
6833 EMACS_INT a1
, a2
, a3
;
6839 if (noninteractive_need_newline
)
6840 putc ('\n', stderr
);
6841 noninteractive_need_newline
= 0;
6842 fprintf (stderr
, m
, a1
, a2
, a3
);
6843 if (cursor_in_echo_area
== 0)
6844 fprintf (stderr
, "\n");
6848 else if (INTERACTIVE
)
6850 /* The frame whose mini-buffer we're going to display the message
6851 on. It may be larger than the selected frame, so we need to
6852 use its buffer, not the selected frame's buffer. */
6853 Lisp_Object mini_window
;
6854 struct frame
*f
, *sf
= SELECTED_FRAME ();
6856 /* Get the frame containing the mini-buffer
6857 that the selected frame is using. */
6858 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
6859 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
6861 /* A null message buffer means that the frame hasn't really been
6862 initialized yet. Error messages get reported properly by
6863 cmd_error, so this must be just an informative message; toss
6865 if (FRAME_MESSAGE_BUF (f
))
6876 len
= doprnt (FRAME_MESSAGE_BUF (f
),
6877 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
6879 len
= doprnt (FRAME_MESSAGE_BUF (f
),
6880 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3,
6882 #endif /* NO_ARG_ARRAY */
6884 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
6889 /* Print should start at the beginning of the message
6890 buffer next time. */
6891 message_buf_print
= 0;
6897 /* The non-logging version of message. */
6900 message_nolog (m
, a1
, a2
, a3
)
6902 EMACS_INT a1
, a2
, a3
;
6904 Lisp_Object old_log_max
;
6905 old_log_max
= Vmessage_log_max
;
6906 Vmessage_log_max
= Qnil
;
6907 message (m
, a1
, a2
, a3
);
6908 Vmessage_log_max
= old_log_max
;
6912 /* Display the current message in the current mini-buffer. This is
6913 only called from error handlers in process.c, and is not time
6919 if (!NILP (echo_area_buffer
[0]))
6922 string
= Fcurrent_message ();
6923 message3 (string
, SBYTES (string
),
6924 !NILP (current_buffer
->enable_multibyte_characters
));
6929 /* Make sure echo area buffers in `echo_buffers' are live.
6930 If they aren't, make new ones. */
6933 ensure_echo_area_buffers ()
6937 for (i
= 0; i
< 2; ++i
)
6938 if (!BUFFERP (echo_buffer
[i
])
6939 || NILP (XBUFFER (echo_buffer
[i
])->name
))
6942 Lisp_Object old_buffer
;
6945 old_buffer
= echo_buffer
[i
];
6946 sprintf (name
, " *Echo Area %d*", i
);
6947 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
6948 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
6950 for (j
= 0; j
< 2; ++j
)
6951 if (EQ (old_buffer
, echo_area_buffer
[j
]))
6952 echo_area_buffer
[j
] = echo_buffer
[i
];
6957 /* Call FN with args A1..A4 with either the current or last displayed
6958 echo_area_buffer as current buffer.
6960 WHICH zero means use the current message buffer
6961 echo_area_buffer[0]. If that is nil, choose a suitable buffer
6962 from echo_buffer[] and clear it.
6964 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
6965 suitable buffer from echo_buffer[] and clear it.
6967 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
6968 that the current message becomes the last displayed one, make
6969 choose a suitable buffer for echo_area_buffer[0], and clear it.
6971 Value is what FN returns. */
6974 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
)
6977 int (*fn
) P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
6983 int this_one
, the_other
, clear_buffer_p
, rc
;
6984 int count
= SPECPDL_INDEX ();
6986 /* If buffers aren't live, make new ones. */
6987 ensure_echo_area_buffers ();
6992 this_one
= 0, the_other
= 1;
6994 this_one
= 1, the_other
= 0;
6997 this_one
= 0, the_other
= 1;
7000 /* We need a fresh one in case the current echo buffer equals
7001 the one containing the last displayed echo area message. */
7002 if (!NILP (echo_area_buffer
[this_one
])
7003 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
7004 echo_area_buffer
[this_one
] = Qnil
;
7007 /* Choose a suitable buffer from echo_buffer[] is we don't
7009 if (NILP (echo_area_buffer
[this_one
]))
7011 echo_area_buffer
[this_one
]
7012 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
7013 ? echo_buffer
[the_other
]
7014 : echo_buffer
[this_one
]);
7018 buffer
= echo_area_buffer
[this_one
];
7020 /* Don't get confused by reusing the buffer used for echoing
7021 for a different purpose. */
7022 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
7025 record_unwind_protect (unwind_with_echo_area_buffer
,
7026 with_echo_area_buffer_unwind_data (w
));
7028 /* Make the echo area buffer current. Note that for display
7029 purposes, it is not necessary that the displayed window's buffer
7030 == current_buffer, except for text property lookup. So, let's
7031 only set that buffer temporarily here without doing a full
7032 Fset_window_buffer. We must also change w->pointm, though,
7033 because otherwise an assertions in unshow_buffer fails, and Emacs
7035 set_buffer_internal_1 (XBUFFER (buffer
));
7039 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
7042 current_buffer
->undo_list
= Qt
;
7043 current_buffer
->read_only
= Qnil
;
7044 specbind (Qinhibit_read_only
, Qt
);
7045 specbind (Qinhibit_modification_hooks
, Qt
);
7047 if (clear_buffer_p
&& Z
> BEG
)
7050 xassert (BEGV
>= BEG
);
7051 xassert (ZV
<= Z
&& ZV
>= BEGV
);
7053 rc
= fn (a1
, a2
, a3
, a4
);
7055 xassert (BEGV
>= BEG
);
7056 xassert (ZV
<= Z
&& ZV
>= BEGV
);
7058 unbind_to (count
, Qnil
);
7063 /* Save state that should be preserved around the call to the function
7064 FN called in with_echo_area_buffer. */
7067 with_echo_area_buffer_unwind_data (w
)
7073 /* Reduce consing by keeping one vector in
7074 Vwith_echo_area_save_vector. */
7075 vector
= Vwith_echo_area_save_vector
;
7076 Vwith_echo_area_save_vector
= Qnil
;
7079 vector
= Fmake_vector (make_number (7), Qnil
);
7081 XSETBUFFER (AREF (vector
, i
), current_buffer
); ++i
;
7082 AREF (vector
, i
) = Vdeactivate_mark
, ++i
;
7083 AREF (vector
, i
) = make_number (windows_or_buffers_changed
), ++i
;
7087 XSETWINDOW (AREF (vector
, i
), w
); ++i
;
7088 AREF (vector
, i
) = w
->buffer
; ++i
;
7089 AREF (vector
, i
) = make_number (XMARKER (w
->pointm
)->charpos
); ++i
;
7090 AREF (vector
, i
) = make_number (XMARKER (w
->pointm
)->bytepos
); ++i
;
7095 for (; i
< end
; ++i
)
7096 AREF (vector
, i
) = Qnil
;
7099 xassert (i
== ASIZE (vector
));
7104 /* Restore global state from VECTOR which was created by
7105 with_echo_area_buffer_unwind_data. */
7108 unwind_with_echo_area_buffer (vector
)
7111 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
7112 Vdeactivate_mark
= AREF (vector
, 1);
7113 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
7115 if (WINDOWP (AREF (vector
, 3)))
7118 Lisp_Object buffer
, charpos
, bytepos
;
7120 w
= XWINDOW (AREF (vector
, 3));
7121 buffer
= AREF (vector
, 4);
7122 charpos
= AREF (vector
, 5);
7123 bytepos
= AREF (vector
, 6);
7126 set_marker_both (w
->pointm
, buffer
,
7127 XFASTINT (charpos
), XFASTINT (bytepos
));
7130 Vwith_echo_area_save_vector
= vector
;
7135 /* Set up the echo area for use by print functions. MULTIBYTE_P
7136 non-zero means we will print multibyte. */
7139 setup_echo_area_for_printing (multibyte_p
)
7142 /* If we can't find an echo area any more, exit. */
7143 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
7146 ensure_echo_area_buffers ();
7148 if (!message_buf_print
)
7150 /* A message has been output since the last time we printed.
7151 Choose a fresh echo area buffer. */
7152 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
7153 echo_area_buffer
[0] = echo_buffer
[1];
7155 echo_area_buffer
[0] = echo_buffer
[0];
7157 /* Switch to that buffer and clear it. */
7158 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
7159 current_buffer
->truncate_lines
= Qnil
;
7163 int count
= SPECPDL_INDEX ();
7164 specbind (Qinhibit_read_only
, Qt
);
7165 /* Note that undo recording is always disabled. */
7167 unbind_to (count
, Qnil
);
7169 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
7171 /* Set up the buffer for the multibyteness we need. */
7173 != !NILP (current_buffer
->enable_multibyte_characters
))
7174 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
7176 /* Raise the frame containing the echo area. */
7177 if (minibuffer_auto_raise
)
7179 struct frame
*sf
= SELECTED_FRAME ();
7180 Lisp_Object mini_window
;
7181 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7182 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
7185 message_log_maybe_newline ();
7186 message_buf_print
= 1;
7190 if (NILP (echo_area_buffer
[0]))
7192 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
7193 echo_area_buffer
[0] = echo_buffer
[1];
7195 echo_area_buffer
[0] = echo_buffer
[0];
7198 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
7200 /* Someone switched buffers between print requests. */
7201 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
7202 current_buffer
->truncate_lines
= Qnil
;
7208 /* Display an echo area message in window W. Value is non-zero if W's
7209 height is changed. If display_last_displayed_message_p is
7210 non-zero, display the message that was last displayed, otherwise
7211 display the current message. */
7214 display_echo_area (w
)
7217 int i
, no_message_p
, window_height_changed_p
, count
;
7219 /* Temporarily disable garbage collections while displaying the echo
7220 area. This is done because a GC can print a message itself.
7221 That message would modify the echo area buffer's contents while a
7222 redisplay of the buffer is going on, and seriously confuse
7224 count
= inhibit_garbage_collection ();
7226 /* If there is no message, we must call display_echo_area_1
7227 nevertheless because it resizes the window. But we will have to
7228 reset the echo_area_buffer in question to nil at the end because
7229 with_echo_area_buffer will sets it to an empty buffer. */
7230 i
= display_last_displayed_message_p
? 1 : 0;
7231 no_message_p
= NILP (echo_area_buffer
[i
]);
7233 window_height_changed_p
7234 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
7235 display_echo_area_1
,
7236 (EMACS_INT
) w
, Qnil
, 0, 0);
7239 echo_area_buffer
[i
] = Qnil
;
7241 unbind_to (count
, Qnil
);
7242 return window_height_changed_p
;
7246 /* Helper for display_echo_area. Display the current buffer which
7247 contains the current echo area message in window W, a mini-window,
7248 a pointer to which is passed in A1. A2..A4 are currently not used.
7249 Change the height of W so that all of the message is displayed.
7250 Value is non-zero if height of W was changed. */
7253 display_echo_area_1 (a1
, a2
, a3
, a4
)
7258 struct window
*w
= (struct window
*) a1
;
7260 struct text_pos start
;
7261 int window_height_changed_p
= 0;
7263 /* Do this before displaying, so that we have a large enough glyph
7264 matrix for the display. */
7265 window_height_changed_p
= resize_mini_window (w
, 0);
7268 clear_glyph_matrix (w
->desired_matrix
);
7269 XSETWINDOW (window
, w
);
7270 SET_TEXT_POS (start
, BEG
, BEG_BYTE
);
7271 try_window (window
, start
);
7273 return window_height_changed_p
;
7277 /* Resize the echo area window to exactly the size needed for the
7278 currently displayed message, if there is one. If a mini-buffer
7279 is active, don't shrink it. */
7282 resize_echo_area_exactly ()
7284 if (BUFFERP (echo_area_buffer
[0])
7285 && WINDOWP (echo_area_window
))
7287 struct window
*w
= XWINDOW (echo_area_window
);
7289 Lisp_Object resize_exactly
;
7291 if (minibuf_level
== 0)
7292 resize_exactly
= Qt
;
7294 resize_exactly
= Qnil
;
7296 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
7297 (EMACS_INT
) w
, resize_exactly
, 0, 0);
7300 ++windows_or_buffers_changed
;
7301 ++update_mode_lines
;
7302 redisplay_internal (0);
7308 /* Callback function for with_echo_area_buffer, when used from
7309 resize_echo_area_exactly. A1 contains a pointer to the window to
7310 resize, EXACTLY non-nil means resize the mini-window exactly to the
7311 size of the text displayed. A3 and A4 are not used. Value is what
7312 resize_mini_window returns. */
7315 resize_mini_window_1 (a1
, exactly
, a3
, a4
)
7317 Lisp_Object exactly
;
7320 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
7324 /* Resize mini-window W to fit the size of its contents. EXACT:P
7325 means size the window exactly to the size needed. Otherwise, it's
7326 only enlarged until W's buffer is empty. Value is non-zero if
7327 the window height has been changed. */
7330 resize_mini_window (w
, exact_p
)
7334 struct frame
*f
= XFRAME (w
->frame
);
7335 int window_height_changed_p
= 0;
7337 xassert (MINI_WINDOW_P (w
));
7339 /* Don't resize windows while redisplaying a window; it would
7340 confuse redisplay functions when the size of the window they are
7341 displaying changes from under them. Such a resizing can happen,
7342 for instance, when which-func prints a long message while
7343 we are running fontification-functions. We're running these
7344 functions with safe_call which binds inhibit-redisplay to t. */
7345 if (!NILP (Vinhibit_redisplay
))
7348 /* Nil means don't try to resize. */
7349 if (NILP (Vresize_mini_windows
)
7350 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
7353 if (!FRAME_MINIBUF_ONLY_P (f
))
7356 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
7357 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
7358 int height
, max_height
;
7359 int unit
= FRAME_LINE_HEIGHT (f
);
7360 struct text_pos start
;
7361 struct buffer
*old_current_buffer
= NULL
;
7363 if (current_buffer
!= XBUFFER (w
->buffer
))
7365 old_current_buffer
= current_buffer
;
7366 set_buffer_internal (XBUFFER (w
->buffer
));
7369 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
7371 /* Compute the max. number of lines specified by the user. */
7372 if (FLOATP (Vmax_mini_window_height
))
7373 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
7374 else if (INTEGERP (Vmax_mini_window_height
))
7375 max_height
= XINT (Vmax_mini_window_height
);
7377 max_height
= total_height
/ 4;
7379 /* Correct that max. height if it's bogus. */
7380 max_height
= max (1, max_height
);
7381 max_height
= min (total_height
, max_height
);
7383 /* Find out the height of the text in the window. */
7384 if (it
.truncate_lines_p
)
7389 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
7390 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
7391 height
= it
.current_y
+ last_height
;
7393 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
7394 height
-= it
.extra_line_spacing
;
7395 height
= (height
+ unit
- 1) / unit
;
7398 /* Compute a suitable window start. */
7399 if (height
> max_height
)
7401 height
= max_height
;
7402 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
7403 move_it_vertically_backward (&it
, (height
- 1) * unit
);
7404 start
= it
.current
.pos
;
7407 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
7408 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
7410 if (EQ (Vresize_mini_windows
, Qgrow_only
))
7412 /* Let it grow only, until we display an empty message, in which
7413 case the window shrinks again. */
7414 if (height
> WINDOW_TOTAL_LINES (w
))
7416 int old_height
= WINDOW_TOTAL_LINES (w
);
7417 freeze_window_starts (f
, 1);
7418 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
7419 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
7421 else if (height
< WINDOW_TOTAL_LINES (w
)
7422 && (exact_p
|| BEGV
== ZV
))
7424 int old_height
= WINDOW_TOTAL_LINES (w
);
7425 freeze_window_starts (f
, 0);
7426 shrink_mini_window (w
);
7427 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
7432 /* Always resize to exact size needed. */
7433 if (height
> WINDOW_TOTAL_LINES (w
))
7435 int old_height
= WINDOW_TOTAL_LINES (w
);
7436 freeze_window_starts (f
, 1);
7437 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
7438 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
7440 else if (height
< WINDOW_TOTAL_LINES (w
))
7442 int old_height
= WINDOW_TOTAL_LINES (w
);
7443 freeze_window_starts (f
, 0);
7444 shrink_mini_window (w
);
7448 freeze_window_starts (f
, 1);
7449 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
7452 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
7456 if (old_current_buffer
)
7457 set_buffer_internal (old_current_buffer
);
7460 return window_height_changed_p
;
7464 /* Value is the current message, a string, or nil if there is no
7472 if (NILP (echo_area_buffer
[0]))
7476 with_echo_area_buffer (0, 0, current_message_1
,
7477 (EMACS_INT
) &msg
, Qnil
, 0, 0);
7479 echo_area_buffer
[0] = Qnil
;
7487 current_message_1 (a1
, a2
, a3
, a4
)
7492 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
7495 *msg
= make_buffer_string (BEG
, Z
, 1);
7502 /* Push the current message on Vmessage_stack for later restauration
7503 by restore_message. Value is non-zero if the current message isn't
7504 empty. This is a relatively infrequent operation, so it's not
7505 worth optimizing. */
7511 msg
= current_message ();
7512 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
7513 return STRINGP (msg
);
7517 /* Restore message display from the top of Vmessage_stack. */
7524 xassert (CONSP (Vmessage_stack
));
7525 msg
= XCAR (Vmessage_stack
);
7527 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
7529 message3_nolog (msg
, 0, 0);
7533 /* Handler for record_unwind_protect calling pop_message. */
7536 pop_message_unwind (dummy
)
7543 /* Pop the top-most entry off Vmessage_stack. */
7548 xassert (CONSP (Vmessage_stack
));
7549 Vmessage_stack
= XCDR (Vmessage_stack
);
7553 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
7554 exits. If the stack is not empty, we have a missing pop_message
7558 check_message_stack ()
7560 if (!NILP (Vmessage_stack
))
7565 /* Truncate to NCHARS what will be displayed in the echo area the next
7566 time we display it---but don't redisplay it now. */
7569 truncate_echo_area (nchars
)
7573 echo_area_buffer
[0] = Qnil
;
7574 /* A null message buffer means that the frame hasn't really been
7575 initialized yet. Error messages get reported properly by
7576 cmd_error, so this must be just an informative message; toss it. */
7577 else if (!noninteractive
7579 && !NILP (echo_area_buffer
[0]))
7581 struct frame
*sf
= SELECTED_FRAME ();
7582 if (FRAME_MESSAGE_BUF (sf
))
7583 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
7588 /* Helper function for truncate_echo_area. Truncate the current
7589 message to at most NCHARS characters. */
7592 truncate_message_1 (nchars
, a2
, a3
, a4
)
7597 if (BEG
+ nchars
< Z
)
7598 del_range (BEG
+ nchars
, Z
);
7600 echo_area_buffer
[0] = Qnil
;
7605 /* Set the current message to a substring of S or STRING.
7607 If STRING is a Lisp string, set the message to the first NBYTES
7608 bytes from STRING. NBYTES zero means use the whole string. If
7609 STRING is multibyte, the message will be displayed multibyte.
7611 If S is not null, set the message to the first LEN bytes of S. LEN
7612 zero means use the whole string. MULTIBYTE_P non-zero means S is
7613 multibyte. Display the message multibyte in that case. */
7616 set_message (s
, string
, nbytes
, multibyte_p
)
7619 int nbytes
, multibyte_p
;
7621 message_enable_multibyte
7622 = ((s
&& multibyte_p
)
7623 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
7625 with_echo_area_buffer (0, -1, set_message_1
,
7626 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
7627 message_buf_print
= 0;
7628 help_echo_showing_p
= 0;
7632 /* Helper function for set_message. Arguments have the same meaning
7633 as there, with A1 corresponding to S and A2 corresponding to STRING
7634 This function is called with the echo area buffer being
7638 set_message_1 (a1
, a2
, nbytes
, multibyte_p
)
7641 EMACS_INT nbytes
, multibyte_p
;
7643 const char *s
= (const char *) a1
;
7644 Lisp_Object string
= a2
;
7648 /* Change multibyteness of the echo buffer appropriately. */
7649 if (message_enable_multibyte
7650 != !NILP (current_buffer
->enable_multibyte_characters
))
7651 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
7653 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
7655 /* Insert new message at BEG. */
7656 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
7658 if (STRINGP (string
))
7663 nbytes
= SBYTES (string
);
7664 nchars
= string_byte_to_char (string
, nbytes
);
7666 /* This function takes care of single/multibyte conversion. We
7667 just have to ensure that the echo area buffer has the right
7668 setting of enable_multibyte_characters. */
7669 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
7674 nbytes
= strlen (s
);
7676 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
7678 /* Convert from multi-byte to single-byte. */
7680 unsigned char work
[1];
7682 /* Convert a multibyte string to single-byte. */
7683 for (i
= 0; i
< nbytes
; i
+= n
)
7685 c
= string_char_and_length (s
+ i
, nbytes
- i
, &n
);
7686 work
[0] = (SINGLE_BYTE_CHAR_P (c
)
7688 : multibyte_char_to_unibyte (c
, Qnil
));
7689 insert_1_both (work
, 1, 1, 1, 0, 0);
7692 else if (!multibyte_p
7693 && !NILP (current_buffer
->enable_multibyte_characters
))
7695 /* Convert from single-byte to multi-byte. */
7697 const unsigned char *msg
= (const unsigned char *) s
;
7698 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7700 /* Convert a single-byte string to multibyte. */
7701 for (i
= 0; i
< nbytes
; i
++)
7703 c
= unibyte_char_to_multibyte (msg
[i
]);
7704 n
= CHAR_STRING (c
, str
);
7705 insert_1_both (str
, 1, n
, 1, 0, 0);
7709 insert_1 (s
, nbytes
, 1, 0, 0);
7716 /* Clear messages. CURRENT_P non-zero means clear the current
7717 message. LAST_DISPLAYED_P non-zero means clear the message
7721 clear_message (current_p
, last_displayed_p
)
7722 int current_p
, last_displayed_p
;
7726 echo_area_buffer
[0] = Qnil
;
7727 message_cleared_p
= 1;
7730 if (last_displayed_p
)
7731 echo_area_buffer
[1] = Qnil
;
7733 message_buf_print
= 0;
7736 /* Clear garbaged frames.
7738 This function is used where the old redisplay called
7739 redraw_garbaged_frames which in turn called redraw_frame which in
7740 turn called clear_frame. The call to clear_frame was a source of
7741 flickering. I believe a clear_frame is not necessary. It should
7742 suffice in the new redisplay to invalidate all current matrices,
7743 and ensure a complete redisplay of all windows. */
7746 clear_garbaged_frames ()
7750 Lisp_Object tail
, frame
;
7751 int changed_count
= 0;
7753 FOR_EACH_FRAME (tail
, frame
)
7755 struct frame
*f
= XFRAME (frame
);
7757 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
7761 Fredraw_frame (frame
);
7762 f
->force_flush_display_p
= 1;
7764 clear_current_matrices (f
);
7773 ++windows_or_buffers_changed
;
7778 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
7779 is non-zero update selected_frame. Value is non-zero if the
7780 mini-windows height has been changed. */
7783 echo_area_display (update_frame_p
)
7786 Lisp_Object mini_window
;
7789 int window_height_changed_p
= 0;
7790 struct frame
*sf
= SELECTED_FRAME ();
7792 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7793 w
= XWINDOW (mini_window
);
7794 f
= XFRAME (WINDOW_FRAME (w
));
7796 /* Don't display if frame is invisible or not yet initialized. */
7797 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
7800 /* The terminal frame is used as the first Emacs frame on the Mac OS. */
7802 #ifdef HAVE_WINDOW_SYSTEM
7803 /* When Emacs starts, selected_frame may be a visible terminal
7804 frame, even if we run under a window system. If we let this
7805 through, a message would be displayed on the terminal. */
7806 if (EQ (selected_frame
, Vterminal_frame
)
7807 && !NILP (Vwindow_system
))
7809 #endif /* HAVE_WINDOW_SYSTEM */
7812 /* Redraw garbaged frames. */
7814 clear_garbaged_frames ();
7816 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
7818 echo_area_window
= mini_window
;
7819 window_height_changed_p
= display_echo_area (w
);
7820 w
->must_be_updated_p
= 1;
7822 /* Update the display, unless called from redisplay_internal.
7823 Also don't update the screen during redisplay itself. The
7824 update will happen at the end of redisplay, and an update
7825 here could cause confusion. */
7826 if (update_frame_p
&& !redisplaying_p
)
7830 /* If the display update has been interrupted by pending
7831 input, update mode lines in the frame. Due to the
7832 pending input, it might have been that redisplay hasn't
7833 been called, so that mode lines above the echo area are
7834 garbaged. This looks odd, so we prevent it here. */
7835 if (!display_completed
)
7836 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
7838 if (window_height_changed_p
7839 /* Don't do this if Emacs is shutting down. Redisplay
7840 needs to run hooks. */
7841 && !NILP (Vrun_hooks
))
7843 /* Must update other windows. Likewise as in other
7844 cases, don't let this update be interrupted by
7846 int count
= SPECPDL_INDEX ();
7847 specbind (Qredisplay_dont_pause
, Qt
);
7848 windows_or_buffers_changed
= 1;
7849 redisplay_internal (0);
7850 unbind_to (count
, Qnil
);
7852 else if (FRAME_WINDOW_P (f
) && n
== 0)
7854 /* Window configuration is the same as before.
7855 Can do with a display update of the echo area,
7856 unless we displayed some mode lines. */
7857 update_single_window (w
, 1);
7858 rif
->flush_display (f
);
7861 update_frame (f
, 1, 1);
7863 /* If cursor is in the echo area, make sure that the next
7864 redisplay displays the minibuffer, so that the cursor will
7865 be replaced with what the minibuffer wants. */
7866 if (cursor_in_echo_area
)
7867 ++windows_or_buffers_changed
;
7870 else if (!EQ (mini_window
, selected_window
))
7871 windows_or_buffers_changed
++;
7873 /* Last displayed message is now the current message. */
7874 echo_area_buffer
[1] = echo_area_buffer
[0];
7876 /* Prevent redisplay optimization in redisplay_internal by resetting
7877 this_line_start_pos. This is done because the mini-buffer now
7878 displays the message instead of its buffer text. */
7879 if (EQ (mini_window
, selected_window
))
7880 CHARPOS (this_line_start_pos
) = 0;
7882 return window_height_changed_p
;
7887 /***********************************************************************
7889 ***********************************************************************/
7892 /* The frame title buffering code is also used by Fformat_mode_line.
7893 So it is not conditioned by HAVE_WINDOW_SYSTEM. */
7895 /* A buffer for constructing frame titles in it; allocated from the
7896 heap in init_xdisp and resized as needed in store_frame_title_char. */
7898 static char *frame_title_buf
;
7900 /* The buffer's end, and a current output position in it. */
7902 static char *frame_title_buf_end
;
7903 static char *frame_title_ptr
;
7906 /* Store a single character C for the frame title in frame_title_buf.
7907 Re-allocate frame_title_buf if necessary. */
7911 store_frame_title_char (char c
)
7913 store_frame_title_char (c
)
7917 /* If output position has reached the end of the allocated buffer,
7918 double the buffer's size. */
7919 if (frame_title_ptr
== frame_title_buf_end
)
7921 int len
= frame_title_ptr
- frame_title_buf
;
7922 int new_size
= 2 * len
* sizeof *frame_title_buf
;
7923 frame_title_buf
= (char *) xrealloc (frame_title_buf
, new_size
);
7924 frame_title_buf_end
= frame_title_buf
+ new_size
;
7925 frame_title_ptr
= frame_title_buf
+ len
;
7928 *frame_title_ptr
++ = c
;
7932 /* Store part of a frame title in frame_title_buf, beginning at
7933 frame_title_ptr. STR is the string to store. Do not copy
7934 characters that yield more columns than PRECISION; PRECISION <= 0
7935 means copy the whole string. Pad with spaces until FIELD_WIDTH
7936 number of characters have been copied; FIELD_WIDTH <= 0 means don't
7937 pad. Called from display_mode_element when it is used to build a
7941 store_frame_title (str
, field_width
, precision
)
7942 const unsigned char *str
;
7943 int field_width
, precision
;
7948 /* Copy at most PRECISION chars from STR. */
7949 nbytes
= strlen (str
);
7950 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
7952 store_frame_title_char (*str
++);
7954 /* Fill up with spaces until FIELD_WIDTH reached. */
7955 while (field_width
> 0
7958 store_frame_title_char (' ');
7965 #ifdef HAVE_WINDOW_SYSTEM
7967 /* Set the title of FRAME, if it has changed. The title format is
7968 Vicon_title_format if FRAME is iconified, otherwise it is
7969 frame_title_format. */
7972 x_consider_frame_title (frame
)
7975 struct frame
*f
= XFRAME (frame
);
7977 if (FRAME_WINDOW_P (f
)
7978 || FRAME_MINIBUF_ONLY_P (f
)
7979 || f
->explicit_name
)
7981 /* Do we have more than one visible frame on this X display? */
7984 struct buffer
*obuf
;
7988 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
7990 Lisp_Object other_frame
= XCAR (tail
);
7991 struct frame
*tf
= XFRAME (other_frame
);
7994 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
7995 && !FRAME_MINIBUF_ONLY_P (tf
)
7996 && !EQ (other_frame
, tip_frame
)
7997 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
8001 /* Set global variable indicating that multiple frames exist. */
8002 multiple_frames
= CONSP (tail
);
8004 /* Switch to the buffer of selected window of the frame. Set up
8005 frame_title_ptr so that display_mode_element will output into it;
8006 then display the title. */
8007 obuf
= current_buffer
;
8008 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
8009 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
8010 frame_title_ptr
= frame_title_buf
;
8011 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
8012 NULL
, DEFAULT_FACE_ID
);
8013 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
8014 len
= frame_title_ptr
- frame_title_buf
;
8015 frame_title_ptr
= NULL
;
8016 set_buffer_internal_1 (obuf
);
8018 /* Set the title only if it's changed. This avoids consing in
8019 the common case where it hasn't. (If it turns out that we've
8020 already wasted too much time by walking through the list with
8021 display_mode_element, then we might need to optimize at a
8022 higher level than this.) */
8023 if (! STRINGP (f
->name
)
8024 || SBYTES (f
->name
) != len
8025 || bcmp (frame_title_buf
, SDATA (f
->name
), len
) != 0)
8026 x_implicitly_set_name (f
, make_string (frame_title_buf
, len
), Qnil
);
8030 #endif /* not HAVE_WINDOW_SYSTEM */
8035 /***********************************************************************
8037 ***********************************************************************/
8040 /* Prepare for redisplay by updating menu-bar item lists when
8041 appropriate. This can call eval. */
8044 prepare_menu_bars ()
8047 struct gcpro gcpro1
, gcpro2
;
8049 Lisp_Object tooltip_frame
;
8051 #ifdef HAVE_WINDOW_SYSTEM
8052 tooltip_frame
= tip_frame
;
8054 tooltip_frame
= Qnil
;
8057 /* Update all frame titles based on their buffer names, etc. We do
8058 this before the menu bars so that the buffer-menu will show the
8059 up-to-date frame titles. */
8060 #ifdef HAVE_WINDOW_SYSTEM
8061 if (windows_or_buffers_changed
|| update_mode_lines
)
8063 Lisp_Object tail
, frame
;
8065 FOR_EACH_FRAME (tail
, frame
)
8068 if (!EQ (frame
, tooltip_frame
)
8069 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
8070 x_consider_frame_title (frame
);
8073 #endif /* HAVE_WINDOW_SYSTEM */
8075 /* Update the menu bar item lists, if appropriate. This has to be
8076 done before any actual redisplay or generation of display lines. */
8077 all_windows
= (update_mode_lines
8078 || buffer_shared
> 1
8079 || windows_or_buffers_changed
);
8082 Lisp_Object tail
, frame
;
8083 int count
= SPECPDL_INDEX ();
8085 record_unwind_protect (Fset_match_data
, Fmatch_data (Qnil
, Qnil
));
8087 FOR_EACH_FRAME (tail
, frame
)
8091 /* Ignore tooltip frame. */
8092 if (EQ (frame
, tooltip_frame
))
8095 /* If a window on this frame changed size, report that to
8096 the user and clear the size-change flag. */
8097 if (FRAME_WINDOW_SIZES_CHANGED (f
))
8099 Lisp_Object functions
;
8101 /* Clear flag first in case we get an error below. */
8102 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
8103 functions
= Vwindow_size_change_functions
;
8104 GCPRO2 (tail
, functions
);
8106 while (CONSP (functions
))
8108 call1 (XCAR (functions
), frame
);
8109 functions
= XCDR (functions
);
8115 update_menu_bar (f
, 0);
8116 #ifdef HAVE_WINDOW_SYSTEM
8117 update_tool_bar (f
, 0);
8122 unbind_to (count
, Qnil
);
8126 struct frame
*sf
= SELECTED_FRAME ();
8127 update_menu_bar (sf
, 1);
8128 #ifdef HAVE_WINDOW_SYSTEM
8129 update_tool_bar (sf
, 1);
8133 /* Motif needs this. See comment in xmenu.c. Turn it off when
8134 pending_menu_activation is not defined. */
8135 #ifdef USE_X_TOOLKIT
8136 pending_menu_activation
= 0;
8141 /* Update the menu bar item list for frame F. This has to be done
8142 before we start to fill in any display lines, because it can call
8145 If SAVE_MATCH_DATA is non-zero, we must save and restore it here. */
8148 update_menu_bar (f
, save_match_data
)
8150 int save_match_data
;
8153 register struct window
*w
;
8155 /* If called recursively during a menu update, do nothing. This can
8156 happen when, for instance, an activate-menubar-hook causes a
8158 if (inhibit_menubar_update
)
8161 window
= FRAME_SELECTED_WINDOW (f
);
8162 w
= XWINDOW (window
);
8164 #if 0 /* The if statement below this if statement used to include the
8165 condition !NILP (w->update_mode_line), rather than using
8166 update_mode_lines directly, and this if statement may have
8167 been added to make that condition work. Now the if
8168 statement below matches its comment, this isn't needed. */
8169 if (update_mode_lines
)
8170 w
->update_mode_line
= Qt
;
8173 if (FRAME_WINDOW_P (f
)
8175 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
8176 || defined (USE_GTK)
8177 FRAME_EXTERNAL_MENU_BAR (f
)
8179 FRAME_MENU_BAR_LINES (f
) > 0
8181 : FRAME_MENU_BAR_LINES (f
) > 0)
8183 /* If the user has switched buffers or windows, we need to
8184 recompute to reflect the new bindings. But we'll
8185 recompute when update_mode_lines is set too; that means
8186 that people can use force-mode-line-update to request
8187 that the menu bar be recomputed. The adverse effect on
8188 the rest of the redisplay algorithm is about the same as
8189 windows_or_buffers_changed anyway. */
8190 if (windows_or_buffers_changed
8191 /* This used to test w->update_mode_line, but we believe
8192 there is no need to recompute the menu in that case. */
8193 || update_mode_lines
8194 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
8195 < BUF_MODIFF (XBUFFER (w
->buffer
)))
8196 != !NILP (w
->last_had_star
))
8197 || ((!NILP (Vtransient_mark_mode
)
8198 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
8199 != !NILP (w
->region_showing
)))
8201 struct buffer
*prev
= current_buffer
;
8202 int count
= SPECPDL_INDEX ();
8204 specbind (Qinhibit_menubar_update
, Qt
);
8206 set_buffer_internal_1 (XBUFFER (w
->buffer
));
8207 if (save_match_data
)
8208 record_unwind_protect (Fset_match_data
, Fmatch_data (Qnil
, Qnil
));
8209 if (NILP (Voverriding_local_map_menu_flag
))
8211 specbind (Qoverriding_terminal_local_map
, Qnil
);
8212 specbind (Qoverriding_local_map
, Qnil
);
8215 /* Run the Lucid hook. */
8216 safe_run_hooks (Qactivate_menubar_hook
);
8218 /* If it has changed current-menubar from previous value,
8219 really recompute the menu-bar from the value. */
8220 if (! NILP (Vlucid_menu_bar_dirty_flag
))
8221 call0 (Qrecompute_lucid_menubar
);
8223 safe_run_hooks (Qmenu_bar_update_hook
);
8224 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
8226 /* Redisplay the menu bar in case we changed it. */
8227 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
8228 || defined (USE_GTK)
8229 if (FRAME_WINDOW_P (f
)
8230 #if defined (MAC_OS)
8231 /* All frames on Mac OS share the same menubar. So only the
8232 selected frame should be allowed to set it. */
8233 && f
== SELECTED_FRAME ()
8236 set_frame_menubar (f
, 0, 0);
8238 /* On a terminal screen, the menu bar is an ordinary screen
8239 line, and this makes it get updated. */
8240 w
->update_mode_line
= Qt
;
8241 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || MAC_OS || USE_GTK) */
8242 /* In the non-toolkit version, the menu bar is an ordinary screen
8243 line, and this makes it get updated. */
8244 w
->update_mode_line
= Qt
;
8245 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || MAC_OS || USE_GTK) */
8247 unbind_to (count
, Qnil
);
8248 set_buffer_internal_1 (prev
);
8255 /***********************************************************************
8257 ***********************************************************************/
8259 #ifdef HAVE_WINDOW_SYSTEM
8262 Nominal cursor position -- where to draw output.
8263 HPOS and VPOS are window relative glyph matrix coordinates.
8264 X and Y are window relative pixel coordinates. */
8266 struct cursor_pos output_cursor
;
8270 Set the global variable output_cursor to CURSOR. All cursor
8271 positions are relative to updated_window. */
8274 set_output_cursor (cursor
)
8275 struct cursor_pos
*cursor
;
8277 output_cursor
.hpos
= cursor
->hpos
;
8278 output_cursor
.vpos
= cursor
->vpos
;
8279 output_cursor
.x
= cursor
->x
;
8280 output_cursor
.y
= cursor
->y
;
8285 Set a nominal cursor position.
8287 HPOS and VPOS are column/row positions in a window glyph matrix. X
8288 and Y are window text area relative pixel positions.
8290 If this is done during an update, updated_window will contain the
8291 window that is being updated and the position is the future output
8292 cursor position for that window. If updated_window is null, use
8293 selected_window and display the cursor at the given position. */
8296 x_cursor_to (vpos
, hpos
, y
, x
)
8297 int vpos
, hpos
, y
, x
;
8301 /* If updated_window is not set, work on selected_window. */
8305 w
= XWINDOW (selected_window
);
8307 /* Set the output cursor. */
8308 output_cursor
.hpos
= hpos
;
8309 output_cursor
.vpos
= vpos
;
8310 output_cursor
.x
= x
;
8311 output_cursor
.y
= y
;
8313 /* If not called as part of an update, really display the cursor.
8314 This will also set the cursor position of W. */
8315 if (updated_window
== NULL
)
8318 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
8319 if (rif
->flush_display_optional
)
8320 rif
->flush_display_optional (SELECTED_FRAME ());
8325 #endif /* HAVE_WINDOW_SYSTEM */
8328 /***********************************************************************
8330 ***********************************************************************/
8332 #ifdef HAVE_WINDOW_SYSTEM
8334 /* Where the mouse was last time we reported a mouse event. */
8336 FRAME_PTR last_mouse_frame
;
8338 /* Tool-bar item index of the item on which a mouse button was pressed
8341 int last_tool_bar_item
;
8344 /* Update the tool-bar item list for frame F. This has to be done
8345 before we start to fill in any display lines. Called from
8346 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
8347 and restore it here. */
8350 update_tool_bar (f
, save_match_data
)
8352 int save_match_data
;
8355 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
8357 int do_update
= WINDOWP (f
->tool_bar_window
)
8358 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
8366 window
= FRAME_SELECTED_WINDOW (f
);
8367 w
= XWINDOW (window
);
8369 /* If the user has switched buffers or windows, we need to
8370 recompute to reflect the new bindings. But we'll
8371 recompute when update_mode_lines is set too; that means
8372 that people can use force-mode-line-update to request
8373 that the menu bar be recomputed. The adverse effect on
8374 the rest of the redisplay algorithm is about the same as
8375 windows_or_buffers_changed anyway. */
8376 if (windows_or_buffers_changed
8377 || !NILP (w
->update_mode_line
)
8378 || update_mode_lines
8379 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
8380 < BUF_MODIFF (XBUFFER (w
->buffer
)))
8381 != !NILP (w
->last_had_star
))
8382 || ((!NILP (Vtransient_mark_mode
)
8383 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
8384 != !NILP (w
->region_showing
)))
8386 struct buffer
*prev
= current_buffer
;
8387 int count
= SPECPDL_INDEX ();
8388 Lisp_Object old_tool_bar
;
8389 struct gcpro gcpro1
;
8391 /* Set current_buffer to the buffer of the selected
8392 window of the frame, so that we get the right local
8394 set_buffer_internal_1 (XBUFFER (w
->buffer
));
8396 /* Save match data, if we must. */
8397 if (save_match_data
)
8398 record_unwind_protect (Fset_match_data
, Fmatch_data (Qnil
, Qnil
));
8400 /* Make sure that we don't accidentally use bogus keymaps. */
8401 if (NILP (Voverriding_local_map_menu_flag
))
8403 specbind (Qoverriding_terminal_local_map
, Qnil
);
8404 specbind (Qoverriding_local_map
, Qnil
);
8407 old_tool_bar
= f
->tool_bar_items
;
8408 GCPRO1 (old_tool_bar
);
8410 /* Build desired tool-bar items from keymaps. */
8413 = tool_bar_items (f
->tool_bar_items
, &f
->n_tool_bar_items
);
8416 /* Redisplay the tool-bar if we changed it. */
8417 if (! NILP (Fequal (old_tool_bar
, f
->tool_bar_items
)))
8418 w
->update_mode_line
= Qt
;
8422 unbind_to (count
, Qnil
);
8423 set_buffer_internal_1 (prev
);
8429 /* Set F->desired_tool_bar_string to a Lisp string representing frame
8430 F's desired tool-bar contents. F->tool_bar_items must have
8431 been set up previously by calling prepare_menu_bars. */
8434 build_desired_tool_bar_string (f
)
8437 int i
, size
, size_needed
;
8438 struct gcpro gcpro1
, gcpro2
, gcpro3
;
8439 Lisp_Object image
, plist
, props
;
8441 image
= plist
= props
= Qnil
;
8442 GCPRO3 (image
, plist
, props
);
8444 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
8445 Otherwise, make a new string. */
8447 /* The size of the string we might be able to reuse. */
8448 size
= (STRINGP (f
->desired_tool_bar_string
)
8449 ? SCHARS (f
->desired_tool_bar_string
)
8452 /* We need one space in the string for each image. */
8453 size_needed
= f
->n_tool_bar_items
;
8455 /* Reuse f->desired_tool_bar_string, if possible. */
8456 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
8457 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
8461 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
8462 Fremove_text_properties (make_number (0), make_number (size
),
8463 props
, f
->desired_tool_bar_string
);
8466 /* Put a `display' property on the string for the images to display,
8467 put a `menu_item' property on tool-bar items with a value that
8468 is the index of the item in F's tool-bar item vector. */
8469 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
8471 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
8473 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8474 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8475 int hmargin
, vmargin
, relief
, idx
, end
;
8476 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
;
8478 /* If image is a vector, choose the image according to the
8480 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
8481 if (VECTORP (image
))
8485 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
8486 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
8489 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
8490 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
8492 xassert (ASIZE (image
) >= idx
);
8493 image
= AREF (image
, idx
);
8498 /* Ignore invalid image specifications. */
8499 if (!valid_image_p (image
))
8502 /* Display the tool-bar button pressed, or depressed. */
8503 plist
= Fcopy_sequence (XCDR (image
));
8505 /* Compute margin and relief to draw. */
8506 relief
= (tool_bar_button_relief
>= 0
8507 ? tool_bar_button_relief
8508 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
8509 hmargin
= vmargin
= relief
;
8511 if (INTEGERP (Vtool_bar_button_margin
)
8512 && XINT (Vtool_bar_button_margin
) > 0)
8514 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
8515 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
8517 else if (CONSP (Vtool_bar_button_margin
))
8519 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
8520 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
8521 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
8523 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
8524 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
8525 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
8528 if (auto_raise_tool_bar_buttons_p
)
8530 /* Add a `:relief' property to the image spec if the item is
8534 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
8541 /* If image is selected, display it pressed, i.e. with a
8542 negative relief. If it's not selected, display it with a
8544 plist
= Fplist_put (plist
, QCrelief
,
8546 ? make_number (-relief
)
8547 : make_number (relief
)));
8552 /* Put a margin around the image. */
8553 if (hmargin
|| vmargin
)
8555 if (hmargin
== vmargin
)
8556 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
8558 plist
= Fplist_put (plist
, QCmargin
,
8559 Fcons (make_number (hmargin
),
8560 make_number (vmargin
)));
8563 /* If button is not enabled, and we don't have special images
8564 for the disabled state, make the image appear disabled by
8565 applying an appropriate algorithm to it. */
8566 if (!enabled_p
&& idx
< 0)
8567 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
8569 /* Put a `display' text property on the string for the image to
8570 display. Put a `menu-item' property on the string that gives
8571 the start of this item's properties in the tool-bar items
8573 image
= Fcons (Qimage
, plist
);
8574 props
= list4 (Qdisplay
, image
,
8575 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
8577 /* Let the last image hide all remaining spaces in the tool bar
8578 string. The string can be longer than needed when we reuse a
8580 if (i
+ 1 == f
->n_tool_bar_items
)
8581 end
= SCHARS (f
->desired_tool_bar_string
);
8584 Fadd_text_properties (make_number (i
), make_number (end
),
8585 props
, f
->desired_tool_bar_string
);
8593 /* Display one line of the tool-bar of frame IT->f. */
8596 display_tool_bar_line (it
)
8599 struct glyph_row
*row
= it
->glyph_row
;
8600 int max_x
= it
->last_visible_x
;
8603 prepare_desired_row (row
);
8604 row
->y
= it
->current_y
;
8606 /* Note that this isn't made use of if the face hasn't a box,
8607 so there's no need to check the face here. */
8608 it
->start_of_box_run_p
= 1;
8610 while (it
->current_x
< max_x
)
8612 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
8614 /* Get the next display element. */
8615 if (!get_next_display_element (it
))
8618 /* Produce glyphs. */
8619 x_before
= it
->current_x
;
8620 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
8621 PRODUCE_GLYPHS (it
);
8623 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
8628 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
8630 if (x
+ glyph
->pixel_width
> max_x
)
8632 /* Glyph doesn't fit on line. */
8633 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
8639 x
+= glyph
->pixel_width
;
8643 /* Stop at line ends. */
8644 if (ITERATOR_AT_END_OF_LINE_P (it
))
8647 set_iterator_to_next (it
, 1);
8652 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
8653 extend_face_to_end_of_line (it
);
8654 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
8655 last
->right_box_line_p
= 1;
8656 if (last
== row
->glyphs
[TEXT_AREA
])
8657 last
->left_box_line_p
= 1;
8658 compute_line_metrics (it
);
8660 /* If line is empty, make it occupy the rest of the tool-bar. */
8661 if (!row
->displays_text_p
)
8663 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
8664 row
->ascent
= row
->phys_ascent
= 0;
8667 row
->full_width_p
= 1;
8668 row
->continued_p
= 0;
8669 row
->truncated_on_left_p
= 0;
8670 row
->truncated_on_right_p
= 0;
8672 it
->current_x
= it
->hpos
= 0;
8673 it
->current_y
+= row
->height
;
8679 /* Value is the number of screen lines needed to make all tool-bar
8680 items of frame F visible. */
8683 tool_bar_lines_needed (f
)
8686 struct window
*w
= XWINDOW (f
->tool_bar_window
);
8689 /* Initialize an iterator for iteration over
8690 F->desired_tool_bar_string in the tool-bar window of frame F. */
8691 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
8692 it
.first_visible_x
= 0;
8693 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
8694 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
8696 while (!ITERATOR_AT_END_P (&it
))
8698 it
.glyph_row
= w
->desired_matrix
->rows
;
8699 clear_glyph_row (it
.glyph_row
);
8700 display_tool_bar_line (&it
);
8703 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
8707 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
8709 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
8718 frame
= selected_frame
;
8720 CHECK_FRAME (frame
);
8723 if (WINDOWP (f
->tool_bar_window
)
8724 || (w
= XWINDOW (f
->tool_bar_window
),
8725 WINDOW_TOTAL_LINES (w
) > 0))
8727 update_tool_bar (f
, 1);
8728 if (f
->n_tool_bar_items
)
8730 build_desired_tool_bar_string (f
);
8731 nlines
= tool_bar_lines_needed (f
);
8735 return make_number (nlines
);
8739 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
8740 height should be changed. */
8743 redisplay_tool_bar (f
)
8748 struct glyph_row
*row
;
8749 int change_height_p
= 0;
8752 if (FRAME_EXTERNAL_TOOL_BAR (f
))
8753 update_frame_tool_bar (f
);
8757 /* If frame hasn't a tool-bar window or if it is zero-height, don't
8758 do anything. This means you must start with tool-bar-lines
8759 non-zero to get the auto-sizing effect. Or in other words, you
8760 can turn off tool-bars by specifying tool-bar-lines zero. */
8761 if (!WINDOWP (f
->tool_bar_window
)
8762 || (w
= XWINDOW (f
->tool_bar_window
),
8763 WINDOW_TOTAL_LINES (w
) == 0))
8766 /* Set up an iterator for the tool-bar window. */
8767 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
8768 it
.first_visible_x
= 0;
8769 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
8772 /* Build a string that represents the contents of the tool-bar. */
8773 build_desired_tool_bar_string (f
);
8774 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
8776 /* Display as many lines as needed to display all tool-bar items. */
8777 while (it
.current_y
< it
.last_visible_y
)
8778 display_tool_bar_line (&it
);
8780 /* It doesn't make much sense to try scrolling in the tool-bar
8781 window, so don't do it. */
8782 w
->desired_matrix
->no_scrolling_p
= 1;
8783 w
->must_be_updated_p
= 1;
8785 if (auto_resize_tool_bars_p
)
8789 /* If we couldn't display everything, change the tool-bar's
8791 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
8792 change_height_p
= 1;
8794 /* If there are blank lines at the end, except for a partially
8795 visible blank line at the end that is smaller than
8796 FRAME_LINE_HEIGHT, change the tool-bar's height. */
8797 row
= it
.glyph_row
- 1;
8798 if (!row
->displays_text_p
8799 && row
->height
>= FRAME_LINE_HEIGHT (f
))
8800 change_height_p
= 1;
8802 /* If row displays tool-bar items, but is partially visible,
8803 change the tool-bar's height. */
8804 if (row
->displays_text_p
8805 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
8806 change_height_p
= 1;
8808 /* Resize windows as needed by changing the `tool-bar-lines'
8811 && (nlines
= tool_bar_lines_needed (f
),
8812 nlines
!= WINDOW_TOTAL_LINES (w
)))
8814 extern Lisp_Object Qtool_bar_lines
;
8816 int old_height
= WINDOW_TOTAL_LINES (w
);
8818 XSETFRAME (frame
, f
);
8819 clear_glyph_matrix (w
->desired_matrix
);
8820 Fmodify_frame_parameters (frame
,
8821 Fcons (Fcons (Qtool_bar_lines
,
8822 make_number (nlines
)),
8824 if (WINDOW_TOTAL_LINES (w
) != old_height
)
8825 fonts_changed_p
= 1;
8829 return change_height_p
;
8833 /* Get information about the tool-bar item which is displayed in GLYPH
8834 on frame F. Return in *PROP_IDX the index where tool-bar item
8835 properties start in F->tool_bar_items. Value is zero if
8836 GLYPH doesn't display a tool-bar item. */
8839 tool_bar_item_info (f
, glyph
, prop_idx
)
8841 struct glyph
*glyph
;
8848 /* This function can be called asynchronously, which means we must
8849 exclude any possibility that Fget_text_property signals an
8851 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
8852 charpos
= max (0, charpos
);
8854 /* Get the text property `menu-item' at pos. The value of that
8855 property is the start index of this item's properties in
8856 F->tool_bar_items. */
8857 prop
= Fget_text_property (make_number (charpos
),
8858 Qmenu_item
, f
->current_tool_bar_string
);
8859 if (INTEGERP (prop
))
8861 *prop_idx
= XINT (prop
);
8871 /* Get information about the tool-bar item at position X/Y on frame F.
8872 Return in *GLYPH a pointer to the glyph of the tool-bar item in
8873 the current matrix of the tool-bar window of F, or NULL if not
8874 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
8875 item in F->tool_bar_items. Value is
8877 -1 if X/Y is not on a tool-bar item
8878 0 if X/Y is on the same item that was highlighted before.
8882 get_tool_bar_item (f
, x
, y
, glyph
, hpos
, vpos
, prop_idx
)
8885 struct glyph
**glyph
;
8886 int *hpos
, *vpos
, *prop_idx
;
8888 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
8889 struct window
*w
= XWINDOW (f
->tool_bar_window
);
8892 /* Find the glyph under X/Y. */
8893 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
8897 /* Get the start of this tool-bar item's properties in
8898 f->tool_bar_items. */
8899 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
8902 /* Is mouse on the highlighted item? */
8903 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
8904 && *vpos
>= dpyinfo
->mouse_face_beg_row
8905 && *vpos
<= dpyinfo
->mouse_face_end_row
8906 && (*vpos
> dpyinfo
->mouse_face_beg_row
8907 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
8908 && (*vpos
< dpyinfo
->mouse_face_end_row
8909 || *hpos
< dpyinfo
->mouse_face_end_col
8910 || dpyinfo
->mouse_face_past_end
))
8918 Handle mouse button event on the tool-bar of frame F, at
8919 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
8920 0 for button release. MODIFIERS is event modifiers for button
8924 handle_tool_bar_click (f
, x
, y
, down_p
, modifiers
)
8927 unsigned int modifiers
;
8929 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
8930 struct window
*w
= XWINDOW (f
->tool_bar_window
);
8931 int hpos
, vpos
, prop_idx
;
8932 struct glyph
*glyph
;
8933 Lisp_Object enabled_p
;
8935 /* If not on the highlighted tool-bar item, return. */
8936 frame_to_window_pixel_xy (w
, &x
, &y
);
8937 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
8940 /* If item is disabled, do nothing. */
8941 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
8942 if (NILP (enabled_p
))
8947 /* Show item in pressed state. */
8948 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
8949 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
8950 last_tool_bar_item
= prop_idx
;
8954 Lisp_Object key
, frame
;
8955 struct input_event event
;
8958 /* Show item in released state. */
8959 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
8960 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
8962 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
8964 XSETFRAME (frame
, f
);
8965 event
.kind
= TOOL_BAR_EVENT
;
8966 event
.frame_or_window
= frame
;
8968 kbd_buffer_store_event (&event
);
8970 event
.kind
= TOOL_BAR_EVENT
;
8971 event
.frame_or_window
= frame
;
8973 event
.modifiers
= modifiers
;
8974 kbd_buffer_store_event (&event
);
8975 last_tool_bar_item
= -1;
8980 /* Possibly highlight a tool-bar item on frame F when mouse moves to
8981 tool-bar window-relative coordinates X/Y. Called from
8982 note_mouse_highlight. */
8985 note_tool_bar_highlight (f
, x
, y
)
8989 Lisp_Object window
= f
->tool_bar_window
;
8990 struct window
*w
= XWINDOW (window
);
8991 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
8993 struct glyph
*glyph
;
8994 struct glyph_row
*row
;
8996 Lisp_Object enabled_p
;
8998 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
8999 int mouse_down_p
, rc
;
9001 /* Function note_mouse_highlight is called with negative x(y
9002 values when mouse moves outside of the frame. */
9003 if (x
<= 0 || y
<= 0)
9005 clear_mouse_face (dpyinfo
);
9009 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
9012 /* Not on tool-bar item. */
9013 clear_mouse_face (dpyinfo
);
9017 /* On same tool-bar item as before. */
9020 clear_mouse_face (dpyinfo
);
9022 /* Mouse is down, but on different tool-bar item? */
9023 mouse_down_p
= (dpyinfo
->grabbed
9024 && f
== last_mouse_frame
9025 && FRAME_LIVE_P (f
));
9027 && last_tool_bar_item
!= prop_idx
)
9030 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
9031 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
9033 /* If tool-bar item is not enabled, don't highlight it. */
9034 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
9035 if (!NILP (enabled_p
))
9037 /* Compute the x-position of the glyph. In front and past the
9038 image is a space. We include this in the highlighted area. */
9039 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
9040 for (i
= x
= 0; i
< hpos
; ++i
)
9041 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
9043 /* Record this as the current active region. */
9044 dpyinfo
->mouse_face_beg_col
= hpos
;
9045 dpyinfo
->mouse_face_beg_row
= vpos
;
9046 dpyinfo
->mouse_face_beg_x
= x
;
9047 dpyinfo
->mouse_face_beg_y
= row
->y
;
9048 dpyinfo
->mouse_face_past_end
= 0;
9050 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
9051 dpyinfo
->mouse_face_end_row
= vpos
;
9052 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
9053 dpyinfo
->mouse_face_end_y
= row
->y
;
9054 dpyinfo
->mouse_face_window
= window
;
9055 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
9057 /* Display it as active. */
9058 show_mouse_face (dpyinfo
, draw
);
9059 dpyinfo
->mouse_face_image_state
= draw
;
9064 /* Set help_echo_string to a help string to display for this tool-bar item.
9065 XTread_socket does the rest. */
9066 help_echo_object
= help_echo_window
= Qnil
;
9068 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
9069 if (NILP (help_echo_string
))
9070 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
9073 #endif /* HAVE_WINDOW_SYSTEM */
9077 /************************************************************************
9078 Horizontal scrolling
9079 ************************************************************************/
9081 static int hscroll_window_tree
P_ ((Lisp_Object
));
9082 static int hscroll_windows
P_ ((Lisp_Object
));
9084 /* For all leaf windows in the window tree rooted at WINDOW, set their
9085 hscroll value so that PT is (i) visible in the window, and (ii) so
9086 that it is not within a certain margin at the window's left and
9087 right border. Value is non-zero if any window's hscroll has been
9091 hscroll_window_tree (window
)
9094 int hscrolled_p
= 0;
9095 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
9096 int hscroll_step_abs
= 0;
9097 double hscroll_step_rel
= 0;
9099 if (hscroll_relative_p
)
9101 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
9102 if (hscroll_step_rel
< 0)
9104 hscroll_relative_p
= 0;
9105 hscroll_step_abs
= 0;
9108 else if (INTEGERP (Vhscroll_step
))
9110 hscroll_step_abs
= XINT (Vhscroll_step
);
9111 if (hscroll_step_abs
< 0)
9112 hscroll_step_abs
= 0;
9115 hscroll_step_abs
= 0;
9117 while (WINDOWP (window
))
9119 struct window
*w
= XWINDOW (window
);
9121 if (WINDOWP (w
->hchild
))
9122 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
9123 else if (WINDOWP (w
->vchild
))
9124 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
9125 else if (w
->cursor
.vpos
>= 0)
9128 int text_area_width
;
9129 struct glyph_row
*current_cursor_row
9130 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
9131 struct glyph_row
*desired_cursor_row
9132 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
9133 struct glyph_row
*cursor_row
9134 = (desired_cursor_row
->enabled_p
9135 ? desired_cursor_row
9136 : current_cursor_row
);
9138 text_area_width
= window_box_width (w
, TEXT_AREA
);
9140 /* Scroll when cursor is inside this scroll margin. */
9141 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
9143 if ((XFASTINT (w
->hscroll
)
9144 && w
->cursor
.x
<= h_margin
)
9145 || (cursor_row
->enabled_p
9146 && cursor_row
->truncated_on_right_p
9147 && (w
->cursor
.x
>= text_area_width
- h_margin
)))
9151 struct buffer
*saved_current_buffer
;
9155 /* Find point in a display of infinite width. */
9156 saved_current_buffer
= current_buffer
;
9157 current_buffer
= XBUFFER (w
->buffer
);
9159 if (w
== XWINDOW (selected_window
))
9160 pt
= BUF_PT (current_buffer
);
9163 pt
= marker_position (w
->pointm
);
9164 pt
= max (BEGV
, pt
);
9168 /* Move iterator to pt starting at cursor_row->start in
9169 a line with infinite width. */
9170 init_to_row_start (&it
, w
, cursor_row
);
9171 it
.last_visible_x
= INFINITY
;
9172 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
9173 current_buffer
= saved_current_buffer
;
9175 /* Position cursor in window. */
9176 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
9177 hscroll
= max (0, (it
.current_x
9178 - (ITERATOR_AT_END_OF_LINE_P (&it
)
9179 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
9180 : (text_area_width
/ 2))))
9181 / FRAME_COLUMN_WIDTH (it
.f
);
9182 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
9184 if (hscroll_relative_p
)
9185 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
9188 wanted_x
= text_area_width
9189 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
9192 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
9196 if (hscroll_relative_p
)
9197 wanted_x
= text_area_width
* hscroll_step_rel
9200 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
9203 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
9205 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
9207 /* Don't call Fset_window_hscroll if value hasn't
9208 changed because it will prevent redisplay
9210 if (XFASTINT (w
->hscroll
) != hscroll
)
9212 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
9213 w
->hscroll
= make_number (hscroll
);
9222 /* Value is non-zero if hscroll of any leaf window has been changed. */
9227 /* Set hscroll so that cursor is visible and not inside horizontal
9228 scroll margins for all windows in the tree rooted at WINDOW. See
9229 also hscroll_window_tree above. Value is non-zero if any window's
9230 hscroll has been changed. If it has, desired matrices on the frame
9231 of WINDOW are cleared. */
9234 hscroll_windows (window
)
9239 if (automatic_hscrolling_p
)
9241 hscrolled_p
= hscroll_window_tree (window
);
9243 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
9252 /************************************************************************
9254 ************************************************************************/
9256 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
9257 to a non-zero value. This is sometimes handy to have in a debugger
9262 /* First and last unchanged row for try_window_id. */
9264 int debug_first_unchanged_at_end_vpos
;
9265 int debug_last_unchanged_at_beg_vpos
;
9267 /* Delta vpos and y. */
9269 int debug_dvpos
, debug_dy
;
9271 /* Delta in characters and bytes for try_window_id. */
9273 int debug_delta
, debug_delta_bytes
;
9275 /* Values of window_end_pos and window_end_vpos at the end of
9278 EMACS_INT debug_end_pos
, debug_end_vpos
;
9280 /* Append a string to W->desired_matrix->method. FMT is a printf
9281 format string. A1...A9 are a supplement for a variable-length
9282 argument list. If trace_redisplay_p is non-zero also printf the
9283 resulting string to stderr. */
9286 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
9289 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
9292 char *method
= w
->desired_matrix
->method
;
9293 int len
= strlen (method
);
9294 int size
= sizeof w
->desired_matrix
->method
;
9295 int remaining
= size
- len
- 1;
9297 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
9298 if (len
&& remaining
)
9304 strncpy (method
+ len
, buffer
, remaining
);
9306 if (trace_redisplay_p
)
9307 fprintf (stderr
, "%p (%s): %s\n",
9309 ((BUFFERP (w
->buffer
)
9310 && STRINGP (XBUFFER (w
->buffer
)->name
))
9311 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
9316 #endif /* GLYPH_DEBUG */
9319 /* Value is non-zero if all changes in window W, which displays
9320 current_buffer, are in the text between START and END. START is a
9321 buffer position, END is given as a distance from Z. Used in
9322 redisplay_internal for display optimization. */
9325 text_outside_line_unchanged_p (w
, start
, end
)
9329 int unchanged_p
= 1;
9331 /* If text or overlays have changed, see where. */
9332 if (XFASTINT (w
->last_modified
) < MODIFF
9333 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
9335 /* Gap in the line? */
9336 if (GPT
< start
|| Z
- GPT
< end
)
9339 /* Changes start in front of the line, or end after it? */
9341 && (BEG_UNCHANGED
< start
- 1
9342 || END_UNCHANGED
< end
))
9345 /* If selective display, can't optimize if changes start at the
9346 beginning of the line. */
9348 && INTEGERP (current_buffer
->selective_display
)
9349 && XINT (current_buffer
->selective_display
) > 0
9350 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
9353 /* If there are overlays at the start or end of the line, these
9354 may have overlay strings with newlines in them. A change at
9355 START, for instance, may actually concern the display of such
9356 overlay strings as well, and they are displayed on different
9357 lines. So, quickly rule out this case. (For the future, it
9358 might be desirable to implement something more telling than
9359 just BEG/END_UNCHANGED.) */
9362 if (BEG
+ BEG_UNCHANGED
== start
9363 && overlay_touches_p (start
))
9365 if (END_UNCHANGED
== end
9366 && overlay_touches_p (Z
- end
))
9375 /* Do a frame update, taking possible shortcuts into account. This is
9376 the main external entry point for redisplay.
9378 If the last redisplay displayed an echo area message and that message
9379 is no longer requested, we clear the echo area or bring back the
9380 mini-buffer if that is in use. */
9385 redisplay_internal (0);
9390 overlay_arrow_string_or_property (var
, pbitmap
)
9394 Lisp_Object pstr
= Fget (var
, Qoverlay_arrow_string
);
9400 if (bitmap
= Fget (var
, Qoverlay_arrow_bitmap
), INTEGERP (bitmap
))
9401 *pbitmap
= XINT (bitmap
);
9406 return Voverlay_arrow_string
;
9409 /* Return 1 if there are any overlay-arrows in current_buffer. */
9411 overlay_arrow_in_current_buffer_p ()
9415 for (vlist
= Voverlay_arrow_variable_list
;
9417 vlist
= XCDR (vlist
))
9419 Lisp_Object var
= XCAR (vlist
);
9424 val
= find_symbol_value (var
);
9426 && current_buffer
== XMARKER (val
)->buffer
)
9433 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
9437 overlay_arrows_changed_p ()
9441 for (vlist
= Voverlay_arrow_variable_list
;
9443 vlist
= XCDR (vlist
))
9445 Lisp_Object var
= XCAR (vlist
);
9446 Lisp_Object val
, pstr
;
9450 val
= find_symbol_value (var
);
9453 if (! EQ (COERCE_MARKER (val
),
9454 Fget (var
, Qlast_arrow_position
))
9455 || ! (pstr
= overlay_arrow_string_or_property (var
, 0),
9456 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
9462 /* Mark overlay arrows to be updated on next redisplay. */
9465 update_overlay_arrows (up_to_date
)
9470 for (vlist
= Voverlay_arrow_variable_list
;
9472 vlist
= XCDR (vlist
))
9474 Lisp_Object var
= XCAR (vlist
);
9481 Lisp_Object val
= find_symbol_value (var
);
9482 Fput (var
, Qlast_arrow_position
,
9483 COERCE_MARKER (val
));
9484 Fput (var
, Qlast_arrow_string
,
9485 overlay_arrow_string_or_property (var
, 0));
9487 else if (up_to_date
< 0
9488 || !NILP (Fget (var
, Qlast_arrow_position
)))
9490 Fput (var
, Qlast_arrow_position
, Qt
);
9491 Fput (var
, Qlast_arrow_string
, Qt
);
9497 /* Return overlay arrow string at row, or nil. */
9500 overlay_arrow_at_row (f
, row
, pbitmap
)
9502 struct glyph_row
*row
;
9507 for (vlist
= Voverlay_arrow_variable_list
;
9509 vlist
= XCDR (vlist
))
9511 Lisp_Object var
= XCAR (vlist
);
9517 val
= find_symbol_value (var
);
9520 && current_buffer
== XMARKER (val
)->buffer
9521 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
9523 val
= overlay_arrow_string_or_property (var
, pbitmap
);
9524 if (FRAME_WINDOW_P (f
))
9526 else if (STRINGP (val
))
9536 /* Return 1 if point moved out of or into a composition. Otherwise
9537 return 0. PREV_BUF and PREV_PT are the last point buffer and
9538 position. BUF and PT are the current point buffer and position. */
9541 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
9542 struct buffer
*prev_buf
, *buf
;
9549 XSETBUFFER (buffer
, buf
);
9550 /* Check a composition at the last point if point moved within the
9552 if (prev_buf
== buf
)
9555 /* Point didn't move. */
9558 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
9559 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
9560 && COMPOSITION_VALID_P (start
, end
, prop
)
9561 && start
< prev_pt
&& end
> prev_pt
)
9562 /* The last point was within the composition. Return 1 iff
9563 point moved out of the composition. */
9564 return (pt
<= start
|| pt
>= end
);
9567 /* Check a composition at the current point. */
9568 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
9569 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
9570 && COMPOSITION_VALID_P (start
, end
, prop
)
9571 && start
< pt
&& end
> pt
);
9575 /* Reconsider the setting of B->clip_changed which is displayed
9579 reconsider_clip_changes (w
, b
)
9584 && !NILP (w
->window_end_valid
)
9585 && w
->current_matrix
->buffer
== b
9586 && w
->current_matrix
->zv
== BUF_ZV (b
)
9587 && w
->current_matrix
->begv
== BUF_BEGV (b
))
9588 b
->clip_changed
= 0;
9590 /* If display wasn't paused, and W is not a tool bar window, see if
9591 point has been moved into or out of a composition. In that case,
9592 we set b->clip_changed to 1 to force updating the screen. If
9593 b->clip_changed has already been set to 1, we can skip this
9595 if (!b
->clip_changed
9596 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
9600 if (w
== XWINDOW (selected_window
))
9601 pt
= BUF_PT (current_buffer
);
9603 pt
= marker_position (w
->pointm
);
9605 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
9606 || pt
!= XINT (w
->last_point
))
9607 && check_point_in_composition (w
->current_matrix
->buffer
,
9608 XINT (w
->last_point
),
9609 XBUFFER (w
->buffer
), pt
))
9610 b
->clip_changed
= 1;
9615 /* Select FRAME to forward the values of frame-local variables into C
9616 variables so that the redisplay routines can access those values
9620 select_frame_for_redisplay (frame
)
9623 Lisp_Object tail
, sym
, val
;
9624 Lisp_Object old
= selected_frame
;
9626 selected_frame
= frame
;
9628 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
9629 if (CONSP (XCAR (tail
))
9630 && (sym
= XCAR (XCAR (tail
)),
9632 && (sym
= indirect_variable (sym
),
9633 val
= SYMBOL_VALUE (sym
),
9634 (BUFFER_LOCAL_VALUEP (val
)
9635 || SOME_BUFFER_LOCAL_VALUEP (val
)))
9636 && XBUFFER_LOCAL_VALUE (val
)->check_frame
)
9637 Fsymbol_value (sym
);
9639 for (tail
= XFRAME (old
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
9640 if (CONSP (XCAR (tail
))
9641 && (sym
= XCAR (XCAR (tail
)),
9643 && (sym
= indirect_variable (sym
),
9644 val
= SYMBOL_VALUE (sym
),
9645 (BUFFER_LOCAL_VALUEP (val
)
9646 || SOME_BUFFER_LOCAL_VALUEP (val
)))
9647 && XBUFFER_LOCAL_VALUE (val
)->check_frame
)
9648 Fsymbol_value (sym
);
9652 #define STOP_POLLING \
9653 do { if (! polling_stopped_here) stop_polling (); \
9654 polling_stopped_here = 1; } while (0)
9656 #define RESUME_POLLING \
9657 do { if (polling_stopped_here) start_polling (); \
9658 polling_stopped_here = 0; } while (0)
9661 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
9662 response to any user action; therefore, we should preserve the echo
9663 area. (Actually, our caller does that job.) Perhaps in the future
9664 avoid recentering windows if it is not necessary; currently that
9665 causes some problems. */
9668 redisplay_internal (preserve_echo_area
)
9669 int preserve_echo_area
;
9671 struct window
*w
= XWINDOW (selected_window
);
9672 struct frame
*f
= XFRAME (w
->frame
);
9674 int must_finish
= 0;
9675 struct text_pos tlbufpos
, tlendpos
;
9676 int number_of_visible_frames
;
9678 struct frame
*sf
= SELECTED_FRAME ();
9679 int polling_stopped_here
= 0;
9681 /* Non-zero means redisplay has to consider all windows on all
9682 frames. Zero means, only selected_window is considered. */
9683 int consider_all_windows_p
;
9685 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
9687 /* No redisplay if running in batch mode or frame is not yet fully
9688 initialized, or redisplay is explicitly turned off by setting
9689 Vinhibit_redisplay. */
9691 || !NILP (Vinhibit_redisplay
)
9692 || !f
->glyphs_initialized_p
)
9695 /* The flag redisplay_performed_directly_p is set by
9696 direct_output_for_insert when it already did the whole screen
9697 update necessary. */
9698 if (redisplay_performed_directly_p
)
9700 redisplay_performed_directly_p
= 0;
9701 if (!hscroll_windows (selected_window
))
9705 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
9706 if (popup_activated ())
9710 /* I don't think this happens but let's be paranoid. */
9714 /* Record a function that resets redisplaying_p to its old value
9715 when we leave this function. */
9716 count
= SPECPDL_INDEX ();
9717 record_unwind_protect (unwind_redisplay
,
9718 Fcons (make_number (redisplaying_p
), selected_frame
));
9720 specbind (Qinhibit_free_realized_faces
, Qnil
);
9724 reconsider_clip_changes (w
, current_buffer
);
9726 /* If new fonts have been loaded that make a glyph matrix adjustment
9727 necessary, do it. */
9728 if (fonts_changed_p
)
9730 adjust_glyphs (NULL
);
9731 ++windows_or_buffers_changed
;
9732 fonts_changed_p
= 0;
9735 /* If face_change_count is non-zero, init_iterator will free all
9736 realized faces, which includes the faces referenced from current
9737 matrices. So, we can't reuse current matrices in this case. */
9738 if (face_change_count
)
9739 ++windows_or_buffers_changed
;
9741 if (! FRAME_WINDOW_P (sf
)
9742 && previous_terminal_frame
!= sf
)
9744 /* Since frames on an ASCII terminal share the same display
9745 area, displaying a different frame means redisplay the whole
9747 windows_or_buffers_changed
++;
9748 SET_FRAME_GARBAGED (sf
);
9749 XSETFRAME (Vterminal_frame
, sf
);
9751 previous_terminal_frame
= sf
;
9753 /* Set the visible flags for all frames. Do this before checking
9754 for resized or garbaged frames; they want to know if their frames
9755 are visible. See the comment in frame.h for
9756 FRAME_SAMPLE_VISIBILITY. */
9758 Lisp_Object tail
, frame
;
9760 number_of_visible_frames
= 0;
9762 FOR_EACH_FRAME (tail
, frame
)
9764 struct frame
*f
= XFRAME (frame
);
9766 FRAME_SAMPLE_VISIBILITY (f
);
9767 if (FRAME_VISIBLE_P (f
))
9768 ++number_of_visible_frames
;
9769 clear_desired_matrices (f
);
9773 /* Notice any pending interrupt request to change frame size. */
9774 do_pending_window_change (1);
9776 /* Clear frames marked as garbaged. */
9778 clear_garbaged_frames ();
9780 /* Build menubar and tool-bar items. */
9781 prepare_menu_bars ();
9783 if (windows_or_buffers_changed
)
9784 update_mode_lines
++;
9786 /* Detect case that we need to write or remove a star in the mode line. */
9787 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
9789 w
->update_mode_line
= Qt
;
9790 if (buffer_shared
> 1)
9791 update_mode_lines
++;
9794 /* If %c is in the mode line, update it if needed. */
9795 if (!NILP (w
->column_number_displayed
)
9796 /* This alternative quickly identifies a common case
9797 where no change is needed. */
9798 && !(PT
== XFASTINT (w
->last_point
)
9799 && XFASTINT (w
->last_modified
) >= MODIFF
9800 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
9801 && (XFASTINT (w
->column_number_displayed
)
9802 != (int) current_column ())) /* iftc */
9803 w
->update_mode_line
= Qt
;
9805 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
9807 /* The variable buffer_shared is set in redisplay_window and
9808 indicates that we redisplay a buffer in different windows. See
9810 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
9811 || cursor_type_changed
);
9813 /* If specs for an arrow have changed, do thorough redisplay
9814 to ensure we remove any arrow that should no longer exist. */
9815 if (overlay_arrows_changed_p ())
9816 consider_all_windows_p
= windows_or_buffers_changed
= 1;
9818 /* Normally the message* functions will have already displayed and
9819 updated the echo area, but the frame may have been trashed, or
9820 the update may have been preempted, so display the echo area
9821 again here. Checking message_cleared_p captures the case that
9822 the echo area should be cleared. */
9823 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
9824 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
9825 || (message_cleared_p
9826 && minibuf_level
== 0
9827 /* If the mini-window is currently selected, this means the
9828 echo-area doesn't show through. */
9829 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
9831 int window_height_changed_p
= echo_area_display (0);
9834 /* If we don't display the current message, don't clear the
9835 message_cleared_p flag, because, if we did, we wouldn't clear
9836 the echo area in the next redisplay which doesn't preserve
9838 if (!display_last_displayed_message_p
)
9839 message_cleared_p
= 0;
9841 if (fonts_changed_p
)
9843 else if (window_height_changed_p
)
9845 consider_all_windows_p
= 1;
9846 ++update_mode_lines
;
9847 ++windows_or_buffers_changed
;
9849 /* If window configuration was changed, frames may have been
9850 marked garbaged. Clear them or we will experience
9851 surprises wrt scrolling. */
9853 clear_garbaged_frames ();
9856 else if (EQ (selected_window
, minibuf_window
)
9857 && (current_buffer
->clip_changed
9858 || XFASTINT (w
->last_modified
) < MODIFF
9859 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
9860 && resize_mini_window (w
, 0))
9862 /* Resized active mini-window to fit the size of what it is
9863 showing if its contents might have changed. */
9865 consider_all_windows_p
= 1;
9866 ++windows_or_buffers_changed
;
9867 ++update_mode_lines
;
9869 /* If window configuration was changed, frames may have been
9870 marked garbaged. Clear them or we will experience
9871 surprises wrt scrolling. */
9873 clear_garbaged_frames ();
9877 /* If showing the region, and mark has changed, we must redisplay
9878 the whole window. The assignment to this_line_start_pos prevents
9879 the optimization directly below this if-statement. */
9880 if (((!NILP (Vtransient_mark_mode
)
9881 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9882 != !NILP (w
->region_showing
))
9883 || (!NILP (w
->region_showing
)
9884 && !EQ (w
->region_showing
,
9885 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
9886 CHARPOS (this_line_start_pos
) = 0;
9888 /* Optimize the case that only the line containing the cursor in the
9889 selected window has changed. Variables starting with this_ are
9890 set in display_line and record information about the line
9891 containing the cursor. */
9892 tlbufpos
= this_line_start_pos
;
9893 tlendpos
= this_line_end_pos
;
9894 if (!consider_all_windows_p
9895 && CHARPOS (tlbufpos
) > 0
9896 && NILP (w
->update_mode_line
)
9897 && !current_buffer
->clip_changed
9898 && !current_buffer
->prevent_redisplay_optimizations_p
9899 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
9900 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
9901 /* Make sure recorded data applies to current buffer, etc. */
9902 && this_line_buffer
== current_buffer
9903 && current_buffer
== XBUFFER (w
->buffer
)
9904 && NILP (w
->force_start
)
9905 && NILP (w
->optional_new_start
)
9906 /* Point must be on the line that we have info recorded about. */
9907 && PT
>= CHARPOS (tlbufpos
)
9908 && PT
<= Z
- CHARPOS (tlendpos
)
9909 /* All text outside that line, including its final newline,
9910 must be unchanged */
9911 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
9912 CHARPOS (tlendpos
)))
9914 if (CHARPOS (tlbufpos
) > BEGV
9915 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
9916 && (CHARPOS (tlbufpos
) == ZV
9917 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
9918 /* Former continuation line has disappeared by becoming empty */
9920 else if (XFASTINT (w
->last_modified
) < MODIFF
9921 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
9922 || MINI_WINDOW_P (w
))
9924 /* We have to handle the case of continuation around a
9925 wide-column character (See the comment in indent.c around
9928 For instance, in the following case:
9930 -------- Insert --------
9931 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
9932 J_I_ ==> J_I_ `^^' are cursors.
9936 As we have to redraw the line above, we should goto cancel. */
9939 int line_height_before
= this_line_pixel_height
;
9941 /* Note that start_display will handle the case that the
9942 line starting at tlbufpos is a continuation lines. */
9943 start_display (&it
, w
, tlbufpos
);
9945 /* Implementation note: It this still necessary? */
9946 if (it
.current_x
!= this_line_start_x
)
9949 TRACE ((stderr
, "trying display optimization 1\n"));
9950 w
->cursor
.vpos
= -1;
9951 overlay_arrow_seen
= 0;
9952 it
.vpos
= this_line_vpos
;
9953 it
.current_y
= this_line_y
;
9954 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
9957 /* If line contains point, is not continued,
9958 and ends at same distance from eob as before, we win */
9959 if (w
->cursor
.vpos
>= 0
9960 /* Line is not continued, otherwise this_line_start_pos
9961 would have been set to 0 in display_line. */
9962 && CHARPOS (this_line_start_pos
)
9963 /* Line ends as before. */
9964 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
9965 /* Line has same height as before. Otherwise other lines
9966 would have to be shifted up or down. */
9967 && this_line_pixel_height
== line_height_before
)
9969 /* If this is not the window's last line, we must adjust
9970 the charstarts of the lines below. */
9971 if (it
.current_y
< it
.last_visible_y
)
9973 struct glyph_row
*row
9974 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
9975 int delta
, delta_bytes
;
9977 if (Z
- CHARPOS (tlendpos
) == ZV
)
9979 /* This line ends at end of (accessible part of)
9980 buffer. There is no newline to count. */
9982 - CHARPOS (tlendpos
)
9983 - MATRIX_ROW_START_CHARPOS (row
));
9984 delta_bytes
= (Z_BYTE
9985 - BYTEPOS (tlendpos
)
9986 - MATRIX_ROW_START_BYTEPOS (row
));
9990 /* This line ends in a newline. Must take
9991 account of the newline and the rest of the
9992 text that follows. */
9994 - CHARPOS (tlendpos
)
9995 - MATRIX_ROW_START_CHARPOS (row
));
9996 delta_bytes
= (Z_BYTE
9997 - BYTEPOS (tlendpos
)
9998 - MATRIX_ROW_START_BYTEPOS (row
));
10001 increment_matrix_positions (w
->current_matrix
,
10002 this_line_vpos
+ 1,
10003 w
->current_matrix
->nrows
,
10004 delta
, delta_bytes
);
10007 /* If this row displays text now but previously didn't,
10008 or vice versa, w->window_end_vpos may have to be
10010 if ((it
.glyph_row
- 1)->displays_text_p
)
10012 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
10013 XSETINT (w
->window_end_vpos
, this_line_vpos
);
10015 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
10016 && this_line_vpos
> 0)
10017 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
10018 w
->window_end_valid
= Qnil
;
10020 /* Update hint: No need to try to scroll in update_window. */
10021 w
->desired_matrix
->no_scrolling_p
= 1;
10024 *w
->desired_matrix
->method
= 0;
10025 debug_method_add (w
, "optimization 1");
10027 #ifdef HAVE_WINDOW_SYSTEM
10028 update_window_fringes (w
, 0);
10035 else if (/* Cursor position hasn't changed. */
10036 PT
== XFASTINT (w
->last_point
)
10037 /* Make sure the cursor was last displayed
10038 in this window. Otherwise we have to reposition it. */
10039 && 0 <= w
->cursor
.vpos
10040 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
10044 do_pending_window_change (1);
10046 /* We used to always goto end_of_redisplay here, but this
10047 isn't enough if we have a blinking cursor. */
10048 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
10049 goto end_of_redisplay
;
10053 /* If highlighting the region, or if the cursor is in the echo area,
10054 then we can't just move the cursor. */
10055 else if (! (!NILP (Vtransient_mark_mode
)
10056 && !NILP (current_buffer
->mark_active
))
10057 && (EQ (selected_window
, current_buffer
->last_selected_window
)
10058 || highlight_nonselected_windows
)
10059 && NILP (w
->region_showing
)
10060 && NILP (Vshow_trailing_whitespace
)
10061 && !cursor_in_echo_area
)
10064 struct glyph_row
*row
;
10066 /* Skip from tlbufpos to PT and see where it is. Note that
10067 PT may be in invisible text. If so, we will end at the
10068 next visible position. */
10069 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
10070 NULL
, DEFAULT_FACE_ID
);
10071 it
.current_x
= this_line_start_x
;
10072 it
.current_y
= this_line_y
;
10073 it
.vpos
= this_line_vpos
;
10075 /* The call to move_it_to stops in front of PT, but
10076 moves over before-strings. */
10077 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
10079 if (it
.vpos
== this_line_vpos
10080 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
10083 xassert (this_line_vpos
== it
.vpos
);
10084 xassert (this_line_y
== it
.current_y
);
10085 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
10087 *w
->desired_matrix
->method
= 0;
10088 debug_method_add (w
, "optimization 3");
10097 /* Text changed drastically or point moved off of line. */
10098 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
10101 CHARPOS (this_line_start_pos
) = 0;
10102 consider_all_windows_p
|= buffer_shared
> 1;
10103 ++clear_face_cache_count
;
10106 /* Build desired matrices, and update the display. If
10107 consider_all_windows_p is non-zero, do it for all windows on all
10108 frames. Otherwise do it for selected_window, only. */
10110 if (consider_all_windows_p
)
10112 Lisp_Object tail
, frame
;
10113 int i
, n
= 0, size
= 50;
10114 struct frame
**updated
10115 = (struct frame
**) alloca (size
* sizeof *updated
);
10117 /* Clear the face cache eventually. */
10118 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
10120 clear_face_cache (0);
10121 clear_face_cache_count
= 0;
10124 /* Recompute # windows showing selected buffer. This will be
10125 incremented each time such a window is displayed. */
10128 FOR_EACH_FRAME (tail
, frame
)
10130 struct frame
*f
= XFRAME (frame
);
10132 if (FRAME_WINDOW_P (f
) || f
== sf
)
10134 if (! EQ (frame
, selected_frame
))
10135 /* Select the frame, for the sake of frame-local
10137 select_frame_for_redisplay (frame
);
10139 #ifdef HAVE_WINDOW_SYSTEM
10140 if (clear_face_cache_count
% 50 == 0
10141 && FRAME_WINDOW_P (f
))
10142 clear_image_cache (f
, 0);
10143 #endif /* HAVE_WINDOW_SYSTEM */
10145 /* Mark all the scroll bars to be removed; we'll redeem
10146 the ones we want when we redisplay their windows. */
10147 if (condemn_scroll_bars_hook
)
10148 condemn_scroll_bars_hook (f
);
10150 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
10151 redisplay_windows (FRAME_ROOT_WINDOW (f
));
10153 /* Any scroll bars which redisplay_windows should have
10154 nuked should now go away. */
10155 if (judge_scroll_bars_hook
)
10156 judge_scroll_bars_hook (f
);
10158 /* If fonts changed, display again. */
10159 /* ??? rms: I suspect it is a mistake to jump all the way
10160 back to retry here. It should just retry this frame. */
10161 if (fonts_changed_p
)
10164 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
10166 /* See if we have to hscroll. */
10167 if (hscroll_windows (f
->root_window
))
10170 /* Prevent various kinds of signals during display
10171 update. stdio is not robust about handling
10172 signals, which can cause an apparent I/O
10174 if (interrupt_input
)
10175 unrequest_sigio ();
10178 /* Update the display. */
10179 set_window_update_flags (XWINDOW (f
->root_window
), 1);
10180 pause
|= update_frame (f
, 0, 0);
10181 #if 0 /* Exiting the loop can leave the wrong value for buffer_shared. */
10188 int nbytes
= size
* sizeof *updated
;
10189 struct frame
**p
= (struct frame
**) alloca (2 * nbytes
);
10190 bcopy (updated
, p
, nbytes
);
10201 /* Do the mark_window_display_accurate after all windows have
10202 been redisplayed because this call resets flags in buffers
10203 which are needed for proper redisplay. */
10204 for (i
= 0; i
< n
; ++i
)
10206 struct frame
*f
= updated
[i
];
10207 mark_window_display_accurate (f
->root_window
, 1);
10208 if (frame_up_to_date_hook
)
10209 frame_up_to_date_hook (f
);
10213 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
10215 Lisp_Object mini_window
;
10216 struct frame
*mini_frame
;
10218 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
10219 /* Use list_of_error, not Qerror, so that
10220 we catch only errors and don't run the debugger. */
10221 internal_condition_case_1 (redisplay_window_1
, selected_window
,
10223 redisplay_window_error
);
10225 /* Compare desired and current matrices, perform output. */
10228 /* If fonts changed, display again. */
10229 if (fonts_changed_p
)
10232 /* Prevent various kinds of signals during display update.
10233 stdio is not robust about handling signals,
10234 which can cause an apparent I/O error. */
10235 if (interrupt_input
)
10236 unrequest_sigio ();
10239 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
10241 if (hscroll_windows (selected_window
))
10244 XWINDOW (selected_window
)->must_be_updated_p
= 1;
10245 pause
= update_frame (sf
, 0, 0);
10248 /* We may have called echo_area_display at the top of this
10249 function. If the echo area is on another frame, that may
10250 have put text on a frame other than the selected one, so the
10251 above call to update_frame would not have caught it. Catch
10253 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10254 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10256 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
10258 XWINDOW (mini_window
)->must_be_updated_p
= 1;
10259 pause
|= update_frame (mini_frame
, 0, 0);
10260 if (!pause
&& hscroll_windows (mini_window
))
10265 /* If display was paused because of pending input, make sure we do a
10266 thorough update the next time. */
10269 /* Prevent the optimization at the beginning of
10270 redisplay_internal that tries a single-line update of the
10271 line containing the cursor in the selected window. */
10272 CHARPOS (this_line_start_pos
) = 0;
10274 /* Let the overlay arrow be updated the next time. */
10275 update_overlay_arrows (0);
10277 /* If we pause after scrolling, some rows in the current
10278 matrices of some windows are not valid. */
10279 if (!WINDOW_FULL_WIDTH_P (w
)
10280 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
10281 update_mode_lines
= 1;
10285 if (!consider_all_windows_p
)
10287 /* This has already been done above if
10288 consider_all_windows_p is set. */
10289 mark_window_display_accurate_1 (w
, 1);
10291 /* Say overlay arrows are up to date. */
10292 update_overlay_arrows (1);
10294 if (frame_up_to_date_hook
!= 0)
10295 frame_up_to_date_hook (sf
);
10298 update_mode_lines
= 0;
10299 windows_or_buffers_changed
= 0;
10300 cursor_type_changed
= 0;
10303 /* Start SIGIO interrupts coming again. Having them off during the
10304 code above makes it less likely one will discard output, but not
10305 impossible, since there might be stuff in the system buffer here.
10306 But it is much hairier to try to do anything about that. */
10307 if (interrupt_input
)
10311 /* If a frame has become visible which was not before, redisplay
10312 again, so that we display it. Expose events for such a frame
10313 (which it gets when becoming visible) don't call the parts of
10314 redisplay constructing glyphs, so simply exposing a frame won't
10315 display anything in this case. So, we have to display these
10316 frames here explicitly. */
10319 Lisp_Object tail
, frame
;
10322 FOR_EACH_FRAME (tail
, frame
)
10324 int this_is_visible
= 0;
10326 if (XFRAME (frame
)->visible
)
10327 this_is_visible
= 1;
10328 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
10329 if (XFRAME (frame
)->visible
)
10330 this_is_visible
= 1;
10332 if (this_is_visible
)
10336 if (new_count
!= number_of_visible_frames
)
10337 windows_or_buffers_changed
++;
10340 /* Change frame size now if a change is pending. */
10341 do_pending_window_change (1);
10343 /* If we just did a pending size change, or have additional
10344 visible frames, redisplay again. */
10345 if (windows_or_buffers_changed
&& !pause
)
10349 unbind_to (count
, Qnil
);
10354 /* Redisplay, but leave alone any recent echo area message unless
10355 another message has been requested in its place.
10357 This is useful in situations where you need to redisplay but no
10358 user action has occurred, making it inappropriate for the message
10359 area to be cleared. See tracking_off and
10360 wait_reading_process_input for examples of these situations.
10362 FROM_WHERE is an integer saying from where this function was
10363 called. This is useful for debugging. */
10366 redisplay_preserve_echo_area (from_where
)
10369 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
10371 if (!NILP (echo_area_buffer
[1]))
10373 /* We have a previously displayed message, but no current
10374 message. Redisplay the previous message. */
10375 display_last_displayed_message_p
= 1;
10376 redisplay_internal (1);
10377 display_last_displayed_message_p
= 0;
10380 redisplay_internal (1);
10384 /* Function registered with record_unwind_protect in
10385 redisplay_internal. Reset redisplaying_p to the value it had
10386 before redisplay_internal was called, and clear
10387 prevent_freeing_realized_faces_p. It also selects the previously
10391 unwind_redisplay (val
)
10394 Lisp_Object old_redisplaying_p
, old_frame
;
10396 old_redisplaying_p
= XCAR (val
);
10397 redisplaying_p
= XFASTINT (old_redisplaying_p
);
10398 old_frame
= XCDR (val
);
10399 if (! EQ (old_frame
, selected_frame
))
10400 select_frame_for_redisplay (old_frame
);
10405 /* Mark the display of window W as accurate or inaccurate. If
10406 ACCURATE_P is non-zero mark display of W as accurate. If
10407 ACCURATE_P is zero, arrange for W to be redisplayed the next time
10408 redisplay_internal is called. */
10411 mark_window_display_accurate_1 (w
, accurate_p
)
10415 if (BUFFERP (w
->buffer
))
10417 struct buffer
*b
= XBUFFER (w
->buffer
);
10420 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
10421 w
->last_overlay_modified
10422 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
10424 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
10428 b
->clip_changed
= 0;
10429 b
->prevent_redisplay_optimizations_p
= 0;
10431 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
10432 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
10433 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
10434 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
10436 w
->current_matrix
->buffer
= b
;
10437 w
->current_matrix
->begv
= BUF_BEGV (b
);
10438 w
->current_matrix
->zv
= BUF_ZV (b
);
10440 w
->last_cursor
= w
->cursor
;
10441 w
->last_cursor_off_p
= w
->cursor_off_p
;
10443 if (w
== XWINDOW (selected_window
))
10444 w
->last_point
= make_number (BUF_PT (b
));
10446 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
10452 w
->window_end_valid
= w
->buffer
;
10453 #if 0 /* This is incorrect with variable-height lines. */
10454 xassert (XINT (w
->window_end_vpos
)
10455 < (WINDOW_TOTAL_LINES (w
)
10456 - (WINDOW_WANTS_MODELINE_P (w
) ? 1 : 0)));
10458 w
->update_mode_line
= Qnil
;
10463 /* Mark the display of windows in the window tree rooted at WINDOW as
10464 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
10465 windows as accurate. If ACCURATE_P is zero, arrange for windows to
10466 be redisplayed the next time redisplay_internal is called. */
10469 mark_window_display_accurate (window
, accurate_p
)
10470 Lisp_Object window
;
10475 for (; !NILP (window
); window
= w
->next
)
10477 w
= XWINDOW (window
);
10478 mark_window_display_accurate_1 (w
, accurate_p
);
10480 if (!NILP (w
->vchild
))
10481 mark_window_display_accurate (w
->vchild
, accurate_p
);
10482 if (!NILP (w
->hchild
))
10483 mark_window_display_accurate (w
->hchild
, accurate_p
);
10488 update_overlay_arrows (1);
10492 /* Force a thorough redisplay the next time by setting
10493 last_arrow_position and last_arrow_string to t, which is
10494 unequal to any useful value of Voverlay_arrow_... */
10495 update_overlay_arrows (-1);
10500 /* Return value in display table DP (Lisp_Char_Table *) for character
10501 C. Since a display table doesn't have any parent, we don't have to
10502 follow parent. Do not call this function directly but use the
10503 macro DISP_CHAR_VECTOR. */
10506 disp_char_vector (dp
, c
)
10507 struct Lisp_Char_Table
*dp
;
10513 if (SINGLE_BYTE_CHAR_P (c
))
10514 return (dp
->contents
[c
]);
10516 SPLIT_CHAR (c
, code
[0], code
[1], code
[2]);
10519 else if (code
[2] < 32)
10522 /* Here, the possible range of code[0] (== charset ID) is
10523 128..max_charset. Since the top level char table contains data
10524 for multibyte characters after 256th element, we must increment
10525 code[0] by 128 to get a correct index. */
10527 code
[3] = -1; /* anchor */
10529 for (i
= 0; code
[i
] >= 0; i
++, dp
= XCHAR_TABLE (val
))
10531 val
= dp
->contents
[code
[i
]];
10532 if (!SUB_CHAR_TABLE_P (val
))
10533 return (NILP (val
) ? dp
->defalt
: val
);
10536 /* Here, val is a sub char table. We return the default value of
10538 return (dp
->defalt
);
10543 /***********************************************************************
10545 ***********************************************************************/
10547 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
10550 redisplay_windows (window
)
10551 Lisp_Object window
;
10553 while (!NILP (window
))
10555 struct window
*w
= XWINDOW (window
);
10557 if (!NILP (w
->hchild
))
10558 redisplay_windows (w
->hchild
);
10559 else if (!NILP (w
->vchild
))
10560 redisplay_windows (w
->vchild
);
10563 displayed_buffer
= XBUFFER (w
->buffer
);
10564 /* Use list_of_error, not Qerror, so that
10565 we catch only errors and don't run the debugger. */
10566 internal_condition_case_1 (redisplay_window_0
, window
,
10568 redisplay_window_error
);
10576 redisplay_window_error ()
10578 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
10583 redisplay_window_0 (window
)
10584 Lisp_Object window
;
10586 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
10587 redisplay_window (window
, 0);
10592 redisplay_window_1 (window
)
10593 Lisp_Object window
;
10595 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
10596 redisplay_window (window
, 1);
10601 /* Increment GLYPH until it reaches END or CONDITION fails while
10602 adding (GLYPH)->pixel_width to X. */
10604 #define SKIP_GLYPHS(glyph, end, x, condition) \
10607 (x) += (glyph)->pixel_width; \
10610 while ((glyph) < (end) && (condition))
10613 /* Set cursor position of W. PT is assumed to be displayed in ROW.
10614 DELTA is the number of bytes by which positions recorded in ROW
10615 differ from current buffer positions. */
10618 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
10620 struct glyph_row
*row
;
10621 struct glyph_matrix
*matrix
;
10622 int delta
, delta_bytes
, dy
, dvpos
;
10624 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
10625 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
10626 /* The first glyph that starts a sequence of glyphs from string. */
10627 struct glyph
*string_start
;
10628 /* The X coordinate of string_start. */
10629 int string_start_x
;
10630 /* The last known character position. */
10631 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
10632 /* The last known character position before string_start. */
10633 int string_before_pos
;
10635 int pt_old
= PT
- delta
;
10637 /* Skip over glyphs not having an object at the start of the row.
10638 These are special glyphs like truncation marks on terminal
10640 if (row
->displays_text_p
)
10642 && INTEGERP (glyph
->object
)
10643 && glyph
->charpos
< 0)
10645 x
+= glyph
->pixel_width
;
10649 string_start
= NULL
;
10651 && !INTEGERP (glyph
->object
)
10652 && (!BUFFERP (glyph
->object
)
10653 || (last_pos
= glyph
->charpos
) < pt_old
))
10655 if (! STRINGP (glyph
->object
))
10657 string_start
= NULL
;
10658 x
+= glyph
->pixel_width
;
10663 string_before_pos
= last_pos
;
10664 string_start
= glyph
;
10665 string_start_x
= x
;
10666 /* Skip all glyphs from string. */
10667 SKIP_GLYPHS (glyph
, end
, x
, STRINGP (glyph
->object
));
10672 && (glyph
== end
|| !BUFFERP (glyph
->object
) || last_pos
> pt_old
))
10674 /* We may have skipped over point because the previous glyphs
10675 are from string. As there's no easy way to know the
10676 character position of the current glyph, find the correct
10677 glyph on point by scanning from string_start again. */
10679 Lisp_Object string
;
10682 limit
= make_number (pt_old
+ 1);
10684 glyph
= string_start
;
10685 x
= string_start_x
;
10686 string
= glyph
->object
;
10687 pos
= string_buffer_position (w
, string
, string_before_pos
);
10688 /* If STRING is from overlay, LAST_POS == 0. We skip such glyphs
10689 because we always put cursor after overlay strings. */
10690 while (pos
== 0 && glyph
< end
)
10692 string
= glyph
->object
;
10693 SKIP_GLYPHS (glyph
, end
, x
, EQ (glyph
->object
, string
));
10695 pos
= string_buffer_position (w
, glyph
->object
, string_before_pos
);
10698 while (glyph
< end
)
10700 pos
= XINT (Fnext_single_char_property_change
10701 (make_number (pos
), Qdisplay
, Qnil
, limit
));
10704 /* Skip glyphs from the same string. */
10705 string
= glyph
->object
;
10706 SKIP_GLYPHS (glyph
, end
, x
, EQ (glyph
->object
, string
));
10707 /* Skip glyphs from an overlay. */
10709 && ! string_buffer_position (w
, glyph
->object
, pos
))
10711 string
= glyph
->object
;
10712 SKIP_GLYPHS (glyph
, end
, x
, EQ (glyph
->object
, string
));
10717 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
10719 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
10720 w
->cursor
.y
= row
->y
+ dy
;
10722 if (w
== XWINDOW (selected_window
))
10724 if (!row
->continued_p
10725 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
10728 this_line_buffer
= XBUFFER (w
->buffer
);
10730 CHARPOS (this_line_start_pos
)
10731 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
10732 BYTEPOS (this_line_start_pos
)
10733 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
10735 CHARPOS (this_line_end_pos
)
10736 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
10737 BYTEPOS (this_line_end_pos
)
10738 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
10740 this_line_y
= w
->cursor
.y
;
10741 this_line_pixel_height
= row
->height
;
10742 this_line_vpos
= w
->cursor
.vpos
;
10743 this_line_start_x
= row
->x
;
10746 CHARPOS (this_line_start_pos
) = 0;
10751 /* Run window scroll functions, if any, for WINDOW with new window
10752 start STARTP. Sets the window start of WINDOW to that position.
10754 We assume that the window's buffer is really current. */
10756 static INLINE
struct text_pos
10757 run_window_scroll_functions (window
, startp
)
10758 Lisp_Object window
;
10759 struct text_pos startp
;
10761 struct window
*w
= XWINDOW (window
);
10762 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
10764 if (current_buffer
!= XBUFFER (w
->buffer
))
10767 if (!NILP (Vwindow_scroll_functions
))
10769 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
10770 make_number (CHARPOS (startp
)));
10771 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
10772 /* In case the hook functions switch buffers. */
10773 if (current_buffer
!= XBUFFER (w
->buffer
))
10774 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10781 /* Make sure the line containing the cursor is fully visible.
10782 A value of 1 means there is nothing to be done.
10783 (Either the line is fully visible, or it cannot be made so,
10784 or we cannot tell.)
10786 If FORCE_P is non-zero, return 0 even if partial visible cursor row
10787 is higher than window.
10789 A value of 0 means the caller should do scrolling
10790 as if point had gone off the screen. */
10793 make_cursor_line_fully_visible (w
, force_p
)
10797 struct glyph_matrix
*matrix
;
10798 struct glyph_row
*row
;
10801 /* It's not always possible to find the cursor, e.g, when a window
10802 is full of overlay strings. Don't do anything in that case. */
10803 if (w
->cursor
.vpos
< 0)
10806 matrix
= w
->desired_matrix
;
10807 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
10809 /* If the cursor row is not partially visible, there's nothing to do. */
10810 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (row
))
10813 /* If the row the cursor is in is taller than the window's height,
10814 it's not clear what to do, so do nothing. */
10815 window_height
= window_box_height (w
);
10816 if (row
->height
>= window_height
)
10818 if (!force_p
|| w
->vscroll
)
10824 /* This code used to try to scroll the window just enough to make
10825 the line visible. It returned 0 to say that the caller should
10826 allocate larger glyph matrices. */
10828 if (MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (w
, row
))
10830 int dy
= row
->height
- row
->visible_height
;
10833 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
10835 else /* MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P (w, row)) */
10837 int dy
= - (row
->height
- row
->visible_height
);
10840 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
10843 /* When we change the cursor y-position of the selected window,
10844 change this_line_y as well so that the display optimization for
10845 the cursor line of the selected window in redisplay_internal uses
10846 the correct y-position. */
10847 if (w
== XWINDOW (selected_window
))
10848 this_line_y
= w
->cursor
.y
;
10850 /* If vscrolling requires a larger glyph matrix, arrange for a fresh
10851 redisplay with larger matrices. */
10852 if (matrix
->nrows
< required_matrix_height (w
))
10854 fonts_changed_p
= 1;
10863 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
10864 non-zero means only WINDOW is redisplayed in redisplay_internal.
10865 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
10866 in redisplay_window to bring a partially visible line into view in
10867 the case that only the cursor has moved.
10869 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
10870 last screen line's vertical height extends past the end of the screen.
10874 1 if scrolling succeeded
10876 0 if scrolling didn't find point.
10878 -1 if new fonts have been loaded so that we must interrupt
10879 redisplay, adjust glyph matrices, and try again. */
10885 SCROLLING_NEED_LARGER_MATRICES
10889 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
10890 scroll_step
, temp_scroll_step
, last_line_misfit
)
10891 Lisp_Object window
;
10892 int just_this_one_p
;
10893 EMACS_INT scroll_conservatively
, scroll_step
;
10894 int temp_scroll_step
;
10895 int last_line_misfit
;
10897 struct window
*w
= XWINDOW (window
);
10898 struct frame
*f
= XFRAME (w
->frame
);
10899 struct text_pos scroll_margin_pos
;
10900 struct text_pos pos
;
10901 struct text_pos startp
;
10903 Lisp_Object window_end
;
10904 int this_scroll_margin
;
10908 int amount_to_scroll
= 0;
10909 Lisp_Object aggressive
;
10911 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
10914 debug_method_add (w
, "try_scrolling");
10917 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
10919 /* Compute scroll margin height in pixels. We scroll when point is
10920 within this distance from the top or bottom of the window. */
10921 if (scroll_margin
> 0)
10923 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
10924 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
10927 this_scroll_margin
= 0;
10929 /* Force scroll_conservatively to have a reasonable value so it doesn't
10930 cause an overflow while computing how much to scroll. */
10931 if (scroll_conservatively
)
10932 scroll_conservatively
= min (scroll_conservatively
,
10933 MOST_POSITIVE_FIXNUM
/ FRAME_LINE_HEIGHT (f
));
10935 /* Compute how much we should try to scroll maximally to bring point
10937 if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
10938 scroll_max
= max (scroll_step
,
10939 max (scroll_conservatively
, temp_scroll_step
));
10940 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
10941 || NUMBERP (current_buffer
->scroll_up_aggressively
))
10942 /* We're trying to scroll because of aggressive scrolling
10943 but no scroll_step is set. Choose an arbitrary one. Maybe
10944 there should be a variable for this. */
10948 scroll_max
*= FRAME_LINE_HEIGHT (f
);
10950 /* Decide whether we have to scroll down. Start at the window end
10951 and move this_scroll_margin up to find the position of the scroll
10953 window_end
= Fwindow_end (window
, Qt
);
10957 CHARPOS (scroll_margin_pos
) = XINT (window_end
);
10958 BYTEPOS (scroll_margin_pos
) = CHAR_TO_BYTE (CHARPOS (scroll_margin_pos
));
10960 if (this_scroll_margin
|| extra_scroll_margin_lines
)
10962 start_display (&it
, w
, scroll_margin_pos
);
10963 if (this_scroll_margin
)
10964 move_it_vertically (&it
, - this_scroll_margin
);
10965 if (extra_scroll_margin_lines
)
10966 move_it_by_lines (&it
, - extra_scroll_margin_lines
, 0);
10967 scroll_margin_pos
= it
.current
.pos
;
10970 if (PT
>= CHARPOS (scroll_margin_pos
))
10974 /* Point is in the scroll margin at the bottom of the window, or
10975 below. Compute a new window start that makes point visible. */
10977 /* Compute the distance from the scroll margin to PT.
10978 Give up if the distance is greater than scroll_max. */
10979 start_display (&it
, w
, scroll_margin_pos
);
10981 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
10982 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
10984 /* To make point visible, we have to move the window start
10985 down so that the line the cursor is in is visible, which
10986 means we have to add in the height of the cursor line. */
10987 dy
= line_bottom_y (&it
) - y0
;
10989 if (dy
> scroll_max
)
10990 return SCROLLING_FAILED
;
10992 /* Move the window start down. If scrolling conservatively,
10993 move it just enough down to make point visible. If
10994 scroll_step is set, move it down by scroll_step. */
10995 start_display (&it
, w
, startp
);
10997 if (scroll_conservatively
)
10998 /* Set AMOUNT_TO_SCROLL to at least one line,
10999 and at most scroll_conservatively lines. */
11001 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
11002 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
11003 else if (scroll_step
|| temp_scroll_step
)
11004 amount_to_scroll
= scroll_max
;
11007 aggressive
= current_buffer
->scroll_up_aggressively
;
11008 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
11009 if (NUMBERP (aggressive
))
11011 double float_amount
= XFLOATINT (aggressive
) * height
;
11012 amount_to_scroll
= float_amount
;
11013 if (amount_to_scroll
== 0 && float_amount
> 0)
11014 amount_to_scroll
= 1;
11018 if (amount_to_scroll
<= 0)
11019 return SCROLLING_FAILED
;
11021 /* If moving by amount_to_scroll leaves STARTP unchanged,
11022 move it down one screen line. */
11024 move_it_vertically (&it
, amount_to_scroll
);
11025 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
11026 move_it_by_lines (&it
, 1, 1);
11027 startp
= it
.current
.pos
;
11031 /* See if point is inside the scroll margin at the top of the
11033 scroll_margin_pos
= startp
;
11034 if (this_scroll_margin
)
11036 start_display (&it
, w
, startp
);
11037 move_it_vertically (&it
, this_scroll_margin
);
11038 scroll_margin_pos
= it
.current
.pos
;
11041 if (PT
< CHARPOS (scroll_margin_pos
))
11043 /* Point is in the scroll margin at the top of the window or
11044 above what is displayed in the window. */
11047 /* Compute the vertical distance from PT to the scroll
11048 margin position. Give up if distance is greater than
11050 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
11051 start_display (&it
, w
, pos
);
11053 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
11054 it
.last_visible_y
, -1,
11055 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
11056 dy
= it
.current_y
- y0
;
11057 if (dy
> scroll_max
)
11058 return SCROLLING_FAILED
;
11060 /* Compute new window start. */
11061 start_display (&it
, w
, startp
);
11063 if (scroll_conservatively
)
11065 max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
11066 else if (scroll_step
|| temp_scroll_step
)
11067 amount_to_scroll
= scroll_max
;
11070 aggressive
= current_buffer
->scroll_down_aggressively
;
11071 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
11072 if (NUMBERP (aggressive
))
11074 double float_amount
= XFLOATINT (aggressive
) * height
;
11075 amount_to_scroll
= float_amount
;
11076 if (amount_to_scroll
== 0 && float_amount
> 0)
11077 amount_to_scroll
= 1;
11081 if (amount_to_scroll
<= 0)
11082 return SCROLLING_FAILED
;
11084 move_it_vertically (&it
, - amount_to_scroll
);
11085 startp
= it
.current
.pos
;
11089 /* Run window scroll functions. */
11090 startp
= run_window_scroll_functions (window
, startp
);
11092 /* Display the window. Give up if new fonts are loaded, or if point
11094 if (!try_window (window
, startp
))
11095 rc
= SCROLLING_NEED_LARGER_MATRICES
;
11096 else if (w
->cursor
.vpos
< 0)
11098 clear_glyph_matrix (w
->desired_matrix
);
11099 rc
= SCROLLING_FAILED
;
11103 /* Maybe forget recorded base line for line number display. */
11104 if (!just_this_one_p
11105 || current_buffer
->clip_changed
11106 || BEG_UNCHANGED
< CHARPOS (startp
))
11107 w
->base_line_number
= Qnil
;
11109 /* If cursor ends up on a partially visible line,
11110 treat that as being off the bottom of the screen. */
11111 if (! make_cursor_line_fully_visible (w
, extra_scroll_margin_lines
<= 1))
11113 clear_glyph_matrix (w
->desired_matrix
);
11114 ++extra_scroll_margin_lines
;
11117 rc
= SCROLLING_SUCCESS
;
11124 /* Compute a suitable window start for window W if display of W starts
11125 on a continuation line. Value is non-zero if a new window start
11128 The new window start will be computed, based on W's width, starting
11129 from the start of the continued line. It is the start of the
11130 screen line with the minimum distance from the old start W->start. */
11133 compute_window_start_on_continuation_line (w
)
11136 struct text_pos pos
, start_pos
;
11137 int window_start_changed_p
= 0;
11139 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
11141 /* If window start is on a continuation line... Window start may be
11142 < BEGV in case there's invisible text at the start of the
11143 buffer (M-x rmail, for example). */
11144 if (CHARPOS (start_pos
) > BEGV
11145 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
11148 struct glyph_row
*row
;
11150 /* Handle the case that the window start is out of range. */
11151 if (CHARPOS (start_pos
) < BEGV
)
11152 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
11153 else if (CHARPOS (start_pos
) > ZV
)
11154 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
11156 /* Find the start of the continued line. This should be fast
11157 because scan_buffer is fast (newline cache). */
11158 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
11159 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
11160 row
, DEFAULT_FACE_ID
);
11161 reseat_at_previous_visible_line_start (&it
);
11163 /* If the line start is "too far" away from the window start,
11164 say it takes too much time to compute a new window start. */
11165 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
11166 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
11168 int min_distance
, distance
;
11170 /* Move forward by display lines to find the new window
11171 start. If window width was enlarged, the new start can
11172 be expected to be > the old start. If window width was
11173 decreased, the new window start will be < the old start.
11174 So, we're looking for the display line start with the
11175 minimum distance from the old window start. */
11176 pos
= it
.current
.pos
;
11177 min_distance
= INFINITY
;
11178 while ((distance
= abs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
11179 distance
< min_distance
)
11181 min_distance
= distance
;
11182 pos
= it
.current
.pos
;
11183 move_it_by_lines (&it
, 1, 0);
11186 /* Set the window start there. */
11187 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
11188 window_start_changed_p
= 1;
11192 return window_start_changed_p
;
11196 /* Try cursor movement in case text has not changed in window WINDOW,
11197 with window start STARTP. Value is
11199 CURSOR_MOVEMENT_SUCCESS if successful
11201 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
11203 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
11204 display. *SCROLL_STEP is set to 1, under certain circumstances, if
11205 we want to scroll as if scroll-step were set to 1. See the code.
11207 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
11208 which case we have to abort this redisplay, and adjust matrices
11213 CURSOR_MOVEMENT_SUCCESS
,
11214 CURSOR_MOVEMENT_CANNOT_BE_USED
,
11215 CURSOR_MOVEMENT_MUST_SCROLL
,
11216 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
11220 try_cursor_movement (window
, startp
, scroll_step
)
11221 Lisp_Object window
;
11222 struct text_pos startp
;
11225 struct window
*w
= XWINDOW (window
);
11226 struct frame
*f
= XFRAME (w
->frame
);
11227 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
11230 if (inhibit_try_cursor_movement
)
11234 /* Handle case where text has not changed, only point, and it has
11235 not moved off the frame. */
11236 if (/* Point may be in this window. */
11237 PT
>= CHARPOS (startp
)
11238 /* Selective display hasn't changed. */
11239 && !current_buffer
->clip_changed
11240 /* Function force-mode-line-update is used to force a thorough
11241 redisplay. It sets either windows_or_buffers_changed or
11242 update_mode_lines. So don't take a shortcut here for these
11244 && !update_mode_lines
11245 && !windows_or_buffers_changed
11246 && !cursor_type_changed
11247 /* Can't use this case if highlighting a region. When a
11248 region exists, cursor movement has to do more than just
11250 && !(!NILP (Vtransient_mark_mode
)
11251 && !NILP (current_buffer
->mark_active
))
11252 && NILP (w
->region_showing
)
11253 && NILP (Vshow_trailing_whitespace
)
11254 /* Right after splitting windows, last_point may be nil. */
11255 && INTEGERP (w
->last_point
)
11256 /* This code is not used for mini-buffer for the sake of the case
11257 of redisplaying to replace an echo area message; since in
11258 that case the mini-buffer contents per se are usually
11259 unchanged. This code is of no real use in the mini-buffer
11260 since the handling of this_line_start_pos, etc., in redisplay
11261 handles the same cases. */
11262 && !EQ (window
, minibuf_window
)
11263 /* When splitting windows or for new windows, it happens that
11264 redisplay is called with a nil window_end_vpos or one being
11265 larger than the window. This should really be fixed in
11266 window.c. I don't have this on my list, now, so we do
11267 approximately the same as the old redisplay code. --gerd. */
11268 && INTEGERP (w
->window_end_vpos
)
11269 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
11270 && (FRAME_WINDOW_P (f
)
11271 || !overlay_arrow_in_current_buffer_p ()))
11273 int this_scroll_margin
, top_scroll_margin
;
11274 struct glyph_row
*row
= NULL
;
11277 debug_method_add (w
, "cursor movement");
11280 /* Scroll if point within this distance from the top or bottom
11281 of the window. This is a pixel value. */
11282 this_scroll_margin
= max (0, scroll_margin
);
11283 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
11284 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
11286 top_scroll_margin
= this_scroll_margin
;
11287 if (WINDOW_WANTS_HEADER_LINE_P (w
))
11288 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
11290 /* Start with the row the cursor was displayed during the last
11291 not paused redisplay. Give up if that row is not valid. */
11292 if (w
->last_cursor
.vpos
< 0
11293 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
11294 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
11297 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
11298 if (row
->mode_line_p
)
11300 if (!row
->enabled_p
)
11301 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
11304 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
11307 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
11309 if (PT
> XFASTINT (w
->last_point
))
11311 /* Point has moved forward. */
11312 while (MATRIX_ROW_END_CHARPOS (row
) < PT
11313 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
11315 xassert (row
->enabled_p
);
11319 /* The end position of a row equals the start position
11320 of the next row. If PT is there, we would rather
11321 display it in the next line. */
11322 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
11323 && MATRIX_ROW_END_CHARPOS (row
) == PT
11324 && !cursor_row_p (w
, row
))
11327 /* If within the scroll margin, scroll. Note that
11328 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
11329 the next line would be drawn, and that
11330 this_scroll_margin can be zero. */
11331 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
11332 || PT
> MATRIX_ROW_END_CHARPOS (row
)
11333 /* Line is completely visible last line in window
11334 and PT is to be set in the next line. */
11335 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
11336 && PT
== MATRIX_ROW_END_CHARPOS (row
)
11337 && !row
->ends_at_zv_p
11338 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
11341 else if (PT
< XFASTINT (w
->last_point
))
11343 /* Cursor has to be moved backward. Note that PT >=
11344 CHARPOS (startp) because of the outer
11346 while (!row
->mode_line_p
11347 && (MATRIX_ROW_START_CHARPOS (row
) > PT
11348 || (MATRIX_ROW_START_CHARPOS (row
) == PT
11349 && MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)))
11350 && (row
->y
> top_scroll_margin
11351 || CHARPOS (startp
) == BEGV
))
11353 xassert (row
->enabled_p
);
11357 /* Consider the following case: Window starts at BEGV,
11358 there is invisible, intangible text at BEGV, so that
11359 display starts at some point START > BEGV. It can
11360 happen that we are called with PT somewhere between
11361 BEGV and START. Try to handle that case. */
11362 if (row
< w
->current_matrix
->rows
11363 || row
->mode_line_p
)
11365 row
= w
->current_matrix
->rows
;
11366 if (row
->mode_line_p
)
11370 /* Due to newlines in overlay strings, we may have to
11371 skip forward over overlay strings. */
11372 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
11373 && MATRIX_ROW_END_CHARPOS (row
) == PT
11374 && !cursor_row_p (w
, row
))
11377 /* If within the scroll margin, scroll. */
11378 if (row
->y
< top_scroll_margin
11379 && CHARPOS (startp
) != BEGV
)
11383 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
11384 || PT
> MATRIX_ROW_END_CHARPOS (row
))
11386 /* if PT is not in the glyph row, give up. */
11387 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
11389 else if (MATRIX_ROW_PARTIALLY_VISIBLE_P (row
))
11391 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
11392 && !row
->ends_at_zv_p
11393 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
11394 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
11395 else if (row
->height
> window_box_height (w
))
11397 /* If we end up in a partially visible line, let's
11398 make it fully visible, except when it's taller
11399 than the window, in which case we can't do much
11402 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
11406 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11407 if (!make_cursor_line_fully_visible (w
, 0))
11408 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
11410 rc
= CURSOR_MOVEMENT_SUCCESS
;
11414 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
11417 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11418 rc
= CURSOR_MOVEMENT_SUCCESS
;
11427 set_vertical_scroll_bar (w
)
11430 int start
, end
, whole
;
11432 /* Calculate the start and end positions for the current window.
11433 At some point, it would be nice to choose between scrollbars
11434 which reflect the whole buffer size, with special markers
11435 indicating narrowing, and scrollbars which reflect only the
11438 Note that mini-buffers sometimes aren't displaying any text. */
11439 if (!MINI_WINDOW_P (w
)
11440 || (w
== XWINDOW (minibuf_window
)
11441 && NILP (echo_area_buffer
[0])))
11443 struct buffer
*buf
= XBUFFER (w
->buffer
);
11444 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
11445 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
11446 /* I don't think this is guaranteed to be right. For the
11447 moment, we'll pretend it is. */
11448 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
11452 if (whole
< (end
- start
))
11453 whole
= end
- start
;
11456 start
= end
= whole
= 0;
11458 /* Indicate what this scroll bar ought to be displaying now. */
11459 set_vertical_scroll_bar_hook (w
, end
- start
, whole
, start
);
11463 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
11464 selected_window is redisplayed.
11466 We can return without actually redisplaying the window if
11467 fonts_changed_p is nonzero. In that case, redisplay_internal will
11471 redisplay_window (window
, just_this_one_p
)
11472 Lisp_Object window
;
11473 int just_this_one_p
;
11475 struct window
*w
= XWINDOW (window
);
11476 struct frame
*f
= XFRAME (w
->frame
);
11477 struct buffer
*buffer
= XBUFFER (w
->buffer
);
11478 struct buffer
*old
= current_buffer
;
11479 struct text_pos lpoint
, opoint
, startp
;
11480 int update_mode_line
;
11483 /* Record it now because it's overwritten. */
11484 int current_matrix_up_to_date_p
= 0;
11485 int used_current_matrix_p
= 0;
11486 /* This is less strict than current_matrix_up_to_date_p.
11487 It indictes that the buffer contents and narrowing are unchanged. */
11488 int buffer_unchanged_p
= 0;
11489 int temp_scroll_step
= 0;
11490 int count
= SPECPDL_INDEX ();
11492 int centering_position
;
11493 int last_line_misfit
= 0;
11495 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
11498 /* W must be a leaf window here. */
11499 xassert (!NILP (w
->buffer
));
11501 *w
->desired_matrix
->method
= 0;
11504 specbind (Qinhibit_point_motion_hooks
, Qt
);
11506 reconsider_clip_changes (w
, buffer
);
11508 /* Has the mode line to be updated? */
11509 update_mode_line
= (!NILP (w
->update_mode_line
)
11510 || update_mode_lines
11511 || buffer
->clip_changed
11512 || buffer
->prevent_redisplay_optimizations_p
);
11514 if (MINI_WINDOW_P (w
))
11516 if (w
== XWINDOW (echo_area_window
)
11517 && !NILP (echo_area_buffer
[0]))
11519 if (update_mode_line
)
11520 /* We may have to update a tty frame's menu bar or a
11521 tool-bar. Example `M-x C-h C-h C-g'. */
11522 goto finish_menu_bars
;
11524 /* We've already displayed the echo area glyphs in this window. */
11525 goto finish_scroll_bars
;
11527 else if ((w
!= XWINDOW (minibuf_window
)
11528 || minibuf_level
== 0)
11529 /* When buffer is nonempty, redisplay window normally. */
11530 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
11531 /* Quail displays non-mini buffers in minibuffer window.
11532 In that case, redisplay the window normally. */
11533 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
11535 /* W is a mini-buffer window, but it's not active, so clear
11537 int yb
= window_text_bottom_y (w
);
11538 struct glyph_row
*row
;
11541 for (y
= 0, row
= w
->desired_matrix
->rows
;
11543 y
+= row
->height
, ++row
)
11544 blank_row (w
, row
, y
);
11545 goto finish_scroll_bars
;
11548 clear_glyph_matrix (w
->desired_matrix
);
11551 /* Otherwise set up data on this window; select its buffer and point
11553 /* Really select the buffer, for the sake of buffer-local
11555 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11556 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
11558 current_matrix_up_to_date_p
11559 = (!NILP (w
->window_end_valid
)
11560 && !current_buffer
->clip_changed
11561 && !current_buffer
->prevent_redisplay_optimizations_p
11562 && XFASTINT (w
->last_modified
) >= MODIFF
11563 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
11566 = (!NILP (w
->window_end_valid
)
11567 && !current_buffer
->clip_changed
11568 && XFASTINT (w
->last_modified
) >= MODIFF
11569 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
11571 /* When windows_or_buffers_changed is non-zero, we can't rely on
11572 the window end being valid, so set it to nil there. */
11573 if (windows_or_buffers_changed
)
11575 /* If window starts on a continuation line, maybe adjust the
11576 window start in case the window's width changed. */
11577 if (XMARKER (w
->start
)->buffer
== current_buffer
)
11578 compute_window_start_on_continuation_line (w
);
11580 w
->window_end_valid
= Qnil
;
11583 /* Some sanity checks. */
11584 CHECK_WINDOW_END (w
);
11585 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
11587 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
11590 /* If %c is in mode line, update it if needed. */
11591 if (!NILP (w
->column_number_displayed
)
11592 /* This alternative quickly identifies a common case
11593 where no change is needed. */
11594 && !(PT
== XFASTINT (w
->last_point
)
11595 && XFASTINT (w
->last_modified
) >= MODIFF
11596 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11597 && (XFASTINT (w
->column_number_displayed
)
11598 != (int) current_column ())) /* iftc */
11599 update_mode_line
= 1;
11601 /* Count number of windows showing the selected buffer. An indirect
11602 buffer counts as its base buffer. */
11603 if (!just_this_one_p
)
11605 struct buffer
*current_base
, *window_base
;
11606 current_base
= current_buffer
;
11607 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
11608 if (current_base
->base_buffer
)
11609 current_base
= current_base
->base_buffer
;
11610 if (window_base
->base_buffer
)
11611 window_base
= window_base
->base_buffer
;
11612 if (current_base
== window_base
)
11616 /* Point refers normally to the selected window. For any other
11617 window, set up appropriate value. */
11618 if (!EQ (window
, selected_window
))
11620 int new_pt
= XMARKER (w
->pointm
)->charpos
;
11621 int new_pt_byte
= marker_byte_position (w
->pointm
);
11625 new_pt_byte
= BEGV_BYTE
;
11626 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
11628 else if (new_pt
> (ZV
- 1))
11631 new_pt_byte
= ZV_BYTE
;
11632 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
11635 /* We don't use SET_PT so that the point-motion hooks don't run. */
11636 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
11639 /* If any of the character widths specified in the display table
11640 have changed, invalidate the width run cache. It's true that
11641 this may be a bit late to catch such changes, but the rest of
11642 redisplay goes (non-fatally) haywire when the display table is
11643 changed, so why should we worry about doing any better? */
11644 if (current_buffer
->width_run_cache
)
11646 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
11648 if (! disptab_matches_widthtab (disptab
,
11649 XVECTOR (current_buffer
->width_table
)))
11651 invalidate_region_cache (current_buffer
,
11652 current_buffer
->width_run_cache
,
11654 recompute_width_table (current_buffer
, disptab
);
11658 /* If window-start is screwed up, choose a new one. */
11659 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
11662 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
11664 /* If someone specified a new starting point but did not insist,
11665 check whether it can be used. */
11666 if (!NILP (w
->optional_new_start
)
11667 && CHARPOS (startp
) >= BEGV
11668 && CHARPOS (startp
) <= ZV
)
11670 w
->optional_new_start
= Qnil
;
11671 start_display (&it
, w
, startp
);
11672 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
11673 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
11674 if (IT_CHARPOS (it
) == PT
)
11675 w
->force_start
= Qt
;
11676 /* IT may overshoot PT if text at PT is invisible. */
11677 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
11678 w
->force_start
= Qt
;
11683 /* Handle case where place to start displaying has been specified,
11684 unless the specified location is outside the accessible range. */
11685 if (!NILP (w
->force_start
)
11686 || w
->frozen_window_start_p
)
11688 /* We set this later on if we have to adjust point. */
11691 w
->force_start
= Qnil
;
11693 w
->window_end_valid
= Qnil
;
11695 /* Forget any recorded base line for line number display. */
11696 if (!buffer_unchanged_p
)
11697 w
->base_line_number
= Qnil
;
11699 /* Redisplay the mode line. Select the buffer properly for that.
11700 Also, run the hook window-scroll-functions
11701 because we have scrolled. */
11702 /* Note, we do this after clearing force_start because
11703 if there's an error, it is better to forget about force_start
11704 than to get into an infinite loop calling the hook functions
11705 and having them get more errors. */
11706 if (!update_mode_line
11707 || ! NILP (Vwindow_scroll_functions
))
11709 update_mode_line
= 1;
11710 w
->update_mode_line
= Qt
;
11711 startp
= run_window_scroll_functions (window
, startp
);
11714 w
->last_modified
= make_number (0);
11715 w
->last_overlay_modified
= make_number (0);
11716 if (CHARPOS (startp
) < BEGV
)
11717 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
11718 else if (CHARPOS (startp
) > ZV
)
11719 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
11721 /* Redisplay, then check if cursor has been set during the
11722 redisplay. Give up if new fonts were loaded. */
11723 if (!try_window (window
, startp
))
11725 w
->force_start
= Qt
;
11726 clear_glyph_matrix (w
->desired_matrix
);
11727 goto need_larger_matrices
;
11730 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
11732 /* If point does not appear, try to move point so it does
11733 appear. The desired matrix has been built above, so we
11734 can use it here. */
11735 new_vpos
= window_box_height (w
) / 2;
11738 if (!make_cursor_line_fully_visible (w
, 0))
11740 /* Point does appear, but on a line partly visible at end of window.
11741 Move it back to a fully-visible line. */
11742 new_vpos
= window_box_height (w
);
11745 /* If we need to move point for either of the above reasons,
11746 now actually do it. */
11749 struct glyph_row
*row
;
11751 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
11752 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
11755 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
11756 MATRIX_ROW_START_BYTEPOS (row
));
11758 if (w
!= XWINDOW (selected_window
))
11759 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
11760 else if (current_buffer
== old
)
11761 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
11763 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
11765 /* If we are highlighting the region, then we just changed
11766 the region, so redisplay to show it. */
11767 if (!NILP (Vtransient_mark_mode
)
11768 && !NILP (current_buffer
->mark_active
))
11770 clear_glyph_matrix (w
->desired_matrix
);
11771 if (!try_window (window
, startp
))
11772 goto need_larger_matrices
;
11777 debug_method_add (w
, "forced window start");
11782 /* Handle case where text has not changed, only point, and it has
11783 not moved off the frame, and we are not retrying after hscroll.
11784 (current_matrix_up_to_date_p is nonzero when retrying.) */
11785 if (current_matrix_up_to_date_p
11786 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
11787 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
11791 case CURSOR_MOVEMENT_SUCCESS
:
11792 used_current_matrix_p
= 1;
11795 #if 0 /* try_cursor_movement never returns this value. */
11796 case CURSOR_MOVEMENT_NEED_LARGER_MATRICES
:
11797 goto need_larger_matrices
;
11800 case CURSOR_MOVEMENT_MUST_SCROLL
:
11801 goto try_to_scroll
;
11807 /* If current starting point was originally the beginning of a line
11808 but no longer is, find a new starting point. */
11809 else if (!NILP (w
->start_at_line_beg
)
11810 && !(CHARPOS (startp
) <= BEGV
11811 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
11814 debug_method_add (w
, "recenter 1");
11819 /* Try scrolling with try_window_id. Value is > 0 if update has
11820 been done, it is -1 if we know that the same window start will
11821 not work. It is 0 if unsuccessful for some other reason. */
11822 else if ((tem
= try_window_id (w
)) != 0)
11825 debug_method_add (w
, "try_window_id %d", tem
);
11828 if (fonts_changed_p
)
11829 goto need_larger_matrices
;
11833 /* Otherwise try_window_id has returned -1 which means that we
11834 don't want the alternative below this comment to execute. */
11836 else if (CHARPOS (startp
) >= BEGV
11837 && CHARPOS (startp
) <= ZV
11838 && PT
>= CHARPOS (startp
)
11839 && (CHARPOS (startp
) < ZV
11840 /* Avoid starting at end of buffer. */
11841 || CHARPOS (startp
) == BEGV
11842 || (XFASTINT (w
->last_modified
) >= MODIFF
11843 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
11846 debug_method_add (w
, "same window start");
11849 /* Try to redisplay starting at same place as before.
11850 If point has not moved off frame, accept the results. */
11851 if (!current_matrix_up_to_date_p
11852 /* Don't use try_window_reusing_current_matrix in this case
11853 because a window scroll function can have changed the
11855 || !NILP (Vwindow_scroll_functions
)
11856 || MINI_WINDOW_P (w
)
11857 || !(used_current_matrix_p
=
11858 try_window_reusing_current_matrix (w
)))
11860 IF_DEBUG (debug_method_add (w
, "1"));
11861 try_window (window
, startp
);
11864 if (fonts_changed_p
)
11865 goto need_larger_matrices
;
11867 if (w
->cursor
.vpos
>= 0)
11869 if (!just_this_one_p
11870 || current_buffer
->clip_changed
11871 || BEG_UNCHANGED
< CHARPOS (startp
))
11872 /* Forget any recorded base line for line number display. */
11873 w
->base_line_number
= Qnil
;
11875 if (!make_cursor_line_fully_visible (w
, 1))
11877 clear_glyph_matrix (w
->desired_matrix
);
11878 last_line_misfit
= 1;
11880 /* Drop through and scroll. */
11885 clear_glyph_matrix (w
->desired_matrix
);
11890 w
->last_modified
= make_number (0);
11891 w
->last_overlay_modified
= make_number (0);
11893 /* Redisplay the mode line. Select the buffer properly for that. */
11894 if (!update_mode_line
)
11896 update_mode_line
= 1;
11897 w
->update_mode_line
= Qt
;
11900 /* Try to scroll by specified few lines. */
11901 if ((scroll_conservatively
11903 || temp_scroll_step
11904 || NUMBERP (current_buffer
->scroll_up_aggressively
)
11905 || NUMBERP (current_buffer
->scroll_down_aggressively
))
11906 && !current_buffer
->clip_changed
11907 && CHARPOS (startp
) >= BEGV
11908 && CHARPOS (startp
) <= ZV
)
11910 /* The function returns -1 if new fonts were loaded, 1 if
11911 successful, 0 if not successful. */
11912 int rc
= try_scrolling (window
, just_this_one_p
,
11913 scroll_conservatively
,
11915 temp_scroll_step
, last_line_misfit
);
11918 case SCROLLING_SUCCESS
:
11921 case SCROLLING_NEED_LARGER_MATRICES
:
11922 goto need_larger_matrices
;
11924 case SCROLLING_FAILED
:
11932 /* Finally, just choose place to start which centers point */
11935 centering_position
= window_box_height (w
) / 2;
11938 /* Jump here with centering_position already set to 0. */
11941 debug_method_add (w
, "recenter");
11944 /* w->vscroll = 0; */
11946 /* Forget any previously recorded base line for line number display. */
11947 if (!buffer_unchanged_p
)
11948 w
->base_line_number
= Qnil
;
11950 /* Move backward half the height of the window. */
11951 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
11952 it
.current_y
= it
.last_visible_y
;
11953 move_it_vertically_backward (&it
, centering_position
);
11954 xassert (IT_CHARPOS (it
) >= BEGV
);
11956 /* The function move_it_vertically_backward may move over more
11957 than the specified y-distance. If it->w is small, e.g. a
11958 mini-buffer window, we may end up in front of the window's
11959 display area. Start displaying at the start of the line
11960 containing PT in this case. */
11961 if (it
.current_y
<= 0)
11963 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
11964 move_it_vertically (&it
, 0);
11965 xassert (IT_CHARPOS (it
) <= PT
);
11969 it
.current_x
= it
.hpos
= 0;
11971 /* Set startp here explicitly in case that helps avoid an infinite loop
11972 in case the window-scroll-functions functions get errors. */
11973 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
11975 /* Run scroll hooks. */
11976 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
11978 /* Redisplay the window. */
11979 if (!current_matrix_up_to_date_p
11980 || windows_or_buffers_changed
11981 || cursor_type_changed
11982 /* Don't use try_window_reusing_current_matrix in this case
11983 because it can have changed the buffer. */
11984 || !NILP (Vwindow_scroll_functions
)
11985 || !just_this_one_p
11986 || MINI_WINDOW_P (w
)
11987 || !(used_current_matrix_p
=
11988 try_window_reusing_current_matrix (w
)))
11989 try_window (window
, startp
);
11991 /* If new fonts have been loaded (due to fontsets), give up. We
11992 have to start a new redisplay since we need to re-adjust glyph
11994 if (fonts_changed_p
)
11995 goto need_larger_matrices
;
11997 /* If cursor did not appear assume that the middle of the window is
11998 in the first line of the window. Do it again with the next line.
11999 (Imagine a window of height 100, displaying two lines of height
12000 60. Moving back 50 from it->last_visible_y will end in the first
12002 if (w
->cursor
.vpos
< 0)
12004 if (!NILP (w
->window_end_valid
)
12005 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
12007 clear_glyph_matrix (w
->desired_matrix
);
12008 move_it_by_lines (&it
, 1, 0);
12009 try_window (window
, it
.current
.pos
);
12011 else if (PT
< IT_CHARPOS (it
))
12013 clear_glyph_matrix (w
->desired_matrix
);
12014 move_it_by_lines (&it
, -1, 0);
12015 try_window (window
, it
.current
.pos
);
12019 /* Not much we can do about it. */
12023 /* Consider the following case: Window starts at BEGV, there is
12024 invisible, intangible text at BEGV, so that display starts at
12025 some point START > BEGV. It can happen that we are called with
12026 PT somewhere between BEGV and START. Try to handle that case. */
12027 if (w
->cursor
.vpos
< 0)
12029 struct glyph_row
*row
= w
->current_matrix
->rows
;
12030 if (row
->mode_line_p
)
12032 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
12035 if (!make_cursor_line_fully_visible (w
, centering_position
> 0))
12037 /* If vscroll is enabled, disable it and try again. */
12041 clear_glyph_matrix (w
->desired_matrix
);
12045 /* If centering point failed to make the whole line visible,
12046 put point at the top instead. That has to make the whole line
12047 visible, if it can be done. */
12048 clear_glyph_matrix (w
->desired_matrix
);
12049 centering_position
= 0;
12055 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12056 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
12057 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
12060 /* Display the mode line, if we must. */
12061 if ((update_mode_line
12062 /* If window not full width, must redo its mode line
12063 if (a) the window to its side is being redone and
12064 (b) we do a frame-based redisplay. This is a consequence
12065 of how inverted lines are drawn in frame-based redisplay. */
12066 || (!just_this_one_p
12067 && !FRAME_WINDOW_P (f
)
12068 && !WINDOW_FULL_WIDTH_P (w
))
12069 /* Line number to display. */
12070 || INTEGERP (w
->base_line_pos
)
12071 /* Column number is displayed and different from the one displayed. */
12072 || (!NILP (w
->column_number_displayed
)
12073 && (XFASTINT (w
->column_number_displayed
)
12074 != (int) current_column ()))) /* iftc */
12075 /* This means that the window has a mode line. */
12076 && (WINDOW_WANTS_MODELINE_P (w
)
12077 || WINDOW_WANTS_HEADER_LINE_P (w
)))
12079 display_mode_lines (w
);
12081 /* If mode line height has changed, arrange for a thorough
12082 immediate redisplay using the correct mode line height. */
12083 if (WINDOW_WANTS_MODELINE_P (w
)
12084 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
12086 fonts_changed_p
= 1;
12087 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
12088 = DESIRED_MODE_LINE_HEIGHT (w
);
12091 /* If top line height has changed, arrange for a thorough
12092 immediate redisplay using the correct mode line height. */
12093 if (WINDOW_WANTS_HEADER_LINE_P (w
)
12094 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
12096 fonts_changed_p
= 1;
12097 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
12098 = DESIRED_HEADER_LINE_HEIGHT (w
);
12101 if (fonts_changed_p
)
12102 goto need_larger_matrices
;
12105 if (!line_number_displayed
12106 && !BUFFERP (w
->base_line_pos
))
12108 w
->base_line_pos
= Qnil
;
12109 w
->base_line_number
= Qnil
;
12114 /* When we reach a frame's selected window, redo the frame's menu bar. */
12115 if (update_mode_line
12116 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
12118 int redisplay_menu_p
= 0;
12119 int redisplay_tool_bar_p
= 0;
12121 if (FRAME_WINDOW_P (f
))
12123 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
12124 || defined (USE_GTK)
12125 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
12127 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
12131 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
12133 if (redisplay_menu_p
)
12134 display_menu_bar (w
);
12136 #ifdef HAVE_WINDOW_SYSTEM
12138 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
12140 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
12141 && (FRAME_TOOL_BAR_LINES (f
) > 0
12142 || auto_resize_tool_bars_p
);
12146 if (redisplay_tool_bar_p
)
12147 redisplay_tool_bar (f
);
12151 #ifdef HAVE_WINDOW_SYSTEM
12152 if (update_window_fringes (w
, 0)
12153 && !just_this_one_p
12154 && (used_current_matrix_p
|| overlay_arrow_seen
)
12155 && !w
->pseudo_window_p
)
12159 draw_window_fringes (w
);
12163 #endif /* HAVE_WINDOW_SYSTEM */
12165 /* We go to this label, with fonts_changed_p nonzero,
12166 if it is necessary to try again using larger glyph matrices.
12167 We have to redeem the scroll bar even in this case,
12168 because the loop in redisplay_internal expects that. */
12169 need_larger_matrices
:
12171 finish_scroll_bars
:
12173 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
12175 /* Set the thumb's position and size. */
12176 set_vertical_scroll_bar (w
);
12178 /* Note that we actually used the scroll bar attached to this
12179 window, so it shouldn't be deleted at the end of redisplay. */
12180 redeem_scroll_bar_hook (w
);
12183 /* Restore current_buffer and value of point in it. */
12184 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
12185 set_buffer_internal_1 (old
);
12186 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
12188 unbind_to (count
, Qnil
);
12192 /* Build the complete desired matrix of WINDOW with a window start
12193 buffer position POS. Value is non-zero if successful. It is zero
12194 if fonts were loaded during redisplay which makes re-adjusting
12195 glyph matrices necessary. */
12198 try_window (window
, pos
)
12199 Lisp_Object window
;
12200 struct text_pos pos
;
12202 struct window
*w
= XWINDOW (window
);
12204 struct glyph_row
*last_text_row
= NULL
;
12206 /* Make POS the new window start. */
12207 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
12209 /* Mark cursor position as unknown. No overlay arrow seen. */
12210 w
->cursor
.vpos
= -1;
12211 overlay_arrow_seen
= 0;
12213 /* Initialize iterator and info to start at POS. */
12214 start_display (&it
, w
, pos
);
12216 /* Display all lines of W. */
12217 while (it
.current_y
< it
.last_visible_y
)
12219 if (display_line (&it
))
12220 last_text_row
= it
.glyph_row
- 1;
12221 if (fonts_changed_p
)
12225 /* If bottom moved off end of frame, change mode line percentage. */
12226 if (XFASTINT (w
->window_end_pos
) <= 0
12227 && Z
!= IT_CHARPOS (it
))
12228 w
->update_mode_line
= Qt
;
12230 /* Set window_end_pos to the offset of the last character displayed
12231 on the window from the end of current_buffer. Set
12232 window_end_vpos to its row number. */
12235 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
12236 w
->window_end_bytepos
12237 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
12239 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
12241 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
12242 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
12243 ->displays_text_p
);
12247 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
12248 w
->window_end_pos
= make_number (Z
- ZV
);
12249 w
->window_end_vpos
= make_number (0);
12252 /* But that is not valid info until redisplay finishes. */
12253 w
->window_end_valid
= Qnil
;
12259 /************************************************************************
12260 Window redisplay reusing current matrix when buffer has not changed
12261 ************************************************************************/
12263 /* Try redisplay of window W showing an unchanged buffer with a
12264 different window start than the last time it was displayed by
12265 reusing its current matrix. Value is non-zero if successful.
12266 W->start is the new window start. */
12269 try_window_reusing_current_matrix (w
)
12272 struct frame
*f
= XFRAME (w
->frame
);
12273 struct glyph_row
*row
, *bottom_row
;
12276 struct text_pos start
, new_start
;
12277 int nrows_scrolled
, i
;
12278 struct glyph_row
*last_text_row
;
12279 struct glyph_row
*last_reused_text_row
;
12280 struct glyph_row
*start_row
;
12281 int start_vpos
, min_y
, max_y
;
12284 if (inhibit_try_window_reusing
)
12288 if (/* This function doesn't handle terminal frames. */
12289 !FRAME_WINDOW_P (f
)
12290 /* Don't try to reuse the display if windows have been split
12292 || windows_or_buffers_changed
12293 || cursor_type_changed
)
12296 /* Can't do this if region may have changed. */
12297 if ((!NILP (Vtransient_mark_mode
)
12298 && !NILP (current_buffer
->mark_active
))
12299 || !NILP (w
->region_showing
)
12300 || !NILP (Vshow_trailing_whitespace
))
12303 /* If top-line visibility has changed, give up. */
12304 if (WINDOW_WANTS_HEADER_LINE_P (w
)
12305 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
12308 /* Give up if old or new display is scrolled vertically. We could
12309 make this function handle this, but right now it doesn't. */
12310 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
12311 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (start_row
))
12314 /* The variable new_start now holds the new window start. The old
12315 start `start' can be determined from the current matrix. */
12316 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
12317 start
= start_row
->start
.pos
;
12318 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
12320 /* Clear the desired matrix for the display below. */
12321 clear_glyph_matrix (w
->desired_matrix
);
12323 if (CHARPOS (new_start
) <= CHARPOS (start
))
12327 /* Don't use this method if the display starts with an ellipsis
12328 displayed for invisible text. It's not easy to handle that case
12329 below, and it's certainly not worth the effort since this is
12330 not a frequent case. */
12331 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
12334 IF_DEBUG (debug_method_add (w
, "twu1"));
12336 /* Display up to a row that can be reused. The variable
12337 last_text_row is set to the last row displayed that displays
12338 text. Note that it.vpos == 0 if or if not there is a
12339 header-line; it's not the same as the MATRIX_ROW_VPOS! */
12340 start_display (&it
, w
, new_start
);
12341 first_row_y
= it
.current_y
;
12342 w
->cursor
.vpos
= -1;
12343 last_text_row
= last_reused_text_row
= NULL
;
12345 while (it
.current_y
< it
.last_visible_y
12346 && IT_CHARPOS (it
) < CHARPOS (start
)
12347 && !fonts_changed_p
)
12348 if (display_line (&it
))
12349 last_text_row
= it
.glyph_row
- 1;
12351 /* A value of current_y < last_visible_y means that we stopped
12352 at the previous window start, which in turn means that we
12353 have at least one reusable row. */
12354 if (it
.current_y
< it
.last_visible_y
)
12356 /* IT.vpos always starts from 0; it counts text lines. */
12357 nrows_scrolled
= it
.vpos
;
12359 /* Find PT if not already found in the lines displayed. */
12360 if (w
->cursor
.vpos
< 0)
12362 int dy
= it
.current_y
- first_row_y
;
12364 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
12365 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
12367 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
12368 dy
, nrows_scrolled
);
12371 clear_glyph_matrix (w
->desired_matrix
);
12376 /* Scroll the display. Do it before the current matrix is
12377 changed. The problem here is that update has not yet
12378 run, i.e. part of the current matrix is not up to date.
12379 scroll_run_hook will clear the cursor, and use the
12380 current matrix to get the height of the row the cursor is
12382 run
.current_y
= first_row_y
;
12383 run
.desired_y
= it
.current_y
;
12384 run
.height
= it
.last_visible_y
- it
.current_y
;
12386 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
12389 rif
->update_window_begin_hook (w
);
12390 rif
->clear_window_mouse_face (w
);
12391 rif
->scroll_run_hook (w
, &run
);
12392 rif
->update_window_end_hook (w
, 0, 0);
12396 /* Shift current matrix down by nrows_scrolled lines. */
12397 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12398 rotate_matrix (w
->current_matrix
,
12400 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
12403 /* Disable lines that must be updated. */
12404 for (i
= 0; i
< it
.vpos
; ++i
)
12405 (start_row
+ i
)->enabled_p
= 0;
12407 /* Re-compute Y positions. */
12408 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
12409 max_y
= it
.last_visible_y
;
12410 for (row
= start_row
+ nrows_scrolled
;
12414 row
->y
= it
.current_y
;
12415 row
->visible_height
= row
->height
;
12417 if (row
->y
< min_y
)
12418 row
->visible_height
-= min_y
- row
->y
;
12419 if (row
->y
+ row
->height
> max_y
)
12420 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
12421 row
->redraw_fringe_bitmaps_p
= 1;
12423 it
.current_y
+= row
->height
;
12425 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12426 last_reused_text_row
= row
;
12427 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
12431 /* Disable lines in the current matrix which are now
12432 below the window. */
12433 for (++row
; row
< bottom_row
; ++row
)
12434 row
->enabled_p
= 0;
12437 /* Update window_end_pos etc.; last_reused_text_row is the last
12438 reused row from the current matrix containing text, if any.
12439 The value of last_text_row is the last displayed line
12440 containing text. */
12441 if (last_reused_text_row
)
12443 w
->window_end_bytepos
12444 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
12446 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
12448 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
12449 w
->current_matrix
));
12451 else if (last_text_row
)
12453 w
->window_end_bytepos
12454 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
12456 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
12458 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
12462 /* This window must be completely empty. */
12463 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
12464 w
->window_end_pos
= make_number (Z
- ZV
);
12465 w
->window_end_vpos
= make_number (0);
12467 w
->window_end_valid
= Qnil
;
12469 /* Update hint: don't try scrolling again in update_window. */
12470 w
->desired_matrix
->no_scrolling_p
= 1;
12473 debug_method_add (w
, "try_window_reusing_current_matrix 1");
12477 else if (CHARPOS (new_start
) > CHARPOS (start
))
12479 struct glyph_row
*pt_row
, *row
;
12480 struct glyph_row
*first_reusable_row
;
12481 struct glyph_row
*first_row_to_display
;
12483 int yb
= window_text_bottom_y (w
);
12485 /* Find the row starting at new_start, if there is one. Don't
12486 reuse a partially visible line at the end. */
12487 first_reusable_row
= start_row
;
12488 while (first_reusable_row
->enabled_p
12489 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
12490 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
12491 < CHARPOS (new_start
)))
12492 ++first_reusable_row
;
12494 /* Give up if there is no row to reuse. */
12495 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
12496 || !first_reusable_row
->enabled_p
12497 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
12498 != CHARPOS (new_start
)))
12501 /* We can reuse fully visible rows beginning with
12502 first_reusable_row to the end of the window. Set
12503 first_row_to_display to the first row that cannot be reused.
12504 Set pt_row to the row containing point, if there is any. */
12506 for (first_row_to_display
= first_reusable_row
;
12507 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
12508 ++first_row_to_display
)
12510 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
12511 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
12512 pt_row
= first_row_to_display
;
12515 /* Start displaying at the start of first_row_to_display. */
12516 xassert (first_row_to_display
->y
< yb
);
12517 init_to_row_start (&it
, w
, first_row_to_display
);
12519 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
12521 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
12523 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
12524 + WINDOW_HEADER_LINE_HEIGHT (w
));
12526 /* Display lines beginning with first_row_to_display in the
12527 desired matrix. Set last_text_row to the last row displayed
12528 that displays text. */
12529 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
12530 if (pt_row
== NULL
)
12531 w
->cursor
.vpos
= -1;
12532 last_text_row
= NULL
;
12533 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
12534 if (display_line (&it
))
12535 last_text_row
= it
.glyph_row
- 1;
12537 /* Give up If point isn't in a row displayed or reused. */
12538 if (w
->cursor
.vpos
< 0)
12540 clear_glyph_matrix (w
->desired_matrix
);
12544 /* If point is in a reused row, adjust y and vpos of the cursor
12548 w
->cursor
.vpos
-= nrows_scrolled
;
12549 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
12552 /* Scroll the display. */
12553 run
.current_y
= first_reusable_row
->y
;
12554 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
12555 run
.height
= it
.last_visible_y
- run
.current_y
;
12556 dy
= run
.current_y
- run
.desired_y
;
12561 rif
->update_window_begin_hook (w
);
12562 rif
->clear_window_mouse_face (w
);
12563 rif
->scroll_run_hook (w
, &run
);
12564 rif
->update_window_end_hook (w
, 0, 0);
12568 /* Adjust Y positions of reused rows. */
12569 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12570 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
12571 max_y
= it
.last_visible_y
;
12572 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
12575 row
->visible_height
= row
->height
;
12576 if (row
->y
< min_y
)
12577 row
->visible_height
-= min_y
- row
->y
;
12578 if (row
->y
+ row
->height
> max_y
)
12579 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
12580 row
->redraw_fringe_bitmaps_p
= 1;
12583 /* Scroll the current matrix. */
12584 xassert (nrows_scrolled
> 0);
12585 rotate_matrix (w
->current_matrix
,
12587 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
12590 /* Disable rows not reused. */
12591 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
12592 row
->enabled_p
= 0;
12594 /* Point may have moved to a different line, so we cannot assume that
12595 the previous cursor position is valid; locate the correct row. */
12598 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12599 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
12603 w
->cursor
.y
= row
->y
;
12605 if (row
< bottom_row
)
12607 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
12608 while (glyph
->charpos
< PT
)
12611 w
->cursor
.x
+= glyph
->pixel_width
;
12617 /* Adjust window end. A null value of last_text_row means that
12618 the window end is in reused rows which in turn means that
12619 only its vpos can have changed. */
12622 w
->window_end_bytepos
12623 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
12625 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
12627 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
12632 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
12635 w
->window_end_valid
= Qnil
;
12636 w
->desired_matrix
->no_scrolling_p
= 1;
12639 debug_method_add (w
, "try_window_reusing_current_matrix 2");
12649 /************************************************************************
12650 Window redisplay reusing current matrix when buffer has changed
12651 ************************************************************************/
12653 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
12654 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
12656 static struct glyph_row
*
12657 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
12658 struct glyph_row
*));
12661 /* Return the last row in MATRIX displaying text. If row START is
12662 non-null, start searching with that row. IT gives the dimensions
12663 of the display. Value is null if matrix is empty; otherwise it is
12664 a pointer to the row found. */
12666 static struct glyph_row
*
12667 find_last_row_displaying_text (matrix
, it
, start
)
12668 struct glyph_matrix
*matrix
;
12670 struct glyph_row
*start
;
12672 struct glyph_row
*row
, *row_found
;
12674 /* Set row_found to the last row in IT->w's current matrix
12675 displaying text. The loop looks funny but think of partially
12678 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
12679 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12681 xassert (row
->enabled_p
);
12683 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
12692 /* Return the last row in the current matrix of W that is not affected
12693 by changes at the start of current_buffer that occurred since W's
12694 current matrix was built. Value is null if no such row exists.
12696 BEG_UNCHANGED us the number of characters unchanged at the start of
12697 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
12698 first changed character in current_buffer. Characters at positions <
12699 BEG + BEG_UNCHANGED are at the same buffer positions as they were
12700 when the current matrix was built. */
12702 static struct glyph_row
*
12703 find_last_unchanged_at_beg_row (w
)
12706 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
12707 struct glyph_row
*row
;
12708 struct glyph_row
*row_found
= NULL
;
12709 int yb
= window_text_bottom_y (w
);
12711 /* Find the last row displaying unchanged text. */
12712 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
12713 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12714 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
)
12716 if (/* If row ends before first_changed_pos, it is unchanged,
12717 except in some case. */
12718 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
12719 /* When row ends in ZV and we write at ZV it is not
12721 && !row
->ends_at_zv_p
12722 /* When first_changed_pos is the end of a continued line,
12723 row is not unchanged because it may be no longer
12725 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
12726 && (row
->continued_p
12727 || row
->exact_window_width_line_p
)))
12730 /* Stop if last visible row. */
12731 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
12741 /* Find the first glyph row in the current matrix of W that is not
12742 affected by changes at the end of current_buffer since the
12743 time W's current matrix was built.
12745 Return in *DELTA the number of chars by which buffer positions in
12746 unchanged text at the end of current_buffer must be adjusted.
12748 Return in *DELTA_BYTES the corresponding number of bytes.
12750 Value is null if no such row exists, i.e. all rows are affected by
12753 static struct glyph_row
*
12754 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
12756 int *delta
, *delta_bytes
;
12758 struct glyph_row
*row
;
12759 struct glyph_row
*row_found
= NULL
;
12761 *delta
= *delta_bytes
= 0;
12763 /* Display must not have been paused, otherwise the current matrix
12764 is not up to date. */
12765 if (NILP (w
->window_end_valid
))
12768 /* A value of window_end_pos >= END_UNCHANGED means that the window
12769 end is in the range of changed text. If so, there is no
12770 unchanged row at the end of W's current matrix. */
12771 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
12774 /* Set row to the last row in W's current matrix displaying text. */
12775 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
12777 /* If matrix is entirely empty, no unchanged row exists. */
12778 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12780 /* The value of row is the last glyph row in the matrix having a
12781 meaningful buffer position in it. The end position of row
12782 corresponds to window_end_pos. This allows us to translate
12783 buffer positions in the current matrix to current buffer
12784 positions for characters not in changed text. */
12785 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
12786 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
12787 int last_unchanged_pos
, last_unchanged_pos_old
;
12788 struct glyph_row
*first_text_row
12789 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
12791 *delta
= Z
- Z_old
;
12792 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
12794 /* Set last_unchanged_pos to the buffer position of the last
12795 character in the buffer that has not been changed. Z is the
12796 index + 1 of the last character in current_buffer, i.e. by
12797 subtracting END_UNCHANGED we get the index of the last
12798 unchanged character, and we have to add BEG to get its buffer
12800 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
12801 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
12803 /* Search backward from ROW for a row displaying a line that
12804 starts at a minimum position >= last_unchanged_pos_old. */
12805 for (; row
> first_text_row
; --row
)
12807 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12810 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
12815 if (row_found
&& !MATRIX_ROW_DISPLAYS_TEXT_P (row_found
))
12822 /* Make sure that glyph rows in the current matrix of window W
12823 reference the same glyph memory as corresponding rows in the
12824 frame's frame matrix. This function is called after scrolling W's
12825 current matrix on a terminal frame in try_window_id and
12826 try_window_reusing_current_matrix. */
12829 sync_frame_with_window_matrix_rows (w
)
12832 struct frame
*f
= XFRAME (w
->frame
);
12833 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
12835 /* Preconditions: W must be a leaf window and full-width. Its frame
12836 must have a frame matrix. */
12837 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
12838 xassert (WINDOW_FULL_WIDTH_P (w
));
12839 xassert (!FRAME_WINDOW_P (f
));
12841 /* If W is a full-width window, glyph pointers in W's current matrix
12842 have, by definition, to be the same as glyph pointers in the
12843 corresponding frame matrix. Note that frame matrices have no
12844 marginal areas (see build_frame_matrix). */
12845 window_row
= w
->current_matrix
->rows
;
12846 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
12847 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
12848 while (window_row
< window_row_end
)
12850 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
12851 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
12853 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
12854 frame_row
->glyphs
[TEXT_AREA
] = start
;
12855 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
12856 frame_row
->glyphs
[LAST_AREA
] = end
;
12858 /* Disable frame rows whose corresponding window rows have
12859 been disabled in try_window_id. */
12860 if (!window_row
->enabled_p
)
12861 frame_row
->enabled_p
= 0;
12863 ++window_row
, ++frame_row
;
12868 /* Find the glyph row in window W containing CHARPOS. Consider all
12869 rows between START and END (not inclusive). END null means search
12870 all rows to the end of the display area of W. Value is the row
12871 containing CHARPOS or null. */
12874 row_containing_pos (w
, charpos
, start
, end
, dy
)
12877 struct glyph_row
*start
, *end
;
12880 struct glyph_row
*row
= start
;
12883 /* If we happen to start on a header-line, skip that. */
12884 if (row
->mode_line_p
)
12887 if ((end
&& row
>= end
) || !row
->enabled_p
)
12890 last_y
= window_text_bottom_y (w
) - dy
;
12894 /* Give up if we have gone too far. */
12895 if (end
&& row
>= end
)
12897 /* This formerly returned if they were equal.
12898 I think that both quantities are of a "last plus one" type;
12899 if so, when they are equal, the row is within the screen. -- rms. */
12900 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
12903 /* If it is in this row, return this row. */
12904 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
12905 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
12906 /* The end position of a row equals the start
12907 position of the next row. If CHARPOS is there, we
12908 would rather display it in the next line, except
12909 when this line ends in ZV. */
12910 && !row
->ends_at_zv_p
12911 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
12912 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
12919 /* Try to redisplay window W by reusing its existing display. W's
12920 current matrix must be up to date when this function is called,
12921 i.e. window_end_valid must not be nil.
12925 1 if display has been updated
12926 0 if otherwise unsuccessful
12927 -1 if redisplay with same window start is known not to succeed
12929 The following steps are performed:
12931 1. Find the last row in the current matrix of W that is not
12932 affected by changes at the start of current_buffer. If no such row
12935 2. Find the first row in W's current matrix that is not affected by
12936 changes at the end of current_buffer. Maybe there is no such row.
12938 3. Display lines beginning with the row + 1 found in step 1 to the
12939 row found in step 2 or, if step 2 didn't find a row, to the end of
12942 4. If cursor is not known to appear on the window, give up.
12944 5. If display stopped at the row found in step 2, scroll the
12945 display and current matrix as needed.
12947 6. Maybe display some lines at the end of W, if we must. This can
12948 happen under various circumstances, like a partially visible line
12949 becoming fully visible, or because newly displayed lines are displayed
12950 in smaller font sizes.
12952 7. Update W's window end information. */
12958 struct frame
*f
= XFRAME (w
->frame
);
12959 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
12960 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
12961 struct glyph_row
*last_unchanged_at_beg_row
;
12962 struct glyph_row
*first_unchanged_at_end_row
;
12963 struct glyph_row
*row
;
12964 struct glyph_row
*bottom_row
;
12967 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
12968 struct text_pos start_pos
;
12970 int first_unchanged_at_end_vpos
= 0;
12971 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
12972 struct text_pos start
;
12973 int first_changed_charpos
, last_changed_charpos
;
12976 if (inhibit_try_window_id
)
12980 /* This is handy for debugging. */
12982 #define GIVE_UP(X) \
12984 fprintf (stderr, "try_window_id give up %d\n", (X)); \
12988 #define GIVE_UP(X) return 0
12991 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
12993 /* Don't use this for mini-windows because these can show
12994 messages and mini-buffers, and we don't handle that here. */
12995 if (MINI_WINDOW_P (w
))
12998 /* This flag is used to prevent redisplay optimizations. */
12999 if (windows_or_buffers_changed
|| cursor_type_changed
)
13002 /* Verify that narrowing has not changed.
13003 Also verify that we were not told to prevent redisplay optimizations.
13004 It would be nice to further
13005 reduce the number of cases where this prevents try_window_id. */
13006 if (current_buffer
->clip_changed
13007 || current_buffer
->prevent_redisplay_optimizations_p
)
13010 /* Window must either use window-based redisplay or be full width. */
13011 if (!FRAME_WINDOW_P (f
)
13012 && (!line_ins_del_ok
13013 || !WINDOW_FULL_WIDTH_P (w
)))
13016 /* Give up if point is not known NOT to appear in W. */
13017 if (PT
< CHARPOS (start
))
13020 /* Another way to prevent redisplay optimizations. */
13021 if (XFASTINT (w
->last_modified
) == 0)
13024 /* Verify that window is not hscrolled. */
13025 if (XFASTINT (w
->hscroll
) != 0)
13028 /* Verify that display wasn't paused. */
13029 if (NILP (w
->window_end_valid
))
13032 /* Can't use this if highlighting a region because a cursor movement
13033 will do more than just set the cursor. */
13034 if (!NILP (Vtransient_mark_mode
)
13035 && !NILP (current_buffer
->mark_active
))
13038 /* Likewise if highlighting trailing whitespace. */
13039 if (!NILP (Vshow_trailing_whitespace
))
13042 /* Likewise if showing a region. */
13043 if (!NILP (w
->region_showing
))
13046 /* Can use this if overlay arrow position and or string have changed. */
13047 if (overlay_arrows_changed_p ())
13051 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
13052 only if buffer has really changed. The reason is that the gap is
13053 initially at Z for freshly visited files. The code below would
13054 set end_unchanged to 0 in that case. */
13055 if (MODIFF
> SAVE_MODIFF
13056 /* This seems to happen sometimes after saving a buffer. */
13057 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
13059 if (GPT
- BEG
< BEG_UNCHANGED
)
13060 BEG_UNCHANGED
= GPT
- BEG
;
13061 if (Z
- GPT
< END_UNCHANGED
)
13062 END_UNCHANGED
= Z
- GPT
;
13065 /* The position of the first and last character that has been changed. */
13066 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
13067 last_changed_charpos
= Z
- END_UNCHANGED
;
13069 /* If window starts after a line end, and the last change is in
13070 front of that newline, then changes don't affect the display.
13071 This case happens with stealth-fontification. Note that although
13072 the display is unchanged, glyph positions in the matrix have to
13073 be adjusted, of course. */
13074 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
13075 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
13076 && ((last_changed_charpos
< CHARPOS (start
)
13077 && CHARPOS (start
) == BEGV
)
13078 || (last_changed_charpos
< CHARPOS (start
) - 1
13079 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
13081 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
13082 struct glyph_row
*r0
;
13084 /* Compute how many chars/bytes have been added to or removed
13085 from the buffer. */
13086 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
13087 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
13089 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
13091 /* Give up if PT is not in the window. Note that it already has
13092 been checked at the start of try_window_id that PT is not in
13093 front of the window start. */
13094 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
13097 /* If window start is unchanged, we can reuse the whole matrix
13098 as is, after adjusting glyph positions. No need to compute
13099 the window end again, since its offset from Z hasn't changed. */
13100 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
13101 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
13102 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
13103 /* PT must not be in a partially visible line. */
13104 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
13105 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
13107 /* Adjust positions in the glyph matrix. */
13108 if (delta
|| delta_bytes
)
13110 struct glyph_row
*r1
13111 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
13112 increment_matrix_positions (w
->current_matrix
,
13113 MATRIX_ROW_VPOS (r0
, current_matrix
),
13114 MATRIX_ROW_VPOS (r1
, current_matrix
),
13115 delta
, delta_bytes
);
13118 /* Set the cursor. */
13119 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
13121 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
13128 /* Handle the case that changes are all below what is displayed in
13129 the window, and that PT is in the window. This shortcut cannot
13130 be taken if ZV is visible in the window, and text has been added
13131 there that is visible in the window. */
13132 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
13133 /* ZV is not visible in the window, or there are no
13134 changes at ZV, actually. */
13135 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
13136 || first_changed_charpos
== last_changed_charpos
))
13138 struct glyph_row
*r0
;
13140 /* Give up if PT is not in the window. Note that it already has
13141 been checked at the start of try_window_id that PT is not in
13142 front of the window start. */
13143 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
13146 /* If window start is unchanged, we can reuse the whole matrix
13147 as is, without changing glyph positions since no text has
13148 been added/removed in front of the window end. */
13149 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
13150 if (TEXT_POS_EQUAL_P (start
, r0
->start
.pos
)
13151 /* PT must not be in a partially visible line. */
13152 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
13153 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
13155 /* We have to compute the window end anew since text
13156 can have been added/removed after it. */
13158 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
13159 w
->window_end_bytepos
13160 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
13162 /* Set the cursor. */
13163 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
13165 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
13172 /* Give up if window start is in the changed area.
13174 The condition used to read
13176 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
13178 but why that was tested escapes me at the moment. */
13179 if (CHARPOS (start
) >= first_changed_charpos
13180 && CHARPOS (start
) <= last_changed_charpos
)
13183 /* Check that window start agrees with the start of the first glyph
13184 row in its current matrix. Check this after we know the window
13185 start is not in changed text, otherwise positions would not be
13187 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
13188 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
13191 /* Give up if the window ends in strings. Overlay strings
13192 at the end are difficult to handle, so don't try. */
13193 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
13194 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
13197 /* Compute the position at which we have to start displaying new
13198 lines. Some of the lines at the top of the window might be
13199 reusable because they are not displaying changed text. Find the
13200 last row in W's current matrix not affected by changes at the
13201 start of current_buffer. Value is null if changes start in the
13202 first line of window. */
13203 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
13204 if (last_unchanged_at_beg_row
)
13206 /* Avoid starting to display in the moddle of a character, a TAB
13207 for instance. This is easier than to set up the iterator
13208 exactly, and it's not a frequent case, so the additional
13209 effort wouldn't really pay off. */
13210 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
13211 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
13212 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
13213 --last_unchanged_at_beg_row
;
13215 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
13218 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
13220 start_pos
= it
.current
.pos
;
13222 /* Start displaying new lines in the desired matrix at the same
13223 vpos we would use in the current matrix, i.e. below
13224 last_unchanged_at_beg_row. */
13225 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
13227 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
13228 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
13230 xassert (it
.hpos
== 0 && it
.current_x
== 0);
13234 /* There are no reusable lines at the start of the window.
13235 Start displaying in the first text line. */
13236 start_display (&it
, w
, start
);
13237 it
.vpos
= it
.first_vpos
;
13238 start_pos
= it
.current
.pos
;
13241 /* Find the first row that is not affected by changes at the end of
13242 the buffer. Value will be null if there is no unchanged row, in
13243 which case we must redisplay to the end of the window. delta
13244 will be set to the value by which buffer positions beginning with
13245 first_unchanged_at_end_row have to be adjusted due to text
13247 first_unchanged_at_end_row
13248 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
13249 IF_DEBUG (debug_delta
= delta
);
13250 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
13252 /* Set stop_pos to the buffer position up to which we will have to
13253 display new lines. If first_unchanged_at_end_row != NULL, this
13254 is the buffer position of the start of the line displayed in that
13255 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
13256 that we don't stop at a buffer position. */
13258 if (first_unchanged_at_end_row
)
13260 xassert (last_unchanged_at_beg_row
== NULL
13261 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
13263 /* If this is a continuation line, move forward to the next one
13264 that isn't. Changes in lines above affect this line.
13265 Caution: this may move first_unchanged_at_end_row to a row
13266 not displaying text. */
13267 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
13268 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
13269 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
13270 < it
.last_visible_y
))
13271 ++first_unchanged_at_end_row
;
13273 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
13274 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
13275 >= it
.last_visible_y
))
13276 first_unchanged_at_end_row
= NULL
;
13279 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
13281 first_unchanged_at_end_vpos
13282 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
13283 xassert (stop_pos
>= Z
- END_UNCHANGED
);
13286 else if (last_unchanged_at_beg_row
== NULL
)
13292 /* Either there is no unchanged row at the end, or the one we have
13293 now displays text. This is a necessary condition for the window
13294 end pos calculation at the end of this function. */
13295 xassert (first_unchanged_at_end_row
== NULL
13296 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
13298 debug_last_unchanged_at_beg_vpos
13299 = (last_unchanged_at_beg_row
13300 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
13302 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
13304 #endif /* GLYPH_DEBUG != 0 */
13307 /* Display new lines. Set last_text_row to the last new line
13308 displayed which has text on it, i.e. might end up as being the
13309 line where the window_end_vpos is. */
13310 w
->cursor
.vpos
= -1;
13311 last_text_row
= NULL
;
13312 overlay_arrow_seen
= 0;
13313 while (it
.current_y
< it
.last_visible_y
13314 && !fonts_changed_p
13315 && (first_unchanged_at_end_row
== NULL
13316 || IT_CHARPOS (it
) < stop_pos
))
13318 if (display_line (&it
))
13319 last_text_row
= it
.glyph_row
- 1;
13322 if (fonts_changed_p
)
13326 /* Compute differences in buffer positions, y-positions etc. for
13327 lines reused at the bottom of the window. Compute what we can
13329 if (first_unchanged_at_end_row
13330 /* No lines reused because we displayed everything up to the
13331 bottom of the window. */
13332 && it
.current_y
< it
.last_visible_y
)
13335 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
13337 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
13338 run
.current_y
= first_unchanged_at_end_row
->y
;
13339 run
.desired_y
= run
.current_y
+ dy
;
13340 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
13344 delta
= dvpos
= dy
= run
.current_y
= run
.desired_y
= run
.height
= 0;
13345 first_unchanged_at_end_row
= NULL
;
13347 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
13350 /* Find the cursor if not already found. We have to decide whether
13351 PT will appear on this window (it sometimes doesn't, but this is
13352 not a very frequent case.) This decision has to be made before
13353 the current matrix is altered. A value of cursor.vpos < 0 means
13354 that PT is either in one of the lines beginning at
13355 first_unchanged_at_end_row or below the window. Don't care for
13356 lines that might be displayed later at the window end; as
13357 mentioned, this is not a frequent case. */
13358 if (w
->cursor
.vpos
< 0)
13360 /* Cursor in unchanged rows at the top? */
13361 if (PT
< CHARPOS (start_pos
)
13362 && last_unchanged_at_beg_row
)
13364 row
= row_containing_pos (w
, PT
,
13365 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
13366 last_unchanged_at_beg_row
+ 1, 0);
13368 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13371 /* Start from first_unchanged_at_end_row looking for PT. */
13372 else if (first_unchanged_at_end_row
)
13374 row
= row_containing_pos (w
, PT
- delta
,
13375 first_unchanged_at_end_row
, NULL
, 0);
13377 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
13378 delta_bytes
, dy
, dvpos
);
13381 /* Give up if cursor was not found. */
13382 if (w
->cursor
.vpos
< 0)
13384 clear_glyph_matrix (w
->desired_matrix
);
13389 /* Don't let the cursor end in the scroll margins. */
13391 int this_scroll_margin
, cursor_height
;
13393 this_scroll_margin
= max (0, scroll_margin
);
13394 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13395 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
13396 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
13398 if ((w
->cursor
.y
< this_scroll_margin
13399 && CHARPOS (start
) > BEGV
)
13400 /* Old redisplay didn't take scroll margin into account at the bottom,
13401 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
13402 || w
->cursor
.y
+ cursor_height
+ this_scroll_margin
> it
.last_visible_y
)
13404 w
->cursor
.vpos
= -1;
13405 clear_glyph_matrix (w
->desired_matrix
);
13410 /* Scroll the display. Do it before changing the current matrix so
13411 that xterm.c doesn't get confused about where the cursor glyph is
13413 if (dy
&& run
.height
)
13417 if (FRAME_WINDOW_P (f
))
13419 rif
->update_window_begin_hook (w
);
13420 rif
->clear_window_mouse_face (w
);
13421 rif
->scroll_run_hook (w
, &run
);
13422 rif
->update_window_end_hook (w
, 0, 0);
13426 /* Terminal frame. In this case, dvpos gives the number of
13427 lines to scroll by; dvpos < 0 means scroll up. */
13428 int first_unchanged_at_end_vpos
13429 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
13430 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
13431 int end
= (WINDOW_TOP_EDGE_LINE (w
)
13432 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
13433 + window_internal_height (w
));
13435 /* Perform the operation on the screen. */
13438 /* Scroll last_unchanged_at_beg_row to the end of the
13439 window down dvpos lines. */
13440 set_terminal_window (end
);
13442 /* On dumb terminals delete dvpos lines at the end
13443 before inserting dvpos empty lines. */
13444 if (!scroll_region_ok
)
13445 ins_del_lines (end
- dvpos
, -dvpos
);
13447 /* Insert dvpos empty lines in front of
13448 last_unchanged_at_beg_row. */
13449 ins_del_lines (from
, dvpos
);
13451 else if (dvpos
< 0)
13453 /* Scroll up last_unchanged_at_beg_vpos to the end of
13454 the window to last_unchanged_at_beg_vpos - |dvpos|. */
13455 set_terminal_window (end
);
13457 /* Delete dvpos lines in front of
13458 last_unchanged_at_beg_vpos. ins_del_lines will set
13459 the cursor to the given vpos and emit |dvpos| delete
13461 ins_del_lines (from
+ dvpos
, dvpos
);
13463 /* On a dumb terminal insert dvpos empty lines at the
13465 if (!scroll_region_ok
)
13466 ins_del_lines (end
+ dvpos
, -dvpos
);
13469 set_terminal_window (0);
13475 /* Shift reused rows of the current matrix to the right position.
13476 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
13478 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
13479 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
13482 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
13483 bottom_vpos
, dvpos
);
13484 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
13487 else if (dvpos
> 0)
13489 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
13490 bottom_vpos
, dvpos
);
13491 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
13492 first_unchanged_at_end_vpos
+ dvpos
, 0);
13495 /* For frame-based redisplay, make sure that current frame and window
13496 matrix are in sync with respect to glyph memory. */
13497 if (!FRAME_WINDOW_P (f
))
13498 sync_frame_with_window_matrix_rows (w
);
13500 /* Adjust buffer positions in reused rows. */
13502 increment_matrix_positions (current_matrix
,
13503 first_unchanged_at_end_vpos
+ dvpos
,
13504 bottom_vpos
, delta
, delta_bytes
);
13506 /* Adjust Y positions. */
13508 shift_glyph_matrix (w
, current_matrix
,
13509 first_unchanged_at_end_vpos
+ dvpos
,
13512 if (first_unchanged_at_end_row
)
13513 first_unchanged_at_end_row
+= dvpos
;
13515 /* If scrolling up, there may be some lines to display at the end of
13517 last_text_row_at_end
= NULL
;
13520 /* Scrolling up can leave for example a partially visible line
13521 at the end of the window to be redisplayed. */
13522 /* Set last_row to the glyph row in the current matrix where the
13523 window end line is found. It has been moved up or down in
13524 the matrix by dvpos. */
13525 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
13526 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
13528 /* If last_row is the window end line, it should display text. */
13529 xassert (last_row
->displays_text_p
);
13531 /* If window end line was partially visible before, begin
13532 displaying at that line. Otherwise begin displaying with the
13533 line following it. */
13534 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
13536 init_to_row_start (&it
, w
, last_row
);
13537 it
.vpos
= last_vpos
;
13538 it
.current_y
= last_row
->y
;
13542 init_to_row_end (&it
, w
, last_row
);
13543 it
.vpos
= 1 + last_vpos
;
13544 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
13548 /* We may start in a continuation line. If so, we have to
13549 get the right continuation_lines_width and current_x. */
13550 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
13551 it
.hpos
= it
.current_x
= 0;
13553 /* Display the rest of the lines at the window end. */
13554 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
13555 while (it
.current_y
< it
.last_visible_y
13556 && !fonts_changed_p
)
13558 /* Is it always sure that the display agrees with lines in
13559 the current matrix? I don't think so, so we mark rows
13560 displayed invalid in the current matrix by setting their
13561 enabled_p flag to zero. */
13562 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
13563 if (display_line (&it
))
13564 last_text_row_at_end
= it
.glyph_row
- 1;
13568 /* Update window_end_pos and window_end_vpos. */
13569 if (first_unchanged_at_end_row
13570 && first_unchanged_at_end_row
->y
< it
.last_visible_y
13571 && !last_text_row_at_end
)
13573 /* Window end line if one of the preserved rows from the current
13574 matrix. Set row to the last row displaying text in current
13575 matrix starting at first_unchanged_at_end_row, after
13577 xassert (first_unchanged_at_end_row
->displays_text_p
);
13578 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
13579 first_unchanged_at_end_row
);
13580 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
13582 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
13583 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
13585 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
13586 xassert (w
->window_end_bytepos
>= 0);
13587 IF_DEBUG (debug_method_add (w
, "A"));
13589 else if (last_text_row_at_end
)
13592 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
13593 w
->window_end_bytepos
13594 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
13596 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
13597 xassert (w
->window_end_bytepos
>= 0);
13598 IF_DEBUG (debug_method_add (w
, "B"));
13600 else if (last_text_row
)
13602 /* We have displayed either to the end of the window or at the
13603 end of the window, i.e. the last row with text is to be found
13604 in the desired matrix. */
13606 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
13607 w
->window_end_bytepos
13608 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
13610 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
13611 xassert (w
->window_end_bytepos
>= 0);
13613 else if (first_unchanged_at_end_row
== NULL
13614 && last_text_row
== NULL
13615 && last_text_row_at_end
== NULL
)
13617 /* Displayed to end of window, but no line containing text was
13618 displayed. Lines were deleted at the end of the window. */
13619 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
13620 int vpos
= XFASTINT (w
->window_end_vpos
);
13621 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
13622 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
13625 row
== NULL
&& vpos
>= first_vpos
;
13626 --vpos
, --current_row
, --desired_row
)
13628 if (desired_row
->enabled_p
)
13630 if (desired_row
->displays_text_p
)
13633 else if (current_row
->displays_text_p
)
13637 xassert (row
!= NULL
);
13638 w
->window_end_vpos
= make_number (vpos
+ 1);
13639 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
13640 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
13641 xassert (w
->window_end_bytepos
>= 0);
13642 IF_DEBUG (debug_method_add (w
, "C"));
13647 #if 0 /* This leads to problems, for instance when the cursor is
13648 at ZV, and the cursor line displays no text. */
13649 /* Disable rows below what's displayed in the window. This makes
13650 debugging easier. */
13651 enable_glyph_matrix_rows (current_matrix
,
13652 XFASTINT (w
->window_end_vpos
) + 1,
13656 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
13657 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
13659 /* Record that display has not been completed. */
13660 w
->window_end_valid
= Qnil
;
13661 w
->desired_matrix
->no_scrolling_p
= 1;
13669 /***********************************************************************
13670 More debugging support
13671 ***********************************************************************/
13675 void dump_glyph_row
P_ ((struct glyph_row
*, int, int));
13676 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
13677 void dump_glyph
P_ ((struct glyph_row
*, struct glyph
*, int));
13680 /* Dump the contents of glyph matrix MATRIX on stderr.
13682 GLYPHS 0 means don't show glyph contents.
13683 GLYPHS 1 means show glyphs in short form
13684 GLYPHS > 1 means show glyphs in long form. */
13687 dump_glyph_matrix (matrix
, glyphs
)
13688 struct glyph_matrix
*matrix
;
13692 for (i
= 0; i
< matrix
->nrows
; ++i
)
13693 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
13697 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
13698 the glyph row and area where the glyph comes from. */
13701 dump_glyph (row
, glyph
, area
)
13702 struct glyph_row
*row
;
13703 struct glyph
*glyph
;
13706 if (glyph
->type
== CHAR_GLYPH
)
13709 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
13710 glyph
- row
->glyphs
[TEXT_AREA
],
13713 (BUFFERP (glyph
->object
)
13715 : (STRINGP (glyph
->object
)
13718 glyph
->pixel_width
,
13720 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
13724 glyph
->left_box_line_p
,
13725 glyph
->right_box_line_p
);
13727 else if (glyph
->type
== STRETCH_GLYPH
)
13730 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
13731 glyph
- row
->glyphs
[TEXT_AREA
],
13734 (BUFFERP (glyph
->object
)
13736 : (STRINGP (glyph
->object
)
13739 glyph
->pixel_width
,
13743 glyph
->left_box_line_p
,
13744 glyph
->right_box_line_p
);
13746 else if (glyph
->type
== IMAGE_GLYPH
)
13749 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
13750 glyph
- row
->glyphs
[TEXT_AREA
],
13753 (BUFFERP (glyph
->object
)
13755 : (STRINGP (glyph
->object
)
13758 glyph
->pixel_width
,
13762 glyph
->left_box_line_p
,
13763 glyph
->right_box_line_p
);
13768 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
13769 GLYPHS 0 means don't show glyph contents.
13770 GLYPHS 1 means show glyphs in short form
13771 GLYPHS > 1 means show glyphs in long form. */
13774 dump_glyph_row (row
, vpos
, glyphs
)
13775 struct glyph_row
*row
;
13780 fprintf (stderr
, "Row Start End Used oEI><O\\CTZFesm X Y W H V A P\n");
13781 fprintf (stderr
, "=======================================================================\n");
13783 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d%1.1d\
13784 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
13786 MATRIX_ROW_START_CHARPOS (row
),
13787 MATRIX_ROW_END_CHARPOS (row
),
13788 row
->used
[TEXT_AREA
],
13789 row
->contains_overlapping_glyphs_p
,
13791 row
->truncated_on_left_p
,
13792 row
->truncated_on_right_p
,
13793 row
->overlay_arrow_p
,
13795 MATRIX_ROW_CONTINUATION_LINE_P (row
),
13796 row
->displays_text_p
,
13799 row
->ends_in_middle_of_char_p
,
13800 row
->starts_in_middle_of_char_p
,
13806 row
->visible_height
,
13809 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
13810 row
->end
.overlay_string_index
,
13811 row
->continuation_lines_width
);
13812 fprintf (stderr
, "%9d %5d\n",
13813 CHARPOS (row
->start
.string_pos
),
13814 CHARPOS (row
->end
.string_pos
));
13815 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
13816 row
->end
.dpvec_index
);
13823 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
13825 struct glyph
*glyph
= row
->glyphs
[area
];
13826 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
13828 /* Glyph for a line end in text. */
13829 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
13832 if (glyph
< glyph_end
)
13833 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
13835 for (; glyph
< glyph_end
; ++glyph
)
13836 dump_glyph (row
, glyph
, area
);
13839 else if (glyphs
== 1)
13843 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
13845 char *s
= (char *) alloca (row
->used
[area
] + 1);
13848 for (i
= 0; i
< row
->used
[area
]; ++i
)
13850 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
13851 if (glyph
->type
== CHAR_GLYPH
13852 && glyph
->u
.ch
< 0x80
13853 && glyph
->u
.ch
>= ' ')
13854 s
[i
] = glyph
->u
.ch
;
13860 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
13866 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
13867 Sdump_glyph_matrix
, 0, 1, "p",
13868 doc
: /* Dump the current matrix of the selected window to stderr.
13869 Shows contents of glyph row structures. With non-nil
13870 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
13871 glyphs in short form, otherwise show glyphs in long form. */)
13873 Lisp_Object glyphs
;
13875 struct window
*w
= XWINDOW (selected_window
);
13876 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13878 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
13879 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
13880 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
13881 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
13882 fprintf (stderr
, "=============================================\n");
13883 dump_glyph_matrix (w
->current_matrix
,
13884 NILP (glyphs
) ? 0 : XINT (glyphs
));
13889 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
13890 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
13893 struct frame
*f
= XFRAME (selected_frame
);
13894 dump_glyph_matrix (f
->current_matrix
, 1);
13899 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
13900 doc
: /* Dump glyph row ROW to stderr.
13901 GLYPH 0 means don't dump glyphs.
13902 GLYPH 1 means dump glyphs in short form.
13903 GLYPH > 1 or omitted means dump glyphs in long form. */)
13905 Lisp_Object row
, glyphs
;
13907 struct glyph_matrix
*matrix
;
13910 CHECK_NUMBER (row
);
13911 matrix
= XWINDOW (selected_window
)->current_matrix
;
13913 if (vpos
>= 0 && vpos
< matrix
->nrows
)
13914 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
13916 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
13921 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
13922 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
13923 GLYPH 0 means don't dump glyphs.
13924 GLYPH 1 means dump glyphs in short form.
13925 GLYPH > 1 or omitted means dump glyphs in long form. */)
13927 Lisp_Object row
, glyphs
;
13929 struct frame
*sf
= SELECTED_FRAME ();
13930 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
13933 CHECK_NUMBER (row
);
13935 if (vpos
>= 0 && vpos
< m
->nrows
)
13936 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
13937 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
13942 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
13943 doc
: /* Toggle tracing of redisplay.
13944 With ARG, turn tracing on if and only if ARG is positive. */)
13949 trace_redisplay_p
= !trace_redisplay_p
;
13952 arg
= Fprefix_numeric_value (arg
);
13953 trace_redisplay_p
= XINT (arg
) > 0;
13960 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
13961 doc
: /* Like `format', but print result to stderr.
13962 usage: (trace-to-stderr STRING &rest OBJECTS) */)
13967 Lisp_Object s
= Fformat (nargs
, args
);
13968 fprintf (stderr
, "%s", SDATA (s
));
13972 #endif /* GLYPH_DEBUG */
13976 /***********************************************************************
13977 Building Desired Matrix Rows
13978 ***********************************************************************/
13980 /* Return a temporary glyph row holding the glyphs of an overlay
13981 arrow. Only used for non-window-redisplay windows. */
13983 static struct glyph_row
*
13984 get_overlay_arrow_glyph_row (w
, overlay_arrow_string
)
13986 Lisp_Object overlay_arrow_string
;
13988 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
13989 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13990 struct buffer
*old
= current_buffer
;
13991 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
13992 int arrow_len
= SCHARS (overlay_arrow_string
);
13993 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
13994 const unsigned char *p
;
13997 int n_glyphs_before
;
13999 set_buffer_temp (buffer
);
14000 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
14001 it
.glyph_row
->used
[TEXT_AREA
] = 0;
14002 SET_TEXT_POS (it
.position
, 0, 0);
14004 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
14006 while (p
< arrow_end
)
14008 Lisp_Object face
, ilisp
;
14010 /* Get the next character. */
14012 it
.c
= string_char_and_length (p
, arrow_len
, &it
.len
);
14014 it
.c
= *p
, it
.len
= 1;
14017 /* Get its face. */
14018 ilisp
= make_number (p
- arrow_string
);
14019 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
14020 it
.face_id
= compute_char_face (f
, it
.c
, face
);
14022 /* Compute its width, get its glyphs. */
14023 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
14024 SET_TEXT_POS (it
.position
, -1, -1);
14025 PRODUCE_GLYPHS (&it
);
14027 /* If this character doesn't fit any more in the line, we have
14028 to remove some glyphs. */
14029 if (it
.current_x
> it
.last_visible_x
)
14031 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
14036 set_buffer_temp (old
);
14037 return it
.glyph_row
;
14041 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
14042 glyphs are only inserted for terminal frames since we can't really
14043 win with truncation glyphs when partially visible glyphs are
14044 involved. Which glyphs to insert is determined by
14045 produce_special_glyphs. */
14048 insert_left_trunc_glyphs (it
)
14051 struct it truncate_it
;
14052 struct glyph
*from
, *end
, *to
, *toend
;
14054 xassert (!FRAME_WINDOW_P (it
->f
));
14056 /* Get the truncation glyphs. */
14058 truncate_it
.current_x
= 0;
14059 truncate_it
.face_id
= DEFAULT_FACE_ID
;
14060 truncate_it
.glyph_row
= &scratch_glyph_row
;
14061 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
14062 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
14063 truncate_it
.object
= make_number (0);
14064 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
14066 /* Overwrite glyphs from IT with truncation glyphs. */
14067 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
14068 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
14069 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
14070 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
14075 /* There may be padding glyphs left over. Overwrite them too. */
14076 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
14078 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
14084 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
14088 /* Compute the pixel height and width of IT->glyph_row.
14090 Most of the time, ascent and height of a display line will be equal
14091 to the max_ascent and max_height values of the display iterator
14092 structure. This is not the case if
14094 1. We hit ZV without displaying anything. In this case, max_ascent
14095 and max_height will be zero.
14097 2. We have some glyphs that don't contribute to the line height.
14098 (The glyph row flag contributes_to_line_height_p is for future
14099 pixmap extensions).
14101 The first case is easily covered by using default values because in
14102 these cases, the line height does not really matter, except that it
14103 must not be zero. */
14106 compute_line_metrics (it
)
14109 struct glyph_row
*row
= it
->glyph_row
;
14112 if (FRAME_WINDOW_P (it
->f
))
14114 int i
, min_y
, max_y
;
14116 /* The line may consist of one space only, that was added to
14117 place the cursor on it. If so, the row's height hasn't been
14119 if (row
->height
== 0)
14121 if (it
->max_ascent
+ it
->max_descent
== 0)
14122 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
14123 row
->ascent
= it
->max_ascent
;
14124 row
->height
= it
->max_ascent
+ it
->max_descent
;
14125 row
->phys_ascent
= it
->max_phys_ascent
;
14126 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
14129 /* Compute the width of this line. */
14130 row
->pixel_width
= row
->x
;
14131 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
14132 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
14134 xassert (row
->pixel_width
>= 0);
14135 xassert (row
->ascent
>= 0 && row
->height
> 0);
14137 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
14138 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
14140 /* If first line's physical ascent is larger than its logical
14141 ascent, use the physical ascent, and make the row taller.
14142 This makes accented characters fully visible. */
14143 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
14144 && row
->phys_ascent
> row
->ascent
)
14146 row
->height
+= row
->phys_ascent
- row
->ascent
;
14147 row
->ascent
= row
->phys_ascent
;
14150 /* Compute how much of the line is visible. */
14151 row
->visible_height
= row
->height
;
14153 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
14154 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
14156 if (row
->y
< min_y
)
14157 row
->visible_height
-= min_y
- row
->y
;
14158 if (row
->y
+ row
->height
> max_y
)
14159 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14163 row
->pixel_width
= row
->used
[TEXT_AREA
];
14164 if (row
->continued_p
)
14165 row
->pixel_width
-= it
->continuation_pixel_width
;
14166 else if (row
->truncated_on_right_p
)
14167 row
->pixel_width
-= it
->truncation_pixel_width
;
14168 row
->ascent
= row
->phys_ascent
= 0;
14169 row
->height
= row
->phys_height
= row
->visible_height
= 1;
14172 /* Compute a hash code for this row. */
14174 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
14175 for (i
= 0; i
< row
->used
[area
]; ++i
)
14176 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
14177 + row
->glyphs
[area
][i
].u
.val
14178 + row
->glyphs
[area
][i
].face_id
14179 + row
->glyphs
[area
][i
].padding_p
14180 + (row
->glyphs
[area
][i
].type
<< 2));
14182 it
->max_ascent
= it
->max_descent
= 0;
14183 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
14187 /* Append one space to the glyph row of iterator IT if doing a
14188 window-based redisplay. The space has the same face as
14189 IT->face_id. Value is non-zero if a space was added.
14191 This function is called to make sure that there is always one glyph
14192 at the end of a glyph row that the cursor can be set on under
14193 window-systems. (If there weren't such a glyph we would not know
14194 how wide and tall a box cursor should be displayed).
14196 At the same time this space let's a nicely handle clearing to the
14197 end of the line if the row ends in italic text. */
14200 append_space_for_newline (it
, default_face_p
)
14202 int default_face_p
;
14204 if (FRAME_WINDOW_P (it
->f
))
14206 int n
= it
->glyph_row
->used
[TEXT_AREA
];
14208 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
14209 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
14211 /* Save some values that must not be changed.
14212 Must save IT->c and IT->len because otherwise
14213 ITERATOR_AT_END_P wouldn't work anymore after
14214 append_space_for_newline has been called. */
14215 enum display_element_type saved_what
= it
->what
;
14216 int saved_c
= it
->c
, saved_len
= it
->len
;
14217 int saved_x
= it
->current_x
;
14218 int saved_face_id
= it
->face_id
;
14219 struct text_pos saved_pos
;
14220 Lisp_Object saved_object
;
14223 saved_object
= it
->object
;
14224 saved_pos
= it
->position
;
14226 it
->what
= IT_CHARACTER
;
14227 bzero (&it
->position
, sizeof it
->position
);
14228 it
->object
= make_number (0);
14232 if (default_face_p
)
14233 it
->face_id
= DEFAULT_FACE_ID
;
14234 else if (it
->face_before_selective_p
)
14235 it
->face_id
= it
->saved_face_id
;
14236 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
14237 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0);
14239 PRODUCE_GLYPHS (it
);
14241 it
->override_ascent
= -1;
14242 it
->constrain_row_ascent_descent_p
= 0;
14243 it
->current_x
= saved_x
;
14244 it
->object
= saved_object
;
14245 it
->position
= saved_pos
;
14246 it
->what
= saved_what
;
14247 it
->face_id
= saved_face_id
;
14248 it
->len
= saved_len
;
14258 /* Extend the face of the last glyph in the text area of IT->glyph_row
14259 to the end of the display line. Called from display_line.
14260 If the glyph row is empty, add a space glyph to it so that we
14261 know the face to draw. Set the glyph row flag fill_line_p. */
14264 extend_face_to_end_of_line (it
)
14268 struct frame
*f
= it
->f
;
14270 /* If line is already filled, do nothing. */
14271 if (it
->current_x
>= it
->last_visible_x
)
14274 /* Face extension extends the background and box of IT->face_id
14275 to the end of the line. If the background equals the background
14276 of the frame, we don't have to do anything. */
14277 if (it
->face_before_selective_p
)
14278 face
= FACE_FROM_ID (it
->f
, it
->saved_face_id
);
14280 face
= FACE_FROM_ID (f
, it
->face_id
);
14282 if (FRAME_WINDOW_P (f
)
14283 && face
->box
== FACE_NO_BOX
14284 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
14288 /* Set the glyph row flag indicating that the face of the last glyph
14289 in the text area has to be drawn to the end of the text area. */
14290 it
->glyph_row
->fill_line_p
= 1;
14292 /* If current character of IT is not ASCII, make sure we have the
14293 ASCII face. This will be automatically undone the next time
14294 get_next_display_element returns a multibyte character. Note
14295 that the character will always be single byte in unibyte text. */
14296 if (!SINGLE_BYTE_CHAR_P (it
->c
))
14298 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0);
14301 if (FRAME_WINDOW_P (f
))
14303 /* If the row is empty, add a space with the current face of IT,
14304 so that we know which face to draw. */
14305 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
14307 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
14308 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
14309 it
->glyph_row
->used
[TEXT_AREA
] = 1;
14314 /* Save some values that must not be changed. */
14315 int saved_x
= it
->current_x
;
14316 struct text_pos saved_pos
;
14317 Lisp_Object saved_object
;
14318 enum display_element_type saved_what
= it
->what
;
14319 int saved_face_id
= it
->face_id
;
14321 saved_object
= it
->object
;
14322 saved_pos
= it
->position
;
14324 it
->what
= IT_CHARACTER
;
14325 bzero (&it
->position
, sizeof it
->position
);
14326 it
->object
= make_number (0);
14329 it
->face_id
= face
->id
;
14331 PRODUCE_GLYPHS (it
);
14333 while (it
->current_x
<= it
->last_visible_x
)
14334 PRODUCE_GLYPHS (it
);
14336 /* Don't count these blanks really. It would let us insert a left
14337 truncation glyph below and make us set the cursor on them, maybe. */
14338 it
->current_x
= saved_x
;
14339 it
->object
= saved_object
;
14340 it
->position
= saved_pos
;
14341 it
->what
= saved_what
;
14342 it
->face_id
= saved_face_id
;
14347 /* Value is non-zero if text starting at CHARPOS in current_buffer is
14348 trailing whitespace. */
14351 trailing_whitespace_p (charpos
)
14354 int bytepos
= CHAR_TO_BYTE (charpos
);
14357 while (bytepos
< ZV_BYTE
14358 && (c
= FETCH_CHAR (bytepos
),
14359 c
== ' ' || c
== '\t'))
14362 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
14364 if (bytepos
!= PT_BYTE
)
14371 /* Highlight trailing whitespace, if any, in ROW. */
14374 highlight_trailing_whitespace (f
, row
)
14376 struct glyph_row
*row
;
14378 int used
= row
->used
[TEXT_AREA
];
14382 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
14383 struct glyph
*glyph
= start
+ used
- 1;
14385 /* Skip over glyphs inserted to display the cursor at the
14386 end of a line, for extending the face of the last glyph
14387 to the end of the line on terminals, and for truncation
14388 and continuation glyphs. */
14389 while (glyph
>= start
14390 && glyph
->type
== CHAR_GLYPH
14391 && INTEGERP (glyph
->object
))
14394 /* If last glyph is a space or stretch, and it's trailing
14395 whitespace, set the face of all trailing whitespace glyphs in
14396 IT->glyph_row to `trailing-whitespace'. */
14398 && BUFFERP (glyph
->object
)
14399 && (glyph
->type
== STRETCH_GLYPH
14400 || (glyph
->type
== CHAR_GLYPH
14401 && glyph
->u
.ch
== ' '))
14402 && trailing_whitespace_p (glyph
->charpos
))
14404 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
14406 while (glyph
>= start
14407 && BUFFERP (glyph
->object
)
14408 && (glyph
->type
== STRETCH_GLYPH
14409 || (glyph
->type
== CHAR_GLYPH
14410 && glyph
->u
.ch
== ' ')))
14411 (glyph
--)->face_id
= face_id
;
14417 /* Value is non-zero if glyph row ROW in window W should be
14418 used to hold the cursor. */
14421 cursor_row_p (w
, row
)
14423 struct glyph_row
*row
;
14425 int cursor_row_p
= 1;
14427 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
14429 /* If the row ends with a newline from a string, we don't want
14430 the cursor there (if the row is continued it doesn't end in a
14432 if (CHARPOS (row
->end
.string_pos
) >= 0
14433 || MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
14434 cursor_row_p
= row
->continued_p
;
14436 /* If the row ends at ZV, display the cursor at the end of that
14437 row instead of at the start of the row below. */
14438 else if (row
->ends_at_zv_p
)
14444 return cursor_row_p
;
14448 /* Construct the glyph row IT->glyph_row in the desired matrix of
14449 IT->w from text at the current position of IT. See dispextern.h
14450 for an overview of struct it. Value is non-zero if
14451 IT->glyph_row displays text, as opposed to a line displaying ZV
14458 struct glyph_row
*row
= it
->glyph_row
;
14459 int overlay_arrow_bitmap
;
14460 Lisp_Object overlay_arrow_string
;
14462 /* We always start displaying at hpos zero even if hscrolled. */
14463 xassert (it
->hpos
== 0 && it
->current_x
== 0);
14465 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
14466 >= it
->w
->desired_matrix
->nrows
)
14468 it
->w
->nrows_scale_factor
++;
14469 fonts_changed_p
= 1;
14473 /* Is IT->w showing the region? */
14474 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
14476 /* Clear the result glyph row and enable it. */
14477 prepare_desired_row (row
);
14479 row
->y
= it
->current_y
;
14480 row
->start
= it
->start
;
14481 row
->continuation_lines_width
= it
->continuation_lines_width
;
14482 row
->displays_text_p
= 1;
14483 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
14484 it
->starts_in_middle_of_char_p
= 0;
14486 /* Arrange the overlays nicely for our purposes. Usually, we call
14487 display_line on only one line at a time, in which case this
14488 can't really hurt too much, or we call it on lines which appear
14489 one after another in the buffer, in which case all calls to
14490 recenter_overlay_lists but the first will be pretty cheap. */
14491 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
14493 /* Move over display elements that are not visible because we are
14494 hscrolled. This may stop at an x-position < IT->first_visible_x
14495 if the first glyph is partially visible or if we hit a line end. */
14496 if (it
->current_x
< it
->first_visible_x
)
14497 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
14498 MOVE_TO_POS
| MOVE_TO_X
);
14500 /* Get the initial row height. This is either the height of the
14501 text hscrolled, if there is any, or zero. */
14502 row
->ascent
= it
->max_ascent
;
14503 row
->height
= it
->max_ascent
+ it
->max_descent
;
14504 row
->phys_ascent
= it
->max_phys_ascent
;
14505 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
14507 /* Loop generating characters. The loop is left with IT on the next
14508 character to display. */
14511 int n_glyphs_before
, hpos_before
, x_before
;
14513 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
14515 /* Retrieve the next thing to display. Value is zero if end of
14517 if (!get_next_display_element (it
))
14519 /* Maybe add a space at the end of this line that is used to
14520 display the cursor there under X. Set the charpos of the
14521 first glyph of blank lines not corresponding to any text
14523 #ifdef HAVE_WINDOW_SYSTEM
14524 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
14525 row
->exact_window_width_line_p
= 1;
14527 #endif /* HAVE_WINDOW_SYSTEM */
14528 if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
14529 || row
->used
[TEXT_AREA
] == 0)
14531 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
14532 row
->displays_text_p
= 0;
14534 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
14535 && (!MINI_WINDOW_P (it
->w
)
14536 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
14537 row
->indicate_empty_line_p
= 1;
14540 it
->continuation_lines_width
= 0;
14541 row
->ends_at_zv_p
= 1;
14545 /* Now, get the metrics of what we want to display. This also
14546 generates glyphs in `row' (which is IT->glyph_row). */
14547 n_glyphs_before
= row
->used
[TEXT_AREA
];
14550 /* Remember the line height so far in case the next element doesn't
14551 fit on the line. */
14552 if (!it
->truncate_lines_p
)
14554 ascent
= it
->max_ascent
;
14555 descent
= it
->max_descent
;
14556 phys_ascent
= it
->max_phys_ascent
;
14557 phys_descent
= it
->max_phys_descent
;
14560 PRODUCE_GLYPHS (it
);
14562 /* If this display element was in marginal areas, continue with
14564 if (it
->area
!= TEXT_AREA
)
14566 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
14567 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
14568 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
14569 row
->phys_height
= max (row
->phys_height
,
14570 it
->max_phys_ascent
+ it
->max_phys_descent
);
14571 set_iterator_to_next (it
, 1);
14575 /* Does the display element fit on the line? If we truncate
14576 lines, we should draw past the right edge of the window. If
14577 we don't truncate, we want to stop so that we can display the
14578 continuation glyph before the right margin. If lines are
14579 continued, there are two possible strategies for characters
14580 resulting in more than 1 glyph (e.g. tabs): Display as many
14581 glyphs as possible in this line and leave the rest for the
14582 continuation line, or display the whole element in the next
14583 line. Original redisplay did the former, so we do it also. */
14584 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
14585 hpos_before
= it
->hpos
;
14588 if (/* Not a newline. */
14590 /* Glyphs produced fit entirely in the line. */
14591 && it
->current_x
< it
->last_visible_x
)
14593 it
->hpos
+= nglyphs
;
14594 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
14595 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
14596 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
14597 row
->phys_height
= max (row
->phys_height
,
14598 it
->max_phys_ascent
+ it
->max_phys_descent
);
14599 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
14600 row
->x
= x
- it
->first_visible_x
;
14605 struct glyph
*glyph
;
14607 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
14609 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
14610 new_x
= x
+ glyph
->pixel_width
;
14612 if (/* Lines are continued. */
14613 !it
->truncate_lines_p
14614 && (/* Glyph doesn't fit on the line. */
14615 new_x
> it
->last_visible_x
14616 /* Or it fits exactly on a window system frame. */
14617 || (new_x
== it
->last_visible_x
14618 && FRAME_WINDOW_P (it
->f
))))
14620 /* End of a continued line. */
14623 || (new_x
== it
->last_visible_x
14624 && FRAME_WINDOW_P (it
->f
)))
14626 /* Current glyph is the only one on the line or
14627 fits exactly on the line. We must continue
14628 the line because we can't draw the cursor
14629 after the glyph. */
14630 row
->continued_p
= 1;
14631 it
->current_x
= new_x
;
14632 it
->continuation_lines_width
+= new_x
;
14634 if (i
== nglyphs
- 1)
14636 set_iterator_to_next (it
, 1);
14637 #ifdef HAVE_WINDOW_SYSTEM
14638 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
14640 if (!get_next_display_element (it
))
14642 row
->exact_window_width_line_p
= 1;
14643 it
->continuation_lines_width
= 0;
14644 row
->continued_p
= 0;
14645 row
->ends_at_zv_p
= 1;
14647 else if (ITERATOR_AT_END_OF_LINE_P (it
))
14649 row
->continued_p
= 0;
14650 row
->exact_window_width_line_p
= 1;
14653 #endif /* HAVE_WINDOW_SYSTEM */
14656 else if (CHAR_GLYPH_PADDING_P (*glyph
)
14657 && !FRAME_WINDOW_P (it
->f
))
14659 /* A padding glyph that doesn't fit on this line.
14660 This means the whole character doesn't fit
14662 row
->used
[TEXT_AREA
] = n_glyphs_before
;
14664 /* Fill the rest of the row with continuation
14665 glyphs like in 20.x. */
14666 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
14667 < row
->glyphs
[1 + TEXT_AREA
])
14668 produce_special_glyphs (it
, IT_CONTINUATION
);
14670 row
->continued_p
= 1;
14671 it
->current_x
= x_before
;
14672 it
->continuation_lines_width
+= x_before
;
14674 /* Restore the height to what it was before the
14675 element not fitting on the line. */
14676 it
->max_ascent
= ascent
;
14677 it
->max_descent
= descent
;
14678 it
->max_phys_ascent
= phys_ascent
;
14679 it
->max_phys_descent
= phys_descent
;
14681 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
14683 /* A TAB that extends past the right edge of the
14684 window. This produces a single glyph on
14685 window system frames. We leave the glyph in
14686 this row and let it fill the row, but don't
14687 consume the TAB. */
14688 it
->continuation_lines_width
+= it
->last_visible_x
;
14689 row
->ends_in_middle_of_char_p
= 1;
14690 row
->continued_p
= 1;
14691 glyph
->pixel_width
= it
->last_visible_x
- x
;
14692 it
->starts_in_middle_of_char_p
= 1;
14696 /* Something other than a TAB that draws past
14697 the right edge of the window. Restore
14698 positions to values before the element. */
14699 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
14701 /* Display continuation glyphs. */
14702 if (!FRAME_WINDOW_P (it
->f
))
14703 produce_special_glyphs (it
, IT_CONTINUATION
);
14704 row
->continued_p
= 1;
14706 it
->continuation_lines_width
+= x
;
14708 if (nglyphs
> 1 && i
> 0)
14710 row
->ends_in_middle_of_char_p
= 1;
14711 it
->starts_in_middle_of_char_p
= 1;
14714 /* Restore the height to what it was before the
14715 element not fitting on the line. */
14716 it
->max_ascent
= ascent
;
14717 it
->max_descent
= descent
;
14718 it
->max_phys_ascent
= phys_ascent
;
14719 it
->max_phys_descent
= phys_descent
;
14724 else if (new_x
> it
->first_visible_x
)
14726 /* Increment number of glyphs actually displayed. */
14729 if (x
< it
->first_visible_x
)
14730 /* Glyph is partially visible, i.e. row starts at
14731 negative X position. */
14732 row
->x
= x
- it
->first_visible_x
;
14736 /* Glyph is completely off the left margin of the
14737 window. This should not happen because of the
14738 move_it_in_display_line at the start of this
14739 function, unless the text display area of the
14740 window is empty. */
14741 xassert (it
->first_visible_x
<= it
->last_visible_x
);
14745 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
14746 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
14747 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
14748 row
->phys_height
= max (row
->phys_height
,
14749 it
->max_phys_ascent
+ it
->max_phys_descent
);
14751 /* End of this display line if row is continued. */
14752 if (row
->continued_p
|| row
->ends_at_zv_p
)
14757 /* Is this a line end? If yes, we're also done, after making
14758 sure that a non-default face is extended up to the right
14759 margin of the window. */
14760 if (ITERATOR_AT_END_OF_LINE_P (it
))
14762 int used_before
= row
->used
[TEXT_AREA
];
14764 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
14766 #ifdef HAVE_WINDOW_SYSTEM
14767 /* Add a space at the end of the line that is used to
14768 display the cursor there. */
14769 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
14770 append_space_for_newline (it
, 0);
14771 #endif /* HAVE_WINDOW_SYSTEM */
14773 /* Extend the face to the end of the line. */
14774 extend_face_to_end_of_line (it
);
14776 /* Make sure we have the position. */
14777 if (used_before
== 0)
14778 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
14780 /* Consume the line end. This skips over invisible lines. */
14781 set_iterator_to_next (it
, 1);
14782 it
->continuation_lines_width
= 0;
14786 /* Proceed with next display element. Note that this skips
14787 over lines invisible because of selective display. */
14788 set_iterator_to_next (it
, 1);
14790 /* If we truncate lines, we are done when the last displayed
14791 glyphs reach past the right margin of the window. */
14792 if (it
->truncate_lines_p
14793 && (FRAME_WINDOW_P (it
->f
)
14794 ? (it
->current_x
>= it
->last_visible_x
)
14795 : (it
->current_x
> it
->last_visible_x
)))
14797 /* Maybe add truncation glyphs. */
14798 if (!FRAME_WINDOW_P (it
->f
))
14802 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
14803 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
14806 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
14808 row
->used
[TEXT_AREA
] = i
;
14809 produce_special_glyphs (it
, IT_TRUNCATION
);
14812 #ifdef HAVE_WINDOW_SYSTEM
14815 /* Don't truncate if we can overflow newline into fringe. */
14816 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
14818 if (!get_next_display_element (it
))
14820 #ifdef HAVE_WINDOW_SYSTEM
14821 it
->continuation_lines_width
= 0;
14822 row
->ends_at_zv_p
= 1;
14823 row
->exact_window_width_line_p
= 1;
14825 #endif /* HAVE_WINDOW_SYSTEM */
14827 if (ITERATOR_AT_END_OF_LINE_P (it
))
14829 row
->exact_window_width_line_p
= 1;
14830 goto at_end_of_line
;
14834 #endif /* HAVE_WINDOW_SYSTEM */
14836 row
->truncated_on_right_p
= 1;
14837 it
->continuation_lines_width
= 0;
14838 reseat_at_next_visible_line_start (it
, 0);
14839 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
14840 it
->hpos
= hpos_before
;
14841 it
->current_x
= x_before
;
14846 /* If line is not empty and hscrolled, maybe insert truncation glyphs
14847 at the left window margin. */
14848 if (it
->first_visible_x
14849 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
14851 if (!FRAME_WINDOW_P (it
->f
))
14852 insert_left_trunc_glyphs (it
);
14853 row
->truncated_on_left_p
= 1;
14856 /* If the start of this line is the overlay arrow-position, then
14857 mark this glyph row as the one containing the overlay arrow.
14858 This is clearly a mess with variable size fonts. It would be
14859 better to let it be displayed like cursors under X. */
14860 if (! overlay_arrow_seen
14861 && (overlay_arrow_string
14862 = overlay_arrow_at_row (it
->f
, row
, &overlay_arrow_bitmap
),
14863 !NILP (overlay_arrow_string
)))
14865 /* Overlay arrow in window redisplay is a fringe bitmap. */
14866 if (!FRAME_WINDOW_P (it
->f
))
14868 struct glyph_row
*arrow_row
14869 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
14870 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
14871 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
14872 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
14873 struct glyph
*p2
, *end
;
14875 /* Copy the arrow glyphs. */
14876 while (glyph
< arrow_end
)
14879 /* Throw away padding glyphs. */
14881 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
14882 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
14888 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
14892 overlay_arrow_seen
= 1;
14893 it
->w
->overlay_arrow_bitmap
= overlay_arrow_bitmap
;
14894 row
->overlay_arrow_p
= 1;
14897 /* Compute pixel dimensions of this line. */
14898 compute_line_metrics (it
);
14900 /* Remember the position at which this line ends. */
14901 row
->end
= it
->current
;
14903 /* Save fringe bitmaps in this row. */
14904 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
14905 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
14906 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
14907 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
14909 it
->left_user_fringe_bitmap
= 0;
14910 it
->left_user_fringe_face_id
= 0;
14911 it
->right_user_fringe_bitmap
= 0;
14912 it
->right_user_fringe_face_id
= 0;
14914 /* Maybe set the cursor. */
14915 if (it
->w
->cursor
.vpos
< 0
14916 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
14917 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
14918 && cursor_row_p (it
->w
, row
))
14919 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
14921 /* Highlight trailing whitespace. */
14922 if (!NILP (Vshow_trailing_whitespace
))
14923 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
14925 /* Prepare for the next line. This line starts horizontally at (X
14926 HPOS) = (0 0). Vertical positions are incremented. As a
14927 convenience for the caller, IT->glyph_row is set to the next
14929 it
->current_x
= it
->hpos
= 0;
14930 it
->current_y
+= row
->height
;
14933 it
->start
= it
->current
;
14934 return row
->displays_text_p
;
14939 /***********************************************************************
14941 ***********************************************************************/
14943 /* Redisplay the menu bar in the frame for window W.
14945 The menu bar of X frames that don't have X toolkit support is
14946 displayed in a special window W->frame->menu_bar_window.
14948 The menu bar of terminal frames is treated specially as far as
14949 glyph matrices are concerned. Menu bar lines are not part of
14950 windows, so the update is done directly on the frame matrix rows
14951 for the menu bar. */
14954 display_menu_bar (w
)
14957 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
14962 /* Don't do all this for graphical frames. */
14964 if (!NILP (Vwindow_system
))
14967 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
14972 if (FRAME_MAC_P (f
))
14976 #ifdef USE_X_TOOLKIT
14977 xassert (!FRAME_WINDOW_P (f
));
14978 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
14979 it
.first_visible_x
= 0;
14980 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
14981 #else /* not USE_X_TOOLKIT */
14982 if (FRAME_WINDOW_P (f
))
14984 /* Menu bar lines are displayed in the desired matrix of the
14985 dummy window menu_bar_window. */
14986 struct window
*menu_w
;
14987 xassert (WINDOWP (f
->menu_bar_window
));
14988 menu_w
= XWINDOW (f
->menu_bar_window
);
14989 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
14991 it
.first_visible_x
= 0;
14992 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
14996 /* This is a TTY frame, i.e. character hpos/vpos are used as
14998 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
15000 it
.first_visible_x
= 0;
15001 it
.last_visible_x
= FRAME_COLS (f
);
15003 #endif /* not USE_X_TOOLKIT */
15005 if (! mode_line_inverse_video
)
15006 /* Force the menu-bar to be displayed in the default face. */
15007 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
15009 /* Clear all rows of the menu bar. */
15010 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
15012 struct glyph_row
*row
= it
.glyph_row
+ i
;
15013 clear_glyph_row (row
);
15014 row
->enabled_p
= 1;
15015 row
->full_width_p
= 1;
15018 /* Display all items of the menu bar. */
15019 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
15020 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
15022 Lisp_Object string
;
15024 /* Stop at nil string. */
15025 string
= AREF (items
, i
+ 1);
15029 /* Remember where item was displayed. */
15030 AREF (items
, i
+ 3) = make_number (it
.hpos
);
15032 /* Display the item, pad with one space. */
15033 if (it
.current_x
< it
.last_visible_x
)
15034 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
15035 SCHARS (string
) + 1, 0, 0, -1);
15038 /* Fill out the line with spaces. */
15039 if (it
.current_x
< it
.last_visible_x
)
15040 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
15042 /* Compute the total height of the lines. */
15043 compute_line_metrics (&it
);
15048 /***********************************************************************
15050 ***********************************************************************/
15052 /* Redisplay mode lines in the window tree whose root is WINDOW. If
15053 FORCE is non-zero, redisplay mode lines unconditionally.
15054 Otherwise, redisplay only mode lines that are garbaged. Value is
15055 the number of windows whose mode lines were redisplayed. */
15058 redisplay_mode_lines (window
, force
)
15059 Lisp_Object window
;
15064 while (!NILP (window
))
15066 struct window
*w
= XWINDOW (window
);
15068 if (WINDOWP (w
->hchild
))
15069 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
15070 else if (WINDOWP (w
->vchild
))
15071 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
15073 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
15074 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
15076 struct text_pos lpoint
;
15077 struct buffer
*old
= current_buffer
;
15079 /* Set the window's buffer for the mode line display. */
15080 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15081 set_buffer_internal_1 (XBUFFER (w
->buffer
));
15083 /* Point refers normally to the selected window. For any
15084 other window, set up appropriate value. */
15085 if (!EQ (window
, selected_window
))
15087 struct text_pos pt
;
15089 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
15090 if (CHARPOS (pt
) < BEGV
)
15091 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
15092 else if (CHARPOS (pt
) > (ZV
- 1))
15093 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
15095 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
15098 /* Display mode lines. */
15099 clear_glyph_matrix (w
->desired_matrix
);
15100 if (display_mode_lines (w
))
15103 w
->must_be_updated_p
= 1;
15106 /* Restore old settings. */
15107 set_buffer_internal_1 (old
);
15108 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
15118 /* Display the mode and/or top line of window W. Value is the number
15119 of mode lines displayed. */
15122 display_mode_lines (w
)
15125 Lisp_Object old_selected_window
, old_selected_frame
;
15128 old_selected_frame
= selected_frame
;
15129 selected_frame
= w
->frame
;
15130 old_selected_window
= selected_window
;
15131 XSETWINDOW (selected_window
, w
);
15133 /* These will be set while the mode line specs are processed. */
15134 line_number_displayed
= 0;
15135 w
->column_number_displayed
= Qnil
;
15137 if (WINDOW_WANTS_MODELINE_P (w
))
15139 struct window
*sel_w
= XWINDOW (old_selected_window
);
15141 /* Select mode line face based on the real selected window. */
15142 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
15143 current_buffer
->mode_line_format
);
15147 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15149 display_mode_line (w
, HEADER_LINE_FACE_ID
,
15150 current_buffer
->header_line_format
);
15154 selected_frame
= old_selected_frame
;
15155 selected_window
= old_selected_window
;
15160 /* Display mode or top line of window W. FACE_ID specifies which line
15161 to display; it is either MODE_LINE_FACE_ID or HEADER_LINE_FACE_ID.
15162 FORMAT is the mode line format to display. Value is the pixel
15163 height of the mode line displayed. */
15166 display_mode_line (w
, face_id
, format
)
15168 enum face_id face_id
;
15169 Lisp_Object format
;
15174 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
15175 prepare_desired_row (it
.glyph_row
);
15177 it
.glyph_row
->mode_line_p
= 1;
15179 if (! mode_line_inverse_video
)
15180 /* Force the mode-line to be displayed in the default face. */
15181 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
15183 /* Temporarily make frame's keyboard the current kboard so that
15184 kboard-local variables in the mode_line_format will get the right
15186 push_frame_kboard (it
.f
);
15187 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
15188 pop_frame_kboard ();
15190 /* Fill up with spaces. */
15191 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
15193 compute_line_metrics (&it
);
15194 it
.glyph_row
->full_width_p
= 1;
15195 it
.glyph_row
->continued_p
= 0;
15196 it
.glyph_row
->truncated_on_left_p
= 0;
15197 it
.glyph_row
->truncated_on_right_p
= 0;
15199 /* Make a 3D mode-line have a shadow at its right end. */
15200 face
= FACE_FROM_ID (it
.f
, face_id
);
15201 extend_face_to_end_of_line (&it
);
15202 if (face
->box
!= FACE_NO_BOX
)
15204 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
15205 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
15206 last
->right_box_line_p
= 1;
15209 return it
.glyph_row
->height
;
15212 /* Alist that caches the results of :propertize.
15213 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
15214 Lisp_Object mode_line_proptrans_alist
;
15216 /* List of strings making up the mode-line. */
15217 Lisp_Object mode_line_string_list
;
15219 /* Base face property when building propertized mode line string. */
15220 static Lisp_Object mode_line_string_face
;
15221 static Lisp_Object mode_line_string_face_prop
;
15224 /* Contribute ELT to the mode line for window IT->w. How it
15225 translates into text depends on its data type.
15227 IT describes the display environment in which we display, as usual.
15229 DEPTH is the depth in recursion. It is used to prevent
15230 infinite recursion here.
15232 FIELD_WIDTH is the number of characters the display of ELT should
15233 occupy in the mode line, and PRECISION is the maximum number of
15234 characters to display from ELT's representation. See
15235 display_string for details.
15237 Returns the hpos of the end of the text generated by ELT.
15239 PROPS is a property list to add to any string we encounter.
15241 If RISKY is nonzero, remove (disregard) any properties in any string
15242 we encounter, and ignore :eval and :propertize.
15244 If the global variable `frame_title_ptr' is non-NULL, then the output
15245 is passed to `store_frame_title' instead of `display_string'. */
15248 display_mode_element (it
, depth
, field_width
, precision
, elt
, props
, risky
)
15251 int field_width
, precision
;
15252 Lisp_Object elt
, props
;
15255 int n
= 0, field
, prec
;
15260 elt
= build_string ("*too-deep*");
15264 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
15268 /* A string: output it and check for %-constructs within it. */
15270 const unsigned char *this, *lisp_string
;
15272 if (!NILP (props
) || risky
)
15274 Lisp_Object oprops
, aelt
;
15275 oprops
= Ftext_properties_at (make_number (0), elt
);
15277 if (NILP (Fequal (props
, oprops
)) || risky
)
15279 /* If the starting string has properties,
15280 merge the specified ones onto the existing ones. */
15281 if (! NILP (oprops
) && !risky
)
15285 oprops
= Fcopy_sequence (oprops
);
15287 while (CONSP (tem
))
15289 oprops
= Fplist_put (oprops
, XCAR (tem
),
15290 XCAR (XCDR (tem
)));
15291 tem
= XCDR (XCDR (tem
));
15296 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
15297 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
15299 mode_line_proptrans_alist
15300 = Fcons (aelt
, Fdelq (aelt
, mode_line_proptrans_alist
));
15307 elt
= Fcopy_sequence (elt
);
15308 Fset_text_properties (make_number (0), Flength (elt
),
15310 /* Add this item to mode_line_proptrans_alist. */
15311 mode_line_proptrans_alist
15312 = Fcons (Fcons (elt
, props
),
15313 mode_line_proptrans_alist
);
15314 /* Truncate mode_line_proptrans_alist
15315 to at most 50 elements. */
15316 tem
= Fnthcdr (make_number (50),
15317 mode_line_proptrans_alist
);
15319 XSETCDR (tem
, Qnil
);
15324 this = SDATA (elt
);
15325 lisp_string
= this;
15329 prec
= precision
- n
;
15330 if (frame_title_ptr
)
15331 n
+= store_frame_title (SDATA (elt
), -1, prec
);
15332 else if (!NILP (mode_line_string_list
))
15333 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
15335 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
15336 0, prec
, 0, STRING_MULTIBYTE (elt
));
15341 while ((precision
<= 0 || n
< precision
)
15343 && (frame_title_ptr
15344 || !NILP (mode_line_string_list
)
15345 || it
->current_x
< it
->last_visible_x
))
15347 const unsigned char *last
= this;
15349 /* Advance to end of string or next format specifier. */
15350 while ((c
= *this++) != '\0' && c
!= '%')
15353 if (this - 1 != last
)
15355 /* Output to end of string or up to '%'. Field width
15356 is length of string. Don't output more than
15357 PRECISION allows us. */
15360 prec
= chars_in_text (last
, this - last
);
15361 if (precision
> 0 && prec
> precision
- n
)
15362 prec
= precision
- n
;
15364 if (frame_title_ptr
)
15365 n
+= store_frame_title (last
, 0, prec
);
15366 else if (!NILP (mode_line_string_list
))
15368 int bytepos
= last
- lisp_string
;
15369 int charpos
= string_byte_to_char (elt
, bytepos
);
15370 n
+= store_mode_line_string (NULL
,
15371 Fsubstring (elt
, make_number (charpos
),
15372 make_number (charpos
+ prec
)),
15377 int bytepos
= last
- lisp_string
;
15378 int charpos
= string_byte_to_char (elt
, bytepos
);
15379 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
15381 STRING_MULTIBYTE (elt
));
15384 else /* c == '%' */
15386 const unsigned char *percent_position
= this;
15388 /* Get the specified minimum width. Zero means
15391 while ((c
= *this++) >= '0' && c
<= '9')
15392 field
= field
* 10 + c
- '0';
15394 /* Don't pad beyond the total padding allowed. */
15395 if (field_width
- n
> 0 && field
> field_width
- n
)
15396 field
= field_width
- n
;
15398 /* Note that either PRECISION <= 0 or N < PRECISION. */
15399 prec
= precision
- n
;
15402 n
+= display_mode_element (it
, depth
, field
, prec
,
15403 Vglobal_mode_string
, props
,
15408 int bytepos
, charpos
;
15409 unsigned char *spec
;
15411 bytepos
= percent_position
- lisp_string
;
15412 charpos
= (STRING_MULTIBYTE (elt
)
15413 ? string_byte_to_char (elt
, bytepos
)
15417 = decode_mode_spec (it
->w
, c
, field
, prec
, &multibyte
);
15419 if (frame_title_ptr
)
15420 n
+= store_frame_title (spec
, field
, prec
);
15421 else if (!NILP (mode_line_string_list
))
15423 int len
= strlen (spec
);
15424 Lisp_Object tem
= make_string (spec
, len
);
15425 props
= Ftext_properties_at (make_number (charpos
), elt
);
15426 /* Should only keep face property in props */
15427 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
15431 int nglyphs_before
, nwritten
;
15433 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
15434 nwritten
= display_string (spec
, Qnil
, elt
,
15439 /* Assign to the glyphs written above the
15440 string where the `%x' came from, position
15444 struct glyph
*glyph
15445 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
15449 for (i
= 0; i
< nwritten
; ++i
)
15451 glyph
[i
].object
= elt
;
15452 glyph
[i
].charpos
= charpos
;
15467 /* A symbol: process the value of the symbol recursively
15468 as if it appeared here directly. Avoid error if symbol void.
15469 Special case: if value of symbol is a string, output the string
15472 register Lisp_Object tem
;
15474 /* If the variable is not marked as risky to set
15475 then its contents are risky to use. */
15476 if (NILP (Fget (elt
, Qrisky_local_variable
)))
15479 tem
= Fboundp (elt
);
15482 tem
= Fsymbol_value (elt
);
15483 /* If value is a string, output that string literally:
15484 don't check for % within it. */
15488 if (!EQ (tem
, elt
))
15490 /* Give up right away for nil or t. */
15500 register Lisp_Object car
, tem
;
15502 /* A cons cell: five distinct cases.
15503 If first element is :eval or :propertize, do something special.
15504 If first element is a string or a cons, process all the elements
15505 and effectively concatenate them.
15506 If first element is a negative number, truncate displaying cdr to
15507 at most that many characters. If positive, pad (with spaces)
15508 to at least that many characters.
15509 If first element is a symbol, process the cadr or caddr recursively
15510 according to whether the symbol's value is non-nil or nil. */
15512 if (EQ (car
, QCeval
))
15514 /* An element of the form (:eval FORM) means evaluate FORM
15515 and use the result as mode line elements. */
15520 if (CONSP (XCDR (elt
)))
15523 spec
= safe_eval (XCAR (XCDR (elt
)));
15524 n
+= display_mode_element (it
, depth
, field_width
- n
,
15525 precision
- n
, spec
, props
,
15529 else if (EQ (car
, QCpropertize
))
15531 /* An element of the form (:propertize ELT PROPS...)
15532 means display ELT but applying properties PROPS. */
15537 if (CONSP (XCDR (elt
)))
15538 n
+= display_mode_element (it
, depth
, field_width
- n
,
15539 precision
- n
, XCAR (XCDR (elt
)),
15540 XCDR (XCDR (elt
)), risky
);
15542 else if (SYMBOLP (car
))
15544 tem
= Fboundp (car
);
15548 /* elt is now the cdr, and we know it is a cons cell.
15549 Use its car if CAR has a non-nil value. */
15552 tem
= Fsymbol_value (car
);
15559 /* Symbol's value is nil (or symbol is unbound)
15560 Get the cddr of the original list
15561 and if possible find the caddr and use that. */
15565 else if (!CONSP (elt
))
15570 else if (INTEGERP (car
))
15572 register int lim
= XINT (car
);
15576 /* Negative int means reduce maximum width. */
15577 if (precision
<= 0)
15580 precision
= min (precision
, -lim
);
15584 /* Padding specified. Don't let it be more than
15585 current maximum. */
15587 lim
= min (precision
, lim
);
15589 /* If that's more padding than already wanted, queue it.
15590 But don't reduce padding already specified even if
15591 that is beyond the current truncation point. */
15592 field_width
= max (lim
, field_width
);
15596 else if (STRINGP (car
) || CONSP (car
))
15598 register int limit
= 50;
15599 /* Limit is to protect against circular lists. */
15602 && (precision
<= 0 || n
< precision
))
15604 n
+= display_mode_element (it
, depth
, field_width
- n
,
15605 precision
- n
, XCAR (elt
),
15615 elt
= build_string ("*invalid*");
15619 /* Pad to FIELD_WIDTH. */
15620 if (field_width
> 0 && n
< field_width
)
15622 if (frame_title_ptr
)
15623 n
+= store_frame_title ("", field_width
- n
, 0);
15624 else if (!NILP (mode_line_string_list
))
15625 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
15627 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
15634 /* Store a mode-line string element in mode_line_string_list.
15636 If STRING is non-null, display that C string. Otherwise, the Lisp
15637 string LISP_STRING is displayed.
15639 FIELD_WIDTH is the minimum number of output glyphs to produce.
15640 If STRING has fewer characters than FIELD_WIDTH, pad to the right
15641 with spaces. FIELD_WIDTH <= 0 means don't pad.
15643 PRECISION is the maximum number of characters to output from
15644 STRING. PRECISION <= 0 means don't truncate the string.
15646 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
15647 properties to the string.
15649 PROPS are the properties to add to the string.
15650 The mode_line_string_face face property is always added to the string.
15653 static int store_mode_line_string (string
, lisp_string
, copy_string
, field_width
, precision
, props
)
15655 Lisp_Object lisp_string
;
15664 if (string
!= NULL
)
15666 len
= strlen (string
);
15667 if (precision
> 0 && len
> precision
)
15669 lisp_string
= make_string (string
, len
);
15671 props
= mode_line_string_face_prop
;
15672 else if (!NILP (mode_line_string_face
))
15674 Lisp_Object face
= Fplist_get (props
, Qface
);
15675 props
= Fcopy_sequence (props
);
15677 face
= mode_line_string_face
;
15679 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
15680 props
= Fplist_put (props
, Qface
, face
);
15682 Fadd_text_properties (make_number (0), make_number (len
),
15683 props
, lisp_string
);
15687 len
= XFASTINT (Flength (lisp_string
));
15688 if (precision
> 0 && len
> precision
)
15691 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
15694 if (!NILP (mode_line_string_face
))
15698 props
= Ftext_properties_at (make_number (0), lisp_string
);
15699 face
= Fplist_get (props
, Qface
);
15701 face
= mode_line_string_face
;
15703 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
15704 props
= Fcons (Qface
, Fcons (face
, Qnil
));
15706 lisp_string
= Fcopy_sequence (lisp_string
);
15709 Fadd_text_properties (make_number (0), make_number (len
),
15710 props
, lisp_string
);
15715 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
15719 if (field_width
> len
)
15721 field_width
-= len
;
15722 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
15724 Fadd_text_properties (make_number (0), make_number (field_width
),
15725 props
, lisp_string
);
15726 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
15734 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
15736 doc
: /* Return the mode-line of selected window as a string.
15737 First optional arg FORMAT specifies a different format string (see
15738 `mode-line-format' for details) to use. If FORMAT is t, return
15739 the buffer's header-line. Second optional arg WINDOW specifies a
15740 different window to use as the context for the formatting.
15741 If third optional arg NO-PROPS is non-nil, string is not propertized. */)
15742 (format
, window
, no_props
)
15743 Lisp_Object format
, window
, no_props
;
15748 struct buffer
*old_buffer
= NULL
;
15749 enum face_id face_id
= DEFAULT_FACE_ID
;
15752 window
= selected_window
;
15753 CHECK_WINDOW (window
);
15754 w
= XWINDOW (window
);
15755 CHECK_BUFFER (w
->buffer
);
15757 if (XBUFFER (w
->buffer
) != current_buffer
)
15759 old_buffer
= current_buffer
;
15760 set_buffer_internal_1 (XBUFFER (w
->buffer
));
15763 if (NILP (format
) || EQ (format
, Qt
))
15765 face_id
= NILP (format
)
15766 ? CURRENT_MODE_LINE_FACE_ID (w
) :
15767 HEADER_LINE_FACE_ID
;
15768 format
= NILP (format
)
15769 ? current_buffer
->mode_line_format
15770 : current_buffer
->header_line_format
;
15773 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
15775 if (NILP (no_props
))
15777 mode_line_string_face
=
15778 (face_id
== MODE_LINE_FACE_ID
? Qmode_line
:
15779 face_id
== MODE_LINE_INACTIVE_FACE_ID
? Qmode_line_inactive
:
15780 face_id
== HEADER_LINE_FACE_ID
? Qheader_line
: Qnil
);
15782 mode_line_string_face_prop
=
15783 NILP (mode_line_string_face
) ? Qnil
:
15784 Fcons (Qface
, Fcons (mode_line_string_face
, Qnil
));
15786 /* We need a dummy last element in mode_line_string_list to
15787 indicate we are building the propertized mode-line string.
15788 Using mode_line_string_face_prop here GC protects it. */
15789 mode_line_string_list
=
15790 Fcons (mode_line_string_face_prop
, Qnil
);
15791 frame_title_ptr
= NULL
;
15795 mode_line_string_face_prop
= Qnil
;
15796 mode_line_string_list
= Qnil
;
15797 frame_title_ptr
= frame_title_buf
;
15800 push_frame_kboard (it
.f
);
15801 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
15802 pop_frame_kboard ();
15805 set_buffer_internal_1 (old_buffer
);
15807 if (NILP (no_props
))
15810 mode_line_string_list
= Fnreverse (mode_line_string_list
);
15811 str
= Fmapconcat (intern ("identity"), XCDR (mode_line_string_list
),
15812 make_string ("", 0));
15813 mode_line_string_face_prop
= Qnil
;
15814 mode_line_string_list
= Qnil
;
15818 len
= frame_title_ptr
- frame_title_buf
;
15819 if (len
> 0 && frame_title_ptr
[-1] == '-')
15821 /* Mode lines typically ends with numerous dashes; reduce to two dashes. */
15822 while (frame_title_ptr
> frame_title_buf
&& *--frame_title_ptr
== '-')
15824 frame_title_ptr
+= 3; /* restore last non-dash + two dashes */
15825 if (len
> frame_title_ptr
- frame_title_buf
)
15826 len
= frame_title_ptr
- frame_title_buf
;
15829 frame_title_ptr
= NULL
;
15830 return make_string (frame_title_buf
, len
);
15833 /* Write a null-terminated, right justified decimal representation of
15834 the positive integer D to BUF using a minimal field width WIDTH. */
15837 pint2str (buf
, width
, d
)
15838 register char *buf
;
15839 register int width
;
15842 register char *p
= buf
;
15850 *p
++ = d
% 10 + '0';
15855 for (width
-= (int) (p
- buf
); width
> 0; --width
)
15866 /* Write a null-terminated, right justified decimal and "human
15867 readable" representation of the nonnegative integer D to BUF using
15868 a minimal field width WIDTH. D should be smaller than 999.5e24. */
15870 static const char power_letter
[] =
15884 pint2hrstr (buf
, width
, d
)
15889 /* We aim to represent the nonnegative integer D as
15890 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
15893 /* -1 means: do not use TENTHS. */
15897 /* Length of QUOTIENT.TENTHS as a string. */
15903 if (1000 <= quotient
)
15905 /* Scale to the appropriate EXPONENT. */
15908 remainder
= quotient
% 1000;
15912 while (1000 <= quotient
);
15914 /* Round to nearest and decide whether to use TENTHS or not. */
15917 tenths
= remainder
/ 100;
15918 if (50 <= remainder
% 100)
15924 if (quotient
== 10)
15931 if (500 <= remainder
)
15932 if (quotient
< 999)
15942 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
15943 if (tenths
== -1 && quotient
<= 99)
15950 p
= psuffix
= buf
+ max (width
, length
);
15952 /* Print EXPONENT. */
15954 *psuffix
++ = power_letter
[exponent
];
15957 /* Print TENTHS. */
15960 *--p
= '0' + tenths
;
15964 /* Print QUOTIENT. */
15967 int digit
= quotient
% 10;
15968 *--p
= '0' + digit
;
15970 while ((quotient
/= 10) != 0);
15972 /* Print leading spaces. */
15977 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
15978 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
15979 type of CODING_SYSTEM. Return updated pointer into BUF. */
15981 static unsigned char invalid_eol_type
[] = "(*invalid*)";
15984 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
15985 Lisp_Object coding_system
;
15986 register char *buf
;
15990 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
15991 const unsigned char *eol_str
;
15993 /* The EOL conversion we are using. */
15994 Lisp_Object eoltype
;
15996 val
= Fget (coding_system
, Qcoding_system
);
15999 if (!VECTORP (val
)) /* Not yet decided. */
16004 eoltype
= eol_mnemonic_undecided
;
16005 /* Don't mention EOL conversion if it isn't decided. */
16009 Lisp_Object eolvalue
;
16011 eolvalue
= Fget (coding_system
, Qeol_type
);
16014 *buf
++ = XFASTINT (AREF (val
, 1));
16018 /* The EOL conversion that is normal on this system. */
16020 if (NILP (eolvalue
)) /* Not yet decided. */
16021 eoltype
= eol_mnemonic_undecided
;
16022 else if (VECTORP (eolvalue
)) /* Not yet decided. */
16023 eoltype
= eol_mnemonic_undecided
;
16024 else /* INTEGERP (eolvalue) -- 0:LF, 1:CRLF, 2:CR */
16025 eoltype
= (XFASTINT (eolvalue
) == 0
16026 ? eol_mnemonic_unix
16027 : (XFASTINT (eolvalue
) == 1
16028 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
16034 /* Mention the EOL conversion if it is not the usual one. */
16035 if (STRINGP (eoltype
))
16037 eol_str
= SDATA (eoltype
);
16038 eol_str_len
= SBYTES (eoltype
);
16040 else if (INTEGERP (eoltype
)
16041 && CHAR_VALID_P (XINT (eoltype
), 0))
16043 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
16044 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
16049 eol_str
= invalid_eol_type
;
16050 eol_str_len
= sizeof (invalid_eol_type
) - 1;
16052 bcopy (eol_str
, buf
, eol_str_len
);
16053 buf
+= eol_str_len
;
16059 /* Return a string for the output of a mode line %-spec for window W,
16060 generated by character C. PRECISION >= 0 means don't return a
16061 string longer than that value. FIELD_WIDTH > 0 means pad the
16062 string returned with spaces to that value. Return 1 in *MULTIBYTE
16063 if the result is multibyte text. */
16065 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
16068 decode_mode_spec (w
, c
, field_width
, precision
, multibyte
)
16071 int field_width
, precision
;
16075 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16076 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
16077 struct buffer
*b
= XBUFFER (w
->buffer
);
16085 if (!NILP (b
->read_only
))
16087 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
16092 /* This differs from %* only for a modified read-only buffer. */
16093 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
16095 if (!NILP (b
->read_only
))
16100 /* This differs from %* in ignoring read-only-ness. */
16101 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
16113 if (command_loop_level
> 5)
16115 p
= decode_mode_spec_buf
;
16116 for (i
= 0; i
< command_loop_level
; i
++)
16119 return decode_mode_spec_buf
;
16127 if (command_loop_level
> 5)
16129 p
= decode_mode_spec_buf
;
16130 for (i
= 0; i
< command_loop_level
; i
++)
16133 return decode_mode_spec_buf
;
16140 /* Let lots_of_dashes be a string of infinite length. */
16141 if (!NILP (mode_line_string_list
))
16143 if (field_width
<= 0
16144 || field_width
> sizeof (lots_of_dashes
))
16146 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
16147 decode_mode_spec_buf
[i
] = '-';
16148 decode_mode_spec_buf
[i
] = '\0';
16149 return decode_mode_spec_buf
;
16152 return lots_of_dashes
;
16161 int col
= (int) current_column (); /* iftc */
16162 w
->column_number_displayed
= make_number (col
);
16163 pint2str (decode_mode_spec_buf
, field_width
, col
);
16164 return decode_mode_spec_buf
;
16168 /* %F displays the frame name. */
16169 if (!NILP (f
->title
))
16170 return (char *) SDATA (f
->title
);
16171 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
16172 return (char *) SDATA (f
->name
);
16181 int size
= ZV
- BEGV
;
16182 pint2str (decode_mode_spec_buf
, field_width
, size
);
16183 return decode_mode_spec_buf
;
16188 int size
= ZV
- BEGV
;
16189 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
16190 return decode_mode_spec_buf
;
16195 int startpos
= XMARKER (w
->start
)->charpos
;
16196 int startpos_byte
= marker_byte_position (w
->start
);
16197 int line
, linepos
, linepos_byte
, topline
;
16199 int height
= WINDOW_TOTAL_LINES (w
);
16201 /* If we decided that this buffer isn't suitable for line numbers,
16202 don't forget that too fast. */
16203 if (EQ (w
->base_line_pos
, w
->buffer
))
16205 /* But do forget it, if the window shows a different buffer now. */
16206 else if (BUFFERP (w
->base_line_pos
))
16207 w
->base_line_pos
= Qnil
;
16209 /* If the buffer is very big, don't waste time. */
16210 if (INTEGERP (Vline_number_display_limit
)
16211 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
16213 w
->base_line_pos
= Qnil
;
16214 w
->base_line_number
= Qnil
;
16218 if (!NILP (w
->base_line_number
)
16219 && !NILP (w
->base_line_pos
)
16220 && XFASTINT (w
->base_line_pos
) <= startpos
)
16222 line
= XFASTINT (w
->base_line_number
);
16223 linepos
= XFASTINT (w
->base_line_pos
);
16224 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
16229 linepos
= BUF_BEGV (b
);
16230 linepos_byte
= BUF_BEGV_BYTE (b
);
16233 /* Count lines from base line to window start position. */
16234 nlines
= display_count_lines (linepos
, linepos_byte
,
16238 topline
= nlines
+ line
;
16240 /* Determine a new base line, if the old one is too close
16241 or too far away, or if we did not have one.
16242 "Too close" means it's plausible a scroll-down would
16243 go back past it. */
16244 if (startpos
== BUF_BEGV (b
))
16246 w
->base_line_number
= make_number (topline
);
16247 w
->base_line_pos
= make_number (BUF_BEGV (b
));
16249 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
16250 || linepos
== BUF_BEGV (b
))
16252 int limit
= BUF_BEGV (b
);
16253 int limit_byte
= BUF_BEGV_BYTE (b
);
16255 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
16257 if (startpos
- distance
> limit
)
16259 limit
= startpos
- distance
;
16260 limit_byte
= CHAR_TO_BYTE (limit
);
16263 nlines
= display_count_lines (startpos
, startpos_byte
,
16265 - (height
* 2 + 30),
16267 /* If we couldn't find the lines we wanted within
16268 line_number_display_limit_width chars per line,
16269 give up on line numbers for this window. */
16270 if (position
== limit_byte
&& limit
== startpos
- distance
)
16272 w
->base_line_pos
= w
->buffer
;
16273 w
->base_line_number
= Qnil
;
16277 w
->base_line_number
= make_number (topline
- nlines
);
16278 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
16281 /* Now count lines from the start pos to point. */
16282 nlines
= display_count_lines (startpos
, startpos_byte
,
16283 PT_BYTE
, PT
, &junk
);
16285 /* Record that we did display the line number. */
16286 line_number_displayed
= 1;
16288 /* Make the string to show. */
16289 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
16290 return decode_mode_spec_buf
;
16293 char* p
= decode_mode_spec_buf
;
16294 int pad
= field_width
- 2;
16300 return decode_mode_spec_buf
;
16306 obj
= b
->mode_name
;
16310 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
16316 int pos
= marker_position (w
->start
);
16317 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
16319 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
16321 if (pos
<= BUF_BEGV (b
))
16326 else if (pos
<= BUF_BEGV (b
))
16330 if (total
> 1000000)
16331 /* Do it differently for a large value, to avoid overflow. */
16332 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
16334 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
16335 /* We can't normally display a 3-digit number,
16336 so get us a 2-digit number that is close. */
16339 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
16340 return decode_mode_spec_buf
;
16344 /* Display percentage of size above the bottom of the screen. */
16347 int toppos
= marker_position (w
->start
);
16348 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
16349 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
16351 if (botpos
>= BUF_ZV (b
))
16353 if (toppos
<= BUF_BEGV (b
))
16360 if (total
> 1000000)
16361 /* Do it differently for a large value, to avoid overflow. */
16362 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
16364 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
16365 /* We can't normally display a 3-digit number,
16366 so get us a 2-digit number that is close. */
16369 if (toppos
<= BUF_BEGV (b
))
16370 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
16372 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
16373 return decode_mode_spec_buf
;
16378 /* status of process */
16379 obj
= Fget_buffer_process (w
->buffer
);
16381 return "no process";
16382 #ifdef subprocesses
16383 obj
= Fsymbol_name (Fprocess_status (obj
));
16387 case 't': /* indicate TEXT or BINARY */
16388 #ifdef MODE_LINE_BINARY_TEXT
16389 return MODE_LINE_BINARY_TEXT (b
);
16395 /* coding-system (not including end-of-line format) */
16397 /* coding-system (including end-of-line type) */
16399 int eol_flag
= (c
== 'Z');
16400 char *p
= decode_mode_spec_buf
;
16402 if (! FRAME_WINDOW_P (f
))
16404 /* No need to mention EOL here--the terminal never needs
16405 to do EOL conversion. */
16406 p
= decode_mode_spec_coding (keyboard_coding
.symbol
, p
, 0);
16407 p
= decode_mode_spec_coding (terminal_coding
.symbol
, p
, 0);
16409 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
16412 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
16413 #ifdef subprocesses
16414 obj
= Fget_buffer_process (Fcurrent_buffer ());
16415 if (PROCESSP (obj
))
16417 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
16419 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
16422 #endif /* subprocesses */
16425 return decode_mode_spec_buf
;
16431 *multibyte
= STRING_MULTIBYTE (obj
);
16432 return (char *) SDATA (obj
);
16439 /* Count up to COUNT lines starting from START / START_BYTE.
16440 But don't go beyond LIMIT_BYTE.
16441 Return the number of lines thus found (always nonnegative).
16443 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
16446 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
16447 int start
, start_byte
, limit_byte
, count
;
16450 register unsigned char *cursor
;
16451 unsigned char *base
;
16453 register int ceiling
;
16454 register unsigned char *ceiling_addr
;
16455 int orig_count
= count
;
16457 /* If we are not in selective display mode,
16458 check only for newlines. */
16459 int selective_display
= (!NILP (current_buffer
->selective_display
)
16460 && !INTEGERP (current_buffer
->selective_display
));
16464 while (start_byte
< limit_byte
)
16466 ceiling
= BUFFER_CEILING_OF (start_byte
);
16467 ceiling
= min (limit_byte
- 1, ceiling
);
16468 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
16469 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
16472 if (selective_display
)
16473 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
16476 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
16479 if (cursor
!= ceiling_addr
)
16483 start_byte
+= cursor
- base
+ 1;
16484 *byte_pos_ptr
= start_byte
;
16488 if (++cursor
== ceiling_addr
)
16494 start_byte
+= cursor
- base
;
16499 while (start_byte
> limit_byte
)
16501 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
16502 ceiling
= max (limit_byte
, ceiling
);
16503 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
16504 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
16507 if (selective_display
)
16508 while (--cursor
!= ceiling_addr
16509 && *cursor
!= '\n' && *cursor
!= 015)
16512 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
16515 if (cursor
!= ceiling_addr
)
16519 start_byte
+= cursor
- base
+ 1;
16520 *byte_pos_ptr
= start_byte
;
16521 /* When scanning backwards, we should
16522 not count the newline posterior to which we stop. */
16523 return - orig_count
- 1;
16529 /* Here we add 1 to compensate for the last decrement
16530 of CURSOR, which took it past the valid range. */
16531 start_byte
+= cursor
- base
+ 1;
16535 *byte_pos_ptr
= limit_byte
;
16538 return - orig_count
+ count
;
16539 return orig_count
- count
;
16545 /***********************************************************************
16547 ***********************************************************************/
16549 /* Display a NUL-terminated string, starting with index START.
16551 If STRING is non-null, display that C string. Otherwise, the Lisp
16552 string LISP_STRING is displayed.
16554 If FACE_STRING is not nil, FACE_STRING_POS is a position in
16555 FACE_STRING. Display STRING or LISP_STRING with the face at
16556 FACE_STRING_POS in FACE_STRING:
16558 Display the string in the environment given by IT, but use the
16559 standard display table, temporarily.
16561 FIELD_WIDTH is the minimum number of output glyphs to produce.
16562 If STRING has fewer characters than FIELD_WIDTH, pad to the right
16563 with spaces. If STRING has more characters, more than FIELD_WIDTH
16564 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
16566 PRECISION is the maximum number of characters to output from
16567 STRING. PRECISION < 0 means don't truncate the string.
16569 This is roughly equivalent to printf format specifiers:
16571 FIELD_WIDTH PRECISION PRINTF
16572 ----------------------------------------
16578 MULTIBYTE zero means do not display multibyte chars, > 0 means do
16579 display them, and < 0 means obey the current buffer's value of
16580 enable_multibyte_characters.
16582 Value is the number of glyphs produced. */
16585 display_string (string
, lisp_string
, face_string
, face_string_pos
,
16586 start
, it
, field_width
, precision
, max_x
, multibyte
)
16587 unsigned char *string
;
16588 Lisp_Object lisp_string
;
16589 Lisp_Object face_string
;
16590 int face_string_pos
;
16593 int field_width
, precision
, max_x
;
16596 int hpos_at_start
= it
->hpos
;
16597 int saved_face_id
= it
->face_id
;
16598 struct glyph_row
*row
= it
->glyph_row
;
16600 /* Initialize the iterator IT for iteration over STRING beginning
16601 with index START. */
16602 reseat_to_string (it
, string
, lisp_string
, start
,
16603 precision
, field_width
, multibyte
);
16605 /* If displaying STRING, set up the face of the iterator
16606 from LISP_STRING, if that's given. */
16607 if (STRINGP (face_string
))
16613 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
16614 0, it
->region_beg_charpos
,
16615 it
->region_end_charpos
,
16616 &endptr
, it
->base_face_id
, 0);
16617 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16618 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
16621 /* Set max_x to the maximum allowed X position. Don't let it go
16622 beyond the right edge of the window. */
16624 max_x
= it
->last_visible_x
;
16626 max_x
= min (max_x
, it
->last_visible_x
);
16628 /* Skip over display elements that are not visible. because IT->w is
16630 if (it
->current_x
< it
->first_visible_x
)
16631 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
16632 MOVE_TO_POS
| MOVE_TO_X
);
16634 row
->ascent
= it
->max_ascent
;
16635 row
->height
= it
->max_ascent
+ it
->max_descent
;
16636 row
->phys_ascent
= it
->max_phys_ascent
;
16637 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16639 /* This condition is for the case that we are called with current_x
16640 past last_visible_x. */
16641 while (it
->current_x
< max_x
)
16643 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
16645 /* Get the next display element. */
16646 if (!get_next_display_element (it
))
16649 /* Produce glyphs. */
16650 x_before
= it
->current_x
;
16651 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
16652 PRODUCE_GLYPHS (it
);
16654 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
16657 while (i
< nglyphs
)
16659 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
16661 if (!it
->truncate_lines_p
16662 && x
+ glyph
->pixel_width
> max_x
)
16664 /* End of continued line or max_x reached. */
16665 if (CHAR_GLYPH_PADDING_P (*glyph
))
16667 /* A wide character is unbreakable. */
16668 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16669 it
->current_x
= x_before
;
16673 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
16678 else if (x
+ glyph
->pixel_width
> it
->first_visible_x
)
16680 /* Glyph is at least partially visible. */
16682 if (x
< it
->first_visible_x
)
16683 it
->glyph_row
->x
= x
- it
->first_visible_x
;
16687 /* Glyph is off the left margin of the display area.
16688 Should not happen. */
16692 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16693 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16694 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16695 row
->phys_height
= max (row
->phys_height
,
16696 it
->max_phys_ascent
+ it
->max_phys_descent
);
16697 x
+= glyph
->pixel_width
;
16701 /* Stop if max_x reached. */
16705 /* Stop at line ends. */
16706 if (ITERATOR_AT_END_OF_LINE_P (it
))
16708 it
->continuation_lines_width
= 0;
16712 set_iterator_to_next (it
, 1);
16714 /* Stop if truncating at the right edge. */
16715 if (it
->truncate_lines_p
16716 && it
->current_x
>= it
->last_visible_x
)
16718 /* Add truncation mark, but don't do it if the line is
16719 truncated at a padding space. */
16720 if (IT_CHARPOS (*it
) < it
->string_nchars
)
16722 if (!FRAME_WINDOW_P (it
->f
))
16726 if (it
->current_x
> it
->last_visible_x
)
16728 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
16729 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
16731 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
16733 row
->used
[TEXT_AREA
] = i
;
16734 produce_special_glyphs (it
, IT_TRUNCATION
);
16737 produce_special_glyphs (it
, IT_TRUNCATION
);
16739 it
->glyph_row
->truncated_on_right_p
= 1;
16745 /* Maybe insert a truncation at the left. */
16746 if (it
->first_visible_x
16747 && IT_CHARPOS (*it
) > 0)
16749 if (!FRAME_WINDOW_P (it
->f
))
16750 insert_left_trunc_glyphs (it
);
16751 it
->glyph_row
->truncated_on_left_p
= 1;
16754 it
->face_id
= saved_face_id
;
16756 /* Value is number of columns displayed. */
16757 return it
->hpos
- hpos_at_start
;
16762 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
16763 appears as an element of LIST or as the car of an element of LIST.
16764 If PROPVAL is a list, compare each element against LIST in that
16765 way, and return 1/2 if any element of PROPVAL is found in LIST.
16766 Otherwise return 0. This function cannot quit.
16767 The return value is 2 if the text is invisible but with an ellipsis
16768 and 1 if it's invisible and without an ellipsis. */
16771 invisible_p (propval
, list
)
16772 register Lisp_Object propval
;
16775 register Lisp_Object tail
, proptail
;
16777 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
16779 register Lisp_Object tem
;
16781 if (EQ (propval
, tem
))
16783 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
16784 return NILP (XCDR (tem
)) ? 1 : 2;
16787 if (CONSP (propval
))
16789 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
16791 Lisp_Object propelt
;
16792 propelt
= XCAR (proptail
);
16793 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
16795 register Lisp_Object tem
;
16797 if (EQ (propelt
, tem
))
16799 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
16800 return NILP (XCDR (tem
)) ? 1 : 2;
16808 /* Calculate a width or height in pixels from a specification using
16809 the following elements:
16812 NUM - a (fractional) multiple of the default font width/height
16813 (NUM) - specifies exactly NUM pixels
16814 UNIT - a fixed number of pixels, see below.
16815 ELEMENT - size of a display element in pixels, see below.
16816 (NUM . SPEC) - equals NUM * SPEC
16817 (+ SPEC SPEC ...) - add pixel values
16818 (- SPEC SPEC ...) - subtract pixel values
16819 (- SPEC) - negate pixel value
16822 INT or FLOAT - a number constant
16823 SYMBOL - use symbol's (buffer local) variable binding.
16826 in - pixels per inch *)
16827 mm - pixels per 1/1000 meter *)
16828 cm - pixels per 1/100 meter *)
16829 width - width of current font in pixels.
16830 height - height of current font in pixels.
16832 *) using the ratio(s) defined in display-pixels-per-inch.
16836 left-fringe - left fringe width in pixels
16837 right-fringe - right fringe width in pixels
16839 left-margin - left margin width in pixels
16840 right-margin - right margin width in pixels
16842 scroll-bar - scroll-bar area width in pixels
16846 Pixels corresponding to 5 inches:
16849 Total width of non-text areas on left side of window (if scroll-bar is on left):
16850 '(space :width (+ left-fringe left-margin scroll-bar))
16852 Align to first text column (in header line):
16853 '(space :align-to 0)
16855 Align to middle of text area minus half the width of variable `my-image'
16856 containing a loaded image:
16857 '(space :align-to (0.5 . (- text my-image)))
16859 Width of left margin minus width of 1 character in the default font:
16860 '(space :width (- left-margin 1))
16862 Width of left margin minus width of 2 characters in the current font:
16863 '(space :width (- left-margin (2 . width)))
16865 Center 1 character over left-margin (in header line):
16866 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
16868 Different ways to express width of left fringe plus left margin minus one pixel:
16869 '(space :width (- (+ left-fringe left-margin) (1)))
16870 '(space :width (+ left-fringe left-margin (- (1))))
16871 '(space :width (+ left-fringe left-margin (-1)))
16875 #define NUMVAL(X) \
16876 ((INTEGERP (X) || FLOATP (X)) \
16881 calc_pixel_width_or_height (res
, it
, prop
, font
, width_p
, align_to
)
16886 int width_p
, *align_to
;
16890 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
16891 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
16894 return OK_PIXELS (0);
16896 if (SYMBOLP (prop
))
16898 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
16900 char *unit
= SDATA (SYMBOL_NAME (prop
));
16902 if (unit
[0] == 'i' && unit
[1] == 'n')
16904 else if (unit
[0] == 'm' && unit
[1] == 'm')
16906 else if (unit
[0] == 'c' && unit
[1] == 'm')
16913 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
16914 || (CONSP (Vdisplay_pixels_per_inch
)
16916 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
16917 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
16919 return OK_PIXELS (ppi
/ pixels
);
16925 #ifdef HAVE_WINDOW_SYSTEM
16926 if (EQ (prop
, Qheight
))
16927 return OK_PIXELS (font
? FONT_HEIGHT ((XFontStruct
*)font
) : FRAME_LINE_HEIGHT (it
->f
));
16928 if (EQ (prop
, Qwidth
))
16929 return OK_PIXELS (font
? FONT_WIDTH ((XFontStruct
*)font
) : FRAME_COLUMN_WIDTH (it
->f
));
16931 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
16932 return OK_PIXELS (1);
16935 if (EQ (prop
, Qtext
))
16936 return OK_PIXELS (width_p
16937 ? window_box_width (it
->w
, TEXT_AREA
)
16938 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
16940 if (align_to
&& *align_to
< 0)
16943 if (EQ (prop
, Qleft
))
16944 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
16945 if (EQ (prop
, Qright
))
16946 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
16947 if (EQ (prop
, Qcenter
))
16948 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
16949 + window_box_width (it
->w
, TEXT_AREA
) / 2);
16950 if (EQ (prop
, Qleft_fringe
))
16951 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
16952 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
16953 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
16954 if (EQ (prop
, Qright_fringe
))
16955 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
16956 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
16957 : window_box_right_offset (it
->w
, TEXT_AREA
));
16958 if (EQ (prop
, Qleft_margin
))
16959 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
16960 if (EQ (prop
, Qright_margin
))
16961 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
16962 if (EQ (prop
, Qscroll_bar
))
16963 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
16965 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
16966 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
16967 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
16972 if (EQ (prop
, Qleft_fringe
))
16973 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
16974 if (EQ (prop
, Qright_fringe
))
16975 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
16976 if (EQ (prop
, Qleft_margin
))
16977 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
16978 if (EQ (prop
, Qright_margin
))
16979 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
16980 if (EQ (prop
, Qscroll_bar
))
16981 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
16984 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
16987 if (INTEGERP (prop
) || FLOATP (prop
))
16989 int base_unit
= (width_p
16990 ? FRAME_COLUMN_WIDTH (it
->f
)
16991 : FRAME_LINE_HEIGHT (it
->f
));
16992 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
16997 Lisp_Object car
= XCAR (prop
);
16998 Lisp_Object cdr
= XCDR (prop
);
17002 #ifdef HAVE_WINDOW_SYSTEM
17003 if (valid_image_p (prop
))
17005 int id
= lookup_image (it
->f
, prop
);
17006 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
17008 return OK_PIXELS (width_p
? img
->width
: img
->height
);
17011 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
17017 while (CONSP (cdr
))
17019 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
17020 font
, width_p
, align_to
))
17023 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
17028 if (EQ (car
, Qminus
))
17030 return OK_PIXELS (pixels
);
17033 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
17036 if (INTEGERP (car
) || FLOATP (car
))
17039 pixels
= XFLOATINT (car
);
17041 return OK_PIXELS (pixels
);
17042 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
17043 font
, width_p
, align_to
))
17044 return OK_PIXELS (pixels
* fact
);
17055 /***********************************************************************
17057 ***********************************************************************/
17059 #ifdef HAVE_WINDOW_SYSTEM
17064 dump_glyph_string (s
)
17065 struct glyph_string
*s
;
17067 fprintf (stderr
, "glyph string\n");
17068 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
17069 s
->x
, s
->y
, s
->width
, s
->height
);
17070 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
17071 fprintf (stderr
, " hl = %d\n", s
->hl
);
17072 fprintf (stderr
, " left overhang = %d, right = %d\n",
17073 s
->left_overhang
, s
->right_overhang
);
17074 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
17075 fprintf (stderr
, " extends to end of line = %d\n",
17076 s
->extends_to_end_of_line_p
);
17077 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
17078 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
17081 #endif /* GLYPH_DEBUG */
17083 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
17084 of XChar2b structures for S; it can't be allocated in
17085 init_glyph_string because it must be allocated via `alloca'. W
17086 is the window on which S is drawn. ROW and AREA are the glyph row
17087 and area within the row from which S is constructed. START is the
17088 index of the first glyph structure covered by S. HL is a
17089 face-override for drawing S. */
17092 #define OPTIONAL_HDC(hdc) hdc,
17093 #define DECLARE_HDC(hdc) HDC hdc;
17094 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
17095 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
17098 #ifndef OPTIONAL_HDC
17099 #define OPTIONAL_HDC(hdc)
17100 #define DECLARE_HDC(hdc)
17101 #define ALLOCATE_HDC(hdc, f)
17102 #define RELEASE_HDC(hdc, f)
17106 init_glyph_string (s
, OPTIONAL_HDC (hdc
) char2b
, w
, row
, area
, start
, hl
)
17107 struct glyph_string
*s
;
17111 struct glyph_row
*row
;
17112 enum glyph_row_area area
;
17114 enum draw_glyphs_face hl
;
17116 bzero (s
, sizeof *s
);
17118 s
->f
= XFRAME (w
->frame
);
17122 s
->display
= FRAME_X_DISPLAY (s
->f
);
17123 s
->window
= FRAME_X_WINDOW (s
->f
);
17124 s
->char2b
= char2b
;
17128 s
->first_glyph
= row
->glyphs
[area
] + start
;
17129 s
->height
= row
->height
;
17130 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
17132 /* Display the internal border below the tool-bar window. */
17133 if (s
->w
== XWINDOW (s
->f
->tool_bar_window
))
17134 s
->y
-= FRAME_INTERNAL_BORDER_WIDTH (s
->f
);
17136 s
->ybase
= s
->y
+ row
->ascent
;
17140 /* Append the list of glyph strings with head H and tail T to the list
17141 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
17144 append_glyph_string_lists (head
, tail
, h
, t
)
17145 struct glyph_string
**head
, **tail
;
17146 struct glyph_string
*h
, *t
;
17160 /* Prepend the list of glyph strings with head H and tail T to the
17161 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
17165 prepend_glyph_string_lists (head
, tail
, h
, t
)
17166 struct glyph_string
**head
, **tail
;
17167 struct glyph_string
*h
, *t
;
17181 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
17182 Set *HEAD and *TAIL to the resulting list. */
17185 append_glyph_string (head
, tail
, s
)
17186 struct glyph_string
**head
, **tail
;
17187 struct glyph_string
*s
;
17189 s
->next
= s
->prev
= NULL
;
17190 append_glyph_string_lists (head
, tail
, s
, s
);
17194 /* Get face and two-byte form of character glyph GLYPH on frame F.
17195 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
17196 a pointer to a realized face that is ready for display. */
17198 static INLINE
struct face
*
17199 get_glyph_face_and_encoding (f
, glyph
, char2b
, two_byte_p
)
17201 struct glyph
*glyph
;
17207 xassert (glyph
->type
== CHAR_GLYPH
);
17208 face
= FACE_FROM_ID (f
, glyph
->face_id
);
17213 if (!glyph
->multibyte_p
)
17215 /* Unibyte case. We don't have to encode, but we have to make
17216 sure to use a face suitable for unibyte. */
17217 STORE_XCHAR2B (char2b
, 0, glyph
->u
.ch
);
17219 else if (glyph
->u
.ch
< 128
17220 && glyph
->face_id
< BASIC_FACE_ID_SENTINEL
)
17222 /* Case of ASCII in a face known to fit ASCII. */
17223 STORE_XCHAR2B (char2b
, 0, glyph
->u
.ch
);
17227 int c1
, c2
, charset
;
17229 /* Split characters into bytes. If c2 is -1 afterwards, C is
17230 really a one-byte character so that byte1 is zero. */
17231 SPLIT_CHAR (glyph
->u
.ch
, charset
, c1
, c2
);
17233 STORE_XCHAR2B (char2b
, c1
, c2
);
17235 STORE_XCHAR2B (char2b
, 0, c1
);
17237 /* Maybe encode the character in *CHAR2B. */
17238 if (charset
!= CHARSET_ASCII
)
17240 struct font_info
*font_info
17241 = FONT_INFO_FROM_ID (f
, face
->font_info_id
);
17244 = rif
->encode_char (glyph
->u
.ch
, char2b
, font_info
, two_byte_p
);
17248 /* Make sure X resources of the face are allocated. */
17249 xassert (face
!= NULL
);
17250 PREPARE_FACE_FOR_DISPLAY (f
, face
);
17255 /* Fill glyph string S with composition components specified by S->cmp.
17257 FACES is an array of faces for all components of this composition.
17258 S->gidx is the index of the first component for S.
17259 OVERLAPS_P non-zero means S should draw the foreground only, and
17260 use its physical height for clipping.
17262 Value is the index of a component not in S. */
17265 fill_composite_glyph_string (s
, faces
, overlaps_p
)
17266 struct glyph_string
*s
;
17267 struct face
**faces
;
17274 s
->for_overlaps_p
= overlaps_p
;
17276 s
->face
= faces
[s
->gidx
];
17277 s
->font
= s
->face
->font
;
17278 s
->font_info
= FONT_INFO_FROM_ID (s
->f
, s
->face
->font_info_id
);
17280 /* For all glyphs of this composition, starting at the offset
17281 S->gidx, until we reach the end of the definition or encounter a
17282 glyph that requires the different face, add it to S. */
17284 for (i
= s
->gidx
+ 1; i
< s
->cmp
->glyph_len
&& faces
[i
] == s
->face
; ++i
)
17287 /* All glyph strings for the same composition has the same width,
17288 i.e. the width set for the first component of the composition. */
17290 s
->width
= s
->first_glyph
->pixel_width
;
17292 /* If the specified font could not be loaded, use the frame's
17293 default font, but record the fact that we couldn't load it in
17294 the glyph string so that we can draw rectangles for the
17295 characters of the glyph string. */
17296 if (s
->font
== NULL
)
17298 s
->font_not_found_p
= 1;
17299 s
->font
= FRAME_FONT (s
->f
);
17302 /* Adjust base line for subscript/superscript text. */
17303 s
->ybase
+= s
->first_glyph
->voffset
;
17305 xassert (s
->face
&& s
->face
->gc
);
17307 /* This glyph string must always be drawn with 16-bit functions. */
17310 return s
->gidx
+ s
->nchars
;
17314 /* Fill glyph string S from a sequence of character glyphs.
17316 FACE_ID is the face id of the string. START is the index of the
17317 first glyph to consider, END is the index of the last + 1.
17318 OVERLAPS_P non-zero means S should draw the foreground only, and
17319 use its physical height for clipping.
17321 Value is the index of the first glyph not in S. */
17324 fill_glyph_string (s
, face_id
, start
, end
, overlaps_p
)
17325 struct glyph_string
*s
;
17327 int start
, end
, overlaps_p
;
17329 struct glyph
*glyph
, *last
;
17331 int glyph_not_available_p
;
17333 xassert (s
->f
== XFRAME (s
->w
->frame
));
17334 xassert (s
->nchars
== 0);
17335 xassert (start
>= 0 && end
> start
);
17337 s
->for_overlaps_p
= overlaps_p
,
17338 glyph
= s
->row
->glyphs
[s
->area
] + start
;
17339 last
= s
->row
->glyphs
[s
->area
] + end
;
17340 voffset
= glyph
->voffset
;
17342 glyph_not_available_p
= glyph
->glyph_not_available_p
;
17344 while (glyph
< last
17345 && glyph
->type
== CHAR_GLYPH
17346 && glyph
->voffset
== voffset
17347 /* Same face id implies same font, nowadays. */
17348 && glyph
->face_id
== face_id
17349 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
17353 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
17354 s
->char2b
+ s
->nchars
,
17356 s
->two_byte_p
= two_byte_p
;
17358 xassert (s
->nchars
<= end
- start
);
17359 s
->width
+= glyph
->pixel_width
;
17363 s
->font
= s
->face
->font
;
17364 s
->font_info
= FONT_INFO_FROM_ID (s
->f
, s
->face
->font_info_id
);
17366 /* If the specified font could not be loaded, use the frame's font,
17367 but record the fact that we couldn't load it in
17368 S->font_not_found_p so that we can draw rectangles for the
17369 characters of the glyph string. */
17370 if (s
->font
== NULL
|| glyph_not_available_p
)
17372 s
->font_not_found_p
= 1;
17373 s
->font
= FRAME_FONT (s
->f
);
17376 /* Adjust base line for subscript/superscript text. */
17377 s
->ybase
+= voffset
;
17379 xassert (s
->face
&& s
->face
->gc
);
17380 return glyph
- s
->row
->glyphs
[s
->area
];
17384 /* Fill glyph string S from image glyph S->first_glyph. */
17387 fill_image_glyph_string (s
)
17388 struct glyph_string
*s
;
17390 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
17391 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
17393 s
->slice
= s
->first_glyph
->slice
;
17394 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
17395 s
->font
= s
->face
->font
;
17396 s
->width
= s
->first_glyph
->pixel_width
;
17398 /* Adjust base line for subscript/superscript text. */
17399 s
->ybase
+= s
->first_glyph
->voffset
;
17403 /* Fill glyph string S from a sequence of stretch glyphs.
17405 ROW is the glyph row in which the glyphs are found, AREA is the
17406 area within the row. START is the index of the first glyph to
17407 consider, END is the index of the last + 1.
17409 Value is the index of the first glyph not in S. */
17412 fill_stretch_glyph_string (s
, row
, area
, start
, end
)
17413 struct glyph_string
*s
;
17414 struct glyph_row
*row
;
17415 enum glyph_row_area area
;
17418 struct glyph
*glyph
, *last
;
17419 int voffset
, face_id
;
17421 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
17423 glyph
= s
->row
->glyphs
[s
->area
] + start
;
17424 last
= s
->row
->glyphs
[s
->area
] + end
;
17425 face_id
= glyph
->face_id
;
17426 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
17427 s
->font
= s
->face
->font
;
17428 s
->font_info
= FONT_INFO_FROM_ID (s
->f
, s
->face
->font_info_id
);
17429 s
->width
= glyph
->pixel_width
;
17430 voffset
= glyph
->voffset
;
17434 && glyph
->type
== STRETCH_GLYPH
17435 && glyph
->voffset
== voffset
17436 && glyph
->face_id
== face_id
);
17438 s
->width
+= glyph
->pixel_width
;
17440 /* Adjust base line for subscript/superscript text. */
17441 s
->ybase
+= voffset
;
17443 /* The case that face->gc == 0 is handled when drawing the glyph
17444 string by calling PREPARE_FACE_FOR_DISPLAY. */
17446 return glyph
- s
->row
->glyphs
[s
->area
];
17451 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
17452 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
17453 assumed to be zero. */
17456 x_get_glyph_overhangs (glyph
, f
, left
, right
)
17457 struct glyph
*glyph
;
17461 *left
= *right
= 0;
17463 if (glyph
->type
== CHAR_GLYPH
)
17467 struct font_info
*font_info
;
17471 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
17473 font_info
= FONT_INFO_FROM_ID (f
, face
->font_info_id
);
17474 if (font
/* ++KFS: Should this be font_info ? */
17475 && (pcm
= rif
->per_char_metric (font
, &char2b
, glyph
->font_type
)))
17477 if (pcm
->rbearing
> pcm
->width
)
17478 *right
= pcm
->rbearing
- pcm
->width
;
17479 if (pcm
->lbearing
< 0)
17480 *left
= -pcm
->lbearing
;
17486 /* Return the index of the first glyph preceding glyph string S that
17487 is overwritten by S because of S's left overhang. Value is -1
17488 if no glyphs are overwritten. */
17491 left_overwritten (s
)
17492 struct glyph_string
*s
;
17496 if (s
->left_overhang
)
17499 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
17500 int first
= s
->first_glyph
- glyphs
;
17502 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
17503 x
-= glyphs
[i
].pixel_width
;
17514 /* Return the index of the first glyph preceding glyph string S that
17515 is overwriting S because of its right overhang. Value is -1 if no
17516 glyph in front of S overwrites S. */
17519 left_overwriting (s
)
17520 struct glyph_string
*s
;
17523 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
17524 int first
= s
->first_glyph
- glyphs
;
17528 for (i
= first
- 1; i
>= 0; --i
)
17531 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
17534 x
-= glyphs
[i
].pixel_width
;
17541 /* Return the index of the last glyph following glyph string S that is
17542 not overwritten by S because of S's right overhang. Value is -1 if
17543 no such glyph is found. */
17546 right_overwritten (s
)
17547 struct glyph_string
*s
;
17551 if (s
->right_overhang
)
17554 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
17555 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
17556 int end
= s
->row
->used
[s
->area
];
17558 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
17559 x
+= glyphs
[i
].pixel_width
;
17568 /* Return the index of the last glyph following glyph string S that
17569 overwrites S because of its left overhang. Value is negative
17570 if no such glyph is found. */
17573 right_overwriting (s
)
17574 struct glyph_string
*s
;
17577 int end
= s
->row
->used
[s
->area
];
17578 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
17579 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
17583 for (i
= first
; i
< end
; ++i
)
17586 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
17589 x
+= glyphs
[i
].pixel_width
;
17596 /* Get face and two-byte form of character C in face FACE_ID on frame
17597 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
17598 means we want to display multibyte text. DISPLAY_P non-zero means
17599 make sure that X resources for the face returned are allocated.
17600 Value is a pointer to a realized face that is ready for display if
17601 DISPLAY_P is non-zero. */
17603 static INLINE
struct face
*
17604 get_char_face_and_encoding (f
, c
, face_id
, char2b
, multibyte_p
, display_p
)
17608 int multibyte_p
, display_p
;
17610 struct face
*face
= FACE_FROM_ID (f
, face_id
);
17614 /* Unibyte case. We don't have to encode, but we have to make
17615 sure to use a face suitable for unibyte. */
17616 STORE_XCHAR2B (char2b
, 0, c
);
17617 face_id
= FACE_FOR_CHAR (f
, face
, c
);
17618 face
= FACE_FROM_ID (f
, face_id
);
17620 else if (c
< 128 && face_id
< BASIC_FACE_ID_SENTINEL
)
17622 /* Case of ASCII in a face known to fit ASCII. */
17623 STORE_XCHAR2B (char2b
, 0, c
);
17627 int c1
, c2
, charset
;
17629 /* Split characters into bytes. If c2 is -1 afterwards, C is
17630 really a one-byte character so that byte1 is zero. */
17631 SPLIT_CHAR (c
, charset
, c1
, c2
);
17633 STORE_XCHAR2B (char2b
, c1
, c2
);
17635 STORE_XCHAR2B (char2b
, 0, c1
);
17637 /* Maybe encode the character in *CHAR2B. */
17638 if (face
->font
!= NULL
)
17640 struct font_info
*font_info
17641 = FONT_INFO_FROM_ID (f
, face
->font_info_id
);
17643 rif
->encode_char (c
, char2b
, font_info
, 0);
17647 /* Make sure X resources of the face are allocated. */
17648 #ifdef HAVE_X_WINDOWS
17652 xassert (face
!= NULL
);
17653 PREPARE_FACE_FOR_DISPLAY (f
, face
);
17660 /* Set background width of glyph string S. START is the index of the
17661 first glyph following S. LAST_X is the right-most x-position + 1
17662 in the drawing area. */
17665 set_glyph_string_background_width (s
, start
, last_x
)
17666 struct glyph_string
*s
;
17670 /* If the face of this glyph string has to be drawn to the end of
17671 the drawing area, set S->extends_to_end_of_line_p. */
17672 struct face
*default_face
= FACE_FROM_ID (s
->f
, DEFAULT_FACE_ID
);
17674 if (start
== s
->row
->used
[s
->area
]
17675 && s
->area
== TEXT_AREA
17676 && ((s
->hl
== DRAW_NORMAL_TEXT
17677 && (s
->row
->fill_line_p
17678 || s
->face
->background
!= default_face
->background
17679 || s
->face
->stipple
!= default_face
->stipple
17680 || s
->row
->mouse_face_p
))
17681 || s
->hl
== DRAW_MOUSE_FACE
17682 || ((s
->hl
== DRAW_IMAGE_RAISED
|| s
->hl
== DRAW_IMAGE_SUNKEN
)
17683 && s
->row
->fill_line_p
)))
17684 s
->extends_to_end_of_line_p
= 1;
17686 /* If S extends its face to the end of the line, set its
17687 background_width to the distance to the right edge of the drawing
17689 if (s
->extends_to_end_of_line_p
)
17690 s
->background_width
= last_x
- s
->x
+ 1;
17692 s
->background_width
= s
->width
;
17696 /* Compute overhangs and x-positions for glyph string S and its
17697 predecessors, or successors. X is the starting x-position for S.
17698 BACKWARD_P non-zero means process predecessors. */
17701 compute_overhangs_and_x (s
, x
, backward_p
)
17702 struct glyph_string
*s
;
17710 if (rif
->compute_glyph_string_overhangs
)
17711 rif
->compute_glyph_string_overhangs (s
);
17721 if (rif
->compute_glyph_string_overhangs
)
17722 rif
->compute_glyph_string_overhangs (s
);
17732 /* The following macros are only called from draw_glyphs below.
17733 They reference the following parameters of that function directly:
17734 `w', `row', `area', and `overlap_p'
17735 as well as the following local variables:
17736 `s', `f', and `hdc' (in W32) */
17739 /* On W32, silently add local `hdc' variable to argument list of
17740 init_glyph_string. */
17741 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
17742 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
17744 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
17745 init_glyph_string (s, char2b, w, row, area, start, hl)
17748 /* Add a glyph string for a stretch glyph to the list of strings
17749 between HEAD and TAIL. START is the index of the stretch glyph in
17750 row area AREA of glyph row ROW. END is the index of the last glyph
17751 in that glyph row area. X is the current output position assigned
17752 to the new glyph string constructed. HL overrides that face of the
17753 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
17754 is the right-most x-position of the drawing area. */
17756 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
17757 and below -- keep them on one line. */
17758 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
17761 s = (struct glyph_string *) alloca (sizeof *s); \
17762 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
17763 START = fill_stretch_glyph_string (s, row, area, START, END); \
17764 append_glyph_string (&HEAD, &TAIL, s); \
17770 /* Add a glyph string for an image glyph to the list of strings
17771 between HEAD and TAIL. START is the index of the image glyph in
17772 row area AREA of glyph row ROW. END is the index of the last glyph
17773 in that glyph row area. X is the current output position assigned
17774 to the new glyph string constructed. HL overrides that face of the
17775 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
17776 is the right-most x-position of the drawing area. */
17778 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
17781 s = (struct glyph_string *) alloca (sizeof *s); \
17782 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
17783 fill_image_glyph_string (s); \
17784 append_glyph_string (&HEAD, &TAIL, s); \
17791 /* Add a glyph string for a sequence of character glyphs to the list
17792 of strings between HEAD and TAIL. START is the index of the first
17793 glyph in row area AREA of glyph row ROW that is part of the new
17794 glyph string. END is the index of the last glyph in that glyph row
17795 area. X is the current output position assigned to the new glyph
17796 string constructed. HL overrides that face of the glyph; e.g. it
17797 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
17798 right-most x-position of the drawing area. */
17800 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
17806 c = (row)->glyphs[area][START].u.ch; \
17807 face_id = (row)->glyphs[area][START].face_id; \
17809 s = (struct glyph_string *) alloca (sizeof *s); \
17810 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
17811 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
17812 append_glyph_string (&HEAD, &TAIL, s); \
17814 START = fill_glyph_string (s, face_id, START, END, overlaps_p); \
17819 /* Add a glyph string for a composite sequence to the list of strings
17820 between HEAD and TAIL. START is the index of the first glyph in
17821 row area AREA of glyph row ROW that is part of the new glyph
17822 string. END is the index of the last glyph in that glyph row area.
17823 X is the current output position assigned to the new glyph string
17824 constructed. HL overrides that face of the glyph; e.g. it is
17825 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
17826 x-position of the drawing area. */
17828 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
17830 int cmp_id = (row)->glyphs[area][START].u.cmp_id; \
17831 int face_id = (row)->glyphs[area][START].face_id; \
17832 struct face *base_face = FACE_FROM_ID (f, face_id); \
17833 struct composition *cmp = composition_table[cmp_id]; \
17834 int glyph_len = cmp->glyph_len; \
17836 struct face **faces; \
17837 struct glyph_string *first_s = NULL; \
17840 base_face = base_face->ascii_face; \
17841 char2b = (XChar2b *) alloca ((sizeof *char2b) * glyph_len); \
17842 faces = (struct face **) alloca ((sizeof *faces) * glyph_len); \
17843 /* At first, fill in `char2b' and `faces'. */ \
17844 for (n = 0; n < glyph_len; n++) \
17846 int c = COMPOSITION_GLYPH (cmp, n); \
17847 int this_face_id = FACE_FOR_CHAR (f, base_face, c); \
17848 faces[n] = FACE_FROM_ID (f, this_face_id); \
17849 get_char_face_and_encoding (f, c, this_face_id, \
17850 char2b + n, 1, 1); \
17853 /* Make glyph_strings for each glyph sequence that is drawable by \
17854 the same face, and append them to HEAD/TAIL. */ \
17855 for (n = 0; n < cmp->glyph_len;) \
17857 s = (struct glyph_string *) alloca (sizeof *s); \
17858 INIT_GLYPH_STRING (s, char2b + n, w, row, area, START, HL); \
17859 append_glyph_string (&(HEAD), &(TAIL), s); \
17867 n = fill_composite_glyph_string (s, faces, overlaps_p); \
17875 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
17876 of AREA of glyph row ROW on window W between indices START and END.
17877 HL overrides the face for drawing glyph strings, e.g. it is
17878 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
17879 x-positions of the drawing area.
17881 This is an ugly monster macro construct because we must use alloca
17882 to allocate glyph strings (because draw_glyphs can be called
17883 asynchronously). */
17885 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
17888 HEAD = TAIL = NULL; \
17889 while (START < END) \
17891 struct glyph *first_glyph = (row)->glyphs[area] + START; \
17892 switch (first_glyph->type) \
17895 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
17899 case COMPOSITE_GLYPH: \
17900 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
17904 case STRETCH_GLYPH: \
17905 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
17909 case IMAGE_GLYPH: \
17910 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
17918 set_glyph_string_background_width (s, START, LAST_X); \
17925 /* Draw glyphs between START and END in AREA of ROW on window W,
17926 starting at x-position X. X is relative to AREA in W. HL is a
17927 face-override with the following meaning:
17929 DRAW_NORMAL_TEXT draw normally
17930 DRAW_CURSOR draw in cursor face
17931 DRAW_MOUSE_FACE draw in mouse face.
17932 DRAW_INVERSE_VIDEO draw in mode line face
17933 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
17934 DRAW_IMAGE_RAISED draw an image with a raised relief around it
17936 If OVERLAPS_P is non-zero, draw only the foreground of characters
17937 and clip to the physical height of ROW.
17939 Value is the x-position reached, relative to AREA of W. */
17942 draw_glyphs (w
, x
, row
, area
, start
, end
, hl
, overlaps_p
)
17945 struct glyph_row
*row
;
17946 enum glyph_row_area area
;
17948 enum draw_glyphs_face hl
;
17951 struct glyph_string
*head
, *tail
;
17952 struct glyph_string
*s
;
17953 int last_x
, area_width
;
17956 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17959 ALLOCATE_HDC (hdc
, f
);
17961 /* Let's rather be paranoid than getting a SEGV. */
17962 end
= min (end
, row
->used
[area
]);
17963 start
= max (0, start
);
17964 start
= min (end
, start
);
17966 /* Translate X to frame coordinates. Set last_x to the right
17967 end of the drawing area. */
17968 if (row
->full_width_p
)
17970 /* X is relative to the left edge of W, without scroll bars
17972 x
+= WINDOW_LEFT_EDGE_X (w
);
17973 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
17977 int area_left
= window_box_left (w
, area
);
17979 area_width
= window_box_width (w
, area
);
17980 last_x
= area_left
+ area_width
;
17983 /* Build a doubly-linked list of glyph_string structures between
17984 head and tail from what we have to draw. Note that the macro
17985 BUILD_GLYPH_STRINGS will modify its start parameter. That's
17986 the reason we use a separate variable `i'. */
17988 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
17990 x_reached
= tail
->x
+ tail
->background_width
;
17994 /* If there are any glyphs with lbearing < 0 or rbearing > width in
17995 the row, redraw some glyphs in front or following the glyph
17996 strings built above. */
17997 if (head
&& !overlaps_p
&& row
->contains_overlapping_glyphs_p
)
18000 struct glyph_string
*h
, *t
;
18002 /* Compute overhangs for all glyph strings. */
18003 if (rif
->compute_glyph_string_overhangs
)
18004 for (s
= head
; s
; s
= s
->next
)
18005 rif
->compute_glyph_string_overhangs (s
);
18007 /* Prepend glyph strings for glyphs in front of the first glyph
18008 string that are overwritten because of the first glyph
18009 string's left overhang. The background of all strings
18010 prepended must be drawn because the first glyph string
18012 i
= left_overwritten (head
);
18016 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
18017 DRAW_NORMAL_TEXT
, dummy_x
, last_x
);
18019 compute_overhangs_and_x (t
, head
->x
, 1);
18020 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
18023 /* Prepend glyph strings for glyphs in front of the first glyph
18024 string that overwrite that glyph string because of their
18025 right overhang. For these strings, only the foreground must
18026 be drawn, because it draws over the glyph string at `head'.
18027 The background must not be drawn because this would overwrite
18028 right overhangs of preceding glyphs for which no glyph
18030 i
= left_overwriting (head
);
18033 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
18034 DRAW_NORMAL_TEXT
, dummy_x
, last_x
);
18035 for (s
= h
; s
; s
= s
->next
)
18036 s
->background_filled_p
= 1;
18037 compute_overhangs_and_x (t
, head
->x
, 1);
18038 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
18041 /* Append glyphs strings for glyphs following the last glyph
18042 string tail that are overwritten by tail. The background of
18043 these strings has to be drawn because tail's foreground draws
18045 i
= right_overwritten (tail
);
18048 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
18049 DRAW_NORMAL_TEXT
, x
, last_x
);
18050 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
18051 append_glyph_string_lists (&head
, &tail
, h
, t
);
18054 /* Append glyph strings for glyphs following the last glyph
18055 string tail that overwrite tail. The foreground of such
18056 glyphs has to be drawn because it writes into the background
18057 of tail. The background must not be drawn because it could
18058 paint over the foreground of following glyphs. */
18059 i
= right_overwriting (tail
);
18062 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
18063 DRAW_NORMAL_TEXT
, x
, last_x
);
18064 for (s
= h
; s
; s
= s
->next
)
18065 s
->background_filled_p
= 1;
18066 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
18067 append_glyph_string_lists (&head
, &tail
, h
, t
);
18071 /* Draw all strings. */
18072 for (s
= head
; s
; s
= s
->next
)
18073 rif
->draw_glyph_string (s
);
18075 if (area
== TEXT_AREA
18076 && !row
->full_width_p
18077 /* When drawing overlapping rows, only the glyph strings'
18078 foreground is drawn, which doesn't erase a cursor
18082 int x0
= head
? head
->x
: x
;
18083 int x1
= tail
? tail
->x
+ tail
->background_width
: x
;
18085 int text_left
= window_box_left (w
, TEXT_AREA
);
18089 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
18090 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
18093 /* Value is the x-position up to which drawn, relative to AREA of W.
18094 This doesn't include parts drawn because of overhangs. */
18095 if (row
->full_width_p
)
18096 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
18098 x_reached
-= window_box_left (w
, area
);
18100 RELEASE_HDC (hdc
, f
);
18106 /* Store one glyph for IT->char_to_display in IT->glyph_row.
18107 Called from x_produce_glyphs when IT->glyph_row is non-null. */
18113 struct glyph
*glyph
;
18114 enum glyph_row_area area
= it
->area
;
18116 xassert (it
->glyph_row
);
18117 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
18119 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
18120 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
18122 glyph
->charpos
= CHARPOS (it
->position
);
18123 glyph
->object
= it
->object
;
18124 glyph
->pixel_width
= it
->pixel_width
;
18125 glyph
->ascent
= it
->ascent
;
18126 glyph
->descent
= it
->descent
;
18127 glyph
->voffset
= it
->voffset
;
18128 glyph
->type
= CHAR_GLYPH
;
18129 glyph
->multibyte_p
= it
->multibyte_p
;
18130 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
18131 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
18132 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
18133 || it
->phys_descent
> it
->descent
);
18134 glyph
->padding_p
= 0;
18135 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
18136 glyph
->face_id
= it
->face_id
;
18137 glyph
->u
.ch
= it
->char_to_display
;
18138 glyph
->slice
= null_glyph_slice
;
18139 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
18140 ++it
->glyph_row
->used
[area
];
18142 else if (!fonts_changed_p
)
18144 it
->w
->ncols_scale_factor
++;
18145 fonts_changed_p
= 1;
18149 /* Store one glyph for the composition IT->cmp_id in IT->glyph_row.
18150 Called from x_produce_glyphs when IT->glyph_row is non-null. */
18153 append_composite_glyph (it
)
18156 struct glyph
*glyph
;
18157 enum glyph_row_area area
= it
->area
;
18159 xassert (it
->glyph_row
);
18161 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
18162 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
18164 glyph
->charpos
= CHARPOS (it
->position
);
18165 glyph
->object
= it
->object
;
18166 glyph
->pixel_width
= it
->pixel_width
;
18167 glyph
->ascent
= it
->ascent
;
18168 glyph
->descent
= it
->descent
;
18169 glyph
->voffset
= it
->voffset
;
18170 glyph
->type
= COMPOSITE_GLYPH
;
18171 glyph
->multibyte_p
= it
->multibyte_p
;
18172 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
18173 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
18174 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
18175 || it
->phys_descent
> it
->descent
);
18176 glyph
->padding_p
= 0;
18177 glyph
->glyph_not_available_p
= 0;
18178 glyph
->face_id
= it
->face_id
;
18179 glyph
->u
.cmp_id
= it
->cmp_id
;
18180 glyph
->slice
= null_glyph_slice
;
18181 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
18182 ++it
->glyph_row
->used
[area
];
18184 else if (!fonts_changed_p
)
18186 it
->w
->ncols_scale_factor
++;
18187 fonts_changed_p
= 1;
18192 /* Change IT->ascent and IT->height according to the setting of
18196 take_vertical_position_into_account (it
)
18201 if (it
->voffset
< 0)
18202 /* Increase the ascent so that we can display the text higher
18204 it
->ascent
-= it
->voffset
;
18206 /* Increase the descent so that we can display the text lower
18208 it
->descent
+= it
->voffset
;
18213 /* Produce glyphs/get display metrics for the image IT is loaded with.
18214 See the description of struct display_iterator in dispextern.h for
18215 an overview of struct display_iterator. */
18218 produce_image_glyph (it
)
18223 int face_ascent
, glyph_ascent
;
18224 struct glyph_slice slice
;
18226 xassert (it
->what
== IT_IMAGE
);
18228 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18230 /* Make sure X resources of the face is loaded. */
18231 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
18233 if (it
->image_id
< 0)
18235 /* Fringe bitmap. */
18236 it
->ascent
= it
->phys_ascent
= 0;
18237 it
->descent
= it
->phys_descent
= 0;
18238 it
->pixel_width
= 0;
18243 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
18245 /* Make sure X resources of the image is loaded. */
18246 prepare_image_for_display (it
->f
, img
);
18248 slice
.x
= slice
.y
= 0;
18249 slice
.width
= img
->width
;
18250 slice
.height
= img
->height
;
18252 if (INTEGERP (it
->slice
.x
))
18253 slice
.x
= XINT (it
->slice
.x
);
18254 else if (FLOATP (it
->slice
.x
))
18255 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
18257 if (INTEGERP (it
->slice
.y
))
18258 slice
.y
= XINT (it
->slice
.y
);
18259 else if (FLOATP (it
->slice
.y
))
18260 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
18262 if (INTEGERP (it
->slice
.width
))
18263 slice
.width
= XINT (it
->slice
.width
);
18264 else if (FLOATP (it
->slice
.width
))
18265 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
18267 if (INTEGERP (it
->slice
.height
))
18268 slice
.height
= XINT (it
->slice
.height
);
18269 else if (FLOATP (it
->slice
.height
))
18270 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
18272 if (slice
.x
>= img
->width
)
18273 slice
.x
= img
->width
;
18274 if (slice
.y
>= img
->height
)
18275 slice
.y
= img
->height
;
18276 if (slice
.x
+ slice
.width
>= img
->width
)
18277 slice
.width
= img
->width
- slice
.x
;
18278 if (slice
.y
+ slice
.height
> img
->height
)
18279 slice
.height
= img
->height
- slice
.y
;
18281 if (slice
.width
== 0 || slice
.height
== 0)
18284 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
18286 it
->descent
= slice
.height
- glyph_ascent
;
18288 it
->descent
+= img
->vmargin
;
18289 if (slice
.y
+ slice
.height
== img
->height
)
18290 it
->descent
+= img
->vmargin
;
18291 it
->phys_descent
= it
->descent
;
18293 it
->pixel_width
= slice
.width
;
18295 it
->pixel_width
+= img
->hmargin
;
18296 if (slice
.x
+ slice
.width
== img
->width
)
18297 it
->pixel_width
+= img
->hmargin
;
18299 /* It's quite possible for images to have an ascent greater than
18300 their height, so don't get confused in that case. */
18301 if (it
->descent
< 0)
18304 #if 0 /* this breaks image tiling */
18305 /* If this glyph is alone on the last line, adjust it.ascent to minimum row ascent. */
18306 face_ascent
= face
->font
? FONT_BASE (face
->font
) : FRAME_BASELINE_OFFSET (it
->f
);
18307 if (face_ascent
> it
->ascent
)
18308 it
->ascent
= it
->phys_ascent
= face_ascent
;
18313 if (face
->box
!= FACE_NO_BOX
)
18315 if (face
->box_line_width
> 0)
18318 it
->ascent
+= face
->box_line_width
;
18319 if (slice
.y
+ slice
.height
== img
->height
)
18320 it
->descent
+= face
->box_line_width
;
18323 if (it
->start_of_box_run_p
&& slice
.x
== 0)
18324 it
->pixel_width
+= abs (face
->box_line_width
);
18325 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
18326 it
->pixel_width
+= abs (face
->box_line_width
);
18329 take_vertical_position_into_account (it
);
18333 struct glyph
*glyph
;
18334 enum glyph_row_area area
= it
->area
;
18336 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
18337 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
18339 glyph
->charpos
= CHARPOS (it
->position
);
18340 glyph
->object
= it
->object
;
18341 glyph
->pixel_width
= it
->pixel_width
;
18342 glyph
->ascent
= glyph_ascent
;
18343 glyph
->descent
= it
->descent
;
18344 glyph
->voffset
= it
->voffset
;
18345 glyph
->type
= IMAGE_GLYPH
;
18346 glyph
->multibyte_p
= it
->multibyte_p
;
18347 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
18348 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
18349 glyph
->overlaps_vertically_p
= 0;
18350 glyph
->padding_p
= 0;
18351 glyph
->glyph_not_available_p
= 0;
18352 glyph
->face_id
= it
->face_id
;
18353 glyph
->u
.img_id
= img
->id
;
18354 glyph
->slice
= slice
;
18355 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
18356 ++it
->glyph_row
->used
[area
];
18358 else if (!fonts_changed_p
)
18360 it
->w
->ncols_scale_factor
++;
18361 fonts_changed_p
= 1;
18367 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
18368 of the glyph, WIDTH and HEIGHT are the width and height of the
18369 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
18372 append_stretch_glyph (it
, object
, width
, height
, ascent
)
18374 Lisp_Object object
;
18378 struct glyph
*glyph
;
18379 enum glyph_row_area area
= it
->area
;
18381 xassert (ascent
>= 0 && ascent
<= height
);
18383 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
18384 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
18386 glyph
->charpos
= CHARPOS (it
->position
);
18387 glyph
->object
= object
;
18388 glyph
->pixel_width
= width
;
18389 glyph
->ascent
= ascent
;
18390 glyph
->descent
= height
- ascent
;
18391 glyph
->voffset
= it
->voffset
;
18392 glyph
->type
= STRETCH_GLYPH
;
18393 glyph
->multibyte_p
= it
->multibyte_p
;
18394 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
18395 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
18396 glyph
->overlaps_vertically_p
= 0;
18397 glyph
->padding_p
= 0;
18398 glyph
->glyph_not_available_p
= 0;
18399 glyph
->face_id
= it
->face_id
;
18400 glyph
->u
.stretch
.ascent
= ascent
;
18401 glyph
->u
.stretch
.height
= height
;
18402 glyph
->slice
= null_glyph_slice
;
18403 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
18404 ++it
->glyph_row
->used
[area
];
18406 else if (!fonts_changed_p
)
18408 it
->w
->ncols_scale_factor
++;
18409 fonts_changed_p
= 1;
18414 /* Produce a stretch glyph for iterator IT. IT->object is the value
18415 of the glyph property displayed. The value must be a list
18416 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
18419 1. `:width WIDTH' specifies that the space should be WIDTH *
18420 canonical char width wide. WIDTH may be an integer or floating
18423 2. `:relative-width FACTOR' specifies that the width of the stretch
18424 should be computed from the width of the first character having the
18425 `glyph' property, and should be FACTOR times that width.
18427 3. `:align-to HPOS' specifies that the space should be wide enough
18428 to reach HPOS, a value in canonical character units.
18430 Exactly one of the above pairs must be present.
18432 4. `:height HEIGHT' specifies that the height of the stretch produced
18433 should be HEIGHT, measured in canonical character units.
18435 5. `:relative-height FACTOR' specifies that the height of the
18436 stretch should be FACTOR times the height of the characters having
18437 the glyph property.
18439 Either none or exactly one of 4 or 5 must be present.
18441 6. `:ascent ASCENT' specifies that ASCENT percent of the height
18442 of the stretch should be used for the ascent of the stretch.
18443 ASCENT must be in the range 0 <= ASCENT <= 100. */
18446 produce_stretch_glyph (it
)
18449 /* (space :width WIDTH :height HEIGHT ...) */
18450 Lisp_Object prop
, plist
;
18451 int width
= 0, height
= 0, align_to
= -1;
18452 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
18455 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18456 XFontStruct
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
18458 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
18460 /* List should start with `space'. */
18461 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
18462 plist
= XCDR (it
->object
);
18464 /* Compute the width of the stretch. */
18465 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
18466 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
18468 /* Absolute width `:width WIDTH' specified and valid. */
18469 zero_width_ok_p
= 1;
18472 else if (prop
= Fplist_get (plist
, QCrelative_width
),
18475 /* Relative width `:relative-width FACTOR' specified and valid.
18476 Compute the width of the characters having the `glyph'
18479 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
18482 if (it
->multibyte_p
)
18484 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
18485 - IT_BYTEPOS (*it
));
18486 it2
.c
= STRING_CHAR_AND_LENGTH (p
, maxlen
, it2
.len
);
18489 it2
.c
= *p
, it2
.len
= 1;
18491 it2
.glyph_row
= NULL
;
18492 it2
.what
= IT_CHARACTER
;
18493 x_produce_glyphs (&it2
);
18494 width
= NUMVAL (prop
) * it2
.pixel_width
;
18496 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
18497 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
18499 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
18500 align_to
= (align_to
< 0
18502 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
18503 else if (align_to
< 0)
18504 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
18505 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
18506 zero_width_ok_p
= 1;
18509 /* Nothing specified -> width defaults to canonical char width. */
18510 width
= FRAME_COLUMN_WIDTH (it
->f
);
18512 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
18515 /* Compute height. */
18516 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
18517 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
18520 zero_height_ok_p
= 1;
18522 else if (prop
= Fplist_get (plist
, QCrelative_height
),
18524 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
18526 height
= FONT_HEIGHT (font
);
18528 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
18531 /* Compute percentage of height used for ascent. If
18532 `:ascent ASCENT' is present and valid, use that. Otherwise,
18533 derive the ascent from the font in use. */
18534 if (prop
= Fplist_get (plist
, QCascent
),
18535 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
18536 ascent
= height
* NUMVAL (prop
) / 100.0;
18537 else if (!NILP (prop
)
18538 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
18539 ascent
= min (max (0, (int)tem
), height
);
18541 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
18543 if (width
> 0 && height
> 0 && it
->glyph_row
)
18545 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
18546 if (!STRINGP (object
))
18547 object
= it
->w
->buffer
;
18548 append_stretch_glyph (it
, object
, width
, height
, ascent
);
18551 it
->pixel_width
= width
;
18552 it
->ascent
= it
->phys_ascent
= ascent
;
18553 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
18554 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
18556 if (width
> 0 && height
> 0 && face
->box
!= FACE_NO_BOX
)
18558 if (face
->box_line_width
> 0)
18560 it
->ascent
+= face
->box_line_width
;
18561 it
->descent
+= face
->box_line_width
;
18564 if (it
->start_of_box_run_p
)
18565 it
->pixel_width
+= abs (face
->box_line_width
);
18566 if (it
->end_of_box_run_p
)
18567 it
->pixel_width
+= abs (face
->box_line_width
);
18570 take_vertical_position_into_account (it
);
18573 /* Calculate line-height and line-spacing properties.
18574 An integer value specifies explicit pixel value.
18575 A float value specifies relative value to current face height.
18576 A cons (float . face-name) specifies relative value to
18577 height of specified face font.
18579 Returns height in pixels, or nil. */
18582 calc_line_height_property (it
, prop
, font
, boff
, total
)
18588 Lisp_Object position
, val
;
18589 Lisp_Object face_name
= Qnil
;
18590 int ascent
, descent
, height
, override
;
18592 if (STRINGP (it
->object
))
18593 position
= make_number (IT_STRING_CHARPOS (*it
));
18595 position
= make_number (IT_CHARPOS (*it
));
18597 val
= Fget_char_property (position
, prop
, it
->object
);
18602 if (total
&& CONSP (val
) && EQ (XCAR (val
), Qtotal
))
18608 if (INTEGERP (val
))
18613 face_name
= XCDR (val
);
18616 else if (SYMBOLP (val
))
18622 override
= EQ (prop
, Qline_height
);
18624 if (NILP (face_name
))
18626 font
= FRAME_FONT (it
->f
);
18627 boff
= FRAME_BASELINE_OFFSET (it
->f
);
18629 else if (EQ (face_name
, Qt
))
18637 struct font_info
*font_info
;
18639 face_id
= lookup_named_face (it
->f
, face_name
, ' ');
18641 return make_number (-1);
18643 face
= FACE_FROM_ID (it
->f
, face_id
);
18646 return make_number (-1);
18648 font_info
= FONT_INFO_FROM_ID (it
->f
, face
->font_info_id
);
18649 boff
= font_info
->baseline_offset
;
18650 if (font_info
->vertical_centering
)
18651 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
18654 ascent
= FONT_BASE (font
) + boff
;
18655 descent
= FONT_DESCENT (font
) - boff
;
18659 it
->override_ascent
= ascent
;
18660 it
->override_descent
= descent
;
18661 it
->override_boff
= boff
;
18664 height
= ascent
+ descent
;
18666 height
= (int)(XFLOAT_DATA (val
) * height
);
18667 else if (INTEGERP (val
))
18668 height
*= XINT (val
);
18670 return make_number (height
);
18675 Produce glyphs/get display metrics for the display element IT is
18676 loaded with. See the description of struct display_iterator in
18677 dispextern.h for an overview of struct display_iterator. */
18680 x_produce_glyphs (it
)
18683 int extra_line_spacing
= it
->extra_line_spacing
;
18685 it
->glyph_not_available_p
= 0;
18687 if (it
->what
== IT_CHARACTER
)
18691 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18693 int font_not_found_p
;
18694 struct font_info
*font_info
;
18695 int boff
; /* baseline offset */
18696 /* We may change it->multibyte_p upon unibyte<->multibyte
18697 conversion. So, save the current value now and restore it
18700 Note: It seems that we don't have to record multibyte_p in
18701 struct glyph because the character code itself tells if or
18702 not the character is multibyte. Thus, in the future, we must
18703 consider eliminating the field `multibyte_p' in the struct
18705 int saved_multibyte_p
= it
->multibyte_p
;
18707 /* Maybe translate single-byte characters to multibyte, or the
18709 it
->char_to_display
= it
->c
;
18710 if (!ASCII_BYTE_P (it
->c
))
18712 if (unibyte_display_via_language_environment
18713 && SINGLE_BYTE_CHAR_P (it
->c
)
18715 || !NILP (Vnonascii_translation_table
)))
18717 it
->char_to_display
= unibyte_char_to_multibyte (it
->c
);
18718 it
->multibyte_p
= 1;
18719 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
);
18720 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18722 else if (!SINGLE_BYTE_CHAR_P (it
->c
)
18723 && !it
->multibyte_p
)
18725 it
->multibyte_p
= 1;
18726 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
);
18727 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18731 /* Get font to use. Encode IT->char_to_display. */
18732 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
18733 &char2b
, it
->multibyte_p
, 0);
18736 /* When no suitable font found, use the default font. */
18737 font_not_found_p
= font
== NULL
;
18738 if (font_not_found_p
)
18740 font
= FRAME_FONT (it
->f
);
18741 boff
= FRAME_BASELINE_OFFSET (it
->f
);
18746 font_info
= FONT_INFO_FROM_ID (it
->f
, face
->font_info_id
);
18747 boff
= font_info
->baseline_offset
;
18748 if (font_info
->vertical_centering
)
18749 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
18752 if (it
->char_to_display
>= ' '
18753 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
18755 /* Either unibyte or ASCII. */
18760 pcm
= rif
->per_char_metric (font
, &char2b
,
18761 FONT_TYPE_FOR_UNIBYTE (font
, it
->char_to_display
));
18763 if (it
->override_ascent
>= 0)
18765 it
->ascent
= it
->override_ascent
;
18766 it
->descent
= it
->override_descent
;
18767 boff
= it
->override_boff
;
18771 it
->ascent
= FONT_BASE (font
) + boff
;
18772 it
->descent
= FONT_DESCENT (font
) - boff
;
18777 it
->phys_ascent
= pcm
->ascent
+ boff
;
18778 it
->phys_descent
= pcm
->descent
- boff
;
18779 it
->pixel_width
= pcm
->width
;
18783 it
->glyph_not_available_p
= 1;
18784 it
->phys_ascent
= it
->ascent
;
18785 it
->phys_descent
= it
->descent
;
18786 it
->pixel_width
= FONT_WIDTH (font
);
18789 if (it
->constrain_row_ascent_descent_p
)
18791 if (it
->descent
> it
->max_descent
)
18793 it
->ascent
+= it
->descent
- it
->max_descent
;
18794 it
->descent
= it
->max_descent
;
18796 if (it
->ascent
> it
->max_ascent
)
18798 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
18799 it
->ascent
= it
->max_ascent
;
18801 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
18802 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
18803 extra_line_spacing
= 0;
18806 /* If this is a space inside a region of text with
18807 `space-width' property, change its width. */
18808 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
18810 it
->pixel_width
*= XFLOATINT (it
->space_width
);
18812 /* If face has a box, add the box thickness to the character
18813 height. If character has a box line to the left and/or
18814 right, add the box line width to the character's width. */
18815 if (face
->box
!= FACE_NO_BOX
)
18817 int thick
= face
->box_line_width
;
18821 it
->ascent
+= thick
;
18822 it
->descent
+= thick
;
18827 if (it
->start_of_box_run_p
)
18828 it
->pixel_width
+= thick
;
18829 if (it
->end_of_box_run_p
)
18830 it
->pixel_width
+= thick
;
18833 /* If face has an overline, add the height of the overline
18834 (1 pixel) and a 1 pixel margin to the character height. */
18835 if (face
->overline_p
)
18838 if (it
->constrain_row_ascent_descent_p
)
18840 if (it
->ascent
> it
->max_ascent
)
18841 it
->ascent
= it
->max_ascent
;
18842 if (it
->descent
> it
->max_descent
)
18843 it
->descent
= it
->max_descent
;
18846 take_vertical_position_into_account (it
);
18848 /* If we have to actually produce glyphs, do it. */
18853 /* Translate a space with a `space-width' property
18854 into a stretch glyph. */
18855 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
18856 / FONT_HEIGHT (font
));
18857 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
18858 it
->ascent
+ it
->descent
, ascent
);
18863 /* If characters with lbearing or rbearing are displayed
18864 in this line, record that fact in a flag of the
18865 glyph row. This is used to optimize X output code. */
18866 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
18867 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
18870 else if (it
->char_to_display
== '\n')
18872 /* A newline has no width but we need the height of the line.
18873 But if previous part of the line set a height, don't
18874 increase that height */
18876 Lisp_Object height
;
18878 it
->override_ascent
= -1;
18879 it
->pixel_width
= 0;
18882 height
= calc_line_height_property(it
, Qline_height
, font
, boff
, 0);
18884 if (it
->override_ascent
>= 0)
18886 it
->ascent
= it
->override_ascent
;
18887 it
->descent
= it
->override_descent
;
18888 boff
= it
->override_boff
;
18892 it
->ascent
= FONT_BASE (font
) + boff
;
18893 it
->descent
= FONT_DESCENT (font
) - boff
;
18896 if (EQ (height
, make_number(0)))
18898 if (it
->descent
> it
->max_descent
)
18900 it
->ascent
+= it
->descent
- it
->max_descent
;
18901 it
->descent
= it
->max_descent
;
18903 if (it
->ascent
> it
->max_ascent
)
18905 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
18906 it
->ascent
= it
->max_ascent
;
18908 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
18909 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
18910 it
->constrain_row_ascent_descent_p
= 1;
18911 extra_line_spacing
= 0;
18915 Lisp_Object spacing
;
18918 it
->phys_ascent
= it
->ascent
;
18919 it
->phys_descent
= it
->descent
;
18921 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
18922 && face
->box
!= FACE_NO_BOX
18923 && face
->box_line_width
> 0)
18925 it
->ascent
+= face
->box_line_width
;
18926 it
->descent
+= face
->box_line_width
;
18929 && XINT (height
) > it
->ascent
+ it
->descent
)
18930 it
->ascent
= XINT (height
) - it
->descent
;
18932 spacing
= calc_line_height_property(it
, Qline_spacing
, font
, boff
, &total
);
18933 if (INTEGERP (spacing
))
18935 extra_line_spacing
= XINT (spacing
);
18937 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
18941 else if (it
->char_to_display
== '\t')
18943 int tab_width
= it
->tab_width
* FRAME_COLUMN_WIDTH (it
->f
);
18944 int x
= it
->current_x
+ it
->continuation_lines_width
;
18945 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
18947 /* If the distance from the current position to the next tab
18948 stop is less than a canonical character width, use the
18949 tab stop after that. */
18950 if (next_tab_x
- x
< FRAME_COLUMN_WIDTH (it
->f
))
18951 next_tab_x
+= tab_width
;
18953 it
->pixel_width
= next_tab_x
- x
;
18955 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
18956 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
18960 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
18961 it
->ascent
+ it
->descent
, it
->ascent
);
18966 /* A multi-byte character. Assume that the display width of the
18967 character is the width of the character multiplied by the
18968 width of the font. */
18970 /* If we found a font, this font should give us the right
18971 metrics. If we didn't find a font, use the frame's
18972 default font and calculate the width of the character
18973 from the charset width; this is what old redisplay code
18976 pcm
= rif
->per_char_metric (font
, &char2b
,
18977 FONT_TYPE_FOR_MULTIBYTE (font
, it
->c
));
18979 if (font_not_found_p
|| !pcm
)
18981 int charset
= CHAR_CHARSET (it
->char_to_display
);
18983 it
->glyph_not_available_p
= 1;
18984 it
->pixel_width
= (FRAME_COLUMN_WIDTH (it
->f
)
18985 * CHARSET_WIDTH (charset
));
18986 it
->phys_ascent
= FONT_BASE (font
) + boff
;
18987 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
18991 it
->pixel_width
= pcm
->width
;
18992 it
->phys_ascent
= pcm
->ascent
+ boff
;
18993 it
->phys_descent
= pcm
->descent
- boff
;
18995 && (pcm
->lbearing
< 0
18996 || pcm
->rbearing
> pcm
->width
))
18997 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
19000 it
->ascent
= FONT_BASE (font
) + boff
;
19001 it
->descent
= FONT_DESCENT (font
) - boff
;
19002 if (face
->box
!= FACE_NO_BOX
)
19004 int thick
= face
->box_line_width
;
19008 it
->ascent
+= thick
;
19009 it
->descent
+= thick
;
19014 if (it
->start_of_box_run_p
)
19015 it
->pixel_width
+= thick
;
19016 if (it
->end_of_box_run_p
)
19017 it
->pixel_width
+= thick
;
19020 /* If face has an overline, add the height of the overline
19021 (1 pixel) and a 1 pixel margin to the character height. */
19022 if (face
->overline_p
)
19025 take_vertical_position_into_account (it
);
19030 it
->multibyte_p
= saved_multibyte_p
;
19032 else if (it
->what
== IT_COMPOSITION
)
19034 /* Note: A composition is represented as one glyph in the
19035 glyph matrix. There are no padding glyphs. */
19038 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19040 int font_not_found_p
;
19041 struct font_info
*font_info
;
19042 int boff
; /* baseline offset */
19043 struct composition
*cmp
= composition_table
[it
->cmp_id
];
19045 /* Maybe translate single-byte characters to multibyte. */
19046 it
->char_to_display
= it
->c
;
19047 if (unibyte_display_via_language_environment
19048 && SINGLE_BYTE_CHAR_P (it
->c
)
19051 && !NILP (Vnonascii_translation_table
))))
19053 it
->char_to_display
= unibyte_char_to_multibyte (it
->c
);
19056 /* Get face and font to use. Encode IT->char_to_display. */
19057 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
);
19058 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19059 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
19060 &char2b
, it
->multibyte_p
, 0);
19063 /* When no suitable font found, use the default font. */
19064 font_not_found_p
= font
== NULL
;
19065 if (font_not_found_p
)
19067 font
= FRAME_FONT (it
->f
);
19068 boff
= FRAME_BASELINE_OFFSET (it
->f
);
19073 font_info
= FONT_INFO_FROM_ID (it
->f
, face
->font_info_id
);
19074 boff
= font_info
->baseline_offset
;
19075 if (font_info
->vertical_centering
)
19076 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
19079 /* There are no padding glyphs, so there is only one glyph to
19080 produce for the composition. Important is that pixel_width,
19081 ascent and descent are the values of what is drawn by
19082 draw_glyphs (i.e. the values of the overall glyphs composed). */
19085 /* If we have not yet calculated pixel size data of glyphs of
19086 the composition for the current face font, calculate them
19087 now. Theoretically, we have to check all fonts for the
19088 glyphs, but that requires much time and memory space. So,
19089 here we check only the font of the first glyph. This leads
19090 to incorrect display very rarely, and C-l (recenter) can
19091 correct the display anyway. */
19092 if (cmp
->font
!= (void *) font
)
19094 /* Ascent and descent of the font of the first character of
19095 this composition (adjusted by baseline offset). Ascent
19096 and descent of overall glyphs should not be less than
19097 them respectively. */
19098 int font_ascent
= FONT_BASE (font
) + boff
;
19099 int font_descent
= FONT_DESCENT (font
) - boff
;
19100 /* Bounding box of the overall glyphs. */
19101 int leftmost
, rightmost
, lowest
, highest
;
19102 int i
, width
, ascent
, descent
;
19104 cmp
->font
= (void *) font
;
19106 /* Initialize the bounding box. */
19108 && (pcm
= rif
->per_char_metric (font
, &char2b
,
19109 FONT_TYPE_FOR_MULTIBYTE (font
, it
->c
))))
19111 width
= pcm
->width
;
19112 ascent
= pcm
->ascent
;
19113 descent
= pcm
->descent
;
19117 width
= FONT_WIDTH (font
);
19118 ascent
= FONT_BASE (font
);
19119 descent
= FONT_DESCENT (font
);
19123 lowest
= - descent
+ boff
;
19124 highest
= ascent
+ boff
;
19128 && font_info
->default_ascent
19129 && CHAR_TABLE_P (Vuse_default_ascent
)
19130 && !NILP (Faref (Vuse_default_ascent
,
19131 make_number (it
->char_to_display
))))
19132 highest
= font_info
->default_ascent
+ boff
;
19134 /* Draw the first glyph at the normal position. It may be
19135 shifted to right later if some other glyphs are drawn at
19137 cmp
->offsets
[0] = 0;
19138 cmp
->offsets
[1] = boff
;
19140 /* Set cmp->offsets for the remaining glyphs. */
19141 for (i
= 1; i
< cmp
->glyph_len
; i
++)
19143 int left
, right
, btm
, top
;
19144 int ch
= COMPOSITION_GLYPH (cmp
, i
);
19145 int face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
);
19147 face
= FACE_FROM_ID (it
->f
, face_id
);
19148 get_char_face_and_encoding (it
->f
, ch
, face
->id
,
19149 &char2b
, it
->multibyte_p
, 0);
19153 font
= FRAME_FONT (it
->f
);
19154 boff
= FRAME_BASELINE_OFFSET (it
->f
);
19160 = FONT_INFO_FROM_ID (it
->f
, face
->font_info_id
);
19161 boff
= font_info
->baseline_offset
;
19162 if (font_info
->vertical_centering
)
19163 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
19167 && (pcm
= rif
->per_char_metric (font
, &char2b
,
19168 FONT_TYPE_FOR_MULTIBYTE (font
, ch
))))
19170 width
= pcm
->width
;
19171 ascent
= pcm
->ascent
;
19172 descent
= pcm
->descent
;
19176 width
= FONT_WIDTH (font
);
19181 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
19183 /* Relative composition with or without
19184 alternate chars. */
19185 left
= (leftmost
+ rightmost
- width
) / 2;
19186 btm
= - descent
+ boff
;
19187 if (font_info
&& font_info
->relative_compose
19188 && (! CHAR_TABLE_P (Vignore_relative_composition
)
19189 || NILP (Faref (Vignore_relative_composition
,
19190 make_number (ch
)))))
19193 if (- descent
>= font_info
->relative_compose
)
19194 /* One extra pixel between two glyphs. */
19196 else if (ascent
<= 0)
19197 /* One extra pixel between two glyphs. */
19198 btm
= lowest
- 1 - ascent
- descent
;
19203 /* A composition rule is specified by an integer
19204 value that encodes global and new reference
19205 points (GREF and NREF). GREF and NREF are
19206 specified by numbers as below:
19208 0---1---2 -- ascent
19212 9--10--11 -- center
19214 ---3---4---5--- baseline
19216 6---7---8 -- descent
19218 int rule
= COMPOSITION_RULE (cmp
, i
);
19219 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
;
19221 COMPOSITION_DECODE_RULE (rule
, gref
, nref
);
19222 grefx
= gref
% 3, nrefx
= nref
% 3;
19223 grefy
= gref
/ 3, nrefy
= nref
/ 3;
19226 + grefx
* (rightmost
- leftmost
) / 2
19227 - nrefx
* width
/ 2);
19228 btm
= ((grefy
== 0 ? highest
19230 : grefy
== 2 ? lowest
19231 : (highest
+ lowest
) / 2)
19232 - (nrefy
== 0 ? ascent
+ descent
19233 : nrefy
== 1 ? descent
- boff
19235 : (ascent
+ descent
) / 2));
19238 cmp
->offsets
[i
* 2] = left
;
19239 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
19241 /* Update the bounding box of the overall glyphs. */
19242 right
= left
+ width
;
19243 top
= btm
+ descent
+ ascent
;
19244 if (left
< leftmost
)
19246 if (right
> rightmost
)
19254 /* If there are glyphs whose x-offsets are negative,
19255 shift all glyphs to the right and make all x-offsets
19259 for (i
= 0; i
< cmp
->glyph_len
; i
++)
19260 cmp
->offsets
[i
* 2] -= leftmost
;
19261 rightmost
-= leftmost
;
19264 cmp
->pixel_width
= rightmost
;
19265 cmp
->ascent
= highest
;
19266 cmp
->descent
= - lowest
;
19267 if (cmp
->ascent
< font_ascent
)
19268 cmp
->ascent
= font_ascent
;
19269 if (cmp
->descent
< font_descent
)
19270 cmp
->descent
= font_descent
;
19273 it
->pixel_width
= cmp
->pixel_width
;
19274 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
19275 it
->descent
= it
->phys_descent
= cmp
->descent
;
19277 if (face
->box
!= FACE_NO_BOX
)
19279 int thick
= face
->box_line_width
;
19283 it
->ascent
+= thick
;
19284 it
->descent
+= thick
;
19289 if (it
->start_of_box_run_p
)
19290 it
->pixel_width
+= thick
;
19291 if (it
->end_of_box_run_p
)
19292 it
->pixel_width
+= thick
;
19295 /* If face has an overline, add the height of the overline
19296 (1 pixel) and a 1 pixel margin to the character height. */
19297 if (face
->overline_p
)
19300 take_vertical_position_into_account (it
);
19303 append_composite_glyph (it
);
19305 else if (it
->what
== IT_IMAGE
)
19306 produce_image_glyph (it
);
19307 else if (it
->what
== IT_STRETCH
)
19308 produce_stretch_glyph (it
);
19310 /* Accumulate dimensions. Note: can't assume that it->descent > 0
19311 because this isn't true for images with `:ascent 100'. */
19312 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
19313 if (it
->area
== TEXT_AREA
)
19314 it
->current_x
+= it
->pixel_width
;
19316 if (extra_line_spacing
> 0)
19317 it
->descent
+= extra_line_spacing
;
19319 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
19320 it
->max_descent
= max (it
->max_descent
, it
->descent
);
19321 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
19322 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
19326 Output LEN glyphs starting at START at the nominal cursor position.
19327 Advance the nominal cursor over the text. The global variable
19328 updated_window contains the window being updated, updated_row is
19329 the glyph row being updated, and updated_area is the area of that
19330 row being updated. */
19333 x_write_glyphs (start
, len
)
19334 struct glyph
*start
;
19339 xassert (updated_window
&& updated_row
);
19342 /* Write glyphs. */
19344 hpos
= start
- updated_row
->glyphs
[updated_area
];
19345 x
= draw_glyphs (updated_window
, output_cursor
.x
,
19346 updated_row
, updated_area
,
19348 DRAW_NORMAL_TEXT
, 0);
19350 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
19351 if (updated_area
== TEXT_AREA
19352 && updated_window
->phys_cursor_on_p
19353 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
19354 && updated_window
->phys_cursor
.hpos
>= hpos
19355 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
19356 updated_window
->phys_cursor_on_p
= 0;
19360 /* Advance the output cursor. */
19361 output_cursor
.hpos
+= len
;
19362 output_cursor
.x
= x
;
19367 Insert LEN glyphs from START at the nominal cursor position. */
19370 x_insert_glyphs (start
, len
)
19371 struct glyph
*start
;
19376 int line_height
, shift_by_width
, shifted_region_width
;
19377 struct glyph_row
*row
;
19378 struct glyph
*glyph
;
19379 int frame_x
, frame_y
, hpos
;
19381 xassert (updated_window
&& updated_row
);
19383 w
= updated_window
;
19384 f
= XFRAME (WINDOW_FRAME (w
));
19386 /* Get the height of the line we are in. */
19388 line_height
= row
->height
;
19390 /* Get the width of the glyphs to insert. */
19391 shift_by_width
= 0;
19392 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
19393 shift_by_width
+= glyph
->pixel_width
;
19395 /* Get the width of the region to shift right. */
19396 shifted_region_width
= (window_box_width (w
, updated_area
)
19401 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
19402 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
19404 rif
->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
19405 line_height
, shift_by_width
);
19407 /* Write the glyphs. */
19408 hpos
= start
- row
->glyphs
[updated_area
];
19409 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
19411 DRAW_NORMAL_TEXT
, 0);
19413 /* Advance the output cursor. */
19414 output_cursor
.hpos
+= len
;
19415 output_cursor
.x
+= shift_by_width
;
19421 Erase the current text line from the nominal cursor position
19422 (inclusive) to pixel column TO_X (exclusive). The idea is that
19423 everything from TO_X onward is already erased.
19425 TO_X is a pixel position relative to updated_area of
19426 updated_window. TO_X == -1 means clear to the end of this area. */
19429 x_clear_end_of_line (to_x
)
19433 struct window
*w
= updated_window
;
19434 int max_x
, min_y
, max_y
;
19435 int from_x
, from_y
, to_y
;
19437 xassert (updated_window
&& updated_row
);
19438 f
= XFRAME (w
->frame
);
19440 if (updated_row
->full_width_p
)
19441 max_x
= WINDOW_TOTAL_WIDTH (w
);
19443 max_x
= window_box_width (w
, updated_area
);
19444 max_y
= window_text_bottom_y (w
);
19446 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
19447 of window. For TO_X > 0, truncate to end of drawing area. */
19453 to_x
= min (to_x
, max_x
);
19455 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
19457 /* Notice if the cursor will be cleared by this operation. */
19458 if (!updated_row
->full_width_p
)
19459 notice_overwritten_cursor (w
, updated_area
,
19460 output_cursor
.x
, -1,
19462 MATRIX_ROW_BOTTOM_Y (updated_row
));
19464 from_x
= output_cursor
.x
;
19466 /* Translate to frame coordinates. */
19467 if (updated_row
->full_width_p
)
19469 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
19470 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
19474 int area_left
= window_box_left (w
, updated_area
);
19475 from_x
+= area_left
;
19479 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
19480 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
19481 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
19483 /* Prevent inadvertently clearing to end of the X window. */
19484 if (to_x
> from_x
&& to_y
> from_y
)
19487 rif
->clear_frame_area (f
, from_x
, from_y
,
19488 to_x
- from_x
, to_y
- from_y
);
19493 #endif /* HAVE_WINDOW_SYSTEM */
19497 /***********************************************************************
19499 ***********************************************************************/
19501 /* Value is the internal representation of the specified cursor type
19502 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
19503 of the bar cursor. */
19505 static enum text_cursor_kinds
19506 get_specified_cursor_type (arg
, width
)
19510 enum text_cursor_kinds type
;
19515 if (EQ (arg
, Qbox
))
19516 return FILLED_BOX_CURSOR
;
19518 if (EQ (arg
, Qhollow
))
19519 return HOLLOW_BOX_CURSOR
;
19521 if (EQ (arg
, Qbar
))
19528 && EQ (XCAR (arg
), Qbar
)
19529 && INTEGERP (XCDR (arg
))
19530 && XINT (XCDR (arg
)) >= 0)
19532 *width
= XINT (XCDR (arg
));
19536 if (EQ (arg
, Qhbar
))
19539 return HBAR_CURSOR
;
19543 && EQ (XCAR (arg
), Qhbar
)
19544 && INTEGERP (XCDR (arg
))
19545 && XINT (XCDR (arg
)) >= 0)
19547 *width
= XINT (XCDR (arg
));
19548 return HBAR_CURSOR
;
19551 /* Treat anything unknown as "hollow box cursor".
19552 It was bad to signal an error; people have trouble fixing
19553 .Xdefaults with Emacs, when it has something bad in it. */
19554 type
= HOLLOW_BOX_CURSOR
;
19559 /* Set the default cursor types for specified frame. */
19561 set_frame_cursor_types (f
, arg
)
19568 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
19569 FRAME_CURSOR_WIDTH (f
) = width
;
19571 /* By default, set up the blink-off state depending on the on-state. */
19573 tem
= Fassoc (arg
, Vblink_cursor_alist
);
19576 FRAME_BLINK_OFF_CURSOR (f
)
19577 = get_specified_cursor_type (XCDR (tem
), &width
);
19578 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
19581 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
19585 /* Return the cursor we want to be displayed in window W. Return
19586 width of bar/hbar cursor through WIDTH arg. Return with
19587 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
19588 (i.e. if the `system caret' should track this cursor).
19590 In a mini-buffer window, we want the cursor only to appear if we
19591 are reading input from this window. For the selected window, we
19592 want the cursor type given by the frame parameter or buffer local
19593 setting of cursor-type. If explicitly marked off, draw no cursor.
19594 In all other cases, we want a hollow box cursor. */
19596 static enum text_cursor_kinds
19597 get_window_cursor_type (w
, glyph
, width
, active_cursor
)
19599 struct glyph
*glyph
;
19601 int *active_cursor
;
19603 struct frame
*f
= XFRAME (w
->frame
);
19604 struct buffer
*b
= XBUFFER (w
->buffer
);
19605 int cursor_type
= DEFAULT_CURSOR
;
19606 Lisp_Object alt_cursor
;
19607 int non_selected
= 0;
19609 *active_cursor
= 1;
19612 if (cursor_in_echo_area
19613 && FRAME_HAS_MINIBUF_P (f
)
19614 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
19616 if (w
== XWINDOW (echo_area_window
))
19618 *width
= FRAME_CURSOR_WIDTH (f
);
19619 return FRAME_DESIRED_CURSOR (f
);
19622 *active_cursor
= 0;
19626 /* Nonselected window or nonselected frame. */
19627 else if (w
!= XWINDOW (f
->selected_window
)
19628 #ifdef HAVE_WINDOW_SYSTEM
19629 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
19633 *active_cursor
= 0;
19635 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
19641 /* Never display a cursor in a window in which cursor-type is nil. */
19642 if (NILP (b
->cursor_type
))
19645 /* Use cursor-in-non-selected-windows for non-selected window or frame. */
19648 alt_cursor
= Fbuffer_local_value (Qcursor_in_non_selected_windows
, w
->buffer
);
19649 return get_specified_cursor_type (alt_cursor
, width
);
19652 /* Get the normal cursor type for this window. */
19653 if (EQ (b
->cursor_type
, Qt
))
19655 cursor_type
= FRAME_DESIRED_CURSOR (f
);
19656 *width
= FRAME_CURSOR_WIDTH (f
);
19659 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
19661 /* Use normal cursor if not blinked off. */
19662 if (!w
->cursor_off_p
)
19664 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
) {
19665 if (cursor_type
== FILLED_BOX_CURSOR
)
19666 cursor_type
= HOLLOW_BOX_CURSOR
;
19668 return cursor_type
;
19671 /* Cursor is blinked off, so determine how to "toggle" it. */
19673 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
19674 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
19675 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
19677 /* Then see if frame has specified a specific blink off cursor type. */
19678 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
19680 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
19681 return FRAME_BLINK_OFF_CURSOR (f
);
19685 /* Some people liked having a permanently visible blinking cursor,
19686 while others had very strong opinions against it. So it was
19687 decided to remove it. KFS 2003-09-03 */
19689 /* Finally perform built-in cursor blinking:
19690 filled box <-> hollow box
19691 wide [h]bar <-> narrow [h]bar
19692 narrow [h]bar <-> no cursor
19693 other type <-> no cursor */
19695 if (cursor_type
== FILLED_BOX_CURSOR
)
19696 return HOLLOW_BOX_CURSOR
;
19698 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
19701 return cursor_type
;
19709 #ifdef HAVE_WINDOW_SYSTEM
19711 /* Notice when the text cursor of window W has been completely
19712 overwritten by a drawing operation that outputs glyphs in AREA
19713 starting at X0 and ending at X1 in the line starting at Y0 and
19714 ending at Y1. X coordinates are area-relative. X1 < 0 means all
19715 the rest of the line after X0 has been written. Y coordinates
19716 are window-relative. */
19719 notice_overwritten_cursor (w
, area
, x0
, x1
, y0
, y1
)
19721 enum glyph_row_area area
;
19722 int x0
, y0
, x1
, y1
;
19724 int cx0
, cx1
, cy0
, cy1
;
19725 struct glyph_row
*row
;
19727 if (!w
->phys_cursor_on_p
)
19729 if (area
!= TEXT_AREA
)
19732 row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
;
19733 if (!row
->displays_text_p
)
19736 if (row
->cursor_in_fringe_p
)
19738 row
->cursor_in_fringe_p
= 0;
19739 draw_fringe_bitmap (w
, row
, 0);
19740 w
->phys_cursor_on_p
= 0;
19744 cx0
= w
->phys_cursor
.x
;
19745 cx1
= cx0
+ w
->phys_cursor_width
;
19746 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
19749 /* The cursor image will be completely removed from the
19750 screen if the output area intersects the cursor area in
19751 y-direction. When we draw in [y0 y1[, and some part of
19752 the cursor is at y < y0, that part must have been drawn
19753 before. When scrolling, the cursor is erased before
19754 actually scrolling, so we don't come here. When not
19755 scrolling, the rows above the old cursor row must have
19756 changed, and in this case these rows must have written
19757 over the cursor image.
19759 Likewise if part of the cursor is below y1, with the
19760 exception of the cursor being in the first blank row at
19761 the buffer and window end because update_text_area
19762 doesn't draw that row. (Except when it does, but
19763 that's handled in update_text_area.) */
19765 cy0
= w
->phys_cursor
.y
;
19766 cy1
= cy0
+ w
->phys_cursor_height
;
19767 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
19770 w
->phys_cursor_on_p
= 0;
19773 #endif /* HAVE_WINDOW_SYSTEM */
19776 /************************************************************************
19778 ************************************************************************/
19780 #ifdef HAVE_WINDOW_SYSTEM
19783 Fix the display of area AREA of overlapping row ROW in window W. */
19786 x_fix_overlapping_area (w
, row
, area
)
19788 struct glyph_row
*row
;
19789 enum glyph_row_area area
;
19796 for (i
= 0; i
< row
->used
[area
];)
19798 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
19800 int start
= i
, start_x
= x
;
19804 x
+= row
->glyphs
[area
][i
].pixel_width
;
19807 while (i
< row
->used
[area
]
19808 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
19810 draw_glyphs (w
, start_x
, row
, area
,
19812 DRAW_NORMAL_TEXT
, 1);
19816 x
+= row
->glyphs
[area
][i
].pixel_width
;
19826 Draw the cursor glyph of window W in glyph row ROW. See the
19827 comment of draw_glyphs for the meaning of HL. */
19830 draw_phys_cursor_glyph (w
, row
, hl
)
19832 struct glyph_row
*row
;
19833 enum draw_glyphs_face hl
;
19835 /* If cursor hpos is out of bounds, don't draw garbage. This can
19836 happen in mini-buffer windows when switching between echo area
19837 glyphs and mini-buffer. */
19838 if (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])
19840 int on_p
= w
->phys_cursor_on_p
;
19842 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
19843 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
19845 w
->phys_cursor_on_p
= on_p
;
19847 if (hl
== DRAW_CURSOR
)
19848 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
19849 /* When we erase the cursor, and ROW is overlapped by other
19850 rows, make sure that these overlapping parts of other rows
19852 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
19854 if (row
> w
->current_matrix
->rows
19855 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
19856 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
);
19858 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
19859 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
19860 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
);
19867 Erase the image of a cursor of window W from the screen. */
19870 erase_phys_cursor (w
)
19873 struct frame
*f
= XFRAME (w
->frame
);
19874 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
19875 int hpos
= w
->phys_cursor
.hpos
;
19876 int vpos
= w
->phys_cursor
.vpos
;
19877 int mouse_face_here_p
= 0;
19878 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
19879 struct glyph_row
*cursor_row
;
19880 struct glyph
*cursor_glyph
;
19881 enum draw_glyphs_face hl
;
19883 /* No cursor displayed or row invalidated => nothing to do on the
19885 if (w
->phys_cursor_type
== NO_CURSOR
)
19886 goto mark_cursor_off
;
19888 /* VPOS >= active_glyphs->nrows means that window has been resized.
19889 Don't bother to erase the cursor. */
19890 if (vpos
>= active_glyphs
->nrows
)
19891 goto mark_cursor_off
;
19893 /* If row containing cursor is marked invalid, there is nothing we
19895 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
19896 if (!cursor_row
->enabled_p
)
19897 goto mark_cursor_off
;
19899 /* If row is completely invisible, don't attempt to delete a cursor which
19900 isn't there. This can happen if cursor is at top of a window, and
19901 we switch to a buffer with a header line in that window. */
19902 if (cursor_row
->visible_height
<= 0)
19903 goto mark_cursor_off
;
19905 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
19906 if (cursor_row
->cursor_in_fringe_p
)
19908 cursor_row
->cursor_in_fringe_p
= 0;
19909 draw_fringe_bitmap (w
, cursor_row
, 0);
19910 goto mark_cursor_off
;
19913 /* This can happen when the new row is shorter than the old one.
19914 In this case, either draw_glyphs or clear_end_of_line
19915 should have cleared the cursor. Note that we wouldn't be
19916 able to erase the cursor in this case because we don't have a
19917 cursor glyph at hand. */
19918 if (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])
19919 goto mark_cursor_off
;
19921 /* If the cursor is in the mouse face area, redisplay that when
19922 we clear the cursor. */
19923 if (! NILP (dpyinfo
->mouse_face_window
)
19924 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
19925 && (vpos
> dpyinfo
->mouse_face_beg_row
19926 || (vpos
== dpyinfo
->mouse_face_beg_row
19927 && hpos
>= dpyinfo
->mouse_face_beg_col
))
19928 && (vpos
< dpyinfo
->mouse_face_end_row
19929 || (vpos
== dpyinfo
->mouse_face_end_row
19930 && hpos
< dpyinfo
->mouse_face_end_col
))
19931 /* Don't redraw the cursor's spot in mouse face if it is at the
19932 end of a line (on a newline). The cursor appears there, but
19933 mouse highlighting does not. */
19934 && cursor_row
->used
[TEXT_AREA
] > hpos
)
19935 mouse_face_here_p
= 1;
19937 /* Maybe clear the display under the cursor. */
19938 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
19941 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
19943 cursor_glyph
= get_phys_cursor_glyph (w
);
19944 if (cursor_glyph
== NULL
)
19945 goto mark_cursor_off
;
19947 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, w
->phys_cursor
.x
);
19948 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
19950 rif
->clear_frame_area (f
, x
, y
,
19951 cursor_glyph
->pixel_width
, cursor_row
->visible_height
);
19954 /* Erase the cursor by redrawing the character underneath it. */
19955 if (mouse_face_here_p
)
19956 hl
= DRAW_MOUSE_FACE
;
19958 hl
= DRAW_NORMAL_TEXT
;
19959 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
19962 w
->phys_cursor_on_p
= 0;
19963 w
->phys_cursor_type
= NO_CURSOR
;
19968 Display or clear cursor of window W. If ON is zero, clear the
19969 cursor. If it is non-zero, display the cursor. If ON is nonzero,
19970 where to put the cursor is specified by HPOS, VPOS, X and Y. */
19973 display_and_set_cursor (w
, on
, hpos
, vpos
, x
, y
)
19975 int on
, hpos
, vpos
, x
, y
;
19977 struct frame
*f
= XFRAME (w
->frame
);
19978 int new_cursor_type
;
19979 int new_cursor_width
;
19981 struct glyph_row
*glyph_row
;
19982 struct glyph
*glyph
;
19984 /* This is pointless on invisible frames, and dangerous on garbaged
19985 windows and frames; in the latter case, the frame or window may
19986 be in the midst of changing its size, and x and y may be off the
19988 if (! FRAME_VISIBLE_P (f
)
19989 || FRAME_GARBAGED_P (f
)
19990 || vpos
>= w
->current_matrix
->nrows
19991 || hpos
>= w
->current_matrix
->matrix_w
)
19994 /* If cursor is off and we want it off, return quickly. */
19995 if (!on
&& !w
->phys_cursor_on_p
)
19998 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
19999 /* If cursor row is not enabled, we don't really know where to
20000 display the cursor. */
20001 if (!glyph_row
->enabled_p
)
20003 w
->phys_cursor_on_p
= 0;
20008 if (!glyph_row
->exact_window_width_line_p
20009 || hpos
< glyph_row
->used
[TEXT_AREA
])
20010 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
20012 xassert (interrupt_input_blocked
);
20014 /* Set new_cursor_type to the cursor we want to be displayed. */
20015 new_cursor_type
= get_window_cursor_type (w
, glyph
,
20016 &new_cursor_width
, &active_cursor
);
20018 /* If cursor is currently being shown and we don't want it to be or
20019 it is in the wrong place, or the cursor type is not what we want,
20021 if (w
->phys_cursor_on_p
20023 || w
->phys_cursor
.x
!= x
20024 || w
->phys_cursor
.y
!= y
20025 || new_cursor_type
!= w
->phys_cursor_type
20026 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
20027 && new_cursor_width
!= w
->phys_cursor_width
)))
20028 erase_phys_cursor (w
);
20030 /* Don't check phys_cursor_on_p here because that flag is only set
20031 to zero in some cases where we know that the cursor has been
20032 completely erased, to avoid the extra work of erasing the cursor
20033 twice. In other words, phys_cursor_on_p can be 1 and the cursor
20034 still not be visible, or it has only been partly erased. */
20037 w
->phys_cursor_ascent
= glyph_row
->ascent
;
20038 w
->phys_cursor_height
= glyph_row
->height
;
20040 /* Set phys_cursor_.* before x_draw_.* is called because some
20041 of them may need the information. */
20042 w
->phys_cursor
.x
= x
;
20043 w
->phys_cursor
.y
= glyph_row
->y
;
20044 w
->phys_cursor
.hpos
= hpos
;
20045 w
->phys_cursor
.vpos
= vpos
;
20048 rif
->draw_window_cursor (w
, glyph_row
, x
, y
,
20049 new_cursor_type
, new_cursor_width
,
20050 on
, active_cursor
);
20054 /* Switch the display of W's cursor on or off, according to the value
20058 update_window_cursor (w
, on
)
20062 /* Don't update cursor in windows whose frame is in the process
20063 of being deleted. */
20064 if (w
->current_matrix
)
20067 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
20068 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
20074 /* Call update_window_cursor with parameter ON_P on all leaf windows
20075 in the window tree rooted at W. */
20078 update_cursor_in_window_tree (w
, on_p
)
20084 if (!NILP (w
->hchild
))
20085 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
20086 else if (!NILP (w
->vchild
))
20087 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
20089 update_window_cursor (w
, on_p
);
20091 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
20097 Display the cursor on window W, or clear it, according to ON_P.
20098 Don't change the cursor's position. */
20101 x_update_cursor (f
, on_p
)
20105 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
20110 Clear the cursor of window W to background color, and mark the
20111 cursor as not shown. This is used when the text where the cursor
20112 is is about to be rewritten. */
20118 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
20119 update_window_cursor (w
, 0);
20124 Display the active region described by mouse_face_* according to DRAW. */
20127 show_mouse_face (dpyinfo
, draw
)
20128 Display_Info
*dpyinfo
;
20129 enum draw_glyphs_face draw
;
20131 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
20132 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20134 if (/* If window is in the process of being destroyed, don't bother
20136 w
->current_matrix
!= NULL
20137 /* Don't update mouse highlight if hidden */
20138 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
20139 /* Recognize when we are called to operate on rows that don't exist
20140 anymore. This can happen when a window is split. */
20141 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
20143 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
20144 struct glyph_row
*row
, *first
, *last
;
20146 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
20147 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
20149 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
20151 int start_hpos
, end_hpos
, start_x
;
20153 /* For all but the first row, the highlight starts at column 0. */
20156 start_hpos
= dpyinfo
->mouse_face_beg_col
;
20157 start_x
= dpyinfo
->mouse_face_beg_x
;
20166 end_hpos
= dpyinfo
->mouse_face_end_col
;
20168 end_hpos
= row
->used
[TEXT_AREA
];
20170 if (end_hpos
> start_hpos
)
20172 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
20173 start_hpos
, end_hpos
,
20177 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
20181 /* When we've written over the cursor, arrange for it to
20182 be displayed again. */
20183 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
20186 display_and_set_cursor (w
, 1,
20187 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
20188 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
20193 /* Change the mouse cursor. */
20194 if (draw
== DRAW_NORMAL_TEXT
)
20195 rif
->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
20196 else if (draw
== DRAW_MOUSE_FACE
)
20197 rif
->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
20199 rif
->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
20203 Clear out the mouse-highlighted active region.
20204 Redraw it un-highlighted first. Value is non-zero if mouse
20205 face was actually drawn unhighlighted. */
20208 clear_mouse_face (dpyinfo
)
20209 Display_Info
*dpyinfo
;
20213 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
20215 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
20219 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
20220 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
20221 dpyinfo
->mouse_face_window
= Qnil
;
20222 dpyinfo
->mouse_face_overlay
= Qnil
;
20228 Non-zero if physical cursor of window W is within mouse face. */
20231 cursor_in_mouse_face_p (w
)
20234 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
20235 int in_mouse_face
= 0;
20237 if (WINDOWP (dpyinfo
->mouse_face_window
)
20238 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
20240 int hpos
= w
->phys_cursor
.hpos
;
20241 int vpos
= w
->phys_cursor
.vpos
;
20243 if (vpos
>= dpyinfo
->mouse_face_beg_row
20244 && vpos
<= dpyinfo
->mouse_face_end_row
20245 && (vpos
> dpyinfo
->mouse_face_beg_row
20246 || hpos
>= dpyinfo
->mouse_face_beg_col
)
20247 && (vpos
< dpyinfo
->mouse_face_end_row
20248 || hpos
< dpyinfo
->mouse_face_end_col
20249 || dpyinfo
->mouse_face_past_end
))
20253 return in_mouse_face
;
20259 /* Find the glyph matrix position of buffer position CHARPOS in window
20260 *W. HPOS, *VPOS, *X, and *Y are set to the positions found. W's
20261 current glyphs must be up to date. If CHARPOS is above window
20262 start return (0, 0, 0, 0). If CHARPOS is after end of W, return end
20263 of last line in W. In the row containing CHARPOS, stop before glyphs
20264 having STOP as object. */
20266 #if 1 /* This is a version of fast_find_position that's more correct
20267 in the presence of hscrolling, for example. I didn't install
20268 it right away because the problem fixed is minor, it failed
20269 in 20.x as well, and I think it's too risky to install
20270 so near the release of 21.1. 2001-09-25 gerd. */
20273 fast_find_position (w
, charpos
, hpos
, vpos
, x
, y
, stop
)
20276 int *hpos
, *vpos
, *x
, *y
;
20279 struct glyph_row
*row
, *first
;
20280 struct glyph
*glyph
, *end
;
20283 first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
20284 row
= row_containing_pos (w
, charpos
, first
, NULL
, 0);
20287 if (charpos
< MATRIX_ROW_START_CHARPOS (first
))
20289 *x
= *y
= *hpos
= *vpos
= 0;
20294 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
20301 *vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
20303 glyph
= row
->glyphs
[TEXT_AREA
];
20304 end
= glyph
+ row
->used
[TEXT_AREA
];
20306 /* Skip over glyphs not having an object at the start of the row.
20307 These are special glyphs like truncation marks on terminal
20309 if (row
->displays_text_p
)
20311 && INTEGERP (glyph
->object
)
20312 && !EQ (stop
, glyph
->object
)
20313 && glyph
->charpos
< 0)
20315 *x
+= glyph
->pixel_width
;
20320 && !INTEGERP (glyph
->object
)
20321 && !EQ (stop
, glyph
->object
)
20322 && (!BUFFERP (glyph
->object
)
20323 || glyph
->charpos
< charpos
))
20325 *x
+= glyph
->pixel_width
;
20329 *hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
20336 fast_find_position (w
, pos
, hpos
, vpos
, x
, y
, stop
)
20339 int *hpos
, *vpos
, *x
, *y
;
20344 int maybe_next_line_p
= 0;
20345 int line_start_position
;
20346 int yb
= window_text_bottom_y (w
);
20347 struct glyph_row
*row
, *best_row
;
20348 int row_vpos
, best_row_vpos
;
20351 row
= best_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
20352 row_vpos
= best_row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
20354 while (row
->y
< yb
)
20356 if (row
->used
[TEXT_AREA
])
20357 line_start_position
= row
->glyphs
[TEXT_AREA
]->charpos
;
20359 line_start_position
= 0;
20361 if (line_start_position
> pos
)
20363 /* If the position sought is the end of the buffer,
20364 don't include the blank lines at the bottom of the window. */
20365 else if (line_start_position
== pos
20366 && pos
== BUF_ZV (XBUFFER (w
->buffer
)))
20368 maybe_next_line_p
= 1;
20371 else if (line_start_position
> 0)
20374 best_row_vpos
= row_vpos
;
20377 if (row
->y
+ row
->height
>= yb
)
20384 /* Find the right column within BEST_ROW. */
20386 current_x
= best_row
->x
;
20387 for (i
= 0; i
< best_row
->used
[TEXT_AREA
]; i
++)
20389 struct glyph
*glyph
= best_row
->glyphs
[TEXT_AREA
] + i
;
20390 int charpos
= glyph
->charpos
;
20392 if (BUFFERP (glyph
->object
))
20394 if (charpos
== pos
)
20397 *vpos
= best_row_vpos
;
20402 else if (charpos
> pos
)
20405 else if (EQ (glyph
->object
, stop
))
20410 current_x
+= glyph
->pixel_width
;
20413 /* If we're looking for the end of the buffer,
20414 and we didn't find it in the line we scanned,
20415 use the start of the following line. */
20416 if (maybe_next_line_p
)
20421 current_x
= best_row
->x
;
20424 *vpos
= best_row_vpos
;
20425 *hpos
= lastcol
+ 1;
20434 /* Find the position of the glyph for position POS in OBJECT in
20435 window W's current matrix, and return in *X, *Y the pixel
20436 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
20438 RIGHT_P non-zero means return the position of the right edge of the
20439 glyph, RIGHT_P zero means return the left edge position.
20441 If no glyph for POS exists in the matrix, return the position of
20442 the glyph with the next smaller position that is in the matrix, if
20443 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
20444 exists in the matrix, return the position of the glyph with the
20445 next larger position in OBJECT.
20447 Value is non-zero if a glyph was found. */
20450 fast_find_string_pos (w
, pos
, object
, hpos
, vpos
, x
, y
, right_p
)
20453 Lisp_Object object
;
20454 int *hpos
, *vpos
, *x
, *y
;
20457 int yb
= window_text_bottom_y (w
);
20458 struct glyph_row
*r
;
20459 struct glyph
*best_glyph
= NULL
;
20460 struct glyph_row
*best_row
= NULL
;
20463 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
20464 r
->enabled_p
&& r
->y
< yb
;
20467 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
20468 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
20471 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
20472 if (EQ (g
->object
, object
))
20474 if (g
->charpos
== pos
)
20481 else if (best_glyph
== NULL
20482 || ((abs (g
->charpos
- pos
)
20483 < abs (best_glyph
->charpos
- pos
))
20486 : g
->charpos
> pos
)))
20500 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
20504 *x
+= best_glyph
->pixel_width
;
20509 *vpos
= best_row
- w
->current_matrix
->rows
;
20512 return best_glyph
!= NULL
;
20516 /* See if position X, Y is within a hot-spot of an image. */
20519 on_hot_spot_p (hot_spot
, x
, y
)
20520 Lisp_Object hot_spot
;
20523 if (!CONSP (hot_spot
))
20526 if (EQ (XCAR (hot_spot
), Qrect
))
20528 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
20529 Lisp_Object rect
= XCDR (hot_spot
);
20533 if (!CONSP (XCAR (rect
)))
20535 if (!CONSP (XCDR (rect
)))
20537 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
20539 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
20541 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
20543 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
20547 else if (EQ (XCAR (hot_spot
), Qcircle
))
20549 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
20550 Lisp_Object circ
= XCDR (hot_spot
);
20551 Lisp_Object lr
, lx0
, ly0
;
20553 && CONSP (XCAR (circ
))
20554 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
20555 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
20556 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
20558 double r
= XFLOATINT (lr
);
20559 double dx
= XINT (lx0
) - x
;
20560 double dy
= XINT (ly0
) - y
;
20561 return (dx
* dx
+ dy
* dy
<= r
* r
);
20564 else if (EQ (XCAR (hot_spot
), Qpoly
))
20566 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
20567 if (VECTORP (XCDR (hot_spot
)))
20569 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
20570 Lisp_Object
*poly
= v
->contents
;
20574 Lisp_Object lx
, ly
;
20577 /* Need an even number of coordinates, and at least 3 edges. */
20578 if (n
< 6 || n
& 1)
20581 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
20582 If count is odd, we are inside polygon. Pixels on edges
20583 may or may not be included depending on actual geometry of the
20585 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
20586 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
20588 x0
= XINT (lx
), y0
= XINT (ly
);
20589 for (i
= 0; i
< n
; i
+= 2)
20591 int x1
= x0
, y1
= y0
;
20592 if ((lx
= poly
[i
], !INTEGERP (lx
))
20593 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
20595 x0
= XINT (lx
), y0
= XINT (ly
);
20597 /* Does this segment cross the X line? */
20605 if (y
> y0
&& y
> y1
)
20607 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
20613 /* If we don't understand the format, pretend we're not in the hot-spot. */
20618 find_hot_spot (map
, x
, y
)
20622 while (CONSP (map
))
20624 if (CONSP (XCAR (map
))
20625 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
20633 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
20635 doc
: /* Lookup in image map MAP coordinates X and Y.
20636 An image map is an alist where each element has the format (AREA ID PLIST).
20637 An AREA is specified as either a rectangle, a circle, or a polygon:
20638 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
20639 pixel coordinates of the upper left and bottom right corners.
20640 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
20641 and the radius of the circle; r may be a float or integer.
20642 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
20643 vector describes one corner in the polygon.
20644 Returns the alist element for the first matching AREA in MAP. */)
20655 return find_hot_spot (map
, XINT (x
), XINT (y
));
20659 /* Display frame CURSOR, optionally using shape defined by POINTER. */
20661 define_frame_cursor1 (f
, cursor
, pointer
)
20664 Lisp_Object pointer
;
20666 if (!NILP (pointer
))
20668 if (EQ (pointer
, Qarrow
))
20669 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
20670 else if (EQ (pointer
, Qhand
))
20671 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
20672 else if (EQ (pointer
, Qtext
))
20673 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
20674 else if (EQ (pointer
, intern ("hdrag")))
20675 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
20676 #ifdef HAVE_X_WINDOWS
20677 else if (EQ (pointer
, intern ("vdrag")))
20678 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
20680 else if (EQ (pointer
, intern ("hourglass")))
20681 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
20682 else if (EQ (pointer
, Qmodeline
))
20683 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
20685 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
20688 if (cursor
!= No_Cursor
)
20689 rif
->define_frame_cursor (f
, cursor
);
20692 /* Take proper action when mouse has moved to the mode or header line
20693 or marginal area AREA of window W, x-position X and y-position Y.
20694 X is relative to the start of the text display area of W, so the
20695 width of bitmap areas and scroll bars must be subtracted to get a
20696 position relative to the start of the mode line. */
20699 note_mode_line_or_margin_highlight (w
, x
, y
, area
)
20702 enum window_part area
;
20704 struct frame
*f
= XFRAME (w
->frame
);
20705 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
20706 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
20707 Lisp_Object pointer
= Qnil
;
20708 int charpos
, dx
, dy
, width
, height
;
20709 Lisp_Object string
, object
= Qnil
;
20710 Lisp_Object pos
, help
;
20712 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
20713 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
20714 &object
, &dx
, &dy
, &width
, &height
);
20717 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
20718 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
20719 &object
, &dx
, &dy
, &width
, &height
);
20724 if (IMAGEP (object
))
20726 Lisp_Object image_map
, hotspot
;
20727 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
20729 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
20731 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
20733 Lisp_Object area_id
, plist
;
20735 area_id
= XCAR (hotspot
);
20736 /* Could check AREA_ID to see if we enter/leave this hot-spot.
20737 If so, we could look for mouse-enter, mouse-leave
20738 properties in PLIST (and do something...). */
20739 if ((plist
= XCDR (hotspot
), CONSP (plist
)))
20741 pointer
= Fplist_get (plist
, Qpointer
);
20742 if (NILP (pointer
))
20744 help
= Fplist_get (plist
, Qhelp_echo
);
20747 help_echo_string
= help
;
20748 /* Is this correct? ++kfs */
20749 XSETWINDOW (help_echo_window
, w
);
20750 help_echo_object
= w
->buffer
;
20751 help_echo_pos
= charpos
;
20754 if (NILP (pointer
))
20755 pointer
= Fplist_get (XCDR (object
), QCpointer
);
20759 if (STRINGP (string
))
20761 pos
= make_number (charpos
);
20762 /* If we're on a string with `help-echo' text property, arrange
20763 for the help to be displayed. This is done by setting the
20764 global variable help_echo_string to the help string. */
20765 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
20768 help_echo_string
= help
;
20769 XSETWINDOW (help_echo_window
, w
);
20770 help_echo_object
= string
;
20771 help_echo_pos
= charpos
;
20774 if (NILP (pointer
))
20775 pointer
= Fget_text_property (pos
, Qpointer
, string
);
20777 /* Change the mouse pointer according to what is under X/Y. */
20778 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
20781 map
= Fget_text_property (pos
, Qlocal_map
, string
);
20782 if (!KEYMAPP (map
))
20783 map
= Fget_text_property (pos
, Qkeymap
, string
);
20784 if (!KEYMAPP (map
))
20785 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
20789 define_frame_cursor1 (f
, cursor
, pointer
);
20794 Take proper action when the mouse has moved to position X, Y on
20795 frame F as regards highlighting characters that have mouse-face
20796 properties. Also de-highlighting chars where the mouse was before.
20797 X and Y can be negative or out of range. */
20800 note_mouse_highlight (f
, x
, y
)
20804 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
20805 enum window_part part
;
20806 Lisp_Object window
;
20808 Cursor cursor
= No_Cursor
;
20809 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
20812 /* When a menu is active, don't highlight because this looks odd. */
20813 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NTGUI)
20814 if (popup_activated ())
20818 if (NILP (Vmouse_highlight
)
20819 || !f
->glyphs_initialized_p
)
20822 dpyinfo
->mouse_face_mouse_x
= x
;
20823 dpyinfo
->mouse_face_mouse_y
= y
;
20824 dpyinfo
->mouse_face_mouse_frame
= f
;
20826 if (dpyinfo
->mouse_face_defer
)
20829 if (gc_in_progress
)
20831 dpyinfo
->mouse_face_deferred_gc
= 1;
20835 /* Which window is that in? */
20836 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
20838 /* If we were displaying active text in another window, clear that. */
20839 if (! EQ (window
, dpyinfo
->mouse_face_window
))
20840 clear_mouse_face (dpyinfo
);
20842 /* Not on a window -> return. */
20843 if (!WINDOWP (window
))
20846 /* Reset help_echo_string. It will get recomputed below. */
20847 help_echo_string
= Qnil
;
20849 /* Convert to window-relative pixel coordinates. */
20850 w
= XWINDOW (window
);
20851 frame_to_window_pixel_xy (w
, &x
, &y
);
20853 /* Handle tool-bar window differently since it doesn't display a
20855 if (EQ (window
, f
->tool_bar_window
))
20857 note_tool_bar_highlight (f
, x
, y
);
20861 /* Mouse is on the mode, header line or margin? */
20862 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
20863 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
20865 note_mode_line_or_margin_highlight (w
, x
, y
, part
);
20869 if (part
== ON_VERTICAL_BORDER
)
20870 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
20871 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
)
20872 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
20874 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
20876 /* Are we in a window whose display is up to date?
20877 And verify the buffer's text has not changed. */
20878 b
= XBUFFER (w
->buffer
);
20879 if (part
== ON_TEXT
20880 && EQ (w
->window_end_valid
, w
->buffer
)
20881 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
20882 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
20884 int hpos
, vpos
, pos
, i
, dx
, dy
, area
;
20885 struct glyph
*glyph
;
20886 Lisp_Object object
;
20887 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
20888 Lisp_Object
*overlay_vec
= NULL
;
20890 struct buffer
*obuf
;
20891 int obegv
, ozv
, same_region
;
20893 /* Find the glyph under X/Y. */
20894 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
20896 /* Look for :pointer property on image. */
20897 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
20899 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
20900 if (img
!= NULL
&& IMAGEP (img
->spec
))
20902 Lisp_Object image_map
, hotspot
;
20903 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
20905 && (hotspot
= find_hot_spot (image_map
,
20906 glyph
->slice
.x
+ dx
,
20907 glyph
->slice
.y
+ dy
),
20909 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
20911 Lisp_Object area_id
, plist
;
20913 area_id
= XCAR (hotspot
);
20914 /* Could check AREA_ID to see if we enter/leave this hot-spot.
20915 If so, we could look for mouse-enter, mouse-leave
20916 properties in PLIST (and do something...). */
20917 if ((plist
= XCDR (hotspot
), CONSP (plist
)))
20919 pointer
= Fplist_get (plist
, Qpointer
);
20920 if (NILP (pointer
))
20922 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
20923 if (!NILP (help_echo_string
))
20925 help_echo_window
= window
;
20926 help_echo_object
= glyph
->object
;
20927 help_echo_pos
= glyph
->charpos
;
20931 if (NILP (pointer
))
20932 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
20936 /* Clear mouse face if X/Y not over text. */
20938 || area
!= TEXT_AREA
20939 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
20941 if (clear_mouse_face (dpyinfo
))
20942 cursor
= No_Cursor
;
20943 if (NILP (pointer
))
20945 if (area
!= TEXT_AREA
)
20946 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
20948 pointer
= Vvoid_text_area_pointer
;
20953 pos
= glyph
->charpos
;
20954 object
= glyph
->object
;
20955 if (!STRINGP (object
) && !BUFFERP (object
))
20958 /* If we get an out-of-range value, return now; avoid an error. */
20959 if (BUFFERP (object
) && pos
> BUF_Z (b
))
20962 /* Make the window's buffer temporarily current for
20963 overlays_at and compute_char_face. */
20964 obuf
= current_buffer
;
20965 current_buffer
= b
;
20971 /* Is this char mouse-active or does it have help-echo? */
20972 position
= make_number (pos
);
20974 if (BUFFERP (object
))
20976 /* Put all the overlays we want in a vector in overlay_vec. */
20977 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
20978 /* Sort overlays into increasing priority order. */
20979 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
20984 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
20985 && vpos
>= dpyinfo
->mouse_face_beg_row
20986 && vpos
<= dpyinfo
->mouse_face_end_row
20987 && (vpos
> dpyinfo
->mouse_face_beg_row
20988 || hpos
>= dpyinfo
->mouse_face_beg_col
)
20989 && (vpos
< dpyinfo
->mouse_face_end_row
20990 || hpos
< dpyinfo
->mouse_face_end_col
20991 || dpyinfo
->mouse_face_past_end
));
20994 cursor
= No_Cursor
;
20996 /* Check mouse-face highlighting. */
20998 /* If there exists an overlay with mouse-face overlapping
20999 the one we are currently highlighting, we have to
21000 check if we enter the overlapping overlay, and then
21001 highlight only that. */
21002 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
21003 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
21005 /* Find the highest priority overlay that has a mouse-face
21008 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
21010 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
21011 if (!NILP (mouse_face
))
21012 overlay
= overlay_vec
[i
];
21015 /* If we're actually highlighting the same overlay as
21016 before, there's no need to do that again. */
21017 if (!NILP (overlay
)
21018 && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
21019 goto check_help_echo
;
21021 dpyinfo
->mouse_face_overlay
= overlay
;
21023 /* Clear the display of the old active region, if any. */
21024 if (clear_mouse_face (dpyinfo
))
21025 cursor
= No_Cursor
;
21027 /* If no overlay applies, get a text property. */
21028 if (NILP (overlay
))
21029 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
21031 /* Handle the overlay case. */
21032 if (!NILP (overlay
))
21034 /* Find the range of text around this char that
21035 should be active. */
21036 Lisp_Object before
, after
;
21039 before
= Foverlay_start (overlay
);
21040 after
= Foverlay_end (overlay
);
21041 /* Record this as the current active region. */
21042 fast_find_position (w
, XFASTINT (before
),
21043 &dpyinfo
->mouse_face_beg_col
,
21044 &dpyinfo
->mouse_face_beg_row
,
21045 &dpyinfo
->mouse_face_beg_x
,
21046 &dpyinfo
->mouse_face_beg_y
, Qnil
);
21048 dpyinfo
->mouse_face_past_end
21049 = !fast_find_position (w
, XFASTINT (after
),
21050 &dpyinfo
->mouse_face_end_col
,
21051 &dpyinfo
->mouse_face_end_row
,
21052 &dpyinfo
->mouse_face_end_x
,
21053 &dpyinfo
->mouse_face_end_y
, Qnil
);
21054 dpyinfo
->mouse_face_window
= window
;
21056 dpyinfo
->mouse_face_face_id
21057 = face_at_buffer_position (w
, pos
, 0, 0,
21059 !dpyinfo
->mouse_face_hidden
);
21061 /* Display it as active. */
21062 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
21063 cursor
= No_Cursor
;
21065 /* Handle the text property case. */
21066 else if (!NILP (mouse_face
) && BUFFERP (object
))
21068 /* Find the range of text around this char that
21069 should be active. */
21070 Lisp_Object before
, after
, beginning
, end
;
21073 beginning
= Fmarker_position (w
->start
);
21074 end
= make_number (BUF_Z (XBUFFER (object
))
21075 - XFASTINT (w
->window_end_pos
));
21077 = Fprevious_single_property_change (make_number (pos
+ 1),
21079 object
, beginning
);
21081 = Fnext_single_property_change (position
, Qmouse_face
,
21084 /* Record this as the current active region. */
21085 fast_find_position (w
, XFASTINT (before
),
21086 &dpyinfo
->mouse_face_beg_col
,
21087 &dpyinfo
->mouse_face_beg_row
,
21088 &dpyinfo
->mouse_face_beg_x
,
21089 &dpyinfo
->mouse_face_beg_y
, Qnil
);
21090 dpyinfo
->mouse_face_past_end
21091 = !fast_find_position (w
, XFASTINT (after
),
21092 &dpyinfo
->mouse_face_end_col
,
21093 &dpyinfo
->mouse_face_end_row
,
21094 &dpyinfo
->mouse_face_end_x
,
21095 &dpyinfo
->mouse_face_end_y
, Qnil
);
21096 dpyinfo
->mouse_face_window
= window
;
21098 if (BUFFERP (object
))
21099 dpyinfo
->mouse_face_face_id
21100 = face_at_buffer_position (w
, pos
, 0, 0,
21102 !dpyinfo
->mouse_face_hidden
);
21104 /* Display it as active. */
21105 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
21106 cursor
= No_Cursor
;
21108 else if (!NILP (mouse_face
) && STRINGP (object
))
21113 b
= Fprevious_single_property_change (make_number (pos
+ 1),
21116 e
= Fnext_single_property_change (position
, Qmouse_face
,
21119 b
= make_number (0);
21121 e
= make_number (SCHARS (object
) - 1);
21122 fast_find_string_pos (w
, XINT (b
), object
,
21123 &dpyinfo
->mouse_face_beg_col
,
21124 &dpyinfo
->mouse_face_beg_row
,
21125 &dpyinfo
->mouse_face_beg_x
,
21126 &dpyinfo
->mouse_face_beg_y
, 0);
21127 fast_find_string_pos (w
, XINT (e
), object
,
21128 &dpyinfo
->mouse_face_end_col
,
21129 &dpyinfo
->mouse_face_end_row
,
21130 &dpyinfo
->mouse_face_end_x
,
21131 &dpyinfo
->mouse_face_end_y
, 1);
21132 dpyinfo
->mouse_face_past_end
= 0;
21133 dpyinfo
->mouse_face_window
= window
;
21134 dpyinfo
->mouse_face_face_id
21135 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
21136 glyph
->face_id
, 1);
21137 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
21138 cursor
= No_Cursor
;
21140 else if (STRINGP (object
) && NILP (mouse_face
))
21142 /* A string which doesn't have mouse-face, but
21143 the text ``under'' it might have. */
21144 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
21145 int start
= MATRIX_ROW_START_CHARPOS (r
);
21147 pos
= string_buffer_position (w
, object
, start
);
21149 mouse_face
= get_char_property_and_overlay (make_number (pos
),
21153 if (!NILP (mouse_face
) && !NILP (overlay
))
21155 Lisp_Object before
= Foverlay_start (overlay
);
21156 Lisp_Object after
= Foverlay_end (overlay
);
21159 /* Note that we might not be able to find position
21160 BEFORE in the glyph matrix if the overlay is
21161 entirely covered by a `display' property. In
21162 this case, we overshoot. So let's stop in
21163 the glyph matrix before glyphs for OBJECT. */
21164 fast_find_position (w
, XFASTINT (before
),
21165 &dpyinfo
->mouse_face_beg_col
,
21166 &dpyinfo
->mouse_face_beg_row
,
21167 &dpyinfo
->mouse_face_beg_x
,
21168 &dpyinfo
->mouse_face_beg_y
,
21171 dpyinfo
->mouse_face_past_end
21172 = !fast_find_position (w
, XFASTINT (after
),
21173 &dpyinfo
->mouse_face_end_col
,
21174 &dpyinfo
->mouse_face_end_row
,
21175 &dpyinfo
->mouse_face_end_x
,
21176 &dpyinfo
->mouse_face_end_y
,
21178 dpyinfo
->mouse_face_window
= window
;
21179 dpyinfo
->mouse_face_face_id
21180 = face_at_buffer_position (w
, pos
, 0, 0,
21182 !dpyinfo
->mouse_face_hidden
);
21184 /* Display it as active. */
21185 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
21186 cursor
= No_Cursor
;
21193 /* Look for a `help-echo' property. */
21194 if (NILP (help_echo_string
)) {
21195 Lisp_Object help
, overlay
;
21197 /* Check overlays first. */
21198 help
= overlay
= Qnil
;
21199 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
21201 overlay
= overlay_vec
[i
];
21202 help
= Foverlay_get (overlay
, Qhelp_echo
);
21207 help_echo_string
= help
;
21208 help_echo_window
= window
;
21209 help_echo_object
= overlay
;
21210 help_echo_pos
= pos
;
21214 Lisp_Object object
= glyph
->object
;
21215 int charpos
= glyph
->charpos
;
21217 /* Try text properties. */
21218 if (STRINGP (object
)
21220 && charpos
< SCHARS (object
))
21222 help
= Fget_text_property (make_number (charpos
),
21223 Qhelp_echo
, object
);
21226 /* If the string itself doesn't specify a help-echo,
21227 see if the buffer text ``under'' it does. */
21228 struct glyph_row
*r
21229 = MATRIX_ROW (w
->current_matrix
, vpos
);
21230 int start
= MATRIX_ROW_START_CHARPOS (r
);
21231 int pos
= string_buffer_position (w
, object
, start
);
21234 help
= Fget_char_property (make_number (pos
),
21235 Qhelp_echo
, w
->buffer
);
21239 object
= w
->buffer
;
21244 else if (BUFFERP (object
)
21247 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
21252 help_echo_string
= help
;
21253 help_echo_window
= window
;
21254 help_echo_object
= object
;
21255 help_echo_pos
= charpos
;
21260 /* Look for a `pointer' property. */
21261 if (NILP (pointer
))
21263 /* Check overlays first. */
21264 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
21265 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
21267 if (NILP (pointer
))
21269 Lisp_Object object
= glyph
->object
;
21270 int charpos
= glyph
->charpos
;
21272 /* Try text properties. */
21273 if (STRINGP (object
)
21275 && charpos
< SCHARS (object
))
21277 pointer
= Fget_text_property (make_number (charpos
),
21279 if (NILP (pointer
))
21281 /* If the string itself doesn't specify a pointer,
21282 see if the buffer text ``under'' it does. */
21283 struct glyph_row
*r
21284 = MATRIX_ROW (w
->current_matrix
, vpos
);
21285 int start
= MATRIX_ROW_START_CHARPOS (r
);
21286 int pos
= string_buffer_position (w
, object
, start
);
21288 pointer
= Fget_char_property (make_number (pos
),
21289 Qpointer
, w
->buffer
);
21292 else if (BUFFERP (object
)
21295 pointer
= Fget_text_property (make_number (charpos
),
21302 current_buffer
= obuf
;
21307 define_frame_cursor1 (f
, cursor
, pointer
);
21312 Clear any mouse-face on window W. This function is part of the
21313 redisplay interface, and is called from try_window_id and similar
21314 functions to ensure the mouse-highlight is off. */
21317 x_clear_window_mouse_face (w
)
21320 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
21321 Lisp_Object window
;
21324 XSETWINDOW (window
, w
);
21325 if (EQ (window
, dpyinfo
->mouse_face_window
))
21326 clear_mouse_face (dpyinfo
);
21332 Just discard the mouse face information for frame F, if any.
21333 This is used when the size of F is changed. */
21336 cancel_mouse_face (f
)
21339 Lisp_Object window
;
21340 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
21342 window
= dpyinfo
->mouse_face_window
;
21343 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
21345 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
21346 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
21347 dpyinfo
->mouse_face_window
= Qnil
;
21352 #endif /* HAVE_WINDOW_SYSTEM */
21355 /***********************************************************************
21357 ***********************************************************************/
21359 #ifdef HAVE_WINDOW_SYSTEM
21361 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
21362 which intersects rectangle R. R is in window-relative coordinates. */
21365 expose_area (w
, row
, r
, area
)
21367 struct glyph_row
*row
;
21369 enum glyph_row_area area
;
21371 struct glyph
*first
= row
->glyphs
[area
];
21372 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
21373 struct glyph
*last
;
21374 int first_x
, start_x
, x
;
21376 if (area
== TEXT_AREA
&& row
->fill_line_p
)
21377 /* If row extends face to end of line write the whole line. */
21378 draw_glyphs (w
, 0, row
, area
,
21379 0, row
->used
[area
],
21380 DRAW_NORMAL_TEXT
, 0);
21383 /* Set START_X to the window-relative start position for drawing glyphs of
21384 AREA. The first glyph of the text area can be partially visible.
21385 The first glyphs of other areas cannot. */
21386 start_x
= window_box_left_offset (w
, area
);
21388 if (area
== TEXT_AREA
)
21391 /* Find the first glyph that must be redrawn. */
21393 && x
+ first
->pixel_width
< r
->x
)
21395 x
+= first
->pixel_width
;
21399 /* Find the last one. */
21403 && x
< r
->x
+ r
->width
)
21405 x
+= last
->pixel_width
;
21411 draw_glyphs (w
, first_x
- start_x
, row
, area
,
21412 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
21413 DRAW_NORMAL_TEXT
, 0);
21418 /* Redraw the parts of the glyph row ROW on window W intersecting
21419 rectangle R. R is in window-relative coordinates. Value is
21420 non-zero if mouse-face was overwritten. */
21423 expose_line (w
, row
, r
)
21425 struct glyph_row
*row
;
21428 xassert (row
->enabled_p
);
21430 if (row
->mode_line_p
|| w
->pseudo_window_p
)
21431 draw_glyphs (w
, 0, row
, TEXT_AREA
,
21432 0, row
->used
[TEXT_AREA
],
21433 DRAW_NORMAL_TEXT
, 0);
21436 if (row
->used
[LEFT_MARGIN_AREA
])
21437 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
21438 if (row
->used
[TEXT_AREA
])
21439 expose_area (w
, row
, r
, TEXT_AREA
);
21440 if (row
->used
[RIGHT_MARGIN_AREA
])
21441 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
21442 draw_row_fringe_bitmaps (w
, row
);
21445 return row
->mouse_face_p
;
21449 /* Redraw those parts of glyphs rows during expose event handling that
21450 overlap other rows. Redrawing of an exposed line writes over parts
21451 of lines overlapping that exposed line; this function fixes that.
21453 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
21454 row in W's current matrix that is exposed and overlaps other rows.
21455 LAST_OVERLAPPING_ROW is the last such row. */
21458 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
)
21460 struct glyph_row
*first_overlapping_row
;
21461 struct glyph_row
*last_overlapping_row
;
21463 struct glyph_row
*row
;
21465 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
21466 if (row
->overlapping_p
)
21468 xassert (row
->enabled_p
&& !row
->mode_line_p
);
21470 if (row
->used
[LEFT_MARGIN_AREA
])
21471 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
);
21473 if (row
->used
[TEXT_AREA
])
21474 x_fix_overlapping_area (w
, row
, TEXT_AREA
);
21476 if (row
->used
[RIGHT_MARGIN_AREA
])
21477 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
);
21482 /* Return non-zero if W's cursor intersects rectangle R. */
21485 phys_cursor_in_rect_p (w
, r
)
21489 XRectangle cr
, result
;
21490 struct glyph
*cursor_glyph
;
21492 cursor_glyph
= get_phys_cursor_glyph (w
);
21495 /* r is relative to W's box, but w->phys_cursor.x is relative
21496 to left edge of W's TEXT area. Adjust it. */
21497 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
21498 cr
.y
= w
->phys_cursor
.y
;
21499 cr
.width
= cursor_glyph
->pixel_width
;
21500 cr
.height
= w
->phys_cursor_height
;
21501 /* ++KFS: W32 version used W32-specific IntersectRect here, but
21502 I assume the effect is the same -- and this is portable. */
21503 return x_intersect_rectangles (&cr
, r
, &result
);
21511 Draw a vertical window border to the right of window W if W doesn't
21512 have vertical scroll bars. */
21515 x_draw_vertical_border (w
)
21518 /* We could do better, if we knew what type of scroll-bar the adjacent
21519 windows (on either side) have... But we don't :-(
21520 However, I think this works ok. ++KFS 2003-04-25 */
21522 /* Redraw borders between horizontally adjacent windows. Don't
21523 do it for frames with vertical scroll bars because either the
21524 right scroll bar of a window, or the left scroll bar of its
21525 neighbor will suffice as a border. */
21526 if (!WINDOW_RIGHTMOST_P (w
)
21527 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
21529 int x0
, x1
, y0
, y1
;
21531 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
21534 rif
->draw_vertical_window_border (w
, x1
, y0
, y1
);
21536 else if (!WINDOW_LEFTMOST_P (w
)
21537 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
21539 int x0
, x1
, y0
, y1
;
21541 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
21544 rif
->draw_vertical_window_border (w
, x0
, y0
, y1
);
21549 /* Redraw the part of window W intersection rectangle FR. Pixel
21550 coordinates in FR are frame-relative. Call this function with
21551 input blocked. Value is non-zero if the exposure overwrites
21555 expose_window (w
, fr
)
21559 struct frame
*f
= XFRAME (w
->frame
);
21561 int mouse_face_overwritten_p
= 0;
21563 /* If window is not yet fully initialized, do nothing. This can
21564 happen when toolkit scroll bars are used and a window is split.
21565 Reconfiguring the scroll bar will generate an expose for a newly
21567 if (w
->current_matrix
== NULL
)
21570 /* When we're currently updating the window, display and current
21571 matrix usually don't agree. Arrange for a thorough display
21573 if (w
== updated_window
)
21575 SET_FRAME_GARBAGED (f
);
21579 /* Frame-relative pixel rectangle of W. */
21580 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
21581 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
21582 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
21583 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
21585 if (x_intersect_rectangles (fr
, &wr
, &r
))
21587 int yb
= window_text_bottom_y (w
);
21588 struct glyph_row
*row
;
21589 int cursor_cleared_p
;
21590 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
21592 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
21593 r
.x
, r
.y
, r
.width
, r
.height
));
21595 /* Convert to window coordinates. */
21596 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
21597 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
21599 /* Turn off the cursor. */
21600 if (!w
->pseudo_window_p
21601 && phys_cursor_in_rect_p (w
, &r
))
21603 x_clear_cursor (w
);
21604 cursor_cleared_p
= 1;
21607 cursor_cleared_p
= 0;
21609 /* Update lines intersecting rectangle R. */
21610 first_overlapping_row
= last_overlapping_row
= NULL
;
21611 for (row
= w
->current_matrix
->rows
;
21616 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
21618 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
21619 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
21620 || (r
.y
>= y0
&& r
.y
< y1
)
21621 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
21623 if (row
->overlapping_p
)
21625 if (first_overlapping_row
== NULL
)
21626 first_overlapping_row
= row
;
21627 last_overlapping_row
= row
;
21630 if (expose_line (w
, row
, &r
))
21631 mouse_face_overwritten_p
= 1;
21638 /* Display the mode line if there is one. */
21639 if (WINDOW_WANTS_MODELINE_P (w
)
21640 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
21642 && row
->y
< r
.y
+ r
.height
)
21644 if (expose_line (w
, row
, &r
))
21645 mouse_face_overwritten_p
= 1;
21648 if (!w
->pseudo_window_p
)
21650 /* Fix the display of overlapping rows. */
21651 if (first_overlapping_row
)
21652 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
);
21654 /* Draw border between windows. */
21655 x_draw_vertical_border (w
);
21657 /* Turn the cursor on again. */
21658 if (cursor_cleared_p
)
21659 update_window_cursor (w
, 1);
21664 /* Display scroll bar for this window. */
21665 if (!NILP (w
->vertical_scroll_bar
))
21668 If this doesn't work here (maybe some header files are missing),
21669 make a function in macterm.c and call it to do the job! */
21671 = SCROLL_BAR_CONTROL_HANDLE (XSCROLL_BAR (w
->vertical_scroll_bar
));
21677 return mouse_face_overwritten_p
;
21682 /* Redraw (parts) of all windows in the window tree rooted at W that
21683 intersect R. R contains frame pixel coordinates. Value is
21684 non-zero if the exposure overwrites mouse-face. */
21687 expose_window_tree (w
, r
)
21691 struct frame
*f
= XFRAME (w
->frame
);
21692 int mouse_face_overwritten_p
= 0;
21694 while (w
&& !FRAME_GARBAGED_P (f
))
21696 if (!NILP (w
->hchild
))
21697 mouse_face_overwritten_p
21698 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
21699 else if (!NILP (w
->vchild
))
21700 mouse_face_overwritten_p
21701 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
21703 mouse_face_overwritten_p
|= expose_window (w
, r
);
21705 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
21708 return mouse_face_overwritten_p
;
21713 Redisplay an exposed area of frame F. X and Y are the upper-left
21714 corner of the exposed rectangle. W and H are width and height of
21715 the exposed area. All are pixel values. W or H zero means redraw
21716 the entire frame. */
21719 expose_frame (f
, x
, y
, w
, h
)
21724 int mouse_face_overwritten_p
= 0;
21726 TRACE ((stderr
, "expose_frame "));
21728 /* No need to redraw if frame will be redrawn soon. */
21729 if (FRAME_GARBAGED_P (f
))
21731 TRACE ((stderr
, " garbaged\n"));
21736 /* MAC_TODO: this is a kludge, but if scroll bars are not activated
21737 or deactivated here, for unknown reasons, activated scroll bars
21738 are shown in deactivated frames in some instances. */
21739 if (f
== FRAME_MAC_DISPLAY_INFO (f
)->x_focus_frame
)
21740 activate_scroll_bars (f
);
21742 deactivate_scroll_bars (f
);
21745 /* If basic faces haven't been realized yet, there is no point in
21746 trying to redraw anything. This can happen when we get an expose
21747 event while Emacs is starting, e.g. by moving another window. */
21748 if (FRAME_FACE_CACHE (f
) == NULL
21749 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
21751 TRACE ((stderr
, " no faces\n"));
21755 if (w
== 0 || h
== 0)
21758 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
21759 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
21769 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
21770 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
21772 if (WINDOWP (f
->tool_bar_window
))
21773 mouse_face_overwritten_p
21774 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
21776 #ifdef HAVE_X_WINDOWS
21778 #ifndef USE_X_TOOLKIT
21779 if (WINDOWP (f
->menu_bar_window
))
21780 mouse_face_overwritten_p
21781 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
21782 #endif /* not USE_X_TOOLKIT */
21786 /* Some window managers support a focus-follows-mouse style with
21787 delayed raising of frames. Imagine a partially obscured frame,
21788 and moving the mouse into partially obscured mouse-face on that
21789 frame. The visible part of the mouse-face will be highlighted,
21790 then the WM raises the obscured frame. With at least one WM, KDE
21791 2.1, Emacs is not getting any event for the raising of the frame
21792 (even tried with SubstructureRedirectMask), only Expose events.
21793 These expose events will draw text normally, i.e. not
21794 highlighted. Which means we must redo the highlight here.
21795 Subsume it under ``we love X''. --gerd 2001-08-15 */
21796 /* Included in Windows version because Windows most likely does not
21797 do the right thing if any third party tool offers
21798 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
21799 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
21801 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
21802 if (f
== dpyinfo
->mouse_face_mouse_frame
)
21804 int x
= dpyinfo
->mouse_face_mouse_x
;
21805 int y
= dpyinfo
->mouse_face_mouse_y
;
21806 clear_mouse_face (dpyinfo
);
21807 note_mouse_highlight (f
, x
, y
);
21814 Determine the intersection of two rectangles R1 and R2. Return
21815 the intersection in *RESULT. Value is non-zero if RESULT is not
21819 x_intersect_rectangles (r1
, r2
, result
)
21820 XRectangle
*r1
, *r2
, *result
;
21822 XRectangle
*left
, *right
;
21823 XRectangle
*upper
, *lower
;
21824 int intersection_p
= 0;
21826 /* Rearrange so that R1 is the left-most rectangle. */
21828 left
= r1
, right
= r2
;
21830 left
= r2
, right
= r1
;
21832 /* X0 of the intersection is right.x0, if this is inside R1,
21833 otherwise there is no intersection. */
21834 if (right
->x
<= left
->x
+ left
->width
)
21836 result
->x
= right
->x
;
21838 /* The right end of the intersection is the minimum of the
21839 the right ends of left and right. */
21840 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
21843 /* Same game for Y. */
21845 upper
= r1
, lower
= r2
;
21847 upper
= r2
, lower
= r1
;
21849 /* The upper end of the intersection is lower.y0, if this is inside
21850 of upper. Otherwise, there is no intersection. */
21851 if (lower
->y
<= upper
->y
+ upper
->height
)
21853 result
->y
= lower
->y
;
21855 /* The lower end of the intersection is the minimum of the lower
21856 ends of upper and lower. */
21857 result
->height
= (min (lower
->y
+ lower
->height
,
21858 upper
->y
+ upper
->height
)
21860 intersection_p
= 1;
21864 return intersection_p
;
21867 #endif /* HAVE_WINDOW_SYSTEM */
21870 /***********************************************************************
21872 ***********************************************************************/
21877 Vwith_echo_area_save_vector
= Qnil
;
21878 staticpro (&Vwith_echo_area_save_vector
);
21880 Vmessage_stack
= Qnil
;
21881 staticpro (&Vmessage_stack
);
21883 Qinhibit_redisplay
= intern ("inhibit-redisplay");
21884 staticpro (&Qinhibit_redisplay
);
21886 message_dolog_marker1
= Fmake_marker ();
21887 staticpro (&message_dolog_marker1
);
21888 message_dolog_marker2
= Fmake_marker ();
21889 staticpro (&message_dolog_marker2
);
21890 message_dolog_marker3
= Fmake_marker ();
21891 staticpro (&message_dolog_marker3
);
21894 defsubr (&Sdump_frame_glyph_matrix
);
21895 defsubr (&Sdump_glyph_matrix
);
21896 defsubr (&Sdump_glyph_row
);
21897 defsubr (&Sdump_tool_bar_row
);
21898 defsubr (&Strace_redisplay
);
21899 defsubr (&Strace_to_stderr
);
21901 #ifdef HAVE_WINDOW_SYSTEM
21902 defsubr (&Stool_bar_lines_needed
);
21903 defsubr (&Slookup_image_map
);
21905 defsubr (&Sformat_mode_line
);
21907 staticpro (&Qmenu_bar_update_hook
);
21908 Qmenu_bar_update_hook
= intern ("menu-bar-update-hook");
21910 staticpro (&Qoverriding_terminal_local_map
);
21911 Qoverriding_terminal_local_map
= intern ("overriding-terminal-local-map");
21913 staticpro (&Qoverriding_local_map
);
21914 Qoverriding_local_map
= intern ("overriding-local-map");
21916 staticpro (&Qwindow_scroll_functions
);
21917 Qwindow_scroll_functions
= intern ("window-scroll-functions");
21919 staticpro (&Qredisplay_end_trigger_functions
);
21920 Qredisplay_end_trigger_functions
= intern ("redisplay-end-trigger-functions");
21922 staticpro (&Qinhibit_point_motion_hooks
);
21923 Qinhibit_point_motion_hooks
= intern ("inhibit-point-motion-hooks");
21925 QCdata
= intern (":data");
21926 staticpro (&QCdata
);
21927 Qdisplay
= intern ("display");
21928 staticpro (&Qdisplay
);
21929 Qspace_width
= intern ("space-width");
21930 staticpro (&Qspace_width
);
21931 Qraise
= intern ("raise");
21932 staticpro (&Qraise
);
21933 Qslice
= intern ("slice");
21934 staticpro (&Qslice
);
21935 Qspace
= intern ("space");
21936 staticpro (&Qspace
);
21937 Qmargin
= intern ("margin");
21938 staticpro (&Qmargin
);
21939 Qpointer
= intern ("pointer");
21940 staticpro (&Qpointer
);
21941 Qleft_margin
= intern ("left-margin");
21942 staticpro (&Qleft_margin
);
21943 Qright_margin
= intern ("right-margin");
21944 staticpro (&Qright_margin
);
21945 Qcenter
= intern ("center");
21946 staticpro (&Qcenter
);
21947 Qline_height
= intern ("line-height");
21948 staticpro (&Qline_height
);
21949 Qtotal
= intern ("total");
21950 staticpro (&Qtotal
);
21951 QCalign_to
= intern (":align-to");
21952 staticpro (&QCalign_to
);
21953 QCrelative_width
= intern (":relative-width");
21954 staticpro (&QCrelative_width
);
21955 QCrelative_height
= intern (":relative-height");
21956 staticpro (&QCrelative_height
);
21957 QCeval
= intern (":eval");
21958 staticpro (&QCeval
);
21959 QCpropertize
= intern (":propertize");
21960 staticpro (&QCpropertize
);
21961 QCfile
= intern (":file");
21962 staticpro (&QCfile
);
21963 Qfontified
= intern ("fontified");
21964 staticpro (&Qfontified
);
21965 Qfontification_functions
= intern ("fontification-functions");
21966 staticpro (&Qfontification_functions
);
21967 Qtrailing_whitespace
= intern ("trailing-whitespace");
21968 staticpro (&Qtrailing_whitespace
);
21969 Qimage
= intern ("image");
21970 staticpro (&Qimage
);
21971 QCmap
= intern (":map");
21972 staticpro (&QCmap
);
21973 QCpointer
= intern (":pointer");
21974 staticpro (&QCpointer
);
21975 Qrect
= intern ("rect");
21976 staticpro (&Qrect
);
21977 Qcircle
= intern ("circle");
21978 staticpro (&Qcircle
);
21979 Qpoly
= intern ("poly");
21980 staticpro (&Qpoly
);
21981 Qmessage_truncate_lines
= intern ("message-truncate-lines");
21982 staticpro (&Qmessage_truncate_lines
);
21983 Qcursor_in_non_selected_windows
= intern ("cursor-in-non-selected-windows");
21984 staticpro (&Qcursor_in_non_selected_windows
);
21985 Qgrow_only
= intern ("grow-only");
21986 staticpro (&Qgrow_only
);
21987 Qinhibit_menubar_update
= intern ("inhibit-menubar-update");
21988 staticpro (&Qinhibit_menubar_update
);
21989 Qinhibit_eval_during_redisplay
= intern ("inhibit-eval-during-redisplay");
21990 staticpro (&Qinhibit_eval_during_redisplay
);
21991 Qposition
= intern ("position");
21992 staticpro (&Qposition
);
21993 Qbuffer_position
= intern ("buffer-position");
21994 staticpro (&Qbuffer_position
);
21995 Qobject
= intern ("object");
21996 staticpro (&Qobject
);
21997 Qbar
= intern ("bar");
21999 Qhbar
= intern ("hbar");
22000 staticpro (&Qhbar
);
22001 Qbox
= intern ("box");
22003 Qhollow
= intern ("hollow");
22004 staticpro (&Qhollow
);
22005 Qhand
= intern ("hand");
22006 staticpro (&Qhand
);
22007 Qarrow
= intern ("arrow");
22008 staticpro (&Qarrow
);
22009 Qtext
= intern ("text");
22010 staticpro (&Qtext
);
22011 Qrisky_local_variable
= intern ("risky-local-variable");
22012 staticpro (&Qrisky_local_variable
);
22013 Qinhibit_free_realized_faces
= intern ("inhibit-free-realized-faces");
22014 staticpro (&Qinhibit_free_realized_faces
);
22016 list_of_error
= Fcons (Fcons (intern ("error"),
22017 Fcons (intern ("void-variable"), Qnil
)),
22019 staticpro (&list_of_error
);
22021 Qlast_arrow_position
= intern ("last-arrow-position");
22022 staticpro (&Qlast_arrow_position
);
22023 Qlast_arrow_string
= intern ("last-arrow-string");
22024 staticpro (&Qlast_arrow_string
);
22026 Qoverlay_arrow_string
= intern ("overlay-arrow-string");
22027 staticpro (&Qoverlay_arrow_string
);
22028 Qoverlay_arrow_bitmap
= intern ("overlay-arrow-bitmap");
22029 staticpro (&Qoverlay_arrow_bitmap
);
22031 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
22032 staticpro (&echo_buffer
[0]);
22033 staticpro (&echo_buffer
[1]);
22035 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
22036 staticpro (&echo_area_buffer
[0]);
22037 staticpro (&echo_area_buffer
[1]);
22039 Vmessages_buffer_name
= build_string ("*Messages*");
22040 staticpro (&Vmessages_buffer_name
);
22042 mode_line_proptrans_alist
= Qnil
;
22043 staticpro (&mode_line_proptrans_alist
);
22045 mode_line_string_list
= Qnil
;
22046 staticpro (&mode_line_string_list
);
22048 help_echo_string
= Qnil
;
22049 staticpro (&help_echo_string
);
22050 help_echo_object
= Qnil
;
22051 staticpro (&help_echo_object
);
22052 help_echo_window
= Qnil
;
22053 staticpro (&help_echo_window
);
22054 previous_help_echo_string
= Qnil
;
22055 staticpro (&previous_help_echo_string
);
22056 help_echo_pos
= -1;
22058 #ifdef HAVE_WINDOW_SYSTEM
22059 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
22060 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
22061 For example, if a block cursor is over a tab, it will be drawn as
22062 wide as that tab on the display. */);
22063 x_stretch_cursor_p
= 0;
22066 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
22067 doc
: /* *Non-nil means highlight trailing whitespace.
22068 The face used for trailing whitespace is `trailing-whitespace'. */);
22069 Vshow_trailing_whitespace
= Qnil
;
22071 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
22072 doc
: /* *The pointer shape to show in void text areas.
22073 Nil means to show the text pointer. Other options are `arrow', `text',
22074 `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
22075 Vvoid_text_area_pointer
= Qarrow
;
22077 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
22078 doc
: /* Non-nil means don't actually do any redisplay.
22079 This is used for internal purposes. */);
22080 Vinhibit_redisplay
= Qnil
;
22082 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
22083 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
22084 Vglobal_mode_string
= Qnil
;
22086 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
22087 doc
: /* Marker for where to display an arrow on top of the buffer text.
22088 This must be the beginning of a line in order to work.
22089 See also `overlay-arrow-string'. */);
22090 Voverlay_arrow_position
= Qnil
;
22092 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
22093 doc
: /* String to display as an arrow in non-window frames.
22094 See also `overlay-arrow-position'. */);
22095 Voverlay_arrow_string
= Qnil
;
22097 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
22098 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
22099 The symbols on this list are examined during redisplay to determine
22100 where to display overlay arrows. */);
22101 Voverlay_arrow_variable_list
22102 = Fcons (intern ("overlay-arrow-position"), Qnil
);
22104 DEFVAR_INT ("scroll-step", &scroll_step
,
22105 doc
: /* *The number of lines to try scrolling a window by when point moves out.
22106 If that fails to bring point back on frame, point is centered instead.
22107 If this is zero, point is always centered after it moves off frame.
22108 If you want scrolling to always be a line at a time, you should set
22109 `scroll-conservatively' to a large value rather than set this to 1. */);
22111 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
22112 doc
: /* *Scroll up to this many lines, to bring point back on screen.
22113 A value of zero means to scroll the text to center point vertically
22114 in the window. */);
22115 scroll_conservatively
= 0;
22117 DEFVAR_INT ("scroll-margin", &scroll_margin
,
22118 doc
: /* *Number of lines of margin at the top and bottom of a window.
22119 Recenter the window whenever point gets within this many lines
22120 of the top or bottom of the window. */);
22123 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
22124 doc
: /* Pixels per inch on current display.
22125 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
22126 Vdisplay_pixels_per_inch
= make_float (72.0);
22129 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
22132 DEFVAR_BOOL ("truncate-partial-width-windows",
22133 &truncate_partial_width_windows
,
22134 doc
: /* *Non-nil means truncate lines in all windows less than full frame wide. */);
22135 truncate_partial_width_windows
= 1;
22137 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
22138 doc
: /* nil means display the mode-line/header-line/menu-bar in the default face.
22139 Any other value means to use the appropriate face, `mode-line',
22140 `header-line', or `menu' respectively. */);
22141 mode_line_inverse_video
= 1;
22143 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
22144 doc
: /* *Maximum buffer size for which line number should be displayed.
22145 If the buffer is bigger than this, the line number does not appear
22146 in the mode line. A value of nil means no limit. */);
22147 Vline_number_display_limit
= Qnil
;
22149 DEFVAR_INT ("line-number-display-limit-width",
22150 &line_number_display_limit_width
,
22151 doc
: /* *Maximum line width (in characters) for line number display.
22152 If the average length of the lines near point is bigger than this, then the
22153 line number may be omitted from the mode line. */);
22154 line_number_display_limit_width
= 200;
22156 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
22157 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
22158 highlight_nonselected_windows
= 0;
22160 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
22161 doc
: /* Non-nil if more than one frame is visible on this display.
22162 Minibuffer-only frames don't count, but iconified frames do.
22163 This variable is not guaranteed to be accurate except while processing
22164 `frame-title-format' and `icon-title-format'. */);
22166 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
22167 doc
: /* Template for displaying the title bar of visible frames.
22168 \(Assuming the window manager supports this feature.)
22169 This variable has the same structure as `mode-line-format' (which see),
22170 and is used only on frames for which no explicit name has been set
22171 \(see `modify-frame-parameters'). */);
22173 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
22174 doc
: /* Template for displaying the title bar of an iconified frame.
22175 \(Assuming the window manager supports this feature.)
22176 This variable has the same structure as `mode-line-format' (which see),
22177 and is used only on frames for which no explicit name has been set
22178 \(see `modify-frame-parameters'). */);
22180 = Vframe_title_format
22181 = Fcons (intern ("multiple-frames"),
22182 Fcons (build_string ("%b"),
22183 Fcons (Fcons (empty_string
,
22184 Fcons (intern ("invocation-name"),
22185 Fcons (build_string ("@"),
22186 Fcons (intern ("system-name"),
22190 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
22191 doc
: /* Maximum number of lines to keep in the message log buffer.
22192 If nil, disable message logging. If t, log messages but don't truncate
22193 the buffer when it becomes large. */);
22194 Vmessage_log_max
= make_number (50);
22196 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
22197 doc
: /* Functions called before redisplay, if window sizes have changed.
22198 The value should be a list of functions that take one argument.
22199 Just before redisplay, for each frame, if any of its windows have changed
22200 size since the last redisplay, or have been split or deleted,
22201 all the functions in the list are called, with the frame as argument. */);
22202 Vwindow_size_change_functions
= Qnil
;
22204 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
22205 doc
: /* List of functions to call before redisplaying a window with scrolling.
22206 Each function is called with two arguments, the window
22207 and its new display-start position. Note that the value of `window-end'
22208 is not valid when these functions are called. */);
22209 Vwindow_scroll_functions
= Qnil
;
22211 DEFVAR_BOOL ("mouse-autoselect-window", &mouse_autoselect_window
,
22212 doc
: /* *Non-nil means autoselect window with mouse pointer. */);
22213 mouse_autoselect_window
= 0;
22215 DEFVAR_BOOL ("auto-resize-tool-bars", &auto_resize_tool_bars_p
,
22216 doc
: /* *Non-nil means automatically resize tool-bars.
22217 This increases a tool-bar's height if not all tool-bar items are visible.
22218 It decreases a tool-bar's height when it would display blank lines
22220 auto_resize_tool_bars_p
= 1;
22222 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
22223 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
22224 auto_raise_tool_bar_buttons_p
= 1;
22226 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
22227 doc
: /* *Margin around tool-bar buttons in pixels.
22228 If an integer, use that for both horizontal and vertical margins.
22229 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
22230 HORZ specifying the horizontal margin, and VERT specifying the
22231 vertical margin. */);
22232 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
22234 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
22235 doc
: /* *Relief thickness of tool-bar buttons. */);
22236 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
22238 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
22239 doc
: /* List of functions to call to fontify regions of text.
22240 Each function is called with one argument POS. Functions must
22241 fontify a region starting at POS in the current buffer, and give
22242 fontified regions the property `fontified'. */);
22243 Vfontification_functions
= Qnil
;
22244 Fmake_variable_buffer_local (Qfontification_functions
);
22246 DEFVAR_BOOL ("unibyte-display-via-language-environment",
22247 &unibyte_display_via_language_environment
,
22248 doc
: /* *Non-nil means display unibyte text according to language environment.
22249 Specifically this means that unibyte non-ASCII characters
22250 are displayed by converting them to the equivalent multibyte characters
22251 according to the current language environment. As a result, they are
22252 displayed according to the current fontset. */);
22253 unibyte_display_via_language_environment
= 0;
22255 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
22256 doc
: /* *Maximum height for resizing mini-windows.
22257 If a float, it specifies a fraction of the mini-window frame's height.
22258 If an integer, it specifies a number of lines. */);
22259 Vmax_mini_window_height
= make_float (0.25);
22261 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
22262 doc
: /* *How to resize mini-windows.
22263 A value of nil means don't automatically resize mini-windows.
22264 A value of t means resize them to fit the text displayed in them.
22265 A value of `grow-only', the default, means let mini-windows grow
22266 only, until their display becomes empty, at which point the windows
22267 go back to their normal size. */);
22268 Vresize_mini_windows
= Qgrow_only
;
22270 DEFVAR_LISP ("cursor-in-non-selected-windows",
22271 &Vcursor_in_non_selected_windows
,
22272 doc
: /* *Cursor type to display in non-selected windows.
22273 t means to use hollow box cursor. See `cursor-type' for other values. */);
22274 Vcursor_in_non_selected_windows
= Qt
;
22276 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
22277 doc
: /* Alist specifying how to blink the cursor off.
22278 Each element has the form (ON-STATE . OFF-STATE). Whenever the
22279 `cursor-type' frame-parameter or variable equals ON-STATE,
22280 comparing using `equal', Emacs uses OFF-STATE to specify
22281 how to blink it off. */);
22282 Vblink_cursor_alist
= Qnil
;
22284 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
22285 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
22286 automatic_hscrolling_p
= 1;
22288 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
22289 doc
: /* *How many columns away from the window edge point is allowed to get
22290 before automatic hscrolling will horizontally scroll the window. */);
22291 hscroll_margin
= 5;
22293 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
22294 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
22295 When point is less than `automatic-hscroll-margin' columns from the window
22296 edge, automatic hscrolling will scroll the window by the amount of columns
22297 determined by this variable. If its value is a positive integer, scroll that
22298 many columns. If it's a positive floating-point number, it specifies the
22299 fraction of the window's width to scroll. If it's nil or zero, point will be
22300 centered horizontally after the scroll. Any other value, including negative
22301 numbers, are treated as if the value were zero.
22303 Automatic hscrolling always moves point outside the scroll margin, so if
22304 point was more than scroll step columns inside the margin, the window will
22305 scroll more than the value given by the scroll step.
22307 Note that the lower bound for automatic hscrolling specified by `scroll-left'
22308 and `scroll-right' overrides this variable's effect. */);
22309 Vhscroll_step
= make_number (0);
22311 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
22312 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
22313 Bind this around calls to `message' to let it take effect. */);
22314 message_truncate_lines
= 0;
22316 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
22317 doc
: /* Normal hook run for clicks on menu bar, before displaying a submenu.
22318 Can be used to update submenus whose contents should vary. */);
22319 Vmenu_bar_update_hook
= Qnil
;
22321 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
22322 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
22323 inhibit_menubar_update
= 0;
22325 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
22326 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
22327 inhibit_eval_during_redisplay
= 0;
22329 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
22330 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
22331 inhibit_free_realized_faces
= 0;
22334 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
22335 doc
: /* Inhibit try_window_id display optimization. */);
22336 inhibit_try_window_id
= 0;
22338 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
22339 doc
: /* Inhibit try_window_reusing display optimization. */);
22340 inhibit_try_window_reusing
= 0;
22342 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
22343 doc
: /* Inhibit try_cursor_movement display optimization. */);
22344 inhibit_try_cursor_movement
= 0;
22345 #endif /* GLYPH_DEBUG */
22349 /* Initialize this module when Emacs starts. */
22354 Lisp_Object root_window
;
22355 struct window
*mini_w
;
22357 current_header_line_height
= current_mode_line_height
= -1;
22359 CHARPOS (this_line_start_pos
) = 0;
22361 mini_w
= XWINDOW (minibuf_window
);
22362 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
22364 if (!noninteractive
)
22366 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
22369 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
22370 set_window_height (root_window
,
22371 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
22373 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
22374 set_window_height (minibuf_window
, 1, 0);
22376 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
22377 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
22379 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
22380 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
22381 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
22383 /* The default ellipsis glyphs `...'. */
22384 for (i
= 0; i
< 3; ++i
)
22385 default_invis_vector
[i
] = make_number ('.');
22389 /* Allocate the buffer for frame titles.
22390 Also used for `format-mode-line'. */
22392 frame_title_buf
= (char *) xmalloc (size
);
22393 frame_title_buf_end
= frame_title_buf
+ size
;
22394 frame_title_ptr
= NULL
;
22397 help_echo_showing_p
= 0;
22401 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
22402 (do not change this comment) */