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
;
6319 /* Do nothing if called asynchronously. Inserting text into
6320 a buffer may call after-change-functions and alike and
6321 that would means running Lisp asynchronously. */
6322 if (handling_signal
)
6326 GCPRO4 (fmt
, msg
, arg1
, arg2
);
6328 args
[0] = fmt
= build_string (format
);
6331 msg
= Fformat (3, args
);
6333 len
= SBYTES (msg
) + 1;
6334 buffer
= (char *) alloca (len
);
6335 bcopy (SDATA (msg
), buffer
, len
);
6337 message_dolog (buffer
, len
- 1, 1, 0);
6342 /* Output a newline in the *Messages* buffer if "needs" one. */
6345 message_log_maybe_newline ()
6347 if (message_log_need_newline
)
6348 message_dolog ("", 0, 1, 0);
6352 /* Add a string M of length NBYTES to the message log, optionally
6353 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
6354 nonzero, means interpret the contents of M as multibyte. This
6355 function calls low-level routines in order to bypass text property
6356 hooks, etc. which might not be safe to run. */
6359 message_dolog (m
, nbytes
, nlflag
, multibyte
)
6361 int nbytes
, nlflag
, multibyte
;
6363 if (!NILP (Vmemory_full
))
6366 if (!NILP (Vmessage_log_max
))
6368 struct buffer
*oldbuf
;
6369 Lisp_Object oldpoint
, oldbegv
, oldzv
;
6370 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
6371 int point_at_end
= 0;
6373 Lisp_Object old_deactivate_mark
, tem
;
6374 struct gcpro gcpro1
;
6376 old_deactivate_mark
= Vdeactivate_mark
;
6377 oldbuf
= current_buffer
;
6378 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
6379 current_buffer
->undo_list
= Qt
;
6381 oldpoint
= message_dolog_marker1
;
6382 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
6383 oldbegv
= message_dolog_marker2
;
6384 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
6385 oldzv
= message_dolog_marker3
;
6386 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
6387 GCPRO1 (old_deactivate_mark
);
6395 BEGV_BYTE
= BEG_BYTE
;
6398 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
6400 /* Insert the string--maybe converting multibyte to single byte
6401 or vice versa, so that all the text fits the buffer. */
6403 && NILP (current_buffer
->enable_multibyte_characters
))
6405 int i
, c
, char_bytes
;
6406 unsigned char work
[1];
6408 /* Convert a multibyte string to single-byte
6409 for the *Message* buffer. */
6410 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
6412 c
= string_char_and_length (m
+ i
, nbytes
- i
, &char_bytes
);
6413 work
[0] = (SINGLE_BYTE_CHAR_P (c
)
6415 : multibyte_char_to_unibyte (c
, Qnil
));
6416 insert_1_both (work
, 1, 1, 1, 0, 0);
6419 else if (! multibyte
6420 && ! NILP (current_buffer
->enable_multibyte_characters
))
6422 int i
, c
, char_bytes
;
6423 unsigned char *msg
= (unsigned char *) m
;
6424 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
6425 /* Convert a single-byte string to multibyte
6426 for the *Message* buffer. */
6427 for (i
= 0; i
< nbytes
; i
++)
6429 c
= unibyte_char_to_multibyte (msg
[i
]);
6430 char_bytes
= CHAR_STRING (c
, str
);
6431 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
6435 insert_1 (m
, nbytes
, 1, 0, 0);
6439 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
6440 insert_1 ("\n", 1, 1, 0, 0);
6442 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
6444 this_bol_byte
= PT_BYTE
;
6446 /* See if this line duplicates the previous one.
6447 If so, combine duplicates. */
6450 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
6452 prev_bol_byte
= PT_BYTE
;
6454 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
6455 this_bol
, this_bol_byte
);
6458 del_range_both (prev_bol
, prev_bol_byte
,
6459 this_bol
, this_bol_byte
, 0);
6465 /* If you change this format, don't forget to also
6466 change message_log_check_duplicate. */
6467 sprintf (dupstr
, " [%d times]", dup
);
6468 duplen
= strlen (dupstr
);
6469 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
6470 insert_1 (dupstr
, duplen
, 1, 0, 1);
6475 /* If we have more than the desired maximum number of lines
6476 in the *Messages* buffer now, delete the oldest ones.
6477 This is safe because we don't have undo in this buffer. */
6479 if (NATNUMP (Vmessage_log_max
))
6481 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
6482 -XFASTINT (Vmessage_log_max
) - 1, 0);
6483 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
6486 BEGV
= XMARKER (oldbegv
)->charpos
;
6487 BEGV_BYTE
= marker_byte_position (oldbegv
);
6496 ZV
= XMARKER (oldzv
)->charpos
;
6497 ZV_BYTE
= marker_byte_position (oldzv
);
6501 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
6503 /* We can't do Fgoto_char (oldpoint) because it will run some
6505 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
6506 XMARKER (oldpoint
)->bytepos
);
6509 unchain_marker (XMARKER (oldpoint
));
6510 unchain_marker (XMARKER (oldbegv
));
6511 unchain_marker (XMARKER (oldzv
));
6513 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
6514 set_buffer_internal (oldbuf
);
6516 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
6517 message_log_need_newline
= !nlflag
;
6518 Vdeactivate_mark
= old_deactivate_mark
;
6523 /* We are at the end of the buffer after just having inserted a newline.
6524 (Note: We depend on the fact we won't be crossing the gap.)
6525 Check to see if the most recent message looks a lot like the previous one.
6526 Return 0 if different, 1 if the new one should just replace it, or a
6527 value N > 1 if we should also append " [N times]". */
6530 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
6531 int prev_bol
, this_bol
;
6532 int prev_bol_byte
, this_bol_byte
;
6535 int len
= Z_BYTE
- 1 - this_bol_byte
;
6537 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
6538 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
6540 for (i
= 0; i
< len
; i
++)
6542 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
6550 if (*p1
++ == ' ' && *p1
++ == '[')
6553 while (*p1
>= '0' && *p1
<= '9')
6554 n
= n
* 10 + *p1
++ - '0';
6555 if (strncmp (p1
, " times]\n", 8) == 0)
6562 /* Display an echo area message M with a specified length of NBYTES
6563 bytes. The string may include null characters. If M is 0, clear
6564 out any existing message, and let the mini-buffer text show
6567 The buffer M must continue to exist until after the echo area gets
6568 cleared or some other message gets displayed there. This means do
6569 not pass text that is stored in a Lisp string; do not pass text in
6570 a buffer that was alloca'd. */
6573 message2 (m
, nbytes
, multibyte
)
6578 /* First flush out any partial line written with print. */
6579 message_log_maybe_newline ();
6581 message_dolog (m
, nbytes
, 1, multibyte
);
6582 message2_nolog (m
, nbytes
, multibyte
);
6586 /* The non-logging counterpart of message2. */
6589 message2_nolog (m
, nbytes
, multibyte
)
6591 int nbytes
, multibyte
;
6593 struct frame
*sf
= SELECTED_FRAME ();
6594 message_enable_multibyte
= multibyte
;
6598 if (noninteractive_need_newline
)
6599 putc ('\n', stderr
);
6600 noninteractive_need_newline
= 0;
6602 fwrite (m
, nbytes
, 1, stderr
);
6603 if (cursor_in_echo_area
== 0)
6604 fprintf (stderr
, "\n");
6607 /* A null message buffer means that the frame hasn't really been
6608 initialized yet. Error messages get reported properly by
6609 cmd_error, so this must be just an informative message; toss it. */
6610 else if (INTERACTIVE
6611 && sf
->glyphs_initialized_p
6612 && FRAME_MESSAGE_BUF (sf
))
6614 Lisp_Object mini_window
;
6617 /* Get the frame containing the mini-buffer
6618 that the selected frame is using. */
6619 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
6620 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
6622 FRAME_SAMPLE_VISIBILITY (f
);
6623 if (FRAME_VISIBLE_P (sf
)
6624 && ! FRAME_VISIBLE_P (f
))
6625 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
6629 set_message (m
, Qnil
, nbytes
, multibyte
);
6630 if (minibuffer_auto_raise
)
6631 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
6634 clear_message (1, 1);
6636 do_pending_window_change (0);
6637 echo_area_display (1);
6638 do_pending_window_change (0);
6639 if (frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
6640 (*frame_up_to_date_hook
) (f
);
6645 /* Display an echo area message M with a specified length of NBYTES
6646 bytes. The string may include null characters. If M is not a
6647 string, clear out any existing message, and let the mini-buffer
6648 text show through. */
6651 message3 (m
, nbytes
, multibyte
)
6656 struct gcpro gcpro1
;
6660 /* First flush out any partial line written with print. */
6661 message_log_maybe_newline ();
6663 message_dolog (SDATA (m
), nbytes
, 1, multibyte
);
6664 message3_nolog (m
, nbytes
, multibyte
);
6670 /* The non-logging version of message3. */
6673 message3_nolog (m
, nbytes
, multibyte
)
6675 int nbytes
, multibyte
;
6677 struct frame
*sf
= SELECTED_FRAME ();
6678 message_enable_multibyte
= multibyte
;
6682 if (noninteractive_need_newline
)
6683 putc ('\n', stderr
);
6684 noninteractive_need_newline
= 0;
6686 fwrite (SDATA (m
), nbytes
, 1, stderr
);
6687 if (cursor_in_echo_area
== 0)
6688 fprintf (stderr
, "\n");
6691 /* A null message buffer means that the frame hasn't really been
6692 initialized yet. Error messages get reported properly by
6693 cmd_error, so this must be just an informative message; toss it. */
6694 else if (INTERACTIVE
6695 && sf
->glyphs_initialized_p
6696 && FRAME_MESSAGE_BUF (sf
))
6698 Lisp_Object mini_window
;
6702 /* Get the frame containing the mini-buffer
6703 that the selected frame is using. */
6704 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
6705 frame
= XWINDOW (mini_window
)->frame
;
6708 FRAME_SAMPLE_VISIBILITY (f
);
6709 if (FRAME_VISIBLE_P (sf
)
6710 && !FRAME_VISIBLE_P (f
))
6711 Fmake_frame_visible (frame
);
6713 if (STRINGP (m
) && SCHARS (m
) > 0)
6715 set_message (NULL
, m
, nbytes
, multibyte
);
6716 if (minibuffer_auto_raise
)
6717 Fraise_frame (frame
);
6720 clear_message (1, 1);
6722 do_pending_window_change (0);
6723 echo_area_display (1);
6724 do_pending_window_change (0);
6725 if (frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
6726 (*frame_up_to_date_hook
) (f
);
6731 /* Display a null-terminated echo area message M. If M is 0, clear
6732 out any existing message, and let the mini-buffer text show through.
6734 The buffer M must continue to exist until after the echo area gets
6735 cleared or some other message gets displayed there. Do not pass
6736 text that is stored in a Lisp string. Do not pass text in a buffer
6737 that was alloca'd. */
6743 message2 (m
, (m
? strlen (m
) : 0), 0);
6747 /* The non-logging counterpart of message1. */
6753 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
6756 /* Display a message M which contains a single %s
6757 which gets replaced with STRING. */
6760 message_with_string (m
, string
, log
)
6765 CHECK_STRING (string
);
6771 if (noninteractive_need_newline
)
6772 putc ('\n', stderr
);
6773 noninteractive_need_newline
= 0;
6774 fprintf (stderr
, m
, SDATA (string
));
6775 if (cursor_in_echo_area
== 0)
6776 fprintf (stderr
, "\n");
6780 else if (INTERACTIVE
)
6782 /* The frame whose minibuffer we're going to display the message on.
6783 It may be larger than the selected frame, so we need
6784 to use its buffer, not the selected frame's buffer. */
6785 Lisp_Object mini_window
;
6786 struct frame
*f
, *sf
= SELECTED_FRAME ();
6788 /* Get the frame containing the minibuffer
6789 that the selected frame is using. */
6790 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
6791 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
6793 /* A null message buffer means that the frame hasn't really been
6794 initialized yet. Error messages get reported properly by
6795 cmd_error, so this must be just an informative message; toss it. */
6796 if (FRAME_MESSAGE_BUF (f
))
6798 Lisp_Object args
[2], message
;
6799 struct gcpro gcpro1
, gcpro2
;
6801 args
[0] = build_string (m
);
6802 args
[1] = message
= string
;
6803 GCPRO2 (args
[0], message
);
6806 message
= Fformat (2, args
);
6809 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
6811 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
6815 /* Print should start at the beginning of the message
6816 buffer next time. */
6817 message_buf_print
= 0;
6823 /* Dump an informative message to the minibuf. If M is 0, clear out
6824 any existing message, and let the mini-buffer text show through. */
6828 message (m
, a1
, a2
, a3
)
6830 EMACS_INT a1
, a2
, a3
;
6836 if (noninteractive_need_newline
)
6837 putc ('\n', stderr
);
6838 noninteractive_need_newline
= 0;
6839 fprintf (stderr
, m
, a1
, a2
, a3
);
6840 if (cursor_in_echo_area
== 0)
6841 fprintf (stderr
, "\n");
6845 else if (INTERACTIVE
)
6847 /* The frame whose mini-buffer we're going to display the message
6848 on. It may be larger than the selected frame, so we need to
6849 use its buffer, not the selected frame's buffer. */
6850 Lisp_Object mini_window
;
6851 struct frame
*f
, *sf
= SELECTED_FRAME ();
6853 /* Get the frame containing the mini-buffer
6854 that the selected frame is using. */
6855 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
6856 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
6858 /* A null message buffer means that the frame hasn't really been
6859 initialized yet. Error messages get reported properly by
6860 cmd_error, so this must be just an informative message; toss
6862 if (FRAME_MESSAGE_BUF (f
))
6873 len
= doprnt (FRAME_MESSAGE_BUF (f
),
6874 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
6876 len
= doprnt (FRAME_MESSAGE_BUF (f
),
6877 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3,
6879 #endif /* NO_ARG_ARRAY */
6881 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
6886 /* Print should start at the beginning of the message
6887 buffer next time. */
6888 message_buf_print
= 0;
6894 /* The non-logging version of message. */
6897 message_nolog (m
, a1
, a2
, a3
)
6899 EMACS_INT a1
, a2
, a3
;
6901 Lisp_Object old_log_max
;
6902 old_log_max
= Vmessage_log_max
;
6903 Vmessage_log_max
= Qnil
;
6904 message (m
, a1
, a2
, a3
);
6905 Vmessage_log_max
= old_log_max
;
6909 /* Display the current message in the current mini-buffer. This is
6910 only called from error handlers in process.c, and is not time
6916 if (!NILP (echo_area_buffer
[0]))
6919 string
= Fcurrent_message ();
6920 message3 (string
, SBYTES (string
),
6921 !NILP (current_buffer
->enable_multibyte_characters
));
6926 /* Make sure echo area buffers in `echo_buffers' are live.
6927 If they aren't, make new ones. */
6930 ensure_echo_area_buffers ()
6934 for (i
= 0; i
< 2; ++i
)
6935 if (!BUFFERP (echo_buffer
[i
])
6936 || NILP (XBUFFER (echo_buffer
[i
])->name
))
6939 Lisp_Object old_buffer
;
6942 old_buffer
= echo_buffer
[i
];
6943 sprintf (name
, " *Echo Area %d*", i
);
6944 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
6945 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
6947 for (j
= 0; j
< 2; ++j
)
6948 if (EQ (old_buffer
, echo_area_buffer
[j
]))
6949 echo_area_buffer
[j
] = echo_buffer
[i
];
6954 /* Call FN with args A1..A4 with either the current or last displayed
6955 echo_area_buffer as current buffer.
6957 WHICH zero means use the current message buffer
6958 echo_area_buffer[0]. If that is nil, choose a suitable buffer
6959 from echo_buffer[] and clear it.
6961 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
6962 suitable buffer from echo_buffer[] and clear it.
6964 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
6965 that the current message becomes the last displayed one, make
6966 choose a suitable buffer for echo_area_buffer[0], and clear it.
6968 Value is what FN returns. */
6971 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
)
6974 int (*fn
) P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
6980 int this_one
, the_other
, clear_buffer_p
, rc
;
6981 int count
= SPECPDL_INDEX ();
6983 /* If buffers aren't live, make new ones. */
6984 ensure_echo_area_buffers ();
6989 this_one
= 0, the_other
= 1;
6991 this_one
= 1, the_other
= 0;
6994 this_one
= 0, the_other
= 1;
6997 /* We need a fresh one in case the current echo buffer equals
6998 the one containing the last displayed echo area message. */
6999 if (!NILP (echo_area_buffer
[this_one
])
7000 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
7001 echo_area_buffer
[this_one
] = Qnil
;
7004 /* Choose a suitable buffer from echo_buffer[] is we don't
7006 if (NILP (echo_area_buffer
[this_one
]))
7008 echo_area_buffer
[this_one
]
7009 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
7010 ? echo_buffer
[the_other
]
7011 : echo_buffer
[this_one
]);
7015 buffer
= echo_area_buffer
[this_one
];
7017 /* Don't get confused by reusing the buffer used for echoing
7018 for a different purpose. */
7019 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
7022 record_unwind_protect (unwind_with_echo_area_buffer
,
7023 with_echo_area_buffer_unwind_data (w
));
7025 /* Make the echo area buffer current. Note that for display
7026 purposes, it is not necessary that the displayed window's buffer
7027 == current_buffer, except for text property lookup. So, let's
7028 only set that buffer temporarily here without doing a full
7029 Fset_window_buffer. We must also change w->pointm, though,
7030 because otherwise an assertions in unshow_buffer fails, and Emacs
7032 set_buffer_internal_1 (XBUFFER (buffer
));
7036 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
7039 current_buffer
->undo_list
= Qt
;
7040 current_buffer
->read_only
= Qnil
;
7041 specbind (Qinhibit_read_only
, Qt
);
7042 specbind (Qinhibit_modification_hooks
, Qt
);
7044 if (clear_buffer_p
&& Z
> BEG
)
7047 xassert (BEGV
>= BEG
);
7048 xassert (ZV
<= Z
&& ZV
>= BEGV
);
7050 rc
= fn (a1
, a2
, a3
, a4
);
7052 xassert (BEGV
>= BEG
);
7053 xassert (ZV
<= Z
&& ZV
>= BEGV
);
7055 unbind_to (count
, Qnil
);
7060 /* Save state that should be preserved around the call to the function
7061 FN called in with_echo_area_buffer. */
7064 with_echo_area_buffer_unwind_data (w
)
7070 /* Reduce consing by keeping one vector in
7071 Vwith_echo_area_save_vector. */
7072 vector
= Vwith_echo_area_save_vector
;
7073 Vwith_echo_area_save_vector
= Qnil
;
7076 vector
= Fmake_vector (make_number (7), Qnil
);
7078 XSETBUFFER (AREF (vector
, i
), current_buffer
); ++i
;
7079 AREF (vector
, i
) = Vdeactivate_mark
, ++i
;
7080 AREF (vector
, i
) = make_number (windows_or_buffers_changed
), ++i
;
7084 XSETWINDOW (AREF (vector
, i
), w
); ++i
;
7085 AREF (vector
, i
) = w
->buffer
; ++i
;
7086 AREF (vector
, i
) = make_number (XMARKER (w
->pointm
)->charpos
); ++i
;
7087 AREF (vector
, i
) = make_number (XMARKER (w
->pointm
)->bytepos
); ++i
;
7092 for (; i
< end
; ++i
)
7093 AREF (vector
, i
) = Qnil
;
7096 xassert (i
== ASIZE (vector
));
7101 /* Restore global state from VECTOR which was created by
7102 with_echo_area_buffer_unwind_data. */
7105 unwind_with_echo_area_buffer (vector
)
7108 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
7109 Vdeactivate_mark
= AREF (vector
, 1);
7110 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
7112 if (WINDOWP (AREF (vector
, 3)))
7115 Lisp_Object buffer
, charpos
, bytepos
;
7117 w
= XWINDOW (AREF (vector
, 3));
7118 buffer
= AREF (vector
, 4);
7119 charpos
= AREF (vector
, 5);
7120 bytepos
= AREF (vector
, 6);
7123 set_marker_both (w
->pointm
, buffer
,
7124 XFASTINT (charpos
), XFASTINT (bytepos
));
7127 Vwith_echo_area_save_vector
= vector
;
7132 /* Set up the echo area for use by print functions. MULTIBYTE_P
7133 non-zero means we will print multibyte. */
7136 setup_echo_area_for_printing (multibyte_p
)
7139 /* If we can't find an echo area any more, exit. */
7140 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
7143 ensure_echo_area_buffers ();
7145 if (!message_buf_print
)
7147 /* A message has been output since the last time we printed.
7148 Choose a fresh echo area buffer. */
7149 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
7150 echo_area_buffer
[0] = echo_buffer
[1];
7152 echo_area_buffer
[0] = echo_buffer
[0];
7154 /* Switch to that buffer and clear it. */
7155 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
7156 current_buffer
->truncate_lines
= Qnil
;
7160 int count
= SPECPDL_INDEX ();
7161 specbind (Qinhibit_read_only
, Qt
);
7162 /* Note that undo recording is always disabled. */
7164 unbind_to (count
, Qnil
);
7166 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
7168 /* Set up the buffer for the multibyteness we need. */
7170 != !NILP (current_buffer
->enable_multibyte_characters
))
7171 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
7173 /* Raise the frame containing the echo area. */
7174 if (minibuffer_auto_raise
)
7176 struct frame
*sf
= SELECTED_FRAME ();
7177 Lisp_Object mini_window
;
7178 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7179 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
7182 message_log_maybe_newline ();
7183 message_buf_print
= 1;
7187 if (NILP (echo_area_buffer
[0]))
7189 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
7190 echo_area_buffer
[0] = echo_buffer
[1];
7192 echo_area_buffer
[0] = echo_buffer
[0];
7195 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
7197 /* Someone switched buffers between print requests. */
7198 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
7199 current_buffer
->truncate_lines
= Qnil
;
7205 /* Display an echo area message in window W. Value is non-zero if W's
7206 height is changed. If display_last_displayed_message_p is
7207 non-zero, display the message that was last displayed, otherwise
7208 display the current message. */
7211 display_echo_area (w
)
7214 int i
, no_message_p
, window_height_changed_p
, count
;
7216 /* Temporarily disable garbage collections while displaying the echo
7217 area. This is done because a GC can print a message itself.
7218 That message would modify the echo area buffer's contents while a
7219 redisplay of the buffer is going on, and seriously confuse
7221 count
= inhibit_garbage_collection ();
7223 /* If there is no message, we must call display_echo_area_1
7224 nevertheless because it resizes the window. But we will have to
7225 reset the echo_area_buffer in question to nil at the end because
7226 with_echo_area_buffer will sets it to an empty buffer. */
7227 i
= display_last_displayed_message_p
? 1 : 0;
7228 no_message_p
= NILP (echo_area_buffer
[i
]);
7230 window_height_changed_p
7231 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
7232 display_echo_area_1
,
7233 (EMACS_INT
) w
, Qnil
, 0, 0);
7236 echo_area_buffer
[i
] = Qnil
;
7238 unbind_to (count
, Qnil
);
7239 return window_height_changed_p
;
7243 /* Helper for display_echo_area. Display the current buffer which
7244 contains the current echo area message in window W, a mini-window,
7245 a pointer to which is passed in A1. A2..A4 are currently not used.
7246 Change the height of W so that all of the message is displayed.
7247 Value is non-zero if height of W was changed. */
7250 display_echo_area_1 (a1
, a2
, a3
, a4
)
7255 struct window
*w
= (struct window
*) a1
;
7257 struct text_pos start
;
7258 int window_height_changed_p
= 0;
7260 /* Do this before displaying, so that we have a large enough glyph
7261 matrix for the display. */
7262 window_height_changed_p
= resize_mini_window (w
, 0);
7265 clear_glyph_matrix (w
->desired_matrix
);
7266 XSETWINDOW (window
, w
);
7267 SET_TEXT_POS (start
, BEG
, BEG_BYTE
);
7268 try_window (window
, start
);
7270 return window_height_changed_p
;
7274 /* Resize the echo area window to exactly the size needed for the
7275 currently displayed message, if there is one. If a mini-buffer
7276 is active, don't shrink it. */
7279 resize_echo_area_exactly ()
7281 if (BUFFERP (echo_area_buffer
[0])
7282 && WINDOWP (echo_area_window
))
7284 struct window
*w
= XWINDOW (echo_area_window
);
7286 Lisp_Object resize_exactly
;
7288 if (minibuf_level
== 0)
7289 resize_exactly
= Qt
;
7291 resize_exactly
= Qnil
;
7293 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
7294 (EMACS_INT
) w
, resize_exactly
, 0, 0);
7297 ++windows_or_buffers_changed
;
7298 ++update_mode_lines
;
7299 redisplay_internal (0);
7305 /* Callback function for with_echo_area_buffer, when used from
7306 resize_echo_area_exactly. A1 contains a pointer to the window to
7307 resize, EXACTLY non-nil means resize the mini-window exactly to the
7308 size of the text displayed. A3 and A4 are not used. Value is what
7309 resize_mini_window returns. */
7312 resize_mini_window_1 (a1
, exactly
, a3
, a4
)
7314 Lisp_Object exactly
;
7317 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
7321 /* Resize mini-window W to fit the size of its contents. EXACT:P
7322 means size the window exactly to the size needed. Otherwise, it's
7323 only enlarged until W's buffer is empty. Value is non-zero if
7324 the window height has been changed. */
7327 resize_mini_window (w
, exact_p
)
7331 struct frame
*f
= XFRAME (w
->frame
);
7332 int window_height_changed_p
= 0;
7334 xassert (MINI_WINDOW_P (w
));
7336 /* Don't resize windows while redisplaying a window; it would
7337 confuse redisplay functions when the size of the window they are
7338 displaying changes from under them. Such a resizing can happen,
7339 for instance, when which-func prints a long message while
7340 we are running fontification-functions. We're running these
7341 functions with safe_call which binds inhibit-redisplay to t. */
7342 if (!NILP (Vinhibit_redisplay
))
7345 /* Nil means don't try to resize. */
7346 if (NILP (Vresize_mini_windows
)
7347 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
7350 if (!FRAME_MINIBUF_ONLY_P (f
))
7353 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
7354 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
7355 int height
, max_height
;
7356 int unit
= FRAME_LINE_HEIGHT (f
);
7357 struct text_pos start
;
7358 struct buffer
*old_current_buffer
= NULL
;
7360 if (current_buffer
!= XBUFFER (w
->buffer
))
7362 old_current_buffer
= current_buffer
;
7363 set_buffer_internal (XBUFFER (w
->buffer
));
7366 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
7368 /* Compute the max. number of lines specified by the user. */
7369 if (FLOATP (Vmax_mini_window_height
))
7370 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
7371 else if (INTEGERP (Vmax_mini_window_height
))
7372 max_height
= XINT (Vmax_mini_window_height
);
7374 max_height
= total_height
/ 4;
7376 /* Correct that max. height if it's bogus. */
7377 max_height
= max (1, max_height
);
7378 max_height
= min (total_height
, max_height
);
7380 /* Find out the height of the text in the window. */
7381 if (it
.truncate_lines_p
)
7386 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
7387 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
7388 height
= it
.current_y
+ last_height
;
7390 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
7391 height
-= it
.extra_line_spacing
;
7392 height
= (height
+ unit
- 1) / unit
;
7395 /* Compute a suitable window start. */
7396 if (height
> max_height
)
7398 height
= max_height
;
7399 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
7400 move_it_vertically_backward (&it
, (height
- 1) * unit
);
7401 start
= it
.current
.pos
;
7404 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
7405 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
7407 if (EQ (Vresize_mini_windows
, Qgrow_only
))
7409 /* Let it grow only, until we display an empty message, in which
7410 case the window shrinks again. */
7411 if (height
> WINDOW_TOTAL_LINES (w
))
7413 int old_height
= WINDOW_TOTAL_LINES (w
);
7414 freeze_window_starts (f
, 1);
7415 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
7416 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
7418 else if (height
< WINDOW_TOTAL_LINES (w
)
7419 && (exact_p
|| BEGV
== ZV
))
7421 int old_height
= WINDOW_TOTAL_LINES (w
);
7422 freeze_window_starts (f
, 0);
7423 shrink_mini_window (w
);
7424 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
7429 /* Always resize to exact size needed. */
7430 if (height
> WINDOW_TOTAL_LINES (w
))
7432 int old_height
= WINDOW_TOTAL_LINES (w
);
7433 freeze_window_starts (f
, 1);
7434 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
7435 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
7437 else if (height
< WINDOW_TOTAL_LINES (w
))
7439 int old_height
= WINDOW_TOTAL_LINES (w
);
7440 freeze_window_starts (f
, 0);
7441 shrink_mini_window (w
);
7445 freeze_window_starts (f
, 1);
7446 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
7449 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
7453 if (old_current_buffer
)
7454 set_buffer_internal (old_current_buffer
);
7457 return window_height_changed_p
;
7461 /* Value is the current message, a string, or nil if there is no
7469 if (NILP (echo_area_buffer
[0]))
7473 with_echo_area_buffer (0, 0, current_message_1
,
7474 (EMACS_INT
) &msg
, Qnil
, 0, 0);
7476 echo_area_buffer
[0] = Qnil
;
7484 current_message_1 (a1
, a2
, a3
, a4
)
7489 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
7492 *msg
= make_buffer_string (BEG
, Z
, 1);
7499 /* Push the current message on Vmessage_stack for later restauration
7500 by restore_message. Value is non-zero if the current message isn't
7501 empty. This is a relatively infrequent operation, so it's not
7502 worth optimizing. */
7508 msg
= current_message ();
7509 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
7510 return STRINGP (msg
);
7514 /* Restore message display from the top of Vmessage_stack. */
7521 xassert (CONSP (Vmessage_stack
));
7522 msg
= XCAR (Vmessage_stack
);
7524 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
7526 message3_nolog (msg
, 0, 0);
7530 /* Handler for record_unwind_protect calling pop_message. */
7533 pop_message_unwind (dummy
)
7540 /* Pop the top-most entry off Vmessage_stack. */
7545 xassert (CONSP (Vmessage_stack
));
7546 Vmessage_stack
= XCDR (Vmessage_stack
);
7550 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
7551 exits. If the stack is not empty, we have a missing pop_message
7555 check_message_stack ()
7557 if (!NILP (Vmessage_stack
))
7562 /* Truncate to NCHARS what will be displayed in the echo area the next
7563 time we display it---but don't redisplay it now. */
7566 truncate_echo_area (nchars
)
7570 echo_area_buffer
[0] = Qnil
;
7571 /* A null message buffer means that the frame hasn't really been
7572 initialized yet. Error messages get reported properly by
7573 cmd_error, so this must be just an informative message; toss it. */
7574 else if (!noninteractive
7576 && !NILP (echo_area_buffer
[0]))
7578 struct frame
*sf
= SELECTED_FRAME ();
7579 if (FRAME_MESSAGE_BUF (sf
))
7580 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
7585 /* Helper function for truncate_echo_area. Truncate the current
7586 message to at most NCHARS characters. */
7589 truncate_message_1 (nchars
, a2
, a3
, a4
)
7594 if (BEG
+ nchars
< Z
)
7595 del_range (BEG
+ nchars
, Z
);
7597 echo_area_buffer
[0] = Qnil
;
7602 /* Set the current message to a substring of S or STRING.
7604 If STRING is a Lisp string, set the message to the first NBYTES
7605 bytes from STRING. NBYTES zero means use the whole string. If
7606 STRING is multibyte, the message will be displayed multibyte.
7608 If S is not null, set the message to the first LEN bytes of S. LEN
7609 zero means use the whole string. MULTIBYTE_P non-zero means S is
7610 multibyte. Display the message multibyte in that case. */
7613 set_message (s
, string
, nbytes
, multibyte_p
)
7616 int nbytes
, multibyte_p
;
7618 message_enable_multibyte
7619 = ((s
&& multibyte_p
)
7620 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
7622 with_echo_area_buffer (0, -1, set_message_1
,
7623 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
7624 message_buf_print
= 0;
7625 help_echo_showing_p
= 0;
7629 /* Helper function for set_message. Arguments have the same meaning
7630 as there, with A1 corresponding to S and A2 corresponding to STRING
7631 This function is called with the echo area buffer being
7635 set_message_1 (a1
, a2
, nbytes
, multibyte_p
)
7638 EMACS_INT nbytes
, multibyte_p
;
7640 const char *s
= (const char *) a1
;
7641 Lisp_Object string
= a2
;
7645 /* Change multibyteness of the echo buffer appropriately. */
7646 if (message_enable_multibyte
7647 != !NILP (current_buffer
->enable_multibyte_characters
))
7648 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
7650 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
7652 /* Insert new message at BEG. */
7653 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
7655 if (STRINGP (string
))
7660 nbytes
= SBYTES (string
);
7661 nchars
= string_byte_to_char (string
, nbytes
);
7663 /* This function takes care of single/multibyte conversion. We
7664 just have to ensure that the echo area buffer has the right
7665 setting of enable_multibyte_characters. */
7666 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
7671 nbytes
= strlen (s
);
7673 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
7675 /* Convert from multi-byte to single-byte. */
7677 unsigned char work
[1];
7679 /* Convert a multibyte string to single-byte. */
7680 for (i
= 0; i
< nbytes
; i
+= n
)
7682 c
= string_char_and_length (s
+ i
, nbytes
- i
, &n
);
7683 work
[0] = (SINGLE_BYTE_CHAR_P (c
)
7685 : multibyte_char_to_unibyte (c
, Qnil
));
7686 insert_1_both (work
, 1, 1, 1, 0, 0);
7689 else if (!multibyte_p
7690 && !NILP (current_buffer
->enable_multibyte_characters
))
7692 /* Convert from single-byte to multi-byte. */
7694 const unsigned char *msg
= (const unsigned char *) s
;
7695 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7697 /* Convert a single-byte string to multibyte. */
7698 for (i
= 0; i
< nbytes
; i
++)
7700 c
= unibyte_char_to_multibyte (msg
[i
]);
7701 n
= CHAR_STRING (c
, str
);
7702 insert_1_both (str
, 1, n
, 1, 0, 0);
7706 insert_1 (s
, nbytes
, 1, 0, 0);
7713 /* Clear messages. CURRENT_P non-zero means clear the current
7714 message. LAST_DISPLAYED_P non-zero means clear the message
7718 clear_message (current_p
, last_displayed_p
)
7719 int current_p
, last_displayed_p
;
7723 echo_area_buffer
[0] = Qnil
;
7724 message_cleared_p
= 1;
7727 if (last_displayed_p
)
7728 echo_area_buffer
[1] = Qnil
;
7730 message_buf_print
= 0;
7733 /* Clear garbaged frames.
7735 This function is used where the old redisplay called
7736 redraw_garbaged_frames which in turn called redraw_frame which in
7737 turn called clear_frame. The call to clear_frame was a source of
7738 flickering. I believe a clear_frame is not necessary. It should
7739 suffice in the new redisplay to invalidate all current matrices,
7740 and ensure a complete redisplay of all windows. */
7743 clear_garbaged_frames ()
7747 Lisp_Object tail
, frame
;
7748 int changed_count
= 0;
7750 FOR_EACH_FRAME (tail
, frame
)
7752 struct frame
*f
= XFRAME (frame
);
7754 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
7758 Fredraw_frame (frame
);
7759 f
->force_flush_display_p
= 1;
7761 clear_current_matrices (f
);
7770 ++windows_or_buffers_changed
;
7775 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
7776 is non-zero update selected_frame. Value is non-zero if the
7777 mini-windows height has been changed. */
7780 echo_area_display (update_frame_p
)
7783 Lisp_Object mini_window
;
7786 int window_height_changed_p
= 0;
7787 struct frame
*sf
= SELECTED_FRAME ();
7789 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7790 w
= XWINDOW (mini_window
);
7791 f
= XFRAME (WINDOW_FRAME (w
));
7793 /* Don't display if frame is invisible or not yet initialized. */
7794 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
7797 /* The terminal frame is used as the first Emacs frame on the Mac OS. */
7799 #ifdef HAVE_WINDOW_SYSTEM
7800 /* When Emacs starts, selected_frame may be a visible terminal
7801 frame, even if we run under a window system. If we let this
7802 through, a message would be displayed on the terminal. */
7803 if (EQ (selected_frame
, Vterminal_frame
)
7804 && !NILP (Vwindow_system
))
7806 #endif /* HAVE_WINDOW_SYSTEM */
7809 /* Redraw garbaged frames. */
7811 clear_garbaged_frames ();
7813 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
7815 echo_area_window
= mini_window
;
7816 window_height_changed_p
= display_echo_area (w
);
7817 w
->must_be_updated_p
= 1;
7819 /* Update the display, unless called from redisplay_internal.
7820 Also don't update the screen during redisplay itself. The
7821 update will happen at the end of redisplay, and an update
7822 here could cause confusion. */
7823 if (update_frame_p
&& !redisplaying_p
)
7827 /* If the display update has been interrupted by pending
7828 input, update mode lines in the frame. Due to the
7829 pending input, it might have been that redisplay hasn't
7830 been called, so that mode lines above the echo area are
7831 garbaged. This looks odd, so we prevent it here. */
7832 if (!display_completed
)
7833 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
7835 if (window_height_changed_p
7836 /* Don't do this if Emacs is shutting down. Redisplay
7837 needs to run hooks. */
7838 && !NILP (Vrun_hooks
))
7840 /* Must update other windows. Likewise as in other
7841 cases, don't let this update be interrupted by
7843 int count
= SPECPDL_INDEX ();
7844 specbind (Qredisplay_dont_pause
, Qt
);
7845 windows_or_buffers_changed
= 1;
7846 redisplay_internal (0);
7847 unbind_to (count
, Qnil
);
7849 else if (FRAME_WINDOW_P (f
) && n
== 0)
7851 /* Window configuration is the same as before.
7852 Can do with a display update of the echo area,
7853 unless we displayed some mode lines. */
7854 update_single_window (w
, 1);
7855 rif
->flush_display (f
);
7858 update_frame (f
, 1, 1);
7860 /* If cursor is in the echo area, make sure that the next
7861 redisplay displays the minibuffer, so that the cursor will
7862 be replaced with what the minibuffer wants. */
7863 if (cursor_in_echo_area
)
7864 ++windows_or_buffers_changed
;
7867 else if (!EQ (mini_window
, selected_window
))
7868 windows_or_buffers_changed
++;
7870 /* Last displayed message is now the current message. */
7871 echo_area_buffer
[1] = echo_area_buffer
[0];
7873 /* Prevent redisplay optimization in redisplay_internal by resetting
7874 this_line_start_pos. This is done because the mini-buffer now
7875 displays the message instead of its buffer text. */
7876 if (EQ (mini_window
, selected_window
))
7877 CHARPOS (this_line_start_pos
) = 0;
7879 return window_height_changed_p
;
7884 /***********************************************************************
7886 ***********************************************************************/
7889 /* The frame title buffering code is also used by Fformat_mode_line.
7890 So it is not conditioned by HAVE_WINDOW_SYSTEM. */
7892 /* A buffer for constructing frame titles in it; allocated from the
7893 heap in init_xdisp and resized as needed in store_frame_title_char. */
7895 static char *frame_title_buf
;
7897 /* The buffer's end, and a current output position in it. */
7899 static char *frame_title_buf_end
;
7900 static char *frame_title_ptr
;
7903 /* Store a single character C for the frame title in frame_title_buf.
7904 Re-allocate frame_title_buf if necessary. */
7908 store_frame_title_char (char c
)
7910 store_frame_title_char (c
)
7914 /* If output position has reached the end of the allocated buffer,
7915 double the buffer's size. */
7916 if (frame_title_ptr
== frame_title_buf_end
)
7918 int len
= frame_title_ptr
- frame_title_buf
;
7919 int new_size
= 2 * len
* sizeof *frame_title_buf
;
7920 frame_title_buf
= (char *) xrealloc (frame_title_buf
, new_size
);
7921 frame_title_buf_end
= frame_title_buf
+ new_size
;
7922 frame_title_ptr
= frame_title_buf
+ len
;
7925 *frame_title_ptr
++ = c
;
7929 /* Store part of a frame title in frame_title_buf, beginning at
7930 frame_title_ptr. STR is the string to store. Do not copy
7931 characters that yield more columns than PRECISION; PRECISION <= 0
7932 means copy the whole string. Pad with spaces until FIELD_WIDTH
7933 number of characters have been copied; FIELD_WIDTH <= 0 means don't
7934 pad. Called from display_mode_element when it is used to build a
7938 store_frame_title (str
, field_width
, precision
)
7939 const unsigned char *str
;
7940 int field_width
, precision
;
7945 /* Copy at most PRECISION chars from STR. */
7946 nbytes
= strlen (str
);
7947 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
7949 store_frame_title_char (*str
++);
7951 /* Fill up with spaces until FIELD_WIDTH reached. */
7952 while (field_width
> 0
7955 store_frame_title_char (' ');
7962 #ifdef HAVE_WINDOW_SYSTEM
7964 /* Set the title of FRAME, if it has changed. The title format is
7965 Vicon_title_format if FRAME is iconified, otherwise it is
7966 frame_title_format. */
7969 x_consider_frame_title (frame
)
7972 struct frame
*f
= XFRAME (frame
);
7974 if (FRAME_WINDOW_P (f
)
7975 || FRAME_MINIBUF_ONLY_P (f
)
7976 || f
->explicit_name
)
7978 /* Do we have more than one visible frame on this X display? */
7981 struct buffer
*obuf
;
7985 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
7987 Lisp_Object other_frame
= XCAR (tail
);
7988 struct frame
*tf
= XFRAME (other_frame
);
7991 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
7992 && !FRAME_MINIBUF_ONLY_P (tf
)
7993 && !EQ (other_frame
, tip_frame
)
7994 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
7998 /* Set global variable indicating that multiple frames exist. */
7999 multiple_frames
= CONSP (tail
);
8001 /* Switch to the buffer of selected window of the frame. Set up
8002 frame_title_ptr so that display_mode_element will output into it;
8003 then display the title. */
8004 obuf
= current_buffer
;
8005 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
8006 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
8007 frame_title_ptr
= frame_title_buf
;
8008 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
8009 NULL
, DEFAULT_FACE_ID
);
8010 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
8011 len
= frame_title_ptr
- frame_title_buf
;
8012 frame_title_ptr
= NULL
;
8013 set_buffer_internal_1 (obuf
);
8015 /* Set the title only if it's changed. This avoids consing in
8016 the common case where it hasn't. (If it turns out that we've
8017 already wasted too much time by walking through the list with
8018 display_mode_element, then we might need to optimize at a
8019 higher level than this.) */
8020 if (! STRINGP (f
->name
)
8021 || SBYTES (f
->name
) != len
8022 || bcmp (frame_title_buf
, SDATA (f
->name
), len
) != 0)
8023 x_implicitly_set_name (f
, make_string (frame_title_buf
, len
), Qnil
);
8027 #endif /* not HAVE_WINDOW_SYSTEM */
8032 /***********************************************************************
8034 ***********************************************************************/
8037 /* Prepare for redisplay by updating menu-bar item lists when
8038 appropriate. This can call eval. */
8041 prepare_menu_bars ()
8044 struct gcpro gcpro1
, gcpro2
;
8046 Lisp_Object tooltip_frame
;
8048 #ifdef HAVE_WINDOW_SYSTEM
8049 tooltip_frame
= tip_frame
;
8051 tooltip_frame
= Qnil
;
8054 /* Update all frame titles based on their buffer names, etc. We do
8055 this before the menu bars so that the buffer-menu will show the
8056 up-to-date frame titles. */
8057 #ifdef HAVE_WINDOW_SYSTEM
8058 if (windows_or_buffers_changed
|| update_mode_lines
)
8060 Lisp_Object tail
, frame
;
8062 FOR_EACH_FRAME (tail
, frame
)
8065 if (!EQ (frame
, tooltip_frame
)
8066 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
8067 x_consider_frame_title (frame
);
8070 #endif /* HAVE_WINDOW_SYSTEM */
8072 /* Update the menu bar item lists, if appropriate. This has to be
8073 done before any actual redisplay or generation of display lines. */
8074 all_windows
= (update_mode_lines
8075 || buffer_shared
> 1
8076 || windows_or_buffers_changed
);
8079 Lisp_Object tail
, frame
;
8080 int count
= SPECPDL_INDEX ();
8082 record_unwind_protect (Fset_match_data
, Fmatch_data (Qnil
, Qnil
));
8084 FOR_EACH_FRAME (tail
, frame
)
8088 /* Ignore tooltip frame. */
8089 if (EQ (frame
, tooltip_frame
))
8092 /* If a window on this frame changed size, report that to
8093 the user and clear the size-change flag. */
8094 if (FRAME_WINDOW_SIZES_CHANGED (f
))
8096 Lisp_Object functions
;
8098 /* Clear flag first in case we get an error below. */
8099 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
8100 functions
= Vwindow_size_change_functions
;
8101 GCPRO2 (tail
, functions
);
8103 while (CONSP (functions
))
8105 call1 (XCAR (functions
), frame
);
8106 functions
= XCDR (functions
);
8112 update_menu_bar (f
, 0);
8113 #ifdef HAVE_WINDOW_SYSTEM
8114 update_tool_bar (f
, 0);
8119 unbind_to (count
, Qnil
);
8123 struct frame
*sf
= SELECTED_FRAME ();
8124 update_menu_bar (sf
, 1);
8125 #ifdef HAVE_WINDOW_SYSTEM
8126 update_tool_bar (sf
, 1);
8130 /* Motif needs this. See comment in xmenu.c. Turn it off when
8131 pending_menu_activation is not defined. */
8132 #ifdef USE_X_TOOLKIT
8133 pending_menu_activation
= 0;
8138 /* Update the menu bar item list for frame F. This has to be done
8139 before we start to fill in any display lines, because it can call
8142 If SAVE_MATCH_DATA is non-zero, we must save and restore it here. */
8145 update_menu_bar (f
, save_match_data
)
8147 int save_match_data
;
8150 register struct window
*w
;
8152 /* If called recursively during a menu update, do nothing. This can
8153 happen when, for instance, an activate-menubar-hook causes a
8155 if (inhibit_menubar_update
)
8158 window
= FRAME_SELECTED_WINDOW (f
);
8159 w
= XWINDOW (window
);
8161 #if 0 /* The if statement below this if statement used to include the
8162 condition !NILP (w->update_mode_line), rather than using
8163 update_mode_lines directly, and this if statement may have
8164 been added to make that condition work. Now the if
8165 statement below matches its comment, this isn't needed. */
8166 if (update_mode_lines
)
8167 w
->update_mode_line
= Qt
;
8170 if (FRAME_WINDOW_P (f
)
8172 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
8173 || defined (USE_GTK)
8174 FRAME_EXTERNAL_MENU_BAR (f
)
8176 FRAME_MENU_BAR_LINES (f
) > 0
8178 : FRAME_MENU_BAR_LINES (f
) > 0)
8180 /* If the user has switched buffers or windows, we need to
8181 recompute to reflect the new bindings. But we'll
8182 recompute when update_mode_lines is set too; that means
8183 that people can use force-mode-line-update to request
8184 that the menu bar be recomputed. The adverse effect on
8185 the rest of the redisplay algorithm is about the same as
8186 windows_or_buffers_changed anyway. */
8187 if (windows_or_buffers_changed
8188 /* This used to test w->update_mode_line, but we believe
8189 there is no need to recompute the menu in that case. */
8190 || update_mode_lines
8191 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
8192 < BUF_MODIFF (XBUFFER (w
->buffer
)))
8193 != !NILP (w
->last_had_star
))
8194 || ((!NILP (Vtransient_mark_mode
)
8195 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
8196 != !NILP (w
->region_showing
)))
8198 struct buffer
*prev
= current_buffer
;
8199 int count
= SPECPDL_INDEX ();
8201 specbind (Qinhibit_menubar_update
, Qt
);
8203 set_buffer_internal_1 (XBUFFER (w
->buffer
));
8204 if (save_match_data
)
8205 record_unwind_protect (Fset_match_data
, Fmatch_data (Qnil
, Qnil
));
8206 if (NILP (Voverriding_local_map_menu_flag
))
8208 specbind (Qoverriding_terminal_local_map
, Qnil
);
8209 specbind (Qoverriding_local_map
, Qnil
);
8212 /* Run the Lucid hook. */
8213 safe_run_hooks (Qactivate_menubar_hook
);
8215 /* If it has changed current-menubar from previous value,
8216 really recompute the menu-bar from the value. */
8217 if (! NILP (Vlucid_menu_bar_dirty_flag
))
8218 call0 (Qrecompute_lucid_menubar
);
8220 safe_run_hooks (Qmenu_bar_update_hook
);
8221 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
8223 /* Redisplay the menu bar in case we changed it. */
8224 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
8225 || defined (USE_GTK)
8226 if (FRAME_WINDOW_P (f
)
8227 #if defined (MAC_OS)
8228 /* All frames on Mac OS share the same menubar. So only the
8229 selected frame should be allowed to set it. */
8230 && f
== SELECTED_FRAME ()
8233 set_frame_menubar (f
, 0, 0);
8235 /* On a terminal screen, the menu bar is an ordinary screen
8236 line, and this makes it get updated. */
8237 w
->update_mode_line
= Qt
;
8238 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || MAC_OS || USE_GTK) */
8239 /* In the non-toolkit version, the menu bar is an ordinary screen
8240 line, and this makes it get updated. */
8241 w
->update_mode_line
= Qt
;
8242 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || MAC_OS || USE_GTK) */
8244 unbind_to (count
, Qnil
);
8245 set_buffer_internal_1 (prev
);
8252 /***********************************************************************
8254 ***********************************************************************/
8256 #ifdef HAVE_WINDOW_SYSTEM
8259 Nominal cursor position -- where to draw output.
8260 HPOS and VPOS are window relative glyph matrix coordinates.
8261 X and Y are window relative pixel coordinates. */
8263 struct cursor_pos output_cursor
;
8267 Set the global variable output_cursor to CURSOR. All cursor
8268 positions are relative to updated_window. */
8271 set_output_cursor (cursor
)
8272 struct cursor_pos
*cursor
;
8274 output_cursor
.hpos
= cursor
->hpos
;
8275 output_cursor
.vpos
= cursor
->vpos
;
8276 output_cursor
.x
= cursor
->x
;
8277 output_cursor
.y
= cursor
->y
;
8282 Set a nominal cursor position.
8284 HPOS and VPOS are column/row positions in a window glyph matrix. X
8285 and Y are window text area relative pixel positions.
8287 If this is done during an update, updated_window will contain the
8288 window that is being updated and the position is the future output
8289 cursor position for that window. If updated_window is null, use
8290 selected_window and display the cursor at the given position. */
8293 x_cursor_to (vpos
, hpos
, y
, x
)
8294 int vpos
, hpos
, y
, x
;
8298 /* If updated_window is not set, work on selected_window. */
8302 w
= XWINDOW (selected_window
);
8304 /* Set the output cursor. */
8305 output_cursor
.hpos
= hpos
;
8306 output_cursor
.vpos
= vpos
;
8307 output_cursor
.x
= x
;
8308 output_cursor
.y
= y
;
8310 /* If not called as part of an update, really display the cursor.
8311 This will also set the cursor position of W. */
8312 if (updated_window
== NULL
)
8315 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
8316 if (rif
->flush_display_optional
)
8317 rif
->flush_display_optional (SELECTED_FRAME ());
8322 #endif /* HAVE_WINDOW_SYSTEM */
8325 /***********************************************************************
8327 ***********************************************************************/
8329 #ifdef HAVE_WINDOW_SYSTEM
8331 /* Where the mouse was last time we reported a mouse event. */
8333 FRAME_PTR last_mouse_frame
;
8335 /* Tool-bar item index of the item on which a mouse button was pressed
8338 int last_tool_bar_item
;
8341 /* Update the tool-bar item list for frame F. This has to be done
8342 before we start to fill in any display lines. Called from
8343 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
8344 and restore it here. */
8347 update_tool_bar (f
, save_match_data
)
8349 int save_match_data
;
8352 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
8354 int do_update
= WINDOWP (f
->tool_bar_window
)
8355 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
8363 window
= FRAME_SELECTED_WINDOW (f
);
8364 w
= XWINDOW (window
);
8366 /* If the user has switched buffers or windows, we need to
8367 recompute to reflect the new bindings. But we'll
8368 recompute when update_mode_lines is set too; that means
8369 that people can use force-mode-line-update to request
8370 that the menu bar be recomputed. The adverse effect on
8371 the rest of the redisplay algorithm is about the same as
8372 windows_or_buffers_changed anyway. */
8373 if (windows_or_buffers_changed
8374 || !NILP (w
->update_mode_line
)
8375 || update_mode_lines
8376 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
8377 < BUF_MODIFF (XBUFFER (w
->buffer
)))
8378 != !NILP (w
->last_had_star
))
8379 || ((!NILP (Vtransient_mark_mode
)
8380 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
8381 != !NILP (w
->region_showing
)))
8383 struct buffer
*prev
= current_buffer
;
8384 int count
= SPECPDL_INDEX ();
8385 Lisp_Object old_tool_bar
;
8386 struct gcpro gcpro1
;
8388 /* Set current_buffer to the buffer of the selected
8389 window of the frame, so that we get the right local
8391 set_buffer_internal_1 (XBUFFER (w
->buffer
));
8393 /* Save match data, if we must. */
8394 if (save_match_data
)
8395 record_unwind_protect (Fset_match_data
, Fmatch_data (Qnil
, Qnil
));
8397 /* Make sure that we don't accidentally use bogus keymaps. */
8398 if (NILP (Voverriding_local_map_menu_flag
))
8400 specbind (Qoverriding_terminal_local_map
, Qnil
);
8401 specbind (Qoverriding_local_map
, Qnil
);
8404 old_tool_bar
= f
->tool_bar_items
;
8405 GCPRO1 (old_tool_bar
);
8407 /* Build desired tool-bar items from keymaps. */
8410 = tool_bar_items (f
->tool_bar_items
, &f
->n_tool_bar_items
);
8413 /* Redisplay the tool-bar if we changed it. */
8414 if (! NILP (Fequal (old_tool_bar
, f
->tool_bar_items
)))
8415 w
->update_mode_line
= Qt
;
8419 unbind_to (count
, Qnil
);
8420 set_buffer_internal_1 (prev
);
8426 /* Set F->desired_tool_bar_string to a Lisp string representing frame
8427 F's desired tool-bar contents. F->tool_bar_items must have
8428 been set up previously by calling prepare_menu_bars. */
8431 build_desired_tool_bar_string (f
)
8434 int i
, size
, size_needed
;
8435 struct gcpro gcpro1
, gcpro2
, gcpro3
;
8436 Lisp_Object image
, plist
, props
;
8438 image
= plist
= props
= Qnil
;
8439 GCPRO3 (image
, plist
, props
);
8441 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
8442 Otherwise, make a new string. */
8444 /* The size of the string we might be able to reuse. */
8445 size
= (STRINGP (f
->desired_tool_bar_string
)
8446 ? SCHARS (f
->desired_tool_bar_string
)
8449 /* We need one space in the string for each image. */
8450 size_needed
= f
->n_tool_bar_items
;
8452 /* Reuse f->desired_tool_bar_string, if possible. */
8453 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
8454 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
8458 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
8459 Fremove_text_properties (make_number (0), make_number (size
),
8460 props
, f
->desired_tool_bar_string
);
8463 /* Put a `display' property on the string for the images to display,
8464 put a `menu_item' property on tool-bar items with a value that
8465 is the index of the item in F's tool-bar item vector. */
8466 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
8468 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
8470 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8471 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8472 int hmargin
, vmargin
, relief
, idx
, end
;
8473 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
;
8475 /* If image is a vector, choose the image according to the
8477 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
8478 if (VECTORP (image
))
8482 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
8483 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
8486 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
8487 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
8489 xassert (ASIZE (image
) >= idx
);
8490 image
= AREF (image
, idx
);
8495 /* Ignore invalid image specifications. */
8496 if (!valid_image_p (image
))
8499 /* Display the tool-bar button pressed, or depressed. */
8500 plist
= Fcopy_sequence (XCDR (image
));
8502 /* Compute margin and relief to draw. */
8503 relief
= (tool_bar_button_relief
>= 0
8504 ? tool_bar_button_relief
8505 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
8506 hmargin
= vmargin
= relief
;
8508 if (INTEGERP (Vtool_bar_button_margin
)
8509 && XINT (Vtool_bar_button_margin
) > 0)
8511 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
8512 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
8514 else if (CONSP (Vtool_bar_button_margin
))
8516 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
8517 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
8518 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
8520 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
8521 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
8522 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
8525 if (auto_raise_tool_bar_buttons_p
)
8527 /* Add a `:relief' property to the image spec if the item is
8531 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
8538 /* If image is selected, display it pressed, i.e. with a
8539 negative relief. If it's not selected, display it with a
8541 plist
= Fplist_put (plist
, QCrelief
,
8543 ? make_number (-relief
)
8544 : make_number (relief
)));
8549 /* Put a margin around the image. */
8550 if (hmargin
|| vmargin
)
8552 if (hmargin
== vmargin
)
8553 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
8555 plist
= Fplist_put (plist
, QCmargin
,
8556 Fcons (make_number (hmargin
),
8557 make_number (vmargin
)));
8560 /* If button is not enabled, and we don't have special images
8561 for the disabled state, make the image appear disabled by
8562 applying an appropriate algorithm to it. */
8563 if (!enabled_p
&& idx
< 0)
8564 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
8566 /* Put a `display' text property on the string for the image to
8567 display. Put a `menu-item' property on the string that gives
8568 the start of this item's properties in the tool-bar items
8570 image
= Fcons (Qimage
, plist
);
8571 props
= list4 (Qdisplay
, image
,
8572 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
8574 /* Let the last image hide all remaining spaces in the tool bar
8575 string. The string can be longer than needed when we reuse a
8577 if (i
+ 1 == f
->n_tool_bar_items
)
8578 end
= SCHARS (f
->desired_tool_bar_string
);
8581 Fadd_text_properties (make_number (i
), make_number (end
),
8582 props
, f
->desired_tool_bar_string
);
8590 /* Display one line of the tool-bar of frame IT->f. */
8593 display_tool_bar_line (it
)
8596 struct glyph_row
*row
= it
->glyph_row
;
8597 int max_x
= it
->last_visible_x
;
8600 prepare_desired_row (row
);
8601 row
->y
= it
->current_y
;
8603 /* Note that this isn't made use of if the face hasn't a box,
8604 so there's no need to check the face here. */
8605 it
->start_of_box_run_p
= 1;
8607 while (it
->current_x
< max_x
)
8609 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
8611 /* Get the next display element. */
8612 if (!get_next_display_element (it
))
8615 /* Produce glyphs. */
8616 x_before
= it
->current_x
;
8617 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
8618 PRODUCE_GLYPHS (it
);
8620 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
8625 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
8627 if (x
+ glyph
->pixel_width
> max_x
)
8629 /* Glyph doesn't fit on line. */
8630 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
8636 x
+= glyph
->pixel_width
;
8640 /* Stop at line ends. */
8641 if (ITERATOR_AT_END_OF_LINE_P (it
))
8644 set_iterator_to_next (it
, 1);
8649 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
8650 extend_face_to_end_of_line (it
);
8651 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
8652 last
->right_box_line_p
= 1;
8653 if (last
== row
->glyphs
[TEXT_AREA
])
8654 last
->left_box_line_p
= 1;
8655 compute_line_metrics (it
);
8657 /* If line is empty, make it occupy the rest of the tool-bar. */
8658 if (!row
->displays_text_p
)
8660 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
8661 row
->ascent
= row
->phys_ascent
= 0;
8664 row
->full_width_p
= 1;
8665 row
->continued_p
= 0;
8666 row
->truncated_on_left_p
= 0;
8667 row
->truncated_on_right_p
= 0;
8669 it
->current_x
= it
->hpos
= 0;
8670 it
->current_y
+= row
->height
;
8676 /* Value is the number of screen lines needed to make all tool-bar
8677 items of frame F visible. */
8680 tool_bar_lines_needed (f
)
8683 struct window
*w
= XWINDOW (f
->tool_bar_window
);
8686 /* Initialize an iterator for iteration over
8687 F->desired_tool_bar_string in the tool-bar window of frame F. */
8688 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
8689 it
.first_visible_x
= 0;
8690 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
8691 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
8693 while (!ITERATOR_AT_END_P (&it
))
8695 it
.glyph_row
= w
->desired_matrix
->rows
;
8696 clear_glyph_row (it
.glyph_row
);
8697 display_tool_bar_line (&it
);
8700 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
8704 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
8706 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
8715 frame
= selected_frame
;
8717 CHECK_FRAME (frame
);
8720 if (WINDOWP (f
->tool_bar_window
)
8721 || (w
= XWINDOW (f
->tool_bar_window
),
8722 WINDOW_TOTAL_LINES (w
) > 0))
8724 update_tool_bar (f
, 1);
8725 if (f
->n_tool_bar_items
)
8727 build_desired_tool_bar_string (f
);
8728 nlines
= tool_bar_lines_needed (f
);
8732 return make_number (nlines
);
8736 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
8737 height should be changed. */
8740 redisplay_tool_bar (f
)
8745 struct glyph_row
*row
;
8746 int change_height_p
= 0;
8749 if (FRAME_EXTERNAL_TOOL_BAR (f
))
8750 update_frame_tool_bar (f
);
8754 /* If frame hasn't a tool-bar window or if it is zero-height, don't
8755 do anything. This means you must start with tool-bar-lines
8756 non-zero to get the auto-sizing effect. Or in other words, you
8757 can turn off tool-bars by specifying tool-bar-lines zero. */
8758 if (!WINDOWP (f
->tool_bar_window
)
8759 || (w
= XWINDOW (f
->tool_bar_window
),
8760 WINDOW_TOTAL_LINES (w
) == 0))
8763 /* Set up an iterator for the tool-bar window. */
8764 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
8765 it
.first_visible_x
= 0;
8766 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
8769 /* Build a string that represents the contents of the tool-bar. */
8770 build_desired_tool_bar_string (f
);
8771 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
8773 /* Display as many lines as needed to display all tool-bar items. */
8774 while (it
.current_y
< it
.last_visible_y
)
8775 display_tool_bar_line (&it
);
8777 /* It doesn't make much sense to try scrolling in the tool-bar
8778 window, so don't do it. */
8779 w
->desired_matrix
->no_scrolling_p
= 1;
8780 w
->must_be_updated_p
= 1;
8782 if (auto_resize_tool_bars_p
)
8786 /* If we couldn't display everything, change the tool-bar's
8788 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
8789 change_height_p
= 1;
8791 /* If there are blank lines at the end, except for a partially
8792 visible blank line at the end that is smaller than
8793 FRAME_LINE_HEIGHT, change the tool-bar's height. */
8794 row
= it
.glyph_row
- 1;
8795 if (!row
->displays_text_p
8796 && row
->height
>= FRAME_LINE_HEIGHT (f
))
8797 change_height_p
= 1;
8799 /* If row displays tool-bar items, but is partially visible,
8800 change the tool-bar's height. */
8801 if (row
->displays_text_p
8802 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
8803 change_height_p
= 1;
8805 /* Resize windows as needed by changing the `tool-bar-lines'
8808 && (nlines
= tool_bar_lines_needed (f
),
8809 nlines
!= WINDOW_TOTAL_LINES (w
)))
8811 extern Lisp_Object Qtool_bar_lines
;
8813 int old_height
= WINDOW_TOTAL_LINES (w
);
8815 XSETFRAME (frame
, f
);
8816 clear_glyph_matrix (w
->desired_matrix
);
8817 Fmodify_frame_parameters (frame
,
8818 Fcons (Fcons (Qtool_bar_lines
,
8819 make_number (nlines
)),
8821 if (WINDOW_TOTAL_LINES (w
) != old_height
)
8822 fonts_changed_p
= 1;
8826 return change_height_p
;
8830 /* Get information about the tool-bar item which is displayed in GLYPH
8831 on frame F. Return in *PROP_IDX the index where tool-bar item
8832 properties start in F->tool_bar_items. Value is zero if
8833 GLYPH doesn't display a tool-bar item. */
8836 tool_bar_item_info (f
, glyph
, prop_idx
)
8838 struct glyph
*glyph
;
8845 /* This function can be called asynchronously, which means we must
8846 exclude any possibility that Fget_text_property signals an
8848 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
8849 charpos
= max (0, charpos
);
8851 /* Get the text property `menu-item' at pos. The value of that
8852 property is the start index of this item's properties in
8853 F->tool_bar_items. */
8854 prop
= Fget_text_property (make_number (charpos
),
8855 Qmenu_item
, f
->current_tool_bar_string
);
8856 if (INTEGERP (prop
))
8858 *prop_idx
= XINT (prop
);
8868 /* Get information about the tool-bar item at position X/Y on frame F.
8869 Return in *GLYPH a pointer to the glyph of the tool-bar item in
8870 the current matrix of the tool-bar window of F, or NULL if not
8871 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
8872 item in F->tool_bar_items. Value is
8874 -1 if X/Y is not on a tool-bar item
8875 0 if X/Y is on the same item that was highlighted before.
8879 get_tool_bar_item (f
, x
, y
, glyph
, hpos
, vpos
, prop_idx
)
8882 struct glyph
**glyph
;
8883 int *hpos
, *vpos
, *prop_idx
;
8885 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
8886 struct window
*w
= XWINDOW (f
->tool_bar_window
);
8889 /* Find the glyph under X/Y. */
8890 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
8894 /* Get the start of this tool-bar item's properties in
8895 f->tool_bar_items. */
8896 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
8899 /* Is mouse on the highlighted item? */
8900 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
8901 && *vpos
>= dpyinfo
->mouse_face_beg_row
8902 && *vpos
<= dpyinfo
->mouse_face_end_row
8903 && (*vpos
> dpyinfo
->mouse_face_beg_row
8904 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
8905 && (*vpos
< dpyinfo
->mouse_face_end_row
8906 || *hpos
< dpyinfo
->mouse_face_end_col
8907 || dpyinfo
->mouse_face_past_end
))
8915 Handle mouse button event on the tool-bar of frame F, at
8916 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
8917 0 for button release. MODIFIERS is event modifiers for button
8921 handle_tool_bar_click (f
, x
, y
, down_p
, modifiers
)
8924 unsigned int modifiers
;
8926 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
8927 struct window
*w
= XWINDOW (f
->tool_bar_window
);
8928 int hpos
, vpos
, prop_idx
;
8929 struct glyph
*glyph
;
8930 Lisp_Object enabled_p
;
8932 /* If not on the highlighted tool-bar item, return. */
8933 frame_to_window_pixel_xy (w
, &x
, &y
);
8934 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
8937 /* If item is disabled, do nothing. */
8938 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
8939 if (NILP (enabled_p
))
8944 /* Show item in pressed state. */
8945 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
8946 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
8947 last_tool_bar_item
= prop_idx
;
8951 Lisp_Object key
, frame
;
8952 struct input_event event
;
8955 /* Show item in released state. */
8956 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
8957 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
8959 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
8961 XSETFRAME (frame
, f
);
8962 event
.kind
= TOOL_BAR_EVENT
;
8963 event
.frame_or_window
= frame
;
8965 kbd_buffer_store_event (&event
);
8967 event
.kind
= TOOL_BAR_EVENT
;
8968 event
.frame_or_window
= frame
;
8970 event
.modifiers
= modifiers
;
8971 kbd_buffer_store_event (&event
);
8972 last_tool_bar_item
= -1;
8977 /* Possibly highlight a tool-bar item on frame F when mouse moves to
8978 tool-bar window-relative coordinates X/Y. Called from
8979 note_mouse_highlight. */
8982 note_tool_bar_highlight (f
, x
, y
)
8986 Lisp_Object window
= f
->tool_bar_window
;
8987 struct window
*w
= XWINDOW (window
);
8988 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
8990 struct glyph
*glyph
;
8991 struct glyph_row
*row
;
8993 Lisp_Object enabled_p
;
8995 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
8996 int mouse_down_p
, rc
;
8998 /* Function note_mouse_highlight is called with negative x(y
8999 values when mouse moves outside of the frame. */
9000 if (x
<= 0 || y
<= 0)
9002 clear_mouse_face (dpyinfo
);
9006 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
9009 /* Not on tool-bar item. */
9010 clear_mouse_face (dpyinfo
);
9014 /* On same tool-bar item as before. */
9017 clear_mouse_face (dpyinfo
);
9019 /* Mouse is down, but on different tool-bar item? */
9020 mouse_down_p
= (dpyinfo
->grabbed
9021 && f
== last_mouse_frame
9022 && FRAME_LIVE_P (f
));
9024 && last_tool_bar_item
!= prop_idx
)
9027 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
9028 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
9030 /* If tool-bar item is not enabled, don't highlight it. */
9031 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
9032 if (!NILP (enabled_p
))
9034 /* Compute the x-position of the glyph. In front and past the
9035 image is a space. We include this in the highlighted area. */
9036 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
9037 for (i
= x
= 0; i
< hpos
; ++i
)
9038 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
9040 /* Record this as the current active region. */
9041 dpyinfo
->mouse_face_beg_col
= hpos
;
9042 dpyinfo
->mouse_face_beg_row
= vpos
;
9043 dpyinfo
->mouse_face_beg_x
= x
;
9044 dpyinfo
->mouse_face_beg_y
= row
->y
;
9045 dpyinfo
->mouse_face_past_end
= 0;
9047 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
9048 dpyinfo
->mouse_face_end_row
= vpos
;
9049 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
9050 dpyinfo
->mouse_face_end_y
= row
->y
;
9051 dpyinfo
->mouse_face_window
= window
;
9052 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
9054 /* Display it as active. */
9055 show_mouse_face (dpyinfo
, draw
);
9056 dpyinfo
->mouse_face_image_state
= draw
;
9061 /* Set help_echo_string to a help string to display for this tool-bar item.
9062 XTread_socket does the rest. */
9063 help_echo_object
= help_echo_window
= Qnil
;
9065 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
9066 if (NILP (help_echo_string
))
9067 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
9070 #endif /* HAVE_WINDOW_SYSTEM */
9074 /************************************************************************
9075 Horizontal scrolling
9076 ************************************************************************/
9078 static int hscroll_window_tree
P_ ((Lisp_Object
));
9079 static int hscroll_windows
P_ ((Lisp_Object
));
9081 /* For all leaf windows in the window tree rooted at WINDOW, set their
9082 hscroll value so that PT is (i) visible in the window, and (ii) so
9083 that it is not within a certain margin at the window's left and
9084 right border. Value is non-zero if any window's hscroll has been
9088 hscroll_window_tree (window
)
9091 int hscrolled_p
= 0;
9092 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
9093 int hscroll_step_abs
= 0;
9094 double hscroll_step_rel
= 0;
9096 if (hscroll_relative_p
)
9098 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
9099 if (hscroll_step_rel
< 0)
9101 hscroll_relative_p
= 0;
9102 hscroll_step_abs
= 0;
9105 else if (INTEGERP (Vhscroll_step
))
9107 hscroll_step_abs
= XINT (Vhscroll_step
);
9108 if (hscroll_step_abs
< 0)
9109 hscroll_step_abs
= 0;
9112 hscroll_step_abs
= 0;
9114 while (WINDOWP (window
))
9116 struct window
*w
= XWINDOW (window
);
9118 if (WINDOWP (w
->hchild
))
9119 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
9120 else if (WINDOWP (w
->vchild
))
9121 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
9122 else if (w
->cursor
.vpos
>= 0)
9125 int text_area_width
;
9126 struct glyph_row
*current_cursor_row
9127 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
9128 struct glyph_row
*desired_cursor_row
9129 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
9130 struct glyph_row
*cursor_row
9131 = (desired_cursor_row
->enabled_p
9132 ? desired_cursor_row
9133 : current_cursor_row
);
9135 text_area_width
= window_box_width (w
, TEXT_AREA
);
9137 /* Scroll when cursor is inside this scroll margin. */
9138 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
9140 if ((XFASTINT (w
->hscroll
)
9141 && w
->cursor
.x
<= h_margin
)
9142 || (cursor_row
->enabled_p
9143 && cursor_row
->truncated_on_right_p
9144 && (w
->cursor
.x
>= text_area_width
- h_margin
)))
9148 struct buffer
*saved_current_buffer
;
9152 /* Find point in a display of infinite width. */
9153 saved_current_buffer
= current_buffer
;
9154 current_buffer
= XBUFFER (w
->buffer
);
9156 if (w
== XWINDOW (selected_window
))
9157 pt
= BUF_PT (current_buffer
);
9160 pt
= marker_position (w
->pointm
);
9161 pt
= max (BEGV
, pt
);
9165 /* Move iterator to pt starting at cursor_row->start in
9166 a line with infinite width. */
9167 init_to_row_start (&it
, w
, cursor_row
);
9168 it
.last_visible_x
= INFINITY
;
9169 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
9170 current_buffer
= saved_current_buffer
;
9172 /* Position cursor in window. */
9173 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
9174 hscroll
= max (0, (it
.current_x
9175 - (ITERATOR_AT_END_OF_LINE_P (&it
)
9176 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
9177 : (text_area_width
/ 2))))
9178 / FRAME_COLUMN_WIDTH (it
.f
);
9179 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
9181 if (hscroll_relative_p
)
9182 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
9185 wanted_x
= text_area_width
9186 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
9189 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
9193 if (hscroll_relative_p
)
9194 wanted_x
= text_area_width
* hscroll_step_rel
9197 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
9200 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
9202 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
9204 /* Don't call Fset_window_hscroll if value hasn't
9205 changed because it will prevent redisplay
9207 if (XFASTINT (w
->hscroll
) != hscroll
)
9209 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
9210 w
->hscroll
= make_number (hscroll
);
9219 /* Value is non-zero if hscroll of any leaf window has been changed. */
9224 /* Set hscroll so that cursor is visible and not inside horizontal
9225 scroll margins for all windows in the tree rooted at WINDOW. See
9226 also hscroll_window_tree above. Value is non-zero if any window's
9227 hscroll has been changed. If it has, desired matrices on the frame
9228 of WINDOW are cleared. */
9231 hscroll_windows (window
)
9236 if (automatic_hscrolling_p
)
9238 hscrolled_p
= hscroll_window_tree (window
);
9240 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
9249 /************************************************************************
9251 ************************************************************************/
9253 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
9254 to a non-zero value. This is sometimes handy to have in a debugger
9259 /* First and last unchanged row for try_window_id. */
9261 int debug_first_unchanged_at_end_vpos
;
9262 int debug_last_unchanged_at_beg_vpos
;
9264 /* Delta vpos and y. */
9266 int debug_dvpos
, debug_dy
;
9268 /* Delta in characters and bytes for try_window_id. */
9270 int debug_delta
, debug_delta_bytes
;
9272 /* Values of window_end_pos and window_end_vpos at the end of
9275 EMACS_INT debug_end_pos
, debug_end_vpos
;
9277 /* Append a string to W->desired_matrix->method. FMT is a printf
9278 format string. A1...A9 are a supplement for a variable-length
9279 argument list. If trace_redisplay_p is non-zero also printf the
9280 resulting string to stderr. */
9283 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
9286 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
9289 char *method
= w
->desired_matrix
->method
;
9290 int len
= strlen (method
);
9291 int size
= sizeof w
->desired_matrix
->method
;
9292 int remaining
= size
- len
- 1;
9294 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
9295 if (len
&& remaining
)
9301 strncpy (method
+ len
, buffer
, remaining
);
9303 if (trace_redisplay_p
)
9304 fprintf (stderr
, "%p (%s): %s\n",
9306 ((BUFFERP (w
->buffer
)
9307 && STRINGP (XBUFFER (w
->buffer
)->name
))
9308 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
9313 #endif /* GLYPH_DEBUG */
9316 /* Value is non-zero if all changes in window W, which displays
9317 current_buffer, are in the text between START and END. START is a
9318 buffer position, END is given as a distance from Z. Used in
9319 redisplay_internal for display optimization. */
9322 text_outside_line_unchanged_p (w
, start
, end
)
9326 int unchanged_p
= 1;
9328 /* If text or overlays have changed, see where. */
9329 if (XFASTINT (w
->last_modified
) < MODIFF
9330 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
9332 /* Gap in the line? */
9333 if (GPT
< start
|| Z
- GPT
< end
)
9336 /* Changes start in front of the line, or end after it? */
9338 && (BEG_UNCHANGED
< start
- 1
9339 || END_UNCHANGED
< end
))
9342 /* If selective display, can't optimize if changes start at the
9343 beginning of the line. */
9345 && INTEGERP (current_buffer
->selective_display
)
9346 && XINT (current_buffer
->selective_display
) > 0
9347 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
9350 /* If there are overlays at the start or end of the line, these
9351 may have overlay strings with newlines in them. A change at
9352 START, for instance, may actually concern the display of such
9353 overlay strings as well, and they are displayed on different
9354 lines. So, quickly rule out this case. (For the future, it
9355 might be desirable to implement something more telling than
9356 just BEG/END_UNCHANGED.) */
9359 if (BEG
+ BEG_UNCHANGED
== start
9360 && overlay_touches_p (start
))
9362 if (END_UNCHANGED
== end
9363 && overlay_touches_p (Z
- end
))
9372 /* Do a frame update, taking possible shortcuts into account. This is
9373 the main external entry point for redisplay.
9375 If the last redisplay displayed an echo area message and that message
9376 is no longer requested, we clear the echo area or bring back the
9377 mini-buffer if that is in use. */
9382 redisplay_internal (0);
9387 overlay_arrow_string_or_property (var
, pbitmap
)
9391 Lisp_Object pstr
= Fget (var
, Qoverlay_arrow_string
);
9397 if (bitmap
= Fget (var
, Qoverlay_arrow_bitmap
), INTEGERP (bitmap
))
9398 *pbitmap
= XINT (bitmap
);
9403 return Voverlay_arrow_string
;
9406 /* Return 1 if there are any overlay-arrows in current_buffer. */
9408 overlay_arrow_in_current_buffer_p ()
9412 for (vlist
= Voverlay_arrow_variable_list
;
9414 vlist
= XCDR (vlist
))
9416 Lisp_Object var
= XCAR (vlist
);
9421 val
= find_symbol_value (var
);
9423 && current_buffer
== XMARKER (val
)->buffer
)
9430 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
9434 overlay_arrows_changed_p ()
9438 for (vlist
= Voverlay_arrow_variable_list
;
9440 vlist
= XCDR (vlist
))
9442 Lisp_Object var
= XCAR (vlist
);
9443 Lisp_Object val
, pstr
;
9447 val
= find_symbol_value (var
);
9450 if (! EQ (COERCE_MARKER (val
),
9451 Fget (var
, Qlast_arrow_position
))
9452 || ! (pstr
= overlay_arrow_string_or_property (var
, 0),
9453 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
9459 /* Mark overlay arrows to be updated on next redisplay. */
9462 update_overlay_arrows (up_to_date
)
9467 for (vlist
= Voverlay_arrow_variable_list
;
9469 vlist
= XCDR (vlist
))
9471 Lisp_Object var
= XCAR (vlist
);
9478 Lisp_Object val
= find_symbol_value (var
);
9479 Fput (var
, Qlast_arrow_position
,
9480 COERCE_MARKER (val
));
9481 Fput (var
, Qlast_arrow_string
,
9482 overlay_arrow_string_or_property (var
, 0));
9484 else if (up_to_date
< 0
9485 || !NILP (Fget (var
, Qlast_arrow_position
)))
9487 Fput (var
, Qlast_arrow_position
, Qt
);
9488 Fput (var
, Qlast_arrow_string
, Qt
);
9494 /* Return overlay arrow string at row, or nil. */
9497 overlay_arrow_at_row (f
, row
, pbitmap
)
9499 struct glyph_row
*row
;
9504 for (vlist
= Voverlay_arrow_variable_list
;
9506 vlist
= XCDR (vlist
))
9508 Lisp_Object var
= XCAR (vlist
);
9514 val
= find_symbol_value (var
);
9517 && current_buffer
== XMARKER (val
)->buffer
9518 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
9520 val
= overlay_arrow_string_or_property (var
, pbitmap
);
9521 if (FRAME_WINDOW_P (f
))
9523 else if (STRINGP (val
))
9533 /* Return 1 if point moved out of or into a composition. Otherwise
9534 return 0. PREV_BUF and PREV_PT are the last point buffer and
9535 position. BUF and PT are the current point buffer and position. */
9538 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
9539 struct buffer
*prev_buf
, *buf
;
9546 XSETBUFFER (buffer
, buf
);
9547 /* Check a composition at the last point if point moved within the
9549 if (prev_buf
== buf
)
9552 /* Point didn't move. */
9555 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
9556 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
9557 && COMPOSITION_VALID_P (start
, end
, prop
)
9558 && start
< prev_pt
&& end
> prev_pt
)
9559 /* The last point was within the composition. Return 1 iff
9560 point moved out of the composition. */
9561 return (pt
<= start
|| pt
>= end
);
9564 /* Check a composition at the current point. */
9565 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
9566 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
9567 && COMPOSITION_VALID_P (start
, end
, prop
)
9568 && start
< pt
&& end
> pt
);
9572 /* Reconsider the setting of B->clip_changed which is displayed
9576 reconsider_clip_changes (w
, b
)
9581 && !NILP (w
->window_end_valid
)
9582 && w
->current_matrix
->buffer
== b
9583 && w
->current_matrix
->zv
== BUF_ZV (b
)
9584 && w
->current_matrix
->begv
== BUF_BEGV (b
))
9585 b
->clip_changed
= 0;
9587 /* If display wasn't paused, and W is not a tool bar window, see if
9588 point has been moved into or out of a composition. In that case,
9589 we set b->clip_changed to 1 to force updating the screen. If
9590 b->clip_changed has already been set to 1, we can skip this
9592 if (!b
->clip_changed
9593 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
9597 if (w
== XWINDOW (selected_window
))
9598 pt
= BUF_PT (current_buffer
);
9600 pt
= marker_position (w
->pointm
);
9602 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
9603 || pt
!= XINT (w
->last_point
))
9604 && check_point_in_composition (w
->current_matrix
->buffer
,
9605 XINT (w
->last_point
),
9606 XBUFFER (w
->buffer
), pt
))
9607 b
->clip_changed
= 1;
9612 /* Select FRAME to forward the values of frame-local variables into C
9613 variables so that the redisplay routines can access those values
9617 select_frame_for_redisplay (frame
)
9620 Lisp_Object tail
, sym
, val
;
9621 Lisp_Object old
= selected_frame
;
9623 selected_frame
= frame
;
9625 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
9626 if (CONSP (XCAR (tail
))
9627 && (sym
= XCAR (XCAR (tail
)),
9629 && (sym
= indirect_variable (sym
),
9630 val
= SYMBOL_VALUE (sym
),
9631 (BUFFER_LOCAL_VALUEP (val
)
9632 || SOME_BUFFER_LOCAL_VALUEP (val
)))
9633 && XBUFFER_LOCAL_VALUE (val
)->check_frame
)
9634 Fsymbol_value (sym
);
9636 for (tail
= XFRAME (old
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
9637 if (CONSP (XCAR (tail
))
9638 && (sym
= XCAR (XCAR (tail
)),
9640 && (sym
= indirect_variable (sym
),
9641 val
= SYMBOL_VALUE (sym
),
9642 (BUFFER_LOCAL_VALUEP (val
)
9643 || SOME_BUFFER_LOCAL_VALUEP (val
)))
9644 && XBUFFER_LOCAL_VALUE (val
)->check_frame
)
9645 Fsymbol_value (sym
);
9649 #define STOP_POLLING \
9650 do { if (! polling_stopped_here) stop_polling (); \
9651 polling_stopped_here = 1; } while (0)
9653 #define RESUME_POLLING \
9654 do { if (polling_stopped_here) start_polling (); \
9655 polling_stopped_here = 0; } while (0)
9658 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
9659 response to any user action; therefore, we should preserve the echo
9660 area. (Actually, our caller does that job.) Perhaps in the future
9661 avoid recentering windows if it is not necessary; currently that
9662 causes some problems. */
9665 redisplay_internal (preserve_echo_area
)
9666 int preserve_echo_area
;
9668 struct window
*w
= XWINDOW (selected_window
);
9669 struct frame
*f
= XFRAME (w
->frame
);
9671 int must_finish
= 0;
9672 struct text_pos tlbufpos
, tlendpos
;
9673 int number_of_visible_frames
;
9675 struct frame
*sf
= SELECTED_FRAME ();
9676 int polling_stopped_here
= 0;
9678 /* Non-zero means redisplay has to consider all windows on all
9679 frames. Zero means, only selected_window is considered. */
9680 int consider_all_windows_p
;
9682 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
9684 /* No redisplay if running in batch mode or frame is not yet fully
9685 initialized, or redisplay is explicitly turned off by setting
9686 Vinhibit_redisplay. */
9688 || !NILP (Vinhibit_redisplay
)
9689 || !f
->glyphs_initialized_p
)
9692 /* The flag redisplay_performed_directly_p is set by
9693 direct_output_for_insert when it already did the whole screen
9694 update necessary. */
9695 if (redisplay_performed_directly_p
)
9697 redisplay_performed_directly_p
= 0;
9698 if (!hscroll_windows (selected_window
))
9702 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
9703 if (popup_activated ())
9707 /* I don't think this happens but let's be paranoid. */
9711 /* Record a function that resets redisplaying_p to its old value
9712 when we leave this function. */
9713 count
= SPECPDL_INDEX ();
9714 record_unwind_protect (unwind_redisplay
,
9715 Fcons (make_number (redisplaying_p
), selected_frame
));
9717 specbind (Qinhibit_free_realized_faces
, Qnil
);
9721 reconsider_clip_changes (w
, current_buffer
);
9723 /* If new fonts have been loaded that make a glyph matrix adjustment
9724 necessary, do it. */
9725 if (fonts_changed_p
)
9727 adjust_glyphs (NULL
);
9728 ++windows_or_buffers_changed
;
9729 fonts_changed_p
= 0;
9732 /* If face_change_count is non-zero, init_iterator will free all
9733 realized faces, which includes the faces referenced from current
9734 matrices. So, we can't reuse current matrices in this case. */
9735 if (face_change_count
)
9736 ++windows_or_buffers_changed
;
9738 if (! FRAME_WINDOW_P (sf
)
9739 && previous_terminal_frame
!= sf
)
9741 /* Since frames on an ASCII terminal share the same display
9742 area, displaying a different frame means redisplay the whole
9744 windows_or_buffers_changed
++;
9745 SET_FRAME_GARBAGED (sf
);
9746 XSETFRAME (Vterminal_frame
, sf
);
9748 previous_terminal_frame
= sf
;
9750 /* Set the visible flags for all frames. Do this before checking
9751 for resized or garbaged frames; they want to know if their frames
9752 are visible. See the comment in frame.h for
9753 FRAME_SAMPLE_VISIBILITY. */
9755 Lisp_Object tail
, frame
;
9757 number_of_visible_frames
= 0;
9759 FOR_EACH_FRAME (tail
, frame
)
9761 struct frame
*f
= XFRAME (frame
);
9763 FRAME_SAMPLE_VISIBILITY (f
);
9764 if (FRAME_VISIBLE_P (f
))
9765 ++number_of_visible_frames
;
9766 clear_desired_matrices (f
);
9770 /* Notice any pending interrupt request to change frame size. */
9771 do_pending_window_change (1);
9773 /* Clear frames marked as garbaged. */
9775 clear_garbaged_frames ();
9777 /* Build menubar and tool-bar items. */
9778 prepare_menu_bars ();
9780 if (windows_or_buffers_changed
)
9781 update_mode_lines
++;
9783 /* Detect case that we need to write or remove a star in the mode line. */
9784 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
9786 w
->update_mode_line
= Qt
;
9787 if (buffer_shared
> 1)
9788 update_mode_lines
++;
9791 /* If %c is in the mode line, update it if needed. */
9792 if (!NILP (w
->column_number_displayed
)
9793 /* This alternative quickly identifies a common case
9794 where no change is needed. */
9795 && !(PT
== XFASTINT (w
->last_point
)
9796 && XFASTINT (w
->last_modified
) >= MODIFF
9797 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
9798 && (XFASTINT (w
->column_number_displayed
)
9799 != (int) current_column ())) /* iftc */
9800 w
->update_mode_line
= Qt
;
9802 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
9804 /* The variable buffer_shared is set in redisplay_window and
9805 indicates that we redisplay a buffer in different windows. See
9807 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
9808 || cursor_type_changed
);
9810 /* If specs for an arrow have changed, do thorough redisplay
9811 to ensure we remove any arrow that should no longer exist. */
9812 if (overlay_arrows_changed_p ())
9813 consider_all_windows_p
= windows_or_buffers_changed
= 1;
9815 /* Normally the message* functions will have already displayed and
9816 updated the echo area, but the frame may have been trashed, or
9817 the update may have been preempted, so display the echo area
9818 again here. Checking message_cleared_p captures the case that
9819 the echo area should be cleared. */
9820 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
9821 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
9822 || (message_cleared_p
9823 && minibuf_level
== 0
9824 /* If the mini-window is currently selected, this means the
9825 echo-area doesn't show through. */
9826 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
9828 int window_height_changed_p
= echo_area_display (0);
9831 /* If we don't display the current message, don't clear the
9832 message_cleared_p flag, because, if we did, we wouldn't clear
9833 the echo area in the next redisplay which doesn't preserve
9835 if (!display_last_displayed_message_p
)
9836 message_cleared_p
= 0;
9838 if (fonts_changed_p
)
9840 else if (window_height_changed_p
)
9842 consider_all_windows_p
= 1;
9843 ++update_mode_lines
;
9844 ++windows_or_buffers_changed
;
9846 /* If window configuration was changed, frames may have been
9847 marked garbaged. Clear them or we will experience
9848 surprises wrt scrolling. */
9850 clear_garbaged_frames ();
9853 else if (EQ (selected_window
, minibuf_window
)
9854 && (current_buffer
->clip_changed
9855 || XFASTINT (w
->last_modified
) < MODIFF
9856 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
9857 && resize_mini_window (w
, 0))
9859 /* Resized active mini-window to fit the size of what it is
9860 showing if its contents might have changed. */
9862 consider_all_windows_p
= 1;
9863 ++windows_or_buffers_changed
;
9864 ++update_mode_lines
;
9866 /* If window configuration was changed, frames may have been
9867 marked garbaged. Clear them or we will experience
9868 surprises wrt scrolling. */
9870 clear_garbaged_frames ();
9874 /* If showing the region, and mark has changed, we must redisplay
9875 the whole window. The assignment to this_line_start_pos prevents
9876 the optimization directly below this if-statement. */
9877 if (((!NILP (Vtransient_mark_mode
)
9878 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9879 != !NILP (w
->region_showing
))
9880 || (!NILP (w
->region_showing
)
9881 && !EQ (w
->region_showing
,
9882 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
9883 CHARPOS (this_line_start_pos
) = 0;
9885 /* Optimize the case that only the line containing the cursor in the
9886 selected window has changed. Variables starting with this_ are
9887 set in display_line and record information about the line
9888 containing the cursor. */
9889 tlbufpos
= this_line_start_pos
;
9890 tlendpos
= this_line_end_pos
;
9891 if (!consider_all_windows_p
9892 && CHARPOS (tlbufpos
) > 0
9893 && NILP (w
->update_mode_line
)
9894 && !current_buffer
->clip_changed
9895 && !current_buffer
->prevent_redisplay_optimizations_p
9896 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
9897 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
9898 /* Make sure recorded data applies to current buffer, etc. */
9899 && this_line_buffer
== current_buffer
9900 && current_buffer
== XBUFFER (w
->buffer
)
9901 && NILP (w
->force_start
)
9902 && NILP (w
->optional_new_start
)
9903 /* Point must be on the line that we have info recorded about. */
9904 && PT
>= CHARPOS (tlbufpos
)
9905 && PT
<= Z
- CHARPOS (tlendpos
)
9906 /* All text outside that line, including its final newline,
9907 must be unchanged */
9908 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
9909 CHARPOS (tlendpos
)))
9911 if (CHARPOS (tlbufpos
) > BEGV
9912 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
9913 && (CHARPOS (tlbufpos
) == ZV
9914 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
9915 /* Former continuation line has disappeared by becoming empty */
9917 else if (XFASTINT (w
->last_modified
) < MODIFF
9918 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
9919 || MINI_WINDOW_P (w
))
9921 /* We have to handle the case of continuation around a
9922 wide-column character (See the comment in indent.c around
9925 For instance, in the following case:
9927 -------- Insert --------
9928 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
9929 J_I_ ==> J_I_ `^^' are cursors.
9933 As we have to redraw the line above, we should goto cancel. */
9936 int line_height_before
= this_line_pixel_height
;
9938 /* Note that start_display will handle the case that the
9939 line starting at tlbufpos is a continuation lines. */
9940 start_display (&it
, w
, tlbufpos
);
9942 /* Implementation note: It this still necessary? */
9943 if (it
.current_x
!= this_line_start_x
)
9946 TRACE ((stderr
, "trying display optimization 1\n"));
9947 w
->cursor
.vpos
= -1;
9948 overlay_arrow_seen
= 0;
9949 it
.vpos
= this_line_vpos
;
9950 it
.current_y
= this_line_y
;
9951 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
9954 /* If line contains point, is not continued,
9955 and ends at same distance from eob as before, we win */
9956 if (w
->cursor
.vpos
>= 0
9957 /* Line is not continued, otherwise this_line_start_pos
9958 would have been set to 0 in display_line. */
9959 && CHARPOS (this_line_start_pos
)
9960 /* Line ends as before. */
9961 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
9962 /* Line has same height as before. Otherwise other lines
9963 would have to be shifted up or down. */
9964 && this_line_pixel_height
== line_height_before
)
9966 /* If this is not the window's last line, we must adjust
9967 the charstarts of the lines below. */
9968 if (it
.current_y
< it
.last_visible_y
)
9970 struct glyph_row
*row
9971 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
9972 int delta
, delta_bytes
;
9974 if (Z
- CHARPOS (tlendpos
) == ZV
)
9976 /* This line ends at end of (accessible part of)
9977 buffer. There is no newline to count. */
9979 - CHARPOS (tlendpos
)
9980 - MATRIX_ROW_START_CHARPOS (row
));
9981 delta_bytes
= (Z_BYTE
9982 - BYTEPOS (tlendpos
)
9983 - MATRIX_ROW_START_BYTEPOS (row
));
9987 /* This line ends in a newline. Must take
9988 account of the newline and the rest of the
9989 text that follows. */
9991 - CHARPOS (tlendpos
)
9992 - MATRIX_ROW_START_CHARPOS (row
));
9993 delta_bytes
= (Z_BYTE
9994 - BYTEPOS (tlendpos
)
9995 - MATRIX_ROW_START_BYTEPOS (row
));
9998 increment_matrix_positions (w
->current_matrix
,
10000 w
->current_matrix
->nrows
,
10001 delta
, delta_bytes
);
10004 /* If this row displays text now but previously didn't,
10005 or vice versa, w->window_end_vpos may have to be
10007 if ((it
.glyph_row
- 1)->displays_text_p
)
10009 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
10010 XSETINT (w
->window_end_vpos
, this_line_vpos
);
10012 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
10013 && this_line_vpos
> 0)
10014 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
10015 w
->window_end_valid
= Qnil
;
10017 /* Update hint: No need to try to scroll in update_window. */
10018 w
->desired_matrix
->no_scrolling_p
= 1;
10021 *w
->desired_matrix
->method
= 0;
10022 debug_method_add (w
, "optimization 1");
10024 #ifdef HAVE_WINDOW_SYSTEM
10025 update_window_fringes (w
, 0);
10032 else if (/* Cursor position hasn't changed. */
10033 PT
== XFASTINT (w
->last_point
)
10034 /* Make sure the cursor was last displayed
10035 in this window. Otherwise we have to reposition it. */
10036 && 0 <= w
->cursor
.vpos
10037 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
10041 do_pending_window_change (1);
10043 /* We used to always goto end_of_redisplay here, but this
10044 isn't enough if we have a blinking cursor. */
10045 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
10046 goto end_of_redisplay
;
10050 /* If highlighting the region, or if the cursor is in the echo area,
10051 then we can't just move the cursor. */
10052 else if (! (!NILP (Vtransient_mark_mode
)
10053 && !NILP (current_buffer
->mark_active
))
10054 && (EQ (selected_window
, current_buffer
->last_selected_window
)
10055 || highlight_nonselected_windows
)
10056 && NILP (w
->region_showing
)
10057 && NILP (Vshow_trailing_whitespace
)
10058 && !cursor_in_echo_area
)
10061 struct glyph_row
*row
;
10063 /* Skip from tlbufpos to PT and see where it is. Note that
10064 PT may be in invisible text. If so, we will end at the
10065 next visible position. */
10066 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
10067 NULL
, DEFAULT_FACE_ID
);
10068 it
.current_x
= this_line_start_x
;
10069 it
.current_y
= this_line_y
;
10070 it
.vpos
= this_line_vpos
;
10072 /* The call to move_it_to stops in front of PT, but
10073 moves over before-strings. */
10074 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
10076 if (it
.vpos
== this_line_vpos
10077 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
10080 xassert (this_line_vpos
== it
.vpos
);
10081 xassert (this_line_y
== it
.current_y
);
10082 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
10084 *w
->desired_matrix
->method
= 0;
10085 debug_method_add (w
, "optimization 3");
10094 /* Text changed drastically or point moved off of line. */
10095 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
10098 CHARPOS (this_line_start_pos
) = 0;
10099 consider_all_windows_p
|= buffer_shared
> 1;
10100 ++clear_face_cache_count
;
10103 /* Build desired matrices, and update the display. If
10104 consider_all_windows_p is non-zero, do it for all windows on all
10105 frames. Otherwise do it for selected_window, only. */
10107 if (consider_all_windows_p
)
10109 Lisp_Object tail
, frame
;
10110 int i
, n
= 0, size
= 50;
10111 struct frame
**updated
10112 = (struct frame
**) alloca (size
* sizeof *updated
);
10114 /* Clear the face cache eventually. */
10115 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
10117 clear_face_cache (0);
10118 clear_face_cache_count
= 0;
10121 /* Recompute # windows showing selected buffer. This will be
10122 incremented each time such a window is displayed. */
10125 FOR_EACH_FRAME (tail
, frame
)
10127 struct frame
*f
= XFRAME (frame
);
10129 if (FRAME_WINDOW_P (f
) || f
== sf
)
10131 if (! EQ (frame
, selected_frame
))
10132 /* Select the frame, for the sake of frame-local
10134 select_frame_for_redisplay (frame
);
10136 #ifdef HAVE_WINDOW_SYSTEM
10137 if (clear_face_cache_count
% 50 == 0
10138 && FRAME_WINDOW_P (f
))
10139 clear_image_cache (f
, 0);
10140 #endif /* HAVE_WINDOW_SYSTEM */
10142 /* Mark all the scroll bars to be removed; we'll redeem
10143 the ones we want when we redisplay their windows. */
10144 if (condemn_scroll_bars_hook
)
10145 condemn_scroll_bars_hook (f
);
10147 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
10148 redisplay_windows (FRAME_ROOT_WINDOW (f
));
10150 /* Any scroll bars which redisplay_windows should have
10151 nuked should now go away. */
10152 if (judge_scroll_bars_hook
)
10153 judge_scroll_bars_hook (f
);
10155 /* If fonts changed, display again. */
10156 /* ??? rms: I suspect it is a mistake to jump all the way
10157 back to retry here. It should just retry this frame. */
10158 if (fonts_changed_p
)
10161 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
10163 /* See if we have to hscroll. */
10164 if (hscroll_windows (f
->root_window
))
10167 /* Prevent various kinds of signals during display
10168 update. stdio is not robust about handling
10169 signals, which can cause an apparent I/O
10171 if (interrupt_input
)
10172 unrequest_sigio ();
10175 /* Update the display. */
10176 set_window_update_flags (XWINDOW (f
->root_window
), 1);
10177 pause
|= update_frame (f
, 0, 0);
10178 #if 0 /* Exiting the loop can leave the wrong value for buffer_shared. */
10185 int nbytes
= size
* sizeof *updated
;
10186 struct frame
**p
= (struct frame
**) alloca (2 * nbytes
);
10187 bcopy (updated
, p
, nbytes
);
10198 /* Do the mark_window_display_accurate after all windows have
10199 been redisplayed because this call resets flags in buffers
10200 which are needed for proper redisplay. */
10201 for (i
= 0; i
< n
; ++i
)
10203 struct frame
*f
= updated
[i
];
10204 mark_window_display_accurate (f
->root_window
, 1);
10205 if (frame_up_to_date_hook
)
10206 frame_up_to_date_hook (f
);
10210 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
10212 Lisp_Object mini_window
;
10213 struct frame
*mini_frame
;
10215 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
10216 /* Use list_of_error, not Qerror, so that
10217 we catch only errors and don't run the debugger. */
10218 internal_condition_case_1 (redisplay_window_1
, selected_window
,
10220 redisplay_window_error
);
10222 /* Compare desired and current matrices, perform output. */
10225 /* If fonts changed, display again. */
10226 if (fonts_changed_p
)
10229 /* Prevent various kinds of signals during display update.
10230 stdio is not robust about handling signals,
10231 which can cause an apparent I/O error. */
10232 if (interrupt_input
)
10233 unrequest_sigio ();
10236 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
10238 if (hscroll_windows (selected_window
))
10241 XWINDOW (selected_window
)->must_be_updated_p
= 1;
10242 pause
= update_frame (sf
, 0, 0);
10245 /* We may have called echo_area_display at the top of this
10246 function. If the echo area is on another frame, that may
10247 have put text on a frame other than the selected one, so the
10248 above call to update_frame would not have caught it. Catch
10250 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10251 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10253 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
10255 XWINDOW (mini_window
)->must_be_updated_p
= 1;
10256 pause
|= update_frame (mini_frame
, 0, 0);
10257 if (!pause
&& hscroll_windows (mini_window
))
10262 /* If display was paused because of pending input, make sure we do a
10263 thorough update the next time. */
10266 /* Prevent the optimization at the beginning of
10267 redisplay_internal that tries a single-line update of the
10268 line containing the cursor in the selected window. */
10269 CHARPOS (this_line_start_pos
) = 0;
10271 /* Let the overlay arrow be updated the next time. */
10272 update_overlay_arrows (0);
10274 /* If we pause after scrolling, some rows in the current
10275 matrices of some windows are not valid. */
10276 if (!WINDOW_FULL_WIDTH_P (w
)
10277 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
10278 update_mode_lines
= 1;
10282 if (!consider_all_windows_p
)
10284 /* This has already been done above if
10285 consider_all_windows_p is set. */
10286 mark_window_display_accurate_1 (w
, 1);
10288 /* Say overlay arrows are up to date. */
10289 update_overlay_arrows (1);
10291 if (frame_up_to_date_hook
!= 0)
10292 frame_up_to_date_hook (sf
);
10295 update_mode_lines
= 0;
10296 windows_or_buffers_changed
= 0;
10297 cursor_type_changed
= 0;
10300 /* Start SIGIO interrupts coming again. Having them off during the
10301 code above makes it less likely one will discard output, but not
10302 impossible, since there might be stuff in the system buffer here.
10303 But it is much hairier to try to do anything about that. */
10304 if (interrupt_input
)
10308 /* If a frame has become visible which was not before, redisplay
10309 again, so that we display it. Expose events for such a frame
10310 (which it gets when becoming visible) don't call the parts of
10311 redisplay constructing glyphs, so simply exposing a frame won't
10312 display anything in this case. So, we have to display these
10313 frames here explicitly. */
10316 Lisp_Object tail
, frame
;
10319 FOR_EACH_FRAME (tail
, frame
)
10321 int this_is_visible
= 0;
10323 if (XFRAME (frame
)->visible
)
10324 this_is_visible
= 1;
10325 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
10326 if (XFRAME (frame
)->visible
)
10327 this_is_visible
= 1;
10329 if (this_is_visible
)
10333 if (new_count
!= number_of_visible_frames
)
10334 windows_or_buffers_changed
++;
10337 /* Change frame size now if a change is pending. */
10338 do_pending_window_change (1);
10340 /* If we just did a pending size change, or have additional
10341 visible frames, redisplay again. */
10342 if (windows_or_buffers_changed
&& !pause
)
10346 unbind_to (count
, Qnil
);
10351 /* Redisplay, but leave alone any recent echo area message unless
10352 another message has been requested in its place.
10354 This is useful in situations where you need to redisplay but no
10355 user action has occurred, making it inappropriate for the message
10356 area to be cleared. See tracking_off and
10357 wait_reading_process_input for examples of these situations.
10359 FROM_WHERE is an integer saying from where this function was
10360 called. This is useful for debugging. */
10363 redisplay_preserve_echo_area (from_where
)
10366 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
10368 if (!NILP (echo_area_buffer
[1]))
10370 /* We have a previously displayed message, but no current
10371 message. Redisplay the previous message. */
10372 display_last_displayed_message_p
= 1;
10373 redisplay_internal (1);
10374 display_last_displayed_message_p
= 0;
10377 redisplay_internal (1);
10381 /* Function registered with record_unwind_protect in
10382 redisplay_internal. Reset redisplaying_p to the value it had
10383 before redisplay_internal was called, and clear
10384 prevent_freeing_realized_faces_p. It also selects the previously
10388 unwind_redisplay (val
)
10391 Lisp_Object old_redisplaying_p
, old_frame
;
10393 old_redisplaying_p
= XCAR (val
);
10394 redisplaying_p
= XFASTINT (old_redisplaying_p
);
10395 old_frame
= XCDR (val
);
10396 if (! EQ (old_frame
, selected_frame
))
10397 select_frame_for_redisplay (old_frame
);
10402 /* Mark the display of window W as accurate or inaccurate. If
10403 ACCURATE_P is non-zero mark display of W as accurate. If
10404 ACCURATE_P is zero, arrange for W to be redisplayed the next time
10405 redisplay_internal is called. */
10408 mark_window_display_accurate_1 (w
, accurate_p
)
10412 if (BUFFERP (w
->buffer
))
10414 struct buffer
*b
= XBUFFER (w
->buffer
);
10417 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
10418 w
->last_overlay_modified
10419 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
10421 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
10425 b
->clip_changed
= 0;
10426 b
->prevent_redisplay_optimizations_p
= 0;
10428 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
10429 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
10430 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
10431 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
10433 w
->current_matrix
->buffer
= b
;
10434 w
->current_matrix
->begv
= BUF_BEGV (b
);
10435 w
->current_matrix
->zv
= BUF_ZV (b
);
10437 w
->last_cursor
= w
->cursor
;
10438 w
->last_cursor_off_p
= w
->cursor_off_p
;
10440 if (w
== XWINDOW (selected_window
))
10441 w
->last_point
= make_number (BUF_PT (b
));
10443 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
10449 w
->window_end_valid
= w
->buffer
;
10450 #if 0 /* This is incorrect with variable-height lines. */
10451 xassert (XINT (w
->window_end_vpos
)
10452 < (WINDOW_TOTAL_LINES (w
)
10453 - (WINDOW_WANTS_MODELINE_P (w
) ? 1 : 0)));
10455 w
->update_mode_line
= Qnil
;
10460 /* Mark the display of windows in the window tree rooted at WINDOW as
10461 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
10462 windows as accurate. If ACCURATE_P is zero, arrange for windows to
10463 be redisplayed the next time redisplay_internal is called. */
10466 mark_window_display_accurate (window
, accurate_p
)
10467 Lisp_Object window
;
10472 for (; !NILP (window
); window
= w
->next
)
10474 w
= XWINDOW (window
);
10475 mark_window_display_accurate_1 (w
, accurate_p
);
10477 if (!NILP (w
->vchild
))
10478 mark_window_display_accurate (w
->vchild
, accurate_p
);
10479 if (!NILP (w
->hchild
))
10480 mark_window_display_accurate (w
->hchild
, accurate_p
);
10485 update_overlay_arrows (1);
10489 /* Force a thorough redisplay the next time by setting
10490 last_arrow_position and last_arrow_string to t, which is
10491 unequal to any useful value of Voverlay_arrow_... */
10492 update_overlay_arrows (-1);
10497 /* Return value in display table DP (Lisp_Char_Table *) for character
10498 C. Since a display table doesn't have any parent, we don't have to
10499 follow parent. Do not call this function directly but use the
10500 macro DISP_CHAR_VECTOR. */
10503 disp_char_vector (dp
, c
)
10504 struct Lisp_Char_Table
*dp
;
10510 if (SINGLE_BYTE_CHAR_P (c
))
10511 return (dp
->contents
[c
]);
10513 SPLIT_CHAR (c
, code
[0], code
[1], code
[2]);
10516 else if (code
[2] < 32)
10519 /* Here, the possible range of code[0] (== charset ID) is
10520 128..max_charset. Since the top level char table contains data
10521 for multibyte characters after 256th element, we must increment
10522 code[0] by 128 to get a correct index. */
10524 code
[3] = -1; /* anchor */
10526 for (i
= 0; code
[i
] >= 0; i
++, dp
= XCHAR_TABLE (val
))
10528 val
= dp
->contents
[code
[i
]];
10529 if (!SUB_CHAR_TABLE_P (val
))
10530 return (NILP (val
) ? dp
->defalt
: val
);
10533 /* Here, val is a sub char table. We return the default value of
10535 return (dp
->defalt
);
10540 /***********************************************************************
10542 ***********************************************************************/
10544 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
10547 redisplay_windows (window
)
10548 Lisp_Object window
;
10550 while (!NILP (window
))
10552 struct window
*w
= XWINDOW (window
);
10554 if (!NILP (w
->hchild
))
10555 redisplay_windows (w
->hchild
);
10556 else if (!NILP (w
->vchild
))
10557 redisplay_windows (w
->vchild
);
10560 displayed_buffer
= XBUFFER (w
->buffer
);
10561 /* Use list_of_error, not Qerror, so that
10562 we catch only errors and don't run the debugger. */
10563 internal_condition_case_1 (redisplay_window_0
, window
,
10565 redisplay_window_error
);
10573 redisplay_window_error ()
10575 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
10580 redisplay_window_0 (window
)
10581 Lisp_Object window
;
10583 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
10584 redisplay_window (window
, 0);
10589 redisplay_window_1 (window
)
10590 Lisp_Object window
;
10592 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
10593 redisplay_window (window
, 1);
10598 /* Increment GLYPH until it reaches END or CONDITION fails while
10599 adding (GLYPH)->pixel_width to X. */
10601 #define SKIP_GLYPHS(glyph, end, x, condition) \
10604 (x) += (glyph)->pixel_width; \
10607 while ((glyph) < (end) && (condition))
10610 /* Set cursor position of W. PT is assumed to be displayed in ROW.
10611 DELTA is the number of bytes by which positions recorded in ROW
10612 differ from current buffer positions. */
10615 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
10617 struct glyph_row
*row
;
10618 struct glyph_matrix
*matrix
;
10619 int delta
, delta_bytes
, dy
, dvpos
;
10621 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
10622 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
10623 /* The first glyph that starts a sequence of glyphs from string. */
10624 struct glyph
*string_start
;
10625 /* The X coordinate of string_start. */
10626 int string_start_x
;
10627 /* The last known character position. */
10628 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
10629 /* The last known character position before string_start. */
10630 int string_before_pos
;
10632 int pt_old
= PT
- delta
;
10634 /* Skip over glyphs not having an object at the start of the row.
10635 These are special glyphs like truncation marks on terminal
10637 if (row
->displays_text_p
)
10639 && INTEGERP (glyph
->object
)
10640 && glyph
->charpos
< 0)
10642 x
+= glyph
->pixel_width
;
10646 string_start
= NULL
;
10648 && !INTEGERP (glyph
->object
)
10649 && (!BUFFERP (glyph
->object
)
10650 || (last_pos
= glyph
->charpos
) < pt_old
))
10652 if (! STRINGP (glyph
->object
))
10654 string_start
= NULL
;
10655 x
+= glyph
->pixel_width
;
10660 string_before_pos
= last_pos
;
10661 string_start
= glyph
;
10662 string_start_x
= x
;
10663 /* Skip all glyphs from string. */
10664 SKIP_GLYPHS (glyph
, end
, x
, STRINGP (glyph
->object
));
10669 && (glyph
== end
|| !BUFFERP (glyph
->object
) || last_pos
> pt_old
))
10671 /* We may have skipped over point because the previous glyphs
10672 are from string. As there's no easy way to know the
10673 character position of the current glyph, find the correct
10674 glyph on point by scanning from string_start again. */
10676 Lisp_Object string
;
10679 limit
= make_number (pt_old
+ 1);
10681 glyph
= string_start
;
10682 x
= string_start_x
;
10683 string
= glyph
->object
;
10684 pos
= string_buffer_position (w
, string
, string_before_pos
);
10685 /* If STRING is from overlay, LAST_POS == 0. We skip such glyphs
10686 because we always put cursor after overlay strings. */
10687 while (pos
== 0 && glyph
< end
)
10689 string
= glyph
->object
;
10690 SKIP_GLYPHS (glyph
, end
, x
, EQ (glyph
->object
, string
));
10692 pos
= string_buffer_position (w
, glyph
->object
, string_before_pos
);
10695 while (glyph
< end
)
10697 pos
= XINT (Fnext_single_char_property_change
10698 (make_number (pos
), Qdisplay
, Qnil
, limit
));
10701 /* Skip glyphs from the same string. */
10702 string
= glyph
->object
;
10703 SKIP_GLYPHS (glyph
, end
, x
, EQ (glyph
->object
, string
));
10704 /* Skip glyphs from an overlay. */
10706 && ! string_buffer_position (w
, glyph
->object
, pos
))
10708 string
= glyph
->object
;
10709 SKIP_GLYPHS (glyph
, end
, x
, EQ (glyph
->object
, string
));
10714 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
10716 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
10717 w
->cursor
.y
= row
->y
+ dy
;
10719 if (w
== XWINDOW (selected_window
))
10721 if (!row
->continued_p
10722 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
10725 this_line_buffer
= XBUFFER (w
->buffer
);
10727 CHARPOS (this_line_start_pos
)
10728 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
10729 BYTEPOS (this_line_start_pos
)
10730 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
10732 CHARPOS (this_line_end_pos
)
10733 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
10734 BYTEPOS (this_line_end_pos
)
10735 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
10737 this_line_y
= w
->cursor
.y
;
10738 this_line_pixel_height
= row
->height
;
10739 this_line_vpos
= w
->cursor
.vpos
;
10740 this_line_start_x
= row
->x
;
10743 CHARPOS (this_line_start_pos
) = 0;
10748 /* Run window scroll functions, if any, for WINDOW with new window
10749 start STARTP. Sets the window start of WINDOW to that position.
10751 We assume that the window's buffer is really current. */
10753 static INLINE
struct text_pos
10754 run_window_scroll_functions (window
, startp
)
10755 Lisp_Object window
;
10756 struct text_pos startp
;
10758 struct window
*w
= XWINDOW (window
);
10759 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
10761 if (current_buffer
!= XBUFFER (w
->buffer
))
10764 if (!NILP (Vwindow_scroll_functions
))
10766 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
10767 make_number (CHARPOS (startp
)));
10768 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
10769 /* In case the hook functions switch buffers. */
10770 if (current_buffer
!= XBUFFER (w
->buffer
))
10771 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10778 /* Make sure the line containing the cursor is fully visible.
10779 A value of 1 means there is nothing to be done.
10780 (Either the line is fully visible, or it cannot be made so,
10781 or we cannot tell.)
10783 If FORCE_P is non-zero, return 0 even if partial visible cursor row
10784 is higher than window.
10786 A value of 0 means the caller should do scrolling
10787 as if point had gone off the screen. */
10790 make_cursor_line_fully_visible (w
, force_p
)
10794 struct glyph_matrix
*matrix
;
10795 struct glyph_row
*row
;
10798 /* It's not always possible to find the cursor, e.g, when a window
10799 is full of overlay strings. Don't do anything in that case. */
10800 if (w
->cursor
.vpos
< 0)
10803 matrix
= w
->desired_matrix
;
10804 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
10806 /* If the cursor row is not partially visible, there's nothing to do. */
10807 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (row
))
10810 /* If the row the cursor is in is taller than the window's height,
10811 it's not clear what to do, so do nothing. */
10812 window_height
= window_box_height (w
);
10813 if (row
->height
>= window_height
)
10815 if (!force_p
|| w
->vscroll
)
10821 /* This code used to try to scroll the window just enough to make
10822 the line visible. It returned 0 to say that the caller should
10823 allocate larger glyph matrices. */
10825 if (MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (w
, row
))
10827 int dy
= row
->height
- row
->visible_height
;
10830 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
10832 else /* MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P (w, row)) */
10834 int dy
= - (row
->height
- row
->visible_height
);
10837 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
10840 /* When we change the cursor y-position of the selected window,
10841 change this_line_y as well so that the display optimization for
10842 the cursor line of the selected window in redisplay_internal uses
10843 the correct y-position. */
10844 if (w
== XWINDOW (selected_window
))
10845 this_line_y
= w
->cursor
.y
;
10847 /* If vscrolling requires a larger glyph matrix, arrange for a fresh
10848 redisplay with larger matrices. */
10849 if (matrix
->nrows
< required_matrix_height (w
))
10851 fonts_changed_p
= 1;
10860 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
10861 non-zero means only WINDOW is redisplayed in redisplay_internal.
10862 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
10863 in redisplay_window to bring a partially visible line into view in
10864 the case that only the cursor has moved.
10866 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
10867 last screen line's vertical height extends past the end of the screen.
10871 1 if scrolling succeeded
10873 0 if scrolling didn't find point.
10875 -1 if new fonts have been loaded so that we must interrupt
10876 redisplay, adjust glyph matrices, and try again. */
10882 SCROLLING_NEED_LARGER_MATRICES
10886 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
10887 scroll_step
, temp_scroll_step
, last_line_misfit
)
10888 Lisp_Object window
;
10889 int just_this_one_p
;
10890 EMACS_INT scroll_conservatively
, scroll_step
;
10891 int temp_scroll_step
;
10892 int last_line_misfit
;
10894 struct window
*w
= XWINDOW (window
);
10895 struct frame
*f
= XFRAME (w
->frame
);
10896 struct text_pos scroll_margin_pos
;
10897 struct text_pos pos
;
10898 struct text_pos startp
;
10900 Lisp_Object window_end
;
10901 int this_scroll_margin
;
10905 int amount_to_scroll
= 0;
10906 Lisp_Object aggressive
;
10908 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
10911 debug_method_add (w
, "try_scrolling");
10914 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
10916 /* Compute scroll margin height in pixels. We scroll when point is
10917 within this distance from the top or bottom of the window. */
10918 if (scroll_margin
> 0)
10920 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
10921 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
10924 this_scroll_margin
= 0;
10926 /* Force scroll_conservatively to have a reasonable value so it doesn't
10927 cause an overflow while computing how much to scroll. */
10928 if (scroll_conservatively
)
10929 scroll_conservatively
= min (scroll_conservatively
,
10930 MOST_POSITIVE_FIXNUM
/ FRAME_LINE_HEIGHT (f
));
10932 /* Compute how much we should try to scroll maximally to bring point
10934 if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
10935 scroll_max
= max (scroll_step
,
10936 max (scroll_conservatively
, temp_scroll_step
));
10937 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
10938 || NUMBERP (current_buffer
->scroll_up_aggressively
))
10939 /* We're trying to scroll because of aggressive scrolling
10940 but no scroll_step is set. Choose an arbitrary one. Maybe
10941 there should be a variable for this. */
10945 scroll_max
*= FRAME_LINE_HEIGHT (f
);
10947 /* Decide whether we have to scroll down. Start at the window end
10948 and move this_scroll_margin up to find the position of the scroll
10950 window_end
= Fwindow_end (window
, Qt
);
10954 CHARPOS (scroll_margin_pos
) = XINT (window_end
);
10955 BYTEPOS (scroll_margin_pos
) = CHAR_TO_BYTE (CHARPOS (scroll_margin_pos
));
10957 if (this_scroll_margin
|| extra_scroll_margin_lines
)
10959 start_display (&it
, w
, scroll_margin_pos
);
10960 if (this_scroll_margin
)
10961 move_it_vertically (&it
, - this_scroll_margin
);
10962 if (extra_scroll_margin_lines
)
10963 move_it_by_lines (&it
, - extra_scroll_margin_lines
, 0);
10964 scroll_margin_pos
= it
.current
.pos
;
10967 if (PT
>= CHARPOS (scroll_margin_pos
))
10971 /* Point is in the scroll margin at the bottom of the window, or
10972 below. Compute a new window start that makes point visible. */
10974 /* Compute the distance from the scroll margin to PT.
10975 Give up if the distance is greater than scroll_max. */
10976 start_display (&it
, w
, scroll_margin_pos
);
10978 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
10979 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
10981 /* To make point visible, we have to move the window start
10982 down so that the line the cursor is in is visible, which
10983 means we have to add in the height of the cursor line. */
10984 dy
= line_bottom_y (&it
) - y0
;
10986 if (dy
> scroll_max
)
10987 return SCROLLING_FAILED
;
10989 /* Move the window start down. If scrolling conservatively,
10990 move it just enough down to make point visible. If
10991 scroll_step is set, move it down by scroll_step. */
10992 start_display (&it
, w
, startp
);
10994 if (scroll_conservatively
)
10995 /* Set AMOUNT_TO_SCROLL to at least one line,
10996 and at most scroll_conservatively lines. */
10998 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
10999 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
11000 else if (scroll_step
|| temp_scroll_step
)
11001 amount_to_scroll
= scroll_max
;
11004 aggressive
= current_buffer
->scroll_up_aggressively
;
11005 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
11006 if (NUMBERP (aggressive
))
11008 double float_amount
= XFLOATINT (aggressive
) * height
;
11009 amount_to_scroll
= float_amount
;
11010 if (amount_to_scroll
== 0 && float_amount
> 0)
11011 amount_to_scroll
= 1;
11015 if (amount_to_scroll
<= 0)
11016 return SCROLLING_FAILED
;
11018 /* If moving by amount_to_scroll leaves STARTP unchanged,
11019 move it down one screen line. */
11021 move_it_vertically (&it
, amount_to_scroll
);
11022 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
11023 move_it_by_lines (&it
, 1, 1);
11024 startp
= it
.current
.pos
;
11028 /* See if point is inside the scroll margin at the top of the
11030 scroll_margin_pos
= startp
;
11031 if (this_scroll_margin
)
11033 start_display (&it
, w
, startp
);
11034 move_it_vertically (&it
, this_scroll_margin
);
11035 scroll_margin_pos
= it
.current
.pos
;
11038 if (PT
< CHARPOS (scroll_margin_pos
))
11040 /* Point is in the scroll margin at the top of the window or
11041 above what is displayed in the window. */
11044 /* Compute the vertical distance from PT to the scroll
11045 margin position. Give up if distance is greater than
11047 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
11048 start_display (&it
, w
, pos
);
11050 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
11051 it
.last_visible_y
, -1,
11052 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
11053 dy
= it
.current_y
- y0
;
11054 if (dy
> scroll_max
)
11055 return SCROLLING_FAILED
;
11057 /* Compute new window start. */
11058 start_display (&it
, w
, startp
);
11060 if (scroll_conservatively
)
11062 max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
11063 else if (scroll_step
|| temp_scroll_step
)
11064 amount_to_scroll
= scroll_max
;
11067 aggressive
= current_buffer
->scroll_down_aggressively
;
11068 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
11069 if (NUMBERP (aggressive
))
11071 double float_amount
= XFLOATINT (aggressive
) * height
;
11072 amount_to_scroll
= float_amount
;
11073 if (amount_to_scroll
== 0 && float_amount
> 0)
11074 amount_to_scroll
= 1;
11078 if (amount_to_scroll
<= 0)
11079 return SCROLLING_FAILED
;
11081 move_it_vertically (&it
, - amount_to_scroll
);
11082 startp
= it
.current
.pos
;
11086 /* Run window scroll functions. */
11087 startp
= run_window_scroll_functions (window
, startp
);
11089 /* Display the window. Give up if new fonts are loaded, or if point
11091 if (!try_window (window
, startp
))
11092 rc
= SCROLLING_NEED_LARGER_MATRICES
;
11093 else if (w
->cursor
.vpos
< 0)
11095 clear_glyph_matrix (w
->desired_matrix
);
11096 rc
= SCROLLING_FAILED
;
11100 /* Maybe forget recorded base line for line number display. */
11101 if (!just_this_one_p
11102 || current_buffer
->clip_changed
11103 || BEG_UNCHANGED
< CHARPOS (startp
))
11104 w
->base_line_number
= Qnil
;
11106 /* If cursor ends up on a partially visible line,
11107 treat that as being off the bottom of the screen. */
11108 if (! make_cursor_line_fully_visible (w
, extra_scroll_margin_lines
<= 1))
11110 clear_glyph_matrix (w
->desired_matrix
);
11111 ++extra_scroll_margin_lines
;
11114 rc
= SCROLLING_SUCCESS
;
11121 /* Compute a suitable window start for window W if display of W starts
11122 on a continuation line. Value is non-zero if a new window start
11125 The new window start will be computed, based on W's width, starting
11126 from the start of the continued line. It is the start of the
11127 screen line with the minimum distance from the old start W->start. */
11130 compute_window_start_on_continuation_line (w
)
11133 struct text_pos pos
, start_pos
;
11134 int window_start_changed_p
= 0;
11136 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
11138 /* If window start is on a continuation line... Window start may be
11139 < BEGV in case there's invisible text at the start of the
11140 buffer (M-x rmail, for example). */
11141 if (CHARPOS (start_pos
) > BEGV
11142 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
11145 struct glyph_row
*row
;
11147 /* Handle the case that the window start is out of range. */
11148 if (CHARPOS (start_pos
) < BEGV
)
11149 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
11150 else if (CHARPOS (start_pos
) > ZV
)
11151 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
11153 /* Find the start of the continued line. This should be fast
11154 because scan_buffer is fast (newline cache). */
11155 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
11156 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
11157 row
, DEFAULT_FACE_ID
);
11158 reseat_at_previous_visible_line_start (&it
);
11160 /* If the line start is "too far" away from the window start,
11161 say it takes too much time to compute a new window start. */
11162 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
11163 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
11165 int min_distance
, distance
;
11167 /* Move forward by display lines to find the new window
11168 start. If window width was enlarged, the new start can
11169 be expected to be > the old start. If window width was
11170 decreased, the new window start will be < the old start.
11171 So, we're looking for the display line start with the
11172 minimum distance from the old window start. */
11173 pos
= it
.current
.pos
;
11174 min_distance
= INFINITY
;
11175 while ((distance
= abs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
11176 distance
< min_distance
)
11178 min_distance
= distance
;
11179 pos
= it
.current
.pos
;
11180 move_it_by_lines (&it
, 1, 0);
11183 /* Set the window start there. */
11184 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
11185 window_start_changed_p
= 1;
11189 return window_start_changed_p
;
11193 /* Try cursor movement in case text has not changed in window WINDOW,
11194 with window start STARTP. Value is
11196 CURSOR_MOVEMENT_SUCCESS if successful
11198 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
11200 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
11201 display. *SCROLL_STEP is set to 1, under certain circumstances, if
11202 we want to scroll as if scroll-step were set to 1. See the code.
11204 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
11205 which case we have to abort this redisplay, and adjust matrices
11210 CURSOR_MOVEMENT_SUCCESS
,
11211 CURSOR_MOVEMENT_CANNOT_BE_USED
,
11212 CURSOR_MOVEMENT_MUST_SCROLL
,
11213 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
11217 try_cursor_movement (window
, startp
, scroll_step
)
11218 Lisp_Object window
;
11219 struct text_pos startp
;
11222 struct window
*w
= XWINDOW (window
);
11223 struct frame
*f
= XFRAME (w
->frame
);
11224 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
11227 if (inhibit_try_cursor_movement
)
11231 /* Handle case where text has not changed, only point, and it has
11232 not moved off the frame. */
11233 if (/* Point may be in this window. */
11234 PT
>= CHARPOS (startp
)
11235 /* Selective display hasn't changed. */
11236 && !current_buffer
->clip_changed
11237 /* Function force-mode-line-update is used to force a thorough
11238 redisplay. It sets either windows_or_buffers_changed or
11239 update_mode_lines. So don't take a shortcut here for these
11241 && !update_mode_lines
11242 && !windows_or_buffers_changed
11243 && !cursor_type_changed
11244 /* Can't use this case if highlighting a region. When a
11245 region exists, cursor movement has to do more than just
11247 && !(!NILP (Vtransient_mark_mode
)
11248 && !NILP (current_buffer
->mark_active
))
11249 && NILP (w
->region_showing
)
11250 && NILP (Vshow_trailing_whitespace
)
11251 /* Right after splitting windows, last_point may be nil. */
11252 && INTEGERP (w
->last_point
)
11253 /* This code is not used for mini-buffer for the sake of the case
11254 of redisplaying to replace an echo area message; since in
11255 that case the mini-buffer contents per se are usually
11256 unchanged. This code is of no real use in the mini-buffer
11257 since the handling of this_line_start_pos, etc., in redisplay
11258 handles the same cases. */
11259 && !EQ (window
, minibuf_window
)
11260 /* When splitting windows or for new windows, it happens that
11261 redisplay is called with a nil window_end_vpos or one being
11262 larger than the window. This should really be fixed in
11263 window.c. I don't have this on my list, now, so we do
11264 approximately the same as the old redisplay code. --gerd. */
11265 && INTEGERP (w
->window_end_vpos
)
11266 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
11267 && (FRAME_WINDOW_P (f
)
11268 || !overlay_arrow_in_current_buffer_p ()))
11270 int this_scroll_margin
, top_scroll_margin
;
11271 struct glyph_row
*row
= NULL
;
11274 debug_method_add (w
, "cursor movement");
11277 /* Scroll if point within this distance from the top or bottom
11278 of the window. This is a pixel value. */
11279 this_scroll_margin
= max (0, scroll_margin
);
11280 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
11281 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
11283 top_scroll_margin
= this_scroll_margin
;
11284 if (WINDOW_WANTS_HEADER_LINE_P (w
))
11285 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
11287 /* Start with the row the cursor was displayed during the last
11288 not paused redisplay. Give up if that row is not valid. */
11289 if (w
->last_cursor
.vpos
< 0
11290 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
11291 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
11294 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
11295 if (row
->mode_line_p
)
11297 if (!row
->enabled_p
)
11298 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
11301 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
11304 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
11306 if (PT
> XFASTINT (w
->last_point
))
11308 /* Point has moved forward. */
11309 while (MATRIX_ROW_END_CHARPOS (row
) < PT
11310 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
11312 xassert (row
->enabled_p
);
11316 /* The end position of a row equals the start position
11317 of the next row. If PT is there, we would rather
11318 display it in the next line. */
11319 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
11320 && MATRIX_ROW_END_CHARPOS (row
) == PT
11321 && !cursor_row_p (w
, row
))
11324 /* If within the scroll margin, scroll. Note that
11325 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
11326 the next line would be drawn, and that
11327 this_scroll_margin can be zero. */
11328 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
11329 || PT
> MATRIX_ROW_END_CHARPOS (row
)
11330 /* Line is completely visible last line in window
11331 and PT is to be set in the next line. */
11332 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
11333 && PT
== MATRIX_ROW_END_CHARPOS (row
)
11334 && !row
->ends_at_zv_p
11335 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
11338 else if (PT
< XFASTINT (w
->last_point
))
11340 /* Cursor has to be moved backward. Note that PT >=
11341 CHARPOS (startp) because of the outer
11343 while (!row
->mode_line_p
11344 && (MATRIX_ROW_START_CHARPOS (row
) > PT
11345 || (MATRIX_ROW_START_CHARPOS (row
) == PT
11346 && MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)))
11347 && (row
->y
> top_scroll_margin
11348 || CHARPOS (startp
) == BEGV
))
11350 xassert (row
->enabled_p
);
11354 /* Consider the following case: Window starts at BEGV,
11355 there is invisible, intangible text at BEGV, so that
11356 display starts at some point START > BEGV. It can
11357 happen that we are called with PT somewhere between
11358 BEGV and START. Try to handle that case. */
11359 if (row
< w
->current_matrix
->rows
11360 || row
->mode_line_p
)
11362 row
= w
->current_matrix
->rows
;
11363 if (row
->mode_line_p
)
11367 /* Due to newlines in overlay strings, we may have to
11368 skip forward over overlay strings. */
11369 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
11370 && MATRIX_ROW_END_CHARPOS (row
) == PT
11371 && !cursor_row_p (w
, row
))
11374 /* If within the scroll margin, scroll. */
11375 if (row
->y
< top_scroll_margin
11376 && CHARPOS (startp
) != BEGV
)
11380 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
11381 || PT
> MATRIX_ROW_END_CHARPOS (row
))
11383 /* if PT is not in the glyph row, give up. */
11384 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
11386 else if (MATRIX_ROW_PARTIALLY_VISIBLE_P (row
))
11388 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
11389 && !row
->ends_at_zv_p
11390 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
11391 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
11392 else if (row
->height
> window_box_height (w
))
11394 /* If we end up in a partially visible line, let's
11395 make it fully visible, except when it's taller
11396 than the window, in which case we can't do much
11399 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
11403 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11404 if (!make_cursor_line_fully_visible (w
, 0))
11405 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
11407 rc
= CURSOR_MOVEMENT_SUCCESS
;
11411 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
11414 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11415 rc
= CURSOR_MOVEMENT_SUCCESS
;
11424 set_vertical_scroll_bar (w
)
11427 int start
, end
, whole
;
11429 /* Calculate the start and end positions for the current window.
11430 At some point, it would be nice to choose between scrollbars
11431 which reflect the whole buffer size, with special markers
11432 indicating narrowing, and scrollbars which reflect only the
11435 Note that mini-buffers sometimes aren't displaying any text. */
11436 if (!MINI_WINDOW_P (w
)
11437 || (w
== XWINDOW (minibuf_window
)
11438 && NILP (echo_area_buffer
[0])))
11440 struct buffer
*buf
= XBUFFER (w
->buffer
);
11441 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
11442 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
11443 /* I don't think this is guaranteed to be right. For the
11444 moment, we'll pretend it is. */
11445 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
11449 if (whole
< (end
- start
))
11450 whole
= end
- start
;
11453 start
= end
= whole
= 0;
11455 /* Indicate what this scroll bar ought to be displaying now. */
11456 set_vertical_scroll_bar_hook (w
, end
- start
, whole
, start
);
11460 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
11461 selected_window is redisplayed.
11463 We can return without actually redisplaying the window if
11464 fonts_changed_p is nonzero. In that case, redisplay_internal will
11468 redisplay_window (window
, just_this_one_p
)
11469 Lisp_Object window
;
11470 int just_this_one_p
;
11472 struct window
*w
= XWINDOW (window
);
11473 struct frame
*f
= XFRAME (w
->frame
);
11474 struct buffer
*buffer
= XBUFFER (w
->buffer
);
11475 struct buffer
*old
= current_buffer
;
11476 struct text_pos lpoint
, opoint
, startp
;
11477 int update_mode_line
;
11480 /* Record it now because it's overwritten. */
11481 int current_matrix_up_to_date_p
= 0;
11482 int used_current_matrix_p
= 0;
11483 /* This is less strict than current_matrix_up_to_date_p.
11484 It indictes that the buffer contents and narrowing are unchanged. */
11485 int buffer_unchanged_p
= 0;
11486 int temp_scroll_step
= 0;
11487 int count
= SPECPDL_INDEX ();
11489 int centering_position
;
11490 int last_line_misfit
= 0;
11492 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
11495 /* W must be a leaf window here. */
11496 xassert (!NILP (w
->buffer
));
11498 *w
->desired_matrix
->method
= 0;
11501 specbind (Qinhibit_point_motion_hooks
, Qt
);
11503 reconsider_clip_changes (w
, buffer
);
11505 /* Has the mode line to be updated? */
11506 update_mode_line
= (!NILP (w
->update_mode_line
)
11507 || update_mode_lines
11508 || buffer
->clip_changed
11509 || buffer
->prevent_redisplay_optimizations_p
);
11511 if (MINI_WINDOW_P (w
))
11513 if (w
== XWINDOW (echo_area_window
)
11514 && !NILP (echo_area_buffer
[0]))
11516 if (update_mode_line
)
11517 /* We may have to update a tty frame's menu bar or a
11518 tool-bar. Example `M-x C-h C-h C-g'. */
11519 goto finish_menu_bars
;
11521 /* We've already displayed the echo area glyphs in this window. */
11522 goto finish_scroll_bars
;
11524 else if ((w
!= XWINDOW (minibuf_window
)
11525 || minibuf_level
== 0)
11526 /* When buffer is nonempty, redisplay window normally. */
11527 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
11528 /* Quail displays non-mini buffers in minibuffer window.
11529 In that case, redisplay the window normally. */
11530 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
11532 /* W is a mini-buffer window, but it's not active, so clear
11534 int yb
= window_text_bottom_y (w
);
11535 struct glyph_row
*row
;
11538 for (y
= 0, row
= w
->desired_matrix
->rows
;
11540 y
+= row
->height
, ++row
)
11541 blank_row (w
, row
, y
);
11542 goto finish_scroll_bars
;
11545 clear_glyph_matrix (w
->desired_matrix
);
11548 /* Otherwise set up data on this window; select its buffer and point
11550 /* Really select the buffer, for the sake of buffer-local
11552 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11553 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
11555 current_matrix_up_to_date_p
11556 = (!NILP (w
->window_end_valid
)
11557 && !current_buffer
->clip_changed
11558 && !current_buffer
->prevent_redisplay_optimizations_p
11559 && XFASTINT (w
->last_modified
) >= MODIFF
11560 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
11563 = (!NILP (w
->window_end_valid
)
11564 && !current_buffer
->clip_changed
11565 && XFASTINT (w
->last_modified
) >= MODIFF
11566 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
11568 /* When windows_or_buffers_changed is non-zero, we can't rely on
11569 the window end being valid, so set it to nil there. */
11570 if (windows_or_buffers_changed
)
11572 /* If window starts on a continuation line, maybe adjust the
11573 window start in case the window's width changed. */
11574 if (XMARKER (w
->start
)->buffer
== current_buffer
)
11575 compute_window_start_on_continuation_line (w
);
11577 w
->window_end_valid
= Qnil
;
11580 /* Some sanity checks. */
11581 CHECK_WINDOW_END (w
);
11582 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
11584 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
11587 /* If %c is in mode line, update it if needed. */
11588 if (!NILP (w
->column_number_displayed
)
11589 /* This alternative quickly identifies a common case
11590 where no change is needed. */
11591 && !(PT
== XFASTINT (w
->last_point
)
11592 && XFASTINT (w
->last_modified
) >= MODIFF
11593 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11594 && (XFASTINT (w
->column_number_displayed
)
11595 != (int) current_column ())) /* iftc */
11596 update_mode_line
= 1;
11598 /* Count number of windows showing the selected buffer. An indirect
11599 buffer counts as its base buffer. */
11600 if (!just_this_one_p
)
11602 struct buffer
*current_base
, *window_base
;
11603 current_base
= current_buffer
;
11604 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
11605 if (current_base
->base_buffer
)
11606 current_base
= current_base
->base_buffer
;
11607 if (window_base
->base_buffer
)
11608 window_base
= window_base
->base_buffer
;
11609 if (current_base
== window_base
)
11613 /* Point refers normally to the selected window. For any other
11614 window, set up appropriate value. */
11615 if (!EQ (window
, selected_window
))
11617 int new_pt
= XMARKER (w
->pointm
)->charpos
;
11618 int new_pt_byte
= marker_byte_position (w
->pointm
);
11622 new_pt_byte
= BEGV_BYTE
;
11623 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
11625 else if (new_pt
> (ZV
- 1))
11628 new_pt_byte
= ZV_BYTE
;
11629 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
11632 /* We don't use SET_PT so that the point-motion hooks don't run. */
11633 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
11636 /* If any of the character widths specified in the display table
11637 have changed, invalidate the width run cache. It's true that
11638 this may be a bit late to catch such changes, but the rest of
11639 redisplay goes (non-fatally) haywire when the display table is
11640 changed, so why should we worry about doing any better? */
11641 if (current_buffer
->width_run_cache
)
11643 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
11645 if (! disptab_matches_widthtab (disptab
,
11646 XVECTOR (current_buffer
->width_table
)))
11648 invalidate_region_cache (current_buffer
,
11649 current_buffer
->width_run_cache
,
11651 recompute_width_table (current_buffer
, disptab
);
11655 /* If window-start is screwed up, choose a new one. */
11656 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
11659 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
11661 /* If someone specified a new starting point but did not insist,
11662 check whether it can be used. */
11663 if (!NILP (w
->optional_new_start
)
11664 && CHARPOS (startp
) >= BEGV
11665 && CHARPOS (startp
) <= ZV
)
11667 w
->optional_new_start
= Qnil
;
11668 start_display (&it
, w
, startp
);
11669 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
11670 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
11671 if (IT_CHARPOS (it
) == PT
)
11672 w
->force_start
= Qt
;
11673 /* IT may overshoot PT if text at PT is invisible. */
11674 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
11675 w
->force_start
= Qt
;
11680 /* Handle case where place to start displaying has been specified,
11681 unless the specified location is outside the accessible range. */
11682 if (!NILP (w
->force_start
)
11683 || w
->frozen_window_start_p
)
11685 /* We set this later on if we have to adjust point. */
11688 w
->force_start
= Qnil
;
11690 w
->window_end_valid
= Qnil
;
11692 /* Forget any recorded base line for line number display. */
11693 if (!buffer_unchanged_p
)
11694 w
->base_line_number
= Qnil
;
11696 /* Redisplay the mode line. Select the buffer properly for that.
11697 Also, run the hook window-scroll-functions
11698 because we have scrolled. */
11699 /* Note, we do this after clearing force_start because
11700 if there's an error, it is better to forget about force_start
11701 than to get into an infinite loop calling the hook functions
11702 and having them get more errors. */
11703 if (!update_mode_line
11704 || ! NILP (Vwindow_scroll_functions
))
11706 update_mode_line
= 1;
11707 w
->update_mode_line
= Qt
;
11708 startp
= run_window_scroll_functions (window
, startp
);
11711 w
->last_modified
= make_number (0);
11712 w
->last_overlay_modified
= make_number (0);
11713 if (CHARPOS (startp
) < BEGV
)
11714 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
11715 else if (CHARPOS (startp
) > ZV
)
11716 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
11718 /* Redisplay, then check if cursor has been set during the
11719 redisplay. Give up if new fonts were loaded. */
11720 if (!try_window (window
, startp
))
11722 w
->force_start
= Qt
;
11723 clear_glyph_matrix (w
->desired_matrix
);
11724 goto need_larger_matrices
;
11727 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
11729 /* If point does not appear, try to move point so it does
11730 appear. The desired matrix has been built above, so we
11731 can use it here. */
11732 new_vpos
= window_box_height (w
) / 2;
11735 if (!make_cursor_line_fully_visible (w
, 0))
11737 /* Point does appear, but on a line partly visible at end of window.
11738 Move it back to a fully-visible line. */
11739 new_vpos
= window_box_height (w
);
11742 /* If we need to move point for either of the above reasons,
11743 now actually do it. */
11746 struct glyph_row
*row
;
11748 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
11749 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
11752 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
11753 MATRIX_ROW_START_BYTEPOS (row
));
11755 if (w
!= XWINDOW (selected_window
))
11756 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
11757 else if (current_buffer
== old
)
11758 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
11760 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
11762 /* If we are highlighting the region, then we just changed
11763 the region, so redisplay to show it. */
11764 if (!NILP (Vtransient_mark_mode
)
11765 && !NILP (current_buffer
->mark_active
))
11767 clear_glyph_matrix (w
->desired_matrix
);
11768 if (!try_window (window
, startp
))
11769 goto need_larger_matrices
;
11774 debug_method_add (w
, "forced window start");
11779 /* Handle case where text has not changed, only point, and it has
11780 not moved off the frame, and we are not retrying after hscroll.
11781 (current_matrix_up_to_date_p is nonzero when retrying.) */
11782 if (current_matrix_up_to_date_p
11783 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
11784 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
11788 case CURSOR_MOVEMENT_SUCCESS
:
11789 used_current_matrix_p
= 1;
11792 #if 0 /* try_cursor_movement never returns this value. */
11793 case CURSOR_MOVEMENT_NEED_LARGER_MATRICES
:
11794 goto need_larger_matrices
;
11797 case CURSOR_MOVEMENT_MUST_SCROLL
:
11798 goto try_to_scroll
;
11804 /* If current starting point was originally the beginning of a line
11805 but no longer is, find a new starting point. */
11806 else if (!NILP (w
->start_at_line_beg
)
11807 && !(CHARPOS (startp
) <= BEGV
11808 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
11811 debug_method_add (w
, "recenter 1");
11816 /* Try scrolling with try_window_id. Value is > 0 if update has
11817 been done, it is -1 if we know that the same window start will
11818 not work. It is 0 if unsuccessful for some other reason. */
11819 else if ((tem
= try_window_id (w
)) != 0)
11822 debug_method_add (w
, "try_window_id %d", tem
);
11825 if (fonts_changed_p
)
11826 goto need_larger_matrices
;
11830 /* Otherwise try_window_id has returned -1 which means that we
11831 don't want the alternative below this comment to execute. */
11833 else if (CHARPOS (startp
) >= BEGV
11834 && CHARPOS (startp
) <= ZV
11835 && PT
>= CHARPOS (startp
)
11836 && (CHARPOS (startp
) < ZV
11837 /* Avoid starting at end of buffer. */
11838 || CHARPOS (startp
) == BEGV
11839 || (XFASTINT (w
->last_modified
) >= MODIFF
11840 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
11843 debug_method_add (w
, "same window start");
11846 /* Try to redisplay starting at same place as before.
11847 If point has not moved off frame, accept the results. */
11848 if (!current_matrix_up_to_date_p
11849 /* Don't use try_window_reusing_current_matrix in this case
11850 because a window scroll function can have changed the
11852 || !NILP (Vwindow_scroll_functions
)
11853 || MINI_WINDOW_P (w
)
11854 || !(used_current_matrix_p
=
11855 try_window_reusing_current_matrix (w
)))
11857 IF_DEBUG (debug_method_add (w
, "1"));
11858 try_window (window
, startp
);
11861 if (fonts_changed_p
)
11862 goto need_larger_matrices
;
11864 if (w
->cursor
.vpos
>= 0)
11866 if (!just_this_one_p
11867 || current_buffer
->clip_changed
11868 || BEG_UNCHANGED
< CHARPOS (startp
))
11869 /* Forget any recorded base line for line number display. */
11870 w
->base_line_number
= Qnil
;
11872 if (!make_cursor_line_fully_visible (w
, 1))
11874 clear_glyph_matrix (w
->desired_matrix
);
11875 last_line_misfit
= 1;
11877 /* Drop through and scroll. */
11882 clear_glyph_matrix (w
->desired_matrix
);
11887 w
->last_modified
= make_number (0);
11888 w
->last_overlay_modified
= make_number (0);
11890 /* Redisplay the mode line. Select the buffer properly for that. */
11891 if (!update_mode_line
)
11893 update_mode_line
= 1;
11894 w
->update_mode_line
= Qt
;
11897 /* Try to scroll by specified few lines. */
11898 if ((scroll_conservatively
11900 || temp_scroll_step
11901 || NUMBERP (current_buffer
->scroll_up_aggressively
)
11902 || NUMBERP (current_buffer
->scroll_down_aggressively
))
11903 && !current_buffer
->clip_changed
11904 && CHARPOS (startp
) >= BEGV
11905 && CHARPOS (startp
) <= ZV
)
11907 /* The function returns -1 if new fonts were loaded, 1 if
11908 successful, 0 if not successful. */
11909 int rc
= try_scrolling (window
, just_this_one_p
,
11910 scroll_conservatively
,
11912 temp_scroll_step
, last_line_misfit
);
11915 case SCROLLING_SUCCESS
:
11918 case SCROLLING_NEED_LARGER_MATRICES
:
11919 goto need_larger_matrices
;
11921 case SCROLLING_FAILED
:
11929 /* Finally, just choose place to start which centers point */
11932 centering_position
= window_box_height (w
) / 2;
11935 /* Jump here with centering_position already set to 0. */
11938 debug_method_add (w
, "recenter");
11941 /* w->vscroll = 0; */
11943 /* Forget any previously recorded base line for line number display. */
11944 if (!buffer_unchanged_p
)
11945 w
->base_line_number
= Qnil
;
11947 /* Move backward half the height of the window. */
11948 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
11949 it
.current_y
= it
.last_visible_y
;
11950 move_it_vertically_backward (&it
, centering_position
);
11951 xassert (IT_CHARPOS (it
) >= BEGV
);
11953 /* The function move_it_vertically_backward may move over more
11954 than the specified y-distance. If it->w is small, e.g. a
11955 mini-buffer window, we may end up in front of the window's
11956 display area. Start displaying at the start of the line
11957 containing PT in this case. */
11958 if (it
.current_y
<= 0)
11960 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
11961 move_it_vertically (&it
, 0);
11962 xassert (IT_CHARPOS (it
) <= PT
);
11966 it
.current_x
= it
.hpos
= 0;
11968 /* Set startp here explicitly in case that helps avoid an infinite loop
11969 in case the window-scroll-functions functions get errors. */
11970 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
11972 /* Run scroll hooks. */
11973 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
11975 /* Redisplay the window. */
11976 if (!current_matrix_up_to_date_p
11977 || windows_or_buffers_changed
11978 || cursor_type_changed
11979 /* Don't use try_window_reusing_current_matrix in this case
11980 because it can have changed the buffer. */
11981 || !NILP (Vwindow_scroll_functions
)
11982 || !just_this_one_p
11983 || MINI_WINDOW_P (w
)
11984 || !(used_current_matrix_p
=
11985 try_window_reusing_current_matrix (w
)))
11986 try_window (window
, startp
);
11988 /* If new fonts have been loaded (due to fontsets), give up. We
11989 have to start a new redisplay since we need to re-adjust glyph
11991 if (fonts_changed_p
)
11992 goto need_larger_matrices
;
11994 /* If cursor did not appear assume that the middle of the window is
11995 in the first line of the window. Do it again with the next line.
11996 (Imagine a window of height 100, displaying two lines of height
11997 60. Moving back 50 from it->last_visible_y will end in the first
11999 if (w
->cursor
.vpos
< 0)
12001 if (!NILP (w
->window_end_valid
)
12002 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
12004 clear_glyph_matrix (w
->desired_matrix
);
12005 move_it_by_lines (&it
, 1, 0);
12006 try_window (window
, it
.current
.pos
);
12008 else if (PT
< IT_CHARPOS (it
))
12010 clear_glyph_matrix (w
->desired_matrix
);
12011 move_it_by_lines (&it
, -1, 0);
12012 try_window (window
, it
.current
.pos
);
12016 /* Not much we can do about it. */
12020 /* Consider the following case: Window starts at BEGV, there is
12021 invisible, intangible text at BEGV, so that display starts at
12022 some point START > BEGV. It can happen that we are called with
12023 PT somewhere between BEGV and START. Try to handle that case. */
12024 if (w
->cursor
.vpos
< 0)
12026 struct glyph_row
*row
= w
->current_matrix
->rows
;
12027 if (row
->mode_line_p
)
12029 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
12032 if (!make_cursor_line_fully_visible (w
, centering_position
> 0))
12034 /* If vscroll is enabled, disable it and try again. */
12038 clear_glyph_matrix (w
->desired_matrix
);
12042 /* If centering point failed to make the whole line visible,
12043 put point at the top instead. That has to make the whole line
12044 visible, if it can be done. */
12045 clear_glyph_matrix (w
->desired_matrix
);
12046 centering_position
= 0;
12052 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12053 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
12054 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
12057 /* Display the mode line, if we must. */
12058 if ((update_mode_line
12059 /* If window not full width, must redo its mode line
12060 if (a) the window to its side is being redone and
12061 (b) we do a frame-based redisplay. This is a consequence
12062 of how inverted lines are drawn in frame-based redisplay. */
12063 || (!just_this_one_p
12064 && !FRAME_WINDOW_P (f
)
12065 && !WINDOW_FULL_WIDTH_P (w
))
12066 /* Line number to display. */
12067 || INTEGERP (w
->base_line_pos
)
12068 /* Column number is displayed and different from the one displayed. */
12069 || (!NILP (w
->column_number_displayed
)
12070 && (XFASTINT (w
->column_number_displayed
)
12071 != (int) current_column ()))) /* iftc */
12072 /* This means that the window has a mode line. */
12073 && (WINDOW_WANTS_MODELINE_P (w
)
12074 || WINDOW_WANTS_HEADER_LINE_P (w
)))
12076 display_mode_lines (w
);
12078 /* If mode line height has changed, arrange for a thorough
12079 immediate redisplay using the correct mode line height. */
12080 if (WINDOW_WANTS_MODELINE_P (w
)
12081 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
12083 fonts_changed_p
= 1;
12084 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
12085 = DESIRED_MODE_LINE_HEIGHT (w
);
12088 /* If top line height has changed, arrange for a thorough
12089 immediate redisplay using the correct mode line height. */
12090 if (WINDOW_WANTS_HEADER_LINE_P (w
)
12091 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
12093 fonts_changed_p
= 1;
12094 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
12095 = DESIRED_HEADER_LINE_HEIGHT (w
);
12098 if (fonts_changed_p
)
12099 goto need_larger_matrices
;
12102 if (!line_number_displayed
12103 && !BUFFERP (w
->base_line_pos
))
12105 w
->base_line_pos
= Qnil
;
12106 w
->base_line_number
= Qnil
;
12111 /* When we reach a frame's selected window, redo the frame's menu bar. */
12112 if (update_mode_line
12113 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
12115 int redisplay_menu_p
= 0;
12116 int redisplay_tool_bar_p
= 0;
12118 if (FRAME_WINDOW_P (f
))
12120 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
12121 || defined (USE_GTK)
12122 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
12124 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
12128 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
12130 if (redisplay_menu_p
)
12131 display_menu_bar (w
);
12133 #ifdef HAVE_WINDOW_SYSTEM
12135 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
12137 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
12138 && (FRAME_TOOL_BAR_LINES (f
) > 0
12139 || auto_resize_tool_bars_p
);
12143 if (redisplay_tool_bar_p
)
12144 redisplay_tool_bar (f
);
12148 #ifdef HAVE_WINDOW_SYSTEM
12149 if (update_window_fringes (w
, 0)
12150 && !just_this_one_p
12151 && (used_current_matrix_p
|| overlay_arrow_seen
)
12152 && !w
->pseudo_window_p
)
12156 draw_window_fringes (w
);
12160 #endif /* HAVE_WINDOW_SYSTEM */
12162 /* We go to this label, with fonts_changed_p nonzero,
12163 if it is necessary to try again using larger glyph matrices.
12164 We have to redeem the scroll bar even in this case,
12165 because the loop in redisplay_internal expects that. */
12166 need_larger_matrices
:
12168 finish_scroll_bars
:
12170 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
12172 /* Set the thumb's position and size. */
12173 set_vertical_scroll_bar (w
);
12175 /* Note that we actually used the scroll bar attached to this
12176 window, so it shouldn't be deleted at the end of redisplay. */
12177 redeem_scroll_bar_hook (w
);
12180 /* Restore current_buffer and value of point in it. */
12181 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
12182 set_buffer_internal_1 (old
);
12183 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
12185 unbind_to (count
, Qnil
);
12189 /* Build the complete desired matrix of WINDOW with a window start
12190 buffer position POS. Value is non-zero if successful. It is zero
12191 if fonts were loaded during redisplay which makes re-adjusting
12192 glyph matrices necessary. */
12195 try_window (window
, pos
)
12196 Lisp_Object window
;
12197 struct text_pos pos
;
12199 struct window
*w
= XWINDOW (window
);
12201 struct glyph_row
*last_text_row
= NULL
;
12203 /* Make POS the new window start. */
12204 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
12206 /* Mark cursor position as unknown. No overlay arrow seen. */
12207 w
->cursor
.vpos
= -1;
12208 overlay_arrow_seen
= 0;
12210 /* Initialize iterator and info to start at POS. */
12211 start_display (&it
, w
, pos
);
12213 /* Display all lines of W. */
12214 while (it
.current_y
< it
.last_visible_y
)
12216 if (display_line (&it
))
12217 last_text_row
= it
.glyph_row
- 1;
12218 if (fonts_changed_p
)
12222 /* If bottom moved off end of frame, change mode line percentage. */
12223 if (XFASTINT (w
->window_end_pos
) <= 0
12224 && Z
!= IT_CHARPOS (it
))
12225 w
->update_mode_line
= Qt
;
12227 /* Set window_end_pos to the offset of the last character displayed
12228 on the window from the end of current_buffer. Set
12229 window_end_vpos to its row number. */
12232 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
12233 w
->window_end_bytepos
12234 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
12236 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
12238 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
12239 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
12240 ->displays_text_p
);
12244 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
12245 w
->window_end_pos
= make_number (Z
- ZV
);
12246 w
->window_end_vpos
= make_number (0);
12249 /* But that is not valid info until redisplay finishes. */
12250 w
->window_end_valid
= Qnil
;
12256 /************************************************************************
12257 Window redisplay reusing current matrix when buffer has not changed
12258 ************************************************************************/
12260 /* Try redisplay of window W showing an unchanged buffer with a
12261 different window start than the last time it was displayed by
12262 reusing its current matrix. Value is non-zero if successful.
12263 W->start is the new window start. */
12266 try_window_reusing_current_matrix (w
)
12269 struct frame
*f
= XFRAME (w
->frame
);
12270 struct glyph_row
*row
, *bottom_row
;
12273 struct text_pos start
, new_start
;
12274 int nrows_scrolled
, i
;
12275 struct glyph_row
*last_text_row
;
12276 struct glyph_row
*last_reused_text_row
;
12277 struct glyph_row
*start_row
;
12278 int start_vpos
, min_y
, max_y
;
12281 if (inhibit_try_window_reusing
)
12285 if (/* This function doesn't handle terminal frames. */
12286 !FRAME_WINDOW_P (f
)
12287 /* Don't try to reuse the display if windows have been split
12289 || windows_or_buffers_changed
12290 || cursor_type_changed
)
12293 /* Can't do this if region may have changed. */
12294 if ((!NILP (Vtransient_mark_mode
)
12295 && !NILP (current_buffer
->mark_active
))
12296 || !NILP (w
->region_showing
)
12297 || !NILP (Vshow_trailing_whitespace
))
12300 /* If top-line visibility has changed, give up. */
12301 if (WINDOW_WANTS_HEADER_LINE_P (w
)
12302 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
12305 /* Give up if old or new display is scrolled vertically. We could
12306 make this function handle this, but right now it doesn't. */
12307 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
12308 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (start_row
))
12311 /* The variable new_start now holds the new window start. The old
12312 start `start' can be determined from the current matrix. */
12313 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
12314 start
= start_row
->start
.pos
;
12315 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
12317 /* Clear the desired matrix for the display below. */
12318 clear_glyph_matrix (w
->desired_matrix
);
12320 if (CHARPOS (new_start
) <= CHARPOS (start
))
12324 /* Don't use this method if the display starts with an ellipsis
12325 displayed for invisible text. It's not easy to handle that case
12326 below, and it's certainly not worth the effort since this is
12327 not a frequent case. */
12328 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
12331 IF_DEBUG (debug_method_add (w
, "twu1"));
12333 /* Display up to a row that can be reused. The variable
12334 last_text_row is set to the last row displayed that displays
12335 text. Note that it.vpos == 0 if or if not there is a
12336 header-line; it's not the same as the MATRIX_ROW_VPOS! */
12337 start_display (&it
, w
, new_start
);
12338 first_row_y
= it
.current_y
;
12339 w
->cursor
.vpos
= -1;
12340 last_text_row
= last_reused_text_row
= NULL
;
12342 while (it
.current_y
< it
.last_visible_y
12343 && IT_CHARPOS (it
) < CHARPOS (start
)
12344 && !fonts_changed_p
)
12345 if (display_line (&it
))
12346 last_text_row
= it
.glyph_row
- 1;
12348 /* A value of current_y < last_visible_y means that we stopped
12349 at the previous window start, which in turn means that we
12350 have at least one reusable row. */
12351 if (it
.current_y
< it
.last_visible_y
)
12353 /* IT.vpos always starts from 0; it counts text lines. */
12354 nrows_scrolled
= it
.vpos
;
12356 /* Find PT if not already found in the lines displayed. */
12357 if (w
->cursor
.vpos
< 0)
12359 int dy
= it
.current_y
- first_row_y
;
12361 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
12362 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
12364 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
12365 dy
, nrows_scrolled
);
12368 clear_glyph_matrix (w
->desired_matrix
);
12373 /* Scroll the display. Do it before the current matrix is
12374 changed. The problem here is that update has not yet
12375 run, i.e. part of the current matrix is not up to date.
12376 scroll_run_hook will clear the cursor, and use the
12377 current matrix to get the height of the row the cursor is
12379 run
.current_y
= first_row_y
;
12380 run
.desired_y
= it
.current_y
;
12381 run
.height
= it
.last_visible_y
- it
.current_y
;
12383 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
12386 rif
->update_window_begin_hook (w
);
12387 rif
->clear_window_mouse_face (w
);
12388 rif
->scroll_run_hook (w
, &run
);
12389 rif
->update_window_end_hook (w
, 0, 0);
12393 /* Shift current matrix down by nrows_scrolled lines. */
12394 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12395 rotate_matrix (w
->current_matrix
,
12397 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
12400 /* Disable lines that must be updated. */
12401 for (i
= 0; i
< it
.vpos
; ++i
)
12402 (start_row
+ i
)->enabled_p
= 0;
12404 /* Re-compute Y positions. */
12405 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
12406 max_y
= it
.last_visible_y
;
12407 for (row
= start_row
+ nrows_scrolled
;
12411 row
->y
= it
.current_y
;
12412 row
->visible_height
= row
->height
;
12414 if (row
->y
< min_y
)
12415 row
->visible_height
-= min_y
- row
->y
;
12416 if (row
->y
+ row
->height
> max_y
)
12417 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
12418 row
->redraw_fringe_bitmaps_p
= 1;
12420 it
.current_y
+= row
->height
;
12422 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12423 last_reused_text_row
= row
;
12424 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
12428 /* Disable lines in the current matrix which are now
12429 below the window. */
12430 for (++row
; row
< bottom_row
; ++row
)
12431 row
->enabled_p
= 0;
12434 /* Update window_end_pos etc.; last_reused_text_row is the last
12435 reused row from the current matrix containing text, if any.
12436 The value of last_text_row is the last displayed line
12437 containing text. */
12438 if (last_reused_text_row
)
12440 w
->window_end_bytepos
12441 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
12443 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
12445 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
12446 w
->current_matrix
));
12448 else if (last_text_row
)
12450 w
->window_end_bytepos
12451 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
12453 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
12455 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
12459 /* This window must be completely empty. */
12460 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
12461 w
->window_end_pos
= make_number (Z
- ZV
);
12462 w
->window_end_vpos
= make_number (0);
12464 w
->window_end_valid
= Qnil
;
12466 /* Update hint: don't try scrolling again in update_window. */
12467 w
->desired_matrix
->no_scrolling_p
= 1;
12470 debug_method_add (w
, "try_window_reusing_current_matrix 1");
12474 else if (CHARPOS (new_start
) > CHARPOS (start
))
12476 struct glyph_row
*pt_row
, *row
;
12477 struct glyph_row
*first_reusable_row
;
12478 struct glyph_row
*first_row_to_display
;
12480 int yb
= window_text_bottom_y (w
);
12482 /* Find the row starting at new_start, if there is one. Don't
12483 reuse a partially visible line at the end. */
12484 first_reusable_row
= start_row
;
12485 while (first_reusable_row
->enabled_p
12486 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
12487 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
12488 < CHARPOS (new_start
)))
12489 ++first_reusable_row
;
12491 /* Give up if there is no row to reuse. */
12492 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
12493 || !first_reusable_row
->enabled_p
12494 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
12495 != CHARPOS (new_start
)))
12498 /* We can reuse fully visible rows beginning with
12499 first_reusable_row to the end of the window. Set
12500 first_row_to_display to the first row that cannot be reused.
12501 Set pt_row to the row containing point, if there is any. */
12503 for (first_row_to_display
= first_reusable_row
;
12504 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
12505 ++first_row_to_display
)
12507 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
12508 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
12509 pt_row
= first_row_to_display
;
12512 /* Start displaying at the start of first_row_to_display. */
12513 xassert (first_row_to_display
->y
< yb
);
12514 init_to_row_start (&it
, w
, first_row_to_display
);
12516 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
12518 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
12520 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
12521 + WINDOW_HEADER_LINE_HEIGHT (w
));
12523 /* Display lines beginning with first_row_to_display in the
12524 desired matrix. Set last_text_row to the last row displayed
12525 that displays text. */
12526 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
12527 if (pt_row
== NULL
)
12528 w
->cursor
.vpos
= -1;
12529 last_text_row
= NULL
;
12530 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
12531 if (display_line (&it
))
12532 last_text_row
= it
.glyph_row
- 1;
12534 /* Give up If point isn't in a row displayed or reused. */
12535 if (w
->cursor
.vpos
< 0)
12537 clear_glyph_matrix (w
->desired_matrix
);
12541 /* If point is in a reused row, adjust y and vpos of the cursor
12545 w
->cursor
.vpos
-= nrows_scrolled
;
12546 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
12549 /* Scroll the display. */
12550 run
.current_y
= first_reusable_row
->y
;
12551 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
12552 run
.height
= it
.last_visible_y
- run
.current_y
;
12553 dy
= run
.current_y
- run
.desired_y
;
12558 rif
->update_window_begin_hook (w
);
12559 rif
->clear_window_mouse_face (w
);
12560 rif
->scroll_run_hook (w
, &run
);
12561 rif
->update_window_end_hook (w
, 0, 0);
12565 /* Adjust Y positions of reused rows. */
12566 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12567 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
12568 max_y
= it
.last_visible_y
;
12569 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
12572 row
->visible_height
= row
->height
;
12573 if (row
->y
< min_y
)
12574 row
->visible_height
-= min_y
- row
->y
;
12575 if (row
->y
+ row
->height
> max_y
)
12576 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
12577 row
->redraw_fringe_bitmaps_p
= 1;
12580 /* Scroll the current matrix. */
12581 xassert (nrows_scrolled
> 0);
12582 rotate_matrix (w
->current_matrix
,
12584 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
12587 /* Disable rows not reused. */
12588 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
12589 row
->enabled_p
= 0;
12591 /* Point may have moved to a different line, so we cannot assume that
12592 the previous cursor position is valid; locate the correct row. */
12595 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12596 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
12600 w
->cursor
.y
= row
->y
;
12602 if (row
< bottom_row
)
12604 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
12605 while (glyph
->charpos
< PT
)
12608 w
->cursor
.x
+= glyph
->pixel_width
;
12614 /* Adjust window end. A null value of last_text_row means that
12615 the window end is in reused rows which in turn means that
12616 only its vpos can have changed. */
12619 w
->window_end_bytepos
12620 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
12622 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
12624 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
12629 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
12632 w
->window_end_valid
= Qnil
;
12633 w
->desired_matrix
->no_scrolling_p
= 1;
12636 debug_method_add (w
, "try_window_reusing_current_matrix 2");
12646 /************************************************************************
12647 Window redisplay reusing current matrix when buffer has changed
12648 ************************************************************************/
12650 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
12651 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
12653 static struct glyph_row
*
12654 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
12655 struct glyph_row
*));
12658 /* Return the last row in MATRIX displaying text. If row START is
12659 non-null, start searching with that row. IT gives the dimensions
12660 of the display. Value is null if matrix is empty; otherwise it is
12661 a pointer to the row found. */
12663 static struct glyph_row
*
12664 find_last_row_displaying_text (matrix
, it
, start
)
12665 struct glyph_matrix
*matrix
;
12667 struct glyph_row
*start
;
12669 struct glyph_row
*row
, *row_found
;
12671 /* Set row_found to the last row in IT->w's current matrix
12672 displaying text. The loop looks funny but think of partially
12675 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
12676 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12678 xassert (row
->enabled_p
);
12680 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
12689 /* Return the last row in the current matrix of W that is not affected
12690 by changes at the start of current_buffer that occurred since W's
12691 current matrix was built. Value is null if no such row exists.
12693 BEG_UNCHANGED us the number of characters unchanged at the start of
12694 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
12695 first changed character in current_buffer. Characters at positions <
12696 BEG + BEG_UNCHANGED are at the same buffer positions as they were
12697 when the current matrix was built. */
12699 static struct glyph_row
*
12700 find_last_unchanged_at_beg_row (w
)
12703 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
12704 struct glyph_row
*row
;
12705 struct glyph_row
*row_found
= NULL
;
12706 int yb
= window_text_bottom_y (w
);
12708 /* Find the last row displaying unchanged text. */
12709 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
12710 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12711 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
)
12713 if (/* If row ends before first_changed_pos, it is unchanged,
12714 except in some case. */
12715 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
12716 /* When row ends in ZV and we write at ZV it is not
12718 && !row
->ends_at_zv_p
12719 /* When first_changed_pos is the end of a continued line,
12720 row is not unchanged because it may be no longer
12722 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
12723 && (row
->continued_p
12724 || row
->exact_window_width_line_p
)))
12727 /* Stop if last visible row. */
12728 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
12738 /* Find the first glyph row in the current matrix of W that is not
12739 affected by changes at the end of current_buffer since the
12740 time W's current matrix was built.
12742 Return in *DELTA the number of chars by which buffer positions in
12743 unchanged text at the end of current_buffer must be adjusted.
12745 Return in *DELTA_BYTES the corresponding number of bytes.
12747 Value is null if no such row exists, i.e. all rows are affected by
12750 static struct glyph_row
*
12751 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
12753 int *delta
, *delta_bytes
;
12755 struct glyph_row
*row
;
12756 struct glyph_row
*row_found
= NULL
;
12758 *delta
= *delta_bytes
= 0;
12760 /* Display must not have been paused, otherwise the current matrix
12761 is not up to date. */
12762 if (NILP (w
->window_end_valid
))
12765 /* A value of window_end_pos >= END_UNCHANGED means that the window
12766 end is in the range of changed text. If so, there is no
12767 unchanged row at the end of W's current matrix. */
12768 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
12771 /* Set row to the last row in W's current matrix displaying text. */
12772 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
12774 /* If matrix is entirely empty, no unchanged row exists. */
12775 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12777 /* The value of row is the last glyph row in the matrix having a
12778 meaningful buffer position in it. The end position of row
12779 corresponds to window_end_pos. This allows us to translate
12780 buffer positions in the current matrix to current buffer
12781 positions for characters not in changed text. */
12782 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
12783 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
12784 int last_unchanged_pos
, last_unchanged_pos_old
;
12785 struct glyph_row
*first_text_row
12786 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
12788 *delta
= Z
- Z_old
;
12789 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
12791 /* Set last_unchanged_pos to the buffer position of the last
12792 character in the buffer that has not been changed. Z is the
12793 index + 1 of the last character in current_buffer, i.e. by
12794 subtracting END_UNCHANGED we get the index of the last
12795 unchanged character, and we have to add BEG to get its buffer
12797 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
12798 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
12800 /* Search backward from ROW for a row displaying a line that
12801 starts at a minimum position >= last_unchanged_pos_old. */
12802 for (; row
> first_text_row
; --row
)
12804 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12807 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
12812 if (row_found
&& !MATRIX_ROW_DISPLAYS_TEXT_P (row_found
))
12819 /* Make sure that glyph rows in the current matrix of window W
12820 reference the same glyph memory as corresponding rows in the
12821 frame's frame matrix. This function is called after scrolling W's
12822 current matrix on a terminal frame in try_window_id and
12823 try_window_reusing_current_matrix. */
12826 sync_frame_with_window_matrix_rows (w
)
12829 struct frame
*f
= XFRAME (w
->frame
);
12830 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
12832 /* Preconditions: W must be a leaf window and full-width. Its frame
12833 must have a frame matrix. */
12834 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
12835 xassert (WINDOW_FULL_WIDTH_P (w
));
12836 xassert (!FRAME_WINDOW_P (f
));
12838 /* If W is a full-width window, glyph pointers in W's current matrix
12839 have, by definition, to be the same as glyph pointers in the
12840 corresponding frame matrix. Note that frame matrices have no
12841 marginal areas (see build_frame_matrix). */
12842 window_row
= w
->current_matrix
->rows
;
12843 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
12844 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
12845 while (window_row
< window_row_end
)
12847 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
12848 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
12850 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
12851 frame_row
->glyphs
[TEXT_AREA
] = start
;
12852 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
12853 frame_row
->glyphs
[LAST_AREA
] = end
;
12855 /* Disable frame rows whose corresponding window rows have
12856 been disabled in try_window_id. */
12857 if (!window_row
->enabled_p
)
12858 frame_row
->enabled_p
= 0;
12860 ++window_row
, ++frame_row
;
12865 /* Find the glyph row in window W containing CHARPOS. Consider all
12866 rows between START and END (not inclusive). END null means search
12867 all rows to the end of the display area of W. Value is the row
12868 containing CHARPOS or null. */
12871 row_containing_pos (w
, charpos
, start
, end
, dy
)
12874 struct glyph_row
*start
, *end
;
12877 struct glyph_row
*row
= start
;
12880 /* If we happen to start on a header-line, skip that. */
12881 if (row
->mode_line_p
)
12884 if ((end
&& row
>= end
) || !row
->enabled_p
)
12887 last_y
= window_text_bottom_y (w
) - dy
;
12891 /* Give up if we have gone too far. */
12892 if (end
&& row
>= end
)
12894 /* This formerly returned if they were equal.
12895 I think that both quantities are of a "last plus one" type;
12896 if so, when they are equal, the row is within the screen. -- rms. */
12897 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
12900 /* If it is in this row, return this row. */
12901 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
12902 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
12903 /* The end position of a row equals the start
12904 position of the next row. If CHARPOS is there, we
12905 would rather display it in the next line, except
12906 when this line ends in ZV. */
12907 && !row
->ends_at_zv_p
12908 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
12909 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
12916 /* Try to redisplay window W by reusing its existing display. W's
12917 current matrix must be up to date when this function is called,
12918 i.e. window_end_valid must not be nil.
12922 1 if display has been updated
12923 0 if otherwise unsuccessful
12924 -1 if redisplay with same window start is known not to succeed
12926 The following steps are performed:
12928 1. Find the last row in the current matrix of W that is not
12929 affected by changes at the start of current_buffer. If no such row
12932 2. Find the first row in W's current matrix that is not affected by
12933 changes at the end of current_buffer. Maybe there is no such row.
12935 3. Display lines beginning with the row + 1 found in step 1 to the
12936 row found in step 2 or, if step 2 didn't find a row, to the end of
12939 4. If cursor is not known to appear on the window, give up.
12941 5. If display stopped at the row found in step 2, scroll the
12942 display and current matrix as needed.
12944 6. Maybe display some lines at the end of W, if we must. This can
12945 happen under various circumstances, like a partially visible line
12946 becoming fully visible, or because newly displayed lines are displayed
12947 in smaller font sizes.
12949 7. Update W's window end information. */
12955 struct frame
*f
= XFRAME (w
->frame
);
12956 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
12957 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
12958 struct glyph_row
*last_unchanged_at_beg_row
;
12959 struct glyph_row
*first_unchanged_at_end_row
;
12960 struct glyph_row
*row
;
12961 struct glyph_row
*bottom_row
;
12964 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
12965 struct text_pos start_pos
;
12967 int first_unchanged_at_end_vpos
= 0;
12968 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
12969 struct text_pos start
;
12970 int first_changed_charpos
, last_changed_charpos
;
12973 if (inhibit_try_window_id
)
12977 /* This is handy for debugging. */
12979 #define GIVE_UP(X) \
12981 fprintf (stderr, "try_window_id give up %d\n", (X)); \
12985 #define GIVE_UP(X) return 0
12988 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
12990 /* Don't use this for mini-windows because these can show
12991 messages and mini-buffers, and we don't handle that here. */
12992 if (MINI_WINDOW_P (w
))
12995 /* This flag is used to prevent redisplay optimizations. */
12996 if (windows_or_buffers_changed
|| cursor_type_changed
)
12999 /* Verify that narrowing has not changed.
13000 Also verify that we were not told to prevent redisplay optimizations.
13001 It would be nice to further
13002 reduce the number of cases where this prevents try_window_id. */
13003 if (current_buffer
->clip_changed
13004 || current_buffer
->prevent_redisplay_optimizations_p
)
13007 /* Window must either use window-based redisplay or be full width. */
13008 if (!FRAME_WINDOW_P (f
)
13009 && (!line_ins_del_ok
13010 || !WINDOW_FULL_WIDTH_P (w
)))
13013 /* Give up if point is not known NOT to appear in W. */
13014 if (PT
< CHARPOS (start
))
13017 /* Another way to prevent redisplay optimizations. */
13018 if (XFASTINT (w
->last_modified
) == 0)
13021 /* Verify that window is not hscrolled. */
13022 if (XFASTINT (w
->hscroll
) != 0)
13025 /* Verify that display wasn't paused. */
13026 if (NILP (w
->window_end_valid
))
13029 /* Can't use this if highlighting a region because a cursor movement
13030 will do more than just set the cursor. */
13031 if (!NILP (Vtransient_mark_mode
)
13032 && !NILP (current_buffer
->mark_active
))
13035 /* Likewise if highlighting trailing whitespace. */
13036 if (!NILP (Vshow_trailing_whitespace
))
13039 /* Likewise if showing a region. */
13040 if (!NILP (w
->region_showing
))
13043 /* Can use this if overlay arrow position and or string have changed. */
13044 if (overlay_arrows_changed_p ())
13048 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
13049 only if buffer has really changed. The reason is that the gap is
13050 initially at Z for freshly visited files. The code below would
13051 set end_unchanged to 0 in that case. */
13052 if (MODIFF
> SAVE_MODIFF
13053 /* This seems to happen sometimes after saving a buffer. */
13054 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
13056 if (GPT
- BEG
< BEG_UNCHANGED
)
13057 BEG_UNCHANGED
= GPT
- BEG
;
13058 if (Z
- GPT
< END_UNCHANGED
)
13059 END_UNCHANGED
= Z
- GPT
;
13062 /* The position of the first and last character that has been changed. */
13063 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
13064 last_changed_charpos
= Z
- END_UNCHANGED
;
13066 /* If window starts after a line end, and the last change is in
13067 front of that newline, then changes don't affect the display.
13068 This case happens with stealth-fontification. Note that although
13069 the display is unchanged, glyph positions in the matrix have to
13070 be adjusted, of course. */
13071 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
13072 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
13073 && ((last_changed_charpos
< CHARPOS (start
)
13074 && CHARPOS (start
) == BEGV
)
13075 || (last_changed_charpos
< CHARPOS (start
) - 1
13076 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
13078 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
13079 struct glyph_row
*r0
;
13081 /* Compute how many chars/bytes have been added to or removed
13082 from the buffer. */
13083 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
13084 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
13086 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
13088 /* Give up if PT is not in the window. Note that it already has
13089 been checked at the start of try_window_id that PT is not in
13090 front of the window start. */
13091 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
13094 /* If window start is unchanged, we can reuse the whole matrix
13095 as is, after adjusting glyph positions. No need to compute
13096 the window end again, since its offset from Z hasn't changed. */
13097 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
13098 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
13099 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
13100 /* PT must not be in a partially visible line. */
13101 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
13102 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
13104 /* Adjust positions in the glyph matrix. */
13105 if (delta
|| delta_bytes
)
13107 struct glyph_row
*r1
13108 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
13109 increment_matrix_positions (w
->current_matrix
,
13110 MATRIX_ROW_VPOS (r0
, current_matrix
),
13111 MATRIX_ROW_VPOS (r1
, current_matrix
),
13112 delta
, delta_bytes
);
13115 /* Set the cursor. */
13116 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
13118 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
13125 /* Handle the case that changes are all below what is displayed in
13126 the window, and that PT is in the window. This shortcut cannot
13127 be taken if ZV is visible in the window, and text has been added
13128 there that is visible in the window. */
13129 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
13130 /* ZV is not visible in the window, or there are no
13131 changes at ZV, actually. */
13132 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
13133 || first_changed_charpos
== last_changed_charpos
))
13135 struct glyph_row
*r0
;
13137 /* Give up if PT is not in the window. Note that it already has
13138 been checked at the start of try_window_id that PT is not in
13139 front of the window start. */
13140 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
13143 /* If window start is unchanged, we can reuse the whole matrix
13144 as is, without changing glyph positions since no text has
13145 been added/removed in front of the window end. */
13146 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
13147 if (TEXT_POS_EQUAL_P (start
, r0
->start
.pos
)
13148 /* PT must not be in a partially visible line. */
13149 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
13150 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
13152 /* We have to compute the window end anew since text
13153 can have been added/removed after it. */
13155 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
13156 w
->window_end_bytepos
13157 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
13159 /* Set the cursor. */
13160 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
13162 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
13169 /* Give up if window start is in the changed area.
13171 The condition used to read
13173 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
13175 but why that was tested escapes me at the moment. */
13176 if (CHARPOS (start
) >= first_changed_charpos
13177 && CHARPOS (start
) <= last_changed_charpos
)
13180 /* Check that window start agrees with the start of the first glyph
13181 row in its current matrix. Check this after we know the window
13182 start is not in changed text, otherwise positions would not be
13184 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
13185 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
13188 /* Give up if the window ends in strings. Overlay strings
13189 at the end are difficult to handle, so don't try. */
13190 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
13191 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
13194 /* Compute the position at which we have to start displaying new
13195 lines. Some of the lines at the top of the window might be
13196 reusable because they are not displaying changed text. Find the
13197 last row in W's current matrix not affected by changes at the
13198 start of current_buffer. Value is null if changes start in the
13199 first line of window. */
13200 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
13201 if (last_unchanged_at_beg_row
)
13203 /* Avoid starting to display in the moddle of a character, a TAB
13204 for instance. This is easier than to set up the iterator
13205 exactly, and it's not a frequent case, so the additional
13206 effort wouldn't really pay off. */
13207 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
13208 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
13209 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
13210 --last_unchanged_at_beg_row
;
13212 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
13215 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
13217 start_pos
= it
.current
.pos
;
13219 /* Start displaying new lines in the desired matrix at the same
13220 vpos we would use in the current matrix, i.e. below
13221 last_unchanged_at_beg_row. */
13222 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
13224 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
13225 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
13227 xassert (it
.hpos
== 0 && it
.current_x
== 0);
13231 /* There are no reusable lines at the start of the window.
13232 Start displaying in the first text line. */
13233 start_display (&it
, w
, start
);
13234 it
.vpos
= it
.first_vpos
;
13235 start_pos
= it
.current
.pos
;
13238 /* Find the first row that is not affected by changes at the end of
13239 the buffer. Value will be null if there is no unchanged row, in
13240 which case we must redisplay to the end of the window. delta
13241 will be set to the value by which buffer positions beginning with
13242 first_unchanged_at_end_row have to be adjusted due to text
13244 first_unchanged_at_end_row
13245 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
13246 IF_DEBUG (debug_delta
= delta
);
13247 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
13249 /* Set stop_pos to the buffer position up to which we will have to
13250 display new lines. If first_unchanged_at_end_row != NULL, this
13251 is the buffer position of the start of the line displayed in that
13252 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
13253 that we don't stop at a buffer position. */
13255 if (first_unchanged_at_end_row
)
13257 xassert (last_unchanged_at_beg_row
== NULL
13258 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
13260 /* If this is a continuation line, move forward to the next one
13261 that isn't. Changes in lines above affect this line.
13262 Caution: this may move first_unchanged_at_end_row to a row
13263 not displaying text. */
13264 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
13265 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
13266 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
13267 < it
.last_visible_y
))
13268 ++first_unchanged_at_end_row
;
13270 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
13271 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
13272 >= it
.last_visible_y
))
13273 first_unchanged_at_end_row
= NULL
;
13276 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
13278 first_unchanged_at_end_vpos
13279 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
13280 xassert (stop_pos
>= Z
- END_UNCHANGED
);
13283 else if (last_unchanged_at_beg_row
== NULL
)
13289 /* Either there is no unchanged row at the end, or the one we have
13290 now displays text. This is a necessary condition for the window
13291 end pos calculation at the end of this function. */
13292 xassert (first_unchanged_at_end_row
== NULL
13293 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
13295 debug_last_unchanged_at_beg_vpos
13296 = (last_unchanged_at_beg_row
13297 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
13299 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
13301 #endif /* GLYPH_DEBUG != 0 */
13304 /* Display new lines. Set last_text_row to the last new line
13305 displayed which has text on it, i.e. might end up as being the
13306 line where the window_end_vpos is. */
13307 w
->cursor
.vpos
= -1;
13308 last_text_row
= NULL
;
13309 overlay_arrow_seen
= 0;
13310 while (it
.current_y
< it
.last_visible_y
13311 && !fonts_changed_p
13312 && (first_unchanged_at_end_row
== NULL
13313 || IT_CHARPOS (it
) < stop_pos
))
13315 if (display_line (&it
))
13316 last_text_row
= it
.glyph_row
- 1;
13319 if (fonts_changed_p
)
13323 /* Compute differences in buffer positions, y-positions etc. for
13324 lines reused at the bottom of the window. Compute what we can
13326 if (first_unchanged_at_end_row
13327 /* No lines reused because we displayed everything up to the
13328 bottom of the window. */
13329 && it
.current_y
< it
.last_visible_y
)
13332 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
13334 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
13335 run
.current_y
= first_unchanged_at_end_row
->y
;
13336 run
.desired_y
= run
.current_y
+ dy
;
13337 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
13341 delta
= dvpos
= dy
= run
.current_y
= run
.desired_y
= run
.height
= 0;
13342 first_unchanged_at_end_row
= NULL
;
13344 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
13347 /* Find the cursor if not already found. We have to decide whether
13348 PT will appear on this window (it sometimes doesn't, but this is
13349 not a very frequent case.) This decision has to be made before
13350 the current matrix is altered. A value of cursor.vpos < 0 means
13351 that PT is either in one of the lines beginning at
13352 first_unchanged_at_end_row or below the window. Don't care for
13353 lines that might be displayed later at the window end; as
13354 mentioned, this is not a frequent case. */
13355 if (w
->cursor
.vpos
< 0)
13357 /* Cursor in unchanged rows at the top? */
13358 if (PT
< CHARPOS (start_pos
)
13359 && last_unchanged_at_beg_row
)
13361 row
= row_containing_pos (w
, PT
,
13362 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
13363 last_unchanged_at_beg_row
+ 1, 0);
13365 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13368 /* Start from first_unchanged_at_end_row looking for PT. */
13369 else if (first_unchanged_at_end_row
)
13371 row
= row_containing_pos (w
, PT
- delta
,
13372 first_unchanged_at_end_row
, NULL
, 0);
13374 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
13375 delta_bytes
, dy
, dvpos
);
13378 /* Give up if cursor was not found. */
13379 if (w
->cursor
.vpos
< 0)
13381 clear_glyph_matrix (w
->desired_matrix
);
13386 /* Don't let the cursor end in the scroll margins. */
13388 int this_scroll_margin
, cursor_height
;
13390 this_scroll_margin
= max (0, scroll_margin
);
13391 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13392 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
13393 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
13395 if ((w
->cursor
.y
< this_scroll_margin
13396 && CHARPOS (start
) > BEGV
)
13397 /* Old redisplay didn't take scroll margin into account at the bottom,
13398 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
13399 || w
->cursor
.y
+ cursor_height
+ this_scroll_margin
> it
.last_visible_y
)
13401 w
->cursor
.vpos
= -1;
13402 clear_glyph_matrix (w
->desired_matrix
);
13407 /* Scroll the display. Do it before changing the current matrix so
13408 that xterm.c doesn't get confused about where the cursor glyph is
13410 if (dy
&& run
.height
)
13414 if (FRAME_WINDOW_P (f
))
13416 rif
->update_window_begin_hook (w
);
13417 rif
->clear_window_mouse_face (w
);
13418 rif
->scroll_run_hook (w
, &run
);
13419 rif
->update_window_end_hook (w
, 0, 0);
13423 /* Terminal frame. In this case, dvpos gives the number of
13424 lines to scroll by; dvpos < 0 means scroll up. */
13425 int first_unchanged_at_end_vpos
13426 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
13427 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
13428 int end
= (WINDOW_TOP_EDGE_LINE (w
)
13429 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
13430 + window_internal_height (w
));
13432 /* Perform the operation on the screen. */
13435 /* Scroll last_unchanged_at_beg_row to the end of the
13436 window down dvpos lines. */
13437 set_terminal_window (end
);
13439 /* On dumb terminals delete dvpos lines at the end
13440 before inserting dvpos empty lines. */
13441 if (!scroll_region_ok
)
13442 ins_del_lines (end
- dvpos
, -dvpos
);
13444 /* Insert dvpos empty lines in front of
13445 last_unchanged_at_beg_row. */
13446 ins_del_lines (from
, dvpos
);
13448 else if (dvpos
< 0)
13450 /* Scroll up last_unchanged_at_beg_vpos to the end of
13451 the window to last_unchanged_at_beg_vpos - |dvpos|. */
13452 set_terminal_window (end
);
13454 /* Delete dvpos lines in front of
13455 last_unchanged_at_beg_vpos. ins_del_lines will set
13456 the cursor to the given vpos and emit |dvpos| delete
13458 ins_del_lines (from
+ dvpos
, dvpos
);
13460 /* On a dumb terminal insert dvpos empty lines at the
13462 if (!scroll_region_ok
)
13463 ins_del_lines (end
+ dvpos
, -dvpos
);
13466 set_terminal_window (0);
13472 /* Shift reused rows of the current matrix to the right position.
13473 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
13475 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
13476 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
13479 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
13480 bottom_vpos
, dvpos
);
13481 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
13484 else if (dvpos
> 0)
13486 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
13487 bottom_vpos
, dvpos
);
13488 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
13489 first_unchanged_at_end_vpos
+ dvpos
, 0);
13492 /* For frame-based redisplay, make sure that current frame and window
13493 matrix are in sync with respect to glyph memory. */
13494 if (!FRAME_WINDOW_P (f
))
13495 sync_frame_with_window_matrix_rows (w
);
13497 /* Adjust buffer positions in reused rows. */
13499 increment_matrix_positions (current_matrix
,
13500 first_unchanged_at_end_vpos
+ dvpos
,
13501 bottom_vpos
, delta
, delta_bytes
);
13503 /* Adjust Y positions. */
13505 shift_glyph_matrix (w
, current_matrix
,
13506 first_unchanged_at_end_vpos
+ dvpos
,
13509 if (first_unchanged_at_end_row
)
13510 first_unchanged_at_end_row
+= dvpos
;
13512 /* If scrolling up, there may be some lines to display at the end of
13514 last_text_row_at_end
= NULL
;
13517 /* Scrolling up can leave for example a partially visible line
13518 at the end of the window to be redisplayed. */
13519 /* Set last_row to the glyph row in the current matrix where the
13520 window end line is found. It has been moved up or down in
13521 the matrix by dvpos. */
13522 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
13523 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
13525 /* If last_row is the window end line, it should display text. */
13526 xassert (last_row
->displays_text_p
);
13528 /* If window end line was partially visible before, begin
13529 displaying at that line. Otherwise begin displaying with the
13530 line following it. */
13531 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
13533 init_to_row_start (&it
, w
, last_row
);
13534 it
.vpos
= last_vpos
;
13535 it
.current_y
= last_row
->y
;
13539 init_to_row_end (&it
, w
, last_row
);
13540 it
.vpos
= 1 + last_vpos
;
13541 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
13545 /* We may start in a continuation line. If so, we have to
13546 get the right continuation_lines_width and current_x. */
13547 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
13548 it
.hpos
= it
.current_x
= 0;
13550 /* Display the rest of the lines at the window end. */
13551 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
13552 while (it
.current_y
< it
.last_visible_y
13553 && !fonts_changed_p
)
13555 /* Is it always sure that the display agrees with lines in
13556 the current matrix? I don't think so, so we mark rows
13557 displayed invalid in the current matrix by setting their
13558 enabled_p flag to zero. */
13559 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
13560 if (display_line (&it
))
13561 last_text_row_at_end
= it
.glyph_row
- 1;
13565 /* Update window_end_pos and window_end_vpos. */
13566 if (first_unchanged_at_end_row
13567 && first_unchanged_at_end_row
->y
< it
.last_visible_y
13568 && !last_text_row_at_end
)
13570 /* Window end line if one of the preserved rows from the current
13571 matrix. Set row to the last row displaying text in current
13572 matrix starting at first_unchanged_at_end_row, after
13574 xassert (first_unchanged_at_end_row
->displays_text_p
);
13575 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
13576 first_unchanged_at_end_row
);
13577 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
13579 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
13580 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
13582 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
13583 xassert (w
->window_end_bytepos
>= 0);
13584 IF_DEBUG (debug_method_add (w
, "A"));
13586 else if (last_text_row_at_end
)
13589 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
13590 w
->window_end_bytepos
13591 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
13593 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
13594 xassert (w
->window_end_bytepos
>= 0);
13595 IF_DEBUG (debug_method_add (w
, "B"));
13597 else if (last_text_row
)
13599 /* We have displayed either to the end of the window or at the
13600 end of the window, i.e. the last row with text is to be found
13601 in the desired matrix. */
13603 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
13604 w
->window_end_bytepos
13605 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
13607 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
13608 xassert (w
->window_end_bytepos
>= 0);
13610 else if (first_unchanged_at_end_row
== NULL
13611 && last_text_row
== NULL
13612 && last_text_row_at_end
== NULL
)
13614 /* Displayed to end of window, but no line containing text was
13615 displayed. Lines were deleted at the end of the window. */
13616 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
13617 int vpos
= XFASTINT (w
->window_end_vpos
);
13618 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
13619 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
13622 row
== NULL
&& vpos
>= first_vpos
;
13623 --vpos
, --current_row
, --desired_row
)
13625 if (desired_row
->enabled_p
)
13627 if (desired_row
->displays_text_p
)
13630 else if (current_row
->displays_text_p
)
13634 xassert (row
!= NULL
);
13635 w
->window_end_vpos
= make_number (vpos
+ 1);
13636 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
13637 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
13638 xassert (w
->window_end_bytepos
>= 0);
13639 IF_DEBUG (debug_method_add (w
, "C"));
13644 #if 0 /* This leads to problems, for instance when the cursor is
13645 at ZV, and the cursor line displays no text. */
13646 /* Disable rows below what's displayed in the window. This makes
13647 debugging easier. */
13648 enable_glyph_matrix_rows (current_matrix
,
13649 XFASTINT (w
->window_end_vpos
) + 1,
13653 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
13654 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
13656 /* Record that display has not been completed. */
13657 w
->window_end_valid
= Qnil
;
13658 w
->desired_matrix
->no_scrolling_p
= 1;
13666 /***********************************************************************
13667 More debugging support
13668 ***********************************************************************/
13672 void dump_glyph_row
P_ ((struct glyph_row
*, int, int));
13673 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
13674 void dump_glyph
P_ ((struct glyph_row
*, struct glyph
*, int));
13677 /* Dump the contents of glyph matrix MATRIX on stderr.
13679 GLYPHS 0 means don't show glyph contents.
13680 GLYPHS 1 means show glyphs in short form
13681 GLYPHS > 1 means show glyphs in long form. */
13684 dump_glyph_matrix (matrix
, glyphs
)
13685 struct glyph_matrix
*matrix
;
13689 for (i
= 0; i
< matrix
->nrows
; ++i
)
13690 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
13694 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
13695 the glyph row and area where the glyph comes from. */
13698 dump_glyph (row
, glyph
, area
)
13699 struct glyph_row
*row
;
13700 struct glyph
*glyph
;
13703 if (glyph
->type
== CHAR_GLYPH
)
13706 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
13707 glyph
- row
->glyphs
[TEXT_AREA
],
13710 (BUFFERP (glyph
->object
)
13712 : (STRINGP (glyph
->object
)
13715 glyph
->pixel_width
,
13717 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
13721 glyph
->left_box_line_p
,
13722 glyph
->right_box_line_p
);
13724 else if (glyph
->type
== STRETCH_GLYPH
)
13727 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
13728 glyph
- row
->glyphs
[TEXT_AREA
],
13731 (BUFFERP (glyph
->object
)
13733 : (STRINGP (glyph
->object
)
13736 glyph
->pixel_width
,
13740 glyph
->left_box_line_p
,
13741 glyph
->right_box_line_p
);
13743 else if (glyph
->type
== IMAGE_GLYPH
)
13746 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
13747 glyph
- row
->glyphs
[TEXT_AREA
],
13750 (BUFFERP (glyph
->object
)
13752 : (STRINGP (glyph
->object
)
13755 glyph
->pixel_width
,
13759 glyph
->left_box_line_p
,
13760 glyph
->right_box_line_p
);
13765 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
13766 GLYPHS 0 means don't show glyph contents.
13767 GLYPHS 1 means show glyphs in short form
13768 GLYPHS > 1 means show glyphs in long form. */
13771 dump_glyph_row (row
, vpos
, glyphs
)
13772 struct glyph_row
*row
;
13777 fprintf (stderr
, "Row Start End Used oEI><O\\CTZFesm X Y W H V A P\n");
13778 fprintf (stderr
, "=======================================================================\n");
13780 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d%1.1d\
13781 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
13783 MATRIX_ROW_START_CHARPOS (row
),
13784 MATRIX_ROW_END_CHARPOS (row
),
13785 row
->used
[TEXT_AREA
],
13786 row
->contains_overlapping_glyphs_p
,
13788 row
->truncated_on_left_p
,
13789 row
->truncated_on_right_p
,
13790 row
->overlay_arrow_p
,
13792 MATRIX_ROW_CONTINUATION_LINE_P (row
),
13793 row
->displays_text_p
,
13796 row
->ends_in_middle_of_char_p
,
13797 row
->starts_in_middle_of_char_p
,
13803 row
->visible_height
,
13806 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
13807 row
->end
.overlay_string_index
,
13808 row
->continuation_lines_width
);
13809 fprintf (stderr
, "%9d %5d\n",
13810 CHARPOS (row
->start
.string_pos
),
13811 CHARPOS (row
->end
.string_pos
));
13812 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
13813 row
->end
.dpvec_index
);
13820 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
13822 struct glyph
*glyph
= row
->glyphs
[area
];
13823 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
13825 /* Glyph for a line end in text. */
13826 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
13829 if (glyph
< glyph_end
)
13830 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
13832 for (; glyph
< glyph_end
; ++glyph
)
13833 dump_glyph (row
, glyph
, area
);
13836 else if (glyphs
== 1)
13840 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
13842 char *s
= (char *) alloca (row
->used
[area
] + 1);
13845 for (i
= 0; i
< row
->used
[area
]; ++i
)
13847 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
13848 if (glyph
->type
== CHAR_GLYPH
13849 && glyph
->u
.ch
< 0x80
13850 && glyph
->u
.ch
>= ' ')
13851 s
[i
] = glyph
->u
.ch
;
13857 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
13863 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
13864 Sdump_glyph_matrix
, 0, 1, "p",
13865 doc
: /* Dump the current matrix of the selected window to stderr.
13866 Shows contents of glyph row structures. With non-nil
13867 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
13868 glyphs in short form, otherwise show glyphs in long form. */)
13870 Lisp_Object glyphs
;
13872 struct window
*w
= XWINDOW (selected_window
);
13873 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13875 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
13876 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
13877 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
13878 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
13879 fprintf (stderr
, "=============================================\n");
13880 dump_glyph_matrix (w
->current_matrix
,
13881 NILP (glyphs
) ? 0 : XINT (glyphs
));
13886 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
13887 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
13890 struct frame
*f
= XFRAME (selected_frame
);
13891 dump_glyph_matrix (f
->current_matrix
, 1);
13896 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
13897 doc
: /* Dump glyph row ROW to stderr.
13898 GLYPH 0 means don't dump glyphs.
13899 GLYPH 1 means dump glyphs in short form.
13900 GLYPH > 1 or omitted means dump glyphs in long form. */)
13902 Lisp_Object row
, glyphs
;
13904 struct glyph_matrix
*matrix
;
13907 CHECK_NUMBER (row
);
13908 matrix
= XWINDOW (selected_window
)->current_matrix
;
13910 if (vpos
>= 0 && vpos
< matrix
->nrows
)
13911 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
13913 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
13918 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
13919 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
13920 GLYPH 0 means don't dump glyphs.
13921 GLYPH 1 means dump glyphs in short form.
13922 GLYPH > 1 or omitted means dump glyphs in long form. */)
13924 Lisp_Object row
, glyphs
;
13926 struct frame
*sf
= SELECTED_FRAME ();
13927 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
13930 CHECK_NUMBER (row
);
13932 if (vpos
>= 0 && vpos
< m
->nrows
)
13933 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
13934 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
13939 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
13940 doc
: /* Toggle tracing of redisplay.
13941 With ARG, turn tracing on if and only if ARG is positive. */)
13946 trace_redisplay_p
= !trace_redisplay_p
;
13949 arg
= Fprefix_numeric_value (arg
);
13950 trace_redisplay_p
= XINT (arg
) > 0;
13957 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
13958 doc
: /* Like `format', but print result to stderr.
13959 usage: (trace-to-stderr STRING &rest OBJECTS) */)
13964 Lisp_Object s
= Fformat (nargs
, args
);
13965 fprintf (stderr
, "%s", SDATA (s
));
13969 #endif /* GLYPH_DEBUG */
13973 /***********************************************************************
13974 Building Desired Matrix Rows
13975 ***********************************************************************/
13977 /* Return a temporary glyph row holding the glyphs of an overlay
13978 arrow. Only used for non-window-redisplay windows. */
13980 static struct glyph_row
*
13981 get_overlay_arrow_glyph_row (w
, overlay_arrow_string
)
13983 Lisp_Object overlay_arrow_string
;
13985 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
13986 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13987 struct buffer
*old
= current_buffer
;
13988 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
13989 int arrow_len
= SCHARS (overlay_arrow_string
);
13990 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
13991 const unsigned char *p
;
13994 int n_glyphs_before
;
13996 set_buffer_temp (buffer
);
13997 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
13998 it
.glyph_row
->used
[TEXT_AREA
] = 0;
13999 SET_TEXT_POS (it
.position
, 0, 0);
14001 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
14003 while (p
< arrow_end
)
14005 Lisp_Object face
, ilisp
;
14007 /* Get the next character. */
14009 it
.c
= string_char_and_length (p
, arrow_len
, &it
.len
);
14011 it
.c
= *p
, it
.len
= 1;
14014 /* Get its face. */
14015 ilisp
= make_number (p
- arrow_string
);
14016 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
14017 it
.face_id
= compute_char_face (f
, it
.c
, face
);
14019 /* Compute its width, get its glyphs. */
14020 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
14021 SET_TEXT_POS (it
.position
, -1, -1);
14022 PRODUCE_GLYPHS (&it
);
14024 /* If this character doesn't fit any more in the line, we have
14025 to remove some glyphs. */
14026 if (it
.current_x
> it
.last_visible_x
)
14028 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
14033 set_buffer_temp (old
);
14034 return it
.glyph_row
;
14038 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
14039 glyphs are only inserted for terminal frames since we can't really
14040 win with truncation glyphs when partially visible glyphs are
14041 involved. Which glyphs to insert is determined by
14042 produce_special_glyphs. */
14045 insert_left_trunc_glyphs (it
)
14048 struct it truncate_it
;
14049 struct glyph
*from
, *end
, *to
, *toend
;
14051 xassert (!FRAME_WINDOW_P (it
->f
));
14053 /* Get the truncation glyphs. */
14055 truncate_it
.current_x
= 0;
14056 truncate_it
.face_id
= DEFAULT_FACE_ID
;
14057 truncate_it
.glyph_row
= &scratch_glyph_row
;
14058 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
14059 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
14060 truncate_it
.object
= make_number (0);
14061 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
14063 /* Overwrite glyphs from IT with truncation glyphs. */
14064 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
14065 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
14066 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
14067 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
14072 /* There may be padding glyphs left over. Overwrite them too. */
14073 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
14075 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
14081 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
14085 /* Compute the pixel height and width of IT->glyph_row.
14087 Most of the time, ascent and height of a display line will be equal
14088 to the max_ascent and max_height values of the display iterator
14089 structure. This is not the case if
14091 1. We hit ZV without displaying anything. In this case, max_ascent
14092 and max_height will be zero.
14094 2. We have some glyphs that don't contribute to the line height.
14095 (The glyph row flag contributes_to_line_height_p is for future
14096 pixmap extensions).
14098 The first case is easily covered by using default values because in
14099 these cases, the line height does not really matter, except that it
14100 must not be zero. */
14103 compute_line_metrics (it
)
14106 struct glyph_row
*row
= it
->glyph_row
;
14109 if (FRAME_WINDOW_P (it
->f
))
14111 int i
, min_y
, max_y
;
14113 /* The line may consist of one space only, that was added to
14114 place the cursor on it. If so, the row's height hasn't been
14116 if (row
->height
== 0)
14118 if (it
->max_ascent
+ it
->max_descent
== 0)
14119 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
14120 row
->ascent
= it
->max_ascent
;
14121 row
->height
= it
->max_ascent
+ it
->max_descent
;
14122 row
->phys_ascent
= it
->max_phys_ascent
;
14123 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
14126 /* Compute the width of this line. */
14127 row
->pixel_width
= row
->x
;
14128 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
14129 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
14131 xassert (row
->pixel_width
>= 0);
14132 xassert (row
->ascent
>= 0 && row
->height
> 0);
14134 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
14135 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
14137 /* If first line's physical ascent is larger than its logical
14138 ascent, use the physical ascent, and make the row taller.
14139 This makes accented characters fully visible. */
14140 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
14141 && row
->phys_ascent
> row
->ascent
)
14143 row
->height
+= row
->phys_ascent
- row
->ascent
;
14144 row
->ascent
= row
->phys_ascent
;
14147 /* Compute how much of the line is visible. */
14148 row
->visible_height
= row
->height
;
14150 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
14151 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
14153 if (row
->y
< min_y
)
14154 row
->visible_height
-= min_y
- row
->y
;
14155 if (row
->y
+ row
->height
> max_y
)
14156 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14160 row
->pixel_width
= row
->used
[TEXT_AREA
];
14161 if (row
->continued_p
)
14162 row
->pixel_width
-= it
->continuation_pixel_width
;
14163 else if (row
->truncated_on_right_p
)
14164 row
->pixel_width
-= it
->truncation_pixel_width
;
14165 row
->ascent
= row
->phys_ascent
= 0;
14166 row
->height
= row
->phys_height
= row
->visible_height
= 1;
14169 /* Compute a hash code for this row. */
14171 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
14172 for (i
= 0; i
< row
->used
[area
]; ++i
)
14173 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
14174 + row
->glyphs
[area
][i
].u
.val
14175 + row
->glyphs
[area
][i
].face_id
14176 + row
->glyphs
[area
][i
].padding_p
14177 + (row
->glyphs
[area
][i
].type
<< 2));
14179 it
->max_ascent
= it
->max_descent
= 0;
14180 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
14184 /* Append one space to the glyph row of iterator IT if doing a
14185 window-based redisplay. The space has the same face as
14186 IT->face_id. Value is non-zero if a space was added.
14188 This function is called to make sure that there is always one glyph
14189 at the end of a glyph row that the cursor can be set on under
14190 window-systems. (If there weren't such a glyph we would not know
14191 how wide and tall a box cursor should be displayed).
14193 At the same time this space let's a nicely handle clearing to the
14194 end of the line if the row ends in italic text. */
14197 append_space_for_newline (it
, default_face_p
)
14199 int default_face_p
;
14201 if (FRAME_WINDOW_P (it
->f
))
14203 int n
= it
->glyph_row
->used
[TEXT_AREA
];
14205 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
14206 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
14208 /* Save some values that must not be changed.
14209 Must save IT->c and IT->len because otherwise
14210 ITERATOR_AT_END_P wouldn't work anymore after
14211 append_space_for_newline has been called. */
14212 enum display_element_type saved_what
= it
->what
;
14213 int saved_c
= it
->c
, saved_len
= it
->len
;
14214 int saved_x
= it
->current_x
;
14215 int saved_face_id
= it
->face_id
;
14216 struct text_pos saved_pos
;
14217 Lisp_Object saved_object
;
14220 saved_object
= it
->object
;
14221 saved_pos
= it
->position
;
14223 it
->what
= IT_CHARACTER
;
14224 bzero (&it
->position
, sizeof it
->position
);
14225 it
->object
= make_number (0);
14229 if (default_face_p
)
14230 it
->face_id
= DEFAULT_FACE_ID
;
14231 else if (it
->face_before_selective_p
)
14232 it
->face_id
= it
->saved_face_id
;
14233 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
14234 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0);
14236 PRODUCE_GLYPHS (it
);
14238 it
->override_ascent
= -1;
14239 it
->constrain_row_ascent_descent_p
= 0;
14240 it
->current_x
= saved_x
;
14241 it
->object
= saved_object
;
14242 it
->position
= saved_pos
;
14243 it
->what
= saved_what
;
14244 it
->face_id
= saved_face_id
;
14245 it
->len
= saved_len
;
14255 /* Extend the face of the last glyph in the text area of IT->glyph_row
14256 to the end of the display line. Called from display_line.
14257 If the glyph row is empty, add a space glyph to it so that we
14258 know the face to draw. Set the glyph row flag fill_line_p. */
14261 extend_face_to_end_of_line (it
)
14265 struct frame
*f
= it
->f
;
14267 /* If line is already filled, do nothing. */
14268 if (it
->current_x
>= it
->last_visible_x
)
14271 /* Face extension extends the background and box of IT->face_id
14272 to the end of the line. If the background equals the background
14273 of the frame, we don't have to do anything. */
14274 if (it
->face_before_selective_p
)
14275 face
= FACE_FROM_ID (it
->f
, it
->saved_face_id
);
14277 face
= FACE_FROM_ID (f
, it
->face_id
);
14279 if (FRAME_WINDOW_P (f
)
14280 && face
->box
== FACE_NO_BOX
14281 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
14285 /* Set the glyph row flag indicating that the face of the last glyph
14286 in the text area has to be drawn to the end of the text area. */
14287 it
->glyph_row
->fill_line_p
= 1;
14289 /* If current character of IT is not ASCII, make sure we have the
14290 ASCII face. This will be automatically undone the next time
14291 get_next_display_element returns a multibyte character. Note
14292 that the character will always be single byte in unibyte text. */
14293 if (!SINGLE_BYTE_CHAR_P (it
->c
))
14295 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0);
14298 if (FRAME_WINDOW_P (f
))
14300 /* If the row is empty, add a space with the current face of IT,
14301 so that we know which face to draw. */
14302 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
14304 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
14305 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
14306 it
->glyph_row
->used
[TEXT_AREA
] = 1;
14311 /* Save some values that must not be changed. */
14312 int saved_x
= it
->current_x
;
14313 struct text_pos saved_pos
;
14314 Lisp_Object saved_object
;
14315 enum display_element_type saved_what
= it
->what
;
14316 int saved_face_id
= it
->face_id
;
14318 saved_object
= it
->object
;
14319 saved_pos
= it
->position
;
14321 it
->what
= IT_CHARACTER
;
14322 bzero (&it
->position
, sizeof it
->position
);
14323 it
->object
= make_number (0);
14326 it
->face_id
= face
->id
;
14328 PRODUCE_GLYPHS (it
);
14330 while (it
->current_x
<= it
->last_visible_x
)
14331 PRODUCE_GLYPHS (it
);
14333 /* Don't count these blanks really. It would let us insert a left
14334 truncation glyph below and make us set the cursor on them, maybe. */
14335 it
->current_x
= saved_x
;
14336 it
->object
= saved_object
;
14337 it
->position
= saved_pos
;
14338 it
->what
= saved_what
;
14339 it
->face_id
= saved_face_id
;
14344 /* Value is non-zero if text starting at CHARPOS in current_buffer is
14345 trailing whitespace. */
14348 trailing_whitespace_p (charpos
)
14351 int bytepos
= CHAR_TO_BYTE (charpos
);
14354 while (bytepos
< ZV_BYTE
14355 && (c
= FETCH_CHAR (bytepos
),
14356 c
== ' ' || c
== '\t'))
14359 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
14361 if (bytepos
!= PT_BYTE
)
14368 /* Highlight trailing whitespace, if any, in ROW. */
14371 highlight_trailing_whitespace (f
, row
)
14373 struct glyph_row
*row
;
14375 int used
= row
->used
[TEXT_AREA
];
14379 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
14380 struct glyph
*glyph
= start
+ used
- 1;
14382 /* Skip over glyphs inserted to display the cursor at the
14383 end of a line, for extending the face of the last glyph
14384 to the end of the line on terminals, and for truncation
14385 and continuation glyphs. */
14386 while (glyph
>= start
14387 && glyph
->type
== CHAR_GLYPH
14388 && INTEGERP (glyph
->object
))
14391 /* If last glyph is a space or stretch, and it's trailing
14392 whitespace, set the face of all trailing whitespace glyphs in
14393 IT->glyph_row to `trailing-whitespace'. */
14395 && BUFFERP (glyph
->object
)
14396 && (glyph
->type
== STRETCH_GLYPH
14397 || (glyph
->type
== CHAR_GLYPH
14398 && glyph
->u
.ch
== ' '))
14399 && trailing_whitespace_p (glyph
->charpos
))
14401 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
14403 while (glyph
>= start
14404 && BUFFERP (glyph
->object
)
14405 && (glyph
->type
== STRETCH_GLYPH
14406 || (glyph
->type
== CHAR_GLYPH
14407 && glyph
->u
.ch
== ' ')))
14408 (glyph
--)->face_id
= face_id
;
14414 /* Value is non-zero if glyph row ROW in window W should be
14415 used to hold the cursor. */
14418 cursor_row_p (w
, row
)
14420 struct glyph_row
*row
;
14422 int cursor_row_p
= 1;
14424 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
14426 /* If the row ends with a newline from a string, we don't want
14427 the cursor there (if the row is continued it doesn't end in a
14429 if (CHARPOS (row
->end
.string_pos
) >= 0
14430 || MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
14431 cursor_row_p
= row
->continued_p
;
14433 /* If the row ends at ZV, display the cursor at the end of that
14434 row instead of at the start of the row below. */
14435 else if (row
->ends_at_zv_p
)
14441 return cursor_row_p
;
14445 /* Construct the glyph row IT->glyph_row in the desired matrix of
14446 IT->w from text at the current position of IT. See dispextern.h
14447 for an overview of struct it. Value is non-zero if
14448 IT->glyph_row displays text, as opposed to a line displaying ZV
14455 struct glyph_row
*row
= it
->glyph_row
;
14456 int overlay_arrow_bitmap
;
14457 Lisp_Object overlay_arrow_string
;
14459 /* We always start displaying at hpos zero even if hscrolled. */
14460 xassert (it
->hpos
== 0 && it
->current_x
== 0);
14462 /* We must not display in a row that's not a text row. */
14463 xassert (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
14464 < it
->w
->desired_matrix
->nrows
);
14466 /* Is IT->w showing the region? */
14467 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
14469 /* Clear the result glyph row and enable it. */
14470 prepare_desired_row (row
);
14472 row
->y
= it
->current_y
;
14473 row
->start
= it
->start
;
14474 row
->continuation_lines_width
= it
->continuation_lines_width
;
14475 row
->displays_text_p
= 1;
14476 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
14477 it
->starts_in_middle_of_char_p
= 0;
14479 /* Arrange the overlays nicely for our purposes. Usually, we call
14480 display_line on only one line at a time, in which case this
14481 can't really hurt too much, or we call it on lines which appear
14482 one after another in the buffer, in which case all calls to
14483 recenter_overlay_lists but the first will be pretty cheap. */
14484 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
14486 /* Move over display elements that are not visible because we are
14487 hscrolled. This may stop at an x-position < IT->first_visible_x
14488 if the first glyph is partially visible or if we hit a line end. */
14489 if (it
->current_x
< it
->first_visible_x
)
14490 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
14491 MOVE_TO_POS
| MOVE_TO_X
);
14493 /* Get the initial row height. This is either the height of the
14494 text hscrolled, if there is any, or zero. */
14495 row
->ascent
= it
->max_ascent
;
14496 row
->height
= it
->max_ascent
+ it
->max_descent
;
14497 row
->phys_ascent
= it
->max_phys_ascent
;
14498 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
14500 /* Loop generating characters. The loop is left with IT on the next
14501 character to display. */
14504 int n_glyphs_before
, hpos_before
, x_before
;
14506 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
14508 /* Retrieve the next thing to display. Value is zero if end of
14510 if (!get_next_display_element (it
))
14512 /* Maybe add a space at the end of this line that is used to
14513 display the cursor there under X. Set the charpos of the
14514 first glyph of blank lines not corresponding to any text
14516 #ifdef HAVE_WINDOW_SYSTEM
14517 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
14518 row
->exact_window_width_line_p
= 1;
14520 #endif /* HAVE_WINDOW_SYSTEM */
14521 if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
14522 || row
->used
[TEXT_AREA
] == 0)
14524 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
14525 row
->displays_text_p
= 0;
14527 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
14528 && (!MINI_WINDOW_P (it
->w
)
14529 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
14530 row
->indicate_empty_line_p
= 1;
14533 it
->continuation_lines_width
= 0;
14534 row
->ends_at_zv_p
= 1;
14538 /* Now, get the metrics of what we want to display. This also
14539 generates glyphs in `row' (which is IT->glyph_row). */
14540 n_glyphs_before
= row
->used
[TEXT_AREA
];
14543 /* Remember the line height so far in case the next element doesn't
14544 fit on the line. */
14545 if (!it
->truncate_lines_p
)
14547 ascent
= it
->max_ascent
;
14548 descent
= it
->max_descent
;
14549 phys_ascent
= it
->max_phys_ascent
;
14550 phys_descent
= it
->max_phys_descent
;
14553 PRODUCE_GLYPHS (it
);
14555 /* If this display element was in marginal areas, continue with
14557 if (it
->area
!= TEXT_AREA
)
14559 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
14560 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
14561 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
14562 row
->phys_height
= max (row
->phys_height
,
14563 it
->max_phys_ascent
+ it
->max_phys_descent
);
14564 set_iterator_to_next (it
, 1);
14568 /* Does the display element fit on the line? If we truncate
14569 lines, we should draw past the right edge of the window. If
14570 we don't truncate, we want to stop so that we can display the
14571 continuation glyph before the right margin. If lines are
14572 continued, there are two possible strategies for characters
14573 resulting in more than 1 glyph (e.g. tabs): Display as many
14574 glyphs as possible in this line and leave the rest for the
14575 continuation line, or display the whole element in the next
14576 line. Original redisplay did the former, so we do it also. */
14577 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
14578 hpos_before
= it
->hpos
;
14581 if (/* Not a newline. */
14583 /* Glyphs produced fit entirely in the line. */
14584 && it
->current_x
< it
->last_visible_x
)
14586 it
->hpos
+= nglyphs
;
14587 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
14588 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
14589 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
14590 row
->phys_height
= max (row
->phys_height
,
14591 it
->max_phys_ascent
+ it
->max_phys_descent
);
14592 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
14593 row
->x
= x
- it
->first_visible_x
;
14598 struct glyph
*glyph
;
14600 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
14602 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
14603 new_x
= x
+ glyph
->pixel_width
;
14605 if (/* Lines are continued. */
14606 !it
->truncate_lines_p
14607 && (/* Glyph doesn't fit on the line. */
14608 new_x
> it
->last_visible_x
14609 /* Or it fits exactly on a window system frame. */
14610 || (new_x
== it
->last_visible_x
14611 && FRAME_WINDOW_P (it
->f
))))
14613 /* End of a continued line. */
14616 || (new_x
== it
->last_visible_x
14617 && FRAME_WINDOW_P (it
->f
)))
14619 /* Current glyph is the only one on the line or
14620 fits exactly on the line. We must continue
14621 the line because we can't draw the cursor
14622 after the glyph. */
14623 row
->continued_p
= 1;
14624 it
->current_x
= new_x
;
14625 it
->continuation_lines_width
+= new_x
;
14627 if (i
== nglyphs
- 1)
14629 set_iterator_to_next (it
, 1);
14630 #ifdef HAVE_WINDOW_SYSTEM
14631 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
14633 if (!get_next_display_element (it
))
14635 row
->exact_window_width_line_p
= 1;
14636 it
->continuation_lines_width
= 0;
14637 row
->continued_p
= 0;
14638 row
->ends_at_zv_p
= 1;
14640 else if (ITERATOR_AT_END_OF_LINE_P (it
))
14642 row
->continued_p
= 0;
14643 row
->exact_window_width_line_p
= 1;
14646 #endif /* HAVE_WINDOW_SYSTEM */
14649 else if (CHAR_GLYPH_PADDING_P (*glyph
)
14650 && !FRAME_WINDOW_P (it
->f
))
14652 /* A padding glyph that doesn't fit on this line.
14653 This means the whole character doesn't fit
14655 row
->used
[TEXT_AREA
] = n_glyphs_before
;
14657 /* Fill the rest of the row with continuation
14658 glyphs like in 20.x. */
14659 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
14660 < row
->glyphs
[1 + TEXT_AREA
])
14661 produce_special_glyphs (it
, IT_CONTINUATION
);
14663 row
->continued_p
= 1;
14664 it
->current_x
= x_before
;
14665 it
->continuation_lines_width
+= x_before
;
14667 /* Restore the height to what it was before the
14668 element not fitting on the line. */
14669 it
->max_ascent
= ascent
;
14670 it
->max_descent
= descent
;
14671 it
->max_phys_ascent
= phys_ascent
;
14672 it
->max_phys_descent
= phys_descent
;
14674 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
14676 /* A TAB that extends past the right edge of the
14677 window. This produces a single glyph on
14678 window system frames. We leave the glyph in
14679 this row and let it fill the row, but don't
14680 consume the TAB. */
14681 it
->continuation_lines_width
+= it
->last_visible_x
;
14682 row
->ends_in_middle_of_char_p
= 1;
14683 row
->continued_p
= 1;
14684 glyph
->pixel_width
= it
->last_visible_x
- x
;
14685 it
->starts_in_middle_of_char_p
= 1;
14689 /* Something other than a TAB that draws past
14690 the right edge of the window. Restore
14691 positions to values before the element. */
14692 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
14694 /* Display continuation glyphs. */
14695 if (!FRAME_WINDOW_P (it
->f
))
14696 produce_special_glyphs (it
, IT_CONTINUATION
);
14697 row
->continued_p
= 1;
14699 it
->continuation_lines_width
+= x
;
14701 if (nglyphs
> 1 && i
> 0)
14703 row
->ends_in_middle_of_char_p
= 1;
14704 it
->starts_in_middle_of_char_p
= 1;
14707 /* Restore the height to what it was before the
14708 element not fitting on the line. */
14709 it
->max_ascent
= ascent
;
14710 it
->max_descent
= descent
;
14711 it
->max_phys_ascent
= phys_ascent
;
14712 it
->max_phys_descent
= phys_descent
;
14717 else if (new_x
> it
->first_visible_x
)
14719 /* Increment number of glyphs actually displayed. */
14722 if (x
< it
->first_visible_x
)
14723 /* Glyph is partially visible, i.e. row starts at
14724 negative X position. */
14725 row
->x
= x
- it
->first_visible_x
;
14729 /* Glyph is completely off the left margin of the
14730 window. This should not happen because of the
14731 move_it_in_display_line at the start of this
14732 function, unless the text display area of the
14733 window is empty. */
14734 xassert (it
->first_visible_x
<= it
->last_visible_x
);
14738 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
14739 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
14740 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
14741 row
->phys_height
= max (row
->phys_height
,
14742 it
->max_phys_ascent
+ it
->max_phys_descent
);
14744 /* End of this display line if row is continued. */
14745 if (row
->continued_p
|| row
->ends_at_zv_p
)
14750 /* Is this a line end? If yes, we're also done, after making
14751 sure that a non-default face is extended up to the right
14752 margin of the window. */
14753 if (ITERATOR_AT_END_OF_LINE_P (it
))
14755 int used_before
= row
->used
[TEXT_AREA
];
14757 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
14759 #ifdef HAVE_WINDOW_SYSTEM
14760 /* Add a space at the end of the line that is used to
14761 display the cursor there. */
14762 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
14763 append_space_for_newline (it
, 0);
14764 #endif /* HAVE_WINDOW_SYSTEM */
14766 /* Extend the face to the end of the line. */
14767 extend_face_to_end_of_line (it
);
14769 /* Make sure we have the position. */
14770 if (used_before
== 0)
14771 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
14773 /* Consume the line end. This skips over invisible lines. */
14774 set_iterator_to_next (it
, 1);
14775 it
->continuation_lines_width
= 0;
14779 /* Proceed with next display element. Note that this skips
14780 over lines invisible because of selective display. */
14781 set_iterator_to_next (it
, 1);
14783 /* If we truncate lines, we are done when the last displayed
14784 glyphs reach past the right margin of the window. */
14785 if (it
->truncate_lines_p
14786 && (FRAME_WINDOW_P (it
->f
)
14787 ? (it
->current_x
>= it
->last_visible_x
)
14788 : (it
->current_x
> it
->last_visible_x
)))
14790 /* Maybe add truncation glyphs. */
14791 if (!FRAME_WINDOW_P (it
->f
))
14795 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
14796 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
14799 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
14801 row
->used
[TEXT_AREA
] = i
;
14802 produce_special_glyphs (it
, IT_TRUNCATION
);
14805 #ifdef HAVE_WINDOW_SYSTEM
14808 /* Don't truncate if we can overflow newline into fringe. */
14809 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
14811 if (!get_next_display_element (it
))
14813 #ifdef HAVE_WINDOW_SYSTEM
14814 it
->continuation_lines_width
= 0;
14815 row
->ends_at_zv_p
= 1;
14816 row
->exact_window_width_line_p
= 1;
14818 #endif /* HAVE_WINDOW_SYSTEM */
14820 if (ITERATOR_AT_END_OF_LINE_P (it
))
14822 row
->exact_window_width_line_p
= 1;
14823 goto at_end_of_line
;
14827 #endif /* HAVE_WINDOW_SYSTEM */
14829 row
->truncated_on_right_p
= 1;
14830 it
->continuation_lines_width
= 0;
14831 reseat_at_next_visible_line_start (it
, 0);
14832 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
14833 it
->hpos
= hpos_before
;
14834 it
->current_x
= x_before
;
14839 /* If line is not empty and hscrolled, maybe insert truncation glyphs
14840 at the left window margin. */
14841 if (it
->first_visible_x
14842 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
14844 if (!FRAME_WINDOW_P (it
->f
))
14845 insert_left_trunc_glyphs (it
);
14846 row
->truncated_on_left_p
= 1;
14849 /* If the start of this line is the overlay arrow-position, then
14850 mark this glyph row as the one containing the overlay arrow.
14851 This is clearly a mess with variable size fonts. It would be
14852 better to let it be displayed like cursors under X. */
14853 if (! overlay_arrow_seen
14854 && (overlay_arrow_string
14855 = overlay_arrow_at_row (it
->f
, row
, &overlay_arrow_bitmap
),
14856 !NILP (overlay_arrow_string
)))
14858 /* Overlay arrow in window redisplay is a fringe bitmap. */
14859 if (!FRAME_WINDOW_P (it
->f
))
14861 struct glyph_row
*arrow_row
14862 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
14863 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
14864 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
14865 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
14866 struct glyph
*p2
, *end
;
14868 /* Copy the arrow glyphs. */
14869 while (glyph
< arrow_end
)
14872 /* Throw away padding glyphs. */
14874 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
14875 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
14881 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
14885 overlay_arrow_seen
= 1;
14886 it
->w
->overlay_arrow_bitmap
= overlay_arrow_bitmap
;
14887 row
->overlay_arrow_p
= 1;
14890 /* Compute pixel dimensions of this line. */
14891 compute_line_metrics (it
);
14893 /* Remember the position at which this line ends. */
14894 row
->end
= it
->current
;
14896 /* Save fringe bitmaps in this row. */
14897 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
14898 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
14899 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
14900 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
14902 it
->left_user_fringe_bitmap
= 0;
14903 it
->left_user_fringe_face_id
= 0;
14904 it
->right_user_fringe_bitmap
= 0;
14905 it
->right_user_fringe_face_id
= 0;
14907 /* Maybe set the cursor. */
14908 if (it
->w
->cursor
.vpos
< 0
14909 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
14910 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
14911 && cursor_row_p (it
->w
, row
))
14912 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
14914 /* Highlight trailing whitespace. */
14915 if (!NILP (Vshow_trailing_whitespace
))
14916 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
14918 /* Prepare for the next line. This line starts horizontally at (X
14919 HPOS) = (0 0). Vertical positions are incremented. As a
14920 convenience for the caller, IT->glyph_row is set to the next
14922 it
->current_x
= it
->hpos
= 0;
14923 it
->current_y
+= row
->height
;
14926 it
->start
= it
->current
;
14927 return row
->displays_text_p
;
14932 /***********************************************************************
14934 ***********************************************************************/
14936 /* Redisplay the menu bar in the frame for window W.
14938 The menu bar of X frames that don't have X toolkit support is
14939 displayed in a special window W->frame->menu_bar_window.
14941 The menu bar of terminal frames is treated specially as far as
14942 glyph matrices are concerned. Menu bar lines are not part of
14943 windows, so the update is done directly on the frame matrix rows
14944 for the menu bar. */
14947 display_menu_bar (w
)
14950 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
14955 /* Don't do all this for graphical frames. */
14957 if (!NILP (Vwindow_system
))
14960 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
14965 if (FRAME_MAC_P (f
))
14969 #ifdef USE_X_TOOLKIT
14970 xassert (!FRAME_WINDOW_P (f
));
14971 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
14972 it
.first_visible_x
= 0;
14973 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
14974 #else /* not USE_X_TOOLKIT */
14975 if (FRAME_WINDOW_P (f
))
14977 /* Menu bar lines are displayed in the desired matrix of the
14978 dummy window menu_bar_window. */
14979 struct window
*menu_w
;
14980 xassert (WINDOWP (f
->menu_bar_window
));
14981 menu_w
= XWINDOW (f
->menu_bar_window
);
14982 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
14984 it
.first_visible_x
= 0;
14985 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
14989 /* This is a TTY frame, i.e. character hpos/vpos are used as
14991 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
14993 it
.first_visible_x
= 0;
14994 it
.last_visible_x
= FRAME_COLS (f
);
14996 #endif /* not USE_X_TOOLKIT */
14998 if (! mode_line_inverse_video
)
14999 /* Force the menu-bar to be displayed in the default face. */
15000 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
15002 /* Clear all rows of the menu bar. */
15003 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
15005 struct glyph_row
*row
= it
.glyph_row
+ i
;
15006 clear_glyph_row (row
);
15007 row
->enabled_p
= 1;
15008 row
->full_width_p
= 1;
15011 /* Display all items of the menu bar. */
15012 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
15013 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
15015 Lisp_Object string
;
15017 /* Stop at nil string. */
15018 string
= AREF (items
, i
+ 1);
15022 /* Remember where item was displayed. */
15023 AREF (items
, i
+ 3) = make_number (it
.hpos
);
15025 /* Display the item, pad with one space. */
15026 if (it
.current_x
< it
.last_visible_x
)
15027 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
15028 SCHARS (string
) + 1, 0, 0, -1);
15031 /* Fill out the line with spaces. */
15032 if (it
.current_x
< it
.last_visible_x
)
15033 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
15035 /* Compute the total height of the lines. */
15036 compute_line_metrics (&it
);
15041 /***********************************************************************
15043 ***********************************************************************/
15045 /* Redisplay mode lines in the window tree whose root is WINDOW. If
15046 FORCE is non-zero, redisplay mode lines unconditionally.
15047 Otherwise, redisplay only mode lines that are garbaged. Value is
15048 the number of windows whose mode lines were redisplayed. */
15051 redisplay_mode_lines (window
, force
)
15052 Lisp_Object window
;
15057 while (!NILP (window
))
15059 struct window
*w
= XWINDOW (window
);
15061 if (WINDOWP (w
->hchild
))
15062 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
15063 else if (WINDOWP (w
->vchild
))
15064 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
15066 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
15067 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
15069 struct text_pos lpoint
;
15070 struct buffer
*old
= current_buffer
;
15072 /* Set the window's buffer for the mode line display. */
15073 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15074 set_buffer_internal_1 (XBUFFER (w
->buffer
));
15076 /* Point refers normally to the selected window. For any
15077 other window, set up appropriate value. */
15078 if (!EQ (window
, selected_window
))
15080 struct text_pos pt
;
15082 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
15083 if (CHARPOS (pt
) < BEGV
)
15084 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
15085 else if (CHARPOS (pt
) > (ZV
- 1))
15086 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
15088 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
15091 /* Display mode lines. */
15092 clear_glyph_matrix (w
->desired_matrix
);
15093 if (display_mode_lines (w
))
15096 w
->must_be_updated_p
= 1;
15099 /* Restore old settings. */
15100 set_buffer_internal_1 (old
);
15101 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
15111 /* Display the mode and/or top line of window W. Value is the number
15112 of mode lines displayed. */
15115 display_mode_lines (w
)
15118 Lisp_Object old_selected_window
, old_selected_frame
;
15121 old_selected_frame
= selected_frame
;
15122 selected_frame
= w
->frame
;
15123 old_selected_window
= selected_window
;
15124 XSETWINDOW (selected_window
, w
);
15126 /* These will be set while the mode line specs are processed. */
15127 line_number_displayed
= 0;
15128 w
->column_number_displayed
= Qnil
;
15130 if (WINDOW_WANTS_MODELINE_P (w
))
15132 struct window
*sel_w
= XWINDOW (old_selected_window
);
15134 /* Select mode line face based on the real selected window. */
15135 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
15136 current_buffer
->mode_line_format
);
15140 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15142 display_mode_line (w
, HEADER_LINE_FACE_ID
,
15143 current_buffer
->header_line_format
);
15147 selected_frame
= old_selected_frame
;
15148 selected_window
= old_selected_window
;
15153 /* Display mode or top line of window W. FACE_ID specifies which line
15154 to display; it is either MODE_LINE_FACE_ID or HEADER_LINE_FACE_ID.
15155 FORMAT is the mode line format to display. Value is the pixel
15156 height of the mode line displayed. */
15159 display_mode_line (w
, face_id
, format
)
15161 enum face_id face_id
;
15162 Lisp_Object format
;
15167 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
15168 prepare_desired_row (it
.glyph_row
);
15170 it
.glyph_row
->mode_line_p
= 1;
15172 if (! mode_line_inverse_video
)
15173 /* Force the mode-line to be displayed in the default face. */
15174 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
15176 /* Temporarily make frame's keyboard the current kboard so that
15177 kboard-local variables in the mode_line_format will get the right
15179 push_frame_kboard (it
.f
);
15180 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
15181 pop_frame_kboard ();
15183 /* Fill up with spaces. */
15184 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
15186 compute_line_metrics (&it
);
15187 it
.glyph_row
->full_width_p
= 1;
15188 it
.glyph_row
->continued_p
= 0;
15189 it
.glyph_row
->truncated_on_left_p
= 0;
15190 it
.glyph_row
->truncated_on_right_p
= 0;
15192 /* Make a 3D mode-line have a shadow at its right end. */
15193 face
= FACE_FROM_ID (it
.f
, face_id
);
15194 extend_face_to_end_of_line (&it
);
15195 if (face
->box
!= FACE_NO_BOX
)
15197 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
15198 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
15199 last
->right_box_line_p
= 1;
15202 return it
.glyph_row
->height
;
15205 /* Alist that caches the results of :propertize.
15206 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
15207 Lisp_Object mode_line_proptrans_alist
;
15209 /* List of strings making up the mode-line. */
15210 Lisp_Object mode_line_string_list
;
15212 /* Base face property when building propertized mode line string. */
15213 static Lisp_Object mode_line_string_face
;
15214 static Lisp_Object mode_line_string_face_prop
;
15217 /* Contribute ELT to the mode line for window IT->w. How it
15218 translates into text depends on its data type.
15220 IT describes the display environment in which we display, as usual.
15222 DEPTH is the depth in recursion. It is used to prevent
15223 infinite recursion here.
15225 FIELD_WIDTH is the number of characters the display of ELT should
15226 occupy in the mode line, and PRECISION is the maximum number of
15227 characters to display from ELT's representation. See
15228 display_string for details.
15230 Returns the hpos of the end of the text generated by ELT.
15232 PROPS is a property list to add to any string we encounter.
15234 If RISKY is nonzero, remove (disregard) any properties in any string
15235 we encounter, and ignore :eval and :propertize.
15237 If the global variable `frame_title_ptr' is non-NULL, then the output
15238 is passed to `store_frame_title' instead of `display_string'. */
15241 display_mode_element (it
, depth
, field_width
, precision
, elt
, props
, risky
)
15244 int field_width
, precision
;
15245 Lisp_Object elt
, props
;
15248 int n
= 0, field
, prec
;
15253 elt
= build_string ("*too-deep*");
15257 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
15261 /* A string: output it and check for %-constructs within it. */
15263 const unsigned char *this, *lisp_string
;
15265 if (!NILP (props
) || risky
)
15267 Lisp_Object oprops
, aelt
;
15268 oprops
= Ftext_properties_at (make_number (0), elt
);
15270 if (NILP (Fequal (props
, oprops
)) || risky
)
15272 /* If the starting string has properties,
15273 merge the specified ones onto the existing ones. */
15274 if (! NILP (oprops
) && !risky
)
15278 oprops
= Fcopy_sequence (oprops
);
15280 while (CONSP (tem
))
15282 oprops
= Fplist_put (oprops
, XCAR (tem
),
15283 XCAR (XCDR (tem
)));
15284 tem
= XCDR (XCDR (tem
));
15289 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
15290 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
15292 mode_line_proptrans_alist
15293 = Fcons (aelt
, Fdelq (aelt
, mode_line_proptrans_alist
));
15300 elt
= Fcopy_sequence (elt
);
15301 Fset_text_properties (make_number (0), Flength (elt
),
15303 /* Add this item to mode_line_proptrans_alist. */
15304 mode_line_proptrans_alist
15305 = Fcons (Fcons (elt
, props
),
15306 mode_line_proptrans_alist
);
15307 /* Truncate mode_line_proptrans_alist
15308 to at most 50 elements. */
15309 tem
= Fnthcdr (make_number (50),
15310 mode_line_proptrans_alist
);
15312 XSETCDR (tem
, Qnil
);
15317 this = SDATA (elt
);
15318 lisp_string
= this;
15322 prec
= precision
- n
;
15323 if (frame_title_ptr
)
15324 n
+= store_frame_title (SDATA (elt
), -1, prec
);
15325 else if (!NILP (mode_line_string_list
))
15326 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
15328 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
15329 0, prec
, 0, STRING_MULTIBYTE (elt
));
15334 while ((precision
<= 0 || n
< precision
)
15336 && (frame_title_ptr
15337 || !NILP (mode_line_string_list
)
15338 || it
->current_x
< it
->last_visible_x
))
15340 const unsigned char *last
= this;
15342 /* Advance to end of string or next format specifier. */
15343 while ((c
= *this++) != '\0' && c
!= '%')
15346 if (this - 1 != last
)
15348 /* Output to end of string or up to '%'. Field width
15349 is length of string. Don't output more than
15350 PRECISION allows us. */
15353 prec
= chars_in_text (last
, this - last
);
15354 if (precision
> 0 && prec
> precision
- n
)
15355 prec
= precision
- n
;
15357 if (frame_title_ptr
)
15358 n
+= store_frame_title (last
, 0, prec
);
15359 else if (!NILP (mode_line_string_list
))
15361 int bytepos
= last
- lisp_string
;
15362 int charpos
= string_byte_to_char (elt
, bytepos
);
15363 n
+= store_mode_line_string (NULL
,
15364 Fsubstring (elt
, make_number (charpos
),
15365 make_number (charpos
+ prec
)),
15370 int bytepos
= last
- lisp_string
;
15371 int charpos
= string_byte_to_char (elt
, bytepos
);
15372 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
15374 STRING_MULTIBYTE (elt
));
15377 else /* c == '%' */
15379 const unsigned char *percent_position
= this;
15381 /* Get the specified minimum width. Zero means
15384 while ((c
= *this++) >= '0' && c
<= '9')
15385 field
= field
* 10 + c
- '0';
15387 /* Don't pad beyond the total padding allowed. */
15388 if (field_width
- n
> 0 && field
> field_width
- n
)
15389 field
= field_width
- n
;
15391 /* Note that either PRECISION <= 0 or N < PRECISION. */
15392 prec
= precision
- n
;
15395 n
+= display_mode_element (it
, depth
, field
, prec
,
15396 Vglobal_mode_string
, props
,
15401 int bytepos
, charpos
;
15402 unsigned char *spec
;
15404 bytepos
= percent_position
- lisp_string
;
15405 charpos
= (STRING_MULTIBYTE (elt
)
15406 ? string_byte_to_char (elt
, bytepos
)
15410 = decode_mode_spec (it
->w
, c
, field
, prec
, &multibyte
);
15412 if (frame_title_ptr
)
15413 n
+= store_frame_title (spec
, field
, prec
);
15414 else if (!NILP (mode_line_string_list
))
15416 int len
= strlen (spec
);
15417 Lisp_Object tem
= make_string (spec
, len
);
15418 props
= Ftext_properties_at (make_number (charpos
), elt
);
15419 /* Should only keep face property in props */
15420 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
15424 int nglyphs_before
, nwritten
;
15426 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
15427 nwritten
= display_string (spec
, Qnil
, elt
,
15432 /* Assign to the glyphs written above the
15433 string where the `%x' came from, position
15437 struct glyph
*glyph
15438 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
15442 for (i
= 0; i
< nwritten
; ++i
)
15444 glyph
[i
].object
= elt
;
15445 glyph
[i
].charpos
= charpos
;
15460 /* A symbol: process the value of the symbol recursively
15461 as if it appeared here directly. Avoid error if symbol void.
15462 Special case: if value of symbol is a string, output the string
15465 register Lisp_Object tem
;
15467 /* If the variable is not marked as risky to set
15468 then its contents are risky to use. */
15469 if (NILP (Fget (elt
, Qrisky_local_variable
)))
15472 tem
= Fboundp (elt
);
15475 tem
= Fsymbol_value (elt
);
15476 /* If value is a string, output that string literally:
15477 don't check for % within it. */
15481 if (!EQ (tem
, elt
))
15483 /* Give up right away for nil or t. */
15493 register Lisp_Object car
, tem
;
15495 /* A cons cell: five distinct cases.
15496 If first element is :eval or :propertize, do something special.
15497 If first element is a string or a cons, process all the elements
15498 and effectively concatenate them.
15499 If first element is a negative number, truncate displaying cdr to
15500 at most that many characters. If positive, pad (with spaces)
15501 to at least that many characters.
15502 If first element is a symbol, process the cadr or caddr recursively
15503 according to whether the symbol's value is non-nil or nil. */
15505 if (EQ (car
, QCeval
))
15507 /* An element of the form (:eval FORM) means evaluate FORM
15508 and use the result as mode line elements. */
15513 if (CONSP (XCDR (elt
)))
15516 spec
= safe_eval (XCAR (XCDR (elt
)));
15517 n
+= display_mode_element (it
, depth
, field_width
- n
,
15518 precision
- n
, spec
, props
,
15522 else if (EQ (car
, QCpropertize
))
15524 /* An element of the form (:propertize ELT PROPS...)
15525 means display ELT but applying properties PROPS. */
15530 if (CONSP (XCDR (elt
)))
15531 n
+= display_mode_element (it
, depth
, field_width
- n
,
15532 precision
- n
, XCAR (XCDR (elt
)),
15533 XCDR (XCDR (elt
)), risky
);
15535 else if (SYMBOLP (car
))
15537 tem
= Fboundp (car
);
15541 /* elt is now the cdr, and we know it is a cons cell.
15542 Use its car if CAR has a non-nil value. */
15545 tem
= Fsymbol_value (car
);
15552 /* Symbol's value is nil (or symbol is unbound)
15553 Get the cddr of the original list
15554 and if possible find the caddr and use that. */
15558 else if (!CONSP (elt
))
15563 else if (INTEGERP (car
))
15565 register int lim
= XINT (car
);
15569 /* Negative int means reduce maximum width. */
15570 if (precision
<= 0)
15573 precision
= min (precision
, -lim
);
15577 /* Padding specified. Don't let it be more than
15578 current maximum. */
15580 lim
= min (precision
, lim
);
15582 /* If that's more padding than already wanted, queue it.
15583 But don't reduce padding already specified even if
15584 that is beyond the current truncation point. */
15585 field_width
= max (lim
, field_width
);
15589 else if (STRINGP (car
) || CONSP (car
))
15591 register int limit
= 50;
15592 /* Limit is to protect against circular lists. */
15595 && (precision
<= 0 || n
< precision
))
15597 n
+= display_mode_element (it
, depth
, field_width
- n
,
15598 precision
- n
, XCAR (elt
),
15608 elt
= build_string ("*invalid*");
15612 /* Pad to FIELD_WIDTH. */
15613 if (field_width
> 0 && n
< field_width
)
15615 if (frame_title_ptr
)
15616 n
+= store_frame_title ("", field_width
- n
, 0);
15617 else if (!NILP (mode_line_string_list
))
15618 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
15620 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
15627 /* Store a mode-line string element in mode_line_string_list.
15629 If STRING is non-null, display that C string. Otherwise, the Lisp
15630 string LISP_STRING is displayed.
15632 FIELD_WIDTH is the minimum number of output glyphs to produce.
15633 If STRING has fewer characters than FIELD_WIDTH, pad to the right
15634 with spaces. FIELD_WIDTH <= 0 means don't pad.
15636 PRECISION is the maximum number of characters to output from
15637 STRING. PRECISION <= 0 means don't truncate the string.
15639 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
15640 properties to the string.
15642 PROPS are the properties to add to the string.
15643 The mode_line_string_face face property is always added to the string.
15646 static int store_mode_line_string (string
, lisp_string
, copy_string
, field_width
, precision
, props
)
15648 Lisp_Object lisp_string
;
15657 if (string
!= NULL
)
15659 len
= strlen (string
);
15660 if (precision
> 0 && len
> precision
)
15662 lisp_string
= make_string (string
, len
);
15664 props
= mode_line_string_face_prop
;
15665 else if (!NILP (mode_line_string_face
))
15667 Lisp_Object face
= Fplist_get (props
, Qface
);
15668 props
= Fcopy_sequence (props
);
15670 face
= mode_line_string_face
;
15672 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
15673 props
= Fplist_put (props
, Qface
, face
);
15675 Fadd_text_properties (make_number (0), make_number (len
),
15676 props
, lisp_string
);
15680 len
= XFASTINT (Flength (lisp_string
));
15681 if (precision
> 0 && len
> precision
)
15684 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
15687 if (!NILP (mode_line_string_face
))
15691 props
= Ftext_properties_at (make_number (0), lisp_string
);
15692 face
= Fplist_get (props
, Qface
);
15694 face
= mode_line_string_face
;
15696 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
15697 props
= Fcons (Qface
, Fcons (face
, Qnil
));
15699 lisp_string
= Fcopy_sequence (lisp_string
);
15702 Fadd_text_properties (make_number (0), make_number (len
),
15703 props
, lisp_string
);
15708 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
15712 if (field_width
> len
)
15714 field_width
-= len
;
15715 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
15717 Fadd_text_properties (make_number (0), make_number (field_width
),
15718 props
, lisp_string
);
15719 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
15727 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
15729 doc
: /* Return the mode-line of selected window as a string.
15730 First optional arg FORMAT specifies a different format string (see
15731 `mode-line-format' for details) to use. If FORMAT is t, return
15732 the buffer's header-line. Second optional arg WINDOW specifies a
15733 different window to use as the context for the formatting.
15734 If third optional arg NO-PROPS is non-nil, string is not propertized. */)
15735 (format
, window
, no_props
)
15736 Lisp_Object format
, window
, no_props
;
15741 struct buffer
*old_buffer
= NULL
;
15742 enum face_id face_id
= DEFAULT_FACE_ID
;
15745 window
= selected_window
;
15746 CHECK_WINDOW (window
);
15747 w
= XWINDOW (window
);
15748 CHECK_BUFFER (w
->buffer
);
15750 if (XBUFFER (w
->buffer
) != current_buffer
)
15752 old_buffer
= current_buffer
;
15753 set_buffer_internal_1 (XBUFFER (w
->buffer
));
15756 if (NILP (format
) || EQ (format
, Qt
))
15758 face_id
= NILP (format
)
15759 ? CURRENT_MODE_LINE_FACE_ID (w
) :
15760 HEADER_LINE_FACE_ID
;
15761 format
= NILP (format
)
15762 ? current_buffer
->mode_line_format
15763 : current_buffer
->header_line_format
;
15766 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
15768 if (NILP (no_props
))
15770 mode_line_string_face
=
15771 (face_id
== MODE_LINE_FACE_ID
? Qmode_line
:
15772 face_id
== MODE_LINE_INACTIVE_FACE_ID
? Qmode_line_inactive
:
15773 face_id
== HEADER_LINE_FACE_ID
? Qheader_line
: Qnil
);
15775 mode_line_string_face_prop
=
15776 NILP (mode_line_string_face
) ? Qnil
:
15777 Fcons (Qface
, Fcons (mode_line_string_face
, Qnil
));
15779 /* We need a dummy last element in mode_line_string_list to
15780 indicate we are building the propertized mode-line string.
15781 Using mode_line_string_face_prop here GC protects it. */
15782 mode_line_string_list
=
15783 Fcons (mode_line_string_face_prop
, Qnil
);
15784 frame_title_ptr
= NULL
;
15788 mode_line_string_face_prop
= Qnil
;
15789 mode_line_string_list
= Qnil
;
15790 frame_title_ptr
= frame_title_buf
;
15793 push_frame_kboard (it
.f
);
15794 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
15795 pop_frame_kboard ();
15798 set_buffer_internal_1 (old_buffer
);
15800 if (NILP (no_props
))
15803 mode_line_string_list
= Fnreverse (mode_line_string_list
);
15804 str
= Fmapconcat (intern ("identity"), XCDR (mode_line_string_list
),
15805 make_string ("", 0));
15806 mode_line_string_face_prop
= Qnil
;
15807 mode_line_string_list
= Qnil
;
15811 len
= frame_title_ptr
- frame_title_buf
;
15812 if (len
> 0 && frame_title_ptr
[-1] == '-')
15814 /* Mode lines typically ends with numerous dashes; reduce to two dashes. */
15815 while (frame_title_ptr
> frame_title_buf
&& *--frame_title_ptr
== '-')
15817 frame_title_ptr
+= 3; /* restore last non-dash + two dashes */
15818 if (len
> frame_title_ptr
- frame_title_buf
)
15819 len
= frame_title_ptr
- frame_title_buf
;
15822 frame_title_ptr
= NULL
;
15823 return make_string (frame_title_buf
, len
);
15826 /* Write a null-terminated, right justified decimal representation of
15827 the positive integer D to BUF using a minimal field width WIDTH. */
15830 pint2str (buf
, width
, d
)
15831 register char *buf
;
15832 register int width
;
15835 register char *p
= buf
;
15843 *p
++ = d
% 10 + '0';
15848 for (width
-= (int) (p
- buf
); width
> 0; --width
)
15859 /* Write a null-terminated, right justified decimal and "human
15860 readable" representation of the nonnegative integer D to BUF using
15861 a minimal field width WIDTH. D should be smaller than 999.5e24. */
15863 static const char power_letter
[] =
15877 pint2hrstr (buf
, width
, d
)
15882 /* We aim to represent the nonnegative integer D as
15883 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
15886 /* -1 means: do not use TENTHS. */
15890 /* Length of QUOTIENT.TENTHS as a string. */
15896 if (1000 <= quotient
)
15898 /* Scale to the appropriate EXPONENT. */
15901 remainder
= quotient
% 1000;
15905 while (1000 <= quotient
);
15907 /* Round to nearest and decide whether to use TENTHS or not. */
15910 tenths
= remainder
/ 100;
15911 if (50 <= remainder
% 100)
15917 if (quotient
== 10)
15924 if (500 <= remainder
)
15925 if (quotient
< 999)
15935 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
15936 if (tenths
== -1 && quotient
<= 99)
15943 p
= psuffix
= buf
+ max (width
, length
);
15945 /* Print EXPONENT. */
15947 *psuffix
++ = power_letter
[exponent
];
15950 /* Print TENTHS. */
15953 *--p
= '0' + tenths
;
15957 /* Print QUOTIENT. */
15960 int digit
= quotient
% 10;
15961 *--p
= '0' + digit
;
15963 while ((quotient
/= 10) != 0);
15965 /* Print leading spaces. */
15970 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
15971 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
15972 type of CODING_SYSTEM. Return updated pointer into BUF. */
15974 static unsigned char invalid_eol_type
[] = "(*invalid*)";
15977 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
15978 Lisp_Object coding_system
;
15979 register char *buf
;
15983 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
15984 const unsigned char *eol_str
;
15986 /* The EOL conversion we are using. */
15987 Lisp_Object eoltype
;
15989 val
= Fget (coding_system
, Qcoding_system
);
15992 if (!VECTORP (val
)) /* Not yet decided. */
15997 eoltype
= eol_mnemonic_undecided
;
15998 /* Don't mention EOL conversion if it isn't decided. */
16002 Lisp_Object eolvalue
;
16004 eolvalue
= Fget (coding_system
, Qeol_type
);
16007 *buf
++ = XFASTINT (AREF (val
, 1));
16011 /* The EOL conversion that is normal on this system. */
16013 if (NILP (eolvalue
)) /* Not yet decided. */
16014 eoltype
= eol_mnemonic_undecided
;
16015 else if (VECTORP (eolvalue
)) /* Not yet decided. */
16016 eoltype
= eol_mnemonic_undecided
;
16017 else /* INTEGERP (eolvalue) -- 0:LF, 1:CRLF, 2:CR */
16018 eoltype
= (XFASTINT (eolvalue
) == 0
16019 ? eol_mnemonic_unix
16020 : (XFASTINT (eolvalue
) == 1
16021 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
16027 /* Mention the EOL conversion if it is not the usual one. */
16028 if (STRINGP (eoltype
))
16030 eol_str
= SDATA (eoltype
);
16031 eol_str_len
= SBYTES (eoltype
);
16033 else if (INTEGERP (eoltype
)
16034 && CHAR_VALID_P (XINT (eoltype
), 0))
16036 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
16037 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
16042 eol_str
= invalid_eol_type
;
16043 eol_str_len
= sizeof (invalid_eol_type
) - 1;
16045 bcopy (eol_str
, buf
, eol_str_len
);
16046 buf
+= eol_str_len
;
16052 /* Return a string for the output of a mode line %-spec for window W,
16053 generated by character C. PRECISION >= 0 means don't return a
16054 string longer than that value. FIELD_WIDTH > 0 means pad the
16055 string returned with spaces to that value. Return 1 in *MULTIBYTE
16056 if the result is multibyte text. */
16058 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
16061 decode_mode_spec (w
, c
, field_width
, precision
, multibyte
)
16064 int field_width
, precision
;
16068 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16069 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
16070 struct buffer
*b
= XBUFFER (w
->buffer
);
16078 if (!NILP (b
->read_only
))
16080 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
16085 /* This differs from %* only for a modified read-only buffer. */
16086 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
16088 if (!NILP (b
->read_only
))
16093 /* This differs from %* in ignoring read-only-ness. */
16094 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
16106 if (command_loop_level
> 5)
16108 p
= decode_mode_spec_buf
;
16109 for (i
= 0; i
< command_loop_level
; i
++)
16112 return decode_mode_spec_buf
;
16120 if (command_loop_level
> 5)
16122 p
= decode_mode_spec_buf
;
16123 for (i
= 0; i
< command_loop_level
; i
++)
16126 return decode_mode_spec_buf
;
16133 /* Let lots_of_dashes be a string of infinite length. */
16134 if (!NILP (mode_line_string_list
))
16136 if (field_width
<= 0
16137 || field_width
> sizeof (lots_of_dashes
))
16139 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
16140 decode_mode_spec_buf
[i
] = '-';
16141 decode_mode_spec_buf
[i
] = '\0';
16142 return decode_mode_spec_buf
;
16145 return lots_of_dashes
;
16154 int col
= (int) current_column (); /* iftc */
16155 w
->column_number_displayed
= make_number (col
);
16156 pint2str (decode_mode_spec_buf
, field_width
, col
);
16157 return decode_mode_spec_buf
;
16161 /* %F displays the frame name. */
16162 if (!NILP (f
->title
))
16163 return (char *) SDATA (f
->title
);
16164 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
16165 return (char *) SDATA (f
->name
);
16174 int size
= ZV
- BEGV
;
16175 pint2str (decode_mode_spec_buf
, field_width
, size
);
16176 return decode_mode_spec_buf
;
16181 int size
= ZV
- BEGV
;
16182 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
16183 return decode_mode_spec_buf
;
16188 int startpos
= XMARKER (w
->start
)->charpos
;
16189 int startpos_byte
= marker_byte_position (w
->start
);
16190 int line
, linepos
, linepos_byte
, topline
;
16192 int height
= WINDOW_TOTAL_LINES (w
);
16194 /* If we decided that this buffer isn't suitable for line numbers,
16195 don't forget that too fast. */
16196 if (EQ (w
->base_line_pos
, w
->buffer
))
16198 /* But do forget it, if the window shows a different buffer now. */
16199 else if (BUFFERP (w
->base_line_pos
))
16200 w
->base_line_pos
= Qnil
;
16202 /* If the buffer is very big, don't waste time. */
16203 if (INTEGERP (Vline_number_display_limit
)
16204 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
16206 w
->base_line_pos
= Qnil
;
16207 w
->base_line_number
= Qnil
;
16211 if (!NILP (w
->base_line_number
)
16212 && !NILP (w
->base_line_pos
)
16213 && XFASTINT (w
->base_line_pos
) <= startpos
)
16215 line
= XFASTINT (w
->base_line_number
);
16216 linepos
= XFASTINT (w
->base_line_pos
);
16217 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
16222 linepos
= BUF_BEGV (b
);
16223 linepos_byte
= BUF_BEGV_BYTE (b
);
16226 /* Count lines from base line to window start position. */
16227 nlines
= display_count_lines (linepos
, linepos_byte
,
16231 topline
= nlines
+ line
;
16233 /* Determine a new base line, if the old one is too close
16234 or too far away, or if we did not have one.
16235 "Too close" means it's plausible a scroll-down would
16236 go back past it. */
16237 if (startpos
== BUF_BEGV (b
))
16239 w
->base_line_number
= make_number (topline
);
16240 w
->base_line_pos
= make_number (BUF_BEGV (b
));
16242 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
16243 || linepos
== BUF_BEGV (b
))
16245 int limit
= BUF_BEGV (b
);
16246 int limit_byte
= BUF_BEGV_BYTE (b
);
16248 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
16250 if (startpos
- distance
> limit
)
16252 limit
= startpos
- distance
;
16253 limit_byte
= CHAR_TO_BYTE (limit
);
16256 nlines
= display_count_lines (startpos
, startpos_byte
,
16258 - (height
* 2 + 30),
16260 /* If we couldn't find the lines we wanted within
16261 line_number_display_limit_width chars per line,
16262 give up on line numbers for this window. */
16263 if (position
== limit_byte
&& limit
== startpos
- distance
)
16265 w
->base_line_pos
= w
->buffer
;
16266 w
->base_line_number
= Qnil
;
16270 w
->base_line_number
= make_number (topline
- nlines
);
16271 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
16274 /* Now count lines from the start pos to point. */
16275 nlines
= display_count_lines (startpos
, startpos_byte
,
16276 PT_BYTE
, PT
, &junk
);
16278 /* Record that we did display the line number. */
16279 line_number_displayed
= 1;
16281 /* Make the string to show. */
16282 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
16283 return decode_mode_spec_buf
;
16286 char* p
= decode_mode_spec_buf
;
16287 int pad
= field_width
- 2;
16293 return decode_mode_spec_buf
;
16299 obj
= b
->mode_name
;
16303 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
16309 int pos
= marker_position (w
->start
);
16310 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
16312 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
16314 if (pos
<= BUF_BEGV (b
))
16319 else if (pos
<= BUF_BEGV (b
))
16323 if (total
> 1000000)
16324 /* Do it differently for a large value, to avoid overflow. */
16325 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
16327 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
16328 /* We can't normally display a 3-digit number,
16329 so get us a 2-digit number that is close. */
16332 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
16333 return decode_mode_spec_buf
;
16337 /* Display percentage of size above the bottom of the screen. */
16340 int toppos
= marker_position (w
->start
);
16341 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
16342 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
16344 if (botpos
>= BUF_ZV (b
))
16346 if (toppos
<= BUF_BEGV (b
))
16353 if (total
> 1000000)
16354 /* Do it differently for a large value, to avoid overflow. */
16355 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
16357 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
16358 /* We can't normally display a 3-digit number,
16359 so get us a 2-digit number that is close. */
16362 if (toppos
<= BUF_BEGV (b
))
16363 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
16365 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
16366 return decode_mode_spec_buf
;
16371 /* status of process */
16372 obj
= Fget_buffer_process (w
->buffer
);
16374 return "no process";
16375 #ifdef subprocesses
16376 obj
= Fsymbol_name (Fprocess_status (obj
));
16380 case 't': /* indicate TEXT or BINARY */
16381 #ifdef MODE_LINE_BINARY_TEXT
16382 return MODE_LINE_BINARY_TEXT (b
);
16388 /* coding-system (not including end-of-line format) */
16390 /* coding-system (including end-of-line type) */
16392 int eol_flag
= (c
== 'Z');
16393 char *p
= decode_mode_spec_buf
;
16395 if (! FRAME_WINDOW_P (f
))
16397 /* No need to mention EOL here--the terminal never needs
16398 to do EOL conversion. */
16399 p
= decode_mode_spec_coding (keyboard_coding
.symbol
, p
, 0);
16400 p
= decode_mode_spec_coding (terminal_coding
.symbol
, p
, 0);
16402 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
16405 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
16406 #ifdef subprocesses
16407 obj
= Fget_buffer_process (Fcurrent_buffer ());
16408 if (PROCESSP (obj
))
16410 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
16412 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
16415 #endif /* subprocesses */
16418 return decode_mode_spec_buf
;
16424 *multibyte
= STRING_MULTIBYTE (obj
);
16425 return (char *) SDATA (obj
);
16432 /* Count up to COUNT lines starting from START / START_BYTE.
16433 But don't go beyond LIMIT_BYTE.
16434 Return the number of lines thus found (always nonnegative).
16436 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
16439 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
16440 int start
, start_byte
, limit_byte
, count
;
16443 register unsigned char *cursor
;
16444 unsigned char *base
;
16446 register int ceiling
;
16447 register unsigned char *ceiling_addr
;
16448 int orig_count
= count
;
16450 /* If we are not in selective display mode,
16451 check only for newlines. */
16452 int selective_display
= (!NILP (current_buffer
->selective_display
)
16453 && !INTEGERP (current_buffer
->selective_display
));
16457 while (start_byte
< limit_byte
)
16459 ceiling
= BUFFER_CEILING_OF (start_byte
);
16460 ceiling
= min (limit_byte
- 1, ceiling
);
16461 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
16462 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
16465 if (selective_display
)
16466 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
16469 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
16472 if (cursor
!= ceiling_addr
)
16476 start_byte
+= cursor
- base
+ 1;
16477 *byte_pos_ptr
= start_byte
;
16481 if (++cursor
== ceiling_addr
)
16487 start_byte
+= cursor
- base
;
16492 while (start_byte
> limit_byte
)
16494 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
16495 ceiling
= max (limit_byte
, ceiling
);
16496 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
16497 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
16500 if (selective_display
)
16501 while (--cursor
!= ceiling_addr
16502 && *cursor
!= '\n' && *cursor
!= 015)
16505 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
16508 if (cursor
!= ceiling_addr
)
16512 start_byte
+= cursor
- base
+ 1;
16513 *byte_pos_ptr
= start_byte
;
16514 /* When scanning backwards, we should
16515 not count the newline posterior to which we stop. */
16516 return - orig_count
- 1;
16522 /* Here we add 1 to compensate for the last decrement
16523 of CURSOR, which took it past the valid range. */
16524 start_byte
+= cursor
- base
+ 1;
16528 *byte_pos_ptr
= limit_byte
;
16531 return - orig_count
+ count
;
16532 return orig_count
- count
;
16538 /***********************************************************************
16540 ***********************************************************************/
16542 /* Display a NUL-terminated string, starting with index START.
16544 If STRING is non-null, display that C string. Otherwise, the Lisp
16545 string LISP_STRING is displayed.
16547 If FACE_STRING is not nil, FACE_STRING_POS is a position in
16548 FACE_STRING. Display STRING or LISP_STRING with the face at
16549 FACE_STRING_POS in FACE_STRING:
16551 Display the string in the environment given by IT, but use the
16552 standard display table, temporarily.
16554 FIELD_WIDTH is the minimum number of output glyphs to produce.
16555 If STRING has fewer characters than FIELD_WIDTH, pad to the right
16556 with spaces. If STRING has more characters, more than FIELD_WIDTH
16557 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
16559 PRECISION is the maximum number of characters to output from
16560 STRING. PRECISION < 0 means don't truncate the string.
16562 This is roughly equivalent to printf format specifiers:
16564 FIELD_WIDTH PRECISION PRINTF
16565 ----------------------------------------
16571 MULTIBYTE zero means do not display multibyte chars, > 0 means do
16572 display them, and < 0 means obey the current buffer's value of
16573 enable_multibyte_characters.
16575 Value is the number of glyphs produced. */
16578 display_string (string
, lisp_string
, face_string
, face_string_pos
,
16579 start
, it
, field_width
, precision
, max_x
, multibyte
)
16580 unsigned char *string
;
16581 Lisp_Object lisp_string
;
16582 Lisp_Object face_string
;
16583 int face_string_pos
;
16586 int field_width
, precision
, max_x
;
16589 int hpos_at_start
= it
->hpos
;
16590 int saved_face_id
= it
->face_id
;
16591 struct glyph_row
*row
= it
->glyph_row
;
16593 /* Initialize the iterator IT for iteration over STRING beginning
16594 with index START. */
16595 reseat_to_string (it
, string
, lisp_string
, start
,
16596 precision
, field_width
, multibyte
);
16598 /* If displaying STRING, set up the face of the iterator
16599 from LISP_STRING, if that's given. */
16600 if (STRINGP (face_string
))
16606 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
16607 0, it
->region_beg_charpos
,
16608 it
->region_end_charpos
,
16609 &endptr
, it
->base_face_id
, 0);
16610 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16611 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
16614 /* Set max_x to the maximum allowed X position. Don't let it go
16615 beyond the right edge of the window. */
16617 max_x
= it
->last_visible_x
;
16619 max_x
= min (max_x
, it
->last_visible_x
);
16621 /* Skip over display elements that are not visible. because IT->w is
16623 if (it
->current_x
< it
->first_visible_x
)
16624 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
16625 MOVE_TO_POS
| MOVE_TO_X
);
16627 row
->ascent
= it
->max_ascent
;
16628 row
->height
= it
->max_ascent
+ it
->max_descent
;
16629 row
->phys_ascent
= it
->max_phys_ascent
;
16630 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16632 /* This condition is for the case that we are called with current_x
16633 past last_visible_x. */
16634 while (it
->current_x
< max_x
)
16636 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
16638 /* Get the next display element. */
16639 if (!get_next_display_element (it
))
16642 /* Produce glyphs. */
16643 x_before
= it
->current_x
;
16644 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
16645 PRODUCE_GLYPHS (it
);
16647 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
16650 while (i
< nglyphs
)
16652 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
16654 if (!it
->truncate_lines_p
16655 && x
+ glyph
->pixel_width
> max_x
)
16657 /* End of continued line or max_x reached. */
16658 if (CHAR_GLYPH_PADDING_P (*glyph
))
16660 /* A wide character is unbreakable. */
16661 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16662 it
->current_x
= x_before
;
16666 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
16671 else if (x
+ glyph
->pixel_width
> it
->first_visible_x
)
16673 /* Glyph is at least partially visible. */
16675 if (x
< it
->first_visible_x
)
16676 it
->glyph_row
->x
= x
- it
->first_visible_x
;
16680 /* Glyph is off the left margin of the display area.
16681 Should not happen. */
16685 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16686 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16687 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16688 row
->phys_height
= max (row
->phys_height
,
16689 it
->max_phys_ascent
+ it
->max_phys_descent
);
16690 x
+= glyph
->pixel_width
;
16694 /* Stop if max_x reached. */
16698 /* Stop at line ends. */
16699 if (ITERATOR_AT_END_OF_LINE_P (it
))
16701 it
->continuation_lines_width
= 0;
16705 set_iterator_to_next (it
, 1);
16707 /* Stop if truncating at the right edge. */
16708 if (it
->truncate_lines_p
16709 && it
->current_x
>= it
->last_visible_x
)
16711 /* Add truncation mark, but don't do it if the line is
16712 truncated at a padding space. */
16713 if (IT_CHARPOS (*it
) < it
->string_nchars
)
16715 if (!FRAME_WINDOW_P (it
->f
))
16719 if (it
->current_x
> it
->last_visible_x
)
16721 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
16722 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
16724 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
16726 row
->used
[TEXT_AREA
] = i
;
16727 produce_special_glyphs (it
, IT_TRUNCATION
);
16730 produce_special_glyphs (it
, IT_TRUNCATION
);
16732 it
->glyph_row
->truncated_on_right_p
= 1;
16738 /* Maybe insert a truncation at the left. */
16739 if (it
->first_visible_x
16740 && IT_CHARPOS (*it
) > 0)
16742 if (!FRAME_WINDOW_P (it
->f
))
16743 insert_left_trunc_glyphs (it
);
16744 it
->glyph_row
->truncated_on_left_p
= 1;
16747 it
->face_id
= saved_face_id
;
16749 /* Value is number of columns displayed. */
16750 return it
->hpos
- hpos_at_start
;
16755 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
16756 appears as an element of LIST or as the car of an element of LIST.
16757 If PROPVAL is a list, compare each element against LIST in that
16758 way, and return 1/2 if any element of PROPVAL is found in LIST.
16759 Otherwise return 0. This function cannot quit.
16760 The return value is 2 if the text is invisible but with an ellipsis
16761 and 1 if it's invisible and without an ellipsis. */
16764 invisible_p (propval
, list
)
16765 register Lisp_Object propval
;
16768 register Lisp_Object tail
, proptail
;
16770 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
16772 register Lisp_Object tem
;
16774 if (EQ (propval
, tem
))
16776 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
16777 return NILP (XCDR (tem
)) ? 1 : 2;
16780 if (CONSP (propval
))
16782 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
16784 Lisp_Object propelt
;
16785 propelt
= XCAR (proptail
);
16786 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
16788 register Lisp_Object tem
;
16790 if (EQ (propelt
, tem
))
16792 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
16793 return NILP (XCDR (tem
)) ? 1 : 2;
16801 /* Calculate a width or height in pixels from a specification using
16802 the following elements:
16805 NUM - a (fractional) multiple of the default font width/height
16806 (NUM) - specifies exactly NUM pixels
16807 UNIT - a fixed number of pixels, see below.
16808 ELEMENT - size of a display element in pixels, see below.
16809 (NUM . SPEC) - equals NUM * SPEC
16810 (+ SPEC SPEC ...) - add pixel values
16811 (- SPEC SPEC ...) - subtract pixel values
16812 (- SPEC) - negate pixel value
16815 INT or FLOAT - a number constant
16816 SYMBOL - use symbol's (buffer local) variable binding.
16819 in - pixels per inch *)
16820 mm - pixels per 1/1000 meter *)
16821 cm - pixels per 1/100 meter *)
16822 width - width of current font in pixels.
16823 height - height of current font in pixels.
16825 *) using the ratio(s) defined in display-pixels-per-inch.
16829 left-fringe - left fringe width in pixels
16830 right-fringe - right fringe width in pixels
16832 left-margin - left margin width in pixels
16833 right-margin - right margin width in pixels
16835 scroll-bar - scroll-bar area width in pixels
16839 Pixels corresponding to 5 inches:
16842 Total width of non-text areas on left side of window (if scroll-bar is on left):
16843 '(space :width (+ left-fringe left-margin scroll-bar))
16845 Align to first text column (in header line):
16846 '(space :align-to 0)
16848 Align to middle of text area minus half the width of variable `my-image'
16849 containing a loaded image:
16850 '(space :align-to (0.5 . (- text my-image)))
16852 Width of left margin minus width of 1 character in the default font:
16853 '(space :width (- left-margin 1))
16855 Width of left margin minus width of 2 characters in the current font:
16856 '(space :width (- left-margin (2 . width)))
16858 Center 1 character over left-margin (in header line):
16859 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
16861 Different ways to express width of left fringe plus left margin minus one pixel:
16862 '(space :width (- (+ left-fringe left-margin) (1)))
16863 '(space :width (+ left-fringe left-margin (- (1))))
16864 '(space :width (+ left-fringe left-margin (-1)))
16868 #define NUMVAL(X) \
16869 ((INTEGERP (X) || FLOATP (X)) \
16874 calc_pixel_width_or_height (res
, it
, prop
, font
, width_p
, align_to
)
16879 int width_p
, *align_to
;
16883 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
16884 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
16887 return OK_PIXELS (0);
16889 if (SYMBOLP (prop
))
16891 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
16893 char *unit
= SDATA (SYMBOL_NAME (prop
));
16895 if (unit
[0] == 'i' && unit
[1] == 'n')
16897 else if (unit
[0] == 'm' && unit
[1] == 'm')
16899 else if (unit
[0] == 'c' && unit
[1] == 'm')
16906 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
16907 || (CONSP (Vdisplay_pixels_per_inch
)
16909 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
16910 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
16912 return OK_PIXELS (ppi
/ pixels
);
16918 #ifdef HAVE_WINDOW_SYSTEM
16919 if (EQ (prop
, Qheight
))
16920 return OK_PIXELS (font
? FONT_HEIGHT ((XFontStruct
*)font
) : FRAME_LINE_HEIGHT (it
->f
));
16921 if (EQ (prop
, Qwidth
))
16922 return OK_PIXELS (font
? FONT_WIDTH ((XFontStruct
*)font
) : FRAME_COLUMN_WIDTH (it
->f
));
16924 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
16925 return OK_PIXELS (1);
16928 if (EQ (prop
, Qtext
))
16929 return OK_PIXELS (width_p
16930 ? window_box_width (it
->w
, TEXT_AREA
)
16931 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
16933 if (align_to
&& *align_to
< 0)
16936 if (EQ (prop
, Qleft
))
16937 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
16938 if (EQ (prop
, Qright
))
16939 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
16940 if (EQ (prop
, Qcenter
))
16941 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
16942 + window_box_width (it
->w
, TEXT_AREA
) / 2);
16943 if (EQ (prop
, Qleft_fringe
))
16944 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
16945 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
16946 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
16947 if (EQ (prop
, Qright_fringe
))
16948 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
16949 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
16950 : window_box_right_offset (it
->w
, TEXT_AREA
));
16951 if (EQ (prop
, Qleft_margin
))
16952 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
16953 if (EQ (prop
, Qright_margin
))
16954 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
16955 if (EQ (prop
, Qscroll_bar
))
16956 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
16958 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
16959 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
16960 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
16965 if (EQ (prop
, Qleft_fringe
))
16966 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
16967 if (EQ (prop
, Qright_fringe
))
16968 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
16969 if (EQ (prop
, Qleft_margin
))
16970 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
16971 if (EQ (prop
, Qright_margin
))
16972 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
16973 if (EQ (prop
, Qscroll_bar
))
16974 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
16977 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
16980 if (INTEGERP (prop
) || FLOATP (prop
))
16982 int base_unit
= (width_p
16983 ? FRAME_COLUMN_WIDTH (it
->f
)
16984 : FRAME_LINE_HEIGHT (it
->f
));
16985 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
16990 Lisp_Object car
= XCAR (prop
);
16991 Lisp_Object cdr
= XCDR (prop
);
16995 #ifdef HAVE_WINDOW_SYSTEM
16996 if (valid_image_p (prop
))
16998 int id
= lookup_image (it
->f
, prop
);
16999 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
17001 return OK_PIXELS (width_p
? img
->width
: img
->height
);
17004 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
17010 while (CONSP (cdr
))
17012 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
17013 font
, width_p
, align_to
))
17016 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
17021 if (EQ (car
, Qminus
))
17023 return OK_PIXELS (pixels
);
17026 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
17029 if (INTEGERP (car
) || FLOATP (car
))
17032 pixels
= XFLOATINT (car
);
17034 return OK_PIXELS (pixels
);
17035 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
17036 font
, width_p
, align_to
))
17037 return OK_PIXELS (pixels
* fact
);
17048 /***********************************************************************
17050 ***********************************************************************/
17052 #ifdef HAVE_WINDOW_SYSTEM
17057 dump_glyph_string (s
)
17058 struct glyph_string
*s
;
17060 fprintf (stderr
, "glyph string\n");
17061 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
17062 s
->x
, s
->y
, s
->width
, s
->height
);
17063 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
17064 fprintf (stderr
, " hl = %d\n", s
->hl
);
17065 fprintf (stderr
, " left overhang = %d, right = %d\n",
17066 s
->left_overhang
, s
->right_overhang
);
17067 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
17068 fprintf (stderr
, " extends to end of line = %d\n",
17069 s
->extends_to_end_of_line_p
);
17070 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
17071 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
17074 #endif /* GLYPH_DEBUG */
17076 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
17077 of XChar2b structures for S; it can't be allocated in
17078 init_glyph_string because it must be allocated via `alloca'. W
17079 is the window on which S is drawn. ROW and AREA are the glyph row
17080 and area within the row from which S is constructed. START is the
17081 index of the first glyph structure covered by S. HL is a
17082 face-override for drawing S. */
17085 #define OPTIONAL_HDC(hdc) hdc,
17086 #define DECLARE_HDC(hdc) HDC hdc;
17087 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
17088 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
17091 #ifndef OPTIONAL_HDC
17092 #define OPTIONAL_HDC(hdc)
17093 #define DECLARE_HDC(hdc)
17094 #define ALLOCATE_HDC(hdc, f)
17095 #define RELEASE_HDC(hdc, f)
17099 init_glyph_string (s
, OPTIONAL_HDC (hdc
) char2b
, w
, row
, area
, start
, hl
)
17100 struct glyph_string
*s
;
17104 struct glyph_row
*row
;
17105 enum glyph_row_area area
;
17107 enum draw_glyphs_face hl
;
17109 bzero (s
, sizeof *s
);
17111 s
->f
= XFRAME (w
->frame
);
17115 s
->display
= FRAME_X_DISPLAY (s
->f
);
17116 s
->window
= FRAME_X_WINDOW (s
->f
);
17117 s
->char2b
= char2b
;
17121 s
->first_glyph
= row
->glyphs
[area
] + start
;
17122 s
->height
= row
->height
;
17123 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
17125 /* Display the internal border below the tool-bar window. */
17126 if (s
->w
== XWINDOW (s
->f
->tool_bar_window
))
17127 s
->y
-= FRAME_INTERNAL_BORDER_WIDTH (s
->f
);
17129 s
->ybase
= s
->y
+ row
->ascent
;
17133 /* Append the list of glyph strings with head H and tail T to the list
17134 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
17137 append_glyph_string_lists (head
, tail
, h
, t
)
17138 struct glyph_string
**head
, **tail
;
17139 struct glyph_string
*h
, *t
;
17153 /* Prepend the list of glyph strings with head H and tail T to the
17154 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
17158 prepend_glyph_string_lists (head
, tail
, h
, t
)
17159 struct glyph_string
**head
, **tail
;
17160 struct glyph_string
*h
, *t
;
17174 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
17175 Set *HEAD and *TAIL to the resulting list. */
17178 append_glyph_string (head
, tail
, s
)
17179 struct glyph_string
**head
, **tail
;
17180 struct glyph_string
*s
;
17182 s
->next
= s
->prev
= NULL
;
17183 append_glyph_string_lists (head
, tail
, s
, s
);
17187 /* Get face and two-byte form of character glyph GLYPH on frame F.
17188 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
17189 a pointer to a realized face that is ready for display. */
17191 static INLINE
struct face
*
17192 get_glyph_face_and_encoding (f
, glyph
, char2b
, two_byte_p
)
17194 struct glyph
*glyph
;
17200 xassert (glyph
->type
== CHAR_GLYPH
);
17201 face
= FACE_FROM_ID (f
, glyph
->face_id
);
17206 if (!glyph
->multibyte_p
)
17208 /* Unibyte case. We don't have to encode, but we have to make
17209 sure to use a face suitable for unibyte. */
17210 STORE_XCHAR2B (char2b
, 0, glyph
->u
.ch
);
17212 else if (glyph
->u
.ch
< 128
17213 && glyph
->face_id
< BASIC_FACE_ID_SENTINEL
)
17215 /* Case of ASCII in a face known to fit ASCII. */
17216 STORE_XCHAR2B (char2b
, 0, glyph
->u
.ch
);
17220 int c1
, c2
, charset
;
17222 /* Split characters into bytes. If c2 is -1 afterwards, C is
17223 really a one-byte character so that byte1 is zero. */
17224 SPLIT_CHAR (glyph
->u
.ch
, charset
, c1
, c2
);
17226 STORE_XCHAR2B (char2b
, c1
, c2
);
17228 STORE_XCHAR2B (char2b
, 0, c1
);
17230 /* Maybe encode the character in *CHAR2B. */
17231 if (charset
!= CHARSET_ASCII
)
17233 struct font_info
*font_info
17234 = FONT_INFO_FROM_ID (f
, face
->font_info_id
);
17237 = rif
->encode_char (glyph
->u
.ch
, char2b
, font_info
, two_byte_p
);
17241 /* Make sure X resources of the face are allocated. */
17242 xassert (face
!= NULL
);
17243 PREPARE_FACE_FOR_DISPLAY (f
, face
);
17248 /* Fill glyph string S with composition components specified by S->cmp.
17250 FACES is an array of faces for all components of this composition.
17251 S->gidx is the index of the first component for S.
17252 OVERLAPS_P non-zero means S should draw the foreground only, and
17253 use its physical height for clipping.
17255 Value is the index of a component not in S. */
17258 fill_composite_glyph_string (s
, faces
, overlaps_p
)
17259 struct glyph_string
*s
;
17260 struct face
**faces
;
17267 s
->for_overlaps_p
= overlaps_p
;
17269 s
->face
= faces
[s
->gidx
];
17270 s
->font
= s
->face
->font
;
17271 s
->font_info
= FONT_INFO_FROM_ID (s
->f
, s
->face
->font_info_id
);
17273 /* For all glyphs of this composition, starting at the offset
17274 S->gidx, until we reach the end of the definition or encounter a
17275 glyph that requires the different face, add it to S. */
17277 for (i
= s
->gidx
+ 1; i
< s
->cmp
->glyph_len
&& faces
[i
] == s
->face
; ++i
)
17280 /* All glyph strings for the same composition has the same width,
17281 i.e. the width set for the first component of the composition. */
17283 s
->width
= s
->first_glyph
->pixel_width
;
17285 /* If the specified font could not be loaded, use the frame's
17286 default font, but record the fact that we couldn't load it in
17287 the glyph string so that we can draw rectangles for the
17288 characters of the glyph string. */
17289 if (s
->font
== NULL
)
17291 s
->font_not_found_p
= 1;
17292 s
->font
= FRAME_FONT (s
->f
);
17295 /* Adjust base line for subscript/superscript text. */
17296 s
->ybase
+= s
->first_glyph
->voffset
;
17298 xassert (s
->face
&& s
->face
->gc
);
17300 /* This glyph string must always be drawn with 16-bit functions. */
17303 return s
->gidx
+ s
->nchars
;
17307 /* Fill glyph string S from a sequence of character glyphs.
17309 FACE_ID is the face id of the string. START is the index of the
17310 first glyph to consider, END is the index of the last + 1.
17311 OVERLAPS_P non-zero means S should draw the foreground only, and
17312 use its physical height for clipping.
17314 Value is the index of the first glyph not in S. */
17317 fill_glyph_string (s
, face_id
, start
, end
, overlaps_p
)
17318 struct glyph_string
*s
;
17320 int start
, end
, overlaps_p
;
17322 struct glyph
*glyph
, *last
;
17324 int glyph_not_available_p
;
17326 xassert (s
->f
== XFRAME (s
->w
->frame
));
17327 xassert (s
->nchars
== 0);
17328 xassert (start
>= 0 && end
> start
);
17330 s
->for_overlaps_p
= overlaps_p
,
17331 glyph
= s
->row
->glyphs
[s
->area
] + start
;
17332 last
= s
->row
->glyphs
[s
->area
] + end
;
17333 voffset
= glyph
->voffset
;
17335 glyph_not_available_p
= glyph
->glyph_not_available_p
;
17337 while (glyph
< last
17338 && glyph
->type
== CHAR_GLYPH
17339 && glyph
->voffset
== voffset
17340 /* Same face id implies same font, nowadays. */
17341 && glyph
->face_id
== face_id
17342 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
17346 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
17347 s
->char2b
+ s
->nchars
,
17349 s
->two_byte_p
= two_byte_p
;
17351 xassert (s
->nchars
<= end
- start
);
17352 s
->width
+= glyph
->pixel_width
;
17356 s
->font
= s
->face
->font
;
17357 s
->font_info
= FONT_INFO_FROM_ID (s
->f
, s
->face
->font_info_id
);
17359 /* If the specified font could not be loaded, use the frame's font,
17360 but record the fact that we couldn't load it in
17361 S->font_not_found_p so that we can draw rectangles for the
17362 characters of the glyph string. */
17363 if (s
->font
== NULL
|| glyph_not_available_p
)
17365 s
->font_not_found_p
= 1;
17366 s
->font
= FRAME_FONT (s
->f
);
17369 /* Adjust base line for subscript/superscript text. */
17370 s
->ybase
+= voffset
;
17372 xassert (s
->face
&& s
->face
->gc
);
17373 return glyph
- s
->row
->glyphs
[s
->area
];
17377 /* Fill glyph string S from image glyph S->first_glyph. */
17380 fill_image_glyph_string (s
)
17381 struct glyph_string
*s
;
17383 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
17384 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
17386 s
->slice
= s
->first_glyph
->slice
;
17387 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
17388 s
->font
= s
->face
->font
;
17389 s
->width
= s
->first_glyph
->pixel_width
;
17391 /* Adjust base line for subscript/superscript text. */
17392 s
->ybase
+= s
->first_glyph
->voffset
;
17396 /* Fill glyph string S from a sequence of stretch glyphs.
17398 ROW is the glyph row in which the glyphs are found, AREA is the
17399 area within the row. START is the index of the first glyph to
17400 consider, END is the index of the last + 1.
17402 Value is the index of the first glyph not in S. */
17405 fill_stretch_glyph_string (s
, row
, area
, start
, end
)
17406 struct glyph_string
*s
;
17407 struct glyph_row
*row
;
17408 enum glyph_row_area area
;
17411 struct glyph
*glyph
, *last
;
17412 int voffset
, face_id
;
17414 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
17416 glyph
= s
->row
->glyphs
[s
->area
] + start
;
17417 last
= s
->row
->glyphs
[s
->area
] + end
;
17418 face_id
= glyph
->face_id
;
17419 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
17420 s
->font
= s
->face
->font
;
17421 s
->font_info
= FONT_INFO_FROM_ID (s
->f
, s
->face
->font_info_id
);
17422 s
->width
= glyph
->pixel_width
;
17423 voffset
= glyph
->voffset
;
17427 && glyph
->type
== STRETCH_GLYPH
17428 && glyph
->voffset
== voffset
17429 && glyph
->face_id
== face_id
);
17431 s
->width
+= glyph
->pixel_width
;
17433 /* Adjust base line for subscript/superscript text. */
17434 s
->ybase
+= voffset
;
17436 /* The case that face->gc == 0 is handled when drawing the glyph
17437 string by calling PREPARE_FACE_FOR_DISPLAY. */
17439 return glyph
- s
->row
->glyphs
[s
->area
];
17444 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
17445 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
17446 assumed to be zero. */
17449 x_get_glyph_overhangs (glyph
, f
, left
, right
)
17450 struct glyph
*glyph
;
17454 *left
= *right
= 0;
17456 if (glyph
->type
== CHAR_GLYPH
)
17460 struct font_info
*font_info
;
17464 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
17466 font_info
= FONT_INFO_FROM_ID (f
, face
->font_info_id
);
17467 if (font
/* ++KFS: Should this be font_info ? */
17468 && (pcm
= rif
->per_char_metric (font
, &char2b
, glyph
->font_type
)))
17470 if (pcm
->rbearing
> pcm
->width
)
17471 *right
= pcm
->rbearing
- pcm
->width
;
17472 if (pcm
->lbearing
< 0)
17473 *left
= -pcm
->lbearing
;
17479 /* Return the index of the first glyph preceding glyph string S that
17480 is overwritten by S because of S's left overhang. Value is -1
17481 if no glyphs are overwritten. */
17484 left_overwritten (s
)
17485 struct glyph_string
*s
;
17489 if (s
->left_overhang
)
17492 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
17493 int first
= s
->first_glyph
- glyphs
;
17495 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
17496 x
-= glyphs
[i
].pixel_width
;
17507 /* Return the index of the first glyph preceding glyph string S that
17508 is overwriting S because of its right overhang. Value is -1 if no
17509 glyph in front of S overwrites S. */
17512 left_overwriting (s
)
17513 struct glyph_string
*s
;
17516 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
17517 int first
= s
->first_glyph
- glyphs
;
17521 for (i
= first
- 1; i
>= 0; --i
)
17524 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
17527 x
-= glyphs
[i
].pixel_width
;
17534 /* Return the index of the last glyph following glyph string S that is
17535 not overwritten by S because of S's right overhang. Value is -1 if
17536 no such glyph is found. */
17539 right_overwritten (s
)
17540 struct glyph_string
*s
;
17544 if (s
->right_overhang
)
17547 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
17548 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
17549 int end
= s
->row
->used
[s
->area
];
17551 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
17552 x
+= glyphs
[i
].pixel_width
;
17561 /* Return the index of the last glyph following glyph string S that
17562 overwrites S because of its left overhang. Value is negative
17563 if no such glyph is found. */
17566 right_overwriting (s
)
17567 struct glyph_string
*s
;
17570 int end
= s
->row
->used
[s
->area
];
17571 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
17572 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
17576 for (i
= first
; i
< end
; ++i
)
17579 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
17582 x
+= glyphs
[i
].pixel_width
;
17589 /* Get face and two-byte form of character C in face FACE_ID on frame
17590 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
17591 means we want to display multibyte text. DISPLAY_P non-zero means
17592 make sure that X resources for the face returned are allocated.
17593 Value is a pointer to a realized face that is ready for display if
17594 DISPLAY_P is non-zero. */
17596 static INLINE
struct face
*
17597 get_char_face_and_encoding (f
, c
, face_id
, char2b
, multibyte_p
, display_p
)
17601 int multibyte_p
, display_p
;
17603 struct face
*face
= FACE_FROM_ID (f
, face_id
);
17607 /* Unibyte case. We don't have to encode, but we have to make
17608 sure to use a face suitable for unibyte. */
17609 STORE_XCHAR2B (char2b
, 0, c
);
17610 face_id
= FACE_FOR_CHAR (f
, face
, c
);
17611 face
= FACE_FROM_ID (f
, face_id
);
17613 else if (c
< 128 && face_id
< BASIC_FACE_ID_SENTINEL
)
17615 /* Case of ASCII in a face known to fit ASCII. */
17616 STORE_XCHAR2B (char2b
, 0, c
);
17620 int c1
, c2
, charset
;
17622 /* Split characters into bytes. If c2 is -1 afterwards, C is
17623 really a one-byte character so that byte1 is zero. */
17624 SPLIT_CHAR (c
, charset
, c1
, c2
);
17626 STORE_XCHAR2B (char2b
, c1
, c2
);
17628 STORE_XCHAR2B (char2b
, 0, c1
);
17630 /* Maybe encode the character in *CHAR2B. */
17631 if (face
->font
!= NULL
)
17633 struct font_info
*font_info
17634 = FONT_INFO_FROM_ID (f
, face
->font_info_id
);
17636 rif
->encode_char (c
, char2b
, font_info
, 0);
17640 /* Make sure X resources of the face are allocated. */
17641 #ifdef HAVE_X_WINDOWS
17645 xassert (face
!= NULL
);
17646 PREPARE_FACE_FOR_DISPLAY (f
, face
);
17653 /* Set background width of glyph string S. START is the index of the
17654 first glyph following S. LAST_X is the right-most x-position + 1
17655 in the drawing area. */
17658 set_glyph_string_background_width (s
, start
, last_x
)
17659 struct glyph_string
*s
;
17663 /* If the face of this glyph string has to be drawn to the end of
17664 the drawing area, set S->extends_to_end_of_line_p. */
17665 struct face
*default_face
= FACE_FROM_ID (s
->f
, DEFAULT_FACE_ID
);
17667 if (start
== s
->row
->used
[s
->area
]
17668 && s
->area
== TEXT_AREA
17669 && ((s
->hl
== DRAW_NORMAL_TEXT
17670 && (s
->row
->fill_line_p
17671 || s
->face
->background
!= default_face
->background
17672 || s
->face
->stipple
!= default_face
->stipple
17673 || s
->row
->mouse_face_p
))
17674 || s
->hl
== DRAW_MOUSE_FACE
17675 || ((s
->hl
== DRAW_IMAGE_RAISED
|| s
->hl
== DRAW_IMAGE_SUNKEN
)
17676 && s
->row
->fill_line_p
)))
17677 s
->extends_to_end_of_line_p
= 1;
17679 /* If S extends its face to the end of the line, set its
17680 background_width to the distance to the right edge of the drawing
17682 if (s
->extends_to_end_of_line_p
)
17683 s
->background_width
= last_x
- s
->x
+ 1;
17685 s
->background_width
= s
->width
;
17689 /* Compute overhangs and x-positions for glyph string S and its
17690 predecessors, or successors. X is the starting x-position for S.
17691 BACKWARD_P non-zero means process predecessors. */
17694 compute_overhangs_and_x (s
, x
, backward_p
)
17695 struct glyph_string
*s
;
17703 if (rif
->compute_glyph_string_overhangs
)
17704 rif
->compute_glyph_string_overhangs (s
);
17714 if (rif
->compute_glyph_string_overhangs
)
17715 rif
->compute_glyph_string_overhangs (s
);
17725 /* The following macros are only called from draw_glyphs below.
17726 They reference the following parameters of that function directly:
17727 `w', `row', `area', and `overlap_p'
17728 as well as the following local variables:
17729 `s', `f', and `hdc' (in W32) */
17732 /* On W32, silently add local `hdc' variable to argument list of
17733 init_glyph_string. */
17734 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
17735 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
17737 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
17738 init_glyph_string (s, char2b, w, row, area, start, hl)
17741 /* Add a glyph string for a stretch glyph to the list of strings
17742 between HEAD and TAIL. START is the index of the stretch glyph in
17743 row area AREA of glyph row ROW. END is the index of the last glyph
17744 in that glyph row area. X is the current output position assigned
17745 to the new glyph string constructed. HL overrides that face of the
17746 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
17747 is the right-most x-position of the drawing area. */
17749 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
17750 and below -- keep them on one line. */
17751 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
17754 s = (struct glyph_string *) alloca (sizeof *s); \
17755 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
17756 START = fill_stretch_glyph_string (s, row, area, START, END); \
17757 append_glyph_string (&HEAD, &TAIL, s); \
17763 /* Add a glyph string for an image glyph to the list of strings
17764 between HEAD and TAIL. START is the index of the image glyph in
17765 row area AREA of glyph row ROW. END is the index of the last glyph
17766 in that glyph row area. X is the current output position assigned
17767 to the new glyph string constructed. HL overrides that face of the
17768 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
17769 is the right-most x-position of the drawing area. */
17771 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
17774 s = (struct glyph_string *) alloca (sizeof *s); \
17775 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
17776 fill_image_glyph_string (s); \
17777 append_glyph_string (&HEAD, &TAIL, s); \
17784 /* Add a glyph string for a sequence of character glyphs to the list
17785 of strings between HEAD and TAIL. START is the index of the first
17786 glyph in row area AREA of glyph row ROW that is part of the new
17787 glyph string. END is the index of the last glyph in that glyph row
17788 area. X is the current output position assigned to the new glyph
17789 string constructed. HL overrides that face of the glyph; e.g. it
17790 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
17791 right-most x-position of the drawing area. */
17793 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
17799 c = (row)->glyphs[area][START].u.ch; \
17800 face_id = (row)->glyphs[area][START].face_id; \
17802 s = (struct glyph_string *) alloca (sizeof *s); \
17803 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
17804 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
17805 append_glyph_string (&HEAD, &TAIL, s); \
17807 START = fill_glyph_string (s, face_id, START, END, overlaps_p); \
17812 /* Add a glyph string for a composite sequence to the list of strings
17813 between HEAD and TAIL. START is the index of the first glyph in
17814 row area AREA of glyph row ROW that is part of the new glyph
17815 string. END is the index of the last glyph in that glyph row area.
17816 X is the current output position assigned to the new glyph string
17817 constructed. HL overrides that face of the glyph; e.g. it is
17818 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
17819 x-position of the drawing area. */
17821 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
17823 int cmp_id = (row)->glyphs[area][START].u.cmp_id; \
17824 int face_id = (row)->glyphs[area][START].face_id; \
17825 struct face *base_face = FACE_FROM_ID (f, face_id); \
17826 struct composition *cmp = composition_table[cmp_id]; \
17827 int glyph_len = cmp->glyph_len; \
17829 struct face **faces; \
17830 struct glyph_string *first_s = NULL; \
17833 base_face = base_face->ascii_face; \
17834 char2b = (XChar2b *) alloca ((sizeof *char2b) * glyph_len); \
17835 faces = (struct face **) alloca ((sizeof *faces) * glyph_len); \
17836 /* At first, fill in `char2b' and `faces'. */ \
17837 for (n = 0; n < glyph_len; n++) \
17839 int c = COMPOSITION_GLYPH (cmp, n); \
17840 int this_face_id = FACE_FOR_CHAR (f, base_face, c); \
17841 faces[n] = FACE_FROM_ID (f, this_face_id); \
17842 get_char_face_and_encoding (f, c, this_face_id, \
17843 char2b + n, 1, 1); \
17846 /* Make glyph_strings for each glyph sequence that is drawable by \
17847 the same face, and append them to HEAD/TAIL. */ \
17848 for (n = 0; n < cmp->glyph_len;) \
17850 s = (struct glyph_string *) alloca (sizeof *s); \
17851 INIT_GLYPH_STRING (s, char2b + n, w, row, area, START, HL); \
17852 append_glyph_string (&(HEAD), &(TAIL), s); \
17860 n = fill_composite_glyph_string (s, faces, overlaps_p); \
17868 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
17869 of AREA of glyph row ROW on window W between indices START and END.
17870 HL overrides the face for drawing glyph strings, e.g. it is
17871 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
17872 x-positions of the drawing area.
17874 This is an ugly monster macro construct because we must use alloca
17875 to allocate glyph strings (because draw_glyphs can be called
17876 asynchronously). */
17878 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
17881 HEAD = TAIL = NULL; \
17882 while (START < END) \
17884 struct glyph *first_glyph = (row)->glyphs[area] + START; \
17885 switch (first_glyph->type) \
17888 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
17892 case COMPOSITE_GLYPH: \
17893 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
17897 case STRETCH_GLYPH: \
17898 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
17902 case IMAGE_GLYPH: \
17903 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
17911 set_glyph_string_background_width (s, START, LAST_X); \
17918 /* Draw glyphs between START and END in AREA of ROW on window W,
17919 starting at x-position X. X is relative to AREA in W. HL is a
17920 face-override with the following meaning:
17922 DRAW_NORMAL_TEXT draw normally
17923 DRAW_CURSOR draw in cursor face
17924 DRAW_MOUSE_FACE draw in mouse face.
17925 DRAW_INVERSE_VIDEO draw in mode line face
17926 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
17927 DRAW_IMAGE_RAISED draw an image with a raised relief around it
17929 If OVERLAPS_P is non-zero, draw only the foreground of characters
17930 and clip to the physical height of ROW.
17932 Value is the x-position reached, relative to AREA of W. */
17935 draw_glyphs (w
, x
, row
, area
, start
, end
, hl
, overlaps_p
)
17938 struct glyph_row
*row
;
17939 enum glyph_row_area area
;
17941 enum draw_glyphs_face hl
;
17944 struct glyph_string
*head
, *tail
;
17945 struct glyph_string
*s
;
17946 int last_x
, area_width
;
17949 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17952 ALLOCATE_HDC (hdc
, f
);
17954 /* Let's rather be paranoid than getting a SEGV. */
17955 end
= min (end
, row
->used
[area
]);
17956 start
= max (0, start
);
17957 start
= min (end
, start
);
17959 /* Translate X to frame coordinates. Set last_x to the right
17960 end of the drawing area. */
17961 if (row
->full_width_p
)
17963 /* X is relative to the left edge of W, without scroll bars
17965 x
+= WINDOW_LEFT_EDGE_X (w
);
17966 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
17970 int area_left
= window_box_left (w
, area
);
17972 area_width
= window_box_width (w
, area
);
17973 last_x
= area_left
+ area_width
;
17976 /* Build a doubly-linked list of glyph_string structures between
17977 head and tail from what we have to draw. Note that the macro
17978 BUILD_GLYPH_STRINGS will modify its start parameter. That's
17979 the reason we use a separate variable `i'. */
17981 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
17983 x_reached
= tail
->x
+ tail
->background_width
;
17987 /* If there are any glyphs with lbearing < 0 or rbearing > width in
17988 the row, redraw some glyphs in front or following the glyph
17989 strings built above. */
17990 if (head
&& !overlaps_p
&& row
->contains_overlapping_glyphs_p
)
17993 struct glyph_string
*h
, *t
;
17995 /* Compute overhangs for all glyph strings. */
17996 if (rif
->compute_glyph_string_overhangs
)
17997 for (s
= head
; s
; s
= s
->next
)
17998 rif
->compute_glyph_string_overhangs (s
);
18000 /* Prepend glyph strings for glyphs in front of the first glyph
18001 string that are overwritten because of the first glyph
18002 string's left overhang. The background of all strings
18003 prepended must be drawn because the first glyph string
18005 i
= left_overwritten (head
);
18009 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
18010 DRAW_NORMAL_TEXT
, dummy_x
, last_x
);
18012 compute_overhangs_and_x (t
, head
->x
, 1);
18013 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
18016 /* Prepend glyph strings for glyphs in front of the first glyph
18017 string that overwrite that glyph string because of their
18018 right overhang. For these strings, only the foreground must
18019 be drawn, because it draws over the glyph string at `head'.
18020 The background must not be drawn because this would overwrite
18021 right overhangs of preceding glyphs for which no glyph
18023 i
= left_overwriting (head
);
18026 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
18027 DRAW_NORMAL_TEXT
, dummy_x
, last_x
);
18028 for (s
= h
; s
; s
= s
->next
)
18029 s
->background_filled_p
= 1;
18030 compute_overhangs_and_x (t
, head
->x
, 1);
18031 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
18034 /* Append glyphs strings for glyphs following the last glyph
18035 string tail that are overwritten by tail. The background of
18036 these strings has to be drawn because tail's foreground draws
18038 i
= right_overwritten (tail
);
18041 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
18042 DRAW_NORMAL_TEXT
, x
, last_x
);
18043 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
18044 append_glyph_string_lists (&head
, &tail
, h
, t
);
18047 /* Append glyph strings for glyphs following the last glyph
18048 string tail that overwrite tail. The foreground of such
18049 glyphs has to be drawn because it writes into the background
18050 of tail. The background must not be drawn because it could
18051 paint over the foreground of following glyphs. */
18052 i
= right_overwriting (tail
);
18055 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
18056 DRAW_NORMAL_TEXT
, x
, last_x
);
18057 for (s
= h
; s
; s
= s
->next
)
18058 s
->background_filled_p
= 1;
18059 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
18060 append_glyph_string_lists (&head
, &tail
, h
, t
);
18064 /* Draw all strings. */
18065 for (s
= head
; s
; s
= s
->next
)
18066 rif
->draw_glyph_string (s
);
18068 if (area
== TEXT_AREA
18069 && !row
->full_width_p
18070 /* When drawing overlapping rows, only the glyph strings'
18071 foreground is drawn, which doesn't erase a cursor
18075 int x0
= head
? head
->x
: x
;
18076 int x1
= tail
? tail
->x
+ tail
->background_width
: x
;
18078 int text_left
= window_box_left (w
, TEXT_AREA
);
18082 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
18083 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
18086 /* Value is the x-position up to which drawn, relative to AREA of W.
18087 This doesn't include parts drawn because of overhangs. */
18088 if (row
->full_width_p
)
18089 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
18091 x_reached
-= window_box_left (w
, area
);
18093 RELEASE_HDC (hdc
, f
);
18099 /* Store one glyph for IT->char_to_display in IT->glyph_row.
18100 Called from x_produce_glyphs when IT->glyph_row is non-null. */
18106 struct glyph
*glyph
;
18107 enum glyph_row_area area
= it
->area
;
18109 xassert (it
->glyph_row
);
18110 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
18112 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
18113 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
18115 glyph
->charpos
= CHARPOS (it
->position
);
18116 glyph
->object
= it
->object
;
18117 glyph
->pixel_width
= it
->pixel_width
;
18118 glyph
->ascent
= it
->ascent
;
18119 glyph
->descent
= it
->descent
;
18120 glyph
->voffset
= it
->voffset
;
18121 glyph
->type
= CHAR_GLYPH
;
18122 glyph
->multibyte_p
= it
->multibyte_p
;
18123 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
18124 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
18125 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
18126 || it
->phys_descent
> it
->descent
);
18127 glyph
->padding_p
= 0;
18128 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
18129 glyph
->face_id
= it
->face_id
;
18130 glyph
->u
.ch
= it
->char_to_display
;
18131 glyph
->slice
= null_glyph_slice
;
18132 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
18133 ++it
->glyph_row
->used
[area
];
18137 /* Store one glyph for the composition IT->cmp_id in IT->glyph_row.
18138 Called from x_produce_glyphs when IT->glyph_row is non-null. */
18141 append_composite_glyph (it
)
18144 struct glyph
*glyph
;
18145 enum glyph_row_area area
= it
->area
;
18147 xassert (it
->glyph_row
);
18149 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
18150 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
18152 glyph
->charpos
= CHARPOS (it
->position
);
18153 glyph
->object
= it
->object
;
18154 glyph
->pixel_width
= it
->pixel_width
;
18155 glyph
->ascent
= it
->ascent
;
18156 glyph
->descent
= it
->descent
;
18157 glyph
->voffset
= it
->voffset
;
18158 glyph
->type
= COMPOSITE_GLYPH
;
18159 glyph
->multibyte_p
= it
->multibyte_p
;
18160 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
18161 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
18162 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
18163 || it
->phys_descent
> it
->descent
);
18164 glyph
->padding_p
= 0;
18165 glyph
->glyph_not_available_p
= 0;
18166 glyph
->face_id
= it
->face_id
;
18167 glyph
->u
.cmp_id
= it
->cmp_id
;
18168 glyph
->slice
= null_glyph_slice
;
18169 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
18170 ++it
->glyph_row
->used
[area
];
18175 /* Change IT->ascent and IT->height according to the setting of
18179 take_vertical_position_into_account (it
)
18184 if (it
->voffset
< 0)
18185 /* Increase the ascent so that we can display the text higher
18187 it
->ascent
-= it
->voffset
;
18189 /* Increase the descent so that we can display the text lower
18191 it
->descent
+= it
->voffset
;
18196 /* Produce glyphs/get display metrics for the image IT is loaded with.
18197 See the description of struct display_iterator in dispextern.h for
18198 an overview of struct display_iterator. */
18201 produce_image_glyph (it
)
18206 int face_ascent
, glyph_ascent
;
18207 struct glyph_slice slice
;
18209 xassert (it
->what
== IT_IMAGE
);
18211 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18213 /* Make sure X resources of the face is loaded. */
18214 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
18216 if (it
->image_id
< 0)
18218 /* Fringe bitmap. */
18219 it
->ascent
= it
->phys_ascent
= 0;
18220 it
->descent
= it
->phys_descent
= 0;
18221 it
->pixel_width
= 0;
18226 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
18228 /* Make sure X resources of the image is loaded. */
18229 prepare_image_for_display (it
->f
, img
);
18231 slice
.x
= slice
.y
= 0;
18232 slice
.width
= img
->width
;
18233 slice
.height
= img
->height
;
18235 if (INTEGERP (it
->slice
.x
))
18236 slice
.x
= XINT (it
->slice
.x
);
18237 else if (FLOATP (it
->slice
.x
))
18238 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
18240 if (INTEGERP (it
->slice
.y
))
18241 slice
.y
= XINT (it
->slice
.y
);
18242 else if (FLOATP (it
->slice
.y
))
18243 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
18245 if (INTEGERP (it
->slice
.width
))
18246 slice
.width
= XINT (it
->slice
.width
);
18247 else if (FLOATP (it
->slice
.width
))
18248 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
18250 if (INTEGERP (it
->slice
.height
))
18251 slice
.height
= XINT (it
->slice
.height
);
18252 else if (FLOATP (it
->slice
.height
))
18253 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
18255 if (slice
.x
>= img
->width
)
18256 slice
.x
= img
->width
;
18257 if (slice
.y
>= img
->height
)
18258 slice
.y
= img
->height
;
18259 if (slice
.x
+ slice
.width
>= img
->width
)
18260 slice
.width
= img
->width
- slice
.x
;
18261 if (slice
.y
+ slice
.height
> img
->height
)
18262 slice
.height
= img
->height
- slice
.y
;
18264 if (slice
.width
== 0 || slice
.height
== 0)
18267 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
18269 it
->descent
= slice
.height
- glyph_ascent
;
18271 it
->descent
+= img
->vmargin
;
18272 if (slice
.y
+ slice
.height
== img
->height
)
18273 it
->descent
+= img
->vmargin
;
18274 it
->phys_descent
= it
->descent
;
18276 it
->pixel_width
= slice
.width
;
18278 it
->pixel_width
+= img
->hmargin
;
18279 if (slice
.x
+ slice
.width
== img
->width
)
18280 it
->pixel_width
+= img
->hmargin
;
18282 /* It's quite possible for images to have an ascent greater than
18283 their height, so don't get confused in that case. */
18284 if (it
->descent
< 0)
18287 #if 0 /* this breaks image tiling */
18288 /* If this glyph is alone on the last line, adjust it.ascent to minimum row ascent. */
18289 face_ascent
= face
->font
? FONT_BASE (face
->font
) : FRAME_BASELINE_OFFSET (it
->f
);
18290 if (face_ascent
> it
->ascent
)
18291 it
->ascent
= it
->phys_ascent
= face_ascent
;
18296 if (face
->box
!= FACE_NO_BOX
)
18298 if (face
->box_line_width
> 0)
18301 it
->ascent
+= face
->box_line_width
;
18302 if (slice
.y
+ slice
.height
== img
->height
)
18303 it
->descent
+= face
->box_line_width
;
18306 if (it
->start_of_box_run_p
&& slice
.x
== 0)
18307 it
->pixel_width
+= abs (face
->box_line_width
);
18308 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
18309 it
->pixel_width
+= abs (face
->box_line_width
);
18312 take_vertical_position_into_account (it
);
18316 struct glyph
*glyph
;
18317 enum glyph_row_area area
= it
->area
;
18319 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
18320 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
18322 glyph
->charpos
= CHARPOS (it
->position
);
18323 glyph
->object
= it
->object
;
18324 glyph
->pixel_width
= it
->pixel_width
;
18325 glyph
->ascent
= glyph_ascent
;
18326 glyph
->descent
= it
->descent
;
18327 glyph
->voffset
= it
->voffset
;
18328 glyph
->type
= IMAGE_GLYPH
;
18329 glyph
->multibyte_p
= it
->multibyte_p
;
18330 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
18331 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
18332 glyph
->overlaps_vertically_p
= 0;
18333 glyph
->padding_p
= 0;
18334 glyph
->glyph_not_available_p
= 0;
18335 glyph
->face_id
= it
->face_id
;
18336 glyph
->u
.img_id
= img
->id
;
18337 glyph
->slice
= slice
;
18338 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
18339 ++it
->glyph_row
->used
[area
];
18345 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
18346 of the glyph, WIDTH and HEIGHT are the width and height of the
18347 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
18350 append_stretch_glyph (it
, object
, width
, height
, ascent
)
18352 Lisp_Object object
;
18356 struct glyph
*glyph
;
18357 enum glyph_row_area area
= it
->area
;
18359 xassert (ascent
>= 0 && ascent
<= height
);
18361 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
18362 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
18364 glyph
->charpos
= CHARPOS (it
->position
);
18365 glyph
->object
= object
;
18366 glyph
->pixel_width
= width
;
18367 glyph
->ascent
= ascent
;
18368 glyph
->descent
= height
- ascent
;
18369 glyph
->voffset
= it
->voffset
;
18370 glyph
->type
= STRETCH_GLYPH
;
18371 glyph
->multibyte_p
= it
->multibyte_p
;
18372 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
18373 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
18374 glyph
->overlaps_vertically_p
= 0;
18375 glyph
->padding_p
= 0;
18376 glyph
->glyph_not_available_p
= 0;
18377 glyph
->face_id
= it
->face_id
;
18378 glyph
->u
.stretch
.ascent
= ascent
;
18379 glyph
->u
.stretch
.height
= height
;
18380 glyph
->slice
= null_glyph_slice
;
18381 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
18382 ++it
->glyph_row
->used
[area
];
18387 /* Produce a stretch glyph for iterator IT. IT->object is the value
18388 of the glyph property displayed. The value must be a list
18389 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
18392 1. `:width WIDTH' specifies that the space should be WIDTH *
18393 canonical char width wide. WIDTH may be an integer or floating
18396 2. `:relative-width FACTOR' specifies that the width of the stretch
18397 should be computed from the width of the first character having the
18398 `glyph' property, and should be FACTOR times that width.
18400 3. `:align-to HPOS' specifies that the space should be wide enough
18401 to reach HPOS, a value in canonical character units.
18403 Exactly one of the above pairs must be present.
18405 4. `:height HEIGHT' specifies that the height of the stretch produced
18406 should be HEIGHT, measured in canonical character units.
18408 5. `:relative-height FACTOR' specifies that the height of the
18409 stretch should be FACTOR times the height of the characters having
18410 the glyph property.
18412 Either none or exactly one of 4 or 5 must be present.
18414 6. `:ascent ASCENT' specifies that ASCENT percent of the height
18415 of the stretch should be used for the ascent of the stretch.
18416 ASCENT must be in the range 0 <= ASCENT <= 100. */
18419 produce_stretch_glyph (it
)
18422 /* (space :width WIDTH :height HEIGHT ...) */
18423 Lisp_Object prop
, plist
;
18424 int width
= 0, height
= 0, align_to
= -1;
18425 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
18428 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18429 XFontStruct
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
18431 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
18433 /* List should start with `space'. */
18434 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
18435 plist
= XCDR (it
->object
);
18437 /* Compute the width of the stretch. */
18438 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
18439 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
18441 /* Absolute width `:width WIDTH' specified and valid. */
18442 zero_width_ok_p
= 1;
18445 else if (prop
= Fplist_get (plist
, QCrelative_width
),
18448 /* Relative width `:relative-width FACTOR' specified and valid.
18449 Compute the width of the characters having the `glyph'
18452 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
18455 if (it
->multibyte_p
)
18457 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
18458 - IT_BYTEPOS (*it
));
18459 it2
.c
= STRING_CHAR_AND_LENGTH (p
, maxlen
, it2
.len
);
18462 it2
.c
= *p
, it2
.len
= 1;
18464 it2
.glyph_row
= NULL
;
18465 it2
.what
= IT_CHARACTER
;
18466 x_produce_glyphs (&it2
);
18467 width
= NUMVAL (prop
) * it2
.pixel_width
;
18469 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
18470 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
18472 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
18473 align_to
= (align_to
< 0
18475 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
18476 else if (align_to
< 0)
18477 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
18478 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
18479 zero_width_ok_p
= 1;
18482 /* Nothing specified -> width defaults to canonical char width. */
18483 width
= FRAME_COLUMN_WIDTH (it
->f
);
18485 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
18488 /* Compute height. */
18489 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
18490 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
18493 zero_height_ok_p
= 1;
18495 else if (prop
= Fplist_get (plist
, QCrelative_height
),
18497 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
18499 height
= FONT_HEIGHT (font
);
18501 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
18504 /* Compute percentage of height used for ascent. If
18505 `:ascent ASCENT' is present and valid, use that. Otherwise,
18506 derive the ascent from the font in use. */
18507 if (prop
= Fplist_get (plist
, QCascent
),
18508 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
18509 ascent
= height
* NUMVAL (prop
) / 100.0;
18510 else if (!NILP (prop
)
18511 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
18512 ascent
= min (max (0, (int)tem
), height
);
18514 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
18516 if (width
> 0 && height
> 0 && it
->glyph_row
)
18518 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
18519 if (!STRINGP (object
))
18520 object
= it
->w
->buffer
;
18521 append_stretch_glyph (it
, object
, width
, height
, ascent
);
18524 it
->pixel_width
= width
;
18525 it
->ascent
= it
->phys_ascent
= ascent
;
18526 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
18527 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
18529 if (width
> 0 && height
> 0 && face
->box
!= FACE_NO_BOX
)
18531 if (face
->box_line_width
> 0)
18533 it
->ascent
+= face
->box_line_width
;
18534 it
->descent
+= face
->box_line_width
;
18537 if (it
->start_of_box_run_p
)
18538 it
->pixel_width
+= abs (face
->box_line_width
);
18539 if (it
->end_of_box_run_p
)
18540 it
->pixel_width
+= abs (face
->box_line_width
);
18543 take_vertical_position_into_account (it
);
18546 /* Calculate line-height and line-spacing properties.
18547 An integer value specifies explicit pixel value.
18548 A float value specifies relative value to current face height.
18549 A cons (float . face-name) specifies relative value to
18550 height of specified face font.
18552 Returns height in pixels, or nil. */
18555 calc_line_height_property (it
, prop
, font
, boff
, total
)
18561 Lisp_Object position
, val
;
18562 Lisp_Object face_name
= Qnil
;
18563 int ascent
, descent
, height
, override
;
18565 if (STRINGP (it
->object
))
18566 position
= make_number (IT_STRING_CHARPOS (*it
));
18568 position
= make_number (IT_CHARPOS (*it
));
18570 val
= Fget_char_property (position
, prop
, it
->object
);
18575 if (total
&& CONSP (val
) && EQ (XCAR (val
), Qtotal
))
18581 if (INTEGERP (val
))
18586 face_name
= XCDR (val
);
18589 else if (SYMBOLP (val
))
18595 override
= EQ (prop
, Qline_height
);
18597 if (NILP (face_name
))
18599 font
= FRAME_FONT (it
->f
);
18600 boff
= FRAME_BASELINE_OFFSET (it
->f
);
18602 else if (EQ (face_name
, Qt
))
18610 struct font_info
*font_info
;
18612 face_id
= lookup_named_face (it
->f
, face_name
, ' ');
18614 return make_number (-1);
18616 face
= FACE_FROM_ID (it
->f
, face_id
);
18619 return make_number (-1);
18621 font_info
= FONT_INFO_FROM_ID (it
->f
, face
->font_info_id
);
18622 boff
= font_info
->baseline_offset
;
18623 if (font_info
->vertical_centering
)
18624 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
18627 ascent
= FONT_BASE (font
) + boff
;
18628 descent
= FONT_DESCENT (font
) - boff
;
18632 it
->override_ascent
= ascent
;
18633 it
->override_descent
= descent
;
18634 it
->override_boff
= boff
;
18637 height
= ascent
+ descent
;
18639 height
= (int)(XFLOAT_DATA (val
) * height
);
18640 else if (INTEGERP (val
))
18641 height
*= XINT (val
);
18643 return make_number (height
);
18648 Produce glyphs/get display metrics for the display element IT is
18649 loaded with. See the description of struct display_iterator in
18650 dispextern.h for an overview of struct display_iterator. */
18653 x_produce_glyphs (it
)
18656 int extra_line_spacing
= it
->extra_line_spacing
;
18658 it
->glyph_not_available_p
= 0;
18660 if (it
->what
== IT_CHARACTER
)
18664 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18666 int font_not_found_p
;
18667 struct font_info
*font_info
;
18668 int boff
; /* baseline offset */
18669 /* We may change it->multibyte_p upon unibyte<->multibyte
18670 conversion. So, save the current value now and restore it
18673 Note: It seems that we don't have to record multibyte_p in
18674 struct glyph because the character code itself tells if or
18675 not the character is multibyte. Thus, in the future, we must
18676 consider eliminating the field `multibyte_p' in the struct
18678 int saved_multibyte_p
= it
->multibyte_p
;
18680 /* Maybe translate single-byte characters to multibyte, or the
18682 it
->char_to_display
= it
->c
;
18683 if (!ASCII_BYTE_P (it
->c
))
18685 if (unibyte_display_via_language_environment
18686 && SINGLE_BYTE_CHAR_P (it
->c
)
18688 || !NILP (Vnonascii_translation_table
)))
18690 it
->char_to_display
= unibyte_char_to_multibyte (it
->c
);
18691 it
->multibyte_p
= 1;
18692 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
);
18693 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18695 else if (!SINGLE_BYTE_CHAR_P (it
->c
)
18696 && !it
->multibyte_p
)
18698 it
->multibyte_p
= 1;
18699 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
);
18700 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18704 /* Get font to use. Encode IT->char_to_display. */
18705 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
18706 &char2b
, it
->multibyte_p
, 0);
18709 /* When no suitable font found, use the default font. */
18710 font_not_found_p
= font
== NULL
;
18711 if (font_not_found_p
)
18713 font
= FRAME_FONT (it
->f
);
18714 boff
= FRAME_BASELINE_OFFSET (it
->f
);
18719 font_info
= FONT_INFO_FROM_ID (it
->f
, face
->font_info_id
);
18720 boff
= font_info
->baseline_offset
;
18721 if (font_info
->vertical_centering
)
18722 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
18725 if (it
->char_to_display
>= ' '
18726 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
18728 /* Either unibyte or ASCII. */
18733 pcm
= rif
->per_char_metric (font
, &char2b
,
18734 FONT_TYPE_FOR_UNIBYTE (font
, it
->char_to_display
));
18736 if (it
->override_ascent
>= 0)
18738 it
->ascent
= it
->override_ascent
;
18739 it
->descent
= it
->override_descent
;
18740 boff
= it
->override_boff
;
18744 it
->ascent
= FONT_BASE (font
) + boff
;
18745 it
->descent
= FONT_DESCENT (font
) - boff
;
18750 it
->phys_ascent
= pcm
->ascent
+ boff
;
18751 it
->phys_descent
= pcm
->descent
- boff
;
18752 it
->pixel_width
= pcm
->width
;
18756 it
->glyph_not_available_p
= 1;
18757 it
->phys_ascent
= it
->ascent
;
18758 it
->phys_descent
= it
->descent
;
18759 it
->pixel_width
= FONT_WIDTH (font
);
18762 if (it
->constrain_row_ascent_descent_p
)
18764 if (it
->descent
> it
->max_descent
)
18766 it
->ascent
+= it
->descent
- it
->max_descent
;
18767 it
->descent
= it
->max_descent
;
18769 if (it
->ascent
> it
->max_ascent
)
18771 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
18772 it
->ascent
= it
->max_ascent
;
18774 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
18775 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
18776 extra_line_spacing
= 0;
18779 /* If this is a space inside a region of text with
18780 `space-width' property, change its width. */
18781 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
18783 it
->pixel_width
*= XFLOATINT (it
->space_width
);
18785 /* If face has a box, add the box thickness to the character
18786 height. If character has a box line to the left and/or
18787 right, add the box line width to the character's width. */
18788 if (face
->box
!= FACE_NO_BOX
)
18790 int thick
= face
->box_line_width
;
18794 it
->ascent
+= thick
;
18795 it
->descent
+= thick
;
18800 if (it
->start_of_box_run_p
)
18801 it
->pixel_width
+= thick
;
18802 if (it
->end_of_box_run_p
)
18803 it
->pixel_width
+= thick
;
18806 /* If face has an overline, add the height of the overline
18807 (1 pixel) and a 1 pixel margin to the character height. */
18808 if (face
->overline_p
)
18811 if (it
->constrain_row_ascent_descent_p
)
18813 if (it
->ascent
> it
->max_ascent
)
18814 it
->ascent
= it
->max_ascent
;
18815 if (it
->descent
> it
->max_descent
)
18816 it
->descent
= it
->max_descent
;
18819 take_vertical_position_into_account (it
);
18821 /* If we have to actually produce glyphs, do it. */
18826 /* Translate a space with a `space-width' property
18827 into a stretch glyph. */
18828 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
18829 / FONT_HEIGHT (font
));
18830 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
18831 it
->ascent
+ it
->descent
, ascent
);
18836 /* If characters with lbearing or rbearing are displayed
18837 in this line, record that fact in a flag of the
18838 glyph row. This is used to optimize X output code. */
18839 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
18840 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
18843 else if (it
->char_to_display
== '\n')
18845 /* A newline has no width but we need the height of the line.
18846 But if previous part of the line set a height, don't
18847 increase that height */
18849 Lisp_Object height
;
18851 it
->override_ascent
= -1;
18852 it
->pixel_width
= 0;
18855 height
= calc_line_height_property(it
, Qline_height
, font
, boff
, 0);
18857 if (it
->override_ascent
>= 0)
18859 it
->ascent
= it
->override_ascent
;
18860 it
->descent
= it
->override_descent
;
18861 boff
= it
->override_boff
;
18865 it
->ascent
= FONT_BASE (font
) + boff
;
18866 it
->descent
= FONT_DESCENT (font
) - boff
;
18869 if (EQ (height
, make_number(0)))
18871 if (it
->descent
> it
->max_descent
)
18873 it
->ascent
+= it
->descent
- it
->max_descent
;
18874 it
->descent
= it
->max_descent
;
18876 if (it
->ascent
> it
->max_ascent
)
18878 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
18879 it
->ascent
= it
->max_ascent
;
18881 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
18882 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
18883 it
->constrain_row_ascent_descent_p
= 1;
18884 extra_line_spacing
= 0;
18888 Lisp_Object spacing
;
18891 it
->phys_ascent
= it
->ascent
;
18892 it
->phys_descent
= it
->descent
;
18894 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
18895 && face
->box
!= FACE_NO_BOX
18896 && face
->box_line_width
> 0)
18898 it
->ascent
+= face
->box_line_width
;
18899 it
->descent
+= face
->box_line_width
;
18902 && XINT (height
) > it
->ascent
+ it
->descent
)
18903 it
->ascent
= XINT (height
) - it
->descent
;
18905 spacing
= calc_line_height_property(it
, Qline_spacing
, font
, boff
, &total
);
18906 if (INTEGERP (spacing
))
18908 extra_line_spacing
= XINT (spacing
);
18910 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
18914 else if (it
->char_to_display
== '\t')
18916 int tab_width
= it
->tab_width
* FRAME_COLUMN_WIDTH (it
->f
);
18917 int x
= it
->current_x
+ it
->continuation_lines_width
;
18918 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
18920 /* If the distance from the current position to the next tab
18921 stop is less than a canonical character width, use the
18922 tab stop after that. */
18923 if (next_tab_x
- x
< FRAME_COLUMN_WIDTH (it
->f
))
18924 next_tab_x
+= tab_width
;
18926 it
->pixel_width
= next_tab_x
- x
;
18928 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
18929 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
18933 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
18934 it
->ascent
+ it
->descent
, it
->ascent
);
18939 /* A multi-byte character. Assume that the display width of the
18940 character is the width of the character multiplied by the
18941 width of the font. */
18943 /* If we found a font, this font should give us the right
18944 metrics. If we didn't find a font, use the frame's
18945 default font and calculate the width of the character
18946 from the charset width; this is what old redisplay code
18949 pcm
= rif
->per_char_metric (font
, &char2b
,
18950 FONT_TYPE_FOR_MULTIBYTE (font
, it
->c
));
18952 if (font_not_found_p
|| !pcm
)
18954 int charset
= CHAR_CHARSET (it
->char_to_display
);
18956 it
->glyph_not_available_p
= 1;
18957 it
->pixel_width
= (FRAME_COLUMN_WIDTH (it
->f
)
18958 * CHARSET_WIDTH (charset
));
18959 it
->phys_ascent
= FONT_BASE (font
) + boff
;
18960 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
18964 it
->pixel_width
= pcm
->width
;
18965 it
->phys_ascent
= pcm
->ascent
+ boff
;
18966 it
->phys_descent
= pcm
->descent
- boff
;
18968 && (pcm
->lbearing
< 0
18969 || pcm
->rbearing
> pcm
->width
))
18970 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
18973 it
->ascent
= FONT_BASE (font
) + boff
;
18974 it
->descent
= FONT_DESCENT (font
) - boff
;
18975 if (face
->box
!= FACE_NO_BOX
)
18977 int thick
= face
->box_line_width
;
18981 it
->ascent
+= thick
;
18982 it
->descent
+= thick
;
18987 if (it
->start_of_box_run_p
)
18988 it
->pixel_width
+= thick
;
18989 if (it
->end_of_box_run_p
)
18990 it
->pixel_width
+= thick
;
18993 /* If face has an overline, add the height of the overline
18994 (1 pixel) and a 1 pixel margin to the character height. */
18995 if (face
->overline_p
)
18998 take_vertical_position_into_account (it
);
19003 it
->multibyte_p
= saved_multibyte_p
;
19005 else if (it
->what
== IT_COMPOSITION
)
19007 /* Note: A composition is represented as one glyph in the
19008 glyph matrix. There are no padding glyphs. */
19011 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19013 int font_not_found_p
;
19014 struct font_info
*font_info
;
19015 int boff
; /* baseline offset */
19016 struct composition
*cmp
= composition_table
[it
->cmp_id
];
19018 /* Maybe translate single-byte characters to multibyte. */
19019 it
->char_to_display
= it
->c
;
19020 if (unibyte_display_via_language_environment
19021 && SINGLE_BYTE_CHAR_P (it
->c
)
19024 && !NILP (Vnonascii_translation_table
))))
19026 it
->char_to_display
= unibyte_char_to_multibyte (it
->c
);
19029 /* Get face and font to use. Encode IT->char_to_display. */
19030 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
);
19031 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19032 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
19033 &char2b
, it
->multibyte_p
, 0);
19036 /* When no suitable font found, use the default font. */
19037 font_not_found_p
= font
== NULL
;
19038 if (font_not_found_p
)
19040 font
= FRAME_FONT (it
->f
);
19041 boff
= FRAME_BASELINE_OFFSET (it
->f
);
19046 font_info
= FONT_INFO_FROM_ID (it
->f
, face
->font_info_id
);
19047 boff
= font_info
->baseline_offset
;
19048 if (font_info
->vertical_centering
)
19049 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
19052 /* There are no padding glyphs, so there is only one glyph to
19053 produce for the composition. Important is that pixel_width,
19054 ascent and descent are the values of what is drawn by
19055 draw_glyphs (i.e. the values of the overall glyphs composed). */
19058 /* If we have not yet calculated pixel size data of glyphs of
19059 the composition for the current face font, calculate them
19060 now. Theoretically, we have to check all fonts for the
19061 glyphs, but that requires much time and memory space. So,
19062 here we check only the font of the first glyph. This leads
19063 to incorrect display very rarely, and C-l (recenter) can
19064 correct the display anyway. */
19065 if (cmp
->font
!= (void *) font
)
19067 /* Ascent and descent of the font of the first character of
19068 this composition (adjusted by baseline offset). Ascent
19069 and descent of overall glyphs should not be less than
19070 them respectively. */
19071 int font_ascent
= FONT_BASE (font
) + boff
;
19072 int font_descent
= FONT_DESCENT (font
) - boff
;
19073 /* Bounding box of the overall glyphs. */
19074 int leftmost
, rightmost
, lowest
, highest
;
19075 int i
, width
, ascent
, descent
;
19077 cmp
->font
= (void *) font
;
19079 /* Initialize the bounding box. */
19081 && (pcm
= rif
->per_char_metric (font
, &char2b
,
19082 FONT_TYPE_FOR_MULTIBYTE (font
, it
->c
))))
19084 width
= pcm
->width
;
19085 ascent
= pcm
->ascent
;
19086 descent
= pcm
->descent
;
19090 width
= FONT_WIDTH (font
);
19091 ascent
= FONT_BASE (font
);
19092 descent
= FONT_DESCENT (font
);
19096 lowest
= - descent
+ boff
;
19097 highest
= ascent
+ boff
;
19101 && font_info
->default_ascent
19102 && CHAR_TABLE_P (Vuse_default_ascent
)
19103 && !NILP (Faref (Vuse_default_ascent
,
19104 make_number (it
->char_to_display
))))
19105 highest
= font_info
->default_ascent
+ boff
;
19107 /* Draw the first glyph at the normal position. It may be
19108 shifted to right later if some other glyphs are drawn at
19110 cmp
->offsets
[0] = 0;
19111 cmp
->offsets
[1] = boff
;
19113 /* Set cmp->offsets for the remaining glyphs. */
19114 for (i
= 1; i
< cmp
->glyph_len
; i
++)
19116 int left
, right
, btm
, top
;
19117 int ch
= COMPOSITION_GLYPH (cmp
, i
);
19118 int face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
);
19120 face
= FACE_FROM_ID (it
->f
, face_id
);
19121 get_char_face_and_encoding (it
->f
, ch
, face
->id
,
19122 &char2b
, it
->multibyte_p
, 0);
19126 font
= FRAME_FONT (it
->f
);
19127 boff
= FRAME_BASELINE_OFFSET (it
->f
);
19133 = FONT_INFO_FROM_ID (it
->f
, face
->font_info_id
);
19134 boff
= font_info
->baseline_offset
;
19135 if (font_info
->vertical_centering
)
19136 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
19140 && (pcm
= rif
->per_char_metric (font
, &char2b
,
19141 FONT_TYPE_FOR_MULTIBYTE (font
, ch
))))
19143 width
= pcm
->width
;
19144 ascent
= pcm
->ascent
;
19145 descent
= pcm
->descent
;
19149 width
= FONT_WIDTH (font
);
19154 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
19156 /* Relative composition with or without
19157 alternate chars. */
19158 left
= (leftmost
+ rightmost
- width
) / 2;
19159 btm
= - descent
+ boff
;
19160 if (font_info
&& font_info
->relative_compose
19161 && (! CHAR_TABLE_P (Vignore_relative_composition
)
19162 || NILP (Faref (Vignore_relative_composition
,
19163 make_number (ch
)))))
19166 if (- descent
>= font_info
->relative_compose
)
19167 /* One extra pixel between two glyphs. */
19169 else if (ascent
<= 0)
19170 /* One extra pixel between two glyphs. */
19171 btm
= lowest
- 1 - ascent
- descent
;
19176 /* A composition rule is specified by an integer
19177 value that encodes global and new reference
19178 points (GREF and NREF). GREF and NREF are
19179 specified by numbers as below:
19181 0---1---2 -- ascent
19185 9--10--11 -- center
19187 ---3---4---5--- baseline
19189 6---7---8 -- descent
19191 int rule
= COMPOSITION_RULE (cmp
, i
);
19192 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
;
19194 COMPOSITION_DECODE_RULE (rule
, gref
, nref
);
19195 grefx
= gref
% 3, nrefx
= nref
% 3;
19196 grefy
= gref
/ 3, nrefy
= nref
/ 3;
19199 + grefx
* (rightmost
- leftmost
) / 2
19200 - nrefx
* width
/ 2);
19201 btm
= ((grefy
== 0 ? highest
19203 : grefy
== 2 ? lowest
19204 : (highest
+ lowest
) / 2)
19205 - (nrefy
== 0 ? ascent
+ descent
19206 : nrefy
== 1 ? descent
- boff
19208 : (ascent
+ descent
) / 2));
19211 cmp
->offsets
[i
* 2] = left
;
19212 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
19214 /* Update the bounding box of the overall glyphs. */
19215 right
= left
+ width
;
19216 top
= btm
+ descent
+ ascent
;
19217 if (left
< leftmost
)
19219 if (right
> rightmost
)
19227 /* If there are glyphs whose x-offsets are negative,
19228 shift all glyphs to the right and make all x-offsets
19232 for (i
= 0; i
< cmp
->glyph_len
; i
++)
19233 cmp
->offsets
[i
* 2] -= leftmost
;
19234 rightmost
-= leftmost
;
19237 cmp
->pixel_width
= rightmost
;
19238 cmp
->ascent
= highest
;
19239 cmp
->descent
= - lowest
;
19240 if (cmp
->ascent
< font_ascent
)
19241 cmp
->ascent
= font_ascent
;
19242 if (cmp
->descent
< font_descent
)
19243 cmp
->descent
= font_descent
;
19246 it
->pixel_width
= cmp
->pixel_width
;
19247 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
19248 it
->descent
= it
->phys_descent
= cmp
->descent
;
19250 if (face
->box
!= FACE_NO_BOX
)
19252 int thick
= face
->box_line_width
;
19256 it
->ascent
+= thick
;
19257 it
->descent
+= thick
;
19262 if (it
->start_of_box_run_p
)
19263 it
->pixel_width
+= thick
;
19264 if (it
->end_of_box_run_p
)
19265 it
->pixel_width
+= thick
;
19268 /* If face has an overline, add the height of the overline
19269 (1 pixel) and a 1 pixel margin to the character height. */
19270 if (face
->overline_p
)
19273 take_vertical_position_into_account (it
);
19276 append_composite_glyph (it
);
19278 else if (it
->what
== IT_IMAGE
)
19279 produce_image_glyph (it
);
19280 else if (it
->what
== IT_STRETCH
)
19281 produce_stretch_glyph (it
);
19283 /* Accumulate dimensions. Note: can't assume that it->descent > 0
19284 because this isn't true for images with `:ascent 100'. */
19285 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
19286 if (it
->area
== TEXT_AREA
)
19287 it
->current_x
+= it
->pixel_width
;
19289 if (extra_line_spacing
> 0)
19290 it
->descent
+= extra_line_spacing
;
19292 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
19293 it
->max_descent
= max (it
->max_descent
, it
->descent
);
19294 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
19295 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
19299 Output LEN glyphs starting at START at the nominal cursor position.
19300 Advance the nominal cursor over the text. The global variable
19301 updated_window contains the window being updated, updated_row is
19302 the glyph row being updated, and updated_area is the area of that
19303 row being updated. */
19306 x_write_glyphs (start
, len
)
19307 struct glyph
*start
;
19312 xassert (updated_window
&& updated_row
);
19315 /* Write glyphs. */
19317 hpos
= start
- updated_row
->glyphs
[updated_area
];
19318 x
= draw_glyphs (updated_window
, output_cursor
.x
,
19319 updated_row
, updated_area
,
19321 DRAW_NORMAL_TEXT
, 0);
19323 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
19324 if (updated_area
== TEXT_AREA
19325 && updated_window
->phys_cursor_on_p
19326 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
19327 && updated_window
->phys_cursor
.hpos
>= hpos
19328 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
19329 updated_window
->phys_cursor_on_p
= 0;
19333 /* Advance the output cursor. */
19334 output_cursor
.hpos
+= len
;
19335 output_cursor
.x
= x
;
19340 Insert LEN glyphs from START at the nominal cursor position. */
19343 x_insert_glyphs (start
, len
)
19344 struct glyph
*start
;
19349 int line_height
, shift_by_width
, shifted_region_width
;
19350 struct glyph_row
*row
;
19351 struct glyph
*glyph
;
19352 int frame_x
, frame_y
, hpos
;
19354 xassert (updated_window
&& updated_row
);
19356 w
= updated_window
;
19357 f
= XFRAME (WINDOW_FRAME (w
));
19359 /* Get the height of the line we are in. */
19361 line_height
= row
->height
;
19363 /* Get the width of the glyphs to insert. */
19364 shift_by_width
= 0;
19365 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
19366 shift_by_width
+= glyph
->pixel_width
;
19368 /* Get the width of the region to shift right. */
19369 shifted_region_width
= (window_box_width (w
, updated_area
)
19374 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
19375 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
19377 rif
->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
19378 line_height
, shift_by_width
);
19380 /* Write the glyphs. */
19381 hpos
= start
- row
->glyphs
[updated_area
];
19382 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
19384 DRAW_NORMAL_TEXT
, 0);
19386 /* Advance the output cursor. */
19387 output_cursor
.hpos
+= len
;
19388 output_cursor
.x
+= shift_by_width
;
19394 Erase the current text line from the nominal cursor position
19395 (inclusive) to pixel column TO_X (exclusive). The idea is that
19396 everything from TO_X onward is already erased.
19398 TO_X is a pixel position relative to updated_area of
19399 updated_window. TO_X == -1 means clear to the end of this area. */
19402 x_clear_end_of_line (to_x
)
19406 struct window
*w
= updated_window
;
19407 int max_x
, min_y
, max_y
;
19408 int from_x
, from_y
, to_y
;
19410 xassert (updated_window
&& updated_row
);
19411 f
= XFRAME (w
->frame
);
19413 if (updated_row
->full_width_p
)
19414 max_x
= WINDOW_TOTAL_WIDTH (w
);
19416 max_x
= window_box_width (w
, updated_area
);
19417 max_y
= window_text_bottom_y (w
);
19419 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
19420 of window. For TO_X > 0, truncate to end of drawing area. */
19426 to_x
= min (to_x
, max_x
);
19428 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
19430 /* Notice if the cursor will be cleared by this operation. */
19431 if (!updated_row
->full_width_p
)
19432 notice_overwritten_cursor (w
, updated_area
,
19433 output_cursor
.x
, -1,
19435 MATRIX_ROW_BOTTOM_Y (updated_row
));
19437 from_x
= output_cursor
.x
;
19439 /* Translate to frame coordinates. */
19440 if (updated_row
->full_width_p
)
19442 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
19443 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
19447 int area_left
= window_box_left (w
, updated_area
);
19448 from_x
+= area_left
;
19452 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
19453 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
19454 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
19456 /* Prevent inadvertently clearing to end of the X window. */
19457 if (to_x
> from_x
&& to_y
> from_y
)
19460 rif
->clear_frame_area (f
, from_x
, from_y
,
19461 to_x
- from_x
, to_y
- from_y
);
19466 #endif /* HAVE_WINDOW_SYSTEM */
19470 /***********************************************************************
19472 ***********************************************************************/
19474 /* Value is the internal representation of the specified cursor type
19475 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
19476 of the bar cursor. */
19478 static enum text_cursor_kinds
19479 get_specified_cursor_type (arg
, width
)
19483 enum text_cursor_kinds type
;
19488 if (EQ (arg
, Qbox
))
19489 return FILLED_BOX_CURSOR
;
19491 if (EQ (arg
, Qhollow
))
19492 return HOLLOW_BOX_CURSOR
;
19494 if (EQ (arg
, Qbar
))
19501 && EQ (XCAR (arg
), Qbar
)
19502 && INTEGERP (XCDR (arg
))
19503 && XINT (XCDR (arg
)) >= 0)
19505 *width
= XINT (XCDR (arg
));
19509 if (EQ (arg
, Qhbar
))
19512 return HBAR_CURSOR
;
19516 && EQ (XCAR (arg
), Qhbar
)
19517 && INTEGERP (XCDR (arg
))
19518 && XINT (XCDR (arg
)) >= 0)
19520 *width
= XINT (XCDR (arg
));
19521 return HBAR_CURSOR
;
19524 /* Treat anything unknown as "hollow box cursor".
19525 It was bad to signal an error; people have trouble fixing
19526 .Xdefaults with Emacs, when it has something bad in it. */
19527 type
= HOLLOW_BOX_CURSOR
;
19532 /* Set the default cursor types for specified frame. */
19534 set_frame_cursor_types (f
, arg
)
19541 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
19542 FRAME_CURSOR_WIDTH (f
) = width
;
19544 /* By default, set up the blink-off state depending on the on-state. */
19546 tem
= Fassoc (arg
, Vblink_cursor_alist
);
19549 FRAME_BLINK_OFF_CURSOR (f
)
19550 = get_specified_cursor_type (XCDR (tem
), &width
);
19551 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
19554 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
19558 /* Return the cursor we want to be displayed in window W. Return
19559 width of bar/hbar cursor through WIDTH arg. Return with
19560 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
19561 (i.e. if the `system caret' should track this cursor).
19563 In a mini-buffer window, we want the cursor only to appear if we
19564 are reading input from this window. For the selected window, we
19565 want the cursor type given by the frame parameter or buffer local
19566 setting of cursor-type. If explicitly marked off, draw no cursor.
19567 In all other cases, we want a hollow box cursor. */
19569 static enum text_cursor_kinds
19570 get_window_cursor_type (w
, glyph
, width
, active_cursor
)
19572 struct glyph
*glyph
;
19574 int *active_cursor
;
19576 struct frame
*f
= XFRAME (w
->frame
);
19577 struct buffer
*b
= XBUFFER (w
->buffer
);
19578 int cursor_type
= DEFAULT_CURSOR
;
19579 Lisp_Object alt_cursor
;
19580 int non_selected
= 0;
19582 *active_cursor
= 1;
19585 if (cursor_in_echo_area
19586 && FRAME_HAS_MINIBUF_P (f
)
19587 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
19589 if (w
== XWINDOW (echo_area_window
))
19591 *width
= FRAME_CURSOR_WIDTH (f
);
19592 return FRAME_DESIRED_CURSOR (f
);
19595 *active_cursor
= 0;
19599 /* Nonselected window or nonselected frame. */
19600 else if (w
!= XWINDOW (f
->selected_window
)
19601 #ifdef HAVE_WINDOW_SYSTEM
19602 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
19606 *active_cursor
= 0;
19608 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
19614 /* Never display a cursor in a window in which cursor-type is nil. */
19615 if (NILP (b
->cursor_type
))
19618 /* Use cursor-in-non-selected-windows for non-selected window or frame. */
19621 alt_cursor
= Fbuffer_local_value (Qcursor_in_non_selected_windows
, w
->buffer
);
19622 return get_specified_cursor_type (alt_cursor
, width
);
19625 /* Get the normal cursor type for this window. */
19626 if (EQ (b
->cursor_type
, Qt
))
19628 cursor_type
= FRAME_DESIRED_CURSOR (f
);
19629 *width
= FRAME_CURSOR_WIDTH (f
);
19632 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
19634 /* Use normal cursor if not blinked off. */
19635 if (!w
->cursor_off_p
)
19637 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
) {
19638 if (cursor_type
== FILLED_BOX_CURSOR
)
19639 cursor_type
= HOLLOW_BOX_CURSOR
;
19641 return cursor_type
;
19644 /* Cursor is blinked off, so determine how to "toggle" it. */
19646 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
19647 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
19648 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
19650 /* Then see if frame has specified a specific blink off cursor type. */
19651 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
19653 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
19654 return FRAME_BLINK_OFF_CURSOR (f
);
19658 /* Some people liked having a permanently visible blinking cursor,
19659 while others had very strong opinions against it. So it was
19660 decided to remove it. KFS 2003-09-03 */
19662 /* Finally perform built-in cursor blinking:
19663 filled box <-> hollow box
19664 wide [h]bar <-> narrow [h]bar
19665 narrow [h]bar <-> no cursor
19666 other type <-> no cursor */
19668 if (cursor_type
== FILLED_BOX_CURSOR
)
19669 return HOLLOW_BOX_CURSOR
;
19671 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
19674 return cursor_type
;
19682 #ifdef HAVE_WINDOW_SYSTEM
19684 /* Notice when the text cursor of window W has been completely
19685 overwritten by a drawing operation that outputs glyphs in AREA
19686 starting at X0 and ending at X1 in the line starting at Y0 and
19687 ending at Y1. X coordinates are area-relative. X1 < 0 means all
19688 the rest of the line after X0 has been written. Y coordinates
19689 are window-relative. */
19692 notice_overwritten_cursor (w
, area
, x0
, x1
, y0
, y1
)
19694 enum glyph_row_area area
;
19695 int x0
, y0
, x1
, y1
;
19697 int cx0
, cx1
, cy0
, cy1
;
19698 struct glyph_row
*row
;
19700 if (!w
->phys_cursor_on_p
)
19702 if (area
!= TEXT_AREA
)
19705 row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
;
19706 if (!row
->displays_text_p
)
19709 if (row
->cursor_in_fringe_p
)
19711 row
->cursor_in_fringe_p
= 0;
19712 draw_fringe_bitmap (w
, row
, 0);
19713 w
->phys_cursor_on_p
= 0;
19717 cx0
= w
->phys_cursor
.x
;
19718 cx1
= cx0
+ w
->phys_cursor_width
;
19719 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
19722 /* The cursor image will be completely removed from the
19723 screen if the output area intersects the cursor area in
19724 y-direction. When we draw in [y0 y1[, and some part of
19725 the cursor is at y < y0, that part must have been drawn
19726 before. When scrolling, the cursor is erased before
19727 actually scrolling, so we don't come here. When not
19728 scrolling, the rows above the old cursor row must have
19729 changed, and in this case these rows must have written
19730 over the cursor image.
19732 Likewise if part of the cursor is below y1, with the
19733 exception of the cursor being in the first blank row at
19734 the buffer and window end because update_text_area
19735 doesn't draw that row. (Except when it does, but
19736 that's handled in update_text_area.) */
19738 cy0
= w
->phys_cursor
.y
;
19739 cy1
= cy0
+ w
->phys_cursor_height
;
19740 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
19743 w
->phys_cursor_on_p
= 0;
19746 #endif /* HAVE_WINDOW_SYSTEM */
19749 /************************************************************************
19751 ************************************************************************/
19753 #ifdef HAVE_WINDOW_SYSTEM
19756 Fix the display of area AREA of overlapping row ROW in window W. */
19759 x_fix_overlapping_area (w
, row
, area
)
19761 struct glyph_row
*row
;
19762 enum glyph_row_area area
;
19769 for (i
= 0; i
< row
->used
[area
];)
19771 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
19773 int start
= i
, start_x
= x
;
19777 x
+= row
->glyphs
[area
][i
].pixel_width
;
19780 while (i
< row
->used
[area
]
19781 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
19783 draw_glyphs (w
, start_x
, row
, area
,
19785 DRAW_NORMAL_TEXT
, 1);
19789 x
+= row
->glyphs
[area
][i
].pixel_width
;
19799 Draw the cursor glyph of window W in glyph row ROW. See the
19800 comment of draw_glyphs for the meaning of HL. */
19803 draw_phys_cursor_glyph (w
, row
, hl
)
19805 struct glyph_row
*row
;
19806 enum draw_glyphs_face hl
;
19808 /* If cursor hpos is out of bounds, don't draw garbage. This can
19809 happen in mini-buffer windows when switching between echo area
19810 glyphs and mini-buffer. */
19811 if (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])
19813 int on_p
= w
->phys_cursor_on_p
;
19815 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
19816 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
19818 w
->phys_cursor_on_p
= on_p
;
19820 if (hl
== DRAW_CURSOR
)
19821 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
19822 /* When we erase the cursor, and ROW is overlapped by other
19823 rows, make sure that these overlapping parts of other rows
19825 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
19827 if (row
> w
->current_matrix
->rows
19828 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
19829 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
);
19831 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
19832 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
19833 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
);
19840 Erase the image of a cursor of window W from the screen. */
19843 erase_phys_cursor (w
)
19846 struct frame
*f
= XFRAME (w
->frame
);
19847 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
19848 int hpos
= w
->phys_cursor
.hpos
;
19849 int vpos
= w
->phys_cursor
.vpos
;
19850 int mouse_face_here_p
= 0;
19851 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
19852 struct glyph_row
*cursor_row
;
19853 struct glyph
*cursor_glyph
;
19854 enum draw_glyphs_face hl
;
19856 /* No cursor displayed or row invalidated => nothing to do on the
19858 if (w
->phys_cursor_type
== NO_CURSOR
)
19859 goto mark_cursor_off
;
19861 /* VPOS >= active_glyphs->nrows means that window has been resized.
19862 Don't bother to erase the cursor. */
19863 if (vpos
>= active_glyphs
->nrows
)
19864 goto mark_cursor_off
;
19866 /* If row containing cursor is marked invalid, there is nothing we
19868 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
19869 if (!cursor_row
->enabled_p
)
19870 goto mark_cursor_off
;
19872 /* If row is completely invisible, don't attempt to delete a cursor which
19873 isn't there. This can happen if cursor is at top of a window, and
19874 we switch to a buffer with a header line in that window. */
19875 if (cursor_row
->visible_height
<= 0)
19876 goto mark_cursor_off
;
19878 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
19879 if (cursor_row
->cursor_in_fringe_p
)
19881 cursor_row
->cursor_in_fringe_p
= 0;
19882 draw_fringe_bitmap (w
, cursor_row
, 0);
19883 goto mark_cursor_off
;
19886 /* This can happen when the new row is shorter than the old one.
19887 In this case, either draw_glyphs or clear_end_of_line
19888 should have cleared the cursor. Note that we wouldn't be
19889 able to erase the cursor in this case because we don't have a
19890 cursor glyph at hand. */
19891 if (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])
19892 goto mark_cursor_off
;
19894 /* If the cursor is in the mouse face area, redisplay that when
19895 we clear the cursor. */
19896 if (! NILP (dpyinfo
->mouse_face_window
)
19897 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
19898 && (vpos
> dpyinfo
->mouse_face_beg_row
19899 || (vpos
== dpyinfo
->mouse_face_beg_row
19900 && hpos
>= dpyinfo
->mouse_face_beg_col
))
19901 && (vpos
< dpyinfo
->mouse_face_end_row
19902 || (vpos
== dpyinfo
->mouse_face_end_row
19903 && hpos
< dpyinfo
->mouse_face_end_col
))
19904 /* Don't redraw the cursor's spot in mouse face if it is at the
19905 end of a line (on a newline). The cursor appears there, but
19906 mouse highlighting does not. */
19907 && cursor_row
->used
[TEXT_AREA
] > hpos
)
19908 mouse_face_here_p
= 1;
19910 /* Maybe clear the display under the cursor. */
19911 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
19914 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
19916 cursor_glyph
= get_phys_cursor_glyph (w
);
19917 if (cursor_glyph
== NULL
)
19918 goto mark_cursor_off
;
19920 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, w
->phys_cursor
.x
);
19921 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
19923 rif
->clear_frame_area (f
, x
, y
,
19924 cursor_glyph
->pixel_width
, cursor_row
->visible_height
);
19927 /* Erase the cursor by redrawing the character underneath it. */
19928 if (mouse_face_here_p
)
19929 hl
= DRAW_MOUSE_FACE
;
19931 hl
= DRAW_NORMAL_TEXT
;
19932 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
19935 w
->phys_cursor_on_p
= 0;
19936 w
->phys_cursor_type
= NO_CURSOR
;
19941 Display or clear cursor of window W. If ON is zero, clear the
19942 cursor. If it is non-zero, display the cursor. If ON is nonzero,
19943 where to put the cursor is specified by HPOS, VPOS, X and Y. */
19946 display_and_set_cursor (w
, on
, hpos
, vpos
, x
, y
)
19948 int on
, hpos
, vpos
, x
, y
;
19950 struct frame
*f
= XFRAME (w
->frame
);
19951 int new_cursor_type
;
19952 int new_cursor_width
;
19954 struct glyph_row
*glyph_row
;
19955 struct glyph
*glyph
;
19957 /* This is pointless on invisible frames, and dangerous on garbaged
19958 windows and frames; in the latter case, the frame or window may
19959 be in the midst of changing its size, and x and y may be off the
19961 if (! FRAME_VISIBLE_P (f
)
19962 || FRAME_GARBAGED_P (f
)
19963 || vpos
>= w
->current_matrix
->nrows
19964 || hpos
>= w
->current_matrix
->matrix_w
)
19967 /* If cursor is off and we want it off, return quickly. */
19968 if (!on
&& !w
->phys_cursor_on_p
)
19971 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
19972 /* If cursor row is not enabled, we don't really know where to
19973 display the cursor. */
19974 if (!glyph_row
->enabled_p
)
19976 w
->phys_cursor_on_p
= 0;
19981 if (!glyph_row
->exact_window_width_line_p
19982 || hpos
< glyph_row
->used
[TEXT_AREA
])
19983 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
19985 xassert (interrupt_input_blocked
);
19987 /* Set new_cursor_type to the cursor we want to be displayed. */
19988 new_cursor_type
= get_window_cursor_type (w
, glyph
,
19989 &new_cursor_width
, &active_cursor
);
19991 /* If cursor is currently being shown and we don't want it to be or
19992 it is in the wrong place, or the cursor type is not what we want,
19994 if (w
->phys_cursor_on_p
19996 || w
->phys_cursor
.x
!= x
19997 || w
->phys_cursor
.y
!= y
19998 || new_cursor_type
!= w
->phys_cursor_type
19999 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
20000 && new_cursor_width
!= w
->phys_cursor_width
)))
20001 erase_phys_cursor (w
);
20003 /* Don't check phys_cursor_on_p here because that flag is only set
20004 to zero in some cases where we know that the cursor has been
20005 completely erased, to avoid the extra work of erasing the cursor
20006 twice. In other words, phys_cursor_on_p can be 1 and the cursor
20007 still not be visible, or it has only been partly erased. */
20010 w
->phys_cursor_ascent
= glyph_row
->ascent
;
20011 w
->phys_cursor_height
= glyph_row
->height
;
20013 /* Set phys_cursor_.* before x_draw_.* is called because some
20014 of them may need the information. */
20015 w
->phys_cursor
.x
= x
;
20016 w
->phys_cursor
.y
= glyph_row
->y
;
20017 w
->phys_cursor
.hpos
= hpos
;
20018 w
->phys_cursor
.vpos
= vpos
;
20021 rif
->draw_window_cursor (w
, glyph_row
, x
, y
,
20022 new_cursor_type
, new_cursor_width
,
20023 on
, active_cursor
);
20027 /* Switch the display of W's cursor on or off, according to the value
20031 update_window_cursor (w
, on
)
20035 /* Don't update cursor in windows whose frame is in the process
20036 of being deleted. */
20037 if (w
->current_matrix
)
20040 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
20041 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
20047 /* Call update_window_cursor with parameter ON_P on all leaf windows
20048 in the window tree rooted at W. */
20051 update_cursor_in_window_tree (w
, on_p
)
20057 if (!NILP (w
->hchild
))
20058 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
20059 else if (!NILP (w
->vchild
))
20060 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
20062 update_window_cursor (w
, on_p
);
20064 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
20070 Display the cursor on window W, or clear it, according to ON_P.
20071 Don't change the cursor's position. */
20074 x_update_cursor (f
, on_p
)
20078 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
20083 Clear the cursor of window W to background color, and mark the
20084 cursor as not shown. This is used when the text where the cursor
20085 is is about to be rewritten. */
20091 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
20092 update_window_cursor (w
, 0);
20097 Display the active region described by mouse_face_* according to DRAW. */
20100 show_mouse_face (dpyinfo
, draw
)
20101 Display_Info
*dpyinfo
;
20102 enum draw_glyphs_face draw
;
20104 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
20105 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20107 if (/* If window is in the process of being destroyed, don't bother
20109 w
->current_matrix
!= NULL
20110 /* Don't update mouse highlight if hidden */
20111 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
20112 /* Recognize when we are called to operate on rows that don't exist
20113 anymore. This can happen when a window is split. */
20114 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
20116 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
20117 struct glyph_row
*row
, *first
, *last
;
20119 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
20120 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
20122 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
20124 int start_hpos
, end_hpos
, start_x
;
20126 /* For all but the first row, the highlight starts at column 0. */
20129 start_hpos
= dpyinfo
->mouse_face_beg_col
;
20130 start_x
= dpyinfo
->mouse_face_beg_x
;
20139 end_hpos
= dpyinfo
->mouse_face_end_col
;
20141 end_hpos
= row
->used
[TEXT_AREA
];
20143 if (end_hpos
> start_hpos
)
20145 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
20146 start_hpos
, end_hpos
,
20150 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
20154 /* When we've written over the cursor, arrange for it to
20155 be displayed again. */
20156 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
20159 display_and_set_cursor (w
, 1,
20160 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
20161 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
20166 /* Change the mouse cursor. */
20167 if (draw
== DRAW_NORMAL_TEXT
)
20168 rif
->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
20169 else if (draw
== DRAW_MOUSE_FACE
)
20170 rif
->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
20172 rif
->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
20176 Clear out the mouse-highlighted active region.
20177 Redraw it un-highlighted first. Value is non-zero if mouse
20178 face was actually drawn unhighlighted. */
20181 clear_mouse_face (dpyinfo
)
20182 Display_Info
*dpyinfo
;
20186 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
20188 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
20192 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
20193 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
20194 dpyinfo
->mouse_face_window
= Qnil
;
20195 dpyinfo
->mouse_face_overlay
= Qnil
;
20201 Non-zero if physical cursor of window W is within mouse face. */
20204 cursor_in_mouse_face_p (w
)
20207 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
20208 int in_mouse_face
= 0;
20210 if (WINDOWP (dpyinfo
->mouse_face_window
)
20211 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
20213 int hpos
= w
->phys_cursor
.hpos
;
20214 int vpos
= w
->phys_cursor
.vpos
;
20216 if (vpos
>= dpyinfo
->mouse_face_beg_row
20217 && vpos
<= dpyinfo
->mouse_face_end_row
20218 && (vpos
> dpyinfo
->mouse_face_beg_row
20219 || hpos
>= dpyinfo
->mouse_face_beg_col
)
20220 && (vpos
< dpyinfo
->mouse_face_end_row
20221 || hpos
< dpyinfo
->mouse_face_end_col
20222 || dpyinfo
->mouse_face_past_end
))
20226 return in_mouse_face
;
20232 /* Find the glyph matrix position of buffer position CHARPOS in window
20233 *W. HPOS, *VPOS, *X, and *Y are set to the positions found. W's
20234 current glyphs must be up to date. If CHARPOS is above window
20235 start return (0, 0, 0, 0). If CHARPOS is after end of W, return end
20236 of last line in W. In the row containing CHARPOS, stop before glyphs
20237 having STOP as object. */
20239 #if 1 /* This is a version of fast_find_position that's more correct
20240 in the presence of hscrolling, for example. I didn't install
20241 it right away because the problem fixed is minor, it failed
20242 in 20.x as well, and I think it's too risky to install
20243 so near the release of 21.1. 2001-09-25 gerd. */
20246 fast_find_position (w
, charpos
, hpos
, vpos
, x
, y
, stop
)
20249 int *hpos
, *vpos
, *x
, *y
;
20252 struct glyph_row
*row
, *first
;
20253 struct glyph
*glyph
, *end
;
20256 first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
20257 row
= row_containing_pos (w
, charpos
, first
, NULL
, 0);
20260 if (charpos
< MATRIX_ROW_START_CHARPOS (first
))
20262 *x
= *y
= *hpos
= *vpos
= 0;
20267 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
20274 *vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
20276 glyph
= row
->glyphs
[TEXT_AREA
];
20277 end
= glyph
+ row
->used
[TEXT_AREA
];
20279 /* Skip over glyphs not having an object at the start of the row.
20280 These are special glyphs like truncation marks on terminal
20282 if (row
->displays_text_p
)
20284 && INTEGERP (glyph
->object
)
20285 && !EQ (stop
, glyph
->object
)
20286 && glyph
->charpos
< 0)
20288 *x
+= glyph
->pixel_width
;
20293 && !INTEGERP (glyph
->object
)
20294 && !EQ (stop
, glyph
->object
)
20295 && (!BUFFERP (glyph
->object
)
20296 || glyph
->charpos
< charpos
))
20298 *x
+= glyph
->pixel_width
;
20302 *hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
20309 fast_find_position (w
, pos
, hpos
, vpos
, x
, y
, stop
)
20312 int *hpos
, *vpos
, *x
, *y
;
20317 int maybe_next_line_p
= 0;
20318 int line_start_position
;
20319 int yb
= window_text_bottom_y (w
);
20320 struct glyph_row
*row
, *best_row
;
20321 int row_vpos
, best_row_vpos
;
20324 row
= best_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
20325 row_vpos
= best_row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
20327 while (row
->y
< yb
)
20329 if (row
->used
[TEXT_AREA
])
20330 line_start_position
= row
->glyphs
[TEXT_AREA
]->charpos
;
20332 line_start_position
= 0;
20334 if (line_start_position
> pos
)
20336 /* If the position sought is the end of the buffer,
20337 don't include the blank lines at the bottom of the window. */
20338 else if (line_start_position
== pos
20339 && pos
== BUF_ZV (XBUFFER (w
->buffer
)))
20341 maybe_next_line_p
= 1;
20344 else if (line_start_position
> 0)
20347 best_row_vpos
= row_vpos
;
20350 if (row
->y
+ row
->height
>= yb
)
20357 /* Find the right column within BEST_ROW. */
20359 current_x
= best_row
->x
;
20360 for (i
= 0; i
< best_row
->used
[TEXT_AREA
]; i
++)
20362 struct glyph
*glyph
= best_row
->glyphs
[TEXT_AREA
] + i
;
20363 int charpos
= glyph
->charpos
;
20365 if (BUFFERP (glyph
->object
))
20367 if (charpos
== pos
)
20370 *vpos
= best_row_vpos
;
20375 else if (charpos
> pos
)
20378 else if (EQ (glyph
->object
, stop
))
20383 current_x
+= glyph
->pixel_width
;
20386 /* If we're looking for the end of the buffer,
20387 and we didn't find it in the line we scanned,
20388 use the start of the following line. */
20389 if (maybe_next_line_p
)
20394 current_x
= best_row
->x
;
20397 *vpos
= best_row_vpos
;
20398 *hpos
= lastcol
+ 1;
20407 /* Find the position of the glyph for position POS in OBJECT in
20408 window W's current matrix, and return in *X, *Y the pixel
20409 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
20411 RIGHT_P non-zero means return the position of the right edge of the
20412 glyph, RIGHT_P zero means return the left edge position.
20414 If no glyph for POS exists in the matrix, return the position of
20415 the glyph with the next smaller position that is in the matrix, if
20416 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
20417 exists in the matrix, return the position of the glyph with the
20418 next larger position in OBJECT.
20420 Value is non-zero if a glyph was found. */
20423 fast_find_string_pos (w
, pos
, object
, hpos
, vpos
, x
, y
, right_p
)
20426 Lisp_Object object
;
20427 int *hpos
, *vpos
, *x
, *y
;
20430 int yb
= window_text_bottom_y (w
);
20431 struct glyph_row
*r
;
20432 struct glyph
*best_glyph
= NULL
;
20433 struct glyph_row
*best_row
= NULL
;
20436 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
20437 r
->enabled_p
&& r
->y
< yb
;
20440 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
20441 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
20444 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
20445 if (EQ (g
->object
, object
))
20447 if (g
->charpos
== pos
)
20454 else if (best_glyph
== NULL
20455 || ((abs (g
->charpos
- pos
)
20456 < abs (best_glyph
->charpos
- pos
))
20459 : g
->charpos
> pos
)))
20473 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
20477 *x
+= best_glyph
->pixel_width
;
20482 *vpos
= best_row
- w
->current_matrix
->rows
;
20485 return best_glyph
!= NULL
;
20489 /* See if position X, Y is within a hot-spot of an image. */
20492 on_hot_spot_p (hot_spot
, x
, y
)
20493 Lisp_Object hot_spot
;
20496 if (!CONSP (hot_spot
))
20499 if (EQ (XCAR (hot_spot
), Qrect
))
20501 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
20502 Lisp_Object rect
= XCDR (hot_spot
);
20506 if (!CONSP (XCAR (rect
)))
20508 if (!CONSP (XCDR (rect
)))
20510 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
20512 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
20514 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
20516 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
20520 else if (EQ (XCAR (hot_spot
), Qcircle
))
20522 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
20523 Lisp_Object circ
= XCDR (hot_spot
);
20524 Lisp_Object lr
, lx0
, ly0
;
20526 && CONSP (XCAR (circ
))
20527 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
20528 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
20529 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
20531 double r
= XFLOATINT (lr
);
20532 double dx
= XINT (lx0
) - x
;
20533 double dy
= XINT (ly0
) - y
;
20534 return (dx
* dx
+ dy
* dy
<= r
* r
);
20537 else if (EQ (XCAR (hot_spot
), Qpoly
))
20539 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
20540 if (VECTORP (XCDR (hot_spot
)))
20542 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
20543 Lisp_Object
*poly
= v
->contents
;
20547 Lisp_Object lx
, ly
;
20550 /* Need an even number of coordinates, and at least 3 edges. */
20551 if (n
< 6 || n
& 1)
20554 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
20555 If count is odd, we are inside polygon. Pixels on edges
20556 may or may not be included depending on actual geometry of the
20558 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
20559 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
20561 x0
= XINT (lx
), y0
= XINT (ly
);
20562 for (i
= 0; i
< n
; i
+= 2)
20564 int x1
= x0
, y1
= y0
;
20565 if ((lx
= poly
[i
], !INTEGERP (lx
))
20566 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
20568 x0
= XINT (lx
), y0
= XINT (ly
);
20570 /* Does this segment cross the X line? */
20578 if (y
> y0
&& y
> y1
)
20580 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
20586 /* If we don't understand the format, pretend we're not in the hot-spot. */
20591 find_hot_spot (map
, x
, y
)
20595 while (CONSP (map
))
20597 if (CONSP (XCAR (map
))
20598 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
20606 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
20608 doc
: /* Lookup in image map MAP coordinates X and Y.
20609 An image map is an alist where each element has the format (AREA ID PLIST).
20610 An AREA is specified as either a rectangle, a circle, or a polygon:
20611 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
20612 pixel coordinates of the upper left and bottom right corners.
20613 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
20614 and the radius of the circle; r may be a float or integer.
20615 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
20616 vector describes one corner in the polygon.
20617 Returns the alist element for the first matching AREA in MAP. */)
20628 return find_hot_spot (map
, XINT (x
), XINT (y
));
20632 /* Display frame CURSOR, optionally using shape defined by POINTER. */
20634 define_frame_cursor1 (f
, cursor
, pointer
)
20637 Lisp_Object pointer
;
20639 if (!NILP (pointer
))
20641 if (EQ (pointer
, Qarrow
))
20642 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
20643 else if (EQ (pointer
, Qhand
))
20644 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
20645 else if (EQ (pointer
, Qtext
))
20646 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
20647 else if (EQ (pointer
, intern ("hdrag")))
20648 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
20649 #ifdef HAVE_X_WINDOWS
20650 else if (EQ (pointer
, intern ("vdrag")))
20651 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
20653 else if (EQ (pointer
, intern ("hourglass")))
20654 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
20655 else if (EQ (pointer
, Qmodeline
))
20656 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
20658 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
20661 if (cursor
!= No_Cursor
)
20662 rif
->define_frame_cursor (f
, cursor
);
20665 /* Take proper action when mouse has moved to the mode or header line
20666 or marginal area AREA of window W, x-position X and y-position Y.
20667 X is relative to the start of the text display area of W, so the
20668 width of bitmap areas and scroll bars must be subtracted to get a
20669 position relative to the start of the mode line. */
20672 note_mode_line_or_margin_highlight (w
, x
, y
, area
)
20675 enum window_part area
;
20677 struct frame
*f
= XFRAME (w
->frame
);
20678 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
20679 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
20680 Lisp_Object pointer
= Qnil
;
20681 int charpos
, dx
, dy
, width
, height
;
20682 Lisp_Object string
, object
= Qnil
;
20683 Lisp_Object pos
, help
;
20685 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
20686 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
20687 &object
, &dx
, &dy
, &width
, &height
);
20690 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
20691 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
20692 &object
, &dx
, &dy
, &width
, &height
);
20697 if (IMAGEP (object
))
20699 Lisp_Object image_map
, hotspot
;
20700 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
20702 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
20704 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
20706 Lisp_Object area_id
, plist
;
20708 area_id
= XCAR (hotspot
);
20709 /* Could check AREA_ID to see if we enter/leave this hot-spot.
20710 If so, we could look for mouse-enter, mouse-leave
20711 properties in PLIST (and do something...). */
20712 if ((plist
= XCDR (hotspot
), CONSP (plist
)))
20714 pointer
= Fplist_get (plist
, Qpointer
);
20715 if (NILP (pointer
))
20717 help
= Fplist_get (plist
, Qhelp_echo
);
20720 help_echo_string
= help
;
20721 /* Is this correct? ++kfs */
20722 XSETWINDOW (help_echo_window
, w
);
20723 help_echo_object
= w
->buffer
;
20724 help_echo_pos
= charpos
;
20727 if (NILP (pointer
))
20728 pointer
= Fplist_get (XCDR (object
), QCpointer
);
20732 if (STRINGP (string
))
20734 pos
= make_number (charpos
);
20735 /* If we're on a string with `help-echo' text property, arrange
20736 for the help to be displayed. This is done by setting the
20737 global variable help_echo_string to the help string. */
20738 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
20741 help_echo_string
= help
;
20742 XSETWINDOW (help_echo_window
, w
);
20743 help_echo_object
= string
;
20744 help_echo_pos
= charpos
;
20747 if (NILP (pointer
))
20748 pointer
= Fget_text_property (pos
, Qpointer
, string
);
20750 /* Change the mouse pointer according to what is under X/Y. */
20751 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
20754 map
= Fget_text_property (pos
, Qlocal_map
, string
);
20755 if (!KEYMAPP (map
))
20756 map
= Fget_text_property (pos
, Qkeymap
, string
);
20757 if (!KEYMAPP (map
))
20758 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
20762 define_frame_cursor1 (f
, cursor
, pointer
);
20767 Take proper action when the mouse has moved to position X, Y on
20768 frame F as regards highlighting characters that have mouse-face
20769 properties. Also de-highlighting chars where the mouse was before.
20770 X and Y can be negative or out of range. */
20773 note_mouse_highlight (f
, x
, y
)
20777 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
20778 enum window_part part
;
20779 Lisp_Object window
;
20781 Cursor cursor
= No_Cursor
;
20782 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
20785 /* When a menu is active, don't highlight because this looks odd. */
20786 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NTGUI)
20787 if (popup_activated ())
20791 if (NILP (Vmouse_highlight
)
20792 || !f
->glyphs_initialized_p
)
20795 dpyinfo
->mouse_face_mouse_x
= x
;
20796 dpyinfo
->mouse_face_mouse_y
= y
;
20797 dpyinfo
->mouse_face_mouse_frame
= f
;
20799 if (dpyinfo
->mouse_face_defer
)
20802 if (gc_in_progress
)
20804 dpyinfo
->mouse_face_deferred_gc
= 1;
20808 /* Which window is that in? */
20809 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
20811 /* If we were displaying active text in another window, clear that. */
20812 if (! EQ (window
, dpyinfo
->mouse_face_window
))
20813 clear_mouse_face (dpyinfo
);
20815 /* Not on a window -> return. */
20816 if (!WINDOWP (window
))
20819 /* Reset help_echo_string. It will get recomputed below. */
20820 help_echo_string
= Qnil
;
20822 /* Convert to window-relative pixel coordinates. */
20823 w
= XWINDOW (window
);
20824 frame_to_window_pixel_xy (w
, &x
, &y
);
20826 /* Handle tool-bar window differently since it doesn't display a
20828 if (EQ (window
, f
->tool_bar_window
))
20830 note_tool_bar_highlight (f
, x
, y
);
20834 /* Mouse is on the mode, header line or margin? */
20835 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
20836 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
20838 note_mode_line_or_margin_highlight (w
, x
, y
, part
);
20842 if (part
== ON_VERTICAL_BORDER
)
20843 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
20844 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
)
20845 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
20847 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
20849 /* Are we in a window whose display is up to date?
20850 And verify the buffer's text has not changed. */
20851 b
= XBUFFER (w
->buffer
);
20852 if (part
== ON_TEXT
20853 && EQ (w
->window_end_valid
, w
->buffer
)
20854 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
20855 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
20857 int hpos
, vpos
, pos
, i
, dx
, dy
, area
;
20858 struct glyph
*glyph
;
20859 Lisp_Object object
;
20860 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
20861 Lisp_Object
*overlay_vec
= NULL
;
20863 struct buffer
*obuf
;
20864 int obegv
, ozv
, same_region
;
20866 /* Find the glyph under X/Y. */
20867 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
20869 /* Look for :pointer property on image. */
20870 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
20872 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
20873 if (img
!= NULL
&& IMAGEP (img
->spec
))
20875 Lisp_Object image_map
, hotspot
;
20876 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
20878 && (hotspot
= find_hot_spot (image_map
,
20879 glyph
->slice
.x
+ dx
,
20880 glyph
->slice
.y
+ dy
),
20882 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
20884 Lisp_Object area_id
, plist
;
20886 area_id
= XCAR (hotspot
);
20887 /* Could check AREA_ID to see if we enter/leave this hot-spot.
20888 If so, we could look for mouse-enter, mouse-leave
20889 properties in PLIST (and do something...). */
20890 if ((plist
= XCDR (hotspot
), CONSP (plist
)))
20892 pointer
= Fplist_get (plist
, Qpointer
);
20893 if (NILP (pointer
))
20895 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
20896 if (!NILP (help_echo_string
))
20898 help_echo_window
= window
;
20899 help_echo_object
= glyph
->object
;
20900 help_echo_pos
= glyph
->charpos
;
20904 if (NILP (pointer
))
20905 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
20909 /* Clear mouse face if X/Y not over text. */
20911 || area
!= TEXT_AREA
20912 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
20914 if (clear_mouse_face (dpyinfo
))
20915 cursor
= No_Cursor
;
20916 if (NILP (pointer
))
20918 if (area
!= TEXT_AREA
)
20919 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
20921 pointer
= Vvoid_text_area_pointer
;
20926 pos
= glyph
->charpos
;
20927 object
= glyph
->object
;
20928 if (!STRINGP (object
) && !BUFFERP (object
))
20931 /* If we get an out-of-range value, return now; avoid an error. */
20932 if (BUFFERP (object
) && pos
> BUF_Z (b
))
20935 /* Make the window's buffer temporarily current for
20936 overlays_at and compute_char_face. */
20937 obuf
= current_buffer
;
20938 current_buffer
= b
;
20944 /* Is this char mouse-active or does it have help-echo? */
20945 position
= make_number (pos
);
20947 if (BUFFERP (object
))
20949 /* Put all the overlays we want in a vector in overlay_vec. */
20950 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
20951 /* Sort overlays into increasing priority order. */
20952 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
20957 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
20958 && vpos
>= dpyinfo
->mouse_face_beg_row
20959 && vpos
<= dpyinfo
->mouse_face_end_row
20960 && (vpos
> dpyinfo
->mouse_face_beg_row
20961 || hpos
>= dpyinfo
->mouse_face_beg_col
)
20962 && (vpos
< dpyinfo
->mouse_face_end_row
20963 || hpos
< dpyinfo
->mouse_face_end_col
20964 || dpyinfo
->mouse_face_past_end
));
20967 cursor
= No_Cursor
;
20969 /* Check mouse-face highlighting. */
20971 /* If there exists an overlay with mouse-face overlapping
20972 the one we are currently highlighting, we have to
20973 check if we enter the overlapping overlay, and then
20974 highlight only that. */
20975 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
20976 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
20978 /* Find the highest priority overlay that has a mouse-face
20981 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
20983 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
20984 if (!NILP (mouse_face
))
20985 overlay
= overlay_vec
[i
];
20988 /* If we're actually highlighting the same overlay as
20989 before, there's no need to do that again. */
20990 if (!NILP (overlay
)
20991 && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
20992 goto check_help_echo
;
20994 dpyinfo
->mouse_face_overlay
= overlay
;
20996 /* Clear the display of the old active region, if any. */
20997 if (clear_mouse_face (dpyinfo
))
20998 cursor
= No_Cursor
;
21000 /* If no overlay applies, get a text property. */
21001 if (NILP (overlay
))
21002 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
21004 /* Handle the overlay case. */
21005 if (!NILP (overlay
))
21007 /* Find the range of text around this char that
21008 should be active. */
21009 Lisp_Object before
, after
;
21012 before
= Foverlay_start (overlay
);
21013 after
= Foverlay_end (overlay
);
21014 /* Record this as the current active region. */
21015 fast_find_position (w
, XFASTINT (before
),
21016 &dpyinfo
->mouse_face_beg_col
,
21017 &dpyinfo
->mouse_face_beg_row
,
21018 &dpyinfo
->mouse_face_beg_x
,
21019 &dpyinfo
->mouse_face_beg_y
, Qnil
);
21021 dpyinfo
->mouse_face_past_end
21022 = !fast_find_position (w
, XFASTINT (after
),
21023 &dpyinfo
->mouse_face_end_col
,
21024 &dpyinfo
->mouse_face_end_row
,
21025 &dpyinfo
->mouse_face_end_x
,
21026 &dpyinfo
->mouse_face_end_y
, Qnil
);
21027 dpyinfo
->mouse_face_window
= window
;
21029 dpyinfo
->mouse_face_face_id
21030 = face_at_buffer_position (w
, pos
, 0, 0,
21032 !dpyinfo
->mouse_face_hidden
);
21034 /* Display it as active. */
21035 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
21036 cursor
= No_Cursor
;
21038 /* Handle the text property case. */
21039 else if (!NILP (mouse_face
) && BUFFERP (object
))
21041 /* Find the range of text around this char that
21042 should be active. */
21043 Lisp_Object before
, after
, beginning
, end
;
21046 beginning
= Fmarker_position (w
->start
);
21047 end
= make_number (BUF_Z (XBUFFER (object
))
21048 - XFASTINT (w
->window_end_pos
));
21050 = Fprevious_single_property_change (make_number (pos
+ 1),
21052 object
, beginning
);
21054 = Fnext_single_property_change (position
, Qmouse_face
,
21057 /* Record this as the current active region. */
21058 fast_find_position (w
, XFASTINT (before
),
21059 &dpyinfo
->mouse_face_beg_col
,
21060 &dpyinfo
->mouse_face_beg_row
,
21061 &dpyinfo
->mouse_face_beg_x
,
21062 &dpyinfo
->mouse_face_beg_y
, Qnil
);
21063 dpyinfo
->mouse_face_past_end
21064 = !fast_find_position (w
, XFASTINT (after
),
21065 &dpyinfo
->mouse_face_end_col
,
21066 &dpyinfo
->mouse_face_end_row
,
21067 &dpyinfo
->mouse_face_end_x
,
21068 &dpyinfo
->mouse_face_end_y
, Qnil
);
21069 dpyinfo
->mouse_face_window
= window
;
21071 if (BUFFERP (object
))
21072 dpyinfo
->mouse_face_face_id
21073 = face_at_buffer_position (w
, pos
, 0, 0,
21075 !dpyinfo
->mouse_face_hidden
);
21077 /* Display it as active. */
21078 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
21079 cursor
= No_Cursor
;
21081 else if (!NILP (mouse_face
) && STRINGP (object
))
21086 b
= Fprevious_single_property_change (make_number (pos
+ 1),
21089 e
= Fnext_single_property_change (position
, Qmouse_face
,
21092 b
= make_number (0);
21094 e
= make_number (SCHARS (object
) - 1);
21095 fast_find_string_pos (w
, XINT (b
), object
,
21096 &dpyinfo
->mouse_face_beg_col
,
21097 &dpyinfo
->mouse_face_beg_row
,
21098 &dpyinfo
->mouse_face_beg_x
,
21099 &dpyinfo
->mouse_face_beg_y
, 0);
21100 fast_find_string_pos (w
, XINT (e
), object
,
21101 &dpyinfo
->mouse_face_end_col
,
21102 &dpyinfo
->mouse_face_end_row
,
21103 &dpyinfo
->mouse_face_end_x
,
21104 &dpyinfo
->mouse_face_end_y
, 1);
21105 dpyinfo
->mouse_face_past_end
= 0;
21106 dpyinfo
->mouse_face_window
= window
;
21107 dpyinfo
->mouse_face_face_id
21108 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
21109 glyph
->face_id
, 1);
21110 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
21111 cursor
= No_Cursor
;
21113 else if (STRINGP (object
) && NILP (mouse_face
))
21115 /* A string which doesn't have mouse-face, but
21116 the text ``under'' it might have. */
21117 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
21118 int start
= MATRIX_ROW_START_CHARPOS (r
);
21120 pos
= string_buffer_position (w
, object
, start
);
21122 mouse_face
= get_char_property_and_overlay (make_number (pos
),
21126 if (!NILP (mouse_face
) && !NILP (overlay
))
21128 Lisp_Object before
= Foverlay_start (overlay
);
21129 Lisp_Object after
= Foverlay_end (overlay
);
21132 /* Note that we might not be able to find position
21133 BEFORE in the glyph matrix if the overlay is
21134 entirely covered by a `display' property. In
21135 this case, we overshoot. So let's stop in
21136 the glyph matrix before glyphs for OBJECT. */
21137 fast_find_position (w
, XFASTINT (before
),
21138 &dpyinfo
->mouse_face_beg_col
,
21139 &dpyinfo
->mouse_face_beg_row
,
21140 &dpyinfo
->mouse_face_beg_x
,
21141 &dpyinfo
->mouse_face_beg_y
,
21144 dpyinfo
->mouse_face_past_end
21145 = !fast_find_position (w
, XFASTINT (after
),
21146 &dpyinfo
->mouse_face_end_col
,
21147 &dpyinfo
->mouse_face_end_row
,
21148 &dpyinfo
->mouse_face_end_x
,
21149 &dpyinfo
->mouse_face_end_y
,
21151 dpyinfo
->mouse_face_window
= window
;
21152 dpyinfo
->mouse_face_face_id
21153 = face_at_buffer_position (w
, pos
, 0, 0,
21155 !dpyinfo
->mouse_face_hidden
);
21157 /* Display it as active. */
21158 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
21159 cursor
= No_Cursor
;
21166 /* Look for a `help-echo' property. */
21167 if (NILP (help_echo_string
)) {
21168 Lisp_Object help
, overlay
;
21170 /* Check overlays first. */
21171 help
= overlay
= Qnil
;
21172 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
21174 overlay
= overlay_vec
[i
];
21175 help
= Foverlay_get (overlay
, Qhelp_echo
);
21180 help_echo_string
= help
;
21181 help_echo_window
= window
;
21182 help_echo_object
= overlay
;
21183 help_echo_pos
= pos
;
21187 Lisp_Object object
= glyph
->object
;
21188 int charpos
= glyph
->charpos
;
21190 /* Try text properties. */
21191 if (STRINGP (object
)
21193 && charpos
< SCHARS (object
))
21195 help
= Fget_text_property (make_number (charpos
),
21196 Qhelp_echo
, object
);
21199 /* If the string itself doesn't specify a help-echo,
21200 see if the buffer text ``under'' it does. */
21201 struct glyph_row
*r
21202 = MATRIX_ROW (w
->current_matrix
, vpos
);
21203 int start
= MATRIX_ROW_START_CHARPOS (r
);
21204 int pos
= string_buffer_position (w
, object
, start
);
21207 help
= Fget_char_property (make_number (pos
),
21208 Qhelp_echo
, w
->buffer
);
21212 object
= w
->buffer
;
21217 else if (BUFFERP (object
)
21220 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
21225 help_echo_string
= help
;
21226 help_echo_window
= window
;
21227 help_echo_object
= object
;
21228 help_echo_pos
= charpos
;
21233 /* Look for a `pointer' property. */
21234 if (NILP (pointer
))
21236 /* Check overlays first. */
21237 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
21238 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
21240 if (NILP (pointer
))
21242 Lisp_Object object
= glyph
->object
;
21243 int charpos
= glyph
->charpos
;
21245 /* Try text properties. */
21246 if (STRINGP (object
)
21248 && charpos
< SCHARS (object
))
21250 pointer
= Fget_text_property (make_number (charpos
),
21252 if (NILP (pointer
))
21254 /* If the string itself doesn't specify a pointer,
21255 see if the buffer text ``under'' it does. */
21256 struct glyph_row
*r
21257 = MATRIX_ROW (w
->current_matrix
, vpos
);
21258 int start
= MATRIX_ROW_START_CHARPOS (r
);
21259 int pos
= string_buffer_position (w
, object
, start
);
21261 pointer
= Fget_char_property (make_number (pos
),
21262 Qpointer
, w
->buffer
);
21265 else if (BUFFERP (object
)
21268 pointer
= Fget_text_property (make_number (charpos
),
21275 current_buffer
= obuf
;
21280 define_frame_cursor1 (f
, cursor
, pointer
);
21285 Clear any mouse-face on window W. This function is part of the
21286 redisplay interface, and is called from try_window_id and similar
21287 functions to ensure the mouse-highlight is off. */
21290 x_clear_window_mouse_face (w
)
21293 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
21294 Lisp_Object window
;
21297 XSETWINDOW (window
, w
);
21298 if (EQ (window
, dpyinfo
->mouse_face_window
))
21299 clear_mouse_face (dpyinfo
);
21305 Just discard the mouse face information for frame F, if any.
21306 This is used when the size of F is changed. */
21309 cancel_mouse_face (f
)
21312 Lisp_Object window
;
21313 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
21315 window
= dpyinfo
->mouse_face_window
;
21316 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
21318 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
21319 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
21320 dpyinfo
->mouse_face_window
= Qnil
;
21325 #endif /* HAVE_WINDOW_SYSTEM */
21328 /***********************************************************************
21330 ***********************************************************************/
21332 #ifdef HAVE_WINDOW_SYSTEM
21334 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
21335 which intersects rectangle R. R is in window-relative coordinates. */
21338 expose_area (w
, row
, r
, area
)
21340 struct glyph_row
*row
;
21342 enum glyph_row_area area
;
21344 struct glyph
*first
= row
->glyphs
[area
];
21345 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
21346 struct glyph
*last
;
21347 int first_x
, start_x
, x
;
21349 if (area
== TEXT_AREA
&& row
->fill_line_p
)
21350 /* If row extends face to end of line write the whole line. */
21351 draw_glyphs (w
, 0, row
, area
,
21352 0, row
->used
[area
],
21353 DRAW_NORMAL_TEXT
, 0);
21356 /* Set START_X to the window-relative start position for drawing glyphs of
21357 AREA. The first glyph of the text area can be partially visible.
21358 The first glyphs of other areas cannot. */
21359 start_x
= window_box_left_offset (w
, area
);
21361 if (area
== TEXT_AREA
)
21364 /* Find the first glyph that must be redrawn. */
21366 && x
+ first
->pixel_width
< r
->x
)
21368 x
+= first
->pixel_width
;
21372 /* Find the last one. */
21376 && x
< r
->x
+ r
->width
)
21378 x
+= last
->pixel_width
;
21384 draw_glyphs (w
, first_x
- start_x
, row
, area
,
21385 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
21386 DRAW_NORMAL_TEXT
, 0);
21391 /* Redraw the parts of the glyph row ROW on window W intersecting
21392 rectangle R. R is in window-relative coordinates. Value is
21393 non-zero if mouse-face was overwritten. */
21396 expose_line (w
, row
, r
)
21398 struct glyph_row
*row
;
21401 xassert (row
->enabled_p
);
21403 if (row
->mode_line_p
|| w
->pseudo_window_p
)
21404 draw_glyphs (w
, 0, row
, TEXT_AREA
,
21405 0, row
->used
[TEXT_AREA
],
21406 DRAW_NORMAL_TEXT
, 0);
21409 if (row
->used
[LEFT_MARGIN_AREA
])
21410 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
21411 if (row
->used
[TEXT_AREA
])
21412 expose_area (w
, row
, r
, TEXT_AREA
);
21413 if (row
->used
[RIGHT_MARGIN_AREA
])
21414 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
21415 draw_row_fringe_bitmaps (w
, row
);
21418 return row
->mouse_face_p
;
21422 /* Redraw those parts of glyphs rows during expose event handling that
21423 overlap other rows. Redrawing of an exposed line writes over parts
21424 of lines overlapping that exposed line; this function fixes that.
21426 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
21427 row in W's current matrix that is exposed and overlaps other rows.
21428 LAST_OVERLAPPING_ROW is the last such row. */
21431 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
)
21433 struct glyph_row
*first_overlapping_row
;
21434 struct glyph_row
*last_overlapping_row
;
21436 struct glyph_row
*row
;
21438 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
21439 if (row
->overlapping_p
)
21441 xassert (row
->enabled_p
&& !row
->mode_line_p
);
21443 if (row
->used
[LEFT_MARGIN_AREA
])
21444 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
);
21446 if (row
->used
[TEXT_AREA
])
21447 x_fix_overlapping_area (w
, row
, TEXT_AREA
);
21449 if (row
->used
[RIGHT_MARGIN_AREA
])
21450 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
);
21455 /* Return non-zero if W's cursor intersects rectangle R. */
21458 phys_cursor_in_rect_p (w
, r
)
21462 XRectangle cr
, result
;
21463 struct glyph
*cursor_glyph
;
21465 cursor_glyph
= get_phys_cursor_glyph (w
);
21468 /* r is relative to W's box, but w->phys_cursor.x is relative
21469 to left edge of W's TEXT area. Adjust it. */
21470 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
21471 cr
.y
= w
->phys_cursor
.y
;
21472 cr
.width
= cursor_glyph
->pixel_width
;
21473 cr
.height
= w
->phys_cursor_height
;
21474 /* ++KFS: W32 version used W32-specific IntersectRect here, but
21475 I assume the effect is the same -- and this is portable. */
21476 return x_intersect_rectangles (&cr
, r
, &result
);
21484 Draw a vertical window border to the right of window W if W doesn't
21485 have vertical scroll bars. */
21488 x_draw_vertical_border (w
)
21491 /* We could do better, if we knew what type of scroll-bar the adjacent
21492 windows (on either side) have... But we don't :-(
21493 However, I think this works ok. ++KFS 2003-04-25 */
21495 /* Redraw borders between horizontally adjacent windows. Don't
21496 do it for frames with vertical scroll bars because either the
21497 right scroll bar of a window, or the left scroll bar of its
21498 neighbor will suffice as a border. */
21499 if (!WINDOW_RIGHTMOST_P (w
)
21500 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
21502 int x0
, x1
, y0
, y1
;
21504 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
21507 rif
->draw_vertical_window_border (w
, x1
, y0
, y1
);
21509 else if (!WINDOW_LEFTMOST_P (w
)
21510 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
21512 int x0
, x1
, y0
, y1
;
21514 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
21517 rif
->draw_vertical_window_border (w
, x0
, y0
, y1
);
21522 /* Redraw the part of window W intersection rectangle FR. Pixel
21523 coordinates in FR are frame-relative. Call this function with
21524 input blocked. Value is non-zero if the exposure overwrites
21528 expose_window (w
, fr
)
21532 struct frame
*f
= XFRAME (w
->frame
);
21534 int mouse_face_overwritten_p
= 0;
21536 /* If window is not yet fully initialized, do nothing. This can
21537 happen when toolkit scroll bars are used and a window is split.
21538 Reconfiguring the scroll bar will generate an expose for a newly
21540 if (w
->current_matrix
== NULL
)
21543 /* When we're currently updating the window, display and current
21544 matrix usually don't agree. Arrange for a thorough display
21546 if (w
== updated_window
)
21548 SET_FRAME_GARBAGED (f
);
21552 /* Frame-relative pixel rectangle of W. */
21553 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
21554 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
21555 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
21556 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
21558 if (x_intersect_rectangles (fr
, &wr
, &r
))
21560 int yb
= window_text_bottom_y (w
);
21561 struct glyph_row
*row
;
21562 int cursor_cleared_p
;
21563 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
21565 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
21566 r
.x
, r
.y
, r
.width
, r
.height
));
21568 /* Convert to window coordinates. */
21569 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
21570 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
21572 /* Turn off the cursor. */
21573 if (!w
->pseudo_window_p
21574 && phys_cursor_in_rect_p (w
, &r
))
21576 x_clear_cursor (w
);
21577 cursor_cleared_p
= 1;
21580 cursor_cleared_p
= 0;
21582 /* Update lines intersecting rectangle R. */
21583 first_overlapping_row
= last_overlapping_row
= NULL
;
21584 for (row
= w
->current_matrix
->rows
;
21589 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
21591 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
21592 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
21593 || (r
.y
>= y0
&& r
.y
< y1
)
21594 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
21596 if (row
->overlapping_p
)
21598 if (first_overlapping_row
== NULL
)
21599 first_overlapping_row
= row
;
21600 last_overlapping_row
= row
;
21603 if (expose_line (w
, row
, &r
))
21604 mouse_face_overwritten_p
= 1;
21611 /* Display the mode line if there is one. */
21612 if (WINDOW_WANTS_MODELINE_P (w
)
21613 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
21615 && row
->y
< r
.y
+ r
.height
)
21617 if (expose_line (w
, row
, &r
))
21618 mouse_face_overwritten_p
= 1;
21621 if (!w
->pseudo_window_p
)
21623 /* Fix the display of overlapping rows. */
21624 if (first_overlapping_row
)
21625 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
);
21627 /* Draw border between windows. */
21628 x_draw_vertical_border (w
);
21630 /* Turn the cursor on again. */
21631 if (cursor_cleared_p
)
21632 update_window_cursor (w
, 1);
21637 /* Display scroll bar for this window. */
21638 if (!NILP (w
->vertical_scroll_bar
))
21641 If this doesn't work here (maybe some header files are missing),
21642 make a function in macterm.c and call it to do the job! */
21644 = SCROLL_BAR_CONTROL_HANDLE (XSCROLL_BAR (w
->vertical_scroll_bar
));
21650 return mouse_face_overwritten_p
;
21655 /* Redraw (parts) of all windows in the window tree rooted at W that
21656 intersect R. R contains frame pixel coordinates. Value is
21657 non-zero if the exposure overwrites mouse-face. */
21660 expose_window_tree (w
, r
)
21664 struct frame
*f
= XFRAME (w
->frame
);
21665 int mouse_face_overwritten_p
= 0;
21667 while (w
&& !FRAME_GARBAGED_P (f
))
21669 if (!NILP (w
->hchild
))
21670 mouse_face_overwritten_p
21671 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
21672 else if (!NILP (w
->vchild
))
21673 mouse_face_overwritten_p
21674 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
21676 mouse_face_overwritten_p
|= expose_window (w
, r
);
21678 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
21681 return mouse_face_overwritten_p
;
21686 Redisplay an exposed area of frame F. X and Y are the upper-left
21687 corner of the exposed rectangle. W and H are width and height of
21688 the exposed area. All are pixel values. W or H zero means redraw
21689 the entire frame. */
21692 expose_frame (f
, x
, y
, w
, h
)
21697 int mouse_face_overwritten_p
= 0;
21699 TRACE ((stderr
, "expose_frame "));
21701 /* No need to redraw if frame will be redrawn soon. */
21702 if (FRAME_GARBAGED_P (f
))
21704 TRACE ((stderr
, " garbaged\n"));
21709 /* MAC_TODO: this is a kludge, but if scroll bars are not activated
21710 or deactivated here, for unknown reasons, activated scroll bars
21711 are shown in deactivated frames in some instances. */
21712 if (f
== FRAME_MAC_DISPLAY_INFO (f
)->x_focus_frame
)
21713 activate_scroll_bars (f
);
21715 deactivate_scroll_bars (f
);
21718 /* If basic faces haven't been realized yet, there is no point in
21719 trying to redraw anything. This can happen when we get an expose
21720 event while Emacs is starting, e.g. by moving another window. */
21721 if (FRAME_FACE_CACHE (f
) == NULL
21722 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
21724 TRACE ((stderr
, " no faces\n"));
21728 if (w
== 0 || h
== 0)
21731 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
21732 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
21742 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
21743 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
21745 if (WINDOWP (f
->tool_bar_window
))
21746 mouse_face_overwritten_p
21747 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
21749 #ifdef HAVE_X_WINDOWS
21751 #ifndef USE_X_TOOLKIT
21752 if (WINDOWP (f
->menu_bar_window
))
21753 mouse_face_overwritten_p
21754 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
21755 #endif /* not USE_X_TOOLKIT */
21759 /* Some window managers support a focus-follows-mouse style with
21760 delayed raising of frames. Imagine a partially obscured frame,
21761 and moving the mouse into partially obscured mouse-face on that
21762 frame. The visible part of the mouse-face will be highlighted,
21763 then the WM raises the obscured frame. With at least one WM, KDE
21764 2.1, Emacs is not getting any event for the raising of the frame
21765 (even tried with SubstructureRedirectMask), only Expose events.
21766 These expose events will draw text normally, i.e. not
21767 highlighted. Which means we must redo the highlight here.
21768 Subsume it under ``we love X''. --gerd 2001-08-15 */
21769 /* Included in Windows version because Windows most likely does not
21770 do the right thing if any third party tool offers
21771 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
21772 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
21774 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
21775 if (f
== dpyinfo
->mouse_face_mouse_frame
)
21777 int x
= dpyinfo
->mouse_face_mouse_x
;
21778 int y
= dpyinfo
->mouse_face_mouse_y
;
21779 clear_mouse_face (dpyinfo
);
21780 note_mouse_highlight (f
, x
, y
);
21787 Determine the intersection of two rectangles R1 and R2. Return
21788 the intersection in *RESULT. Value is non-zero if RESULT is not
21792 x_intersect_rectangles (r1
, r2
, result
)
21793 XRectangle
*r1
, *r2
, *result
;
21795 XRectangle
*left
, *right
;
21796 XRectangle
*upper
, *lower
;
21797 int intersection_p
= 0;
21799 /* Rearrange so that R1 is the left-most rectangle. */
21801 left
= r1
, right
= r2
;
21803 left
= r2
, right
= r1
;
21805 /* X0 of the intersection is right.x0, if this is inside R1,
21806 otherwise there is no intersection. */
21807 if (right
->x
<= left
->x
+ left
->width
)
21809 result
->x
= right
->x
;
21811 /* The right end of the intersection is the minimum of the
21812 the right ends of left and right. */
21813 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
21816 /* Same game for Y. */
21818 upper
= r1
, lower
= r2
;
21820 upper
= r2
, lower
= r1
;
21822 /* The upper end of the intersection is lower.y0, if this is inside
21823 of upper. Otherwise, there is no intersection. */
21824 if (lower
->y
<= upper
->y
+ upper
->height
)
21826 result
->y
= lower
->y
;
21828 /* The lower end of the intersection is the minimum of the lower
21829 ends of upper and lower. */
21830 result
->height
= (min (lower
->y
+ lower
->height
,
21831 upper
->y
+ upper
->height
)
21833 intersection_p
= 1;
21837 return intersection_p
;
21840 #endif /* HAVE_WINDOW_SYSTEM */
21843 /***********************************************************************
21845 ***********************************************************************/
21850 Vwith_echo_area_save_vector
= Qnil
;
21851 staticpro (&Vwith_echo_area_save_vector
);
21853 Vmessage_stack
= Qnil
;
21854 staticpro (&Vmessage_stack
);
21856 Qinhibit_redisplay
= intern ("inhibit-redisplay");
21857 staticpro (&Qinhibit_redisplay
);
21859 message_dolog_marker1
= Fmake_marker ();
21860 staticpro (&message_dolog_marker1
);
21861 message_dolog_marker2
= Fmake_marker ();
21862 staticpro (&message_dolog_marker2
);
21863 message_dolog_marker3
= Fmake_marker ();
21864 staticpro (&message_dolog_marker3
);
21867 defsubr (&Sdump_frame_glyph_matrix
);
21868 defsubr (&Sdump_glyph_matrix
);
21869 defsubr (&Sdump_glyph_row
);
21870 defsubr (&Sdump_tool_bar_row
);
21871 defsubr (&Strace_redisplay
);
21872 defsubr (&Strace_to_stderr
);
21874 #ifdef HAVE_WINDOW_SYSTEM
21875 defsubr (&Stool_bar_lines_needed
);
21876 defsubr (&Slookup_image_map
);
21878 defsubr (&Sformat_mode_line
);
21880 staticpro (&Qmenu_bar_update_hook
);
21881 Qmenu_bar_update_hook
= intern ("menu-bar-update-hook");
21883 staticpro (&Qoverriding_terminal_local_map
);
21884 Qoverriding_terminal_local_map
= intern ("overriding-terminal-local-map");
21886 staticpro (&Qoverriding_local_map
);
21887 Qoverriding_local_map
= intern ("overriding-local-map");
21889 staticpro (&Qwindow_scroll_functions
);
21890 Qwindow_scroll_functions
= intern ("window-scroll-functions");
21892 staticpro (&Qredisplay_end_trigger_functions
);
21893 Qredisplay_end_trigger_functions
= intern ("redisplay-end-trigger-functions");
21895 staticpro (&Qinhibit_point_motion_hooks
);
21896 Qinhibit_point_motion_hooks
= intern ("inhibit-point-motion-hooks");
21898 QCdata
= intern (":data");
21899 staticpro (&QCdata
);
21900 Qdisplay
= intern ("display");
21901 staticpro (&Qdisplay
);
21902 Qspace_width
= intern ("space-width");
21903 staticpro (&Qspace_width
);
21904 Qraise
= intern ("raise");
21905 staticpro (&Qraise
);
21906 Qslice
= intern ("slice");
21907 staticpro (&Qslice
);
21908 Qspace
= intern ("space");
21909 staticpro (&Qspace
);
21910 Qmargin
= intern ("margin");
21911 staticpro (&Qmargin
);
21912 Qpointer
= intern ("pointer");
21913 staticpro (&Qpointer
);
21914 Qleft_margin
= intern ("left-margin");
21915 staticpro (&Qleft_margin
);
21916 Qright_margin
= intern ("right-margin");
21917 staticpro (&Qright_margin
);
21918 Qcenter
= intern ("center");
21919 staticpro (&Qcenter
);
21920 Qline_height
= intern ("line-height");
21921 staticpro (&Qline_height
);
21922 Qtotal
= intern ("total");
21923 staticpro (&Qtotal
);
21924 QCalign_to
= intern (":align-to");
21925 staticpro (&QCalign_to
);
21926 QCrelative_width
= intern (":relative-width");
21927 staticpro (&QCrelative_width
);
21928 QCrelative_height
= intern (":relative-height");
21929 staticpro (&QCrelative_height
);
21930 QCeval
= intern (":eval");
21931 staticpro (&QCeval
);
21932 QCpropertize
= intern (":propertize");
21933 staticpro (&QCpropertize
);
21934 QCfile
= intern (":file");
21935 staticpro (&QCfile
);
21936 Qfontified
= intern ("fontified");
21937 staticpro (&Qfontified
);
21938 Qfontification_functions
= intern ("fontification-functions");
21939 staticpro (&Qfontification_functions
);
21940 Qtrailing_whitespace
= intern ("trailing-whitespace");
21941 staticpro (&Qtrailing_whitespace
);
21942 Qimage
= intern ("image");
21943 staticpro (&Qimage
);
21944 QCmap
= intern (":map");
21945 staticpro (&QCmap
);
21946 QCpointer
= intern (":pointer");
21947 staticpro (&QCpointer
);
21948 Qrect
= intern ("rect");
21949 staticpro (&Qrect
);
21950 Qcircle
= intern ("circle");
21951 staticpro (&Qcircle
);
21952 Qpoly
= intern ("poly");
21953 staticpro (&Qpoly
);
21954 Qmessage_truncate_lines
= intern ("message-truncate-lines");
21955 staticpro (&Qmessage_truncate_lines
);
21956 Qcursor_in_non_selected_windows
= intern ("cursor-in-non-selected-windows");
21957 staticpro (&Qcursor_in_non_selected_windows
);
21958 Qgrow_only
= intern ("grow-only");
21959 staticpro (&Qgrow_only
);
21960 Qinhibit_menubar_update
= intern ("inhibit-menubar-update");
21961 staticpro (&Qinhibit_menubar_update
);
21962 Qinhibit_eval_during_redisplay
= intern ("inhibit-eval-during-redisplay");
21963 staticpro (&Qinhibit_eval_during_redisplay
);
21964 Qposition
= intern ("position");
21965 staticpro (&Qposition
);
21966 Qbuffer_position
= intern ("buffer-position");
21967 staticpro (&Qbuffer_position
);
21968 Qobject
= intern ("object");
21969 staticpro (&Qobject
);
21970 Qbar
= intern ("bar");
21972 Qhbar
= intern ("hbar");
21973 staticpro (&Qhbar
);
21974 Qbox
= intern ("box");
21976 Qhollow
= intern ("hollow");
21977 staticpro (&Qhollow
);
21978 Qhand
= intern ("hand");
21979 staticpro (&Qhand
);
21980 Qarrow
= intern ("arrow");
21981 staticpro (&Qarrow
);
21982 Qtext
= intern ("text");
21983 staticpro (&Qtext
);
21984 Qrisky_local_variable
= intern ("risky-local-variable");
21985 staticpro (&Qrisky_local_variable
);
21986 Qinhibit_free_realized_faces
= intern ("inhibit-free-realized-faces");
21987 staticpro (&Qinhibit_free_realized_faces
);
21989 list_of_error
= Fcons (Fcons (intern ("error"),
21990 Fcons (intern ("void-variable"), Qnil
)),
21992 staticpro (&list_of_error
);
21994 Qlast_arrow_position
= intern ("last-arrow-position");
21995 staticpro (&Qlast_arrow_position
);
21996 Qlast_arrow_string
= intern ("last-arrow-string");
21997 staticpro (&Qlast_arrow_string
);
21999 Qoverlay_arrow_string
= intern ("overlay-arrow-string");
22000 staticpro (&Qoverlay_arrow_string
);
22001 Qoverlay_arrow_bitmap
= intern ("overlay-arrow-bitmap");
22002 staticpro (&Qoverlay_arrow_bitmap
);
22004 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
22005 staticpro (&echo_buffer
[0]);
22006 staticpro (&echo_buffer
[1]);
22008 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
22009 staticpro (&echo_area_buffer
[0]);
22010 staticpro (&echo_area_buffer
[1]);
22012 Vmessages_buffer_name
= build_string ("*Messages*");
22013 staticpro (&Vmessages_buffer_name
);
22015 mode_line_proptrans_alist
= Qnil
;
22016 staticpro (&mode_line_proptrans_alist
);
22018 mode_line_string_list
= Qnil
;
22019 staticpro (&mode_line_string_list
);
22021 help_echo_string
= Qnil
;
22022 staticpro (&help_echo_string
);
22023 help_echo_object
= Qnil
;
22024 staticpro (&help_echo_object
);
22025 help_echo_window
= Qnil
;
22026 staticpro (&help_echo_window
);
22027 previous_help_echo_string
= Qnil
;
22028 staticpro (&previous_help_echo_string
);
22029 help_echo_pos
= -1;
22031 #ifdef HAVE_WINDOW_SYSTEM
22032 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
22033 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
22034 For example, if a block cursor is over a tab, it will be drawn as
22035 wide as that tab on the display. */);
22036 x_stretch_cursor_p
= 0;
22039 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
22040 doc
: /* *Non-nil means highlight trailing whitespace.
22041 The face used for trailing whitespace is `trailing-whitespace'. */);
22042 Vshow_trailing_whitespace
= Qnil
;
22044 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
22045 doc
: /* *The pointer shape to show in void text areas.
22046 Nil means to show the text pointer. Other options are `arrow', `text',
22047 `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
22048 Vvoid_text_area_pointer
= Qarrow
;
22050 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
22051 doc
: /* Non-nil means don't actually do any redisplay.
22052 This is used for internal purposes. */);
22053 Vinhibit_redisplay
= Qnil
;
22055 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
22056 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
22057 Vglobal_mode_string
= Qnil
;
22059 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
22060 doc
: /* Marker for where to display an arrow on top of the buffer text.
22061 This must be the beginning of a line in order to work.
22062 See also `overlay-arrow-string'. */);
22063 Voverlay_arrow_position
= Qnil
;
22065 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
22066 doc
: /* String to display as an arrow in non-window frames.
22067 See also `overlay-arrow-position'. */);
22068 Voverlay_arrow_string
= Qnil
;
22070 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
22071 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
22072 The symbols on this list are examined during redisplay to determine
22073 where to display overlay arrows. */);
22074 Voverlay_arrow_variable_list
22075 = Fcons (intern ("overlay-arrow-position"), Qnil
);
22077 DEFVAR_INT ("scroll-step", &scroll_step
,
22078 doc
: /* *The number of lines to try scrolling a window by when point moves out.
22079 If that fails to bring point back on frame, point is centered instead.
22080 If this is zero, point is always centered after it moves off frame.
22081 If you want scrolling to always be a line at a time, you should set
22082 `scroll-conservatively' to a large value rather than set this to 1. */);
22084 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
22085 doc
: /* *Scroll up to this many lines, to bring point back on screen.
22086 A value of zero means to scroll the text to center point vertically
22087 in the window. */);
22088 scroll_conservatively
= 0;
22090 DEFVAR_INT ("scroll-margin", &scroll_margin
,
22091 doc
: /* *Number of lines of margin at the top and bottom of a window.
22092 Recenter the window whenever point gets within this many lines
22093 of the top or bottom of the window. */);
22096 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
22097 doc
: /* Pixels per inch on current display.
22098 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
22099 Vdisplay_pixels_per_inch
= make_float (72.0);
22102 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
22105 DEFVAR_BOOL ("truncate-partial-width-windows",
22106 &truncate_partial_width_windows
,
22107 doc
: /* *Non-nil means truncate lines in all windows less than full frame wide. */);
22108 truncate_partial_width_windows
= 1;
22110 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
22111 doc
: /* nil means display the mode-line/header-line/menu-bar in the default face.
22112 Any other value means to use the appropriate face, `mode-line',
22113 `header-line', or `menu' respectively. */);
22114 mode_line_inverse_video
= 1;
22116 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
22117 doc
: /* *Maximum buffer size for which line number should be displayed.
22118 If the buffer is bigger than this, the line number does not appear
22119 in the mode line. A value of nil means no limit. */);
22120 Vline_number_display_limit
= Qnil
;
22122 DEFVAR_INT ("line-number-display-limit-width",
22123 &line_number_display_limit_width
,
22124 doc
: /* *Maximum line width (in characters) for line number display.
22125 If the average length of the lines near point is bigger than this, then the
22126 line number may be omitted from the mode line. */);
22127 line_number_display_limit_width
= 200;
22129 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
22130 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
22131 highlight_nonselected_windows
= 0;
22133 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
22134 doc
: /* Non-nil if more than one frame is visible on this display.
22135 Minibuffer-only frames don't count, but iconified frames do.
22136 This variable is not guaranteed to be accurate except while processing
22137 `frame-title-format' and `icon-title-format'. */);
22139 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
22140 doc
: /* Template for displaying the title bar of visible frames.
22141 \(Assuming the window manager supports this feature.)
22142 This variable has the same structure as `mode-line-format' (which see),
22143 and is used only on frames for which no explicit name has been set
22144 \(see `modify-frame-parameters'). */);
22146 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
22147 doc
: /* Template for displaying the title bar of an iconified frame.
22148 \(Assuming the window manager supports this feature.)
22149 This variable has the same structure as `mode-line-format' (which see),
22150 and is used only on frames for which no explicit name has been set
22151 \(see `modify-frame-parameters'). */);
22153 = Vframe_title_format
22154 = Fcons (intern ("multiple-frames"),
22155 Fcons (build_string ("%b"),
22156 Fcons (Fcons (empty_string
,
22157 Fcons (intern ("invocation-name"),
22158 Fcons (build_string ("@"),
22159 Fcons (intern ("system-name"),
22163 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
22164 doc
: /* Maximum number of lines to keep in the message log buffer.
22165 If nil, disable message logging. If t, log messages but don't truncate
22166 the buffer when it becomes large. */);
22167 Vmessage_log_max
= make_number (50);
22169 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
22170 doc
: /* Functions called before redisplay, if window sizes have changed.
22171 The value should be a list of functions that take one argument.
22172 Just before redisplay, for each frame, if any of its windows have changed
22173 size since the last redisplay, or have been split or deleted,
22174 all the functions in the list are called, with the frame as argument. */);
22175 Vwindow_size_change_functions
= Qnil
;
22177 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
22178 doc
: /* List of Functions to call before redisplaying a window with scrolling.
22179 Each function is called with two arguments, the window
22180 and its new display-start position. Note that the value of `window-end'
22181 is not valid when these functions are called. */);
22182 Vwindow_scroll_functions
= Qnil
;
22184 DEFVAR_BOOL ("mouse-autoselect-window", &mouse_autoselect_window
,
22185 doc
: /* *Non-nil means autoselect window with mouse pointer. */);
22186 mouse_autoselect_window
= 0;
22188 DEFVAR_BOOL ("auto-resize-tool-bars", &auto_resize_tool_bars_p
,
22189 doc
: /* *Non-nil means automatically resize tool-bars.
22190 This increases a tool-bar's height if not all tool-bar items are visible.
22191 It decreases a tool-bar's height when it would display blank lines
22193 auto_resize_tool_bars_p
= 1;
22195 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
22196 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
22197 auto_raise_tool_bar_buttons_p
= 1;
22199 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
22200 doc
: /* *Margin around tool-bar buttons in pixels.
22201 If an integer, use that for both horizontal and vertical margins.
22202 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
22203 HORZ specifying the horizontal margin, and VERT specifying the
22204 vertical margin. */);
22205 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
22207 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
22208 doc
: /* *Relief thickness of tool-bar buttons. */);
22209 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
22211 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
22212 doc
: /* List of functions to call to fontify regions of text.
22213 Each function is called with one argument POS. Functions must
22214 fontify a region starting at POS in the current buffer, and give
22215 fontified regions the property `fontified'. */);
22216 Vfontification_functions
= Qnil
;
22217 Fmake_variable_buffer_local (Qfontification_functions
);
22219 DEFVAR_BOOL ("unibyte-display-via-language-environment",
22220 &unibyte_display_via_language_environment
,
22221 doc
: /* *Non-nil means display unibyte text according to language environment.
22222 Specifically this means that unibyte non-ASCII characters
22223 are displayed by converting them to the equivalent multibyte characters
22224 according to the current language environment. As a result, they are
22225 displayed according to the current fontset. */);
22226 unibyte_display_via_language_environment
= 0;
22228 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
22229 doc
: /* *Maximum height for resizing mini-windows.
22230 If a float, it specifies a fraction of the mini-window frame's height.
22231 If an integer, it specifies a number of lines. */);
22232 Vmax_mini_window_height
= make_float (0.25);
22234 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
22235 doc
: /* *How to resize mini-windows.
22236 A value of nil means don't automatically resize mini-windows.
22237 A value of t means resize them to fit the text displayed in them.
22238 A value of `grow-only', the default, means let mini-windows grow
22239 only, until their display becomes empty, at which point the windows
22240 go back to their normal size. */);
22241 Vresize_mini_windows
= Qgrow_only
;
22243 DEFVAR_LISP ("cursor-in-non-selected-windows",
22244 &Vcursor_in_non_selected_windows
,
22245 doc
: /* *Cursor type to display in non-selected windows.
22246 t means to use hollow box cursor. See `cursor-type' for other values. */);
22247 Vcursor_in_non_selected_windows
= Qt
;
22249 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
22250 doc
: /* Alist specifying how to blink the cursor off.
22251 Each element has the form (ON-STATE . OFF-STATE). Whenever the
22252 `cursor-type' frame-parameter or variable equals ON-STATE,
22253 comparing using `equal', Emacs uses OFF-STATE to specify
22254 how to blink it off. */);
22255 Vblink_cursor_alist
= Qnil
;
22257 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
22258 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
22259 automatic_hscrolling_p
= 1;
22261 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
22262 doc
: /* *How many columns away from the window edge point is allowed to get
22263 before automatic hscrolling will horizontally scroll the window. */);
22264 hscroll_margin
= 5;
22266 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
22267 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
22268 When point is less than `automatic-hscroll-margin' columns from the window
22269 edge, automatic hscrolling will scroll the window by the amount of columns
22270 determined by this variable. If its value is a positive integer, scroll that
22271 many columns. If it's a positive floating-point number, it specifies the
22272 fraction of the window's width to scroll. If it's nil or zero, point will be
22273 centered horizontally after the scroll. Any other value, including negative
22274 numbers, are treated as if the value were zero.
22276 Automatic hscrolling always moves point outside the scroll margin, so if
22277 point was more than scroll step columns inside the margin, the window will
22278 scroll more than the value given by the scroll step.
22280 Note that the lower bound for automatic hscrolling specified by `scroll-left'
22281 and `scroll-right' overrides this variable's effect. */);
22282 Vhscroll_step
= make_number (0);
22284 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
22285 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
22286 Bind this around calls to `message' to let it take effect. */);
22287 message_truncate_lines
= 0;
22289 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
22290 doc
: /* Normal hook run for clicks on menu bar, before displaying a submenu.
22291 Can be used to update submenus whose contents should vary. */);
22292 Vmenu_bar_update_hook
= Qnil
;
22294 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
22295 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
22296 inhibit_menubar_update
= 0;
22298 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
22299 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
22300 inhibit_eval_during_redisplay
= 0;
22302 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
22303 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
22304 inhibit_free_realized_faces
= 0;
22307 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
22308 doc
: /* Inhibit try_window_id display optimization. */);
22309 inhibit_try_window_id
= 0;
22311 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
22312 doc
: /* Inhibit try_window_reusing display optimization. */);
22313 inhibit_try_window_reusing
= 0;
22315 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
22316 doc
: /* Inhibit try_cursor_movement display optimization. */);
22317 inhibit_try_cursor_movement
= 0;
22318 #endif /* GLYPH_DEBUG */
22322 /* Initialize this module when Emacs starts. */
22327 Lisp_Object root_window
;
22328 struct window
*mini_w
;
22330 current_header_line_height
= current_mode_line_height
= -1;
22332 CHARPOS (this_line_start_pos
) = 0;
22334 mini_w
= XWINDOW (minibuf_window
);
22335 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
22337 if (!noninteractive
)
22339 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
22342 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
22343 set_window_height (root_window
,
22344 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
22346 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
22347 set_window_height (minibuf_window
, 1, 0);
22349 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
22350 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
22352 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
22353 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
22354 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
22356 /* The default ellipsis glyphs `...'. */
22357 for (i
= 0; i
< 3; ++i
)
22358 default_invis_vector
[i
] = make_number ('.');
22362 /* Allocate the buffer for frame titles.
22363 Also used for `format-mode-line'. */
22365 frame_title_buf
= (char *) xmalloc (size
);
22366 frame_title_buf_end
= frame_title_buf
+ size
;
22367 frame_title_ptr
= NULL
;
22370 help_echo_showing_p
= 0;
22374 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
22375 (do not change this comment) */