1 /* Display generation from window structure and buffer text.
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995,
3 1997, 1998, 1999, 2000, 2001, 2002, 2003,
4 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
25 Emacs separates the task of updating the display from code
26 modifying global state, e.g. buffer text. This way functions
27 operating on buffers don't also have to be concerned with updating
30 Updating the display is triggered by the Lisp interpreter when it
31 decides it's time to do it. This is done either automatically for
32 you as part of the interpreter's command loop or as the result of
33 calling Lisp functions like `sit-for'. The C function `redisplay'
34 in xdisp.c is the only entry into the inner redisplay code. (Or,
35 let's say almost---see the description of direct update
38 The following diagram shows how redisplay code is invoked. As you
39 can see, Lisp calls redisplay and vice versa. Under window systems
40 like X, some portions of the redisplay code are also called
41 asynchronously during mouse movement or expose events. It is very
42 important that these code parts do NOT use the C library (malloc,
43 free) because many C libraries under Unix are not reentrant. They
44 may also NOT call functions of the Lisp interpreter which could
45 change the interpreter's state. If you don't follow these rules,
46 you will encounter bugs which are very hard to explain.
48 (Direct functions, see below)
49 direct_output_for_insert,
50 direct_forward_char (dispnew.c)
51 +---------------------------------+
54 +--------------+ redisplay +----------------+
55 | Lisp machine |---------------->| Redisplay code |<--+
56 +--------------+ (xdisp.c) +----------------+ |
58 +----------------------------------+ |
59 Don't use this path when called |
62 expose_window (asynchronous) |
64 X expose events -----+
66 What does redisplay do? Obviously, it has to figure out somehow what
67 has been changed since the last time the display has been updated,
68 and to make these changes visible. Preferably it would do that in
69 a moderately intelligent way, i.e. fast.
71 Changes in buffer text can be deduced from window and buffer
72 structures, and from some global variables like `beg_unchanged' and
73 `end_unchanged'. The contents of the display are additionally
74 recorded in a `glyph matrix', a two-dimensional matrix of glyph
75 structures. Each row in such a matrix corresponds to a line on the
76 display, and each glyph in a row corresponds to a column displaying
77 a character, an image, or what else. This matrix is called the
78 `current glyph matrix' or `current matrix' in redisplay
81 For buffer parts that have been changed since the last update, a
82 second glyph matrix is constructed, the so called `desired glyph
83 matrix' or short `desired matrix'. Current and desired matrix are
84 then compared to find a cheap way to update the display, e.g. by
85 reusing part of the display by scrolling lines.
90 You will find a lot of redisplay optimizations when you start
91 looking at the innards of redisplay. The overall goal of all these
92 optimizations is to make redisplay fast because it is done
95 Two optimizations are not found in xdisp.c. These are the direct
96 operations mentioned above. As the name suggests they follow a
97 different principle than the rest of redisplay. Instead of
98 building a desired matrix and then comparing it with the current
99 display, they perform their actions directly on the display and on
102 One direct operation updates the display after one character has
103 been entered. The other one moves the cursor by one position
104 forward or backward. You find these functions under the names
105 `direct_output_for_insert' and `direct_output_forward_char' in
111 Desired matrices are always built per Emacs window. The function
112 `display_line' is the central function to look at if you are
113 interested. It constructs one row in a desired matrix given an
114 iterator structure containing both a buffer position and a
115 description of the environment in which the text is to be
116 displayed. But this is too early, read on.
118 Characters and pixmaps displayed for a range of buffer text depend
119 on various settings of buffers and windows, on overlays and text
120 properties, on display tables, on selective display. The good news
121 is that all this hairy stuff is hidden behind a small set of
122 interface functions taking an iterator structure (struct it)
125 Iteration over things to be displayed is then simple. It is
126 started by initializing an iterator with a call to init_iterator.
127 Calls to get_next_display_element fill the iterator structure with
128 relevant information about the next thing to display. Calls to
129 set_iterator_to_next move the iterator to the next thing.
131 Besides this, an iterator also contains information about the
132 display environment in which glyphs for display elements are to be
133 produced. It has fields for the width and height of the display,
134 the information whether long lines are truncated or continued, a
135 current X and Y position, and lots of other stuff you can better
138 Glyphs in a desired matrix are normally constructed in a loop
139 calling get_next_display_element and then produce_glyphs. The call
140 to produce_glyphs will fill the iterator structure with pixel
141 information about the element being displayed and at the same time
142 produce glyphs for it. If the display element fits on the line
143 being displayed, set_iterator_to_next is called next, otherwise the
144 glyphs produced are discarded.
149 That just couldn't be all, could it? What about terminal types not
150 supporting operations on sub-windows of the screen? To update the
151 display on such a terminal, window-based glyph matrices are not
152 well suited. To be able to reuse part of the display (scrolling
153 lines up and down), we must instead have a view of the whole
154 screen. This is what `frame matrices' are for. They are a trick.
156 Frames on terminals like above have a glyph pool. Windows on such
157 a frame sub-allocate their glyph memory from their frame's glyph
158 pool. The frame itself is given its own glyph matrices. By
159 coincidence---or maybe something else---rows in window glyph
160 matrices are slices of corresponding rows in frame matrices. Thus
161 writing to window matrices implicitly updates a frame matrix which
162 provides us with the view of the whole screen that we originally
163 wanted to have without having to move many bytes around. To be
164 honest, there is a little bit more done, but not much more. If you
165 plan to extend that code, take a look at dispnew.c. The function
166 build_frame_matrix is a good starting point. */
172 #include "keyboard.h"
175 #include "termchar.h"
176 #include "dispextern.h"
178 #include "character.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
205 #ifndef FRAME_X_OUTPUT
206 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
209 #define INFINITY 10000000
211 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
213 extern void set_frame_menubar
P_ ((struct frame
*f
, int, int));
214 extern int pending_menu_activation
;
217 extern int interrupt_input
;
218 extern int command_loop_level
;
220 extern Lisp_Object do_mouse_tracking
;
222 extern int minibuffer_auto_raise
;
223 extern Lisp_Object Vminibuffer_list
;
225 extern Lisp_Object Qface
;
226 extern Lisp_Object Qmode_line
, Qmode_line_inactive
, Qheader_line
;
228 extern Lisp_Object Voverriding_local_map
;
229 extern Lisp_Object Voverriding_local_map_menu_flag
;
230 extern Lisp_Object Qmenu_item
;
231 extern Lisp_Object Qwhen
;
232 extern Lisp_Object Qhelp_echo
;
234 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
235 Lisp_Object Qwindow_scroll_functions
, Vwindow_scroll_functions
;
236 Lisp_Object Qwindow_text_change_functions
, Vwindow_text_change_functions
;
237 Lisp_Object Qredisplay_end_trigger_functions
, Vredisplay_end_trigger_functions
;
238 Lisp_Object Qinhibit_point_motion_hooks
;
239 Lisp_Object QCeval
, QCfile
, QCdata
, QCpropertize
;
240 Lisp_Object Qfontified
;
241 Lisp_Object Qgrow_only
;
242 Lisp_Object Qinhibit_eval_during_redisplay
;
243 Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
246 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
249 Lisp_Object Qarrow
, Qhand
, Qtext
;
251 Lisp_Object Qrisky_local_variable
;
253 /* Holds the list (error). */
254 Lisp_Object list_of_error
;
256 /* Functions called to fontify regions of text. */
258 Lisp_Object Vfontification_functions
;
259 Lisp_Object Qfontification_functions
;
261 /* Non-nil means automatically select any window when the mouse
262 cursor moves into it. */
263 Lisp_Object Vmouse_autoselect_window
;
265 Lisp_Object Vwrap_prefix
, Qwrap_prefix
;
266 Lisp_Object Vline_prefix
, Qline_prefix
;
268 /* Non-zero means draw tool bar buttons raised when the mouse moves
271 int auto_raise_tool_bar_buttons_p
;
273 /* Non-zero means to reposition window if cursor line is only partially visible. */
275 int make_cursor_line_fully_visible_p
;
277 /* Margin below tool bar in pixels. 0 or nil means no margin.
278 If value is `internal-border-width' or `border-width',
279 the corresponding frame parameter is used. */
281 Lisp_Object Vtool_bar_border
;
283 /* Margin around tool bar buttons in pixels. */
285 Lisp_Object Vtool_bar_button_margin
;
287 /* Thickness of shadow to draw around tool bar buttons. */
289 EMACS_INT tool_bar_button_relief
;
291 /* Non-nil means automatically resize tool-bars so that all tool-bar
292 items are visible, and no blank lines remain.
294 If value is `grow-only', only make tool-bar bigger. */
296 Lisp_Object Vauto_resize_tool_bars
;
298 /* Non-zero means draw block and hollow cursor as wide as the glyph
299 under it. For example, if a block cursor is over a tab, it will be
300 drawn as wide as that tab on the display. */
302 int x_stretch_cursor_p
;
304 /* Non-nil means don't actually do any redisplay. */
306 Lisp_Object Vinhibit_redisplay
, Qinhibit_redisplay
;
308 /* Non-zero means Lisp evaluation during redisplay is inhibited. */
310 int inhibit_eval_during_redisplay
;
312 /* Names of text properties relevant for redisplay. */
314 Lisp_Object Qdisplay
;
315 extern Lisp_Object Qface
, Qinvisible
, Qwidth
;
317 /* Symbols used in text property values. */
319 Lisp_Object Vdisplay_pixels_per_inch
;
320 Lisp_Object Qspace
, QCalign_to
, QCrelative_width
, QCrelative_height
;
321 Lisp_Object Qleft_margin
, Qright_margin
, Qspace_width
, Qraise
;
324 Lisp_Object Qmargin
, Qpointer
;
325 Lisp_Object Qline_height
;
326 extern Lisp_Object Qheight
;
327 extern Lisp_Object QCwidth
, QCheight
, QCascent
;
328 extern Lisp_Object Qscroll_bar
;
329 extern Lisp_Object Qcursor
;
331 /* Non-nil means highlight trailing whitespace. */
333 Lisp_Object Vshow_trailing_whitespace
;
335 /* Non-nil means escape non-break space and hyphens. */
337 Lisp_Object Vnobreak_char_display
;
339 #ifdef HAVE_WINDOW_SYSTEM
340 extern Lisp_Object Voverflow_newline_into_fringe
;
342 /* Test if overflow newline into fringe. Called with iterator IT
343 at or past right window margin, and with IT->current_x set. */
345 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) \
346 (!NILP (Voverflow_newline_into_fringe) \
347 && FRAME_WINDOW_P (it->f) \
348 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) > 0 \
349 && it->current_x == it->last_visible_x)
351 #endif /* HAVE_WINDOW_SYSTEM */
353 /* Non-nil means show the text cursor in void text areas
354 i.e. in blank areas after eol and eob. This used to be
355 the default in 21.3. */
357 Lisp_Object Vvoid_text_area_pointer
;
359 /* Name of the face used to highlight trailing whitespace. */
361 Lisp_Object Qtrailing_whitespace
;
363 /* Name and number of the face used to highlight escape glyphs. */
365 Lisp_Object Qescape_glyph
;
367 /* Name and number of the face used to highlight non-breaking spaces. */
369 Lisp_Object Qnobreak_space
;
371 /* The symbol `image' which is the car of the lists used to represent
376 /* The image map types. */
377 Lisp_Object QCmap
, QCpointer
;
378 Lisp_Object Qrect
, Qcircle
, Qpoly
;
380 /* Non-zero means print newline to stdout before next mini-buffer
383 int noninteractive_need_newline
;
385 /* Non-zero means print newline to message log before next message. */
387 static int message_log_need_newline
;
389 /* Three markers that message_dolog uses.
390 It could allocate them itself, but that causes trouble
391 in handling memory-full errors. */
392 static Lisp_Object message_dolog_marker1
;
393 static Lisp_Object message_dolog_marker2
;
394 static Lisp_Object message_dolog_marker3
;
396 /* The buffer position of the first character appearing entirely or
397 partially on the line of the selected window which contains the
398 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
399 redisplay optimization in redisplay_internal. */
401 static struct text_pos this_line_start_pos
;
403 /* Number of characters past the end of the line above, including the
404 terminating newline. */
406 static struct text_pos this_line_end_pos
;
408 /* The vertical positions and the height of this line. */
410 static int this_line_vpos
;
411 static int this_line_y
;
412 static int this_line_pixel_height
;
414 /* X position at which this display line starts. Usually zero;
415 negative if first character is partially visible. */
417 static int this_line_start_x
;
419 /* Buffer that this_line_.* variables are referring to. */
421 static struct buffer
*this_line_buffer
;
423 /* Nonzero means truncate lines in all windows less wide than the
426 Lisp_Object Vtruncate_partial_width_windows
;
428 /* A flag to control how to display unibyte 8-bit character. */
430 int unibyte_display_via_language_environment
;
432 /* Nonzero means we have more than one non-mini-buffer-only frame.
433 Not guaranteed to be accurate except while parsing
434 frame-title-format. */
438 Lisp_Object Vglobal_mode_string
;
441 /* List of variables (symbols) which hold markers for overlay arrows.
442 The symbols on this list are examined during redisplay to determine
443 where to display overlay arrows. */
445 Lisp_Object Voverlay_arrow_variable_list
;
447 /* Marker for where to display an arrow on top of the buffer text. */
449 Lisp_Object Voverlay_arrow_position
;
451 /* String to display for the arrow. Only used on terminal frames. */
453 Lisp_Object Voverlay_arrow_string
;
455 /* Values of those variables at last redisplay are stored as
456 properties on `overlay-arrow-position' symbol. However, if
457 Voverlay_arrow_position is a marker, last-arrow-position is its
458 numerical position. */
460 Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
462 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
463 properties on a symbol in overlay-arrow-variable-list. */
465 Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
467 /* Like mode-line-format, but for the title bar on a visible frame. */
469 Lisp_Object Vframe_title_format
;
471 /* Like mode-line-format, but for the title bar on an iconified frame. */
473 Lisp_Object Vicon_title_format
;
475 /* List of functions to call when a window's size changes. These
476 functions get one arg, a frame on which one or more windows' sizes
479 static Lisp_Object Vwindow_size_change_functions
;
481 Lisp_Object Qmenu_bar_update_hook
, Vmenu_bar_update_hook
;
483 /* Nonzero if an overlay arrow has been displayed in this window. */
485 static int overlay_arrow_seen
;
487 /* Nonzero means highlight the region even in nonselected windows. */
489 int highlight_nonselected_windows
;
491 /* If cursor motion alone moves point off frame, try scrolling this
492 many lines up or down if that will bring it back. */
494 static EMACS_INT scroll_step
;
496 /* Nonzero means scroll just far enough to bring point back on the
497 screen, when appropriate. */
499 static EMACS_INT scroll_conservatively
;
501 /* Recenter the window whenever point gets within this many lines of
502 the top or bottom of the window. This value is translated into a
503 pixel value by multiplying it with FRAME_LINE_HEIGHT, which means
504 that there is really a fixed pixel height scroll margin. */
506 EMACS_INT scroll_margin
;
508 /* Number of windows showing the buffer of the selected window (or
509 another buffer with the same base buffer). keyboard.c refers to
514 /* Vector containing glyphs for an ellipsis `...'. */
516 static Lisp_Object default_invis_vector
[3];
518 /* Zero means display the mode-line/header-line/menu-bar in the default face
519 (this slightly odd definition is for compatibility with previous versions
520 of emacs), non-zero means display them using their respective faces.
522 This variable is deprecated. */
524 int mode_line_inverse_video
;
526 /* Prompt to display in front of the mini-buffer contents. */
528 Lisp_Object minibuf_prompt
;
530 /* Width of current mini-buffer prompt. Only set after display_line
531 of the line that contains the prompt. */
533 int minibuf_prompt_width
;
535 /* This is the window where the echo area message was displayed. It
536 is always a mini-buffer window, but it may not be the same window
537 currently active as a mini-buffer. */
539 Lisp_Object echo_area_window
;
541 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
542 pushes the current message and the value of
543 message_enable_multibyte on the stack, the function restore_message
544 pops the stack and displays MESSAGE again. */
546 Lisp_Object Vmessage_stack
;
548 /* Nonzero means multibyte characters were enabled when the echo area
549 message was specified. */
551 int message_enable_multibyte
;
553 /* Nonzero if we should redraw the mode lines on the next redisplay. */
555 int update_mode_lines
;
557 /* Nonzero if window sizes or contents have changed since last
558 redisplay that finished. */
560 int windows_or_buffers_changed
;
562 /* Nonzero means a frame's cursor type has been changed. */
564 int cursor_type_changed
;
566 /* Nonzero after display_mode_line if %l was used and it displayed a
569 int line_number_displayed
;
571 /* Maximum buffer size for which to display line numbers. */
573 Lisp_Object Vline_number_display_limit
;
575 /* Line width to consider when repositioning for line number display. */
577 static EMACS_INT line_number_display_limit_width
;
579 /* Number of lines to keep in the message log buffer. t means
580 infinite. nil means don't log at all. */
582 Lisp_Object Vmessage_log_max
;
584 /* The name of the *Messages* buffer, a string. */
586 static Lisp_Object Vmessages_buffer_name
;
588 /* Current, index 0, and last displayed echo area message. Either
589 buffers from echo_buffers, or nil to indicate no message. */
591 Lisp_Object echo_area_buffer
[2];
593 /* The buffers referenced from echo_area_buffer. */
595 static Lisp_Object echo_buffer
[2];
597 /* A vector saved used in with_area_buffer to reduce consing. */
599 static Lisp_Object Vwith_echo_area_save_vector
;
601 /* Non-zero means display_echo_area should display the last echo area
602 message again. Set by redisplay_preserve_echo_area. */
604 static int display_last_displayed_message_p
;
606 /* Nonzero if echo area is being used by print; zero if being used by
609 int message_buf_print
;
611 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
613 Lisp_Object Qinhibit_menubar_update
;
614 int inhibit_menubar_update
;
616 /* When evaluating expressions from menu bar items (enable conditions,
617 for instance), this is the frame they are being processed for. */
619 Lisp_Object Vmenu_updating_frame
;
621 /* Maximum height for resizing mini-windows. Either a float
622 specifying a fraction of the available height, or an integer
623 specifying a number of lines. */
625 Lisp_Object Vmax_mini_window_height
;
627 /* Non-zero means messages should be displayed with truncated
628 lines instead of being continued. */
630 int message_truncate_lines
;
631 Lisp_Object Qmessage_truncate_lines
;
633 /* Set to 1 in clear_message to make redisplay_internal aware
634 of an emptied echo area. */
636 static int message_cleared_p
;
638 /* How to blink the default frame cursor off. */
639 Lisp_Object Vblink_cursor_alist
;
641 /* A scratch glyph row with contents used for generating truncation
642 glyphs. Also used in direct_output_for_insert. */
644 #define MAX_SCRATCH_GLYPHS 100
645 struct glyph_row scratch_glyph_row
;
646 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
648 /* Ascent and height of the last line processed by move_it_to. */
650 static int last_max_ascent
, last_height
;
652 /* Non-zero if there's a help-echo in the echo area. */
654 int help_echo_showing_p
;
656 /* If >= 0, computed, exact values of mode-line and header-line height
657 to use in the macros CURRENT_MODE_LINE_HEIGHT and
658 CURRENT_HEADER_LINE_HEIGHT. */
660 int current_mode_line_height
, current_header_line_height
;
662 /* The maximum distance to look ahead for text properties. Values
663 that are too small let us call compute_char_face and similar
664 functions too often which is expensive. Values that are too large
665 let us call compute_char_face and alike too often because we
666 might not be interested in text properties that far away. */
668 #define TEXT_PROP_DISTANCE_LIMIT 100
672 /* Variables to turn off display optimizations from Lisp. */
674 int inhibit_try_window_id
, inhibit_try_window_reusing
;
675 int inhibit_try_cursor_movement
;
677 /* Non-zero means print traces of redisplay if compiled with
680 int trace_redisplay_p
;
682 #endif /* GLYPH_DEBUG */
684 #ifdef DEBUG_TRACE_MOVE
685 /* Non-zero means trace with TRACE_MOVE to stderr. */
688 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
690 #define TRACE_MOVE(x) (void) 0
693 /* Non-zero means automatically scroll windows horizontally to make
696 int automatic_hscrolling_p
;
697 Lisp_Object Qauto_hscroll_mode
;
699 /* How close to the margin can point get before the window is scrolled
701 EMACS_INT hscroll_margin
;
703 /* How much to scroll horizontally when point is inside the above margin. */
704 Lisp_Object Vhscroll_step
;
706 /* The variable `resize-mini-windows'. If nil, don't resize
707 mini-windows. If t, always resize them to fit the text they
708 display. If `grow-only', let mini-windows grow only until they
711 Lisp_Object Vresize_mini_windows
;
713 /* Buffer being redisplayed -- for redisplay_window_error. */
715 struct buffer
*displayed_buffer
;
717 /* Space between overline and text. */
719 EMACS_INT overline_margin
;
721 /* Require underline to be at least this many screen pixels below baseline
722 This to avoid underline "merging" with the base of letters at small
723 font sizes, particularly when x_use_underline_position_properties is on. */
725 EMACS_INT underline_minimum_offset
;
727 /* Value returned from text property handlers (see below). */
732 HANDLED_RECOMPUTE_PROPS
,
733 HANDLED_OVERLAY_STRING_CONSUMED
,
737 /* A description of text properties that redisplay is interested
742 /* The name of the property. */
745 /* A unique index for the property. */
748 /* A handler function called to set up iterator IT from the property
749 at IT's current position. Value is used to steer handle_stop. */
750 enum prop_handled (*handler
) P_ ((struct it
*it
));
753 static enum prop_handled handle_face_prop
P_ ((struct it
*));
754 static enum prop_handled handle_invisible_prop
P_ ((struct it
*));
755 static enum prop_handled handle_display_prop
P_ ((struct it
*));
756 static enum prop_handled handle_composition_prop
P_ ((struct it
*));
757 static enum prop_handled handle_overlay_change
P_ ((struct it
*));
758 static enum prop_handled handle_fontified_prop
P_ ((struct it
*));
759 static enum prop_handled handle_auto_composed_prop
P_ ((struct it
*));
761 /* Properties handled by iterators. */
763 static struct props it_props
[] =
765 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
766 /* Handle `face' before `display' because some sub-properties of
767 `display' need to know the face. */
768 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
769 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
770 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
771 {&Qauto_composed
, AUTO_COMPOSED_PROP_IDX
, handle_auto_composed_prop
},
772 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
776 /* Value is the position described by X. If X is a marker, value is
777 the marker_position of X. Otherwise, value is X. */
779 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
781 /* Enumeration returned by some move_it_.* functions internally. */
785 /* Not used. Undefined value. */
788 /* Move ended at the requested buffer position or ZV. */
789 MOVE_POS_MATCH_OR_ZV
,
791 /* Move ended at the requested X pixel position. */
794 /* Move within a line ended at the end of a line that must be
798 /* Move within a line ended at the end of a line that would
799 be displayed truncated. */
802 /* Move within a line ended at a line end. */
806 /* This counter is used to clear the face cache every once in a while
807 in redisplay_internal. It is incremented for each redisplay.
808 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
811 #define CLEAR_FACE_CACHE_COUNT 500
812 static int clear_face_cache_count
;
814 /* Similarly for the image cache. */
816 #ifdef HAVE_WINDOW_SYSTEM
817 #define CLEAR_IMAGE_CACHE_COUNT 101
818 static int clear_image_cache_count
;
821 /* Non-zero while redisplay_internal is in progress. */
825 /* Non-zero means don't free realized faces. Bound while freeing
826 realized faces is dangerous because glyph matrices might still
829 int inhibit_free_realized_faces
;
830 Lisp_Object Qinhibit_free_realized_faces
;
832 /* If a string, XTread_socket generates an event to display that string.
833 (The display is done in read_char.) */
835 Lisp_Object help_echo_string
;
836 Lisp_Object help_echo_window
;
837 Lisp_Object help_echo_object
;
840 /* Temporary variable for XTread_socket. */
842 Lisp_Object previous_help_echo_string
;
844 /* Null glyph slice */
846 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
849 /* Function prototypes. */
851 static void setup_for_ellipsis
P_ ((struct it
*, int));
852 static void mark_window_display_accurate_1
P_ ((struct window
*, int));
853 static int single_display_spec_string_p
P_ ((Lisp_Object
, Lisp_Object
));
854 static int display_prop_string_p
P_ ((Lisp_Object
, Lisp_Object
));
855 static int cursor_row_p
P_ ((struct window
*, struct glyph_row
*));
856 static int redisplay_mode_lines
P_ ((Lisp_Object
, int));
857 static char *decode_mode_spec_coding
P_ ((Lisp_Object
, char *, int));
859 static Lisp_Object get_it_property
P_ ((struct it
*it
, Lisp_Object prop
));
861 static void handle_line_prefix
P_ ((struct it
*));
864 static int invisible_text_between_p
P_ ((struct it
*, int, int));
867 static void pint2str
P_ ((char *, int, int));
868 static void pint2hrstr
P_ ((char *, int, int));
869 static struct text_pos run_window_scroll_functions
P_ ((Lisp_Object
,
871 static void reconsider_clip_changes
P_ ((struct window
*, struct buffer
*));
872 static int text_outside_line_unchanged_p
P_ ((struct window
*, int, int));
873 static void store_mode_line_noprop_char
P_ ((char));
874 static int store_mode_line_noprop
P_ ((const unsigned char *, int, int));
875 static void x_consider_frame_title
P_ ((Lisp_Object
));
876 static void handle_stop
P_ ((struct it
*));
877 static int tool_bar_lines_needed
P_ ((struct frame
*, int *));
878 static int single_display_spec_intangible_p
P_ ((Lisp_Object
));
879 static void ensure_echo_area_buffers
P_ ((void));
880 static Lisp_Object unwind_with_echo_area_buffer
P_ ((Lisp_Object
));
881 static Lisp_Object with_echo_area_buffer_unwind_data
P_ ((struct window
*));
882 static int with_echo_area_buffer
P_ ((struct window
*, int,
883 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
884 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
885 static void clear_garbaged_frames
P_ ((void));
886 static int current_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
887 static int truncate_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
888 static int set_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
889 static int display_echo_area
P_ ((struct window
*));
890 static int display_echo_area_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
891 static int resize_mini_window_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
892 static Lisp_Object unwind_redisplay
P_ ((Lisp_Object
));
893 static int string_char_and_length
P_ ((const unsigned char *, int, int *));
894 static struct text_pos display_prop_end
P_ ((struct it
*, Lisp_Object
,
896 static int compute_window_start_on_continuation_line
P_ ((struct window
*));
897 static Lisp_Object safe_eval_handler
P_ ((Lisp_Object
));
898 static void insert_left_trunc_glyphs
P_ ((struct it
*));
899 static struct glyph_row
*get_overlay_arrow_glyph_row
P_ ((struct window
*,
901 static void extend_face_to_end_of_line
P_ ((struct it
*));
902 static int append_space_for_newline
P_ ((struct it
*, int));
903 static int cursor_row_fully_visible_p
P_ ((struct window
*, int, int));
904 static int try_scrolling
P_ ((Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int));
905 static int try_cursor_movement
P_ ((Lisp_Object
, struct text_pos
, int *));
906 static int trailing_whitespace_p
P_ ((int));
907 static int message_log_check_duplicate
P_ ((int, int, int, int));
908 static void push_it
P_ ((struct it
*));
909 static void pop_it
P_ ((struct it
*));
910 static void sync_frame_with_window_matrix_rows
P_ ((struct window
*));
911 static void select_frame_for_redisplay
P_ ((Lisp_Object
));
912 static void redisplay_internal
P_ ((int));
913 static int echo_area_display
P_ ((int));
914 static void redisplay_windows
P_ ((Lisp_Object
));
915 static void redisplay_window
P_ ((Lisp_Object
, int));
916 static Lisp_Object
redisplay_window_error ();
917 static Lisp_Object redisplay_window_0
P_ ((Lisp_Object
));
918 static Lisp_Object redisplay_window_1
P_ ((Lisp_Object
));
919 static int update_menu_bar
P_ ((struct frame
*, int, int));
920 static int try_window_reusing_current_matrix
P_ ((struct window
*));
921 static int try_window_id
P_ ((struct window
*));
922 static int display_line
P_ ((struct it
*));
923 static int display_mode_lines
P_ ((struct window
*));
924 static int display_mode_line
P_ ((struct window
*, enum face_id
, Lisp_Object
));
925 static int display_mode_element
P_ ((struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int));
926 static int store_mode_line_string
P_ ((char *, Lisp_Object
, int, int, int, Lisp_Object
));
927 static char *decode_mode_spec
P_ ((struct window
*, int, int, int, int *));
928 static void display_menu_bar
P_ ((struct window
*));
929 static int display_count_lines
P_ ((int, int, int, int, int *));
930 static int display_string
P_ ((unsigned char *, Lisp_Object
, Lisp_Object
,
931 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int));
932 static void compute_line_metrics
P_ ((struct it
*));
933 static void run_redisplay_end_trigger_hook
P_ ((struct it
*));
934 static int get_overlay_strings
P_ ((struct it
*, int));
935 static int get_overlay_strings_1
P_ ((struct it
*, int, int));
936 static void next_overlay_string
P_ ((struct it
*));
937 static void reseat
P_ ((struct it
*, struct text_pos
, int));
938 static void reseat_1
P_ ((struct it
*, struct text_pos
, int));
939 static void back_to_previous_visible_line_start
P_ ((struct it
*));
940 void reseat_at_previous_visible_line_start
P_ ((struct it
*));
941 static void reseat_at_next_visible_line_start
P_ ((struct it
*, int));
942 static int next_element_from_ellipsis
P_ ((struct it
*));
943 static int next_element_from_display_vector
P_ ((struct it
*));
944 static int next_element_from_string
P_ ((struct it
*));
945 static int next_element_from_c_string
P_ ((struct it
*));
946 static int next_element_from_buffer
P_ ((struct it
*));
947 static int next_element_from_composition
P_ ((struct it
*));
948 static int next_element_from_image
P_ ((struct it
*));
949 static int next_element_from_stretch
P_ ((struct it
*));
950 static void load_overlay_strings
P_ ((struct it
*, int));
951 static int init_from_display_pos
P_ ((struct it
*, struct window
*,
952 struct display_pos
*));
953 static void reseat_to_string
P_ ((struct it
*, unsigned char *,
954 Lisp_Object
, int, int, int, int));
955 static enum move_it_result
956 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
957 enum move_operation_enum
);
958 void move_it_vertically_backward
P_ ((struct it
*, int));
959 static void init_to_row_start
P_ ((struct it
*, struct window
*,
960 struct glyph_row
*));
961 static int init_to_row_end
P_ ((struct it
*, struct window
*,
962 struct glyph_row
*));
963 static void back_to_previous_line_start
P_ ((struct it
*));
964 static int forward_to_next_line_start
P_ ((struct it
*, int *));
965 static struct text_pos string_pos_nchars_ahead
P_ ((struct text_pos
,
967 static struct text_pos string_pos
P_ ((int, Lisp_Object
));
968 static struct text_pos c_string_pos
P_ ((int, unsigned char *, int));
969 static int number_of_chars
P_ ((unsigned char *, int));
970 static void compute_stop_pos
P_ ((struct it
*));
971 static void compute_string_pos
P_ ((struct text_pos
*, struct text_pos
,
973 static int face_before_or_after_it_pos
P_ ((struct it
*, int));
974 static EMACS_INT next_overlay_change
P_ ((EMACS_INT
));
975 static int handle_single_display_spec
P_ ((struct it
*, Lisp_Object
,
976 Lisp_Object
, Lisp_Object
,
977 struct text_pos
*, int));
978 static int underlying_face_id
P_ ((struct it
*));
979 static int in_ellipses_for_invisible_text_p
P_ ((struct display_pos
*,
982 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
983 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
985 #ifdef HAVE_WINDOW_SYSTEM
987 static void update_tool_bar
P_ ((struct frame
*, int));
988 static void build_desired_tool_bar_string
P_ ((struct frame
*f
));
989 static int redisplay_tool_bar
P_ ((struct frame
*));
990 static void display_tool_bar_line
P_ ((struct it
*, int));
991 static void notice_overwritten_cursor
P_ ((struct window
*,
993 int, int, int, int));
997 #endif /* HAVE_WINDOW_SYSTEM */
1000 /***********************************************************************
1001 Window display dimensions
1002 ***********************************************************************/
1004 /* Return the bottom boundary y-position for text lines in window W.
1005 This is the first y position at which a line cannot start.
1006 It is relative to the top of the window.
1008 This is the height of W minus the height of a mode line, if any. */
1011 window_text_bottom_y (w
)
1014 int height
= WINDOW_TOTAL_HEIGHT (w
);
1016 if (WINDOW_WANTS_MODELINE_P (w
))
1017 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
1021 /* Return the pixel width of display area AREA of window W. AREA < 0
1022 means return the total width of W, not including fringes to
1023 the left and right of the window. */
1026 window_box_width (w
, area
)
1030 int cols
= XFASTINT (w
->total_cols
);
1033 if (!w
->pseudo_window_p
)
1035 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
1037 if (area
== TEXT_AREA
)
1039 if (INTEGERP (w
->left_margin_cols
))
1040 cols
-= XFASTINT (w
->left_margin_cols
);
1041 if (INTEGERP (w
->right_margin_cols
))
1042 cols
-= XFASTINT (w
->right_margin_cols
);
1043 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
1045 else if (area
== LEFT_MARGIN_AREA
)
1047 cols
= (INTEGERP (w
->left_margin_cols
)
1048 ? XFASTINT (w
->left_margin_cols
) : 0);
1051 else if (area
== RIGHT_MARGIN_AREA
)
1053 cols
= (INTEGERP (w
->right_margin_cols
)
1054 ? XFASTINT (w
->right_margin_cols
) : 0);
1059 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1063 /* Return the pixel height of the display area of window W, not
1064 including mode lines of W, if any. */
1067 window_box_height (w
)
1070 struct frame
*f
= XFRAME (w
->frame
);
1071 int height
= WINDOW_TOTAL_HEIGHT (w
);
1073 xassert (height
>= 0);
1075 /* Note: the code below that determines the mode-line/header-line
1076 height is essentially the same as that contained in the macro
1077 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1078 the appropriate glyph row has its `mode_line_p' flag set,
1079 and if it doesn't, uses estimate_mode_line_height instead. */
1081 if (WINDOW_WANTS_MODELINE_P (w
))
1083 struct glyph_row
*ml_row
1084 = (w
->current_matrix
&& w
->current_matrix
->rows
1085 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1087 if (ml_row
&& ml_row
->mode_line_p
)
1088 height
-= ml_row
->height
;
1090 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1093 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1095 struct glyph_row
*hl_row
1096 = (w
->current_matrix
&& w
->current_matrix
->rows
1097 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1099 if (hl_row
&& hl_row
->mode_line_p
)
1100 height
-= hl_row
->height
;
1102 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1105 /* With a very small font and a mode-line that's taller than
1106 default, we might end up with a negative height. */
1107 return max (0, height
);
1110 /* Return the window-relative coordinate of the left edge of display
1111 area AREA of window W. AREA < 0 means return the left edge of the
1112 whole window, to the right of the left fringe of W. */
1115 window_box_left_offset (w
, area
)
1121 if (w
->pseudo_window_p
)
1124 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1126 if (area
== TEXT_AREA
)
1127 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1128 + window_box_width (w
, LEFT_MARGIN_AREA
));
1129 else if (area
== RIGHT_MARGIN_AREA
)
1130 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1131 + window_box_width (w
, LEFT_MARGIN_AREA
)
1132 + window_box_width (w
, TEXT_AREA
)
1133 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1135 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1136 else if (area
== LEFT_MARGIN_AREA
1137 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1138 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1144 /* Return the window-relative coordinate of the right edge of display
1145 area AREA of window W. AREA < 0 means return the left edge of the
1146 whole window, to the left of the right fringe of W. */
1149 window_box_right_offset (w
, area
)
1153 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1156 /* Return the frame-relative coordinate of the left edge of display
1157 area AREA of window W. AREA < 0 means return the left edge of the
1158 whole window, to the right of the left fringe of W. */
1161 window_box_left (w
, area
)
1165 struct frame
*f
= XFRAME (w
->frame
);
1168 if (w
->pseudo_window_p
)
1169 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1171 x
= (WINDOW_LEFT_EDGE_X (w
)
1172 + window_box_left_offset (w
, area
));
1178 /* Return the frame-relative coordinate of the right edge of display
1179 area AREA of window W. AREA < 0 means return the left edge of the
1180 whole window, to the left of the right fringe of W. */
1183 window_box_right (w
, area
)
1187 return window_box_left (w
, area
) + window_box_width (w
, area
);
1190 /* Get the bounding box of the display area AREA of window W, without
1191 mode lines, in frame-relative coordinates. AREA < 0 means the
1192 whole window, not including the left and right fringes of
1193 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1194 coordinates of the upper-left corner of the box. Return in
1195 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1198 window_box (w
, area
, box_x
, box_y
, box_width
, box_height
)
1201 int *box_x
, *box_y
, *box_width
, *box_height
;
1204 *box_width
= window_box_width (w
, area
);
1206 *box_height
= window_box_height (w
);
1208 *box_x
= window_box_left (w
, area
);
1211 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1212 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1213 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1218 /* Get the bounding box of the display area AREA of window W, without
1219 mode lines. AREA < 0 means the whole window, not including the
1220 left and right fringe of the window. Return in *TOP_LEFT_X
1221 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1222 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1223 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1227 window_box_edges (w
, area
, top_left_x
, top_left_y
,
1228 bottom_right_x
, bottom_right_y
)
1231 int *top_left_x
, *top_left_y
, *bottom_right_x
, *bottom_right_y
;
1233 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1235 *bottom_right_x
+= *top_left_x
;
1236 *bottom_right_y
+= *top_left_y
;
1241 /***********************************************************************
1243 ***********************************************************************/
1245 /* Return the bottom y-position of the line the iterator IT is in.
1246 This can modify IT's settings. */
1252 int line_height
= it
->max_ascent
+ it
->max_descent
;
1253 int line_top_y
= it
->current_y
;
1255 if (line_height
== 0)
1258 line_height
= last_height
;
1259 else if (IT_CHARPOS (*it
) < ZV
)
1261 move_it_by_lines (it
, 1, 1);
1262 line_height
= (it
->max_ascent
|| it
->max_descent
1263 ? it
->max_ascent
+ it
->max_descent
1268 struct glyph_row
*row
= it
->glyph_row
;
1270 /* Use the default character height. */
1271 it
->glyph_row
= NULL
;
1272 it
->what
= IT_CHARACTER
;
1275 PRODUCE_GLYPHS (it
);
1276 line_height
= it
->ascent
+ it
->descent
;
1277 it
->glyph_row
= row
;
1281 return line_top_y
+ line_height
;
1285 /* Return 1 if position CHARPOS is visible in window W.
1286 CHARPOS < 0 means return info about WINDOW_END position.
1287 If visible, set *X and *Y to pixel coordinates of top left corner.
1288 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1289 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1292 pos_visible_p (w
, charpos
, x
, y
, rtop
, rbot
, rowh
, vpos
)
1294 int charpos
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
;
1297 struct text_pos top
;
1299 struct buffer
*old_buffer
= NULL
;
1304 if (XBUFFER (w
->buffer
) != current_buffer
)
1306 old_buffer
= current_buffer
;
1307 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1310 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1312 /* Compute exact mode line heights. */
1313 if (WINDOW_WANTS_MODELINE_P (w
))
1314 current_mode_line_height
1315 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1316 current_buffer
->mode_line_format
);
1318 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1319 current_header_line_height
1320 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1321 current_buffer
->header_line_format
);
1323 start_display (&it
, w
, top
);
1324 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1325 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1327 /* Note that we may overshoot because of invisible text. */
1328 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1330 int top_x
= it
.current_x
;
1331 int top_y
= it
.current_y
;
1332 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1333 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1335 if (top_y
< window_top_y
)
1336 visible_p
= bottom_y
> window_top_y
;
1337 else if (top_y
< it
.last_visible_y
)
1341 if (it
.method
== GET_FROM_BUFFER
)
1343 Lisp_Object window
, prop
;
1345 XSETWINDOW (window
, w
);
1346 prop
= Fget_char_property (make_number (it
.position
.charpos
),
1347 Qinvisible
, window
);
1349 /* If charpos coincides with invisible text covered with an
1350 ellipsis, use the first glyph of the ellipsis to compute
1351 the pixel positions. */
1352 if (TEXT_PROP_MEANS_INVISIBLE (prop
) == 2)
1354 struct glyph_row
*row
= it
.glyph_row
;
1355 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1356 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1359 for (; glyph
< end
&& glyph
->charpos
< charpos
; glyph
++)
1360 x
+= glyph
->pixel_width
;
1367 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1368 *rtop
= max (0, window_top_y
- top_y
);
1369 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1370 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1371 - max (top_y
, window_top_y
)));
1380 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1381 move_it_by_lines (&it
, 1, 0);
1382 if (charpos
< IT_CHARPOS (it
)
1383 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1386 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1388 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1389 *rtop
= max (0, -it2
.current_y
);
1390 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1391 - it
.last_visible_y
));
1392 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1394 - max (it2
.current_y
,
1395 WINDOW_HEADER_LINE_HEIGHT (w
))));
1401 set_buffer_internal_1 (old_buffer
);
1403 current_header_line_height
= current_mode_line_height
= -1;
1405 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1406 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1409 /* Debugging code. */
1411 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1412 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1414 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1421 /* Return the next character from STR which is MAXLEN bytes long.
1422 Return in *LEN the length of the character. This is like
1423 STRING_CHAR_AND_LENGTH but never returns an invalid character. If
1424 we find one, we return a `?', but with the length of the invalid
1428 string_char_and_length (str
, maxlen
, len
)
1429 const unsigned char *str
;
1434 c
= STRING_CHAR_AND_LENGTH (str
, maxlen
, *len
);
1435 if (!CHAR_VALID_P (c
, 1))
1436 /* We may not change the length here because other places in Emacs
1437 don't use this function, i.e. they silently accept invalid
1446 /* Given a position POS containing a valid character and byte position
1447 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1449 static struct text_pos
1450 string_pos_nchars_ahead (pos
, string
, nchars
)
1451 struct text_pos pos
;
1455 xassert (STRINGP (string
) && nchars
>= 0);
1457 if (STRING_MULTIBYTE (string
))
1459 int rest
= SBYTES (string
) - BYTEPOS (pos
);
1460 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1465 string_char_and_length (p
, rest
, &len
);
1466 p
+= len
, rest
-= len
;
1467 xassert (rest
>= 0);
1469 BYTEPOS (pos
) += len
;
1473 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1479 /* Value is the text position, i.e. character and byte position,
1480 for character position CHARPOS in STRING. */
1482 static INLINE
struct text_pos
1483 string_pos (charpos
, string
)
1487 struct text_pos pos
;
1488 xassert (STRINGP (string
));
1489 xassert (charpos
>= 0);
1490 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1495 /* Value is a text position, i.e. character and byte position, for
1496 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1497 means recognize multibyte characters. */
1499 static struct text_pos
1500 c_string_pos (charpos
, s
, multibyte_p
)
1505 struct text_pos pos
;
1507 xassert (s
!= NULL
);
1508 xassert (charpos
>= 0);
1512 int rest
= strlen (s
), len
;
1514 SET_TEXT_POS (pos
, 0, 0);
1517 string_char_and_length (s
, rest
, &len
);
1518 s
+= len
, rest
-= len
;
1519 xassert (rest
>= 0);
1521 BYTEPOS (pos
) += len
;
1525 SET_TEXT_POS (pos
, charpos
, charpos
);
1531 /* Value is the number of characters in C string S. MULTIBYTE_P
1532 non-zero means recognize multibyte characters. */
1535 number_of_chars (s
, multibyte_p
)
1543 int rest
= strlen (s
), len
;
1544 unsigned char *p
= (unsigned char *) s
;
1546 for (nchars
= 0; rest
> 0; ++nchars
)
1548 string_char_and_length (p
, rest
, &len
);
1549 rest
-= len
, p
+= len
;
1553 nchars
= strlen (s
);
1559 /* Compute byte position NEWPOS->bytepos corresponding to
1560 NEWPOS->charpos. POS is a known position in string STRING.
1561 NEWPOS->charpos must be >= POS.charpos. */
1564 compute_string_pos (newpos
, pos
, string
)
1565 struct text_pos
*newpos
, pos
;
1568 xassert (STRINGP (string
));
1569 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1571 if (STRING_MULTIBYTE (string
))
1572 *newpos
= string_pos_nchars_ahead (pos
, string
,
1573 CHARPOS (*newpos
) - CHARPOS (pos
));
1575 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1579 Return an estimation of the pixel height of mode or top lines on
1580 frame F. FACE_ID specifies what line's height to estimate. */
1583 estimate_mode_line_height (f
, face_id
)
1585 enum face_id face_id
;
1587 #ifdef HAVE_WINDOW_SYSTEM
1588 if (FRAME_WINDOW_P (f
))
1590 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1592 /* This function is called so early when Emacs starts that the face
1593 cache and mode line face are not yet initialized. */
1594 if (FRAME_FACE_CACHE (f
))
1596 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1600 height
= FONT_HEIGHT (face
->font
);
1601 if (face
->box_line_width
> 0)
1602 height
+= 2 * face
->box_line_width
;
1613 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1614 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1615 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1616 not force the value into range. */
1619 pixel_to_glyph_coords (f
, pix_x
, pix_y
, x
, y
, bounds
, noclip
)
1621 register int pix_x
, pix_y
;
1623 NativeRectangle
*bounds
;
1627 #ifdef HAVE_WINDOW_SYSTEM
1628 if (FRAME_WINDOW_P (f
))
1630 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1631 even for negative values. */
1633 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1635 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1637 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1638 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1641 STORE_NATIVE_RECT (*bounds
,
1642 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1643 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1644 FRAME_COLUMN_WIDTH (f
) - 1,
1645 FRAME_LINE_HEIGHT (f
) - 1);
1651 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1652 pix_x
= FRAME_TOTAL_COLS (f
);
1656 else if (pix_y
> FRAME_LINES (f
))
1657 pix_y
= FRAME_LINES (f
);
1667 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1668 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1669 can't tell the positions because W's display is not up to date,
1673 glyph_to_pixel_coords (w
, hpos
, vpos
, frame_x
, frame_y
)
1676 int *frame_x
, *frame_y
;
1678 #ifdef HAVE_WINDOW_SYSTEM
1679 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1683 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1684 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1686 if (display_completed
)
1688 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1689 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1690 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1696 hpos
+= glyph
->pixel_width
;
1700 /* If first glyph is partially visible, its first visible position is still 0. */
1712 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1713 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1724 #ifdef HAVE_WINDOW_SYSTEM
1726 /* Find the glyph under window-relative coordinates X/Y in window W.
1727 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1728 strings. Return in *HPOS and *VPOS the row and column number of
1729 the glyph found. Return in *AREA the glyph area containing X.
1730 Value is a pointer to the glyph found or null if X/Y is not on
1731 text, or we can't tell because W's current matrix is not up to
1738 x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, dx
, dy
, area
)
1741 int *hpos
, *vpos
, *dx
, *dy
, *area
;
1743 struct glyph
*glyph
, *end
;
1744 struct glyph_row
*row
= NULL
;
1747 /* Find row containing Y. Give up if some row is not enabled. */
1748 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1750 row
= MATRIX_ROW (w
->current_matrix
, i
);
1751 if (!row
->enabled_p
)
1753 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1760 /* Give up if Y is not in the window. */
1761 if (i
== w
->current_matrix
->nrows
)
1764 /* Get the glyph area containing X. */
1765 if (w
->pseudo_window_p
)
1772 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1774 *area
= LEFT_MARGIN_AREA
;
1775 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1777 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1780 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1784 *area
= RIGHT_MARGIN_AREA
;
1785 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1789 /* Find glyph containing X. */
1790 glyph
= row
->glyphs
[*area
];
1791 end
= glyph
+ row
->used
[*area
];
1793 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1795 x
-= glyph
->pixel_width
;
1805 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1808 *hpos
= glyph
- row
->glyphs
[*area
];
1814 Convert frame-relative x/y to coordinates relative to window W.
1815 Takes pseudo-windows into account. */
1818 frame_to_window_pixel_xy (w
, x
, y
)
1822 if (w
->pseudo_window_p
)
1824 /* A pseudo-window is always full-width, and starts at the
1825 left edge of the frame, plus a frame border. */
1826 struct frame
*f
= XFRAME (w
->frame
);
1827 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1828 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1832 *x
-= WINDOW_LEFT_EDGE_X (w
);
1833 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1838 Return in RECTS[] at most N clipping rectangles for glyph string S.
1839 Return the number of stored rectangles. */
1842 get_glyph_string_clip_rects (s
, rects
, n
)
1843 struct glyph_string
*s
;
1844 NativeRectangle
*rects
;
1852 if (s
->row
->full_width_p
)
1854 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1855 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1856 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1858 /* Unless displaying a mode or menu bar line, which are always
1859 fully visible, clip to the visible part of the row. */
1860 if (s
->w
->pseudo_window_p
)
1861 r
.height
= s
->row
->visible_height
;
1863 r
.height
= s
->height
;
1867 /* This is a text line that may be partially visible. */
1868 r
.x
= window_box_left (s
->w
, s
->area
);
1869 r
.width
= window_box_width (s
->w
, s
->area
);
1870 r
.height
= s
->row
->visible_height
;
1874 if (r
.x
< s
->clip_head
->x
)
1876 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1877 r
.width
-= s
->clip_head
->x
- r
.x
;
1880 r
.x
= s
->clip_head
->x
;
1883 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1885 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1886 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1891 /* If S draws overlapping rows, it's sufficient to use the top and
1892 bottom of the window for clipping because this glyph string
1893 intentionally draws over other lines. */
1894 if (s
->for_overlaps
)
1896 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1897 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1899 /* Alas, the above simple strategy does not work for the
1900 environments with anti-aliased text: if the same text is
1901 drawn onto the same place multiple times, it gets thicker.
1902 If the overlap we are processing is for the erased cursor, we
1903 take the intersection with the rectagle of the cursor. */
1904 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1906 XRectangle rc
, r_save
= r
;
1908 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1909 rc
.y
= s
->w
->phys_cursor
.y
;
1910 rc
.width
= s
->w
->phys_cursor_width
;
1911 rc
.height
= s
->w
->phys_cursor_height
;
1913 x_intersect_rectangles (&r_save
, &rc
, &r
);
1918 /* Don't use S->y for clipping because it doesn't take partially
1919 visible lines into account. For example, it can be negative for
1920 partially visible lines at the top of a window. */
1921 if (!s
->row
->full_width_p
1922 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1923 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1925 r
.y
= max (0, s
->row
->y
);
1927 /* If drawing a tool-bar window, draw it over the internal border
1928 at the top of the window. */
1929 if (WINDOWP (s
->f
->tool_bar_window
)
1930 && s
->w
== XWINDOW (s
->f
->tool_bar_window
))
1931 r
.y
-= FRAME_INTERNAL_BORDER_WIDTH (s
->f
);
1934 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1936 /* If drawing the cursor, don't let glyph draw outside its
1937 advertised boundaries. Cleartype does this under some circumstances. */
1938 if (s
->hl
== DRAW_CURSOR
)
1940 struct glyph
*glyph
= s
->first_glyph
;
1945 r
.width
-= s
->x
- r
.x
;
1948 r
.width
= min (r
.width
, glyph
->pixel_width
);
1950 /* If r.y is below window bottom, ensure that we still see a cursor. */
1951 height
= min (glyph
->ascent
+ glyph
->descent
,
1952 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1953 max_y
= window_text_bottom_y (s
->w
) - height
;
1954 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1955 if (s
->ybase
- glyph
->ascent
> max_y
)
1962 /* Don't draw cursor glyph taller than our actual glyph. */
1963 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1964 if (height
< r
.height
)
1966 max_y
= r
.y
+ r
.height
;
1967 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1968 r
.height
= min (max_y
- r
.y
, height
);
1975 XRectangle r_save
= r
;
1977 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1981 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1982 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1984 #ifdef CONVERT_FROM_XRECT
1985 CONVERT_FROM_XRECT (r
, *rects
);
1993 /* If we are processing overlapping and allowed to return
1994 multiple clipping rectangles, we exclude the row of the glyph
1995 string from the clipping rectangle. This is to avoid drawing
1996 the same text on the environment with anti-aliasing. */
1997 #ifdef CONVERT_FROM_XRECT
2000 XRectangle
*rs
= rects
;
2002 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2004 if (s
->for_overlaps
& OVERLAPS_PRED
)
2007 if (r
.y
+ r
.height
> row_y
)
2010 rs
[i
].height
= row_y
- r
.y
;
2016 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2019 if (r
.y
< row_y
+ s
->row
->visible_height
)
2021 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2023 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2024 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2033 #ifdef CONVERT_FROM_XRECT
2034 for (i
= 0; i
< n
; i
++)
2035 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2042 Return in *NR the clipping rectangle for glyph string S. */
2045 get_glyph_string_clip_rect (s
, nr
)
2046 struct glyph_string
*s
;
2047 NativeRectangle
*nr
;
2049 get_glyph_string_clip_rects (s
, nr
, 1);
2054 Return the position and height of the phys cursor in window W.
2055 Set w->phys_cursor_width to width of phys cursor.
2059 get_phys_cursor_geometry (w
, row
, glyph
, xp
, yp
, heightp
)
2061 struct glyph_row
*row
;
2062 struct glyph
*glyph
;
2063 int *xp
, *yp
, *heightp
;
2065 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2066 int x
, y
, wd
, h
, h0
, y0
;
2068 /* Compute the width of the rectangle to draw. If on a stretch
2069 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2070 rectangle as wide as the glyph, but use a canonical character
2072 wd
= glyph
->pixel_width
- 1;
2077 x
= w
->phys_cursor
.x
;
2084 if (glyph
->type
== STRETCH_GLYPH
2085 && !x_stretch_cursor_p
)
2086 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2087 w
->phys_cursor_width
= wd
;
2089 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2091 /* If y is below window bottom, ensure that we still see a cursor. */
2092 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2094 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2095 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2097 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2100 h
= max (h
- (y0
- y
) + 1, h0
);
2105 y0
= window_text_bottom_y (w
) - h0
;
2113 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2114 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2119 * Remember which glyph the mouse is over.
2123 remember_mouse_glyph (f
, gx
, gy
, rect
)
2126 NativeRectangle
*rect
;
2130 struct glyph_row
*r
, *gr
, *end_row
;
2131 enum window_part part
;
2132 enum glyph_row_area area
;
2133 int x
, y
, width
, height
;
2135 /* Try to determine frame pixel position and size of the glyph under
2136 frame pixel coordinates X/Y on frame F. */
2138 if (!f
->glyphs_initialized_p
2139 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, &x
, &y
, 0),
2142 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2143 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2147 w
= XWINDOW (window
);
2148 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2149 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2151 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2152 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2154 if (w
->pseudo_window_p
)
2157 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2163 case ON_LEFT_MARGIN
:
2164 area
= LEFT_MARGIN_AREA
;
2167 case ON_RIGHT_MARGIN
:
2168 area
= RIGHT_MARGIN_AREA
;
2171 case ON_HEADER_LINE
:
2173 gr
= (part
== ON_HEADER_LINE
2174 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2175 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2178 goto text_glyph_row_found
;
2185 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2186 if (r
->y
+ r
->height
> y
)
2192 text_glyph_row_found
:
2195 struct glyph
*g
= gr
->glyphs
[area
];
2196 struct glyph
*end
= g
+ gr
->used
[area
];
2198 height
= gr
->height
;
2199 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2200 if (gx
+ g
->pixel_width
> x
)
2205 if (g
->type
== IMAGE_GLYPH
)
2207 /* Don't remember when mouse is over image, as
2208 image may have hot-spots. */
2209 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2212 width
= g
->pixel_width
;
2216 /* Use nominal char spacing at end of line. */
2218 gx
+= (x
/ width
) * width
;
2221 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2222 gx
+= window_box_left_offset (w
, area
);
2226 /* Use nominal line height at end of window. */
2227 gx
= (x
/ width
) * width
;
2229 gy
+= (y
/ height
) * height
;
2233 case ON_LEFT_FRINGE
:
2234 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2235 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2236 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2237 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2240 case ON_RIGHT_FRINGE
:
2241 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2242 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2243 : window_box_right_offset (w
, TEXT_AREA
));
2244 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2248 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2250 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2251 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2252 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2254 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2258 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2259 if (r
->y
+ r
->height
> y
)
2266 height
= gr
->height
;
2269 /* Use nominal line height at end of window. */
2271 gy
+= (y
/ height
) * height
;
2278 /* If there is no glyph under the mouse, then we divide the screen
2279 into a grid of the smallest glyph in the frame, and use that
2282 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2283 round down even for negative values. */
2289 gx
= (gx
/ width
) * width
;
2290 gy
= (gy
/ height
) * height
;
2295 gx
+= WINDOW_LEFT_EDGE_X (w
);
2296 gy
+= WINDOW_TOP_EDGE_Y (w
);
2299 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2301 /* Visible feedback for debugging. */
2304 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2305 f
->output_data
.x
->normal_gc
,
2306 gx
, gy
, width
, height
);
2312 #endif /* HAVE_WINDOW_SYSTEM */
2315 /***********************************************************************
2316 Lisp form evaluation
2317 ***********************************************************************/
2319 /* Error handler for safe_eval and safe_call. */
2322 safe_eval_handler (arg
)
2325 add_to_log ("Error during redisplay: %s", arg
, Qnil
);
2330 /* Evaluate SEXPR and return the result, or nil if something went
2331 wrong. Prevent redisplay during the evaluation. */
2333 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2334 Return the result, or nil if something went wrong. Prevent
2335 redisplay during the evaluation. */
2338 safe_call (nargs
, args
)
2344 if (inhibit_eval_during_redisplay
)
2348 int count
= SPECPDL_INDEX ();
2349 struct gcpro gcpro1
;
2352 gcpro1
.nvars
= nargs
;
2353 specbind (Qinhibit_redisplay
, Qt
);
2354 /* Use Qt to ensure debugger does not run,
2355 so there is no possibility of wanting to redisplay. */
2356 val
= internal_condition_case_2 (Ffuncall
, nargs
, args
, Qt
,
2359 val
= unbind_to (count
, val
);
2366 /* Call function FN with one argument ARG.
2367 Return the result, or nil if something went wrong. */
2370 safe_call1 (fn
, arg
)
2371 Lisp_Object fn
, arg
;
2373 Lisp_Object args
[2];
2376 return safe_call (2, args
);
2379 static Lisp_Object Qeval
;
2382 safe_eval (Lisp_Object sexpr
)
2384 return safe_call1 (Qeval
, sexpr
);
2387 /* Call function FN with one argument ARG.
2388 Return the result, or nil if something went wrong. */
2391 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2393 Lisp_Object args
[3];
2397 return safe_call (3, args
);
2402 /***********************************************************************
2404 ***********************************************************************/
2408 /* Define CHECK_IT to perform sanity checks on iterators.
2409 This is for debugging. It is too slow to do unconditionally. */
2415 if (it
->method
== GET_FROM_STRING
)
2417 xassert (STRINGP (it
->string
));
2418 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2422 xassert (IT_STRING_CHARPOS (*it
) < 0);
2423 if (it
->method
== GET_FROM_BUFFER
)
2425 /* Check that character and byte positions agree. */
2426 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2431 xassert (it
->current
.dpvec_index
>= 0);
2433 xassert (it
->current
.dpvec_index
< 0);
2436 #define CHECK_IT(IT) check_it ((IT))
2440 #define CHECK_IT(IT) (void) 0
2447 /* Check that the window end of window W is what we expect it
2448 to be---the last row in the current matrix displaying text. */
2451 check_window_end (w
)
2454 if (!MINI_WINDOW_P (w
)
2455 && !NILP (w
->window_end_valid
))
2457 struct glyph_row
*row
;
2458 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2459 XFASTINT (w
->window_end_vpos
)),
2461 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2462 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2466 #define CHECK_WINDOW_END(W) check_window_end ((W))
2468 #else /* not GLYPH_DEBUG */
2470 #define CHECK_WINDOW_END(W) (void) 0
2472 #endif /* not GLYPH_DEBUG */
2476 /***********************************************************************
2477 Iterator initialization
2478 ***********************************************************************/
2480 /* Initialize IT for displaying current_buffer in window W, starting
2481 at character position CHARPOS. CHARPOS < 0 means that no buffer
2482 position is specified which is useful when the iterator is assigned
2483 a position later. BYTEPOS is the byte position corresponding to
2484 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2486 If ROW is not null, calls to produce_glyphs with IT as parameter
2487 will produce glyphs in that row.
2489 BASE_FACE_ID is the id of a base face to use. It must be one of
2490 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2491 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2492 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2494 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2495 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2496 will be initialized to use the corresponding mode line glyph row of
2497 the desired matrix of W. */
2500 init_iterator (it
, w
, charpos
, bytepos
, row
, base_face_id
)
2503 int charpos
, bytepos
;
2504 struct glyph_row
*row
;
2505 enum face_id base_face_id
;
2507 int highlight_region_p
;
2508 enum face_id remapped_base_face_id
= base_face_id
;
2510 /* Some precondition checks. */
2511 xassert (w
!= NULL
&& it
!= NULL
);
2512 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2515 /* If face attributes have been changed since the last redisplay,
2516 free realized faces now because they depend on face definitions
2517 that might have changed. Don't free faces while there might be
2518 desired matrices pending which reference these faces. */
2519 if (face_change_count
&& !inhibit_free_realized_faces
)
2521 face_change_count
= 0;
2522 free_all_realized_faces (Qnil
);
2525 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2526 if (! NILP (Vface_remapping_alist
))
2527 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2529 /* Use one of the mode line rows of W's desired matrix if
2533 if (base_face_id
== MODE_LINE_FACE_ID
2534 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2535 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2536 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2537 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2541 bzero (it
, sizeof *it
);
2542 it
->current
.overlay_string_index
= -1;
2543 it
->current
.dpvec_index
= -1;
2544 it
->base_face_id
= remapped_base_face_id
;
2546 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2548 /* The window in which we iterate over current_buffer: */
2549 XSETWINDOW (it
->window
, w
);
2551 it
->f
= XFRAME (w
->frame
);
2553 /* Extra space between lines (on window systems only). */
2554 if (base_face_id
== DEFAULT_FACE_ID
2555 && FRAME_WINDOW_P (it
->f
))
2557 if (NATNUMP (current_buffer
->extra_line_spacing
))
2558 it
->extra_line_spacing
= XFASTINT (current_buffer
->extra_line_spacing
);
2559 else if (FLOATP (current_buffer
->extra_line_spacing
))
2560 it
->extra_line_spacing
= (XFLOAT_DATA (current_buffer
->extra_line_spacing
)
2561 * FRAME_LINE_HEIGHT (it
->f
));
2562 else if (it
->f
->extra_line_spacing
> 0)
2563 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2564 it
->max_extra_line_spacing
= 0;
2567 /* If realized faces have been removed, e.g. because of face
2568 attribute changes of named faces, recompute them. When running
2569 in batch mode, the face cache of the initial frame is null. If
2570 we happen to get called, make a dummy face cache. */
2571 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2572 init_frame_faces (it
->f
);
2573 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2574 recompute_basic_faces (it
->f
);
2576 /* Current value of the `slice', `space-width', and 'height' properties. */
2577 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2578 it
->space_width
= Qnil
;
2579 it
->font_height
= Qnil
;
2580 it
->override_ascent
= -1;
2582 /* Are control characters displayed as `^C'? */
2583 it
->ctl_arrow_p
= !NILP (current_buffer
->ctl_arrow
);
2585 /* -1 means everything between a CR and the following line end
2586 is invisible. >0 means lines indented more than this value are
2588 it
->selective
= (INTEGERP (current_buffer
->selective_display
)
2589 ? XFASTINT (current_buffer
->selective_display
)
2590 : (!NILP (current_buffer
->selective_display
)
2592 it
->selective_display_ellipsis_p
2593 = !NILP (current_buffer
->selective_display_ellipses
);
2595 /* Display table to use. */
2596 it
->dp
= window_display_table (w
);
2598 /* Are multibyte characters enabled in current_buffer? */
2599 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
2601 /* Non-zero if we should highlight the region. */
2603 = (!NILP (Vtransient_mark_mode
)
2604 && !NILP (current_buffer
->mark_active
)
2605 && XMARKER (current_buffer
->mark
)->buffer
!= 0);
2607 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2608 start and end of a visible region in window IT->w. Set both to
2609 -1 to indicate no region. */
2610 if (highlight_region_p
2611 /* Maybe highlight only in selected window. */
2612 && (/* Either show region everywhere. */
2613 highlight_nonselected_windows
2614 /* Or show region in the selected window. */
2615 || w
== XWINDOW (selected_window
)
2616 /* Or show the region if we are in the mini-buffer and W is
2617 the window the mini-buffer refers to. */
2618 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2619 && WINDOWP (minibuf_selected_window
)
2620 && w
== XWINDOW (minibuf_selected_window
))))
2622 int charpos
= marker_position (current_buffer
->mark
);
2623 it
->region_beg_charpos
= min (PT
, charpos
);
2624 it
->region_end_charpos
= max (PT
, charpos
);
2627 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2629 /* Get the position at which the redisplay_end_trigger hook should
2630 be run, if it is to be run at all. */
2631 if (MARKERP (w
->redisplay_end_trigger
)
2632 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2633 it
->redisplay_end_trigger_charpos
2634 = marker_position (w
->redisplay_end_trigger
);
2635 else if (INTEGERP (w
->redisplay_end_trigger
))
2636 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2638 /* Correct bogus values of tab_width. */
2639 it
->tab_width
= XINT (current_buffer
->tab_width
);
2640 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2643 /* Are lines in the display truncated? */
2644 if (base_face_id
!= DEFAULT_FACE_ID
2645 || XINT (it
->w
->hscroll
)
2646 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2647 && ((!NILP (Vtruncate_partial_width_windows
)
2648 && !INTEGERP (Vtruncate_partial_width_windows
))
2649 || (INTEGERP (Vtruncate_partial_width_windows
)
2650 && (WINDOW_TOTAL_COLS (it
->w
)
2651 < XINT (Vtruncate_partial_width_windows
))))))
2652 it
->line_wrap
= TRUNCATE
;
2653 else if (NILP (current_buffer
->truncate_lines
))
2654 it
->line_wrap
= NILP (current_buffer
->word_wrap
)
2655 ? WINDOW_WRAP
: WORD_WRAP
;
2657 it
->line_wrap
= TRUNCATE
;
2659 /* Get dimensions of truncation and continuation glyphs. These are
2660 displayed as fringe bitmaps under X, so we don't need them for such
2662 if (!FRAME_WINDOW_P (it
->f
))
2664 if (it
->line_wrap
== TRUNCATE
)
2666 /* We will need the truncation glyph. */
2667 xassert (it
->glyph_row
== NULL
);
2668 produce_special_glyphs (it
, IT_TRUNCATION
);
2669 it
->truncation_pixel_width
= it
->pixel_width
;
2673 /* We will need the continuation glyph. */
2674 xassert (it
->glyph_row
== NULL
);
2675 produce_special_glyphs (it
, IT_CONTINUATION
);
2676 it
->continuation_pixel_width
= it
->pixel_width
;
2679 /* Reset these values to zero because the produce_special_glyphs
2680 above has changed them. */
2681 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2682 it
->phys_ascent
= it
->phys_descent
= 0;
2685 /* Set this after getting the dimensions of truncation and
2686 continuation glyphs, so that we don't produce glyphs when calling
2687 produce_special_glyphs, above. */
2688 it
->glyph_row
= row
;
2689 it
->area
= TEXT_AREA
;
2691 /* Get the dimensions of the display area. The display area
2692 consists of the visible window area plus a horizontally scrolled
2693 part to the left of the window. All x-values are relative to the
2694 start of this total display area. */
2695 if (base_face_id
!= DEFAULT_FACE_ID
)
2697 /* Mode lines, menu bar in terminal frames. */
2698 it
->first_visible_x
= 0;
2699 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2704 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2705 it
->last_visible_x
= (it
->first_visible_x
2706 + window_box_width (w
, TEXT_AREA
));
2708 /* If we truncate lines, leave room for the truncator glyph(s) at
2709 the right margin. Otherwise, leave room for the continuation
2710 glyph(s). Truncation and continuation glyphs are not inserted
2711 for window-based redisplay. */
2712 if (!FRAME_WINDOW_P (it
->f
))
2714 if (it
->line_wrap
== TRUNCATE
)
2715 it
->last_visible_x
-= it
->truncation_pixel_width
;
2717 it
->last_visible_x
-= it
->continuation_pixel_width
;
2720 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2721 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2724 /* Leave room for a border glyph. */
2725 if (!FRAME_WINDOW_P (it
->f
)
2726 && !WINDOW_RIGHTMOST_P (it
->w
))
2727 it
->last_visible_x
-= 1;
2729 it
->last_visible_y
= window_text_bottom_y (w
);
2731 /* For mode lines and alike, arrange for the first glyph having a
2732 left box line if the face specifies a box. */
2733 if (base_face_id
!= DEFAULT_FACE_ID
)
2737 it
->face_id
= remapped_base_face_id
;
2739 /* If we have a boxed mode line, make the first character appear
2740 with a left box line. */
2741 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2742 if (face
->box
!= FACE_NO_BOX
)
2743 it
->start_of_box_run_p
= 1;
2746 /* If a buffer position was specified, set the iterator there,
2747 getting overlays and face properties from that position. */
2748 if (charpos
>= BUF_BEG (current_buffer
))
2750 it
->end_charpos
= ZV
;
2752 IT_CHARPOS (*it
) = charpos
;
2754 /* Compute byte position if not specified. */
2755 if (bytepos
< charpos
)
2756 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2758 IT_BYTEPOS (*it
) = bytepos
;
2760 it
->start
= it
->current
;
2762 /* Compute faces etc. */
2763 reseat (it
, it
->current
.pos
, 1);
2770 /* Initialize IT for the display of window W with window start POS. */
2773 start_display (it
, w
, pos
)
2776 struct text_pos pos
;
2778 struct glyph_row
*row
;
2779 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2781 row
= w
->desired_matrix
->rows
+ first_vpos
;
2782 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2783 it
->first_vpos
= first_vpos
;
2785 /* Don't reseat to previous visible line start if current start
2786 position is in a string or image. */
2787 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2789 int start_at_line_beg_p
;
2790 int first_y
= it
->current_y
;
2792 /* If window start is not at a line start, skip forward to POS to
2793 get the correct continuation lines width. */
2794 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2795 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2796 if (!start_at_line_beg_p
)
2800 reseat_at_previous_visible_line_start (it
);
2801 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2803 new_x
= it
->current_x
+ it
->pixel_width
;
2805 /* If lines are continued, this line may end in the middle
2806 of a multi-glyph character (e.g. a control character
2807 displayed as \003, or in the middle of an overlay
2808 string). In this case move_it_to above will not have
2809 taken us to the start of the continuation line but to the
2810 end of the continued line. */
2811 if (it
->current_x
> 0
2812 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2813 && (/* And glyph doesn't fit on the line. */
2814 new_x
> it
->last_visible_x
2815 /* Or it fits exactly and we're on a window
2817 || (new_x
== it
->last_visible_x
2818 && FRAME_WINDOW_P (it
->f
))))
2820 if (it
->current
.dpvec_index
>= 0
2821 || it
->current
.overlay_string_index
>= 0)
2823 set_iterator_to_next (it
, 1);
2824 move_it_in_display_line_to (it
, -1, -1, 0);
2827 it
->continuation_lines_width
+= it
->current_x
;
2830 /* We're starting a new display line, not affected by the
2831 height of the continued line, so clear the appropriate
2832 fields in the iterator structure. */
2833 it
->max_ascent
= it
->max_descent
= 0;
2834 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2836 it
->current_y
= first_y
;
2838 it
->current_x
= it
->hpos
= 0;
2842 #if 0 /* Don't assert the following because start_display is sometimes
2843 called intentionally with a window start that is not at a
2844 line start. Please leave this code in as a comment. */
2846 /* Window start should be on a line start, now. */
2847 xassert (it
->continuation_lines_width
2848 || IT_CHARPOS (it
) == BEGV
2849 || FETCH_BYTE (IT_BYTEPOS (it
) - 1) == '\n');
2854 /* Return 1 if POS is a position in ellipses displayed for invisible
2855 text. W is the window we display, for text property lookup. */
2858 in_ellipses_for_invisible_text_p (pos
, w
)
2859 struct display_pos
*pos
;
2862 Lisp_Object prop
, window
;
2864 int charpos
= CHARPOS (pos
->pos
);
2866 /* If POS specifies a position in a display vector, this might
2867 be for an ellipsis displayed for invisible text. We won't
2868 get the iterator set up for delivering that ellipsis unless
2869 we make sure that it gets aware of the invisible text. */
2870 if (pos
->dpvec_index
>= 0
2871 && pos
->overlay_string_index
< 0
2872 && CHARPOS (pos
->string_pos
) < 0
2874 && (XSETWINDOW (window
, w
),
2875 prop
= Fget_char_property (make_number (charpos
),
2876 Qinvisible
, window
),
2877 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2879 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2881 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2888 /* Initialize IT for stepping through current_buffer in window W,
2889 starting at position POS that includes overlay string and display
2890 vector/ control character translation position information. Value
2891 is zero if there are overlay strings with newlines at POS. */
2894 init_from_display_pos (it
, w
, pos
)
2897 struct display_pos
*pos
;
2899 int charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2900 int i
, overlay_strings_with_newlines
= 0;
2902 /* If POS specifies a position in a display vector, this might
2903 be for an ellipsis displayed for invisible text. We won't
2904 get the iterator set up for delivering that ellipsis unless
2905 we make sure that it gets aware of the invisible text. */
2906 if (in_ellipses_for_invisible_text_p (pos
, w
))
2912 /* Keep in mind: the call to reseat in init_iterator skips invisible
2913 text, so we might end up at a position different from POS. This
2914 is only a problem when POS is a row start after a newline and an
2915 overlay starts there with an after-string, and the overlay has an
2916 invisible property. Since we don't skip invisible text in
2917 display_line and elsewhere immediately after consuming the
2918 newline before the row start, such a POS will not be in a string,
2919 but the call to init_iterator below will move us to the
2921 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2923 /* This only scans the current chunk -- it should scan all chunks.
2924 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2925 to 16 in 22.1 to make this a lesser problem. */
2926 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2928 const char *s
= SDATA (it
->overlay_strings
[i
]);
2929 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2931 while (s
< e
&& *s
!= '\n')
2936 overlay_strings_with_newlines
= 1;
2941 /* If position is within an overlay string, set up IT to the right
2943 if (pos
->overlay_string_index
>= 0)
2947 /* If the first overlay string happens to have a `display'
2948 property for an image, the iterator will be set up for that
2949 image, and we have to undo that setup first before we can
2950 correct the overlay string index. */
2951 if (it
->method
== GET_FROM_IMAGE
)
2954 /* We already have the first chunk of overlay strings in
2955 IT->overlay_strings. Load more until the one for
2956 pos->overlay_string_index is in IT->overlay_strings. */
2957 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2959 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2960 it
->current
.overlay_string_index
= 0;
2963 load_overlay_strings (it
, 0);
2964 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2968 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2969 relative_index
= (it
->current
.overlay_string_index
2970 % OVERLAY_STRING_CHUNK_SIZE
);
2971 it
->string
= it
->overlay_strings
[relative_index
];
2972 xassert (STRINGP (it
->string
));
2973 it
->current
.string_pos
= pos
->string_pos
;
2974 it
->method
= GET_FROM_STRING
;
2977 #if 0 /* This is bogus because POS not having an overlay string
2978 position does not mean it's after the string. Example: A
2979 line starting with a before-string and initialization of IT
2980 to the previous row's end position. */
2981 else if (it
->current
.overlay_string_index
>= 0)
2983 /* If POS says we're already after an overlay string ending at
2984 POS, make sure to pop the iterator because it will be in
2985 front of that overlay string. When POS is ZV, we've thereby
2986 also ``processed'' overlay strings at ZV. */
2989 xassert (it
->current
.overlay_string_index
== -1);
2990 xassert (it
->method
== GET_FROM_BUFFER
);
2991 if (CHARPOS (pos
->pos
) == ZV
)
2992 it
->overlay_strings_at_end_processed_p
= 1;
2996 if (CHARPOS (pos
->string_pos
) >= 0)
2998 /* Recorded position is not in an overlay string, but in another
2999 string. This can only be a string from a `display' property.
3000 IT should already be filled with that string. */
3001 it
->current
.string_pos
= pos
->string_pos
;
3002 xassert (STRINGP (it
->string
));
3005 /* Restore position in display vector translations, control
3006 character translations or ellipses. */
3007 if (pos
->dpvec_index
>= 0)
3009 if (it
->dpvec
== NULL
)
3010 get_next_display_element (it
);
3011 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3012 it
->current
.dpvec_index
= pos
->dpvec_index
;
3016 return !overlay_strings_with_newlines
;
3020 /* Initialize IT for stepping through current_buffer in window W
3021 starting at ROW->start. */
3024 init_to_row_start (it
, w
, row
)
3027 struct glyph_row
*row
;
3029 init_from_display_pos (it
, w
, &row
->start
);
3030 it
->start
= row
->start
;
3031 it
->continuation_lines_width
= row
->continuation_lines_width
;
3036 /* Initialize IT for stepping through current_buffer in window W
3037 starting in the line following ROW, i.e. starting at ROW->end.
3038 Value is zero if there are overlay strings with newlines at ROW's
3042 init_to_row_end (it
, w
, row
)
3045 struct glyph_row
*row
;
3049 if (init_from_display_pos (it
, w
, &row
->end
))
3051 if (row
->continued_p
)
3052 it
->continuation_lines_width
3053 = row
->continuation_lines_width
+ row
->pixel_width
;
3064 /***********************************************************************
3066 ***********************************************************************/
3068 /* Called when IT reaches IT->stop_charpos. Handle text property and
3069 overlay changes. Set IT->stop_charpos to the next position where
3076 enum prop_handled handled
;
3077 int handle_overlay_change_p
;
3081 it
->current
.dpvec_index
= -1;
3082 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3083 it
->ignore_overlay_strings_at_pos_p
= 0;
3085 /* Use face of preceding text for ellipsis (if invisible) */
3086 if (it
->selective_display_ellipsis_p
)
3087 it
->saved_face_id
= it
->face_id
;
3091 handled
= HANDLED_NORMALLY
;
3093 /* Call text property handlers. */
3094 for (p
= it_props
; p
->handler
; ++p
)
3096 handled
= p
->handler (it
);
3098 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3100 else if (handled
== HANDLED_RETURN
)
3102 /* We still want to show before and after strings from
3103 overlays even if the actual buffer text is replaced. */
3104 if (!handle_overlay_change_p
|| it
->sp
> 1)
3106 if (!get_overlay_strings_1 (it
, 0, 0))
3108 it
->ignore_overlay_strings_at_pos_p
= 1;
3109 it
->string_from_display_prop_p
= 0;
3110 handle_overlay_change_p
= 0;
3111 handled
= HANDLED_RECOMPUTE_PROPS
;
3114 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3115 handle_overlay_change_p
= 0;
3118 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3120 /* Don't check for overlay strings below when set to deliver
3121 characters from a display vector. */
3122 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3123 handle_overlay_change_p
= 0;
3125 /* Handle overlay changes.
3126 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3127 if it finds overlays. */
3128 if (handle_overlay_change_p
)
3129 handled
= handle_overlay_change (it
);
3132 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3134 /* Determine where to stop next. */
3135 if (handled
== HANDLED_NORMALLY
)
3136 compute_stop_pos (it
);
3140 /* Compute IT->stop_charpos from text property and overlay change
3141 information for IT's current position. */
3144 compute_stop_pos (it
)
3147 register INTERVAL iv
, next_iv
;
3148 Lisp_Object object
, limit
, position
;
3150 /* If nowhere else, stop at the end. */
3151 it
->stop_charpos
= it
->end_charpos
;
3153 if (STRINGP (it
->string
))
3155 /* Strings are usually short, so don't limit the search for
3157 object
= it
->string
;
3159 position
= make_number (IT_STRING_CHARPOS (*it
));
3165 /* If next overlay change is in front of the current stop pos
3166 (which is IT->end_charpos), stop there. Note: value of
3167 next_overlay_change is point-max if no overlay change
3169 charpos
= next_overlay_change (IT_CHARPOS (*it
));
3170 if (charpos
< it
->stop_charpos
)
3171 it
->stop_charpos
= charpos
;
3173 /* If showing the region, we have to stop at the region
3174 start or end because the face might change there. */
3175 if (it
->region_beg_charpos
> 0)
3177 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3178 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3179 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3180 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3183 /* Set up variables for computing the stop position from text
3184 property changes. */
3185 XSETBUFFER (object
, current_buffer
);
3186 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3187 position
= make_number (IT_CHARPOS (*it
));
3191 /* Get the interval containing IT's position. Value is a null
3192 interval if there isn't such an interval. */
3193 iv
= validate_interval_range (object
, &position
, &position
, 0);
3194 if (!NULL_INTERVAL_P (iv
))
3196 Lisp_Object values_here
[LAST_PROP_IDX
];
3199 /* Get properties here. */
3200 for (p
= it_props
; p
->handler
; ++p
)
3201 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3203 /* Look for an interval following iv that has different
3205 for (next_iv
= next_interval (iv
);
3206 (!NULL_INTERVAL_P (next_iv
)
3208 || XFASTINT (limit
) > next_iv
->position
));
3209 next_iv
= next_interval (next_iv
))
3211 for (p
= it_props
; p
->handler
; ++p
)
3213 Lisp_Object new_value
;
3215 new_value
= textget (next_iv
->plist
, *p
->name
);
3216 if (!EQ (values_here
[p
->idx
], new_value
))
3224 if (!NULL_INTERVAL_P (next_iv
))
3226 if (INTEGERP (limit
)
3227 && next_iv
->position
>= XFASTINT (limit
))
3228 /* No text property change up to limit. */
3229 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3231 /* Text properties change in next_iv. */
3232 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3236 xassert (STRINGP (it
->string
)
3237 || (it
->stop_charpos
>= BEGV
3238 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3242 /* Return the position of the next overlay change after POS in
3243 current_buffer. Value is point-max if no overlay change
3244 follows. This is like `next-overlay-change' but doesn't use
3248 next_overlay_change (pos
)
3253 Lisp_Object
*overlays
;
3256 /* Get all overlays at the given position. */
3257 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3259 /* If any of these overlays ends before endpos,
3260 use its ending point instead. */
3261 for (i
= 0; i
< noverlays
; ++i
)
3266 oend
= OVERLAY_END (overlays
[i
]);
3267 oendpos
= OVERLAY_POSITION (oend
);
3268 endpos
= min (endpos
, oendpos
);
3276 /***********************************************************************
3278 ***********************************************************************/
3280 /* Handle changes in the `fontified' property of the current buffer by
3281 calling hook functions from Qfontification_functions to fontify
3284 static enum prop_handled
3285 handle_fontified_prop (it
)
3288 Lisp_Object prop
, pos
;
3289 enum prop_handled handled
= HANDLED_NORMALLY
;
3291 if (!NILP (Vmemory_full
))
3294 /* Get the value of the `fontified' property at IT's current buffer
3295 position. (The `fontified' property doesn't have a special
3296 meaning in strings.) If the value is nil, call functions from
3297 Qfontification_functions. */
3298 if (!STRINGP (it
->string
)
3300 && !NILP (Vfontification_functions
)
3301 && !NILP (Vrun_hooks
)
3302 && (pos
= make_number (IT_CHARPOS (*it
)),
3303 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3304 /* Ignore the special cased nil value always present at EOB since
3305 no amount of fontifying will be able to change it. */
3306 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3308 int count
= SPECPDL_INDEX ();
3311 val
= Vfontification_functions
;
3312 specbind (Qfontification_functions
, Qnil
);
3314 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3315 safe_call1 (val
, pos
);
3318 Lisp_Object globals
, fn
;
3319 struct gcpro gcpro1
, gcpro2
;
3322 GCPRO2 (val
, globals
);
3324 for (; CONSP (val
); val
= XCDR (val
))
3330 /* A value of t indicates this hook has a local
3331 binding; it means to run the global binding too.
3332 In a global value, t should not occur. If it
3333 does, we must ignore it to avoid an endless
3335 for (globals
= Fdefault_value (Qfontification_functions
);
3337 globals
= XCDR (globals
))
3339 fn
= XCAR (globals
);
3341 safe_call1 (fn
, pos
);
3345 safe_call1 (fn
, pos
);
3351 unbind_to (count
, Qnil
);
3353 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3354 something. This avoids an endless loop if they failed to
3355 fontify the text for which reason ever. */
3356 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3357 handled
= HANDLED_RECOMPUTE_PROPS
;
3365 /***********************************************************************
3367 ***********************************************************************/
3369 /* Set up iterator IT from face properties at its current position.
3370 Called from handle_stop. */
3372 static enum prop_handled
3373 handle_face_prop (it
)
3377 EMACS_INT next_stop
;
3379 if (!STRINGP (it
->string
))
3382 = face_at_buffer_position (it
->w
,
3384 it
->region_beg_charpos
,
3385 it
->region_end_charpos
,
3388 + TEXT_PROP_DISTANCE_LIMIT
),
3391 /* Is this a start of a run of characters with box face?
3392 Caveat: this can be called for a freshly initialized
3393 iterator; face_id is -1 in this case. We know that the new
3394 face will not change until limit, i.e. if the new face has a
3395 box, all characters up to limit will have one. But, as
3396 usual, we don't know whether limit is really the end. */
3397 if (new_face_id
!= it
->face_id
)
3399 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3401 /* If new face has a box but old face has not, this is
3402 the start of a run of characters with box, i.e. it has
3403 a shadow on the left side. The value of face_id of the
3404 iterator will be -1 if this is the initial call that gets
3405 the face. In this case, we have to look in front of IT's
3406 position and see whether there is a face != new_face_id. */
3407 it
->start_of_box_run_p
3408 = (new_face
->box
!= FACE_NO_BOX
3409 && (it
->face_id
>= 0
3410 || IT_CHARPOS (*it
) == BEG
3411 || new_face_id
!= face_before_it_pos (it
)));
3412 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3417 int base_face_id
, bufpos
;
3419 Lisp_Object from_overlay
3420 = (it
->current
.overlay_string_index
>= 0
3421 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3424 /* See if we got to this string directly or indirectly from
3425 an overlay property. That includes the before-string or
3426 after-string of an overlay, strings in display properties
3427 provided by an overlay, their text properties, etc.
3429 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3430 if (! NILP (from_overlay
))
3431 for (i
= it
->sp
- 1; i
>= 0; i
--)
3433 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3435 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3436 else if (! NILP (it
->stack
[i
].from_overlay
))
3437 from_overlay
= it
->stack
[i
].from_overlay
;
3439 if (!NILP (from_overlay
))
3443 if (! NILP (from_overlay
))
3445 bufpos
= IT_CHARPOS (*it
);
3446 /* For a string from an overlay, the base face depends
3447 only on text properties and ignores overlays. */
3449 = face_for_overlay_string (it
->w
,
3451 it
->region_beg_charpos
,
3452 it
->region_end_charpos
,
3455 + TEXT_PROP_DISTANCE_LIMIT
),
3463 /* For strings from a `display' property, use the face at
3464 IT's current buffer position as the base face to merge
3465 with, so that overlay strings appear in the same face as
3466 surrounding text, unless they specify their own
3468 base_face_id
= underlying_face_id (it
);
3471 new_face_id
= face_at_string_position (it
->w
,
3473 IT_STRING_CHARPOS (*it
),
3475 it
->region_beg_charpos
,
3476 it
->region_end_charpos
,
3480 #if 0 /* This shouldn't be neccessary. Let's check it. */
3481 /* If IT is used to display a mode line we would really like to
3482 use the mode line face instead of the frame's default face. */
3483 if (it
->glyph_row
== MATRIX_MODE_LINE_ROW (it
->w
->desired_matrix
)
3484 && new_face_id
== DEFAULT_FACE_ID
)
3485 new_face_id
= CURRENT_MODE_LINE_FACE_ID (it
->w
);
3488 /* Is this a start of a run of characters with box? Caveat:
3489 this can be called for a freshly allocated iterator; face_id
3490 is -1 is this case. We know that the new face will not
3491 change until the next check pos, i.e. if the new face has a
3492 box, all characters up to that position will have a
3493 box. But, as usual, we don't know whether that position
3494 is really the end. */
3495 if (new_face_id
!= it
->face_id
)
3497 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3498 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3500 /* If new face has a box but old face hasn't, this is the
3501 start of a run of characters with box, i.e. it has a
3502 shadow on the left side. */
3503 it
->start_of_box_run_p
3504 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3505 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3509 it
->face_id
= new_face_id
;
3510 return HANDLED_NORMALLY
;
3514 /* Return the ID of the face ``underlying'' IT's current position,
3515 which is in a string. If the iterator is associated with a
3516 buffer, return the face at IT's current buffer position.
3517 Otherwise, use the iterator's base_face_id. */
3520 underlying_face_id (it
)
3523 int face_id
= it
->base_face_id
, i
;
3525 xassert (STRINGP (it
->string
));
3527 for (i
= it
->sp
- 1; i
>= 0; --i
)
3528 if (NILP (it
->stack
[i
].string
))
3529 face_id
= it
->stack
[i
].face_id
;
3535 /* Compute the face one character before or after the current position
3536 of IT. BEFORE_P non-zero means get the face in front of IT's
3537 position. Value is the id of the face. */
3540 face_before_or_after_it_pos (it
, before_p
)
3545 EMACS_INT next_check_charpos
;
3546 struct text_pos pos
;
3548 xassert (it
->s
== NULL
);
3550 if (STRINGP (it
->string
))
3552 int bufpos
, base_face_id
;
3554 /* No face change past the end of the string (for the case
3555 we are padding with spaces). No face change before the
3557 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3558 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3561 /* Set pos to the position before or after IT's current position. */
3563 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3565 /* For composition, we must check the character after the
3567 pos
= (it
->what
== IT_COMPOSITION
3568 ? string_pos (IT_STRING_CHARPOS (*it
) + it
->cmp_len
, it
->string
)
3569 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3571 if (it
->current
.overlay_string_index
>= 0)
3572 bufpos
= IT_CHARPOS (*it
);
3576 base_face_id
= underlying_face_id (it
);
3578 /* Get the face for ASCII, or unibyte. */
3579 face_id
= face_at_string_position (it
->w
,
3583 it
->region_beg_charpos
,
3584 it
->region_end_charpos
,
3585 &next_check_charpos
,
3588 /* Correct the face for charsets different from ASCII. Do it
3589 for the multibyte case only. The face returned above is
3590 suitable for unibyte text if IT->string is unibyte. */
3591 if (STRING_MULTIBYTE (it
->string
))
3593 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3594 int rest
= SBYTES (it
->string
) - BYTEPOS (pos
);
3596 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3598 c
= string_char_and_length (p
, rest
, &len
);
3599 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3604 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3605 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3608 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3609 pos
= it
->current
.pos
;
3612 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3615 if (it
->what
== IT_COMPOSITION
)
3616 /* For composition, we must check the position after the
3618 pos
.charpos
+= it
->cmp_len
, pos
.bytepos
+= it
->len
;
3620 INC_TEXT_POS (pos
, it
->multibyte_p
);
3623 /* Determine face for CHARSET_ASCII, or unibyte. */
3624 face_id
= face_at_buffer_position (it
->w
,
3626 it
->region_beg_charpos
,
3627 it
->region_end_charpos
,
3628 &next_check_charpos
,
3631 /* Correct the face for charsets different from ASCII. Do it
3632 for the multibyte case only. The face returned above is
3633 suitable for unibyte text if current_buffer is unibyte. */
3634 if (it
->multibyte_p
)
3636 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3637 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3638 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3647 /***********************************************************************
3649 ***********************************************************************/
3651 /* Set up iterator IT from invisible properties at its current
3652 position. Called from handle_stop. */
3654 static enum prop_handled
3655 handle_invisible_prop (it
)
3658 enum prop_handled handled
= HANDLED_NORMALLY
;
3660 if (STRINGP (it
->string
))
3662 extern Lisp_Object Qinvisible
;
3663 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3665 /* Get the value of the invisible text property at the
3666 current position. Value will be nil if there is no such
3668 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3669 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3672 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3674 handled
= HANDLED_RECOMPUTE_PROPS
;
3676 /* Get the position at which the next change of the
3677 invisible text property can be found in IT->string.
3678 Value will be nil if the property value is the same for
3679 all the rest of IT->string. */
3680 XSETINT (limit
, SCHARS (it
->string
));
3681 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3684 /* Text at current position is invisible. The next
3685 change in the property is at position end_charpos.
3686 Move IT's current position to that position. */
3687 if (INTEGERP (end_charpos
)
3688 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3690 struct text_pos old
;
3691 old
= it
->current
.string_pos
;
3692 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3693 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3697 /* The rest of the string is invisible. If this is an
3698 overlay string, proceed with the next overlay string
3699 or whatever comes and return a character from there. */
3700 if (it
->current
.overlay_string_index
>= 0)
3702 next_overlay_string (it
);
3703 /* Don't check for overlay strings when we just
3704 finished processing them. */
3705 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3709 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3710 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3718 EMACS_INT newpos
, next_stop
, start_charpos
;
3719 Lisp_Object pos
, prop
, overlay
;
3721 /* First of all, is there invisible text at this position? */
3722 start_charpos
= IT_CHARPOS (*it
);
3723 pos
= make_number (IT_CHARPOS (*it
));
3724 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3726 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3728 /* If we are on invisible text, skip over it. */
3729 if (invis_p
&& IT_CHARPOS (*it
) < it
->end_charpos
)
3731 /* Record whether we have to display an ellipsis for the
3733 int display_ellipsis_p
= invis_p
== 2;
3735 handled
= HANDLED_RECOMPUTE_PROPS
;
3737 /* Loop skipping over invisible text. The loop is left at
3738 ZV or with IT on the first char being visible again. */
3741 /* Try to skip some invisible text. Return value is the
3742 position reached which can be equal to IT's position
3743 if there is nothing invisible here. This skips both
3744 over invisible text properties and overlays with
3745 invisible property. */
3746 newpos
= skip_invisible (IT_CHARPOS (*it
),
3747 &next_stop
, ZV
, it
->window
);
3749 /* If we skipped nothing at all we weren't at invisible
3750 text in the first place. If everything to the end of
3751 the buffer was skipped, end the loop. */
3752 if (newpos
== IT_CHARPOS (*it
) || newpos
>= ZV
)
3756 /* We skipped some characters but not necessarily
3757 all there are. Check if we ended up on visible
3758 text. Fget_char_property returns the property of
3759 the char before the given position, i.e. if we
3760 get invis_p = 0, this means that the char at
3761 newpos is visible. */
3762 pos
= make_number (newpos
);
3763 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3764 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3767 /* If we ended up on invisible text, proceed to
3768 skip starting with next_stop. */
3770 IT_CHARPOS (*it
) = next_stop
;
3772 /* If there are adjacent invisible texts, don't lose the
3773 second one's ellipsis. */
3775 display_ellipsis_p
= 1;
3779 /* The position newpos is now either ZV or on visible text. */
3780 IT_CHARPOS (*it
) = newpos
;
3781 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3783 /* If there are before-strings at the start of invisible
3784 text, and the text is invisible because of a text
3785 property, arrange to show before-strings because 20.x did
3786 it that way. (If the text is invisible because of an
3787 overlay property instead of a text property, this is
3788 already handled in the overlay code.) */
3790 && get_overlay_strings (it
, start_charpos
))
3792 handled
= HANDLED_RECOMPUTE_PROPS
;
3793 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3795 else if (display_ellipsis_p
)
3797 /* Make sure that the glyphs of the ellipsis will get
3798 correct `charpos' values. If we would not update
3799 it->position here, the glyphs would belong to the
3800 last visible character _before_ the invisible
3801 text, which confuses `set_cursor_from_row'.
3803 We use the last invisible position instead of the
3804 first because this way the cursor is always drawn on
3805 the first "." of the ellipsis, whenever PT is inside
3806 the invisible text. Otherwise the cursor would be
3807 placed _after_ the ellipsis when the point is after the
3808 first invisible character. */
3809 if (!STRINGP (it
->object
))
3811 it
->position
.charpos
= IT_CHARPOS (*it
) - 1;
3812 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3814 setup_for_ellipsis (it
, 0);
3815 /* Let the ellipsis display before
3816 considering any properties of the following char.
3817 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3818 handled
= HANDLED_RETURN
;
3827 /* Make iterator IT return `...' next.
3828 Replaces LEN characters from buffer. */
3831 setup_for_ellipsis (it
, len
)
3835 /* Use the display table definition for `...'. Invalid glyphs
3836 will be handled by the method returning elements from dpvec. */
3837 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3839 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3840 it
->dpvec
= v
->contents
;
3841 it
->dpend
= v
->contents
+ v
->size
;
3845 /* Default `...'. */
3846 it
->dpvec
= default_invis_vector
;
3847 it
->dpend
= default_invis_vector
+ 3;
3850 it
->dpvec_char_len
= len
;
3851 it
->current
.dpvec_index
= 0;
3852 it
->dpvec_face_id
= -1;
3854 /* Remember the current face id in case glyphs specify faces.
3855 IT's face is restored in set_iterator_to_next.
3856 saved_face_id was set to preceding char's face in handle_stop. */
3857 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3858 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3860 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3866 /***********************************************************************
3868 ***********************************************************************/
3870 /* Set up iterator IT from `display' property at its current position.
3871 Called from handle_stop.
3872 We return HANDLED_RETURN if some part of the display property
3873 overrides the display of the buffer text itself.
3874 Otherwise we return HANDLED_NORMALLY. */
3876 static enum prop_handled
3877 handle_display_prop (it
)
3880 Lisp_Object prop
, object
, overlay
;
3881 struct text_pos
*position
;
3882 /* Nonzero if some property replaces the display of the text itself. */
3883 int display_replaced_p
= 0;
3885 if (STRINGP (it
->string
))
3887 object
= it
->string
;
3888 position
= &it
->current
.string_pos
;
3892 XSETWINDOW (object
, it
->w
);
3893 position
= &it
->current
.pos
;
3896 /* Reset those iterator values set from display property values. */
3897 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3898 it
->space_width
= Qnil
;
3899 it
->font_height
= Qnil
;
3902 /* We don't support recursive `display' properties, i.e. string
3903 values that have a string `display' property, that have a string
3904 `display' property etc. */
3905 if (!it
->string_from_display_prop_p
)
3906 it
->area
= TEXT_AREA
;
3908 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
3909 Qdisplay
, object
, &overlay
);
3911 return HANDLED_NORMALLY
;
3912 /* Now OVERLAY is the overlay that gave us this property, or nil
3913 if it was a text property. */
3915 if (!STRINGP (it
->string
))
3916 object
= it
->w
->buffer
;
3919 /* Simple properties. */
3920 && !EQ (XCAR (prop
), Qimage
)
3921 && !EQ (XCAR (prop
), Qspace
)
3922 && !EQ (XCAR (prop
), Qwhen
)
3923 && !EQ (XCAR (prop
), Qslice
)
3924 && !EQ (XCAR (prop
), Qspace_width
)
3925 && !EQ (XCAR (prop
), Qheight
)
3926 && !EQ (XCAR (prop
), Qraise
)
3927 /* Marginal area specifications. */
3928 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3929 && !EQ (XCAR (prop
), Qleft_fringe
)
3930 && !EQ (XCAR (prop
), Qright_fringe
)
3931 && !NILP (XCAR (prop
)))
3933 for (; CONSP (prop
); prop
= XCDR (prop
))
3935 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
3936 position
, display_replaced_p
))
3938 display_replaced_p
= 1;
3939 /* If some text in a string is replaced, `position' no
3940 longer points to the position of `object'. */
3941 if (STRINGP (object
))
3946 else if (VECTORP (prop
))
3949 for (i
= 0; i
< ASIZE (prop
); ++i
)
3950 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
3951 position
, display_replaced_p
))
3953 display_replaced_p
= 1;
3954 /* If some text in a string is replaced, `position' no
3955 longer points to the position of `object'. */
3956 if (STRINGP (object
))
3962 int ret
= handle_single_display_spec (it
, prop
, object
, overlay
,
3964 if (ret
< 0) /* Replaced by "", i.e. nothing. */
3965 return HANDLED_RECOMPUTE_PROPS
;
3967 display_replaced_p
= 1;
3970 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
3974 /* Value is the position of the end of the `display' property starting
3975 at START_POS in OBJECT. */
3977 static struct text_pos
3978 display_prop_end (it
, object
, start_pos
)
3981 struct text_pos start_pos
;
3984 struct text_pos end_pos
;
3986 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
3987 Qdisplay
, object
, Qnil
);
3988 CHARPOS (end_pos
) = XFASTINT (end
);
3989 if (STRINGP (object
))
3990 compute_string_pos (&end_pos
, start_pos
, it
->string
);
3992 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
3998 /* Set up IT from a single `display' specification PROP. OBJECT
3999 is the object in which the `display' property was found. *POSITION
4000 is the position at which it was found. DISPLAY_REPLACED_P non-zero
4001 means that we previously saw a display specification which already
4002 replaced text display with something else, for example an image;
4003 we ignore such properties after the first one has been processed.
4005 OVERLAY is the overlay this `display' property came from,
4006 or nil if it was a text property.
4008 If PROP is a `space' or `image' specification, and in some other
4009 cases too, set *POSITION to the position where the `display'
4012 Value is non-zero if something was found which replaces the display
4013 of buffer or string text. Specifically, the value is -1 if that
4014 "something" is "nothing". */
4017 handle_single_display_spec (it
, spec
, object
, overlay
, position
,
4018 display_replaced_before_p
)
4022 Lisp_Object overlay
;
4023 struct text_pos
*position
;
4024 int display_replaced_before_p
;
4027 Lisp_Object location
, value
;
4028 struct text_pos start_pos
, save_pos
;
4031 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4032 If the result is non-nil, use VALUE instead of SPEC. */
4034 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4043 if (!NILP (form
) && !EQ (form
, Qt
))
4045 int count
= SPECPDL_INDEX ();
4046 struct gcpro gcpro1
;
4048 /* Bind `object' to the object having the `display' property, a
4049 buffer or string. Bind `position' to the position in the
4050 object where the property was found, and `buffer-position'
4051 to the current position in the buffer. */
4052 specbind (Qobject
, object
);
4053 specbind (Qposition
, make_number (CHARPOS (*position
)));
4054 specbind (Qbuffer_position
,
4055 make_number (STRINGP (object
)
4056 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
4058 form
= safe_eval (form
);
4060 unbind_to (count
, Qnil
);
4066 /* Handle `(height HEIGHT)' specifications. */
4068 && EQ (XCAR (spec
), Qheight
)
4069 && CONSP (XCDR (spec
)))
4071 if (!FRAME_WINDOW_P (it
->f
))
4074 it
->font_height
= XCAR (XCDR (spec
));
4075 if (!NILP (it
->font_height
))
4077 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4078 int new_height
= -1;
4080 if (CONSP (it
->font_height
)
4081 && (EQ (XCAR (it
->font_height
), Qplus
)
4082 || EQ (XCAR (it
->font_height
), Qminus
))
4083 && CONSP (XCDR (it
->font_height
))
4084 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4086 /* `(+ N)' or `(- N)' where N is an integer. */
4087 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4088 if (EQ (XCAR (it
->font_height
), Qplus
))
4090 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4092 else if (FUNCTIONP (it
->font_height
))
4094 /* Call function with current height as argument.
4095 Value is the new height. */
4097 height
= safe_call1 (it
->font_height
,
4098 face
->lface
[LFACE_HEIGHT_INDEX
]);
4099 if (NUMBERP (height
))
4100 new_height
= XFLOATINT (height
);
4102 else if (NUMBERP (it
->font_height
))
4104 /* Value is a multiple of the canonical char height. */
4107 face
= FACE_FROM_ID (it
->f
,
4108 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4109 new_height
= (XFLOATINT (it
->font_height
)
4110 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
4114 /* Evaluate IT->font_height with `height' bound to the
4115 current specified height to get the new height. */
4116 int count
= SPECPDL_INDEX ();
4118 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4119 value
= safe_eval (it
->font_height
);
4120 unbind_to (count
, Qnil
);
4122 if (NUMBERP (value
))
4123 new_height
= XFLOATINT (value
);
4127 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4133 /* Handle `(space-width WIDTH)'. */
4135 && EQ (XCAR (spec
), Qspace_width
)
4136 && CONSP (XCDR (spec
)))
4138 if (!FRAME_WINDOW_P (it
->f
))
4141 value
= XCAR (XCDR (spec
));
4142 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4143 it
->space_width
= value
;
4148 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4150 && EQ (XCAR (spec
), Qslice
))
4154 if (!FRAME_WINDOW_P (it
->f
))
4157 if (tem
= XCDR (spec
), CONSP (tem
))
4159 it
->slice
.x
= XCAR (tem
);
4160 if (tem
= XCDR (tem
), CONSP (tem
))
4162 it
->slice
.y
= XCAR (tem
);
4163 if (tem
= XCDR (tem
), CONSP (tem
))
4165 it
->slice
.width
= XCAR (tem
);
4166 if (tem
= XCDR (tem
), CONSP (tem
))
4167 it
->slice
.height
= XCAR (tem
);
4175 /* Handle `(raise FACTOR)'. */
4177 && EQ (XCAR (spec
), Qraise
)
4178 && CONSP (XCDR (spec
)))
4180 if (!FRAME_WINDOW_P (it
->f
))
4183 #ifdef HAVE_WINDOW_SYSTEM
4184 value
= XCAR (XCDR (spec
));
4185 if (NUMBERP (value
))
4187 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4188 it
->voffset
= - (XFLOATINT (value
)
4189 * (FONT_HEIGHT (face
->font
)));
4191 #endif /* HAVE_WINDOW_SYSTEM */
4196 /* Don't handle the other kinds of display specifications
4197 inside a string that we got from a `display' property. */
4198 if (it
->string_from_display_prop_p
)
4201 /* Characters having this form of property are not displayed, so
4202 we have to find the end of the property. */
4203 start_pos
= *position
;
4204 *position
= display_prop_end (it
, object
, start_pos
);
4207 /* Stop the scan at that end position--we assume that all
4208 text properties change there. */
4209 it
->stop_charpos
= position
->charpos
;
4211 /* Handle `(left-fringe BITMAP [FACE])'
4212 and `(right-fringe BITMAP [FACE])'. */
4214 && (EQ (XCAR (spec
), Qleft_fringe
)
4215 || EQ (XCAR (spec
), Qright_fringe
))
4216 && CONSP (XCDR (spec
)))
4218 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4221 if (!FRAME_WINDOW_P (it
->f
))
4222 /* If we return here, POSITION has been advanced
4223 across the text with this property. */
4226 #ifdef HAVE_WINDOW_SYSTEM
4227 value
= XCAR (XCDR (spec
));
4228 if (!SYMBOLP (value
)
4229 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4230 /* If we return here, POSITION has been advanced
4231 across the text with this property. */
4234 if (CONSP (XCDR (XCDR (spec
))))
4236 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4237 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4243 /* Save current settings of IT so that we can restore them
4244 when we are finished with the glyph property value. */
4246 save_pos
= it
->position
;
4247 it
->position
= *position
;
4249 it
->position
= save_pos
;
4251 it
->area
= TEXT_AREA
;
4252 it
->what
= IT_IMAGE
;
4253 it
->image_id
= -1; /* no image */
4254 it
->position
= start_pos
;
4255 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4256 it
->method
= GET_FROM_IMAGE
;
4257 it
->from_overlay
= Qnil
;
4258 it
->face_id
= face_id
;
4260 /* Say that we haven't consumed the characters with
4261 `display' property yet. The call to pop_it in
4262 set_iterator_to_next will clean this up. */
4263 *position
= start_pos
;
4265 if (EQ (XCAR (spec
), Qleft_fringe
))
4267 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4268 it
->left_user_fringe_face_id
= face_id
;
4272 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4273 it
->right_user_fringe_face_id
= face_id
;
4275 #endif /* HAVE_WINDOW_SYSTEM */
4279 /* Prepare to handle `((margin left-margin) ...)',
4280 `((margin right-margin) ...)' and `((margin nil) ...)'
4281 prefixes for display specifications. */
4282 location
= Qunbound
;
4283 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4287 value
= XCDR (spec
);
4289 value
= XCAR (value
);
4292 if (EQ (XCAR (tem
), Qmargin
)
4293 && (tem
= XCDR (tem
),
4294 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4296 || EQ (tem
, Qleft_margin
)
4297 || EQ (tem
, Qright_margin
))))
4301 if (EQ (location
, Qunbound
))
4307 /* After this point, VALUE is the property after any
4308 margin prefix has been stripped. It must be a string,
4309 an image specification, or `(space ...)'.
4311 LOCATION specifies where to display: `left-margin',
4312 `right-margin' or nil. */
4314 valid_p
= (STRINGP (value
)
4315 #ifdef HAVE_WINDOW_SYSTEM
4316 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4317 #endif /* not HAVE_WINDOW_SYSTEM */
4318 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4320 if (valid_p
&& !display_replaced_before_p
)
4322 /* Save current settings of IT so that we can restore them
4323 when we are finished with the glyph property value. */
4324 save_pos
= it
->position
;
4325 it
->position
= *position
;
4327 it
->position
= save_pos
;
4328 it
->from_overlay
= overlay
;
4330 if (NILP (location
))
4331 it
->area
= TEXT_AREA
;
4332 else if (EQ (location
, Qleft_margin
))
4333 it
->area
= LEFT_MARGIN_AREA
;
4335 it
->area
= RIGHT_MARGIN_AREA
;
4337 if (STRINGP (value
))
4339 if (SCHARS (value
) == 0)
4342 return -1; /* Replaced by "", i.e. nothing. */
4345 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4346 it
->current
.overlay_string_index
= -1;
4347 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4348 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4349 it
->method
= GET_FROM_STRING
;
4350 it
->stop_charpos
= 0;
4351 it
->string_from_display_prop_p
= 1;
4352 /* Say that we haven't consumed the characters with
4353 `display' property yet. The call to pop_it in
4354 set_iterator_to_next will clean this up. */
4355 if (BUFFERP (object
))
4356 *position
= start_pos
;
4358 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4360 it
->method
= GET_FROM_STRETCH
;
4362 *position
= it
->position
= start_pos
;
4364 #ifdef HAVE_WINDOW_SYSTEM
4367 it
->what
= IT_IMAGE
;
4368 it
->image_id
= lookup_image (it
->f
, value
);
4369 it
->position
= start_pos
;
4370 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4371 it
->method
= GET_FROM_IMAGE
;
4373 /* Say that we haven't consumed the characters with
4374 `display' property yet. The call to pop_it in
4375 set_iterator_to_next will clean this up. */
4376 *position
= start_pos
;
4378 #endif /* HAVE_WINDOW_SYSTEM */
4383 /* Invalid property or property not supported. Restore
4384 POSITION to what it was before. */
4385 *position
= start_pos
;
4390 /* Check if SPEC is a display sub-property value whose text should be
4391 treated as intangible. */
4394 single_display_spec_intangible_p (prop
)
4397 /* Skip over `when FORM'. */
4398 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4412 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4413 we don't need to treat text as intangible. */
4414 if (EQ (XCAR (prop
), Qmargin
))
4422 || EQ (XCAR (prop
), Qleft_margin
)
4423 || EQ (XCAR (prop
), Qright_margin
))
4427 return (CONSP (prop
)
4428 && (EQ (XCAR (prop
), Qimage
)
4429 || EQ (XCAR (prop
), Qspace
)));
4433 /* Check if PROP is a display property value whose text should be
4434 treated as intangible. */
4437 display_prop_intangible_p (prop
)
4441 && CONSP (XCAR (prop
))
4442 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4444 /* A list of sub-properties. */
4445 while (CONSP (prop
))
4447 if (single_display_spec_intangible_p (XCAR (prop
)))
4452 else if (VECTORP (prop
))
4454 /* A vector of sub-properties. */
4456 for (i
= 0; i
< ASIZE (prop
); ++i
)
4457 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4461 return single_display_spec_intangible_p (prop
);
4467 /* Return 1 if PROP is a display sub-property value containing STRING. */
4470 single_display_spec_string_p (prop
, string
)
4471 Lisp_Object prop
, string
;
4473 if (EQ (string
, prop
))
4476 /* Skip over `when FORM'. */
4477 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4486 /* Skip over `margin LOCATION'. */
4487 if (EQ (XCAR (prop
), Qmargin
))
4498 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4502 /* Return 1 if STRING appears in the `display' property PROP. */
4505 display_prop_string_p (prop
, string
)
4506 Lisp_Object prop
, string
;
4509 && CONSP (XCAR (prop
))
4510 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4512 /* A list of sub-properties. */
4513 while (CONSP (prop
))
4515 if (single_display_spec_string_p (XCAR (prop
), string
))
4520 else if (VECTORP (prop
))
4522 /* A vector of sub-properties. */
4524 for (i
= 0; i
< ASIZE (prop
); ++i
)
4525 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4529 return single_display_spec_string_p (prop
, string
);
4535 /* Determine from which buffer position in W's buffer STRING comes
4536 from. AROUND_CHARPOS is an approximate position where it could
4537 be from. Value is the buffer position or 0 if it couldn't be
4540 W's buffer must be current.
4542 This function is necessary because we don't record buffer positions
4543 in glyphs generated from strings (to keep struct glyph small).
4544 This function may only use code that doesn't eval because it is
4545 called asynchronously from note_mouse_highlight. */
4548 string_buffer_position (w
, string
, around_charpos
)
4553 Lisp_Object limit
, prop
, pos
;
4554 const int MAX_DISTANCE
= 1000;
4557 pos
= make_number (around_charpos
);
4558 limit
= make_number (min (XINT (pos
) + MAX_DISTANCE
, ZV
));
4559 while (!found
&& !EQ (pos
, limit
))
4561 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4562 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4565 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
, limit
);
4570 pos
= make_number (around_charpos
);
4571 limit
= make_number (max (XINT (pos
) - MAX_DISTANCE
, BEGV
));
4572 while (!found
&& !EQ (pos
, limit
))
4574 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4575 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4578 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4583 return found
? XINT (pos
) : 0;
4588 /***********************************************************************
4589 `composition' property
4590 ***********************************************************************/
4592 static enum prop_handled
4593 handle_auto_composed_prop (it
)
4596 enum prop_handled handled
= HANDLED_NORMALLY
;
4598 if (FUNCTIONP (Vauto_composition_function
))
4600 Lisp_Object val
= Qnil
;
4601 EMACS_INT pos
, limit
= -1;
4603 if (STRINGP (it
->string
))
4604 pos
= IT_STRING_CHARPOS (*it
);
4606 pos
= IT_CHARPOS (*it
);
4608 val
= Fget_text_property (make_number (pos
), Qauto_composed
, it
->string
);
4611 Lisp_Object cmp_prop
;
4612 EMACS_INT cmp_start
, cmp_end
;
4614 if (get_property_and_range (pos
, Qcomposition
, &cmp_prop
,
4615 &cmp_start
, &cmp_end
, it
->string
)
4617 && COMPOSITION_METHOD (cmp_prop
) == COMPOSITION_WITH_GLYPH_STRING
)
4619 Lisp_Object gstring
= COMPOSITION_COMPONENTS (cmp_prop
);
4620 Lisp_Object font_object
= LGSTRING_FONT (gstring
);
4622 if (! EQ (font_object
,
4623 font_at (-1, pos
, FACE_FROM_ID (it
->f
, it
->face_id
),
4624 it
->w
, it
->string
)))
4625 /* We must re-compute the composition for the
4634 /* As Fnext_single_char_property_change is very slow, we
4635 limit the search to the current line. */
4636 if (STRINGP (it
->string
))
4637 limit
= SCHARS (it
->string
);
4639 limit
= find_next_newline_no_quit (pos
, 1);
4640 end
= Fnext_single_char_property_change (make_number (pos
),
4643 make_number (limit
));
4645 if (XINT (end
) < limit
)
4646 /* The current point is auto-composed, but there exist
4647 characters not yet composed beyond the
4648 auto-composed region. There's a possiblity that
4649 the last characters in the region may be newly
4654 if (NILP (val
) && ! STRINGP (it
->string
))
4657 limit
= (STRINGP (it
->string
) ? SCHARS (it
->string
)
4658 : find_next_newline_no_quit (pos
, 1));
4661 int count
= SPECPDL_INDEX ();
4662 Lisp_Object args
[5];
4664 if (FRAME_WINDOW_P (it
->f
))
4665 limit
= font_range (pos
, limit
,
4666 FACE_FROM_ID (it
->f
, it
->face_id
),
4668 args
[0] = Vauto_composition_function
;
4669 specbind (Qauto_composition_function
, Qnil
);
4670 args
[1] = make_number (pos
);
4671 args
[2] = make_number (limit
);
4672 args
[3] = it
->window
;
4673 args
[4] = it
->string
;
4674 safe_call (5, args
);
4675 unbind_to (count
, Qnil
);
4683 /* Set up iterator IT from `composition' property at its current
4684 position. Called from handle_stop. */
4686 static enum prop_handled
4687 handle_composition_prop (it
)
4690 Lisp_Object prop
, string
;
4691 EMACS_INT pos
, pos_byte
, start
, end
;
4692 enum prop_handled handled
= HANDLED_NORMALLY
;
4694 if (STRINGP (it
->string
))
4698 pos
= IT_STRING_CHARPOS (*it
);
4699 pos_byte
= IT_STRING_BYTEPOS (*it
);
4700 string
= it
->string
;
4701 s
= SDATA (string
) + pos_byte
;
4702 it
->c
= STRING_CHAR (s
, 0);
4706 pos
= IT_CHARPOS (*it
);
4707 pos_byte
= IT_BYTEPOS (*it
);
4709 it
->c
= FETCH_CHAR (pos_byte
);
4712 /* If there's a valid composition and point is not inside of the
4713 composition (in the case that the composition is from the current
4714 buffer), draw a glyph composed from the composition components. */
4715 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4716 && COMPOSITION_VALID_P (start
, end
, prop
)
4717 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4723 if (STRINGP (it
->string
))
4724 pos_byte
= string_char_to_byte (it
->string
, start
);
4726 pos_byte
= CHAR_TO_BYTE (start
);
4728 id
= get_composition_id (start
, pos_byte
, end
- start
, prop
, string
);
4732 struct composition
*cmp
= composition_table
[id
];
4734 if (cmp
->glyph_len
== 0)
4737 if (STRINGP (it
->string
))
4739 IT_STRING_CHARPOS (*it
) = end
;
4740 IT_STRING_BYTEPOS (*it
) = string_char_to_byte (it
->string
,
4745 IT_CHARPOS (*it
) = end
;
4746 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (end
);
4748 return HANDLED_RECOMPUTE_PROPS
;
4751 it
->stop_charpos
= end
;
4754 it
->method
= GET_FROM_COMPOSITION
;
4756 it
->cmp_len
= COMPOSITION_LENGTH (prop
);
4757 /* For a terminal, draw only the first (non-TAB) character
4758 of the components. */
4759 if (composition_table
[id
]->method
== COMPOSITION_WITH_GLYPH_STRING
)
4761 /* FIXME: This doesn't do anything!?! */
4762 Lisp_Object lgstring
= AREF (XHASH_TABLE (composition_hash_table
)
4764 cmp
->hash_index
* 2);
4770 for (i
= 0; i
< cmp
->glyph_len
; i
++)
4771 if ((it
->c
= COMPOSITION_GLYPH (composition_table
[id
], i
))
4777 it
->len
= (STRINGP (it
->string
)
4778 ? string_char_to_byte (it
->string
, end
)
4779 : CHAR_TO_BYTE (end
)) - pos_byte
;
4780 handled
= HANDLED_RETURN
;
4789 /***********************************************************************
4791 ***********************************************************************/
4793 /* The following structure is used to record overlay strings for
4794 later sorting in load_overlay_strings. */
4796 struct overlay_entry
4798 Lisp_Object overlay
;
4805 /* Set up iterator IT from overlay strings at its current position.
4806 Called from handle_stop. */
4808 static enum prop_handled
4809 handle_overlay_change (it
)
4812 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4813 return HANDLED_RECOMPUTE_PROPS
;
4815 return HANDLED_NORMALLY
;
4819 /* Set up the next overlay string for delivery by IT, if there is an
4820 overlay string to deliver. Called by set_iterator_to_next when the
4821 end of the current overlay string is reached. If there are more
4822 overlay strings to display, IT->string and
4823 IT->current.overlay_string_index are set appropriately here.
4824 Otherwise IT->string is set to nil. */
4827 next_overlay_string (it
)
4830 ++it
->current
.overlay_string_index
;
4831 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4833 /* No more overlay strings. Restore IT's settings to what
4834 they were before overlay strings were processed, and
4835 continue to deliver from current_buffer. */
4836 int display_ellipsis_p
= it
->stack
[it
->sp
- 1].display_ellipsis_p
;
4840 || it
->method
== GET_FROM_COMPOSITION
4841 || (NILP (it
->string
)
4842 && it
->method
== GET_FROM_BUFFER
4843 && it
->stop_charpos
>= BEGV
4844 && it
->stop_charpos
<= it
->end_charpos
));
4845 it
->current
.overlay_string_index
= -1;
4846 it
->n_overlay_strings
= 0;
4848 /* If we're at the end of the buffer, record that we have
4849 processed the overlay strings there already, so that
4850 next_element_from_buffer doesn't try it again. */
4851 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4852 it
->overlay_strings_at_end_processed_p
= 1;
4854 /* If we have to display `...' for invisible text, set
4855 the iterator up for that. */
4856 if (display_ellipsis_p
)
4857 setup_for_ellipsis (it
, 0);
4861 /* There are more overlay strings to process. If
4862 IT->current.overlay_string_index has advanced to a position
4863 where we must load IT->overlay_strings with more strings, do
4865 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4867 if (it
->current
.overlay_string_index
&& i
== 0)
4868 load_overlay_strings (it
, 0);
4870 /* Initialize IT to deliver display elements from the overlay
4872 it
->string
= it
->overlay_strings
[i
];
4873 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4874 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4875 it
->method
= GET_FROM_STRING
;
4876 it
->stop_charpos
= 0;
4883 /* Compare two overlay_entry structures E1 and E2. Used as a
4884 comparison function for qsort in load_overlay_strings. Overlay
4885 strings for the same position are sorted so that
4887 1. All after-strings come in front of before-strings, except
4888 when they come from the same overlay.
4890 2. Within after-strings, strings are sorted so that overlay strings
4891 from overlays with higher priorities come first.
4893 2. Within before-strings, strings are sorted so that overlay
4894 strings from overlays with higher priorities come last.
4896 Value is analogous to strcmp. */
4900 compare_overlay_entries (e1
, e2
)
4903 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4904 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4907 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4909 /* Let after-strings appear in front of before-strings if
4910 they come from different overlays. */
4911 if (EQ (entry1
->overlay
, entry2
->overlay
))
4912 result
= entry1
->after_string_p
? 1 : -1;
4914 result
= entry1
->after_string_p
? -1 : 1;
4916 else if (entry1
->after_string_p
)
4917 /* After-strings sorted in order of decreasing priority. */
4918 result
= entry2
->priority
- entry1
->priority
;
4920 /* Before-strings sorted in order of increasing priority. */
4921 result
= entry1
->priority
- entry2
->priority
;
4927 /* Load the vector IT->overlay_strings with overlay strings from IT's
4928 current buffer position, or from CHARPOS if that is > 0. Set
4929 IT->n_overlays to the total number of overlay strings found.
4931 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4932 a time. On entry into load_overlay_strings,
4933 IT->current.overlay_string_index gives the number of overlay
4934 strings that have already been loaded by previous calls to this
4937 IT->add_overlay_start contains an additional overlay start
4938 position to consider for taking overlay strings from, if non-zero.
4939 This position comes into play when the overlay has an `invisible'
4940 property, and both before and after-strings. When we've skipped to
4941 the end of the overlay, because of its `invisible' property, we
4942 nevertheless want its before-string to appear.
4943 IT->add_overlay_start will contain the overlay start position
4946 Overlay strings are sorted so that after-string strings come in
4947 front of before-string strings. Within before and after-strings,
4948 strings are sorted by overlay priority. See also function
4949 compare_overlay_entries. */
4952 load_overlay_strings (it
, charpos
)
4956 extern Lisp_Object Qafter_string
, Qbefore_string
, Qwindow
, Qpriority
;
4957 Lisp_Object overlay
, window
, str
, invisible
;
4958 struct Lisp_Overlay
*ov
;
4961 int n
= 0, i
, j
, invis_p
;
4962 struct overlay_entry
*entries
4963 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4966 charpos
= IT_CHARPOS (*it
);
4968 /* Append the overlay string STRING of overlay OVERLAY to vector
4969 `entries' which has size `size' and currently contains `n'
4970 elements. AFTER_P non-zero means STRING is an after-string of
4972 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4975 Lisp_Object priority; \
4979 int new_size = 2 * size; \
4980 struct overlay_entry *old = entries; \
4982 (struct overlay_entry *) alloca (new_size \
4983 * sizeof *entries); \
4984 bcopy (old, entries, size * sizeof *entries); \
4988 entries[n].string = (STRING); \
4989 entries[n].overlay = (OVERLAY); \
4990 priority = Foverlay_get ((OVERLAY), Qpriority); \
4991 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4992 entries[n].after_string_p = (AFTER_P); \
4997 /* Process overlay before the overlay center. */
4998 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5000 XSETMISC (overlay
, ov
);
5001 xassert (OVERLAYP (overlay
));
5002 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5003 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5008 /* Skip this overlay if it doesn't start or end at IT's current
5010 if (end
!= charpos
&& start
!= charpos
)
5013 /* Skip this overlay if it doesn't apply to IT->w. */
5014 window
= Foverlay_get (overlay
, Qwindow
);
5015 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5018 /* If the text ``under'' the overlay is invisible, both before-
5019 and after-strings from this overlay are visible; start and
5020 end position are indistinguishable. */
5021 invisible
= Foverlay_get (overlay
, Qinvisible
);
5022 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5024 /* If overlay has a non-empty before-string, record it. */
5025 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5026 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5028 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5030 /* If overlay has a non-empty after-string, record it. */
5031 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5032 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5034 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5037 /* Process overlays after the overlay center. */
5038 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5040 XSETMISC (overlay
, ov
);
5041 xassert (OVERLAYP (overlay
));
5042 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5043 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5045 if (start
> charpos
)
5048 /* Skip this overlay if it doesn't start or end at IT's current
5050 if (end
!= charpos
&& start
!= charpos
)
5053 /* Skip this overlay if it doesn't apply to IT->w. */
5054 window
= Foverlay_get (overlay
, Qwindow
);
5055 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5058 /* If the text ``under'' the overlay is invisible, it has a zero
5059 dimension, and both before- and after-strings apply. */
5060 invisible
= Foverlay_get (overlay
, Qinvisible
);
5061 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5063 /* If overlay has a non-empty before-string, record it. */
5064 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5065 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5067 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5069 /* If overlay has a non-empty after-string, record it. */
5070 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5071 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5073 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5076 #undef RECORD_OVERLAY_STRING
5080 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5082 /* Record the total number of strings to process. */
5083 it
->n_overlay_strings
= n
;
5085 /* IT->current.overlay_string_index is the number of overlay strings
5086 that have already been consumed by IT. Copy some of the
5087 remaining overlay strings to IT->overlay_strings. */
5089 j
= it
->current
.overlay_string_index
;
5090 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5092 it
->overlay_strings
[i
] = entries
[j
].string
;
5093 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5100 /* Get the first chunk of overlay strings at IT's current buffer
5101 position, or at CHARPOS if that is > 0. Value is non-zero if at
5102 least one overlay string was found. */
5105 get_overlay_strings_1 (it
, charpos
, compute_stop_p
)
5110 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5111 process. This fills IT->overlay_strings with strings, and sets
5112 IT->n_overlay_strings to the total number of strings to process.
5113 IT->pos.overlay_string_index has to be set temporarily to zero
5114 because load_overlay_strings needs this; it must be set to -1
5115 when no overlay strings are found because a zero value would
5116 indicate a position in the first overlay string. */
5117 it
->current
.overlay_string_index
= 0;
5118 load_overlay_strings (it
, charpos
);
5120 /* If we found overlay strings, set up IT to deliver display
5121 elements from the first one. Otherwise set up IT to deliver
5122 from current_buffer. */
5123 if (it
->n_overlay_strings
)
5125 /* Make sure we know settings in current_buffer, so that we can
5126 restore meaningful values when we're done with the overlay
5129 compute_stop_pos (it
);
5130 xassert (it
->face_id
>= 0);
5132 /* Save IT's settings. They are restored after all overlay
5133 strings have been processed. */
5134 xassert (!compute_stop_p
|| it
->sp
== 0);
5137 /* Set up IT to deliver display elements from the first overlay
5139 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5140 it
->string
= it
->overlay_strings
[0];
5141 it
->from_overlay
= Qnil
;
5142 it
->stop_charpos
= 0;
5143 xassert (STRINGP (it
->string
));
5144 it
->end_charpos
= SCHARS (it
->string
);
5145 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5146 it
->method
= GET_FROM_STRING
;
5150 it
->current
.overlay_string_index
= -1;
5155 get_overlay_strings (it
, charpos
)
5160 it
->method
= GET_FROM_BUFFER
;
5162 (void) get_overlay_strings_1 (it
, charpos
, 1);
5166 /* Value is non-zero if we found at least one overlay string. */
5167 return STRINGP (it
->string
);
5172 /***********************************************************************
5173 Saving and restoring state
5174 ***********************************************************************/
5176 /* Save current settings of IT on IT->stack. Called, for example,
5177 before setting up IT for an overlay string, to be able to restore
5178 IT's settings to what they were after the overlay string has been
5185 struct iterator_stack_entry
*p
;
5187 xassert (it
->sp
< IT_STACK_SIZE
);
5188 p
= it
->stack
+ it
->sp
;
5190 p
->stop_charpos
= it
->stop_charpos
;
5191 xassert (it
->face_id
>= 0);
5192 p
->face_id
= it
->face_id
;
5193 p
->string
= it
->string
;
5194 p
->method
= it
->method
;
5195 p
->from_overlay
= it
->from_overlay
;
5198 case GET_FROM_IMAGE
:
5199 p
->u
.image
.object
= it
->object
;
5200 p
->u
.image
.image_id
= it
->image_id
;
5201 p
->u
.image
.slice
= it
->slice
;
5203 case GET_FROM_COMPOSITION
:
5204 p
->u
.comp
.object
= it
->object
;
5205 p
->u
.comp
.c
= it
->c
;
5206 p
->u
.comp
.len
= it
->len
;
5207 p
->u
.comp
.cmp_id
= it
->cmp_id
;
5208 p
->u
.comp
.cmp_len
= it
->cmp_len
;
5210 case GET_FROM_STRETCH
:
5211 p
->u
.stretch
.object
= it
->object
;
5214 p
->position
= it
->position
;
5215 p
->current
= it
->current
;
5216 p
->end_charpos
= it
->end_charpos
;
5217 p
->string_nchars
= it
->string_nchars
;
5219 p
->multibyte_p
= it
->multibyte_p
;
5220 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5221 p
->space_width
= it
->space_width
;
5222 p
->font_height
= it
->font_height
;
5223 p
->voffset
= it
->voffset
;
5224 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5225 p
->display_ellipsis_p
= 0;
5230 /* Restore IT's settings from IT->stack. Called, for example, when no
5231 more overlay strings must be processed, and we return to delivering
5232 display elements from a buffer, or when the end of a string from a
5233 `display' property is reached and we return to delivering display
5234 elements from an overlay string, or from a buffer. */
5240 struct iterator_stack_entry
*p
;
5242 xassert (it
->sp
> 0);
5244 p
= it
->stack
+ it
->sp
;
5245 it
->stop_charpos
= p
->stop_charpos
;
5246 it
->face_id
= p
->face_id
;
5247 it
->current
= p
->current
;
5248 it
->position
= p
->position
;
5249 it
->string
= p
->string
;
5250 it
->from_overlay
= p
->from_overlay
;
5251 if (NILP (it
->string
))
5252 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5253 it
->method
= p
->method
;
5256 case GET_FROM_IMAGE
:
5257 it
->image_id
= p
->u
.image
.image_id
;
5258 it
->object
= p
->u
.image
.object
;
5259 it
->slice
= p
->u
.image
.slice
;
5261 case GET_FROM_COMPOSITION
:
5262 it
->object
= p
->u
.comp
.object
;
5263 it
->c
= p
->u
.comp
.c
;
5264 it
->len
= p
->u
.comp
.len
;
5265 it
->cmp_id
= p
->u
.comp
.cmp_id
;
5266 it
->cmp_len
= p
->u
.comp
.cmp_len
;
5268 case GET_FROM_STRETCH
:
5269 it
->object
= p
->u
.comp
.object
;
5271 case GET_FROM_BUFFER
:
5272 it
->object
= it
->w
->buffer
;
5274 case GET_FROM_STRING
:
5275 it
->object
= it
->string
;
5278 it
->end_charpos
= p
->end_charpos
;
5279 it
->string_nchars
= p
->string_nchars
;
5281 it
->multibyte_p
= p
->multibyte_p
;
5282 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5283 it
->space_width
= p
->space_width
;
5284 it
->font_height
= p
->font_height
;
5285 it
->voffset
= p
->voffset
;
5286 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5291 /***********************************************************************
5293 ***********************************************************************/
5295 /* Set IT's current position to the previous line start. */
5298 back_to_previous_line_start (it
)
5301 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5302 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5306 /* Move IT to the next line start.
5308 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5309 we skipped over part of the text (as opposed to moving the iterator
5310 continuously over the text). Otherwise, don't change the value
5313 Newlines may come from buffer text, overlay strings, or strings
5314 displayed via the `display' property. That's the reason we can't
5315 simply use find_next_newline_no_quit.
5317 Note that this function may not skip over invisible text that is so
5318 because of text properties and immediately follows a newline. If
5319 it would, function reseat_at_next_visible_line_start, when called
5320 from set_iterator_to_next, would effectively make invisible
5321 characters following a newline part of the wrong glyph row, which
5322 leads to wrong cursor motion. */
5325 forward_to_next_line_start (it
, skipped_p
)
5329 int old_selective
, newline_found_p
, n
;
5330 const int MAX_NEWLINE_DISTANCE
= 500;
5332 /* If already on a newline, just consume it to avoid unintended
5333 skipping over invisible text below. */
5334 if (it
->what
== IT_CHARACTER
5336 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5338 set_iterator_to_next (it
, 0);
5343 /* Don't handle selective display in the following. It's (a)
5344 unnecessary because it's done by the caller, and (b) leads to an
5345 infinite recursion because next_element_from_ellipsis indirectly
5346 calls this function. */
5347 old_selective
= it
->selective
;
5350 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5351 from buffer text. */
5352 for (n
= newline_found_p
= 0;
5353 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5354 n
+= STRINGP (it
->string
) ? 0 : 1)
5356 if (!get_next_display_element (it
))
5358 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5359 set_iterator_to_next (it
, 0);
5362 /* If we didn't find a newline near enough, see if we can use a
5364 if (!newline_found_p
)
5366 int start
= IT_CHARPOS (*it
);
5367 int limit
= find_next_newline_no_quit (start
, 1);
5370 xassert (!STRINGP (it
->string
));
5372 /* If there isn't any `display' property in sight, and no
5373 overlays, we can just use the position of the newline in
5375 if (it
->stop_charpos
>= limit
5376 || ((pos
= Fnext_single_property_change (make_number (start
),
5378 Qnil
, make_number (limit
)),
5380 && next_overlay_change (start
) == ZV
))
5382 IT_CHARPOS (*it
) = limit
;
5383 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5384 *skipped_p
= newline_found_p
= 1;
5388 while (get_next_display_element (it
)
5389 && !newline_found_p
)
5391 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5392 set_iterator_to_next (it
, 0);
5397 it
->selective
= old_selective
;
5398 return newline_found_p
;
5402 /* Set IT's current position to the previous visible line start. Skip
5403 invisible text that is so either due to text properties or due to
5404 selective display. Caution: this does not change IT->current_x and
5408 back_to_previous_visible_line_start (it
)
5411 while (IT_CHARPOS (*it
) > BEGV
)
5413 back_to_previous_line_start (it
);
5415 if (IT_CHARPOS (*it
) <= BEGV
)
5418 /* If selective > 0, then lines indented more than that values
5420 if (it
->selective
> 0
5421 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5422 (double) it
->selective
)) /* iftc */
5425 /* Check the newline before point for invisibility. */
5428 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5429 Qinvisible
, it
->window
);
5430 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5434 if (IT_CHARPOS (*it
) <= BEGV
)
5441 Lisp_Object val
, overlay
;
5443 /* If newline is part of a composition, continue from start of composition */
5444 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5445 && beg
< IT_CHARPOS (*it
))
5448 /* If newline is replaced by a display property, find start of overlay
5449 or interval and continue search from that point. */
5451 pos
= --IT_CHARPOS (it2
);
5454 it2
.string_from_display_prop_p
= 0;
5455 if (handle_display_prop (&it2
) == HANDLED_RETURN
5456 && !NILP (val
= get_char_property_and_overlay
5457 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5458 && (OVERLAYP (overlay
)
5459 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5460 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5463 /* Newline is not replaced by anything -- so we are done. */
5469 IT_CHARPOS (*it
) = beg
;
5470 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5474 it
->continuation_lines_width
= 0;
5476 xassert (IT_CHARPOS (*it
) >= BEGV
);
5477 xassert (IT_CHARPOS (*it
) == BEGV
5478 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5483 /* Reseat iterator IT at the previous visible line start. Skip
5484 invisible text that is so either due to text properties or due to
5485 selective display. At the end, update IT's overlay information,
5486 face information etc. */
5489 reseat_at_previous_visible_line_start (it
)
5492 back_to_previous_visible_line_start (it
);
5493 reseat (it
, it
->current
.pos
, 1);
5498 /* Reseat iterator IT on the next visible line start in the current
5499 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5500 preceding the line start. Skip over invisible text that is so
5501 because of selective display. Compute faces, overlays etc at the
5502 new position. Note that this function does not skip over text that
5503 is invisible because of text properties. */
5506 reseat_at_next_visible_line_start (it
, on_newline_p
)
5510 int newline_found_p
, skipped_p
= 0;
5512 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5514 /* Skip over lines that are invisible because they are indented
5515 more than the value of IT->selective. */
5516 if (it
->selective
> 0)
5517 while (IT_CHARPOS (*it
) < ZV
5518 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5519 (double) it
->selective
)) /* iftc */
5521 xassert (IT_BYTEPOS (*it
) == BEGV
5522 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5523 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5526 /* Position on the newline if that's what's requested. */
5527 if (on_newline_p
&& newline_found_p
)
5529 if (STRINGP (it
->string
))
5531 if (IT_STRING_CHARPOS (*it
) > 0)
5533 --IT_STRING_CHARPOS (*it
);
5534 --IT_STRING_BYTEPOS (*it
);
5537 else if (IT_CHARPOS (*it
) > BEGV
)
5541 reseat (it
, it
->current
.pos
, 0);
5545 reseat (it
, it
->current
.pos
, 0);
5552 /***********************************************************************
5553 Changing an iterator's position
5554 ***********************************************************************/
5556 /* Change IT's current position to POS in current_buffer. If FORCE_P
5557 is non-zero, always check for text properties at the new position.
5558 Otherwise, text properties are only looked up if POS >=
5559 IT->check_charpos of a property. */
5562 reseat (it
, pos
, force_p
)
5564 struct text_pos pos
;
5567 int original_pos
= IT_CHARPOS (*it
);
5569 reseat_1 (it
, pos
, 0);
5571 /* Determine where to check text properties. Avoid doing it
5572 where possible because text property lookup is very expensive. */
5574 || CHARPOS (pos
) > it
->stop_charpos
5575 || CHARPOS (pos
) < original_pos
)
5582 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5583 IT->stop_pos to POS, also. */
5586 reseat_1 (it
, pos
, set_stop_p
)
5588 struct text_pos pos
;
5591 /* Don't call this function when scanning a C string. */
5592 xassert (it
->s
== NULL
);
5594 /* POS must be a reasonable value. */
5595 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5597 it
->current
.pos
= it
->position
= pos
;
5598 it
->end_charpos
= ZV
;
5600 it
->current
.dpvec_index
= -1;
5601 it
->current
.overlay_string_index
= -1;
5602 IT_STRING_CHARPOS (*it
) = -1;
5603 IT_STRING_BYTEPOS (*it
) = -1;
5605 it
->string_from_display_prop_p
= 0;
5606 it
->method
= GET_FROM_BUFFER
;
5607 it
->object
= it
->w
->buffer
;
5608 it
->area
= TEXT_AREA
;
5609 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
5611 it
->string_from_display_prop_p
= 0;
5612 it
->face_before_selective_p
= 0;
5615 it
->stop_charpos
= CHARPOS (pos
);
5619 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5620 If S is non-null, it is a C string to iterate over. Otherwise,
5621 STRING gives a Lisp string to iterate over.
5623 If PRECISION > 0, don't return more then PRECISION number of
5624 characters from the string.
5626 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5627 characters have been returned. FIELD_WIDTH < 0 means an infinite
5630 MULTIBYTE = 0 means disable processing of multibyte characters,
5631 MULTIBYTE > 0 means enable it,
5632 MULTIBYTE < 0 means use IT->multibyte_p.
5634 IT must be initialized via a prior call to init_iterator before
5635 calling this function. */
5638 reseat_to_string (it
, s
, string
, charpos
, precision
, field_width
, multibyte
)
5643 int precision
, field_width
, multibyte
;
5645 /* No region in strings. */
5646 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5648 /* No text property checks performed by default, but see below. */
5649 it
->stop_charpos
= -1;
5651 /* Set iterator position and end position. */
5652 bzero (&it
->current
, sizeof it
->current
);
5653 it
->current
.overlay_string_index
= -1;
5654 it
->current
.dpvec_index
= -1;
5655 xassert (charpos
>= 0);
5657 /* If STRING is specified, use its multibyteness, otherwise use the
5658 setting of MULTIBYTE, if specified. */
5660 it
->multibyte_p
= multibyte
> 0;
5664 xassert (STRINGP (string
));
5665 it
->string
= string
;
5667 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5668 it
->method
= GET_FROM_STRING
;
5669 it
->current
.string_pos
= string_pos (charpos
, string
);
5676 /* Note that we use IT->current.pos, not it->current.string_pos,
5677 for displaying C strings. */
5678 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5679 if (it
->multibyte_p
)
5681 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5682 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5686 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5687 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5690 it
->method
= GET_FROM_C_STRING
;
5693 /* PRECISION > 0 means don't return more than PRECISION characters
5695 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5696 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5698 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5699 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5700 FIELD_WIDTH < 0 means infinite field width. This is useful for
5701 padding with `-' at the end of a mode line. */
5702 if (field_width
< 0)
5703 field_width
= INFINITY
;
5704 if (field_width
> it
->end_charpos
- charpos
)
5705 it
->end_charpos
= charpos
+ field_width
;
5707 /* Use the standard display table for displaying strings. */
5708 if (DISP_TABLE_P (Vstandard_display_table
))
5709 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5711 it
->stop_charpos
= charpos
;
5717 /***********************************************************************
5719 ***********************************************************************/
5721 /* Map enum it_method value to corresponding next_element_from_* function. */
5723 static int (* get_next_element
[NUM_IT_METHODS
]) P_ ((struct it
*it
)) =
5725 next_element_from_buffer
,
5726 next_element_from_display_vector
,
5727 next_element_from_composition
,
5728 next_element_from_string
,
5729 next_element_from_c_string
,
5730 next_element_from_image
,
5731 next_element_from_stretch
5734 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5736 /* Load IT's display element fields with information about the next
5737 display element from the current position of IT. Value is zero if
5738 end of buffer (or C string) is reached. */
5740 static struct frame
*last_escape_glyph_frame
= NULL
;
5741 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5742 static int last_escape_glyph_merged_face_id
= 0;
5745 get_next_display_element (it
)
5748 /* Non-zero means that we found a display element. Zero means that
5749 we hit the end of what we iterate over. Performance note: the
5750 function pointer `method' used here turns out to be faster than
5751 using a sequence of if-statements. */
5755 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5757 if (it
->what
== IT_CHARACTER
)
5759 /* Map via display table or translate control characters.
5760 IT->c, IT->len etc. have been set to the next character by
5761 the function call above. If we have a display table, and it
5762 contains an entry for IT->c, translate it. Don't do this if
5763 IT->c itself comes from a display table, otherwise we could
5764 end up in an infinite recursion. (An alternative could be to
5765 count the recursion depth of this function and signal an
5766 error when a certain maximum depth is reached.) Is it worth
5768 if (success_p
&& it
->dpvec
== NULL
)
5773 && (dv
= DISP_CHAR_VECTOR (it
->dp
, it
->c
),
5776 struct Lisp_Vector
*v
= XVECTOR (dv
);
5778 /* Return the first character from the display table
5779 entry, if not empty. If empty, don't display the
5780 current character. */
5783 it
->dpvec_char_len
= it
->len
;
5784 it
->dpvec
= v
->contents
;
5785 it
->dpend
= v
->contents
+ v
->size
;
5786 it
->current
.dpvec_index
= 0;
5787 it
->dpvec_face_id
= -1;
5788 it
->saved_face_id
= it
->face_id
;
5789 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5794 set_iterator_to_next (it
, 0);
5799 /* Translate control characters into `\003' or `^C' form.
5800 Control characters coming from a display table entry are
5801 currently not translated because we use IT->dpvec to hold
5802 the translation. This could easily be changed but I
5803 don't believe that it is worth doing.
5805 If it->multibyte_p is nonzero, non-printable non-ASCII
5806 characters are also translated to octal form.
5808 If it->multibyte_p is zero, eight-bit characters that
5809 don't have corresponding multibyte char code are also
5810 translated to octal form. */
5811 else if ((it
->c
< ' '
5812 ? (it
->area
!= TEXT_AREA
5813 /* In mode line, treat \n, \t like other crl chars. */
5815 && it
->glyph_row
&& it
->glyph_row
->mode_line_p
)
5816 || (it
->c
!= '\n' && it
->c
!= '\t'))
5818 ? (!CHAR_PRINTABLE_P (it
->c
)
5819 || (!NILP (Vnobreak_char_display
)
5820 && (it
->c
== 0xA0 /* NO-BREAK SPACE */
5821 || it
->c
== 0xAD /* SOFT HYPHEN */)))
5823 && (! unibyte_display_via_language_environment
5824 || (UNIBYTE_CHAR_HAS_MULTIBYTE_P (it
->c
)))))))
5826 /* IT->c is a control character which must be displayed
5827 either as '\003' or as `^C' where the '\\' and '^'
5828 can be defined in the display table. Fill
5829 IT->ctl_chars with glyphs for what we have to
5830 display. Then, set IT->dpvec to these glyphs. */
5833 int face_id
, lface_id
= 0 ;
5836 /* Handle control characters with ^. */
5838 if (it
->c
< 128 && it
->ctl_arrow_p
)
5842 g
= '^'; /* default glyph for Control */
5843 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5845 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5846 && GLYPH_CODE_CHAR_VALID_P (gc
))
5848 g
= GLYPH_CODE_CHAR (gc
);
5849 lface_id
= GLYPH_CODE_FACE (gc
);
5853 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5855 else if (it
->f
== last_escape_glyph_frame
5856 && it
->face_id
== last_escape_glyph_face_id
)
5858 face_id
= last_escape_glyph_merged_face_id
;
5862 /* Merge the escape-glyph face into the current face. */
5863 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5865 last_escape_glyph_frame
= it
->f
;
5866 last_escape_glyph_face_id
= it
->face_id
;
5867 last_escape_glyph_merged_face_id
= face_id
;
5870 XSETINT (it
->ctl_chars
[0], g
);
5871 XSETINT (it
->ctl_chars
[1], it
->c
^ 0100);
5873 goto display_control
;
5876 /* Handle non-break space in the mode where it only gets
5879 if (EQ (Vnobreak_char_display
, Qt
)
5882 /* Merge the no-break-space face into the current face. */
5883 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5887 XSETINT (it
->ctl_chars
[0], ' ');
5889 goto display_control
;
5892 /* Handle sequences that start with the "escape glyph". */
5894 /* the default escape glyph is \. */
5895 escape_glyph
= '\\';
5898 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5899 && GLYPH_CODE_CHAR_VALID_P (gc
))
5901 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5902 lface_id
= GLYPH_CODE_FACE (gc
);
5906 /* The display table specified a face.
5907 Merge it into face_id and also into escape_glyph. */
5908 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5911 else if (it
->f
== last_escape_glyph_frame
5912 && it
->face_id
== last_escape_glyph_face_id
)
5914 face_id
= last_escape_glyph_merged_face_id
;
5918 /* Merge the escape-glyph face into the current face. */
5919 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5921 last_escape_glyph_frame
= it
->f
;
5922 last_escape_glyph_face_id
= it
->face_id
;
5923 last_escape_glyph_merged_face_id
= face_id
;
5926 /* Handle soft hyphens in the mode where they only get
5929 if (EQ (Vnobreak_char_display
, Qt
)
5933 XSETINT (it
->ctl_chars
[0], '-');
5935 goto display_control
;
5938 /* Handle non-break space and soft hyphen
5939 with the escape glyph. */
5941 if (it
->c
== 0xA0 || it
->c
== 0xAD)
5943 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5944 it
->c
= (it
->c
== 0xA0 ? ' ' : '-');
5945 XSETINT (it
->ctl_chars
[1], it
->c
);
5947 goto display_control
;
5951 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
5955 /* Set IT->ctl_chars[0] to the glyph for `\\'. */
5956 if (CHAR_BYTE8_P (it
->c
))
5958 str
[0] = CHAR_TO_BYTE8 (it
->c
);
5961 else if (it
->c
< 256)
5968 /* It's an invalid character, which shouldn't
5969 happen actually, but due to bugs it may
5970 happen. Let's print the char as is, there's
5971 not much meaningful we can do with it. */
5973 str
[1] = it
->c
>> 8;
5974 str
[2] = it
->c
>> 16;
5975 str
[3] = it
->c
>> 24;
5979 for (i
= 0; i
< len
; i
++)
5982 XSETINT (it
->ctl_chars
[i
* 4], escape_glyph
);
5983 /* Insert three more glyphs into IT->ctl_chars for
5984 the octal display of the character. */
5985 g
= ((str
[i
] >> 6) & 7) + '0';
5986 XSETINT (it
->ctl_chars
[i
* 4 + 1], g
);
5987 g
= ((str
[i
] >> 3) & 7) + '0';
5988 XSETINT (it
->ctl_chars
[i
* 4 + 2], g
);
5989 g
= (str
[i
] & 7) + '0';
5990 XSETINT (it
->ctl_chars
[i
* 4 + 3], g
);
5996 /* Set up IT->dpvec and return first character from it. */
5997 it
->dpvec_char_len
= it
->len
;
5998 it
->dpvec
= it
->ctl_chars
;
5999 it
->dpend
= it
->dpvec
+ ctl_len
;
6000 it
->current
.dpvec_index
= 0;
6001 it
->dpvec_face_id
= face_id
;
6002 it
->saved_face_id
= it
->face_id
;
6003 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6010 /* Adjust face id for a multibyte character. There are no multibyte
6011 character in unibyte text. */
6012 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6015 && FRAME_WINDOW_P (it
->f
))
6017 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6018 int pos
= (it
->s
? -1
6019 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6020 : IT_CHARPOS (*it
));
6022 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->c
, pos
, it
->string
);
6025 /* Is this character the last one of a run of characters with
6026 box? If yes, set IT->end_of_box_run_p to 1. */
6033 it
->end_of_box_run_p
6034 = ((face_id
= face_after_it_pos (it
),
6035 face_id
!= it
->face_id
)
6036 && (face
= FACE_FROM_ID (it
->f
, face_id
),
6037 face
->box
== FACE_NO_BOX
));
6040 /* Value is 0 if end of buffer or string reached. */
6045 /* Move IT to the next display element.
6047 RESEAT_P non-zero means if called on a newline in buffer text,
6048 skip to the next visible line start.
6050 Functions get_next_display_element and set_iterator_to_next are
6051 separate because I find this arrangement easier to handle than a
6052 get_next_display_element function that also increments IT's
6053 position. The way it is we can first look at an iterator's current
6054 display element, decide whether it fits on a line, and if it does,
6055 increment the iterator position. The other way around we probably
6056 would either need a flag indicating whether the iterator has to be
6057 incremented the next time, or we would have to implement a
6058 decrement position function which would not be easy to write. */
6061 set_iterator_to_next (it
, reseat_p
)
6065 /* Reset flags indicating start and end of a sequence of characters
6066 with box. Reset them at the start of this function because
6067 moving the iterator to a new position might set them. */
6068 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6072 case GET_FROM_BUFFER
:
6073 /* The current display element of IT is a character from
6074 current_buffer. Advance in the buffer, and maybe skip over
6075 invisible lines that are so because of selective display. */
6076 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6077 reseat_at_next_visible_line_start (it
, 0);
6080 xassert (it
->len
!= 0);
6081 IT_BYTEPOS (*it
) += it
->len
;
6082 IT_CHARPOS (*it
) += 1;
6083 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6087 case GET_FROM_COMPOSITION
:
6088 xassert (it
->cmp_id
>= 0 && it
->cmp_id
< n_compositions
);
6089 xassert (it
->sp
> 0);
6091 if (it
->method
== GET_FROM_STRING
)
6093 IT_STRING_BYTEPOS (*it
) += it
->len
;
6094 IT_STRING_CHARPOS (*it
) += it
->cmp_len
;
6095 goto consider_string_end
;
6097 else if (it
->method
== GET_FROM_BUFFER
)
6099 IT_BYTEPOS (*it
) += it
->len
;
6100 IT_CHARPOS (*it
) += it
->cmp_len
;
6104 case GET_FROM_C_STRING
:
6105 /* Current display element of IT is from a C string. */
6106 IT_BYTEPOS (*it
) += it
->len
;
6107 IT_CHARPOS (*it
) += 1;
6110 case GET_FROM_DISPLAY_VECTOR
:
6111 /* Current display element of IT is from a display table entry.
6112 Advance in the display table definition. Reset it to null if
6113 end reached, and continue with characters from buffers/
6115 ++it
->current
.dpvec_index
;
6117 /* Restore face of the iterator to what they were before the
6118 display vector entry (these entries may contain faces). */
6119 it
->face_id
= it
->saved_face_id
;
6121 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6123 int recheck_faces
= it
->ellipsis_p
;
6126 it
->method
= GET_FROM_C_STRING
;
6127 else if (STRINGP (it
->string
))
6128 it
->method
= GET_FROM_STRING
;
6131 it
->method
= GET_FROM_BUFFER
;
6132 it
->object
= it
->w
->buffer
;
6136 it
->current
.dpvec_index
= -1;
6138 /* Skip over characters which were displayed via IT->dpvec. */
6139 if (it
->dpvec_char_len
< 0)
6140 reseat_at_next_visible_line_start (it
, 1);
6141 else if (it
->dpvec_char_len
> 0)
6143 if (it
->method
== GET_FROM_STRING
6144 && it
->n_overlay_strings
> 0)
6145 it
->ignore_overlay_strings_at_pos_p
= 1;
6146 it
->len
= it
->dpvec_char_len
;
6147 set_iterator_to_next (it
, reseat_p
);
6150 /* Maybe recheck faces after display vector */
6152 it
->stop_charpos
= IT_CHARPOS (*it
);
6156 case GET_FROM_STRING
:
6157 /* Current display element is a character from a Lisp string. */
6158 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6159 IT_STRING_BYTEPOS (*it
) += it
->len
;
6160 IT_STRING_CHARPOS (*it
) += 1;
6162 consider_string_end
:
6164 if (it
->current
.overlay_string_index
>= 0)
6166 /* IT->string is an overlay string. Advance to the
6167 next, if there is one. */
6168 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6169 next_overlay_string (it
);
6173 /* IT->string is not an overlay string. If we reached
6174 its end, and there is something on IT->stack, proceed
6175 with what is on the stack. This can be either another
6176 string, this time an overlay string, or a buffer. */
6177 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6181 if (it
->method
== GET_FROM_STRING
)
6182 goto consider_string_end
;
6187 case GET_FROM_IMAGE
:
6188 case GET_FROM_STRETCH
:
6189 /* The position etc with which we have to proceed are on
6190 the stack. The position may be at the end of a string,
6191 if the `display' property takes up the whole string. */
6192 xassert (it
->sp
> 0);
6194 if (it
->method
== GET_FROM_STRING
)
6195 goto consider_string_end
;
6199 /* There are no other methods defined, so this should be a bug. */
6203 xassert (it
->method
!= GET_FROM_STRING
6204 || (STRINGP (it
->string
)
6205 && IT_STRING_CHARPOS (*it
) >= 0));
6208 /* Load IT's display element fields with information about the next
6209 display element which comes from a display table entry or from the
6210 result of translating a control character to one of the forms `^C'
6213 IT->dpvec holds the glyphs to return as characters.
6214 IT->saved_face_id holds the face id before the display vector--
6215 it is restored into IT->face_idin set_iterator_to_next. */
6218 next_element_from_display_vector (it
)
6224 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6226 it
->face_id
= it
->saved_face_id
;
6228 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6229 That seemed totally bogus - so I changed it... */
6231 if ((gc
= it
->dpvec
[it
->current
.dpvec_index
], GLYPH_CODE_P (gc
))
6232 && GLYPH_CODE_CHAR_VALID_P (gc
))
6234 it
->c
= GLYPH_CODE_CHAR (gc
);
6235 it
->len
= CHAR_BYTES (it
->c
);
6237 /* The entry may contain a face id to use. Such a face id is
6238 the id of a Lisp face, not a realized face. A face id of
6239 zero means no face is specified. */
6240 if (it
->dpvec_face_id
>= 0)
6241 it
->face_id
= it
->dpvec_face_id
;
6244 int lface_id
= GLYPH_CODE_FACE (gc
);
6246 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6251 /* Display table entry is invalid. Return a space. */
6252 it
->c
= ' ', it
->len
= 1;
6254 /* Don't change position and object of the iterator here. They are
6255 still the values of the character that had this display table
6256 entry or was translated, and that's what we want. */
6257 it
->what
= IT_CHARACTER
;
6262 /* Load IT with the next display element from Lisp string IT->string.
6263 IT->current.string_pos is the current position within the string.
6264 If IT->current.overlay_string_index >= 0, the Lisp string is an
6268 next_element_from_string (it
)
6271 struct text_pos position
;
6273 xassert (STRINGP (it
->string
));
6274 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6275 position
= it
->current
.string_pos
;
6277 /* Time to check for invisible text? */
6278 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6279 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6283 /* Since a handler may have changed IT->method, we must
6285 return GET_NEXT_DISPLAY_ELEMENT (it
);
6288 if (it
->current
.overlay_string_index
>= 0)
6290 /* Get the next character from an overlay string. In overlay
6291 strings, There is no field width or padding with spaces to
6293 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6298 else if (STRING_MULTIBYTE (it
->string
))
6300 int remaining
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6301 const unsigned char *s
= (SDATA (it
->string
)
6302 + IT_STRING_BYTEPOS (*it
));
6303 it
->c
= string_char_and_length (s
, remaining
, &it
->len
);
6307 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6313 /* Get the next character from a Lisp string that is not an
6314 overlay string. Such strings come from the mode line, for
6315 example. We may have to pad with spaces, or truncate the
6316 string. See also next_element_from_c_string. */
6317 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6322 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6324 /* Pad with spaces. */
6325 it
->c
= ' ', it
->len
= 1;
6326 CHARPOS (position
) = BYTEPOS (position
) = -1;
6328 else if (STRING_MULTIBYTE (it
->string
))
6330 int maxlen
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6331 const unsigned char *s
= (SDATA (it
->string
)
6332 + IT_STRING_BYTEPOS (*it
));
6333 it
->c
= string_char_and_length (s
, maxlen
, &it
->len
);
6337 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6342 /* Record what we have and where it came from. */
6343 it
->what
= IT_CHARACTER
;
6344 it
->object
= it
->string
;
6345 it
->position
= position
;
6350 /* Load IT with next display element from C string IT->s.
6351 IT->string_nchars is the maximum number of characters to return
6352 from the string. IT->end_charpos may be greater than
6353 IT->string_nchars when this function is called, in which case we
6354 may have to return padding spaces. Value is zero if end of string
6355 reached, including padding spaces. */
6358 next_element_from_c_string (it
)
6364 it
->what
= IT_CHARACTER
;
6365 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6368 /* IT's position can be greater IT->string_nchars in case a field
6369 width or precision has been specified when the iterator was
6371 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6373 /* End of the game. */
6377 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6379 /* Pad with spaces. */
6380 it
->c
= ' ', it
->len
= 1;
6381 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6383 else if (it
->multibyte_p
)
6385 /* Implementation note: The calls to strlen apparently aren't a
6386 performance problem because there is no noticeable performance
6387 difference between Emacs running in unibyte or multibyte mode. */
6388 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
6389 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
),
6393 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6399 /* Set up IT to return characters from an ellipsis, if appropriate.
6400 The definition of the ellipsis glyphs may come from a display table
6401 entry. This function Fills IT with the first glyph from the
6402 ellipsis if an ellipsis is to be displayed. */
6405 next_element_from_ellipsis (it
)
6408 if (it
->selective_display_ellipsis_p
)
6409 setup_for_ellipsis (it
, it
->len
);
6412 /* The face at the current position may be different from the
6413 face we find after the invisible text. Remember what it
6414 was in IT->saved_face_id, and signal that it's there by
6415 setting face_before_selective_p. */
6416 it
->saved_face_id
= it
->face_id
;
6417 it
->method
= GET_FROM_BUFFER
;
6418 it
->object
= it
->w
->buffer
;
6419 reseat_at_next_visible_line_start (it
, 1);
6420 it
->face_before_selective_p
= 1;
6423 return GET_NEXT_DISPLAY_ELEMENT (it
);
6427 /* Deliver an image display element. The iterator IT is already
6428 filled with image information (done in handle_display_prop). Value
6433 next_element_from_image (it
)
6436 it
->what
= IT_IMAGE
;
6441 /* Fill iterator IT with next display element from a stretch glyph
6442 property. IT->object is the value of the text property. Value is
6446 next_element_from_stretch (it
)
6449 it
->what
= IT_STRETCH
;
6454 /* Load IT with the next display element from current_buffer. Value
6455 is zero if end of buffer reached. IT->stop_charpos is the next
6456 position at which to stop and check for text properties or buffer
6460 next_element_from_buffer (it
)
6465 /* Check this assumption, otherwise, we would never enter the
6466 if-statement, below. */
6467 xassert (IT_CHARPOS (*it
) >= BEGV
6468 && IT_CHARPOS (*it
) <= it
->stop_charpos
);
6470 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6472 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6474 int overlay_strings_follow_p
;
6476 /* End of the game, except when overlay strings follow that
6477 haven't been returned yet. */
6478 if (it
->overlay_strings_at_end_processed_p
)
6479 overlay_strings_follow_p
= 0;
6482 it
->overlay_strings_at_end_processed_p
= 1;
6483 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6486 if (overlay_strings_follow_p
)
6487 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6491 it
->position
= it
->current
.pos
;
6498 return GET_NEXT_DISPLAY_ELEMENT (it
);
6503 /* No face changes, overlays etc. in sight, so just return a
6504 character from current_buffer. */
6507 /* Maybe run the redisplay end trigger hook. Performance note:
6508 This doesn't seem to cost measurable time. */
6509 if (it
->redisplay_end_trigger_charpos
6511 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6512 run_redisplay_end_trigger_hook (it
);
6514 /* Get the next character, maybe multibyte. */
6515 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6516 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6518 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT_BYTE
? ZV_BYTE
: GPT_BYTE
)
6519 - IT_BYTEPOS (*it
));
6520 it
->c
= string_char_and_length (p
, maxlen
, &it
->len
);
6523 it
->c
= *p
, it
->len
= 1;
6525 /* Record what we have and where it came from. */
6526 it
->what
= IT_CHARACTER
;
6527 it
->object
= it
->w
->buffer
;
6528 it
->position
= it
->current
.pos
;
6530 /* Normally we return the character found above, except when we
6531 really want to return an ellipsis for selective display. */
6536 /* A value of selective > 0 means hide lines indented more
6537 than that number of columns. */
6538 if (it
->selective
> 0
6539 && IT_CHARPOS (*it
) + 1 < ZV
6540 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6541 IT_BYTEPOS (*it
) + 1,
6542 (double) it
->selective
)) /* iftc */
6544 success_p
= next_element_from_ellipsis (it
);
6545 it
->dpvec_char_len
= -1;
6548 else if (it
->c
== '\r' && it
->selective
== -1)
6550 /* A value of selective == -1 means that everything from the
6551 CR to the end of the line is invisible, with maybe an
6552 ellipsis displayed for it. */
6553 success_p
= next_element_from_ellipsis (it
);
6554 it
->dpvec_char_len
= -1;
6559 /* Value is zero if end of buffer reached. */
6560 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6565 /* Run the redisplay end trigger hook for IT. */
6568 run_redisplay_end_trigger_hook (it
)
6571 Lisp_Object args
[3];
6573 /* IT->glyph_row should be non-null, i.e. we should be actually
6574 displaying something, or otherwise we should not run the hook. */
6575 xassert (it
->glyph_row
);
6577 /* Set up hook arguments. */
6578 args
[0] = Qredisplay_end_trigger_functions
;
6579 args
[1] = it
->window
;
6580 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6581 it
->redisplay_end_trigger_charpos
= 0;
6583 /* Since we are *trying* to run these functions, don't try to run
6584 them again, even if they get an error. */
6585 it
->w
->redisplay_end_trigger
= Qnil
;
6586 Frun_hook_with_args (3, args
);
6588 /* Notice if it changed the face of the character we are on. */
6589 handle_face_prop (it
);
6593 /* Deliver a composition display element. The iterator IT is already
6594 filled with composition information (done in
6595 handle_composition_prop). Value is always 1. */
6598 next_element_from_composition (it
)
6601 it
->what
= IT_COMPOSITION
;
6602 it
->position
= (STRINGP (it
->string
)
6603 ? it
->current
.string_pos
6605 if (STRINGP (it
->string
))
6606 it
->object
= it
->string
;
6608 it
->object
= it
->w
->buffer
;
6614 /***********************************************************************
6615 Moving an iterator without producing glyphs
6616 ***********************************************************************/
6618 /* Check if iterator is at a position corresponding to a valid buffer
6619 position after some move_it_ call. */
6621 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6622 ((it)->method == GET_FROM_STRING \
6623 ? IT_STRING_CHARPOS (*it) == 0 \
6627 /* Move iterator IT to a specified buffer or X position within one
6628 line on the display without producing glyphs.
6630 OP should be a bit mask including some or all of these bits:
6631 MOVE_TO_X: Stop on reaching x-position TO_X.
6632 MOVE_TO_POS: Stop on reaching buffer or string position TO_CHARPOS.
6633 Regardless of OP's value, stop in reaching the end of the display line.
6635 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6636 This means, in particular, that TO_X includes window's horizontal
6639 The return value has several possible values that
6640 say what condition caused the scan to stop:
6642 MOVE_POS_MATCH_OR_ZV
6643 - when TO_POS or ZV was reached.
6646 -when TO_X was reached before TO_POS or ZV were reached.
6649 - when we reached the end of the display area and the line must
6653 - when we reached the end of the display area and the line is
6657 - when we stopped at a line end, i.e. a newline or a CR and selective
6660 static enum move_it_result
6661 move_it_in_display_line_to (struct it
*it
,
6662 EMACS_INT to_charpos
, int to_x
,
6663 enum move_operation_enum op
)
6665 enum move_it_result result
= MOVE_UNDEFINED
;
6666 struct glyph_row
*saved_glyph_row
;
6667 struct it wrap_it
, atpos_it
;
6670 /* Don't produce glyphs in produce_glyphs. */
6671 saved_glyph_row
= it
->glyph_row
;
6672 it
->glyph_row
= NULL
;
6674 /* Use wrap_it to save a copy of IT wherever a word wrap could
6675 occur. Use atpos_it to save a copy of IT at the desired
6676 position, if found, so that we can scan ahead and check if the
6677 word later overshoots the window edge. */
6681 #define BUFFER_POS_REACHED_P() \
6682 ((op & MOVE_TO_POS) != 0 \
6683 && BUFFERP (it->object) \
6684 && IT_CHARPOS (*it) >= to_charpos \
6685 && (it->method == GET_FROM_BUFFER \
6686 || (it->method == GET_FROM_DISPLAY_VECTOR \
6687 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6689 /* If there's a line-/wrap-prefix, handle it. */
6690 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
6691 && it
->current_y
< it
->last_visible_y
)
6693 handle_line_prefix (it
);
6698 int x
, i
, ascent
= 0, descent
= 0;
6700 /* Stop if we move beyond TO_CHARPOS (after an image or stretch glyph). */
6701 if ((op
& MOVE_TO_POS
) != 0
6702 && BUFFERP (it
->object
)
6703 && it
->method
== GET_FROM_BUFFER
6704 && IT_CHARPOS (*it
) > to_charpos
)
6706 if (it
->line_wrap
== WORD_WRAP
)
6708 /* If wrap_it is valid, the current position might be in
6709 a word that is wrapped to the next line, so continue
6710 to see if that happens. */
6713 result
= MOVE_POS_MATCH_OR_ZV
;
6716 if (atpos_it
.sp
< 0)
6721 result
= MOVE_POS_MATCH_OR_ZV
;
6726 /* Stop when ZV reached.
6727 We used to stop here when TO_CHARPOS reached as well, but that is
6728 too soon if this glyph does not fit on this line. So we handle it
6729 explicitly below. */
6730 if (!get_next_display_element (it
))
6732 result
= MOVE_POS_MATCH_OR_ZV
;
6736 if (it
->line_wrap
== TRUNCATE
)
6738 if (BUFFER_POS_REACHED_P ())
6740 result
= MOVE_POS_MATCH_OR_ZV
;
6746 /* Remember the line height so far in case the next element
6747 doesn't fit on the line. */
6748 ascent
= it
->max_ascent
;
6749 descent
= it
->max_descent
;
6751 if (it
->line_wrap
== WORD_WRAP
)
6753 if (it
->what
== IT_CHARACTER
6754 && (it
->c
== ' ' || it
->c
== '\t'))
6758 /* We are done if the position is already found. */
6759 if (atpos_it
.sp
>= 0)
6763 goto buffer_pos_reached
;
6771 /* The call to produce_glyphs will get the metrics of the
6772 display element IT is loaded with. Record the x-position
6773 before this display element, in case it doesn't fit on the
6777 PRODUCE_GLYPHS (it
);
6779 if (it
->area
!= TEXT_AREA
)
6781 set_iterator_to_next (it
, 1);
6785 /* The number of glyphs we get back in IT->nglyphs will normally
6786 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
6787 character on a terminal frame, or (iii) a line end. For the
6788 second case, IT->nglyphs - 1 padding glyphs will be present
6789 (on X frames, there is only one glyph produced for a
6790 composite character.
6792 The behavior implemented below means, for continuation lines,
6793 that as many spaces of a TAB as fit on the current line are
6794 displayed there. For terminal frames, as many glyphs of a
6795 multi-glyph character are displayed in the current line, too.
6796 This is what the old redisplay code did, and we keep it that
6797 way. Under X, the whole shape of a complex character must
6798 fit on the line or it will be completely displayed in the
6801 Note that both for tabs and padding glyphs, all glyphs have
6805 /* More than one glyph or glyph doesn't fit on line. All
6806 glyphs have the same width. */
6807 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
6809 int x_before_this_char
= x
;
6810 int hpos_before_this_char
= it
->hpos
;
6812 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
6814 new_x
= x
+ single_glyph_width
;
6816 /* We want to leave anything reaching TO_X to the caller. */
6817 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
6819 if (BUFFER_POS_REACHED_P ())
6821 if (it
->line_wrap
== WORD_WRAP
)
6824 goto buffer_pos_reached
;
6825 if (atpos_it
.sp
< 0)
6829 goto buffer_pos_reached
;
6832 result
= MOVE_X_REACHED
;
6836 if (/* Lines are continued. */
6837 it
->line_wrap
!= TRUNCATE
6838 && (/* And glyph doesn't fit on the line. */
6839 new_x
> it
->last_visible_x
6840 /* Or it fits exactly and we're on a window
6842 || (new_x
== it
->last_visible_x
6843 && FRAME_WINDOW_P (it
->f
))))
6845 if (/* IT->hpos == 0 means the very first glyph
6846 doesn't fit on the line, e.g. a wide image. */
6848 || (new_x
== it
->last_visible_x
6849 && FRAME_WINDOW_P (it
->f
)))
6852 it
->current_x
= new_x
;
6854 /* The character's last glyph just barely fits
6856 if (i
== it
->nglyphs
- 1)
6858 /* If this is the destination position,
6859 return a position *before* it in this row,
6860 now that we know it fits in this row. */
6861 if (BUFFER_POS_REACHED_P ())
6863 it
->hpos
= hpos_before_this_char
;
6864 it
->current_x
= x_before_this_char
;
6865 result
= MOVE_POS_MATCH_OR_ZV
;
6869 set_iterator_to_next (it
, 1);
6870 #ifdef HAVE_WINDOW_SYSTEM
6871 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
6873 if (!get_next_display_element (it
))
6875 result
= MOVE_POS_MATCH_OR_ZV
;
6878 if (BUFFER_POS_REACHED_P ())
6880 if (ITERATOR_AT_END_OF_LINE_P (it
))
6881 result
= MOVE_POS_MATCH_OR_ZV
;
6883 result
= MOVE_LINE_CONTINUED
;
6886 if (ITERATOR_AT_END_OF_LINE_P (it
))
6888 result
= MOVE_NEWLINE_OR_CR
;
6892 #endif /* HAVE_WINDOW_SYSTEM */
6898 it
->max_ascent
= ascent
;
6899 it
->max_descent
= descent
;
6902 if (wrap_it
.sp
>= 0)
6908 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
6910 result
= MOVE_LINE_CONTINUED
;
6914 if (BUFFER_POS_REACHED_P ())
6916 if (it
->line_wrap
== WORD_WRAP
)
6919 goto buffer_pos_reached
;
6920 if (atpos_it
.sp
< 0)
6924 goto buffer_pos_reached
;
6927 if (new_x
> it
->first_visible_x
)
6929 /* Glyph is visible. Increment number of glyphs that
6930 would be displayed. */
6935 if (result
!= MOVE_UNDEFINED
)
6938 else if (BUFFER_POS_REACHED_P ())
6942 it
->max_ascent
= ascent
;
6943 it
->max_descent
= descent
;
6944 result
= MOVE_POS_MATCH_OR_ZV
;
6947 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
6949 /* Stop when TO_X specified and reached. This check is
6950 necessary here because of lines consisting of a line end,
6951 only. The line end will not produce any glyphs and we
6952 would never get MOVE_X_REACHED. */
6953 xassert (it
->nglyphs
== 0);
6954 result
= MOVE_X_REACHED
;
6958 /* Is this a line end? If yes, we're done. */
6959 if (ITERATOR_AT_END_OF_LINE_P (it
))
6961 result
= MOVE_NEWLINE_OR_CR
;
6965 /* The current display element has been consumed. Advance
6967 set_iterator_to_next (it
, 1);
6969 /* Stop if lines are truncated and IT's current x-position is
6970 past the right edge of the window now. */
6971 if (it
->line_wrap
== TRUNCATE
6972 && it
->current_x
>= it
->last_visible_x
)
6974 #ifdef HAVE_WINDOW_SYSTEM
6975 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
6977 if (!get_next_display_element (it
)
6978 || BUFFER_POS_REACHED_P ())
6980 result
= MOVE_POS_MATCH_OR_ZV
;
6983 if (ITERATOR_AT_END_OF_LINE_P (it
))
6985 result
= MOVE_NEWLINE_OR_CR
;
6989 #endif /* HAVE_WINDOW_SYSTEM */
6990 result
= MOVE_LINE_TRUNCATED
;
6995 #undef BUFFER_POS_REACHED_P
6997 /* If we scanned beyond to_pos and didn't find a point to wrap at,
6998 return iterator at to_pos. */
6999 if (atpos_it
.sp
>= 0)
7002 /* Restore the iterator settings altered at the beginning of this
7004 it
->glyph_row
= saved_glyph_row
;
7008 /* For external use. */
7010 move_it_in_display_line (struct it
*it
,
7011 EMACS_INT to_charpos
, int to_x
,
7012 enum move_operation_enum op
)
7014 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7018 /* Move IT forward until it satisfies one or more of the criteria in
7019 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7021 OP is a bit-mask that specifies where to stop, and in particular,
7022 which of those four position arguments makes a difference. See the
7023 description of enum move_operation_enum.
7025 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7026 screen line, this function will set IT to the next position >
7030 move_it_to (it
, to_charpos
, to_x
, to_y
, to_vpos
, op
)
7032 int to_charpos
, to_x
, to_y
, to_vpos
;
7035 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7041 if (op
& MOVE_TO_VPOS
)
7043 /* If no TO_CHARPOS and no TO_X specified, stop at the
7044 start of the line TO_VPOS. */
7045 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7047 if (it
->vpos
== to_vpos
)
7053 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7057 /* TO_VPOS >= 0 means stop at TO_X in the line at
7058 TO_VPOS, or at TO_POS, whichever comes first. */
7059 if (it
->vpos
== to_vpos
)
7065 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7067 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7072 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7074 /* We have reached TO_X but not in the line we want. */
7075 skip
= move_it_in_display_line_to (it
, to_charpos
,
7077 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7085 else if (op
& MOVE_TO_Y
)
7087 struct it it_backup
;
7089 /* TO_Y specified means stop at TO_X in the line containing
7090 TO_Y---or at TO_CHARPOS if this is reached first. The
7091 problem is that we can't really tell whether the line
7092 contains TO_Y before we have completely scanned it, and
7093 this may skip past TO_X. What we do is to first scan to
7096 If TO_X is not specified, use a TO_X of zero. The reason
7097 is to make the outcome of this function more predictable.
7098 If we didn't use TO_X == 0, we would stop at the end of
7099 the line which is probably not what a caller would expect
7101 skip
= move_it_in_display_line_to (it
, to_charpos
,
7105 | (op
& MOVE_TO_POS
)));
7107 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7108 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7114 /* If TO_X was reached, we would like to know whether TO_Y
7115 is in the line. This can only be said if we know the
7116 total line height which requires us to scan the rest of
7118 if (skip
== MOVE_X_REACHED
)
7120 /* Wait! We can conclude that TO_Y is in the line if
7121 the already scanned glyphs make the line tall enough
7122 because further scanning doesn't make it shorter. */
7123 line_height
= it
->max_ascent
+ it
->max_descent
;
7124 if (to_y
>= it
->current_y
7125 && to_y
< it
->current_y
+ line_height
)
7131 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7132 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7134 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7137 /* Now, decide whether TO_Y is in this line. */
7138 line_height
= it
->max_ascent
+ it
->max_descent
;
7139 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7141 if (to_y
>= it
->current_y
7142 && to_y
< it
->current_y
+ line_height
)
7144 if (skip
== MOVE_X_REACHED
)
7145 /* If TO_Y is in this line and TO_X was reached above,
7146 we scanned too far. We have to restore IT's settings
7147 to the ones before skipping. */
7151 else if (skip
== MOVE_X_REACHED
)
7154 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7161 else if (BUFFERP (it
->object
)
7162 && it
->method
== GET_FROM_BUFFER
7163 && IT_CHARPOS (*it
) >= to_charpos
)
7164 skip
= MOVE_POS_MATCH_OR_ZV
;
7166 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7170 case MOVE_POS_MATCH_OR_ZV
:
7174 case MOVE_NEWLINE_OR_CR
:
7175 set_iterator_to_next (it
, 1);
7176 it
->continuation_lines_width
= 0;
7179 case MOVE_LINE_TRUNCATED
:
7180 it
->continuation_lines_width
= 0;
7181 reseat_at_next_visible_line_start (it
, 0);
7182 if ((op
& MOVE_TO_POS
) != 0
7183 && IT_CHARPOS (*it
) > to_charpos
)
7190 case MOVE_LINE_CONTINUED
:
7191 /* For continued lines ending in a tab, some of the glyphs
7192 associated with the tab are displayed on the current
7193 line. Since it->current_x does not include these glyphs,
7194 we use it->last_visible_x instead. */
7195 it
->continuation_lines_width
+=
7196 (it
->c
== '\t') ? it
->last_visible_x
: it
->current_x
;
7203 /* Reset/increment for the next run. */
7204 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7205 it
->current_x
= it
->hpos
= 0;
7206 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7208 last_height
= it
->max_ascent
+ it
->max_descent
;
7209 last_max_ascent
= it
->max_ascent
;
7210 it
->max_ascent
= it
->max_descent
= 0;
7215 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7219 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7221 If DY > 0, move IT backward at least that many pixels. DY = 0
7222 means move IT backward to the preceding line start or BEGV. This
7223 function may move over more than DY pixels if IT->current_y - DY
7224 ends up in the middle of a line; in this case IT->current_y will be
7225 set to the top of the line moved to. */
7228 move_it_vertically_backward (it
, dy
)
7239 start_pos
= IT_CHARPOS (*it
);
7241 /* Estimate how many newlines we must move back. */
7242 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7244 /* Set the iterator's position that many lines back. */
7245 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7246 back_to_previous_visible_line_start (it
);
7248 /* Reseat the iterator here. When moving backward, we don't want
7249 reseat to skip forward over invisible text, set up the iterator
7250 to deliver from overlay strings at the new position etc. So,
7251 use reseat_1 here. */
7252 reseat_1 (it
, it
->current
.pos
, 1);
7254 /* We are now surely at a line start. */
7255 it
->current_x
= it
->hpos
= 0;
7256 it
->continuation_lines_width
= 0;
7258 /* Move forward and see what y-distance we moved. First move to the
7259 start of the next line so that we get its height. We need this
7260 height to be able to tell whether we reached the specified
7263 it2
.max_ascent
= it2
.max_descent
= 0;
7266 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7267 MOVE_TO_POS
| MOVE_TO_VPOS
);
7269 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7270 xassert (IT_CHARPOS (*it
) >= BEGV
);
7273 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7274 xassert (IT_CHARPOS (*it
) >= BEGV
);
7275 /* H is the actual vertical distance from the position in *IT
7276 and the starting position. */
7277 h
= it2
.current_y
- it
->current_y
;
7278 /* NLINES is the distance in number of lines. */
7279 nlines
= it2
.vpos
- it
->vpos
;
7281 /* Correct IT's y and vpos position
7282 so that they are relative to the starting point. */
7288 /* DY == 0 means move to the start of the screen line. The
7289 value of nlines is > 0 if continuation lines were involved. */
7291 move_it_by_lines (it
, nlines
, 1);
7293 /* I think this assert is bogus if buffer contains
7294 invisible text or images. KFS. */
7295 xassert (IT_CHARPOS (*it
) <= start_pos
);
7300 /* The y-position we try to reach, relative to *IT.
7301 Note that H has been subtracted in front of the if-statement. */
7302 int target_y
= it
->current_y
+ h
- dy
;
7303 int y0
= it3
.current_y
;
7304 int y1
= line_bottom_y (&it3
);
7305 int line_height
= y1
- y0
;
7307 /* If we did not reach target_y, try to move further backward if
7308 we can. If we moved too far backward, try to move forward. */
7309 if (target_y
< it
->current_y
7310 /* This is heuristic. In a window that's 3 lines high, with
7311 a line height of 13 pixels each, recentering with point
7312 on the bottom line will try to move -39/2 = 19 pixels
7313 backward. Try to avoid moving into the first line. */
7314 && (it
->current_y
- target_y
7315 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7316 && IT_CHARPOS (*it
) > BEGV
)
7318 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7319 target_y
- it
->current_y
));
7320 dy
= it
->current_y
- target_y
;
7321 goto move_further_back
;
7323 else if (target_y
>= it
->current_y
+ line_height
7324 && IT_CHARPOS (*it
) < ZV
)
7326 /* Should move forward by at least one line, maybe more.
7328 Note: Calling move_it_by_lines can be expensive on
7329 terminal frames, where compute_motion is used (via
7330 vmotion) to do the job, when there are very long lines
7331 and truncate-lines is nil. That's the reason for
7332 treating terminal frames specially here. */
7334 if (!FRAME_WINDOW_P (it
->f
))
7335 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7340 move_it_by_lines (it
, 1, 1);
7342 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7346 /* I think this assert is bogus if buffer contains
7347 invisible text or images. KFS. */
7348 xassert (IT_CHARPOS (*it
) >= BEGV
);
7355 /* Move IT by a specified amount of pixel lines DY. DY negative means
7356 move backwards. DY = 0 means move to start of screen line. At the
7357 end, IT will be on the start of a screen line. */
7360 move_it_vertically (it
, dy
)
7365 move_it_vertically_backward (it
, -dy
);
7368 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7369 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7370 MOVE_TO_POS
| MOVE_TO_Y
);
7371 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7373 /* If buffer ends in ZV without a newline, move to the start of
7374 the line to satisfy the post-condition. */
7375 if (IT_CHARPOS (*it
) == ZV
7377 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7378 move_it_by_lines (it
, 0, 0);
7383 /* Move iterator IT past the end of the text line it is in. */
7386 move_it_past_eol (it
)
7389 enum move_it_result rc
;
7391 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7392 if (rc
== MOVE_NEWLINE_OR_CR
)
7393 set_iterator_to_next (it
, 0);
7397 #if 0 /* Currently not used. */
7399 /* Return non-zero if some text between buffer positions START_CHARPOS
7400 and END_CHARPOS is invisible. IT->window is the window for text
7404 invisible_text_between_p (it
, start_charpos
, end_charpos
)
7406 int start_charpos
, end_charpos
;
7408 Lisp_Object prop
, limit
;
7409 int invisible_found_p
;
7411 xassert (it
!= NULL
&& start_charpos
<= end_charpos
);
7413 /* Is text at START invisible? */
7414 prop
= Fget_char_property (make_number (start_charpos
), Qinvisible
,
7416 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
7417 invisible_found_p
= 1;
7420 limit
= Fnext_single_char_property_change (make_number (start_charpos
),
7422 make_number (end_charpos
));
7423 invisible_found_p
= XFASTINT (limit
) < end_charpos
;
7426 return invisible_found_p
;
7432 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7433 negative means move up. DVPOS == 0 means move to the start of the
7434 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7435 NEED_Y_P is zero, IT->current_y will be left unchanged.
7437 Further optimization ideas: If we would know that IT->f doesn't use
7438 a face with proportional font, we could be faster for
7439 truncate-lines nil. */
7442 move_it_by_lines (it
, dvpos
, need_y_p
)
7444 int dvpos
, need_y_p
;
7446 struct position pos
;
7448 /* The commented-out optimization uses vmotion on terminals. This
7449 gives bad results, because elements like it->what, on which
7450 callers such as pos_visible_p rely, aren't updated. */
7451 /* if (!FRAME_WINDOW_P (it->f))
7453 struct text_pos textpos;
7455 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7456 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7457 reseat (it, textpos, 1);
7458 it->vpos += pos.vpos;
7459 it->current_y += pos.vpos;
7465 /* DVPOS == 0 means move to the start of the screen line. */
7466 move_it_vertically_backward (it
, 0);
7467 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7468 /* Let next call to line_bottom_y calculate real line height */
7473 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7474 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7475 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7480 int start_charpos
, i
;
7482 /* Start at the beginning of the screen line containing IT's
7483 position. This may actually move vertically backwards,
7484 in case of overlays, so adjust dvpos accordingly. */
7486 move_it_vertically_backward (it
, 0);
7489 /* Go back -DVPOS visible lines and reseat the iterator there. */
7490 start_charpos
= IT_CHARPOS (*it
);
7491 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7492 back_to_previous_visible_line_start (it
);
7493 reseat (it
, it
->current
.pos
, 1);
7495 /* Move further back if we end up in a string or an image. */
7496 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7498 /* First try to move to start of display line. */
7500 move_it_vertically_backward (it
, 0);
7502 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7504 /* If start of line is still in string or image,
7505 move further back. */
7506 back_to_previous_visible_line_start (it
);
7507 reseat (it
, it
->current
.pos
, 1);
7511 it
->current_x
= it
->hpos
= 0;
7513 /* Above call may have moved too far if continuation lines
7514 are involved. Scan forward and see if it did. */
7516 it2
.vpos
= it2
.current_y
= 0;
7517 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7518 it
->vpos
-= it2
.vpos
;
7519 it
->current_y
-= it2
.current_y
;
7520 it
->current_x
= it
->hpos
= 0;
7522 /* If we moved too far back, move IT some lines forward. */
7523 if (it2
.vpos
> -dvpos
)
7525 int delta
= it2
.vpos
+ dvpos
;
7527 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7528 /* Move back again if we got too far ahead. */
7529 if (IT_CHARPOS (*it
) >= start_charpos
)
7535 /* Return 1 if IT points into the middle of a display vector. */
7538 in_display_vector_p (it
)
7541 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7542 && it
->current
.dpvec_index
> 0
7543 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7547 /***********************************************************************
7549 ***********************************************************************/
7552 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7556 add_to_log (format
, arg1
, arg2
)
7558 Lisp_Object arg1
, arg2
;
7560 Lisp_Object args
[3];
7561 Lisp_Object msg
, fmt
;
7564 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7567 /* Do nothing if called asynchronously. Inserting text into
7568 a buffer may call after-change-functions and alike and
7569 that would means running Lisp asynchronously. */
7570 if (handling_signal
)
7574 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7576 args
[0] = fmt
= build_string (format
);
7579 msg
= Fformat (3, args
);
7581 len
= SBYTES (msg
) + 1;
7582 SAFE_ALLOCA (buffer
, char *, len
);
7583 bcopy (SDATA (msg
), buffer
, len
);
7585 message_dolog (buffer
, len
- 1, 1, 0);
7592 /* Output a newline in the *Messages* buffer if "needs" one. */
7595 message_log_maybe_newline ()
7597 if (message_log_need_newline
)
7598 message_dolog ("", 0, 1, 0);
7602 /* Add a string M of length NBYTES to the message log, optionally
7603 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7604 nonzero, means interpret the contents of M as multibyte. This
7605 function calls low-level routines in order to bypass text property
7606 hooks, etc. which might not be safe to run.
7608 This may GC (insert may run before/after change hooks),
7609 so the buffer M must NOT point to a Lisp string. */
7612 message_dolog (m
, nbytes
, nlflag
, multibyte
)
7614 int nbytes
, nlflag
, multibyte
;
7616 if (!NILP (Vmemory_full
))
7619 if (!NILP (Vmessage_log_max
))
7621 struct buffer
*oldbuf
;
7622 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7623 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7624 int point_at_end
= 0;
7626 Lisp_Object old_deactivate_mark
, tem
;
7627 struct gcpro gcpro1
;
7629 old_deactivate_mark
= Vdeactivate_mark
;
7630 oldbuf
= current_buffer
;
7631 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7632 current_buffer
->undo_list
= Qt
;
7634 oldpoint
= message_dolog_marker1
;
7635 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7636 oldbegv
= message_dolog_marker2
;
7637 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7638 oldzv
= message_dolog_marker3
;
7639 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7640 GCPRO1 (old_deactivate_mark
);
7648 BEGV_BYTE
= BEG_BYTE
;
7651 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7653 /* Insert the string--maybe converting multibyte to single byte
7654 or vice versa, so that all the text fits the buffer. */
7656 && NILP (current_buffer
->enable_multibyte_characters
))
7658 int i
, c
, char_bytes
;
7659 unsigned char work
[1];
7661 /* Convert a multibyte string to single-byte
7662 for the *Message* buffer. */
7663 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
7665 c
= string_char_and_length (m
+ i
, nbytes
- i
, &char_bytes
);
7666 work
[0] = (ASCII_CHAR_P (c
)
7668 : multibyte_char_to_unibyte (c
, Qnil
));
7669 insert_1_both (work
, 1, 1, 1, 0, 0);
7672 else if (! multibyte
7673 && ! NILP (current_buffer
->enable_multibyte_characters
))
7675 int i
, c
, char_bytes
;
7676 unsigned char *msg
= (unsigned char *) m
;
7677 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7678 /* Convert a single-byte string to multibyte
7679 for the *Message* buffer. */
7680 for (i
= 0; i
< nbytes
; i
++)
7683 c
= unibyte_char_to_multibyte (c
);
7684 char_bytes
= CHAR_STRING (c
, str
);
7685 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
7689 insert_1 (m
, nbytes
, 1, 0, 0);
7693 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
7694 insert_1 ("\n", 1, 1, 0, 0);
7696 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7698 this_bol_byte
= PT_BYTE
;
7700 /* See if this line duplicates the previous one.
7701 If so, combine duplicates. */
7704 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7706 prev_bol_byte
= PT_BYTE
;
7708 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
7709 this_bol
, this_bol_byte
);
7712 del_range_both (prev_bol
, prev_bol_byte
,
7713 this_bol
, this_bol_byte
, 0);
7719 /* If you change this format, don't forget to also
7720 change message_log_check_duplicate. */
7721 sprintf (dupstr
, " [%d times]", dup
);
7722 duplen
= strlen (dupstr
);
7723 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
7724 insert_1 (dupstr
, duplen
, 1, 0, 1);
7729 /* If we have more than the desired maximum number of lines
7730 in the *Messages* buffer now, delete the oldest ones.
7731 This is safe because we don't have undo in this buffer. */
7733 if (NATNUMP (Vmessage_log_max
))
7735 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
7736 -XFASTINT (Vmessage_log_max
) - 1, 0);
7737 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
7740 BEGV
= XMARKER (oldbegv
)->charpos
;
7741 BEGV_BYTE
= marker_byte_position (oldbegv
);
7750 ZV
= XMARKER (oldzv
)->charpos
;
7751 ZV_BYTE
= marker_byte_position (oldzv
);
7755 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7757 /* We can't do Fgoto_char (oldpoint) because it will run some
7759 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
7760 XMARKER (oldpoint
)->bytepos
);
7763 unchain_marker (XMARKER (oldpoint
));
7764 unchain_marker (XMARKER (oldbegv
));
7765 unchain_marker (XMARKER (oldzv
));
7767 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
7768 set_buffer_internal (oldbuf
);
7770 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
7771 message_log_need_newline
= !nlflag
;
7772 Vdeactivate_mark
= old_deactivate_mark
;
7777 /* We are at the end of the buffer after just having inserted a newline.
7778 (Note: We depend on the fact we won't be crossing the gap.)
7779 Check to see if the most recent message looks a lot like the previous one.
7780 Return 0 if different, 1 if the new one should just replace it, or a
7781 value N > 1 if we should also append " [N times]". */
7784 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
7785 int prev_bol
, this_bol
;
7786 int prev_bol_byte
, this_bol_byte
;
7789 int len
= Z_BYTE
- 1 - this_bol_byte
;
7791 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
7792 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
7794 for (i
= 0; i
< len
; i
++)
7796 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
7804 if (*p1
++ == ' ' && *p1
++ == '[')
7807 while (*p1
>= '0' && *p1
<= '9')
7808 n
= n
* 10 + *p1
++ - '0';
7809 if (strncmp (p1
, " times]\n", 8) == 0)
7816 /* Display an echo area message M with a specified length of NBYTES
7817 bytes. The string may include null characters. If M is 0, clear
7818 out any existing message, and let the mini-buffer text show
7821 This may GC, so the buffer M must NOT point to a Lisp string. */
7824 message2 (m
, nbytes
, multibyte
)
7829 /* First flush out any partial line written with print. */
7830 message_log_maybe_newline ();
7832 message_dolog (m
, nbytes
, 1, multibyte
);
7833 message2_nolog (m
, nbytes
, multibyte
);
7837 /* The non-logging counterpart of message2. */
7840 message2_nolog (m
, nbytes
, multibyte
)
7842 int nbytes
, multibyte
;
7844 struct frame
*sf
= SELECTED_FRAME ();
7845 message_enable_multibyte
= multibyte
;
7849 if (noninteractive_need_newline
)
7850 putc ('\n', stderr
);
7851 noninteractive_need_newline
= 0;
7853 fwrite (m
, nbytes
, 1, stderr
);
7854 if (cursor_in_echo_area
== 0)
7855 fprintf (stderr
, "\n");
7858 /* A null message buffer means that the frame hasn't really been
7859 initialized yet. Error messages get reported properly by
7860 cmd_error, so this must be just an informative message; toss it. */
7861 else if (INTERACTIVE
7862 && sf
->glyphs_initialized_p
7863 && FRAME_MESSAGE_BUF (sf
))
7865 Lisp_Object mini_window
;
7868 /* Get the frame containing the mini-buffer
7869 that the selected frame is using. */
7870 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7871 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
7873 FRAME_SAMPLE_VISIBILITY (f
);
7874 if (FRAME_VISIBLE_P (sf
)
7875 && ! FRAME_VISIBLE_P (f
))
7876 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
7880 set_message (m
, Qnil
, nbytes
, multibyte
);
7881 if (minibuffer_auto_raise
)
7882 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
7885 clear_message (1, 1);
7887 do_pending_window_change (0);
7888 echo_area_display (1);
7889 do_pending_window_change (0);
7890 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
7891 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
7896 /* Display an echo area message M with a specified length of NBYTES
7897 bytes. The string may include null characters. If M is not a
7898 string, clear out any existing message, and let the mini-buffer
7901 This function cancels echoing. */
7904 message3 (m
, nbytes
, multibyte
)
7909 struct gcpro gcpro1
;
7912 clear_message (1,1);
7915 /* First flush out any partial line written with print. */
7916 message_log_maybe_newline ();
7922 SAFE_ALLOCA (buffer
, char *, nbytes
);
7923 bcopy (SDATA (m
), buffer
, nbytes
);
7924 message_dolog (buffer
, nbytes
, 1, multibyte
);
7927 message3_nolog (m
, nbytes
, multibyte
);
7933 /* The non-logging version of message3.
7934 This does not cancel echoing, because it is used for echoing.
7935 Perhaps we need to make a separate function for echoing
7936 and make this cancel echoing. */
7939 message3_nolog (m
, nbytes
, multibyte
)
7941 int nbytes
, multibyte
;
7943 struct frame
*sf
= SELECTED_FRAME ();
7944 message_enable_multibyte
= multibyte
;
7948 if (noninteractive_need_newline
)
7949 putc ('\n', stderr
);
7950 noninteractive_need_newline
= 0;
7952 fwrite (SDATA (m
), nbytes
, 1, stderr
);
7953 if (cursor_in_echo_area
== 0)
7954 fprintf (stderr
, "\n");
7957 /* A null message buffer means that the frame hasn't really been
7958 initialized yet. Error messages get reported properly by
7959 cmd_error, so this must be just an informative message; toss it. */
7960 else if (INTERACTIVE
7961 && sf
->glyphs_initialized_p
7962 && FRAME_MESSAGE_BUF (sf
))
7964 Lisp_Object mini_window
;
7968 /* Get the frame containing the mini-buffer
7969 that the selected frame is using. */
7970 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7971 frame
= XWINDOW (mini_window
)->frame
;
7974 FRAME_SAMPLE_VISIBILITY (f
);
7975 if (FRAME_VISIBLE_P (sf
)
7976 && !FRAME_VISIBLE_P (f
))
7977 Fmake_frame_visible (frame
);
7979 if (STRINGP (m
) && SCHARS (m
) > 0)
7981 set_message (NULL
, m
, nbytes
, multibyte
);
7982 if (minibuffer_auto_raise
)
7983 Fraise_frame (frame
);
7984 /* Assume we are not echoing.
7985 (If we are, echo_now will override this.) */
7986 echo_message_buffer
= Qnil
;
7989 clear_message (1, 1);
7991 do_pending_window_change (0);
7992 echo_area_display (1);
7993 do_pending_window_change (0);
7994 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
7995 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8000 /* Display a null-terminated echo area message M. If M is 0, clear
8001 out any existing message, and let the mini-buffer text show through.
8003 The buffer M must continue to exist until after the echo area gets
8004 cleared or some other message gets displayed there. Do not pass
8005 text that is stored in a Lisp string. Do not pass text in a buffer
8006 that was alloca'd. */
8012 message2 (m
, (m
? strlen (m
) : 0), 0);
8016 /* The non-logging counterpart of message1. */
8022 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8025 /* Display a message M which contains a single %s
8026 which gets replaced with STRING. */
8029 message_with_string (m
, string
, log
)
8034 CHECK_STRING (string
);
8040 if (noninteractive_need_newline
)
8041 putc ('\n', stderr
);
8042 noninteractive_need_newline
= 0;
8043 fprintf (stderr
, m
, SDATA (string
));
8044 if (cursor_in_echo_area
== 0)
8045 fprintf (stderr
, "\n");
8049 else if (INTERACTIVE
)
8051 /* The frame whose minibuffer we're going to display the message on.
8052 It may be larger than the selected frame, so we need
8053 to use its buffer, not the selected frame's buffer. */
8054 Lisp_Object mini_window
;
8055 struct frame
*f
, *sf
= SELECTED_FRAME ();
8057 /* Get the frame containing the minibuffer
8058 that the selected frame is using. */
8059 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8060 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8062 /* A null message buffer means that the frame hasn't really been
8063 initialized yet. Error messages get reported properly by
8064 cmd_error, so this must be just an informative message; toss it. */
8065 if (FRAME_MESSAGE_BUF (f
))
8067 Lisp_Object args
[2], message
;
8068 struct gcpro gcpro1
, gcpro2
;
8070 args
[0] = build_string (m
);
8071 args
[1] = message
= string
;
8072 GCPRO2 (args
[0], message
);
8075 message
= Fformat (2, args
);
8078 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8080 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8084 /* Print should start at the beginning of the message
8085 buffer next time. */
8086 message_buf_print
= 0;
8092 /* Dump an informative message to the minibuf. If M is 0, clear out
8093 any existing message, and let the mini-buffer text show through. */
8097 message (m
, a1
, a2
, a3
)
8099 EMACS_INT a1
, a2
, a3
;
8105 if (noninteractive_need_newline
)
8106 putc ('\n', stderr
);
8107 noninteractive_need_newline
= 0;
8108 fprintf (stderr
, m
, a1
, a2
, a3
);
8109 if (cursor_in_echo_area
== 0)
8110 fprintf (stderr
, "\n");
8114 else if (INTERACTIVE
)
8116 /* The frame whose mini-buffer we're going to display the message
8117 on. It may be larger than the selected frame, so we need to
8118 use its buffer, not the selected frame's buffer. */
8119 Lisp_Object mini_window
;
8120 struct frame
*f
, *sf
= SELECTED_FRAME ();
8122 /* Get the frame containing the mini-buffer
8123 that the selected frame is using. */
8124 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8125 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8127 /* A null message buffer means that the frame hasn't really been
8128 initialized yet. Error messages get reported properly by
8129 cmd_error, so this must be just an informative message; toss
8131 if (FRAME_MESSAGE_BUF (f
))
8142 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8143 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
8145 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8146 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3,
8148 #endif /* NO_ARG_ARRAY */
8150 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8155 /* Print should start at the beginning of the message
8156 buffer next time. */
8157 message_buf_print
= 0;
8163 /* The non-logging version of message. */
8166 message_nolog (m
, a1
, a2
, a3
)
8168 EMACS_INT a1
, a2
, a3
;
8170 Lisp_Object old_log_max
;
8171 old_log_max
= Vmessage_log_max
;
8172 Vmessage_log_max
= Qnil
;
8173 message (m
, a1
, a2
, a3
);
8174 Vmessage_log_max
= old_log_max
;
8178 /* Display the current message in the current mini-buffer. This is
8179 only called from error handlers in process.c, and is not time
8185 if (!NILP (echo_area_buffer
[0]))
8188 string
= Fcurrent_message ();
8189 message3 (string
, SBYTES (string
),
8190 !NILP (current_buffer
->enable_multibyte_characters
));
8195 /* Make sure echo area buffers in `echo_buffers' are live.
8196 If they aren't, make new ones. */
8199 ensure_echo_area_buffers ()
8203 for (i
= 0; i
< 2; ++i
)
8204 if (!BUFFERP (echo_buffer
[i
])
8205 || NILP (XBUFFER (echo_buffer
[i
])->name
))
8208 Lisp_Object old_buffer
;
8211 old_buffer
= echo_buffer
[i
];
8212 sprintf (name
, " *Echo Area %d*", i
);
8213 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8214 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
8216 for (j
= 0; j
< 2; ++j
)
8217 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8218 echo_area_buffer
[j
] = echo_buffer
[i
];
8223 /* Call FN with args A1..A4 with either the current or last displayed
8224 echo_area_buffer as current buffer.
8226 WHICH zero means use the current message buffer
8227 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8228 from echo_buffer[] and clear it.
8230 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8231 suitable buffer from echo_buffer[] and clear it.
8233 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8234 that the current message becomes the last displayed one, make
8235 choose a suitable buffer for echo_area_buffer[0], and clear it.
8237 Value is what FN returns. */
8240 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
)
8243 int (*fn
) P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
8249 int this_one
, the_other
, clear_buffer_p
, rc
;
8250 int count
= SPECPDL_INDEX ();
8252 /* If buffers aren't live, make new ones. */
8253 ensure_echo_area_buffers ();
8258 this_one
= 0, the_other
= 1;
8260 this_one
= 1, the_other
= 0;
8263 this_one
= 0, the_other
= 1;
8266 /* We need a fresh one in case the current echo buffer equals
8267 the one containing the last displayed echo area message. */
8268 if (!NILP (echo_area_buffer
[this_one
])
8269 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8270 echo_area_buffer
[this_one
] = Qnil
;
8273 /* Choose a suitable buffer from echo_buffer[] is we don't
8275 if (NILP (echo_area_buffer
[this_one
]))
8277 echo_area_buffer
[this_one
]
8278 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8279 ? echo_buffer
[the_other
]
8280 : echo_buffer
[this_one
]);
8284 buffer
= echo_area_buffer
[this_one
];
8286 /* Don't get confused by reusing the buffer used for echoing
8287 for a different purpose. */
8288 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8291 record_unwind_protect (unwind_with_echo_area_buffer
,
8292 with_echo_area_buffer_unwind_data (w
));
8294 /* Make the echo area buffer current. Note that for display
8295 purposes, it is not necessary that the displayed window's buffer
8296 == current_buffer, except for text property lookup. So, let's
8297 only set that buffer temporarily here without doing a full
8298 Fset_window_buffer. We must also change w->pointm, though,
8299 because otherwise an assertions in unshow_buffer fails, and Emacs
8301 set_buffer_internal_1 (XBUFFER (buffer
));
8305 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8308 current_buffer
->undo_list
= Qt
;
8309 current_buffer
->read_only
= Qnil
;
8310 specbind (Qinhibit_read_only
, Qt
);
8311 specbind (Qinhibit_modification_hooks
, Qt
);
8313 if (clear_buffer_p
&& Z
> BEG
)
8316 xassert (BEGV
>= BEG
);
8317 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8319 rc
= fn (a1
, a2
, a3
, a4
);
8321 xassert (BEGV
>= BEG
);
8322 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8324 unbind_to (count
, Qnil
);
8329 /* Save state that should be preserved around the call to the function
8330 FN called in with_echo_area_buffer. */
8333 with_echo_area_buffer_unwind_data (w
)
8337 Lisp_Object vector
, tmp
;
8339 /* Reduce consing by keeping one vector in
8340 Vwith_echo_area_save_vector. */
8341 vector
= Vwith_echo_area_save_vector
;
8342 Vwith_echo_area_save_vector
= Qnil
;
8345 vector
= Fmake_vector (make_number (7), Qnil
);
8347 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8348 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8349 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8353 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8354 ASET (vector
, i
, w
->buffer
); ++i
;
8355 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8356 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8361 for (; i
< end
; ++i
)
8362 ASET (vector
, i
, Qnil
);
8365 xassert (i
== ASIZE (vector
));
8370 /* Restore global state from VECTOR which was created by
8371 with_echo_area_buffer_unwind_data. */
8374 unwind_with_echo_area_buffer (vector
)
8377 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8378 Vdeactivate_mark
= AREF (vector
, 1);
8379 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8381 if (WINDOWP (AREF (vector
, 3)))
8384 Lisp_Object buffer
, charpos
, bytepos
;
8386 w
= XWINDOW (AREF (vector
, 3));
8387 buffer
= AREF (vector
, 4);
8388 charpos
= AREF (vector
, 5);
8389 bytepos
= AREF (vector
, 6);
8392 set_marker_both (w
->pointm
, buffer
,
8393 XFASTINT (charpos
), XFASTINT (bytepos
));
8396 Vwith_echo_area_save_vector
= vector
;
8401 /* Set up the echo area for use by print functions. MULTIBYTE_P
8402 non-zero means we will print multibyte. */
8405 setup_echo_area_for_printing (multibyte_p
)
8408 /* If we can't find an echo area any more, exit. */
8409 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8412 ensure_echo_area_buffers ();
8414 if (!message_buf_print
)
8416 /* A message has been output since the last time we printed.
8417 Choose a fresh echo area buffer. */
8418 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8419 echo_area_buffer
[0] = echo_buffer
[1];
8421 echo_area_buffer
[0] = echo_buffer
[0];
8423 /* Switch to that buffer and clear it. */
8424 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8425 current_buffer
->truncate_lines
= Qnil
;
8429 int count
= SPECPDL_INDEX ();
8430 specbind (Qinhibit_read_only
, Qt
);
8431 /* Note that undo recording is always disabled. */
8433 unbind_to (count
, Qnil
);
8435 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8437 /* Set up the buffer for the multibyteness we need. */
8439 != !NILP (current_buffer
->enable_multibyte_characters
))
8440 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8442 /* Raise the frame containing the echo area. */
8443 if (minibuffer_auto_raise
)
8445 struct frame
*sf
= SELECTED_FRAME ();
8446 Lisp_Object mini_window
;
8447 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8448 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8451 message_log_maybe_newline ();
8452 message_buf_print
= 1;
8456 if (NILP (echo_area_buffer
[0]))
8458 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8459 echo_area_buffer
[0] = echo_buffer
[1];
8461 echo_area_buffer
[0] = echo_buffer
[0];
8464 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8466 /* Someone switched buffers between print requests. */
8467 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8468 current_buffer
->truncate_lines
= Qnil
;
8474 /* Display an echo area message in window W. Value is non-zero if W's
8475 height is changed. If display_last_displayed_message_p is
8476 non-zero, display the message that was last displayed, otherwise
8477 display the current message. */
8480 display_echo_area (w
)
8483 int i
, no_message_p
, window_height_changed_p
, count
;
8485 /* Temporarily disable garbage collections while displaying the echo
8486 area. This is done because a GC can print a message itself.
8487 That message would modify the echo area buffer's contents while a
8488 redisplay of the buffer is going on, and seriously confuse
8490 count
= inhibit_garbage_collection ();
8492 /* If there is no message, we must call display_echo_area_1
8493 nevertheless because it resizes the window. But we will have to
8494 reset the echo_area_buffer in question to nil at the end because
8495 with_echo_area_buffer will sets it to an empty buffer. */
8496 i
= display_last_displayed_message_p
? 1 : 0;
8497 no_message_p
= NILP (echo_area_buffer
[i
]);
8499 window_height_changed_p
8500 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8501 display_echo_area_1
,
8502 (EMACS_INT
) w
, Qnil
, 0, 0);
8505 echo_area_buffer
[i
] = Qnil
;
8507 unbind_to (count
, Qnil
);
8508 return window_height_changed_p
;
8512 /* Helper for display_echo_area. Display the current buffer which
8513 contains the current echo area message in window W, a mini-window,
8514 a pointer to which is passed in A1. A2..A4 are currently not used.
8515 Change the height of W so that all of the message is displayed.
8516 Value is non-zero if height of W was changed. */
8519 display_echo_area_1 (a1
, a2
, a3
, a4
)
8524 struct window
*w
= (struct window
*) a1
;
8526 struct text_pos start
;
8527 int window_height_changed_p
= 0;
8529 /* Do this before displaying, so that we have a large enough glyph
8530 matrix for the display. If we can't get enough space for the
8531 whole text, display the last N lines. That works by setting w->start. */
8532 window_height_changed_p
= resize_mini_window (w
, 0);
8534 /* Use the starting position chosen by resize_mini_window. */
8535 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8538 clear_glyph_matrix (w
->desired_matrix
);
8539 XSETWINDOW (window
, w
);
8540 try_window (window
, start
, 0);
8542 return window_height_changed_p
;
8546 /* Resize the echo area window to exactly the size needed for the
8547 currently displayed message, if there is one. If a mini-buffer
8548 is active, don't shrink it. */
8551 resize_echo_area_exactly ()
8553 if (BUFFERP (echo_area_buffer
[0])
8554 && WINDOWP (echo_area_window
))
8556 struct window
*w
= XWINDOW (echo_area_window
);
8558 Lisp_Object resize_exactly
;
8560 if (minibuf_level
== 0)
8561 resize_exactly
= Qt
;
8563 resize_exactly
= Qnil
;
8565 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8566 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8569 ++windows_or_buffers_changed
;
8570 ++update_mode_lines
;
8571 redisplay_internal (0);
8577 /* Callback function for with_echo_area_buffer, when used from
8578 resize_echo_area_exactly. A1 contains a pointer to the window to
8579 resize, EXACTLY non-nil means resize the mini-window exactly to the
8580 size of the text displayed. A3 and A4 are not used. Value is what
8581 resize_mini_window returns. */
8584 resize_mini_window_1 (a1
, exactly
, a3
, a4
)
8586 Lisp_Object exactly
;
8589 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8593 /* Resize mini-window W to fit the size of its contents. EXACT_P
8594 means size the window exactly to the size needed. Otherwise, it's
8595 only enlarged until W's buffer is empty.
8597 Set W->start to the right place to begin display. If the whole
8598 contents fit, start at the beginning. Otherwise, start so as
8599 to make the end of the contents appear. This is particularly
8600 important for y-or-n-p, but seems desirable generally.
8602 Value is non-zero if the window height has been changed. */
8605 resize_mini_window (w
, exact_p
)
8609 struct frame
*f
= XFRAME (w
->frame
);
8610 int window_height_changed_p
= 0;
8612 xassert (MINI_WINDOW_P (w
));
8614 /* By default, start display at the beginning. */
8615 set_marker_both (w
->start
, w
->buffer
,
8616 BUF_BEGV (XBUFFER (w
->buffer
)),
8617 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8619 /* Don't resize windows while redisplaying a window; it would
8620 confuse redisplay functions when the size of the window they are
8621 displaying changes from under them. Such a resizing can happen,
8622 for instance, when which-func prints a long message while
8623 we are running fontification-functions. We're running these
8624 functions with safe_call which binds inhibit-redisplay to t. */
8625 if (!NILP (Vinhibit_redisplay
))
8628 /* Nil means don't try to resize. */
8629 if (NILP (Vresize_mini_windows
)
8630 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8633 if (!FRAME_MINIBUF_ONLY_P (f
))
8636 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8637 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8638 int height
, max_height
;
8639 int unit
= FRAME_LINE_HEIGHT (f
);
8640 struct text_pos start
;
8641 struct buffer
*old_current_buffer
= NULL
;
8643 if (current_buffer
!= XBUFFER (w
->buffer
))
8645 old_current_buffer
= current_buffer
;
8646 set_buffer_internal (XBUFFER (w
->buffer
));
8649 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8651 /* Compute the max. number of lines specified by the user. */
8652 if (FLOATP (Vmax_mini_window_height
))
8653 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8654 else if (INTEGERP (Vmax_mini_window_height
))
8655 max_height
= XINT (Vmax_mini_window_height
);
8657 max_height
= total_height
/ 4;
8659 /* Correct that max. height if it's bogus. */
8660 max_height
= max (1, max_height
);
8661 max_height
= min (total_height
, max_height
);
8663 /* Find out the height of the text in the window. */
8664 if (it
.line_wrap
== TRUNCATE
)
8669 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8670 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8671 height
= it
.current_y
+ last_height
;
8673 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
8674 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
8675 height
= (height
+ unit
- 1) / unit
;
8678 /* Compute a suitable window start. */
8679 if (height
> max_height
)
8681 height
= max_height
;
8682 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8683 move_it_vertically_backward (&it
, (height
- 1) * unit
);
8684 start
= it
.current
.pos
;
8687 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
8688 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
8690 if (EQ (Vresize_mini_windows
, Qgrow_only
))
8692 /* Let it grow only, until we display an empty message, in which
8693 case the window shrinks again. */
8694 if (height
> WINDOW_TOTAL_LINES (w
))
8696 int old_height
= WINDOW_TOTAL_LINES (w
);
8697 freeze_window_starts (f
, 1);
8698 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8699 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8701 else if (height
< WINDOW_TOTAL_LINES (w
)
8702 && (exact_p
|| BEGV
== ZV
))
8704 int old_height
= WINDOW_TOTAL_LINES (w
);
8705 freeze_window_starts (f
, 0);
8706 shrink_mini_window (w
);
8707 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8712 /* Always resize to exact size needed. */
8713 if (height
> WINDOW_TOTAL_LINES (w
))
8715 int old_height
= WINDOW_TOTAL_LINES (w
);
8716 freeze_window_starts (f
, 1);
8717 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8718 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8720 else if (height
< WINDOW_TOTAL_LINES (w
))
8722 int old_height
= WINDOW_TOTAL_LINES (w
);
8723 freeze_window_starts (f
, 0);
8724 shrink_mini_window (w
);
8728 freeze_window_starts (f
, 1);
8729 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8732 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8736 if (old_current_buffer
)
8737 set_buffer_internal (old_current_buffer
);
8740 return window_height_changed_p
;
8744 /* Value is the current message, a string, or nil if there is no
8752 if (!BUFFERP (echo_area_buffer
[0]))
8756 with_echo_area_buffer (0, 0, current_message_1
,
8757 (EMACS_INT
) &msg
, Qnil
, 0, 0);
8759 echo_area_buffer
[0] = Qnil
;
8767 current_message_1 (a1
, a2
, a3
, a4
)
8772 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
8775 *msg
= make_buffer_string (BEG
, Z
, 1);
8782 /* Push the current message on Vmessage_stack for later restauration
8783 by restore_message. Value is non-zero if the current message isn't
8784 empty. This is a relatively infrequent operation, so it's not
8785 worth optimizing. */
8791 msg
= current_message ();
8792 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
8793 return STRINGP (msg
);
8797 /* Restore message display from the top of Vmessage_stack. */
8804 xassert (CONSP (Vmessage_stack
));
8805 msg
= XCAR (Vmessage_stack
);
8807 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8809 message3_nolog (msg
, 0, 0);
8813 /* Handler for record_unwind_protect calling pop_message. */
8816 pop_message_unwind (dummy
)
8823 /* Pop the top-most entry off Vmessage_stack. */
8828 xassert (CONSP (Vmessage_stack
));
8829 Vmessage_stack
= XCDR (Vmessage_stack
);
8833 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
8834 exits. If the stack is not empty, we have a missing pop_message
8838 check_message_stack ()
8840 if (!NILP (Vmessage_stack
))
8845 /* Truncate to NCHARS what will be displayed in the echo area the next
8846 time we display it---but don't redisplay it now. */
8849 truncate_echo_area (nchars
)
8853 echo_area_buffer
[0] = Qnil
;
8854 /* A null message buffer means that the frame hasn't really been
8855 initialized yet. Error messages get reported properly by
8856 cmd_error, so this must be just an informative message; toss it. */
8857 else if (!noninteractive
8859 && !NILP (echo_area_buffer
[0]))
8861 struct frame
*sf
= SELECTED_FRAME ();
8862 if (FRAME_MESSAGE_BUF (sf
))
8863 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
8868 /* Helper function for truncate_echo_area. Truncate the current
8869 message to at most NCHARS characters. */
8872 truncate_message_1 (nchars
, a2
, a3
, a4
)
8877 if (BEG
+ nchars
< Z
)
8878 del_range (BEG
+ nchars
, Z
);
8880 echo_area_buffer
[0] = Qnil
;
8885 /* Set the current message to a substring of S or STRING.
8887 If STRING is a Lisp string, set the message to the first NBYTES
8888 bytes from STRING. NBYTES zero means use the whole string. If
8889 STRING is multibyte, the message will be displayed multibyte.
8891 If S is not null, set the message to the first LEN bytes of S. LEN
8892 zero means use the whole string. MULTIBYTE_P non-zero means S is
8893 multibyte. Display the message multibyte in that case.
8895 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
8896 to t before calling set_message_1 (which calls insert).
8900 set_message (s
, string
, nbytes
, multibyte_p
)
8903 int nbytes
, multibyte_p
;
8905 message_enable_multibyte
8906 = ((s
&& multibyte_p
)
8907 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
8909 with_echo_area_buffer (0, -1, set_message_1
,
8910 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
8911 message_buf_print
= 0;
8912 help_echo_showing_p
= 0;
8916 /* Helper function for set_message. Arguments have the same meaning
8917 as there, with A1 corresponding to S and A2 corresponding to STRING
8918 This function is called with the echo area buffer being
8922 set_message_1 (a1
, a2
, nbytes
, multibyte_p
)
8925 EMACS_INT nbytes
, multibyte_p
;
8927 const char *s
= (const char *) a1
;
8928 Lisp_Object string
= a2
;
8930 /* Change multibyteness of the echo buffer appropriately. */
8931 if (message_enable_multibyte
8932 != !NILP (current_buffer
->enable_multibyte_characters
))
8933 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
8935 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
8937 /* Insert new message at BEG. */
8938 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8940 if (STRINGP (string
))
8945 nbytes
= SBYTES (string
);
8946 nchars
= string_byte_to_char (string
, nbytes
);
8948 /* This function takes care of single/multibyte conversion. We
8949 just have to ensure that the echo area buffer has the right
8950 setting of enable_multibyte_characters. */
8951 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
8956 nbytes
= strlen (s
);
8958 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
8960 /* Convert from multi-byte to single-byte. */
8962 unsigned char work
[1];
8964 /* Convert a multibyte string to single-byte. */
8965 for (i
= 0; i
< nbytes
; i
+= n
)
8967 c
= string_char_and_length (s
+ i
, nbytes
- i
, &n
);
8968 work
[0] = (ASCII_CHAR_P (c
)
8970 : multibyte_char_to_unibyte (c
, Qnil
));
8971 insert_1_both (work
, 1, 1, 1, 0, 0);
8974 else if (!multibyte_p
8975 && !NILP (current_buffer
->enable_multibyte_characters
))
8977 /* Convert from single-byte to multi-byte. */
8979 const unsigned char *msg
= (const unsigned char *) s
;
8980 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8982 /* Convert a single-byte string to multibyte. */
8983 for (i
= 0; i
< nbytes
; i
++)
8986 c
= unibyte_char_to_multibyte (c
);
8987 n
= CHAR_STRING (c
, str
);
8988 insert_1_both (str
, 1, n
, 1, 0, 0);
8992 insert_1 (s
, nbytes
, 1, 0, 0);
8999 /* Clear messages. CURRENT_P non-zero means clear the current
9000 message. LAST_DISPLAYED_P non-zero means clear the message
9004 clear_message (current_p
, last_displayed_p
)
9005 int current_p
, last_displayed_p
;
9009 echo_area_buffer
[0] = Qnil
;
9010 message_cleared_p
= 1;
9013 if (last_displayed_p
)
9014 echo_area_buffer
[1] = Qnil
;
9016 message_buf_print
= 0;
9019 /* Clear garbaged frames.
9021 This function is used where the old redisplay called
9022 redraw_garbaged_frames which in turn called redraw_frame which in
9023 turn called clear_frame. The call to clear_frame was a source of
9024 flickering. I believe a clear_frame is not necessary. It should
9025 suffice in the new redisplay to invalidate all current matrices,
9026 and ensure a complete redisplay of all windows. */
9029 clear_garbaged_frames ()
9033 Lisp_Object tail
, frame
;
9034 int changed_count
= 0;
9036 FOR_EACH_FRAME (tail
, frame
)
9038 struct frame
*f
= XFRAME (frame
);
9040 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9044 Fredraw_frame (frame
);
9045 f
->force_flush_display_p
= 1;
9047 clear_current_matrices (f
);
9056 ++windows_or_buffers_changed
;
9061 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9062 is non-zero update selected_frame. Value is non-zero if the
9063 mini-windows height has been changed. */
9066 echo_area_display (update_frame_p
)
9069 Lisp_Object mini_window
;
9072 int window_height_changed_p
= 0;
9073 struct frame
*sf
= SELECTED_FRAME ();
9075 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9076 w
= XWINDOW (mini_window
);
9077 f
= XFRAME (WINDOW_FRAME (w
));
9079 /* Don't display if frame is invisible or not yet initialized. */
9080 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9083 #ifdef HAVE_WINDOW_SYSTEM
9084 /* When Emacs starts, selected_frame may be the initial terminal
9085 frame. If we let this through, a message would be displayed on
9087 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9089 #endif /* HAVE_WINDOW_SYSTEM */
9091 /* Redraw garbaged frames. */
9093 clear_garbaged_frames ();
9095 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9097 echo_area_window
= mini_window
;
9098 window_height_changed_p
= display_echo_area (w
);
9099 w
->must_be_updated_p
= 1;
9101 /* Update the display, unless called from redisplay_internal.
9102 Also don't update the screen during redisplay itself. The
9103 update will happen at the end of redisplay, and an update
9104 here could cause confusion. */
9105 if (update_frame_p
&& !redisplaying_p
)
9109 /* If the display update has been interrupted by pending
9110 input, update mode lines in the frame. Due to the
9111 pending input, it might have been that redisplay hasn't
9112 been called, so that mode lines above the echo area are
9113 garbaged. This looks odd, so we prevent it here. */
9114 if (!display_completed
)
9115 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9117 if (window_height_changed_p
9118 /* Don't do this if Emacs is shutting down. Redisplay
9119 needs to run hooks. */
9120 && !NILP (Vrun_hooks
))
9122 /* Must update other windows. Likewise as in other
9123 cases, don't let this update be interrupted by
9125 int count
= SPECPDL_INDEX ();
9126 specbind (Qredisplay_dont_pause
, Qt
);
9127 windows_or_buffers_changed
= 1;
9128 redisplay_internal (0);
9129 unbind_to (count
, Qnil
);
9131 else if (FRAME_WINDOW_P (f
) && n
== 0)
9133 /* Window configuration is the same as before.
9134 Can do with a display update of the echo area,
9135 unless we displayed some mode lines. */
9136 update_single_window (w
, 1);
9137 FRAME_RIF (f
)->flush_display (f
);
9140 update_frame (f
, 1, 1);
9142 /* If cursor is in the echo area, make sure that the next
9143 redisplay displays the minibuffer, so that the cursor will
9144 be replaced with what the minibuffer wants. */
9145 if (cursor_in_echo_area
)
9146 ++windows_or_buffers_changed
;
9149 else if (!EQ (mini_window
, selected_window
))
9150 windows_or_buffers_changed
++;
9152 /* Last displayed message is now the current message. */
9153 echo_area_buffer
[1] = echo_area_buffer
[0];
9154 /* Inform read_char that we're not echoing. */
9155 echo_message_buffer
= Qnil
;
9157 /* Prevent redisplay optimization in redisplay_internal by resetting
9158 this_line_start_pos. This is done because the mini-buffer now
9159 displays the message instead of its buffer text. */
9160 if (EQ (mini_window
, selected_window
))
9161 CHARPOS (this_line_start_pos
) = 0;
9163 return window_height_changed_p
;
9168 /***********************************************************************
9169 Mode Lines and Frame Titles
9170 ***********************************************************************/
9172 /* A buffer for constructing non-propertized mode-line strings and
9173 frame titles in it; allocated from the heap in init_xdisp and
9174 resized as needed in store_mode_line_noprop_char. */
9176 static char *mode_line_noprop_buf
;
9178 /* The buffer's end, and a current output position in it. */
9180 static char *mode_line_noprop_buf_end
;
9181 static char *mode_line_noprop_ptr
;
9183 #define MODE_LINE_NOPROP_LEN(start) \
9184 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9187 MODE_LINE_DISPLAY
= 0,
9193 /* Alist that caches the results of :propertize.
9194 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9195 static Lisp_Object mode_line_proptrans_alist
;
9197 /* List of strings making up the mode-line. */
9198 static Lisp_Object mode_line_string_list
;
9200 /* Base face property when building propertized mode line string. */
9201 static Lisp_Object mode_line_string_face
;
9202 static Lisp_Object mode_line_string_face_prop
;
9205 /* Unwind data for mode line strings */
9207 static Lisp_Object Vmode_line_unwind_vector
;
9210 format_mode_line_unwind_data (struct buffer
*obuf
,
9214 Lisp_Object vector
, tmp
;
9216 /* Reduce consing by keeping one vector in
9217 Vwith_echo_area_save_vector. */
9218 vector
= Vmode_line_unwind_vector
;
9219 Vmode_line_unwind_vector
= Qnil
;
9222 vector
= Fmake_vector (make_number (8), Qnil
);
9224 ASET (vector
, 0, make_number (mode_line_target
));
9225 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9226 ASET (vector
, 2, mode_line_string_list
);
9227 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9228 ASET (vector
, 4, mode_line_string_face
);
9229 ASET (vector
, 5, mode_line_string_face_prop
);
9232 XSETBUFFER (tmp
, obuf
);
9235 ASET (vector
, 6, tmp
);
9236 ASET (vector
, 7, owin
);
9242 unwind_format_mode_line (vector
)
9245 mode_line_target
= XINT (AREF (vector
, 0));
9246 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9247 mode_line_string_list
= AREF (vector
, 2);
9248 if (! EQ (AREF (vector
, 3), Qt
))
9249 mode_line_proptrans_alist
= AREF (vector
, 3);
9250 mode_line_string_face
= AREF (vector
, 4);
9251 mode_line_string_face_prop
= AREF (vector
, 5);
9253 if (!NILP (AREF (vector
, 7)))
9254 /* Select window before buffer, since it may change the buffer. */
9255 Fselect_window (AREF (vector
, 7), Qt
);
9257 if (!NILP (AREF (vector
, 6)))
9259 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9260 ASET (vector
, 6, Qnil
);
9263 Vmode_line_unwind_vector
= vector
;
9268 /* Store a single character C for the frame title in mode_line_noprop_buf.
9269 Re-allocate mode_line_noprop_buf if necessary. */
9273 store_mode_line_noprop_char (char c
)
9275 store_mode_line_noprop_char (c
)
9279 /* If output position has reached the end of the allocated buffer,
9280 double the buffer's size. */
9281 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9283 int len
= MODE_LINE_NOPROP_LEN (0);
9284 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9285 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9286 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9287 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9290 *mode_line_noprop_ptr
++ = c
;
9294 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9295 mode_line_noprop_ptr. STR is the string to store. Do not copy
9296 characters that yield more columns than PRECISION; PRECISION <= 0
9297 means copy the whole string. Pad with spaces until FIELD_WIDTH
9298 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9299 pad. Called from display_mode_element when it is used to build a
9303 store_mode_line_noprop (str
, field_width
, precision
)
9304 const unsigned char *str
;
9305 int field_width
, precision
;
9310 /* Copy at most PRECISION chars from STR. */
9311 nbytes
= strlen (str
);
9312 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9314 store_mode_line_noprop_char (*str
++);
9316 /* Fill up with spaces until FIELD_WIDTH reached. */
9317 while (field_width
> 0
9320 store_mode_line_noprop_char (' ');
9327 /***********************************************************************
9329 ***********************************************************************/
9331 #ifdef HAVE_WINDOW_SYSTEM
9333 /* Set the title of FRAME, if it has changed. The title format is
9334 Vicon_title_format if FRAME is iconified, otherwise it is
9335 frame_title_format. */
9338 x_consider_frame_title (frame
)
9341 struct frame
*f
= XFRAME (frame
);
9343 if (FRAME_WINDOW_P (f
)
9344 || FRAME_MINIBUF_ONLY_P (f
)
9345 || f
->explicit_name
)
9347 /* Do we have more than one visible frame on this X display? */
9354 int count
= SPECPDL_INDEX ();
9356 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9358 Lisp_Object other_frame
= XCAR (tail
);
9359 struct frame
*tf
= XFRAME (other_frame
);
9362 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9363 && !FRAME_MINIBUF_ONLY_P (tf
)
9364 && !EQ (other_frame
, tip_frame
)
9365 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9369 /* Set global variable indicating that multiple frames exist. */
9370 multiple_frames
= CONSP (tail
);
9372 /* Switch to the buffer of selected window of the frame. Set up
9373 mode_line_target so that display_mode_element will output into
9374 mode_line_noprop_buf; then display the title. */
9375 record_unwind_protect (unwind_format_mode_line
,
9376 format_mode_line_unwind_data
9377 (current_buffer
, selected_window
, 0));
9379 Fselect_window (f
->selected_window
, Qt
);
9380 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9381 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9383 mode_line_target
= MODE_LINE_TITLE
;
9384 title_start
= MODE_LINE_NOPROP_LEN (0);
9385 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9386 NULL
, DEFAULT_FACE_ID
);
9387 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9388 len
= MODE_LINE_NOPROP_LEN (title_start
);
9389 title
= mode_line_noprop_buf
+ title_start
;
9390 unbind_to (count
, Qnil
);
9392 /* Set the title only if it's changed. This avoids consing in
9393 the common case where it hasn't. (If it turns out that we've
9394 already wasted too much time by walking through the list with
9395 display_mode_element, then we might need to optimize at a
9396 higher level than this.) */
9397 if (! STRINGP (f
->name
)
9398 || SBYTES (f
->name
) != len
9399 || bcmp (title
, SDATA (f
->name
), len
) != 0)
9400 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9404 #endif /* not HAVE_WINDOW_SYSTEM */
9409 /***********************************************************************
9411 ***********************************************************************/
9414 /* Prepare for redisplay by updating menu-bar item lists when
9415 appropriate. This can call eval. */
9418 prepare_menu_bars ()
9421 struct gcpro gcpro1
, gcpro2
;
9423 Lisp_Object tooltip_frame
;
9425 #ifdef HAVE_WINDOW_SYSTEM
9426 tooltip_frame
= tip_frame
;
9428 tooltip_frame
= Qnil
;
9431 /* Update all frame titles based on their buffer names, etc. We do
9432 this before the menu bars so that the buffer-menu will show the
9433 up-to-date frame titles. */
9434 #ifdef HAVE_WINDOW_SYSTEM
9435 if (windows_or_buffers_changed
|| update_mode_lines
)
9437 Lisp_Object tail
, frame
;
9439 FOR_EACH_FRAME (tail
, frame
)
9442 if (!EQ (frame
, tooltip_frame
)
9443 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9444 x_consider_frame_title (frame
);
9447 #endif /* HAVE_WINDOW_SYSTEM */
9449 /* Update the menu bar item lists, if appropriate. This has to be
9450 done before any actual redisplay or generation of display lines. */
9451 all_windows
= (update_mode_lines
9452 || buffer_shared
> 1
9453 || windows_or_buffers_changed
);
9456 Lisp_Object tail
, frame
;
9457 int count
= SPECPDL_INDEX ();
9458 /* 1 means that update_menu_bar has run its hooks
9459 so any further calls to update_menu_bar shouldn't do so again. */
9460 int menu_bar_hooks_run
= 0;
9462 record_unwind_save_match_data ();
9464 FOR_EACH_FRAME (tail
, frame
)
9468 /* Ignore tooltip frame. */
9469 if (EQ (frame
, tooltip_frame
))
9472 /* If a window on this frame changed size, report that to
9473 the user and clear the size-change flag. */
9474 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9476 Lisp_Object functions
;
9478 /* Clear flag first in case we get an error below. */
9479 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9480 functions
= Vwindow_size_change_functions
;
9481 GCPRO2 (tail
, functions
);
9483 while (CONSP (functions
))
9485 call1 (XCAR (functions
), frame
);
9486 functions
= XCDR (functions
);
9492 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9493 #ifdef HAVE_WINDOW_SYSTEM
9494 update_tool_bar (f
, 0);
9496 mac_update_title_bar (f
, 0);
9502 unbind_to (count
, Qnil
);
9506 struct frame
*sf
= SELECTED_FRAME ();
9507 update_menu_bar (sf
, 1, 0);
9508 #ifdef HAVE_WINDOW_SYSTEM
9509 update_tool_bar (sf
, 1);
9511 mac_update_title_bar (sf
, 1);
9516 /* Motif needs this. See comment in xmenu.c. Turn it off when
9517 pending_menu_activation is not defined. */
9518 #ifdef USE_X_TOOLKIT
9519 pending_menu_activation
= 0;
9524 /* Update the menu bar item list for frame F. This has to be done
9525 before we start to fill in any display lines, because it can call
9528 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9530 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9531 already ran the menu bar hooks for this redisplay, so there
9532 is no need to run them again. The return value is the
9533 updated value of this flag, to pass to the next call. */
9536 update_menu_bar (f
, save_match_data
, hooks_run
)
9538 int save_match_data
;
9542 register struct window
*w
;
9544 /* If called recursively during a menu update, do nothing. This can
9545 happen when, for instance, an activate-menubar-hook causes a
9547 if (inhibit_menubar_update
)
9550 window
= FRAME_SELECTED_WINDOW (f
);
9551 w
= XWINDOW (window
);
9553 #if 0 /* The if statement below this if statement used to include the
9554 condition !NILP (w->update_mode_line), rather than using
9555 update_mode_lines directly, and this if statement may have
9556 been added to make that condition work. Now the if
9557 statement below matches its comment, this isn't needed. */
9558 if (update_mode_lines
)
9559 w
->update_mode_line
= Qt
;
9562 if (FRAME_WINDOW_P (f
)
9564 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
9565 || defined (USE_GTK)
9566 FRAME_EXTERNAL_MENU_BAR (f
)
9568 FRAME_MENU_BAR_LINES (f
) > 0
9570 : FRAME_MENU_BAR_LINES (f
) > 0)
9572 /* If the user has switched buffers or windows, we need to
9573 recompute to reflect the new bindings. But we'll
9574 recompute when update_mode_lines is set too; that means
9575 that people can use force-mode-line-update to request
9576 that the menu bar be recomputed. The adverse effect on
9577 the rest of the redisplay algorithm is about the same as
9578 windows_or_buffers_changed anyway. */
9579 if (windows_or_buffers_changed
9580 /* This used to test w->update_mode_line, but we believe
9581 there is no need to recompute the menu in that case. */
9582 || update_mode_lines
9583 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9584 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9585 != !NILP (w
->last_had_star
))
9586 || ((!NILP (Vtransient_mark_mode
)
9587 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9588 != !NILP (w
->region_showing
)))
9590 struct buffer
*prev
= current_buffer
;
9591 int count
= SPECPDL_INDEX ();
9593 specbind (Qinhibit_menubar_update
, Qt
);
9595 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9596 if (save_match_data
)
9597 record_unwind_save_match_data ();
9598 if (NILP (Voverriding_local_map_menu_flag
))
9600 specbind (Qoverriding_terminal_local_map
, Qnil
);
9601 specbind (Qoverriding_local_map
, Qnil
);
9606 /* Run the Lucid hook. */
9607 safe_run_hooks (Qactivate_menubar_hook
);
9609 /* If it has changed current-menubar from previous value,
9610 really recompute the menu-bar from the value. */
9611 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9612 call0 (Qrecompute_lucid_menubar
);
9614 safe_run_hooks (Qmenu_bar_update_hook
);
9619 XSETFRAME (Vmenu_updating_frame
, f
);
9620 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9622 /* Redisplay the menu bar in case we changed it. */
9623 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
9624 || defined (USE_GTK)
9625 if (FRAME_WINDOW_P (f
))
9628 /* All frames on Mac OS share the same menubar. So only
9629 the selected frame should be allowed to set it. */
9630 if (f
== SELECTED_FRAME ())
9632 set_frame_menubar (f
, 0, 0);
9635 /* On a terminal screen, the menu bar is an ordinary screen
9636 line, and this makes it get updated. */
9637 w
->update_mode_line
= Qt
;
9638 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || MAC_OS || USE_GTK) */
9639 /* In the non-toolkit version, the menu bar is an ordinary screen
9640 line, and this makes it get updated. */
9641 w
->update_mode_line
= Qt
;
9642 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || MAC_OS || USE_GTK) */
9644 unbind_to (count
, Qnil
);
9645 set_buffer_internal_1 (prev
);
9654 /***********************************************************************
9656 ***********************************************************************/
9658 #ifdef HAVE_WINDOW_SYSTEM
9661 Nominal cursor position -- where to draw output.
9662 HPOS and VPOS are window relative glyph matrix coordinates.
9663 X and Y are window relative pixel coordinates. */
9665 struct cursor_pos output_cursor
;
9669 Set the global variable output_cursor to CURSOR. All cursor
9670 positions are relative to updated_window. */
9673 set_output_cursor (cursor
)
9674 struct cursor_pos
*cursor
;
9676 output_cursor
.hpos
= cursor
->hpos
;
9677 output_cursor
.vpos
= cursor
->vpos
;
9678 output_cursor
.x
= cursor
->x
;
9679 output_cursor
.y
= cursor
->y
;
9684 Set a nominal cursor position.
9686 HPOS and VPOS are column/row positions in a window glyph matrix. X
9687 and Y are window text area relative pixel positions.
9689 If this is done during an update, updated_window will contain the
9690 window that is being updated and the position is the future output
9691 cursor position for that window. If updated_window is null, use
9692 selected_window and display the cursor at the given position. */
9695 x_cursor_to (vpos
, hpos
, y
, x
)
9696 int vpos
, hpos
, y
, x
;
9700 /* If updated_window is not set, work on selected_window. */
9704 w
= XWINDOW (selected_window
);
9706 /* Set the output cursor. */
9707 output_cursor
.hpos
= hpos
;
9708 output_cursor
.vpos
= vpos
;
9709 output_cursor
.x
= x
;
9710 output_cursor
.y
= y
;
9712 /* If not called as part of an update, really display the cursor.
9713 This will also set the cursor position of W. */
9714 if (updated_window
== NULL
)
9717 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
9718 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
9719 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
9724 #endif /* HAVE_WINDOW_SYSTEM */
9727 /***********************************************************************
9729 ***********************************************************************/
9731 #ifdef HAVE_WINDOW_SYSTEM
9733 /* Where the mouse was last time we reported a mouse event. */
9735 FRAME_PTR last_mouse_frame
;
9737 /* Tool-bar item index of the item on which a mouse button was pressed
9740 int last_tool_bar_item
;
9743 /* Update the tool-bar item list for frame F. This has to be done
9744 before we start to fill in any display lines. Called from
9745 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
9746 and restore it here. */
9749 update_tool_bar (f
, save_match_data
)
9751 int save_match_data
;
9753 #if defined (USE_GTK) || USE_MAC_TOOLBAR
9754 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
9756 int do_update
= WINDOWP (f
->tool_bar_window
)
9757 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
9765 window
= FRAME_SELECTED_WINDOW (f
);
9766 w
= XWINDOW (window
);
9768 /* If the user has switched buffers or windows, we need to
9769 recompute to reflect the new bindings. But we'll
9770 recompute when update_mode_lines is set too; that means
9771 that people can use force-mode-line-update to request
9772 that the menu bar be recomputed. The adverse effect on
9773 the rest of the redisplay algorithm is about the same as
9774 windows_or_buffers_changed anyway. */
9775 if (windows_or_buffers_changed
9776 || !NILP (w
->update_mode_line
)
9777 || update_mode_lines
9778 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9779 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9780 != !NILP (w
->last_had_star
))
9781 || ((!NILP (Vtransient_mark_mode
)
9782 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9783 != !NILP (w
->region_showing
)))
9785 struct buffer
*prev
= current_buffer
;
9786 int count
= SPECPDL_INDEX ();
9787 Lisp_Object new_tool_bar
;
9789 struct gcpro gcpro1
;
9791 /* Set current_buffer to the buffer of the selected
9792 window of the frame, so that we get the right local
9794 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9796 /* Save match data, if we must. */
9797 if (save_match_data
)
9798 record_unwind_save_match_data ();
9800 /* Make sure that we don't accidentally use bogus keymaps. */
9801 if (NILP (Voverriding_local_map_menu_flag
))
9803 specbind (Qoverriding_terminal_local_map
, Qnil
);
9804 specbind (Qoverriding_local_map
, Qnil
);
9807 GCPRO1 (new_tool_bar
);
9809 /* Build desired tool-bar items from keymaps. */
9810 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
9813 /* Redisplay the tool-bar if we changed it. */
9814 if (new_n_tool_bar
!= f
->n_tool_bar_items
9815 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
9817 /* Redisplay that happens asynchronously due to an expose event
9818 may access f->tool_bar_items. Make sure we update both
9819 variables within BLOCK_INPUT so no such event interrupts. */
9821 f
->tool_bar_items
= new_tool_bar
;
9822 f
->n_tool_bar_items
= new_n_tool_bar
;
9823 w
->update_mode_line
= Qt
;
9829 unbind_to (count
, Qnil
);
9830 set_buffer_internal_1 (prev
);
9836 /* Set F->desired_tool_bar_string to a Lisp string representing frame
9837 F's desired tool-bar contents. F->tool_bar_items must have
9838 been set up previously by calling prepare_menu_bars. */
9841 build_desired_tool_bar_string (f
)
9844 int i
, size
, size_needed
;
9845 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9846 Lisp_Object image
, plist
, props
;
9848 image
= plist
= props
= Qnil
;
9849 GCPRO3 (image
, plist
, props
);
9851 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
9852 Otherwise, make a new string. */
9854 /* The size of the string we might be able to reuse. */
9855 size
= (STRINGP (f
->desired_tool_bar_string
)
9856 ? SCHARS (f
->desired_tool_bar_string
)
9859 /* We need one space in the string for each image. */
9860 size_needed
= f
->n_tool_bar_items
;
9862 /* Reuse f->desired_tool_bar_string, if possible. */
9863 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
9864 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
9868 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
9869 Fremove_text_properties (make_number (0), make_number (size
),
9870 props
, f
->desired_tool_bar_string
);
9873 /* Put a `display' property on the string for the images to display,
9874 put a `menu_item' property on tool-bar items with a value that
9875 is the index of the item in F's tool-bar item vector. */
9876 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
9878 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
9880 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
9881 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
9882 int hmargin
, vmargin
, relief
, idx
, end
;
9883 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
;
9885 /* If image is a vector, choose the image according to the
9887 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
9888 if (VECTORP (image
))
9892 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
9893 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
9896 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
9897 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
9899 xassert (ASIZE (image
) >= idx
);
9900 image
= AREF (image
, idx
);
9905 /* Ignore invalid image specifications. */
9906 if (!valid_image_p (image
))
9909 /* Display the tool-bar button pressed, or depressed. */
9910 plist
= Fcopy_sequence (XCDR (image
));
9912 /* Compute margin and relief to draw. */
9913 relief
= (tool_bar_button_relief
>= 0
9914 ? tool_bar_button_relief
9915 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
9916 hmargin
= vmargin
= relief
;
9918 if (INTEGERP (Vtool_bar_button_margin
)
9919 && XINT (Vtool_bar_button_margin
) > 0)
9921 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
9922 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
9924 else if (CONSP (Vtool_bar_button_margin
))
9926 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
9927 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
9928 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
9930 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
9931 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
9932 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
9935 if (auto_raise_tool_bar_buttons_p
)
9937 /* Add a `:relief' property to the image spec if the item is
9941 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
9948 /* If image is selected, display it pressed, i.e. with a
9949 negative relief. If it's not selected, display it with a
9951 plist
= Fplist_put (plist
, QCrelief
,
9953 ? make_number (-relief
)
9954 : make_number (relief
)));
9959 /* Put a margin around the image. */
9960 if (hmargin
|| vmargin
)
9962 if (hmargin
== vmargin
)
9963 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
9965 plist
= Fplist_put (plist
, QCmargin
,
9966 Fcons (make_number (hmargin
),
9967 make_number (vmargin
)));
9970 /* If button is not enabled, and we don't have special images
9971 for the disabled state, make the image appear disabled by
9972 applying an appropriate algorithm to it. */
9973 if (!enabled_p
&& idx
< 0)
9974 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
9976 /* Put a `display' text property on the string for the image to
9977 display. Put a `menu-item' property on the string that gives
9978 the start of this item's properties in the tool-bar items
9980 image
= Fcons (Qimage
, plist
);
9981 props
= list4 (Qdisplay
, image
,
9982 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
9984 /* Let the last image hide all remaining spaces in the tool bar
9985 string. The string can be longer than needed when we reuse a
9987 if (i
+ 1 == f
->n_tool_bar_items
)
9988 end
= SCHARS (f
->desired_tool_bar_string
);
9991 Fadd_text_properties (make_number (i
), make_number (end
),
9992 props
, f
->desired_tool_bar_string
);
10000 /* Display one line of the tool-bar of frame IT->f.
10002 HEIGHT specifies the desired height of the tool-bar line.
10003 If the actual height of the glyph row is less than HEIGHT, the
10004 row's height is increased to HEIGHT, and the icons are centered
10005 vertically in the new height.
10007 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10008 count a final empty row in case the tool-bar width exactly matches
10013 display_tool_bar_line (it
, height
)
10017 struct glyph_row
*row
= it
->glyph_row
;
10018 int max_x
= it
->last_visible_x
;
10019 struct glyph
*last
;
10021 prepare_desired_row (row
);
10022 row
->y
= it
->current_y
;
10024 /* Note that this isn't made use of if the face hasn't a box,
10025 so there's no need to check the face here. */
10026 it
->start_of_box_run_p
= 1;
10028 while (it
->current_x
< max_x
)
10030 int x
, n_glyphs_before
, i
, nglyphs
;
10031 struct it it_before
;
10033 /* Get the next display element. */
10034 if (!get_next_display_element (it
))
10036 /* Don't count empty row if we are counting needed tool-bar lines. */
10037 if (height
< 0 && !it
->hpos
)
10042 /* Produce glyphs. */
10043 n_glyphs_before
= row
->used
[TEXT_AREA
];
10046 PRODUCE_GLYPHS (it
);
10048 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10050 x
= it_before
.current_x
;
10051 while (i
< nglyphs
)
10053 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10055 if (x
+ glyph
->pixel_width
> max_x
)
10057 /* Glyph doesn't fit on line. Backtrack. */
10058 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10060 /* If this is the only glyph on this line, it will never fit on the
10061 toolbar, so skip it. But ensure there is at least one glyph,
10062 so we don't accidentally disable the tool-bar. */
10063 if (n_glyphs_before
== 0
10064 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10070 x
+= glyph
->pixel_width
;
10074 /* Stop at line ends. */
10075 if (ITERATOR_AT_END_OF_LINE_P (it
))
10078 set_iterator_to_next (it
, 1);
10083 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10085 /* Use default face for the border below the tool bar.
10087 FIXME: When auto-resize-tool-bars is grow-only, there is
10088 no additional border below the possibly empty tool-bar lines.
10089 So to make the extra empty lines look "normal", we have to
10090 use the tool-bar face for the border too. */
10091 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10092 it
->face_id
= DEFAULT_FACE_ID
;
10094 extend_face_to_end_of_line (it
);
10095 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10096 last
->right_box_line_p
= 1;
10097 if (last
== row
->glyphs
[TEXT_AREA
])
10098 last
->left_box_line_p
= 1;
10100 /* Make line the desired height and center it vertically. */
10101 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10103 /* Don't add more than one line height. */
10104 height
%= FRAME_LINE_HEIGHT (it
->f
);
10105 it
->max_ascent
+= height
/ 2;
10106 it
->max_descent
+= (height
+ 1) / 2;
10109 compute_line_metrics (it
);
10111 /* If line is empty, make it occupy the rest of the tool-bar. */
10112 if (!row
->displays_text_p
)
10114 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10115 row
->visible_height
= row
->height
;
10116 row
->ascent
= row
->phys_ascent
= 0;
10117 row
->extra_line_spacing
= 0;
10120 row
->full_width_p
= 1;
10121 row
->continued_p
= 0;
10122 row
->truncated_on_left_p
= 0;
10123 row
->truncated_on_right_p
= 0;
10125 it
->current_x
= it
->hpos
= 0;
10126 it
->current_y
+= row
->height
;
10132 /* Max tool-bar height. */
10134 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10135 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10137 /* Value is the number of screen lines needed to make all tool-bar
10138 items of frame F visible. The number of actual rows needed is
10139 returned in *N_ROWS if non-NULL. */
10142 tool_bar_lines_needed (f
, n_rows
)
10146 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10148 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10149 the desired matrix, so use (unused) mode-line row as temporary row to
10150 avoid destroying the first tool-bar row. */
10151 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10153 /* Initialize an iterator for iteration over
10154 F->desired_tool_bar_string in the tool-bar window of frame F. */
10155 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10156 it
.first_visible_x
= 0;
10157 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10158 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10160 while (!ITERATOR_AT_END_P (&it
))
10162 clear_glyph_row (temp_row
);
10163 it
.glyph_row
= temp_row
;
10164 display_tool_bar_line (&it
, -1);
10166 clear_glyph_row (temp_row
);
10168 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10170 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10172 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10176 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10178 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10187 frame
= selected_frame
;
10189 CHECK_FRAME (frame
);
10190 f
= XFRAME (frame
);
10192 if (WINDOWP (f
->tool_bar_window
)
10193 || (w
= XWINDOW (f
->tool_bar_window
),
10194 WINDOW_TOTAL_LINES (w
) > 0))
10196 update_tool_bar (f
, 1);
10197 if (f
->n_tool_bar_items
)
10199 build_desired_tool_bar_string (f
);
10200 nlines
= tool_bar_lines_needed (f
, NULL
);
10204 return make_number (nlines
);
10208 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10209 height should be changed. */
10212 redisplay_tool_bar (f
)
10217 struct glyph_row
*row
;
10219 #if defined (USE_GTK) || USE_MAC_TOOLBAR
10220 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10221 update_frame_tool_bar (f
);
10225 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10226 do anything. This means you must start with tool-bar-lines
10227 non-zero to get the auto-sizing effect. Or in other words, you
10228 can turn off tool-bars by specifying tool-bar-lines zero. */
10229 if (!WINDOWP (f
->tool_bar_window
)
10230 || (w
= XWINDOW (f
->tool_bar_window
),
10231 WINDOW_TOTAL_LINES (w
) == 0))
10234 /* Set up an iterator for the tool-bar window. */
10235 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10236 it
.first_visible_x
= 0;
10237 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10238 row
= it
.glyph_row
;
10240 /* Build a string that represents the contents of the tool-bar. */
10241 build_desired_tool_bar_string (f
);
10242 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10244 if (f
->n_tool_bar_rows
== 0)
10248 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10249 nlines
!= WINDOW_TOTAL_LINES (w
)))
10251 extern Lisp_Object Qtool_bar_lines
;
10253 int old_height
= WINDOW_TOTAL_LINES (w
);
10255 XSETFRAME (frame
, f
);
10256 Fmodify_frame_parameters (frame
,
10257 Fcons (Fcons (Qtool_bar_lines
,
10258 make_number (nlines
)),
10260 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10262 clear_glyph_matrix (w
->desired_matrix
);
10263 fonts_changed_p
= 1;
10269 /* Display as many lines as needed to display all tool-bar items. */
10271 if (f
->n_tool_bar_rows
> 0)
10273 int border
, rows
, height
, extra
;
10275 if (INTEGERP (Vtool_bar_border
))
10276 border
= XINT (Vtool_bar_border
);
10277 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10278 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10279 else if (EQ (Vtool_bar_border
, Qborder_width
))
10280 border
= f
->border_width
;
10286 rows
= f
->n_tool_bar_rows
;
10287 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10288 extra
= it
.last_visible_y
- border
- height
* rows
;
10290 while (it
.current_y
< it
.last_visible_y
)
10293 if (extra
> 0 && rows
-- > 0)
10295 h
= (extra
+ rows
- 1) / rows
;
10298 display_tool_bar_line (&it
, height
+ h
);
10303 while (it
.current_y
< it
.last_visible_y
)
10304 display_tool_bar_line (&it
, 0);
10307 /* It doesn't make much sense to try scrolling in the tool-bar
10308 window, so don't do it. */
10309 w
->desired_matrix
->no_scrolling_p
= 1;
10310 w
->must_be_updated_p
= 1;
10312 if (!NILP (Vauto_resize_tool_bars
))
10314 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10315 int change_height_p
= 0;
10317 /* If we couldn't display everything, change the tool-bar's
10318 height if there is room for more. */
10319 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10320 && it
.current_y
< max_tool_bar_height
)
10321 change_height_p
= 1;
10323 row
= it
.glyph_row
- 1;
10325 /* If there are blank lines at the end, except for a partially
10326 visible blank line at the end that is smaller than
10327 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10328 if (!row
->displays_text_p
10329 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10330 change_height_p
= 1;
10332 /* If row displays tool-bar items, but is partially visible,
10333 change the tool-bar's height. */
10334 if (row
->displays_text_p
10335 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10336 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10337 change_height_p
= 1;
10339 /* Resize windows as needed by changing the `tool-bar-lines'
10340 frame parameter. */
10341 if (change_height_p
)
10343 extern Lisp_Object Qtool_bar_lines
;
10345 int old_height
= WINDOW_TOTAL_LINES (w
);
10347 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10349 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10350 && !f
->minimize_tool_bar_window_p
)
10351 ? (nlines
> old_height
)
10352 : (nlines
!= old_height
));
10353 f
->minimize_tool_bar_window_p
= 0;
10355 if (change_height_p
)
10357 XSETFRAME (frame
, f
);
10358 Fmodify_frame_parameters (frame
,
10359 Fcons (Fcons (Qtool_bar_lines
,
10360 make_number (nlines
)),
10362 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10364 clear_glyph_matrix (w
->desired_matrix
);
10365 f
->n_tool_bar_rows
= nrows
;
10366 fonts_changed_p
= 1;
10373 f
->minimize_tool_bar_window_p
= 0;
10378 /* Get information about the tool-bar item which is displayed in GLYPH
10379 on frame F. Return in *PROP_IDX the index where tool-bar item
10380 properties start in F->tool_bar_items. Value is zero if
10381 GLYPH doesn't display a tool-bar item. */
10384 tool_bar_item_info (f
, glyph
, prop_idx
)
10386 struct glyph
*glyph
;
10393 /* This function can be called asynchronously, which means we must
10394 exclude any possibility that Fget_text_property signals an
10396 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10397 charpos
= max (0, charpos
);
10399 /* Get the text property `menu-item' at pos. The value of that
10400 property is the start index of this item's properties in
10401 F->tool_bar_items. */
10402 prop
= Fget_text_property (make_number (charpos
),
10403 Qmenu_item
, f
->current_tool_bar_string
);
10404 if (INTEGERP (prop
))
10406 *prop_idx
= XINT (prop
);
10416 /* Get information about the tool-bar item at position X/Y on frame F.
10417 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10418 the current matrix of the tool-bar window of F, or NULL if not
10419 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10420 item in F->tool_bar_items. Value is
10422 -1 if X/Y is not on a tool-bar item
10423 0 if X/Y is on the same item that was highlighted before.
10427 get_tool_bar_item (f
, x
, y
, glyph
, hpos
, vpos
, prop_idx
)
10430 struct glyph
**glyph
;
10431 int *hpos
, *vpos
, *prop_idx
;
10433 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10434 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10437 /* Find the glyph under X/Y. */
10438 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10439 if (*glyph
== NULL
)
10442 /* Get the start of this tool-bar item's properties in
10443 f->tool_bar_items. */
10444 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10447 /* Is mouse on the highlighted item? */
10448 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
10449 && *vpos
>= dpyinfo
->mouse_face_beg_row
10450 && *vpos
<= dpyinfo
->mouse_face_end_row
10451 && (*vpos
> dpyinfo
->mouse_face_beg_row
10452 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
10453 && (*vpos
< dpyinfo
->mouse_face_end_row
10454 || *hpos
< dpyinfo
->mouse_face_end_col
10455 || dpyinfo
->mouse_face_past_end
))
10463 Handle mouse button event on the tool-bar of frame F, at
10464 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10465 0 for button release. MODIFIERS is event modifiers for button
10469 handle_tool_bar_click (f
, x
, y
, down_p
, modifiers
)
10472 unsigned int modifiers
;
10474 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10475 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10476 int hpos
, vpos
, prop_idx
;
10477 struct glyph
*glyph
;
10478 Lisp_Object enabled_p
;
10480 /* If not on the highlighted tool-bar item, return. */
10481 frame_to_window_pixel_xy (w
, &x
, &y
);
10482 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10485 /* If item is disabled, do nothing. */
10486 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10487 if (NILP (enabled_p
))
10492 /* Show item in pressed state. */
10493 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
10494 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10495 last_tool_bar_item
= prop_idx
;
10499 Lisp_Object key
, frame
;
10500 struct input_event event
;
10501 EVENT_INIT (event
);
10503 /* Show item in released state. */
10504 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
10505 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10507 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10509 XSETFRAME (frame
, f
);
10510 event
.kind
= TOOL_BAR_EVENT
;
10511 event
.frame_or_window
= frame
;
10513 kbd_buffer_store_event (&event
);
10515 event
.kind
= TOOL_BAR_EVENT
;
10516 event
.frame_or_window
= frame
;
10518 event
.modifiers
= modifiers
;
10519 kbd_buffer_store_event (&event
);
10520 last_tool_bar_item
= -1;
10525 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10526 tool-bar window-relative coordinates X/Y. Called from
10527 note_mouse_highlight. */
10530 note_tool_bar_highlight (f
, x
, y
)
10534 Lisp_Object window
= f
->tool_bar_window
;
10535 struct window
*w
= XWINDOW (window
);
10536 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10538 struct glyph
*glyph
;
10539 struct glyph_row
*row
;
10541 Lisp_Object enabled_p
;
10543 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10544 int mouse_down_p
, rc
;
10546 /* Function note_mouse_highlight is called with negative x(y
10547 values when mouse moves outside of the frame. */
10548 if (x
<= 0 || y
<= 0)
10550 clear_mouse_face (dpyinfo
);
10554 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10557 /* Not on tool-bar item. */
10558 clear_mouse_face (dpyinfo
);
10562 /* On same tool-bar item as before. */
10563 goto set_help_echo
;
10565 clear_mouse_face (dpyinfo
);
10567 /* Mouse is down, but on different tool-bar item? */
10568 mouse_down_p
= (dpyinfo
->grabbed
10569 && f
== last_mouse_frame
10570 && FRAME_LIVE_P (f
));
10572 && last_tool_bar_item
!= prop_idx
)
10575 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10576 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10578 /* If tool-bar item is not enabled, don't highlight it. */
10579 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10580 if (!NILP (enabled_p
))
10582 /* Compute the x-position of the glyph. In front and past the
10583 image is a space. We include this in the highlighted area. */
10584 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10585 for (i
= x
= 0; i
< hpos
; ++i
)
10586 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10588 /* Record this as the current active region. */
10589 dpyinfo
->mouse_face_beg_col
= hpos
;
10590 dpyinfo
->mouse_face_beg_row
= vpos
;
10591 dpyinfo
->mouse_face_beg_x
= x
;
10592 dpyinfo
->mouse_face_beg_y
= row
->y
;
10593 dpyinfo
->mouse_face_past_end
= 0;
10595 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
10596 dpyinfo
->mouse_face_end_row
= vpos
;
10597 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10598 dpyinfo
->mouse_face_end_y
= row
->y
;
10599 dpyinfo
->mouse_face_window
= window
;
10600 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10602 /* Display it as active. */
10603 show_mouse_face (dpyinfo
, draw
);
10604 dpyinfo
->mouse_face_image_state
= draw
;
10609 /* Set help_echo_string to a help string to display for this tool-bar item.
10610 XTread_socket does the rest. */
10611 help_echo_object
= help_echo_window
= Qnil
;
10612 help_echo_pos
= -1;
10613 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10614 if (NILP (help_echo_string
))
10615 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10618 #endif /* HAVE_WINDOW_SYSTEM */
10622 /************************************************************************
10623 Horizontal scrolling
10624 ************************************************************************/
10626 static int hscroll_window_tree
P_ ((Lisp_Object
));
10627 static int hscroll_windows
P_ ((Lisp_Object
));
10629 /* For all leaf windows in the window tree rooted at WINDOW, set their
10630 hscroll value so that PT is (i) visible in the window, and (ii) so
10631 that it is not within a certain margin at the window's left and
10632 right border. Value is non-zero if any window's hscroll has been
10636 hscroll_window_tree (window
)
10637 Lisp_Object window
;
10639 int hscrolled_p
= 0;
10640 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10641 int hscroll_step_abs
= 0;
10642 double hscroll_step_rel
= 0;
10644 if (hscroll_relative_p
)
10646 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10647 if (hscroll_step_rel
< 0)
10649 hscroll_relative_p
= 0;
10650 hscroll_step_abs
= 0;
10653 else if (INTEGERP (Vhscroll_step
))
10655 hscroll_step_abs
= XINT (Vhscroll_step
);
10656 if (hscroll_step_abs
< 0)
10657 hscroll_step_abs
= 0;
10660 hscroll_step_abs
= 0;
10662 while (WINDOWP (window
))
10664 struct window
*w
= XWINDOW (window
);
10666 if (WINDOWP (w
->hchild
))
10667 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10668 else if (WINDOWP (w
->vchild
))
10669 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10670 else if (w
->cursor
.vpos
>= 0)
10673 int text_area_width
;
10674 struct glyph_row
*current_cursor_row
10675 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10676 struct glyph_row
*desired_cursor_row
10677 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10678 struct glyph_row
*cursor_row
10679 = (desired_cursor_row
->enabled_p
10680 ? desired_cursor_row
10681 : current_cursor_row
);
10683 text_area_width
= window_box_width (w
, TEXT_AREA
);
10685 /* Scroll when cursor is inside this scroll margin. */
10686 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10688 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10689 && ((XFASTINT (w
->hscroll
)
10690 && w
->cursor
.x
<= h_margin
)
10691 || (cursor_row
->enabled_p
10692 && cursor_row
->truncated_on_right_p
10693 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10697 struct buffer
*saved_current_buffer
;
10701 /* Find point in a display of infinite width. */
10702 saved_current_buffer
= current_buffer
;
10703 current_buffer
= XBUFFER (w
->buffer
);
10705 if (w
== XWINDOW (selected_window
))
10706 pt
= BUF_PT (current_buffer
);
10709 pt
= marker_position (w
->pointm
);
10710 pt
= max (BEGV
, pt
);
10714 /* Move iterator to pt starting at cursor_row->start in
10715 a line with infinite width. */
10716 init_to_row_start (&it
, w
, cursor_row
);
10717 it
.last_visible_x
= INFINITY
;
10718 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
10719 current_buffer
= saved_current_buffer
;
10721 /* Position cursor in window. */
10722 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
10723 hscroll
= max (0, (it
.current_x
10724 - (ITERATOR_AT_END_OF_LINE_P (&it
)
10725 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
10726 : (text_area_width
/ 2))))
10727 / FRAME_COLUMN_WIDTH (it
.f
);
10728 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
10730 if (hscroll_relative_p
)
10731 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
10734 wanted_x
= text_area_width
10735 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10738 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10742 if (hscroll_relative_p
)
10743 wanted_x
= text_area_width
* hscroll_step_rel
10746 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10749 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10751 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
10753 /* Don't call Fset_window_hscroll if value hasn't
10754 changed because it will prevent redisplay
10756 if (XFASTINT (w
->hscroll
) != hscroll
)
10758 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
10759 w
->hscroll
= make_number (hscroll
);
10768 /* Value is non-zero if hscroll of any leaf window has been changed. */
10769 return hscrolled_p
;
10773 /* Set hscroll so that cursor is visible and not inside horizontal
10774 scroll margins for all windows in the tree rooted at WINDOW. See
10775 also hscroll_window_tree above. Value is non-zero if any window's
10776 hscroll has been changed. If it has, desired matrices on the frame
10777 of WINDOW are cleared. */
10780 hscroll_windows (window
)
10781 Lisp_Object window
;
10783 int hscrolled_p
= hscroll_window_tree (window
);
10785 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
10786 return hscrolled_p
;
10791 /************************************************************************
10793 ************************************************************************/
10795 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
10796 to a non-zero value. This is sometimes handy to have in a debugger
10801 /* First and last unchanged row for try_window_id. */
10803 int debug_first_unchanged_at_end_vpos
;
10804 int debug_last_unchanged_at_beg_vpos
;
10806 /* Delta vpos and y. */
10808 int debug_dvpos
, debug_dy
;
10810 /* Delta in characters and bytes for try_window_id. */
10812 int debug_delta
, debug_delta_bytes
;
10814 /* Values of window_end_pos and window_end_vpos at the end of
10817 EMACS_INT debug_end_pos
, debug_end_vpos
;
10819 /* Append a string to W->desired_matrix->method. FMT is a printf
10820 format string. A1...A9 are a supplement for a variable-length
10821 argument list. If trace_redisplay_p is non-zero also printf the
10822 resulting string to stderr. */
10825 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
10828 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
10831 char *method
= w
->desired_matrix
->method
;
10832 int len
= strlen (method
);
10833 int size
= sizeof w
->desired_matrix
->method
;
10834 int remaining
= size
- len
- 1;
10836 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
10837 if (len
&& remaining
)
10840 --remaining
, ++len
;
10843 strncpy (method
+ len
, buffer
, remaining
);
10845 if (trace_redisplay_p
)
10846 fprintf (stderr
, "%p (%s): %s\n",
10848 ((BUFFERP (w
->buffer
)
10849 && STRINGP (XBUFFER (w
->buffer
)->name
))
10850 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
10855 #endif /* GLYPH_DEBUG */
10858 /* Value is non-zero if all changes in window W, which displays
10859 current_buffer, are in the text between START and END. START is a
10860 buffer position, END is given as a distance from Z. Used in
10861 redisplay_internal for display optimization. */
10864 text_outside_line_unchanged_p (w
, start
, end
)
10868 int unchanged_p
= 1;
10870 /* If text or overlays have changed, see where. */
10871 if (XFASTINT (w
->last_modified
) < MODIFF
10872 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
10874 /* Gap in the line? */
10875 if (GPT
< start
|| Z
- GPT
< end
)
10878 /* Changes start in front of the line, or end after it? */
10880 && (BEG_UNCHANGED
< start
- 1
10881 || END_UNCHANGED
< end
))
10884 /* If selective display, can't optimize if changes start at the
10885 beginning of the line. */
10887 && INTEGERP (current_buffer
->selective_display
)
10888 && XINT (current_buffer
->selective_display
) > 0
10889 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
10892 /* If there are overlays at the start or end of the line, these
10893 may have overlay strings with newlines in them. A change at
10894 START, for instance, may actually concern the display of such
10895 overlay strings as well, and they are displayed on different
10896 lines. So, quickly rule out this case. (For the future, it
10897 might be desirable to implement something more telling than
10898 just BEG/END_UNCHANGED.) */
10901 if (BEG
+ BEG_UNCHANGED
== start
10902 && overlay_touches_p (start
))
10904 if (END_UNCHANGED
== end
10905 && overlay_touches_p (Z
- end
))
10910 return unchanged_p
;
10914 /* Do a frame update, taking possible shortcuts into account. This is
10915 the main external entry point for redisplay.
10917 If the last redisplay displayed an echo area message and that message
10918 is no longer requested, we clear the echo area or bring back the
10919 mini-buffer if that is in use. */
10924 redisplay_internal (0);
10929 overlay_arrow_string_or_property (var
)
10934 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
10937 return Voverlay_arrow_string
;
10940 /* Return 1 if there are any overlay-arrows in current_buffer. */
10942 overlay_arrow_in_current_buffer_p ()
10946 for (vlist
= Voverlay_arrow_variable_list
;
10948 vlist
= XCDR (vlist
))
10950 Lisp_Object var
= XCAR (vlist
);
10953 if (!SYMBOLP (var
))
10955 val
= find_symbol_value (var
);
10957 && current_buffer
== XMARKER (val
)->buffer
)
10964 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
10968 overlay_arrows_changed_p ()
10972 for (vlist
= Voverlay_arrow_variable_list
;
10974 vlist
= XCDR (vlist
))
10976 Lisp_Object var
= XCAR (vlist
);
10977 Lisp_Object val
, pstr
;
10979 if (!SYMBOLP (var
))
10981 val
= find_symbol_value (var
);
10982 if (!MARKERP (val
))
10984 if (! EQ (COERCE_MARKER (val
),
10985 Fget (var
, Qlast_arrow_position
))
10986 || ! (pstr
= overlay_arrow_string_or_property (var
),
10987 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
10993 /* Mark overlay arrows to be updated on next redisplay. */
10996 update_overlay_arrows (up_to_date
)
11001 for (vlist
= Voverlay_arrow_variable_list
;
11003 vlist
= XCDR (vlist
))
11005 Lisp_Object var
= XCAR (vlist
);
11007 if (!SYMBOLP (var
))
11010 if (up_to_date
> 0)
11012 Lisp_Object val
= find_symbol_value (var
);
11013 Fput (var
, Qlast_arrow_position
,
11014 COERCE_MARKER (val
));
11015 Fput (var
, Qlast_arrow_string
,
11016 overlay_arrow_string_or_property (var
));
11018 else if (up_to_date
< 0
11019 || !NILP (Fget (var
, Qlast_arrow_position
)))
11021 Fput (var
, Qlast_arrow_position
, Qt
);
11022 Fput (var
, Qlast_arrow_string
, Qt
);
11028 /* Return overlay arrow string to display at row.
11029 Return integer (bitmap number) for arrow bitmap in left fringe.
11030 Return nil if no overlay arrow. */
11033 overlay_arrow_at_row (it
, row
)
11035 struct glyph_row
*row
;
11039 for (vlist
= Voverlay_arrow_variable_list
;
11041 vlist
= XCDR (vlist
))
11043 Lisp_Object var
= XCAR (vlist
);
11046 if (!SYMBOLP (var
))
11049 val
= find_symbol_value (var
);
11052 && current_buffer
== XMARKER (val
)->buffer
11053 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11055 if (FRAME_WINDOW_P (it
->f
)
11056 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11058 #ifdef HAVE_WINDOW_SYSTEM
11059 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11062 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11063 return make_number (fringe_bitmap
);
11066 return make_number (-1); /* Use default arrow bitmap */
11068 return overlay_arrow_string_or_property (var
);
11075 /* Return 1 if point moved out of or into a composition. Otherwise
11076 return 0. PREV_BUF and PREV_PT are the last point buffer and
11077 position. BUF and PT are the current point buffer and position. */
11080 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
11081 struct buffer
*prev_buf
, *buf
;
11084 EMACS_INT start
, end
;
11086 Lisp_Object buffer
;
11088 XSETBUFFER (buffer
, buf
);
11089 /* Check a composition at the last point if point moved within the
11091 if (prev_buf
== buf
)
11094 /* Point didn't move. */
11097 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11098 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11099 && COMPOSITION_VALID_P (start
, end
, prop
)
11100 && start
< prev_pt
&& end
> prev_pt
)
11101 /* The last point was within the composition. Return 1 iff
11102 point moved out of the composition. */
11103 return (pt
<= start
|| pt
>= end
);
11106 /* Check a composition at the current point. */
11107 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11108 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11109 && COMPOSITION_VALID_P (start
, end
, prop
)
11110 && start
< pt
&& end
> pt
);
11114 /* Reconsider the setting of B->clip_changed which is displayed
11118 reconsider_clip_changes (w
, b
)
11122 if (b
->clip_changed
11123 && !NILP (w
->window_end_valid
)
11124 && w
->current_matrix
->buffer
== b
11125 && w
->current_matrix
->zv
== BUF_ZV (b
)
11126 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11127 b
->clip_changed
= 0;
11129 /* If display wasn't paused, and W is not a tool bar window, see if
11130 point has been moved into or out of a composition. In that case,
11131 we set b->clip_changed to 1 to force updating the screen. If
11132 b->clip_changed has already been set to 1, we can skip this
11134 if (!b
->clip_changed
11135 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11139 if (w
== XWINDOW (selected_window
))
11140 pt
= BUF_PT (current_buffer
);
11142 pt
= marker_position (w
->pointm
);
11144 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11145 || pt
!= XINT (w
->last_point
))
11146 && check_point_in_composition (w
->current_matrix
->buffer
,
11147 XINT (w
->last_point
),
11148 XBUFFER (w
->buffer
), pt
))
11149 b
->clip_changed
= 1;
11154 /* Select FRAME to forward the values of frame-local variables into C
11155 variables so that the redisplay routines can access those values
11159 select_frame_for_redisplay (frame
)
11162 Lisp_Object tail
, symbol
, val
;
11163 Lisp_Object old
= selected_frame
;
11164 struct Lisp_Symbol
*sym
;
11166 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11168 selected_frame
= frame
;
11172 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11173 if (CONSP (XCAR (tail
))
11174 && (symbol
= XCAR (XCAR (tail
)),
11176 && (sym
= indirect_variable (XSYMBOL (symbol
)),
11178 (BUFFER_LOCAL_VALUEP (val
)))
11179 && XBUFFER_LOCAL_VALUE (val
)->check_frame
)
11180 /* Use find_symbol_value rather than Fsymbol_value
11181 to avoid an error if it is void. */
11182 find_symbol_value (symbol
);
11183 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11187 #define STOP_POLLING \
11188 do { if (! polling_stopped_here) stop_polling (); \
11189 polling_stopped_here = 1; } while (0)
11191 #define RESUME_POLLING \
11192 do { if (polling_stopped_here) start_polling (); \
11193 polling_stopped_here = 0; } while (0)
11196 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11197 response to any user action; therefore, we should preserve the echo
11198 area. (Actually, our caller does that job.) Perhaps in the future
11199 avoid recentering windows if it is not necessary; currently that
11200 causes some problems. */
11203 redisplay_internal (preserve_echo_area
)
11204 int preserve_echo_area
;
11206 struct window
*w
= XWINDOW (selected_window
);
11209 int must_finish
= 0;
11210 struct text_pos tlbufpos
, tlendpos
;
11211 int number_of_visible_frames
;
11214 int polling_stopped_here
= 0;
11215 Lisp_Object old_frame
= selected_frame
;
11217 /* Non-zero means redisplay has to consider all windows on all
11218 frames. Zero means, only selected_window is considered. */
11219 int consider_all_windows_p
;
11221 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11223 /* No redisplay if running in batch mode or frame is not yet fully
11224 initialized, or redisplay is explicitly turned off by setting
11225 Vinhibit_redisplay. */
11227 || !NILP (Vinhibit_redisplay
))
11230 /* Don't examine these until after testing Vinhibit_redisplay.
11231 When Emacs is shutting down, perhaps because its connection to
11232 X has dropped, we should not look at them at all. */
11233 f
= XFRAME (w
->frame
);
11234 sf
= SELECTED_FRAME ();
11236 if (!f
->glyphs_initialized_p
)
11239 /* The flag redisplay_performed_directly_p is set by
11240 direct_output_for_insert when it already did the whole screen
11241 update necessary. */
11242 if (redisplay_performed_directly_p
)
11244 redisplay_performed_directly_p
= 0;
11245 if (!hscroll_windows (selected_window
))
11249 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (MAC_OS)
11250 if (popup_activated ())
11254 /* I don't think this happens but let's be paranoid. */
11255 if (redisplaying_p
)
11258 /* Record a function that resets redisplaying_p to its old value
11259 when we leave this function. */
11260 count
= SPECPDL_INDEX ();
11261 record_unwind_protect (unwind_redisplay
,
11262 Fcons (make_number (redisplaying_p
), selected_frame
));
11264 specbind (Qinhibit_free_realized_faces
, Qnil
);
11267 Lisp_Object tail
, frame
;
11269 FOR_EACH_FRAME (tail
, frame
)
11271 struct frame
*f
= XFRAME (frame
);
11272 f
->already_hscrolled_p
= 0;
11277 if (!EQ (old_frame
, selected_frame
)
11278 && FRAME_LIVE_P (XFRAME (old_frame
)))
11279 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11280 selected_frame and selected_window to be temporarily out-of-sync so
11281 when we come back here via `goto retry', we need to resync because we
11282 may need to run Elisp code (via prepare_menu_bars). */
11283 select_frame_for_redisplay (old_frame
);
11286 reconsider_clip_changes (w
, current_buffer
);
11287 last_escape_glyph_frame
= NULL
;
11288 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11290 /* If new fonts have been loaded that make a glyph matrix adjustment
11291 necessary, do it. */
11292 if (fonts_changed_p
)
11294 adjust_glyphs (NULL
);
11295 ++windows_or_buffers_changed
;
11296 fonts_changed_p
= 0;
11299 /* If face_change_count is non-zero, init_iterator will free all
11300 realized faces, which includes the faces referenced from current
11301 matrices. So, we can't reuse current matrices in this case. */
11302 if (face_change_count
)
11303 ++windows_or_buffers_changed
;
11305 if (FRAME_TERMCAP_P (sf
)
11306 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11308 /* Since frames on a single ASCII terminal share the same
11309 display area, displaying a different frame means redisplay
11310 the whole thing. */
11311 windows_or_buffers_changed
++;
11312 SET_FRAME_GARBAGED (sf
);
11314 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11316 FRAME_TTY (sf
)->previous_frame
= sf
;
11319 /* Set the visible flags for all frames. Do this before checking
11320 for resized or garbaged frames; they want to know if their frames
11321 are visible. See the comment in frame.h for
11322 FRAME_SAMPLE_VISIBILITY. */
11324 Lisp_Object tail
, frame
;
11326 number_of_visible_frames
= 0;
11328 FOR_EACH_FRAME (tail
, frame
)
11330 struct frame
*f
= XFRAME (frame
);
11332 FRAME_SAMPLE_VISIBILITY (f
);
11333 if (FRAME_VISIBLE_P (f
))
11334 ++number_of_visible_frames
;
11335 clear_desired_matrices (f
);
11340 /* Notice any pending interrupt request to change frame size. */
11341 do_pending_window_change (1);
11343 /* Clear frames marked as garbaged. */
11344 if (frame_garbaged
)
11345 clear_garbaged_frames ();
11347 /* Build menubar and tool-bar items. */
11348 if (NILP (Vmemory_full
))
11349 prepare_menu_bars ();
11351 if (windows_or_buffers_changed
)
11352 update_mode_lines
++;
11354 /* Detect case that we need to write or remove a star in the mode line. */
11355 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11357 w
->update_mode_line
= Qt
;
11358 if (buffer_shared
> 1)
11359 update_mode_lines
++;
11362 /* Avoid invocation of point motion hooks by `current_column' below. */
11363 count1
= SPECPDL_INDEX ();
11364 specbind (Qinhibit_point_motion_hooks
, Qt
);
11366 /* If %c is in the mode line, update it if needed. */
11367 if (!NILP (w
->column_number_displayed
)
11368 /* This alternative quickly identifies a common case
11369 where no change is needed. */
11370 && !(PT
== XFASTINT (w
->last_point
)
11371 && XFASTINT (w
->last_modified
) >= MODIFF
11372 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11373 && (XFASTINT (w
->column_number_displayed
)
11374 != (int) current_column ())) /* iftc */
11375 w
->update_mode_line
= Qt
;
11377 unbind_to (count1
, Qnil
);
11379 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11381 /* The variable buffer_shared is set in redisplay_window and
11382 indicates that we redisplay a buffer in different windows. See
11384 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11385 || cursor_type_changed
);
11387 /* If specs for an arrow have changed, do thorough redisplay
11388 to ensure we remove any arrow that should no longer exist. */
11389 if (overlay_arrows_changed_p ())
11390 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11392 /* Normally the message* functions will have already displayed and
11393 updated the echo area, but the frame may have been trashed, or
11394 the update may have been preempted, so display the echo area
11395 again here. Checking message_cleared_p captures the case that
11396 the echo area should be cleared. */
11397 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11398 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11399 || (message_cleared_p
11400 && minibuf_level
== 0
11401 /* If the mini-window is currently selected, this means the
11402 echo-area doesn't show through. */
11403 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11405 int window_height_changed_p
= echo_area_display (0);
11408 /* If we don't display the current message, don't clear the
11409 message_cleared_p flag, because, if we did, we wouldn't clear
11410 the echo area in the next redisplay which doesn't preserve
11412 if (!display_last_displayed_message_p
)
11413 message_cleared_p
= 0;
11415 if (fonts_changed_p
)
11417 else if (window_height_changed_p
)
11419 consider_all_windows_p
= 1;
11420 ++update_mode_lines
;
11421 ++windows_or_buffers_changed
;
11423 /* If window configuration was changed, frames may have been
11424 marked garbaged. Clear them or we will experience
11425 surprises wrt scrolling. */
11426 if (frame_garbaged
)
11427 clear_garbaged_frames ();
11430 else if (EQ (selected_window
, minibuf_window
)
11431 && (current_buffer
->clip_changed
11432 || XFASTINT (w
->last_modified
) < MODIFF
11433 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11434 && resize_mini_window (w
, 0))
11436 /* Resized active mini-window to fit the size of what it is
11437 showing if its contents might have changed. */
11439 consider_all_windows_p
= 1;
11440 ++windows_or_buffers_changed
;
11441 ++update_mode_lines
;
11443 /* If window configuration was changed, frames may have been
11444 marked garbaged. Clear them or we will experience
11445 surprises wrt scrolling. */
11446 if (frame_garbaged
)
11447 clear_garbaged_frames ();
11451 /* If showing the region, and mark has changed, we must redisplay
11452 the whole window. The assignment to this_line_start_pos prevents
11453 the optimization directly below this if-statement. */
11454 if (((!NILP (Vtransient_mark_mode
)
11455 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
11456 != !NILP (w
->region_showing
))
11457 || (!NILP (w
->region_showing
)
11458 && !EQ (w
->region_showing
,
11459 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
11460 CHARPOS (this_line_start_pos
) = 0;
11462 /* Optimize the case that only the line containing the cursor in the
11463 selected window has changed. Variables starting with this_ are
11464 set in display_line and record information about the line
11465 containing the cursor. */
11466 tlbufpos
= this_line_start_pos
;
11467 tlendpos
= this_line_end_pos
;
11468 if (!consider_all_windows_p
11469 && CHARPOS (tlbufpos
) > 0
11470 && NILP (w
->update_mode_line
)
11471 && !current_buffer
->clip_changed
11472 && !current_buffer
->prevent_redisplay_optimizations_p
11473 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11474 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11475 /* Make sure recorded data applies to current buffer, etc. */
11476 && this_line_buffer
== current_buffer
11477 && current_buffer
== XBUFFER (w
->buffer
)
11478 && NILP (w
->force_start
)
11479 && NILP (w
->optional_new_start
)
11480 /* Point must be on the line that we have info recorded about. */
11481 && PT
>= CHARPOS (tlbufpos
)
11482 && PT
<= Z
- CHARPOS (tlendpos
)
11483 /* All text outside that line, including its final newline,
11484 must be unchanged */
11485 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11486 CHARPOS (tlendpos
)))
11488 if (CHARPOS (tlbufpos
) > BEGV
11489 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11490 && (CHARPOS (tlbufpos
) == ZV
11491 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11492 /* Former continuation line has disappeared by becoming empty */
11494 else if (XFASTINT (w
->last_modified
) < MODIFF
11495 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11496 || MINI_WINDOW_P (w
))
11498 /* We have to handle the case of continuation around a
11499 wide-column character (See the comment in indent.c around
11502 For instance, in the following case:
11504 -------- Insert --------
11505 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11506 J_I_ ==> J_I_ `^^' are cursors.
11510 As we have to redraw the line above, we should goto cancel. */
11513 int line_height_before
= this_line_pixel_height
;
11515 /* Note that start_display will handle the case that the
11516 line starting at tlbufpos is a continuation lines. */
11517 start_display (&it
, w
, tlbufpos
);
11519 /* Implementation note: It this still necessary? */
11520 if (it
.current_x
!= this_line_start_x
)
11523 TRACE ((stderr
, "trying display optimization 1\n"));
11524 w
->cursor
.vpos
= -1;
11525 overlay_arrow_seen
= 0;
11526 it
.vpos
= this_line_vpos
;
11527 it
.current_y
= this_line_y
;
11528 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11529 display_line (&it
);
11531 /* If line contains point, is not continued,
11532 and ends at same distance from eob as before, we win */
11533 if (w
->cursor
.vpos
>= 0
11534 /* Line is not continued, otherwise this_line_start_pos
11535 would have been set to 0 in display_line. */
11536 && CHARPOS (this_line_start_pos
)
11537 /* Line ends as before. */
11538 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11539 /* Line has same height as before. Otherwise other lines
11540 would have to be shifted up or down. */
11541 && this_line_pixel_height
== line_height_before
)
11543 /* If this is not the window's last line, we must adjust
11544 the charstarts of the lines below. */
11545 if (it
.current_y
< it
.last_visible_y
)
11547 struct glyph_row
*row
11548 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11549 int delta
, delta_bytes
;
11551 if (Z
- CHARPOS (tlendpos
) == ZV
)
11553 /* This line ends at end of (accessible part of)
11554 buffer. There is no newline to count. */
11556 - CHARPOS (tlendpos
)
11557 - MATRIX_ROW_START_CHARPOS (row
));
11558 delta_bytes
= (Z_BYTE
11559 - BYTEPOS (tlendpos
)
11560 - MATRIX_ROW_START_BYTEPOS (row
));
11564 /* This line ends in a newline. Must take
11565 account of the newline and the rest of the
11566 text that follows. */
11568 - CHARPOS (tlendpos
)
11569 - MATRIX_ROW_START_CHARPOS (row
));
11570 delta_bytes
= (Z_BYTE
11571 - BYTEPOS (tlendpos
)
11572 - MATRIX_ROW_START_BYTEPOS (row
));
11575 increment_matrix_positions (w
->current_matrix
,
11576 this_line_vpos
+ 1,
11577 w
->current_matrix
->nrows
,
11578 delta
, delta_bytes
);
11581 /* If this row displays text now but previously didn't,
11582 or vice versa, w->window_end_vpos may have to be
11584 if ((it
.glyph_row
- 1)->displays_text_p
)
11586 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11587 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11589 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11590 && this_line_vpos
> 0)
11591 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11592 w
->window_end_valid
= Qnil
;
11594 /* Update hint: No need to try to scroll in update_window. */
11595 w
->desired_matrix
->no_scrolling_p
= 1;
11598 *w
->desired_matrix
->method
= 0;
11599 debug_method_add (w
, "optimization 1");
11601 #ifdef HAVE_WINDOW_SYSTEM
11602 update_window_fringes (w
, 0);
11609 else if (/* Cursor position hasn't changed. */
11610 PT
== XFASTINT (w
->last_point
)
11611 /* Make sure the cursor was last displayed
11612 in this window. Otherwise we have to reposition it. */
11613 && 0 <= w
->cursor
.vpos
11614 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11618 do_pending_window_change (1);
11620 /* We used to always goto end_of_redisplay here, but this
11621 isn't enough if we have a blinking cursor. */
11622 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11623 goto end_of_redisplay
;
11627 /* If highlighting the region, or if the cursor is in the echo area,
11628 then we can't just move the cursor. */
11629 else if (! (!NILP (Vtransient_mark_mode
)
11630 && !NILP (current_buffer
->mark_active
))
11631 && (EQ (selected_window
, current_buffer
->last_selected_window
)
11632 || highlight_nonselected_windows
)
11633 && NILP (w
->region_showing
)
11634 && NILP (Vshow_trailing_whitespace
)
11635 && !cursor_in_echo_area
)
11638 struct glyph_row
*row
;
11640 /* Skip from tlbufpos to PT and see where it is. Note that
11641 PT may be in invisible text. If so, we will end at the
11642 next visible position. */
11643 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11644 NULL
, DEFAULT_FACE_ID
);
11645 it
.current_x
= this_line_start_x
;
11646 it
.current_y
= this_line_y
;
11647 it
.vpos
= this_line_vpos
;
11649 /* The call to move_it_to stops in front of PT, but
11650 moves over before-strings. */
11651 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11653 if (it
.vpos
== this_line_vpos
11654 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11657 xassert (this_line_vpos
== it
.vpos
);
11658 xassert (this_line_y
== it
.current_y
);
11659 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11661 *w
->desired_matrix
->method
= 0;
11662 debug_method_add (w
, "optimization 3");
11671 /* Text changed drastically or point moved off of line. */
11672 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11675 CHARPOS (this_line_start_pos
) = 0;
11676 consider_all_windows_p
|= buffer_shared
> 1;
11677 ++clear_face_cache_count
;
11678 #ifdef HAVE_WINDOW_SYSTEM
11679 ++clear_image_cache_count
;
11682 /* Build desired matrices, and update the display. If
11683 consider_all_windows_p is non-zero, do it for all windows on all
11684 frames. Otherwise do it for selected_window, only. */
11686 if (consider_all_windows_p
)
11688 Lisp_Object tail
, frame
;
11690 FOR_EACH_FRAME (tail
, frame
)
11691 XFRAME (frame
)->updated_p
= 0;
11693 /* Recompute # windows showing selected buffer. This will be
11694 incremented each time such a window is displayed. */
11697 FOR_EACH_FRAME (tail
, frame
)
11699 struct frame
*f
= XFRAME (frame
);
11701 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11703 if (! EQ (frame
, selected_frame
))
11704 /* Select the frame, for the sake of frame-local
11706 select_frame_for_redisplay (frame
);
11708 /* Mark all the scroll bars to be removed; we'll redeem
11709 the ones we want when we redisplay their windows. */
11710 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11711 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11713 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11714 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11716 /* Any scroll bars which redisplay_windows should have
11717 nuked should now go away. */
11718 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11719 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
11721 /* If fonts changed, display again. */
11722 /* ??? rms: I suspect it is a mistake to jump all the way
11723 back to retry here. It should just retry this frame. */
11724 if (fonts_changed_p
)
11727 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11729 /* See if we have to hscroll. */
11730 if (!f
->already_hscrolled_p
)
11732 f
->already_hscrolled_p
= 1;
11733 if (hscroll_windows (f
->root_window
))
11737 /* Prevent various kinds of signals during display
11738 update. stdio is not robust about handling
11739 signals, which can cause an apparent I/O
11741 if (interrupt_input
)
11742 unrequest_sigio ();
11745 /* Update the display. */
11746 set_window_update_flags (XWINDOW (f
->root_window
), 1);
11747 pause
|= update_frame (f
, 0, 0);
11748 #if 0 /* Exiting the loop can leave the wrong value for buffer_shared. */
11758 if (!EQ (old_frame
, selected_frame
)
11759 && FRAME_LIVE_P (XFRAME (old_frame
)))
11760 /* We played a bit fast-and-loose above and allowed selected_frame
11761 and selected_window to be temporarily out-of-sync but let's make
11762 sure this stays contained. */
11763 select_frame_for_redisplay (old_frame
);
11764 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
11768 /* Do the mark_window_display_accurate after all windows have
11769 been redisplayed because this call resets flags in buffers
11770 which are needed for proper redisplay. */
11771 FOR_EACH_FRAME (tail
, frame
)
11773 struct frame
*f
= XFRAME (frame
);
11776 mark_window_display_accurate (f
->root_window
, 1);
11777 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
11778 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
11783 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11785 Lisp_Object mini_window
;
11786 struct frame
*mini_frame
;
11788 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
11789 /* Use list_of_error, not Qerror, so that
11790 we catch only errors and don't run the debugger. */
11791 internal_condition_case_1 (redisplay_window_1
, selected_window
,
11793 redisplay_window_error
);
11795 /* Compare desired and current matrices, perform output. */
11798 /* If fonts changed, display again. */
11799 if (fonts_changed_p
)
11802 /* Prevent various kinds of signals during display update.
11803 stdio is not robust about handling signals,
11804 which can cause an apparent I/O error. */
11805 if (interrupt_input
)
11806 unrequest_sigio ();
11809 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11811 if (hscroll_windows (selected_window
))
11814 XWINDOW (selected_window
)->must_be_updated_p
= 1;
11815 pause
= update_frame (sf
, 0, 0);
11818 /* We may have called echo_area_display at the top of this
11819 function. If the echo area is on another frame, that may
11820 have put text on a frame other than the selected one, so the
11821 above call to update_frame would not have caught it. Catch
11823 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11824 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
11826 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
11828 XWINDOW (mini_window
)->must_be_updated_p
= 1;
11829 pause
|= update_frame (mini_frame
, 0, 0);
11830 if (!pause
&& hscroll_windows (mini_window
))
11835 /* If display was paused because of pending input, make sure we do a
11836 thorough update the next time. */
11839 /* Prevent the optimization at the beginning of
11840 redisplay_internal that tries a single-line update of the
11841 line containing the cursor in the selected window. */
11842 CHARPOS (this_line_start_pos
) = 0;
11844 /* Let the overlay arrow be updated the next time. */
11845 update_overlay_arrows (0);
11847 /* If we pause after scrolling, some rows in the current
11848 matrices of some windows are not valid. */
11849 if (!WINDOW_FULL_WIDTH_P (w
)
11850 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
11851 update_mode_lines
= 1;
11855 if (!consider_all_windows_p
)
11857 /* This has already been done above if
11858 consider_all_windows_p is set. */
11859 mark_window_display_accurate_1 (w
, 1);
11861 /* Say overlay arrows are up to date. */
11862 update_overlay_arrows (1);
11864 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
11865 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
11868 update_mode_lines
= 0;
11869 windows_or_buffers_changed
= 0;
11870 cursor_type_changed
= 0;
11873 /* Start SIGIO interrupts coming again. Having them off during the
11874 code above makes it less likely one will discard output, but not
11875 impossible, since there might be stuff in the system buffer here.
11876 But it is much hairier to try to do anything about that. */
11877 if (interrupt_input
)
11881 /* If a frame has become visible which was not before, redisplay
11882 again, so that we display it. Expose events for such a frame
11883 (which it gets when becoming visible) don't call the parts of
11884 redisplay constructing glyphs, so simply exposing a frame won't
11885 display anything in this case. So, we have to display these
11886 frames here explicitly. */
11889 Lisp_Object tail
, frame
;
11892 FOR_EACH_FRAME (tail
, frame
)
11894 int this_is_visible
= 0;
11896 if (XFRAME (frame
)->visible
)
11897 this_is_visible
= 1;
11898 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
11899 if (XFRAME (frame
)->visible
)
11900 this_is_visible
= 1;
11902 if (this_is_visible
)
11906 if (new_count
!= number_of_visible_frames
)
11907 windows_or_buffers_changed
++;
11910 /* Change frame size now if a change is pending. */
11911 do_pending_window_change (1);
11913 /* If we just did a pending size change, or have additional
11914 visible frames, redisplay again. */
11915 if (windows_or_buffers_changed
&& !pause
)
11918 /* Clear the face cache eventually. */
11919 if (consider_all_windows_p
)
11921 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
11923 clear_face_cache (0);
11924 clear_face_cache_count
= 0;
11926 #ifdef HAVE_WINDOW_SYSTEM
11927 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
11929 clear_image_caches (Qnil
);
11930 clear_image_cache_count
= 0;
11932 #endif /* HAVE_WINDOW_SYSTEM */
11936 unbind_to (count
, Qnil
);
11941 /* Redisplay, but leave alone any recent echo area message unless
11942 another message has been requested in its place.
11944 This is useful in situations where you need to redisplay but no
11945 user action has occurred, making it inappropriate for the message
11946 area to be cleared. See tracking_off and
11947 wait_reading_process_output for examples of these situations.
11949 FROM_WHERE is an integer saying from where this function was
11950 called. This is useful for debugging. */
11953 redisplay_preserve_echo_area (from_where
)
11956 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
11958 if (!NILP (echo_area_buffer
[1]))
11960 /* We have a previously displayed message, but no current
11961 message. Redisplay the previous message. */
11962 display_last_displayed_message_p
= 1;
11963 redisplay_internal (1);
11964 display_last_displayed_message_p
= 0;
11967 redisplay_internal (1);
11969 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
11970 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11971 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
11975 /* Function registered with record_unwind_protect in
11976 redisplay_internal. Reset redisplaying_p to the value it had
11977 before redisplay_internal was called, and clear
11978 prevent_freeing_realized_faces_p. It also selects the previously
11979 selected frame, unless it has been deleted (by an X connection
11980 failure during redisplay, for example). */
11983 unwind_redisplay (val
)
11986 Lisp_Object old_redisplaying_p
, old_frame
;
11988 old_redisplaying_p
= XCAR (val
);
11989 redisplaying_p
= XFASTINT (old_redisplaying_p
);
11990 old_frame
= XCDR (val
);
11991 if (! EQ (old_frame
, selected_frame
)
11992 && FRAME_LIVE_P (XFRAME (old_frame
)))
11993 select_frame_for_redisplay (old_frame
);
11998 /* Mark the display of window W as accurate or inaccurate. If
11999 ACCURATE_P is non-zero mark display of W as accurate. If
12000 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12001 redisplay_internal is called. */
12004 mark_window_display_accurate_1 (w
, accurate_p
)
12008 if (BUFFERP (w
->buffer
))
12010 struct buffer
*b
= XBUFFER (w
->buffer
);
12013 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12014 w
->last_overlay_modified
12015 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12017 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12021 b
->clip_changed
= 0;
12022 b
->prevent_redisplay_optimizations_p
= 0;
12024 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12025 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12026 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12027 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12029 w
->current_matrix
->buffer
= b
;
12030 w
->current_matrix
->begv
= BUF_BEGV (b
);
12031 w
->current_matrix
->zv
= BUF_ZV (b
);
12033 w
->last_cursor
= w
->cursor
;
12034 w
->last_cursor_off_p
= w
->cursor_off_p
;
12036 if (w
== XWINDOW (selected_window
))
12037 w
->last_point
= make_number (BUF_PT (b
));
12039 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12045 w
->window_end_valid
= w
->buffer
;
12046 #if 0 /* This is incorrect with variable-height lines. */
12047 xassert (XINT (w
->window_end_vpos
)
12048 < (WINDOW_TOTAL_LINES (w
)
12049 - (WINDOW_WANTS_MODELINE_P (w
) ? 1 : 0)));
12051 w
->update_mode_line
= Qnil
;
12056 /* Mark the display of windows in the window tree rooted at WINDOW as
12057 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12058 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12059 be redisplayed the next time redisplay_internal is called. */
12062 mark_window_display_accurate (window
, accurate_p
)
12063 Lisp_Object window
;
12068 for (; !NILP (window
); window
= w
->next
)
12070 w
= XWINDOW (window
);
12071 mark_window_display_accurate_1 (w
, accurate_p
);
12073 if (!NILP (w
->vchild
))
12074 mark_window_display_accurate (w
->vchild
, accurate_p
);
12075 if (!NILP (w
->hchild
))
12076 mark_window_display_accurate (w
->hchild
, accurate_p
);
12081 update_overlay_arrows (1);
12085 /* Force a thorough redisplay the next time by setting
12086 last_arrow_position and last_arrow_string to t, which is
12087 unequal to any useful value of Voverlay_arrow_... */
12088 update_overlay_arrows (-1);
12093 /* Return value in display table DP (Lisp_Char_Table *) for character
12094 C. Since a display table doesn't have any parent, we don't have to
12095 follow parent. Do not call this function directly but use the
12096 macro DISP_CHAR_VECTOR. */
12099 disp_char_vector (dp
, c
)
12100 struct Lisp_Char_Table
*dp
;
12105 if (ASCII_CHAR_P (c
))
12108 if (SUB_CHAR_TABLE_P (val
))
12109 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12115 XSETCHAR_TABLE (table
, dp
);
12116 val
= char_table_ref (table
, c
);
12125 /***********************************************************************
12127 ***********************************************************************/
12129 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12132 redisplay_windows (window
)
12133 Lisp_Object window
;
12135 while (!NILP (window
))
12137 struct window
*w
= XWINDOW (window
);
12139 if (!NILP (w
->hchild
))
12140 redisplay_windows (w
->hchild
);
12141 else if (!NILP (w
->vchild
))
12142 redisplay_windows (w
->vchild
);
12145 displayed_buffer
= XBUFFER (w
->buffer
);
12146 /* Use list_of_error, not Qerror, so that
12147 we catch only errors and don't run the debugger. */
12148 internal_condition_case_1 (redisplay_window_0
, window
,
12150 redisplay_window_error
);
12158 redisplay_window_error ()
12160 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12165 redisplay_window_0 (window
)
12166 Lisp_Object window
;
12168 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12169 redisplay_window (window
, 0);
12174 redisplay_window_1 (window
)
12175 Lisp_Object window
;
12177 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12178 redisplay_window (window
, 1);
12183 /* Increment GLYPH until it reaches END or CONDITION fails while
12184 adding (GLYPH)->pixel_width to X. */
12186 #define SKIP_GLYPHS(glyph, end, x, condition) \
12189 (x) += (glyph)->pixel_width; \
12192 while ((glyph) < (end) && (condition))
12195 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12196 DELTA is the number of bytes by which positions recorded in ROW
12197 differ from current buffer positions.
12199 Return 0 if cursor is not on this row. 1 otherwise. */
12202 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
12204 struct glyph_row
*row
;
12205 struct glyph_matrix
*matrix
;
12206 int delta
, delta_bytes
, dy
, dvpos
;
12208 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12209 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12210 struct glyph
*cursor
= NULL
;
12211 /* The first glyph that starts a sequence of glyphs from string. */
12212 struct glyph
*string_start
;
12213 /* The X coordinate of string_start. */
12214 int string_start_x
;
12215 /* The last known character position. */
12216 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12217 /* The last known character position before string_start. */
12218 int string_before_pos
;
12221 int cursor_from_overlay_pos
= 0;
12222 int pt_old
= PT
- delta
;
12224 /* Skip over glyphs not having an object at the start of the row.
12225 These are special glyphs like truncation marks on terminal
12227 if (row
->displays_text_p
)
12229 && INTEGERP (glyph
->object
)
12230 && glyph
->charpos
< 0)
12232 x
+= glyph
->pixel_width
;
12236 string_start
= NULL
;
12238 && !INTEGERP (glyph
->object
)
12239 && (!BUFFERP (glyph
->object
)
12240 || (last_pos
= glyph
->charpos
) < pt_old
12241 || glyph
->avoid_cursor_p
))
12243 if (! STRINGP (glyph
->object
))
12245 string_start
= NULL
;
12246 x
+= glyph
->pixel_width
;
12248 if (cursor_from_overlay_pos
12249 && last_pos
>= cursor_from_overlay_pos
)
12251 cursor_from_overlay_pos
= 0;
12257 if (string_start
== NULL
)
12259 string_before_pos
= last_pos
;
12260 string_start
= glyph
;
12261 string_start_x
= x
;
12263 /* Skip all glyphs from string. */
12268 if ((cursor
== NULL
|| glyph
> cursor
)
12269 && (cprop
= Fget_char_property (make_number ((glyph
)->charpos
),
12270 Qcursor
, (glyph
)->object
),
12272 && (pos
= string_buffer_position (w
, glyph
->object
,
12273 string_before_pos
),
12274 (pos
== 0 /* From overlay */
12275 || pos
== pt_old
)))
12277 /* Estimate overlay buffer position from the buffer
12278 positions of the glyphs before and after the overlay.
12279 Add 1 to last_pos so that if point corresponds to the
12280 glyph right after the overlay, we still use a 'cursor'
12281 property found in that overlay. */
12282 cursor_from_overlay_pos
= (pos
? 0 : last_pos
12283 + (INTEGERP (cprop
) ? XINT (cprop
) : 0));
12287 x
+= glyph
->pixel_width
;
12290 while (glyph
< end
&& EQ (glyph
->object
, string_start
->object
));
12294 if (cursor
!= NULL
)
12299 else if (row
->ends_in_ellipsis_p
&& glyph
== end
)
12301 /* Scan back over the ellipsis glyphs, decrementing positions. */
12302 while (glyph
> row
->glyphs
[TEXT_AREA
]
12303 && (glyph
- 1)->charpos
== last_pos
)
12304 glyph
--, x
-= glyph
->pixel_width
;
12305 /* That loop always goes one position too far,
12306 including the glyph before the ellipsis.
12307 So scan forward over that one. */
12308 x
+= glyph
->pixel_width
;
12311 else if (string_start
12312 && (glyph
== end
|| !BUFFERP (glyph
->object
) || last_pos
> pt_old
))
12314 /* We may have skipped over point because the previous glyphs
12315 are from string. As there's no easy way to know the
12316 character position of the current glyph, find the correct
12317 glyph on point by scanning from string_start again. */
12319 Lisp_Object string
;
12320 struct glyph
*stop
= glyph
;
12323 limit
= make_number (pt_old
+ 1);
12324 glyph
= string_start
;
12325 x
= string_start_x
;
12326 string
= glyph
->object
;
12327 pos
= string_buffer_position (w
, string
, string_before_pos
);
12328 /* If STRING is from overlay, LAST_POS == 0. We skip such glyphs
12329 because we always put cursor after overlay strings. */
12330 while (pos
== 0 && glyph
< stop
)
12332 string
= glyph
->object
;
12333 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12335 pos
= string_buffer_position (w
, glyph
->object
, string_before_pos
);
12338 while (glyph
< stop
)
12340 pos
= XINT (Fnext_single_char_property_change
12341 (make_number (pos
), Qdisplay
, Qnil
, limit
));
12344 /* Skip glyphs from the same string. */
12345 string
= glyph
->object
;
12346 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12347 /* Skip glyphs from an overlay. */
12348 while (glyph
< stop
12349 && ! string_buffer_position (w
, glyph
->object
, pos
))
12351 string
= glyph
->object
;
12352 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12356 /* If we reached the end of the line, and end was from a string,
12357 cursor is not on this line. */
12358 if (glyph
== end
&& row
->continued_p
)
12362 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12364 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12365 w
->cursor
.y
= row
->y
+ dy
;
12367 if (w
== XWINDOW (selected_window
))
12369 if (!row
->continued_p
12370 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12373 this_line_buffer
= XBUFFER (w
->buffer
);
12375 CHARPOS (this_line_start_pos
)
12376 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12377 BYTEPOS (this_line_start_pos
)
12378 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12380 CHARPOS (this_line_end_pos
)
12381 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12382 BYTEPOS (this_line_end_pos
)
12383 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12385 this_line_y
= w
->cursor
.y
;
12386 this_line_pixel_height
= row
->height
;
12387 this_line_vpos
= w
->cursor
.vpos
;
12388 this_line_start_x
= row
->x
;
12391 CHARPOS (this_line_start_pos
) = 0;
12398 /* Run window scroll functions, if any, for WINDOW with new window
12399 start STARTP. Sets the window start of WINDOW to that position.
12401 We assume that the window's buffer is really current. */
12403 static INLINE
struct text_pos
12404 run_window_scroll_functions (window
, startp
)
12405 Lisp_Object window
;
12406 struct text_pos startp
;
12408 struct window
*w
= XWINDOW (window
);
12409 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12411 if (current_buffer
!= XBUFFER (w
->buffer
))
12414 if (!NILP (Vwindow_scroll_functions
))
12416 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12417 make_number (CHARPOS (startp
)));
12418 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12419 /* In case the hook functions switch buffers. */
12420 if (current_buffer
!= XBUFFER (w
->buffer
))
12421 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12428 /* Make sure the line containing the cursor is fully visible.
12429 A value of 1 means there is nothing to be done.
12430 (Either the line is fully visible, or it cannot be made so,
12431 or we cannot tell.)
12433 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12434 is higher than window.
12436 A value of 0 means the caller should do scrolling
12437 as if point had gone off the screen. */
12440 cursor_row_fully_visible_p (w
, force_p
, current_matrix_p
)
12443 int current_matrix_p
;
12445 struct glyph_matrix
*matrix
;
12446 struct glyph_row
*row
;
12449 if (!make_cursor_line_fully_visible_p
)
12452 /* It's not always possible to find the cursor, e.g, when a window
12453 is full of overlay strings. Don't do anything in that case. */
12454 if (w
->cursor
.vpos
< 0)
12457 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
12458 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
12460 /* If the cursor row is not partially visible, there's nothing to do. */
12461 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
12464 /* If the row the cursor is in is taller than the window's height,
12465 it's not clear what to do, so do nothing. */
12466 window_height
= window_box_height (w
);
12467 if (row
->height
>= window_height
)
12469 if (!force_p
|| MINI_WINDOW_P (w
)
12470 || w
->vscroll
|| w
->cursor
.vpos
== 0)
12476 /* This code used to try to scroll the window just enough to make
12477 the line visible. It returned 0 to say that the caller should
12478 allocate larger glyph matrices. */
12480 if (MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (w
, row
))
12482 int dy
= row
->height
- row
->visible_height
;
12485 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
12487 else /* MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P (w, row)) */
12489 int dy
= - (row
->height
- row
->visible_height
);
12492 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
12495 /* When we change the cursor y-position of the selected window,
12496 change this_line_y as well so that the display optimization for
12497 the cursor line of the selected window in redisplay_internal uses
12498 the correct y-position. */
12499 if (w
== XWINDOW (selected_window
))
12500 this_line_y
= w
->cursor
.y
;
12502 /* If vscrolling requires a larger glyph matrix, arrange for a fresh
12503 redisplay with larger matrices. */
12504 if (matrix
->nrows
< required_matrix_height (w
))
12506 fonts_changed_p
= 1;
12515 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
12516 non-zero means only WINDOW is redisplayed in redisplay_internal.
12517 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
12518 in redisplay_window to bring a partially visible line into view in
12519 the case that only the cursor has moved.
12521 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
12522 last screen line's vertical height extends past the end of the screen.
12526 1 if scrolling succeeded
12528 0 if scrolling didn't find point.
12530 -1 if new fonts have been loaded so that we must interrupt
12531 redisplay, adjust glyph matrices, and try again. */
12537 SCROLLING_NEED_LARGER_MATRICES
12541 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
12542 scroll_step
, temp_scroll_step
, last_line_misfit
)
12543 Lisp_Object window
;
12544 int just_this_one_p
;
12545 EMACS_INT scroll_conservatively
, scroll_step
;
12546 int temp_scroll_step
;
12547 int last_line_misfit
;
12549 struct window
*w
= XWINDOW (window
);
12550 struct frame
*f
= XFRAME (w
->frame
);
12551 struct text_pos scroll_margin_pos
;
12552 struct text_pos pos
;
12553 struct text_pos startp
;
12555 Lisp_Object window_end
;
12556 int this_scroll_margin
;
12560 int amount_to_scroll
= 0;
12561 Lisp_Object aggressive
;
12563 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
12566 debug_method_add (w
, "try_scrolling");
12569 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12571 /* Compute scroll margin height in pixels. We scroll when point is
12572 within this distance from the top or bottom of the window. */
12573 if (scroll_margin
> 0)
12575 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
12576 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
12579 this_scroll_margin
= 0;
12581 /* Force scroll_conservatively to have a reasonable value so it doesn't
12582 cause an overflow while computing how much to scroll. */
12583 if (scroll_conservatively
)
12584 scroll_conservatively
= min (scroll_conservatively
,
12585 MOST_POSITIVE_FIXNUM
/ FRAME_LINE_HEIGHT (f
));
12587 /* Compute how much we should try to scroll maximally to bring point
12589 if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
12590 scroll_max
= max (scroll_step
,
12591 max (scroll_conservatively
, temp_scroll_step
));
12592 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
12593 || NUMBERP (current_buffer
->scroll_up_aggressively
))
12594 /* We're trying to scroll because of aggressive scrolling
12595 but no scroll_step is set. Choose an arbitrary one. Maybe
12596 there should be a variable for this. */
12600 scroll_max
*= FRAME_LINE_HEIGHT (f
);
12602 /* Decide whether we have to scroll down. Start at the window end
12603 and move this_scroll_margin up to find the position of the scroll
12605 window_end
= Fwindow_end (window
, Qt
);
12609 CHARPOS (scroll_margin_pos
) = XINT (window_end
);
12610 BYTEPOS (scroll_margin_pos
) = CHAR_TO_BYTE (CHARPOS (scroll_margin_pos
));
12612 if (this_scroll_margin
|| extra_scroll_margin_lines
)
12614 start_display (&it
, w
, scroll_margin_pos
);
12615 if (this_scroll_margin
)
12616 move_it_vertically_backward (&it
, this_scroll_margin
);
12617 if (extra_scroll_margin_lines
)
12618 move_it_by_lines (&it
, - extra_scroll_margin_lines
, 0);
12619 scroll_margin_pos
= it
.current
.pos
;
12622 if (PT
>= CHARPOS (scroll_margin_pos
))
12626 /* Point is in the scroll margin at the bottom of the window, or
12627 below. Compute a new window start that makes point visible. */
12629 /* Compute the distance from the scroll margin to PT.
12630 Give up if the distance is greater than scroll_max. */
12631 start_display (&it
, w
, scroll_margin_pos
);
12633 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
12634 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
12636 /* To make point visible, we have to move the window start
12637 down so that the line the cursor is in is visible, which
12638 means we have to add in the height of the cursor line. */
12639 dy
= line_bottom_y (&it
) - y0
;
12641 if (dy
> scroll_max
)
12642 return SCROLLING_FAILED
;
12644 /* Move the window start down. If scrolling conservatively,
12645 move it just enough down to make point visible. If
12646 scroll_step is set, move it down by scroll_step. */
12647 start_display (&it
, w
, startp
);
12649 if (scroll_conservatively
)
12650 /* Set AMOUNT_TO_SCROLL to at least one line,
12651 and at most scroll_conservatively lines. */
12653 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
12654 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
12655 else if (scroll_step
|| temp_scroll_step
)
12656 amount_to_scroll
= scroll_max
;
12659 aggressive
= current_buffer
->scroll_up_aggressively
;
12660 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12661 if (NUMBERP (aggressive
))
12663 double float_amount
= XFLOATINT (aggressive
) * height
;
12664 amount_to_scroll
= float_amount
;
12665 if (amount_to_scroll
== 0 && float_amount
> 0)
12666 amount_to_scroll
= 1;
12670 if (amount_to_scroll
<= 0)
12671 return SCROLLING_FAILED
;
12673 /* If moving by amount_to_scroll leaves STARTP unchanged,
12674 move it down one screen line. */
12676 move_it_vertically (&it
, amount_to_scroll
);
12677 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
12678 move_it_by_lines (&it
, 1, 1);
12679 startp
= it
.current
.pos
;
12683 /* See if point is inside the scroll margin at the top of the
12685 scroll_margin_pos
= startp
;
12686 if (this_scroll_margin
)
12688 start_display (&it
, w
, startp
);
12689 move_it_vertically (&it
, this_scroll_margin
);
12690 scroll_margin_pos
= it
.current
.pos
;
12693 if (PT
< CHARPOS (scroll_margin_pos
))
12695 /* Point is in the scroll margin at the top of the window or
12696 above what is displayed in the window. */
12699 /* Compute the vertical distance from PT to the scroll
12700 margin position. Give up if distance is greater than
12702 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
12703 start_display (&it
, w
, pos
);
12705 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
12706 it
.last_visible_y
, -1,
12707 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
12708 dy
= it
.current_y
- y0
;
12709 if (dy
> scroll_max
)
12710 return SCROLLING_FAILED
;
12712 /* Compute new window start. */
12713 start_display (&it
, w
, startp
);
12715 if (scroll_conservatively
)
12717 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
12718 else if (scroll_step
|| temp_scroll_step
)
12719 amount_to_scroll
= scroll_max
;
12722 aggressive
= current_buffer
->scroll_down_aggressively
;
12723 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12724 if (NUMBERP (aggressive
))
12726 double float_amount
= XFLOATINT (aggressive
) * height
;
12727 amount_to_scroll
= float_amount
;
12728 if (amount_to_scroll
== 0 && float_amount
> 0)
12729 amount_to_scroll
= 1;
12733 if (amount_to_scroll
<= 0)
12734 return SCROLLING_FAILED
;
12736 move_it_vertically_backward (&it
, amount_to_scroll
);
12737 startp
= it
.current
.pos
;
12741 /* Run window scroll functions. */
12742 startp
= run_window_scroll_functions (window
, startp
);
12744 /* Display the window. Give up if new fonts are loaded, or if point
12746 if (!try_window (window
, startp
, 0))
12747 rc
= SCROLLING_NEED_LARGER_MATRICES
;
12748 else if (w
->cursor
.vpos
< 0)
12750 clear_glyph_matrix (w
->desired_matrix
);
12751 rc
= SCROLLING_FAILED
;
12755 /* Maybe forget recorded base line for line number display. */
12756 if (!just_this_one_p
12757 || current_buffer
->clip_changed
12758 || BEG_UNCHANGED
< CHARPOS (startp
))
12759 w
->base_line_number
= Qnil
;
12761 /* If cursor ends up on a partially visible line,
12762 treat that as being off the bottom of the screen. */
12763 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
12765 clear_glyph_matrix (w
->desired_matrix
);
12766 ++extra_scroll_margin_lines
;
12769 rc
= SCROLLING_SUCCESS
;
12776 /* Compute a suitable window start for window W if display of W starts
12777 on a continuation line. Value is non-zero if a new window start
12780 The new window start will be computed, based on W's width, starting
12781 from the start of the continued line. It is the start of the
12782 screen line with the minimum distance from the old start W->start. */
12785 compute_window_start_on_continuation_line (w
)
12788 struct text_pos pos
, start_pos
;
12789 int window_start_changed_p
= 0;
12791 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
12793 /* If window start is on a continuation line... Window start may be
12794 < BEGV in case there's invisible text at the start of the
12795 buffer (M-x rmail, for example). */
12796 if (CHARPOS (start_pos
) > BEGV
12797 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
12800 struct glyph_row
*row
;
12802 /* Handle the case that the window start is out of range. */
12803 if (CHARPOS (start_pos
) < BEGV
)
12804 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
12805 else if (CHARPOS (start_pos
) > ZV
)
12806 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
12808 /* Find the start of the continued line. This should be fast
12809 because scan_buffer is fast (newline cache). */
12810 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
12811 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
12812 row
, DEFAULT_FACE_ID
);
12813 reseat_at_previous_visible_line_start (&it
);
12815 /* If the line start is "too far" away from the window start,
12816 say it takes too much time to compute a new window start. */
12817 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
12818 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
12820 int min_distance
, distance
;
12822 /* Move forward by display lines to find the new window
12823 start. If window width was enlarged, the new start can
12824 be expected to be > the old start. If window width was
12825 decreased, the new window start will be < the old start.
12826 So, we're looking for the display line start with the
12827 minimum distance from the old window start. */
12828 pos
= it
.current
.pos
;
12829 min_distance
= INFINITY
;
12830 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
12831 distance
< min_distance
)
12833 min_distance
= distance
;
12834 pos
= it
.current
.pos
;
12835 move_it_by_lines (&it
, 1, 0);
12838 /* Set the window start there. */
12839 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
12840 window_start_changed_p
= 1;
12844 return window_start_changed_p
;
12848 /* Try cursor movement in case text has not changed in window WINDOW,
12849 with window start STARTP. Value is
12851 CURSOR_MOVEMENT_SUCCESS if successful
12853 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
12855 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
12856 display. *SCROLL_STEP is set to 1, under certain circumstances, if
12857 we want to scroll as if scroll-step were set to 1. See the code.
12859 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
12860 which case we have to abort this redisplay, and adjust matrices
12865 CURSOR_MOVEMENT_SUCCESS
,
12866 CURSOR_MOVEMENT_CANNOT_BE_USED
,
12867 CURSOR_MOVEMENT_MUST_SCROLL
,
12868 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
12872 try_cursor_movement (window
, startp
, scroll_step
)
12873 Lisp_Object window
;
12874 struct text_pos startp
;
12877 struct window
*w
= XWINDOW (window
);
12878 struct frame
*f
= XFRAME (w
->frame
);
12879 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
12882 if (inhibit_try_cursor_movement
)
12886 /* Handle case where text has not changed, only point, and it has
12887 not moved off the frame. */
12888 if (/* Point may be in this window. */
12889 PT
>= CHARPOS (startp
)
12890 /* Selective display hasn't changed. */
12891 && !current_buffer
->clip_changed
12892 /* Function force-mode-line-update is used to force a thorough
12893 redisplay. It sets either windows_or_buffers_changed or
12894 update_mode_lines. So don't take a shortcut here for these
12896 && !update_mode_lines
12897 && !windows_or_buffers_changed
12898 && !cursor_type_changed
12899 /* Can't use this case if highlighting a region. When a
12900 region exists, cursor movement has to do more than just
12902 && !(!NILP (Vtransient_mark_mode
)
12903 && !NILP (current_buffer
->mark_active
))
12904 && NILP (w
->region_showing
)
12905 && NILP (Vshow_trailing_whitespace
)
12906 /* Right after splitting windows, last_point may be nil. */
12907 && INTEGERP (w
->last_point
)
12908 /* This code is not used for mini-buffer for the sake of the case
12909 of redisplaying to replace an echo area message; since in
12910 that case the mini-buffer contents per se are usually
12911 unchanged. This code is of no real use in the mini-buffer
12912 since the handling of this_line_start_pos, etc., in redisplay
12913 handles the same cases. */
12914 && !EQ (window
, minibuf_window
)
12915 /* When splitting windows or for new windows, it happens that
12916 redisplay is called with a nil window_end_vpos or one being
12917 larger than the window. This should really be fixed in
12918 window.c. I don't have this on my list, now, so we do
12919 approximately the same as the old redisplay code. --gerd. */
12920 && INTEGERP (w
->window_end_vpos
)
12921 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
12922 && (FRAME_WINDOW_P (f
)
12923 || !overlay_arrow_in_current_buffer_p ()))
12925 int this_scroll_margin
, top_scroll_margin
;
12926 struct glyph_row
*row
= NULL
;
12929 debug_method_add (w
, "cursor movement");
12932 /* Scroll if point within this distance from the top or bottom
12933 of the window. This is a pixel value. */
12934 this_scroll_margin
= max (0, scroll_margin
);
12935 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
12936 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
12938 top_scroll_margin
= this_scroll_margin
;
12939 if (WINDOW_WANTS_HEADER_LINE_P (w
))
12940 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
12942 /* Start with the row the cursor was displayed during the last
12943 not paused redisplay. Give up if that row is not valid. */
12944 if (w
->last_cursor
.vpos
< 0
12945 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
12946 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12949 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
12950 if (row
->mode_line_p
)
12952 if (!row
->enabled_p
)
12953 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12956 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
12959 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
12961 if (PT
> XFASTINT (w
->last_point
))
12963 /* Point has moved forward. */
12964 while (MATRIX_ROW_END_CHARPOS (row
) < PT
12965 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
12967 xassert (row
->enabled_p
);
12971 /* The end position of a row equals the start position
12972 of the next row. If PT is there, we would rather
12973 display it in the next line. */
12974 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
12975 && MATRIX_ROW_END_CHARPOS (row
) == PT
12976 && !cursor_row_p (w
, row
))
12979 /* If within the scroll margin, scroll. Note that
12980 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
12981 the next line would be drawn, and that
12982 this_scroll_margin can be zero. */
12983 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
12984 || PT
> MATRIX_ROW_END_CHARPOS (row
)
12985 /* Line is completely visible last line in window
12986 and PT is to be set in the next line. */
12987 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
12988 && PT
== MATRIX_ROW_END_CHARPOS (row
)
12989 && !row
->ends_at_zv_p
12990 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
12993 else if (PT
< XFASTINT (w
->last_point
))
12995 /* Cursor has to be moved backward. Note that PT >=
12996 CHARPOS (startp) because of the outer if-statement. */
12997 while (!row
->mode_line_p
12998 && (MATRIX_ROW_START_CHARPOS (row
) > PT
12999 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13000 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13001 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13002 row
> w
->current_matrix
->rows
13003 && (row
-1)->ends_in_newline_from_string_p
))))
13004 && (row
->y
> top_scroll_margin
13005 || CHARPOS (startp
) == BEGV
))
13007 xassert (row
->enabled_p
);
13011 /* Consider the following case: Window starts at BEGV,
13012 there is invisible, intangible text at BEGV, so that
13013 display starts at some point START > BEGV. It can
13014 happen that we are called with PT somewhere between
13015 BEGV and START. Try to handle that case. */
13016 if (row
< w
->current_matrix
->rows
13017 || row
->mode_line_p
)
13019 row
= w
->current_matrix
->rows
;
13020 if (row
->mode_line_p
)
13024 /* Due to newlines in overlay strings, we may have to
13025 skip forward over overlay strings. */
13026 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13027 && MATRIX_ROW_END_CHARPOS (row
) == PT
13028 && !cursor_row_p (w
, row
))
13031 /* If within the scroll margin, scroll. */
13032 if (row
->y
< top_scroll_margin
13033 && CHARPOS (startp
) != BEGV
)
13038 /* Cursor did not move. So don't scroll even if cursor line
13039 is partially visible, as it was so before. */
13040 rc
= CURSOR_MOVEMENT_SUCCESS
;
13043 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13044 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13046 /* if PT is not in the glyph row, give up. */
13047 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13049 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13050 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13051 && make_cursor_line_fully_visible_p
)
13053 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13054 && !row
->ends_at_zv_p
13055 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13056 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13057 else if (row
->height
> window_box_height (w
))
13059 /* If we end up in a partially visible line, let's
13060 make it fully visible, except when it's taller
13061 than the window, in which case we can't do much
13064 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13068 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13069 if (!cursor_row_fully_visible_p (w
, 0, 1))
13070 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13072 rc
= CURSOR_MOVEMENT_SUCCESS
;
13076 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13081 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13083 rc
= CURSOR_MOVEMENT_SUCCESS
;
13088 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13089 && MATRIX_ROW_START_CHARPOS (row
) == PT
13090 && cursor_row_p (w
, row
));
13099 set_vertical_scroll_bar (w
)
13102 int start
, end
, whole
;
13104 /* Calculate the start and end positions for the current window.
13105 At some point, it would be nice to choose between scrollbars
13106 which reflect the whole buffer size, with special markers
13107 indicating narrowing, and scrollbars which reflect only the
13110 Note that mini-buffers sometimes aren't displaying any text. */
13111 if (!MINI_WINDOW_P (w
)
13112 || (w
== XWINDOW (minibuf_window
)
13113 && NILP (echo_area_buffer
[0])))
13115 struct buffer
*buf
= XBUFFER (w
->buffer
);
13116 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13117 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13118 /* I don't think this is guaranteed to be right. For the
13119 moment, we'll pretend it is. */
13120 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13124 if (whole
< (end
- start
))
13125 whole
= end
- start
;
13128 start
= end
= whole
= 0;
13130 /* Indicate what this scroll bar ought to be displaying now. */
13131 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13132 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13133 (w
, end
- start
, whole
, start
);
13137 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13138 selected_window is redisplayed.
13140 We can return without actually redisplaying the window if
13141 fonts_changed_p is nonzero. In that case, redisplay_internal will
13145 redisplay_window (window
, just_this_one_p
)
13146 Lisp_Object window
;
13147 int just_this_one_p
;
13149 struct window
*w
= XWINDOW (window
);
13150 struct frame
*f
= XFRAME (w
->frame
);
13151 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13152 struct buffer
*old
= current_buffer
;
13153 struct text_pos lpoint
, opoint
, startp
;
13154 int update_mode_line
;
13157 /* Record it now because it's overwritten. */
13158 int current_matrix_up_to_date_p
= 0;
13159 int used_current_matrix_p
= 0;
13160 /* This is less strict than current_matrix_up_to_date_p.
13161 It indictes that the buffer contents and narrowing are unchanged. */
13162 int buffer_unchanged_p
= 0;
13163 int temp_scroll_step
= 0;
13164 int count
= SPECPDL_INDEX ();
13166 int centering_position
= -1;
13167 int last_line_misfit
= 0;
13168 int beg_unchanged
, end_unchanged
;
13170 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13173 /* W must be a leaf window here. */
13174 xassert (!NILP (w
->buffer
));
13176 *w
->desired_matrix
->method
= 0;
13180 reconsider_clip_changes (w
, buffer
);
13182 /* Has the mode line to be updated? */
13183 update_mode_line
= (!NILP (w
->update_mode_line
)
13184 || update_mode_lines
13185 || buffer
->clip_changed
13186 || buffer
->prevent_redisplay_optimizations_p
);
13188 if (MINI_WINDOW_P (w
))
13190 if (w
== XWINDOW (echo_area_window
)
13191 && !NILP (echo_area_buffer
[0]))
13193 if (update_mode_line
)
13194 /* We may have to update a tty frame's menu bar or a
13195 tool-bar. Example `M-x C-h C-h C-g'. */
13196 goto finish_menu_bars
;
13198 /* We've already displayed the echo area glyphs in this window. */
13199 goto finish_scroll_bars
;
13201 else if ((w
!= XWINDOW (minibuf_window
)
13202 || minibuf_level
== 0)
13203 /* When buffer is nonempty, redisplay window normally. */
13204 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13205 /* Quail displays non-mini buffers in minibuffer window.
13206 In that case, redisplay the window normally. */
13207 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13209 /* W is a mini-buffer window, but it's not active, so clear
13211 int yb
= window_text_bottom_y (w
);
13212 struct glyph_row
*row
;
13215 for (y
= 0, row
= w
->desired_matrix
->rows
;
13217 y
+= row
->height
, ++row
)
13218 blank_row (w
, row
, y
);
13219 goto finish_scroll_bars
;
13222 clear_glyph_matrix (w
->desired_matrix
);
13225 /* Otherwise set up data on this window; select its buffer and point
13227 /* Really select the buffer, for the sake of buffer-local
13229 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13231 current_matrix_up_to_date_p
13232 = (!NILP (w
->window_end_valid
)
13233 && !current_buffer
->clip_changed
13234 && !current_buffer
->prevent_redisplay_optimizations_p
13235 && XFASTINT (w
->last_modified
) >= MODIFF
13236 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13238 /* Run the window-bottom-change-functions
13239 if it is possible that the text on the screen has changed
13240 (either due to modification of the text, or any other reason). */
13241 if (!current_matrix_up_to_date_p
13242 && !NILP (Vwindow_text_change_functions
))
13244 safe_run_hooks (Qwindow_text_change_functions
);
13248 beg_unchanged
= BEG_UNCHANGED
;
13249 end_unchanged
= END_UNCHANGED
;
13251 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13253 specbind (Qinhibit_point_motion_hooks
, Qt
);
13256 = (!NILP (w
->window_end_valid
)
13257 && !current_buffer
->clip_changed
13258 && XFASTINT (w
->last_modified
) >= MODIFF
13259 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13261 /* When windows_or_buffers_changed is non-zero, we can't rely on
13262 the window end being valid, so set it to nil there. */
13263 if (windows_or_buffers_changed
)
13265 /* If window starts on a continuation line, maybe adjust the
13266 window start in case the window's width changed. */
13267 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13268 compute_window_start_on_continuation_line (w
);
13270 w
->window_end_valid
= Qnil
;
13273 /* Some sanity checks. */
13274 CHECK_WINDOW_END (w
);
13275 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13277 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13280 /* If %c is in mode line, update it if needed. */
13281 if (!NILP (w
->column_number_displayed
)
13282 /* This alternative quickly identifies a common case
13283 where no change is needed. */
13284 && !(PT
== XFASTINT (w
->last_point
)
13285 && XFASTINT (w
->last_modified
) >= MODIFF
13286 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13287 && (XFASTINT (w
->column_number_displayed
)
13288 != (int) current_column ())) /* iftc */
13289 update_mode_line
= 1;
13291 /* Count number of windows showing the selected buffer. An indirect
13292 buffer counts as its base buffer. */
13293 if (!just_this_one_p
)
13295 struct buffer
*current_base
, *window_base
;
13296 current_base
= current_buffer
;
13297 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13298 if (current_base
->base_buffer
)
13299 current_base
= current_base
->base_buffer
;
13300 if (window_base
->base_buffer
)
13301 window_base
= window_base
->base_buffer
;
13302 if (current_base
== window_base
)
13306 /* Point refers normally to the selected window. For any other
13307 window, set up appropriate value. */
13308 if (!EQ (window
, selected_window
))
13310 int new_pt
= XMARKER (w
->pointm
)->charpos
;
13311 int new_pt_byte
= marker_byte_position (w
->pointm
);
13315 new_pt_byte
= BEGV_BYTE
;
13316 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13318 else if (new_pt
> (ZV
- 1))
13321 new_pt_byte
= ZV_BYTE
;
13322 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13325 /* We don't use SET_PT so that the point-motion hooks don't run. */
13326 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13329 /* If any of the character widths specified in the display table
13330 have changed, invalidate the width run cache. It's true that
13331 this may be a bit late to catch such changes, but the rest of
13332 redisplay goes (non-fatally) haywire when the display table is
13333 changed, so why should we worry about doing any better? */
13334 if (current_buffer
->width_run_cache
)
13336 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13338 if (! disptab_matches_widthtab (disptab
,
13339 XVECTOR (current_buffer
->width_table
)))
13341 invalidate_region_cache (current_buffer
,
13342 current_buffer
->width_run_cache
,
13344 recompute_width_table (current_buffer
, disptab
);
13348 /* If window-start is screwed up, choose a new one. */
13349 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13352 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13354 /* If someone specified a new starting point but did not insist,
13355 check whether it can be used. */
13356 if (!NILP (w
->optional_new_start
)
13357 && CHARPOS (startp
) >= BEGV
13358 && CHARPOS (startp
) <= ZV
)
13360 w
->optional_new_start
= Qnil
;
13361 start_display (&it
, w
, startp
);
13362 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13363 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13364 if (IT_CHARPOS (it
) == PT
)
13365 w
->force_start
= Qt
;
13366 /* IT may overshoot PT if text at PT is invisible. */
13367 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13368 w
->force_start
= Qt
;
13373 /* Handle case where place to start displaying has been specified,
13374 unless the specified location is outside the accessible range. */
13375 if (!NILP (w
->force_start
)
13376 || w
->frozen_window_start_p
)
13378 /* We set this later on if we have to adjust point. */
13382 w
->force_start
= Qnil
;
13384 w
->window_end_valid
= Qnil
;
13386 /* Forget any recorded base line for line number display. */
13387 if (!buffer_unchanged_p
)
13388 w
->base_line_number
= Qnil
;
13390 /* Redisplay the mode line. Select the buffer properly for that.
13391 Also, run the hook window-scroll-functions
13392 because we have scrolled. */
13393 /* Note, we do this after clearing force_start because
13394 if there's an error, it is better to forget about force_start
13395 than to get into an infinite loop calling the hook functions
13396 and having them get more errors. */
13397 if (!update_mode_line
13398 || ! NILP (Vwindow_scroll_functions
))
13400 update_mode_line
= 1;
13401 w
->update_mode_line
= Qt
;
13402 startp
= run_window_scroll_functions (window
, startp
);
13405 w
->last_modified
= make_number (0);
13406 w
->last_overlay_modified
= make_number (0);
13407 if (CHARPOS (startp
) < BEGV
)
13408 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13409 else if (CHARPOS (startp
) > ZV
)
13410 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
13412 /* Redisplay, then check if cursor has been set during the
13413 redisplay. Give up if new fonts were loaded. */
13414 val
= try_window (window
, startp
, 1);
13417 w
->force_start
= Qt
;
13418 clear_glyph_matrix (w
->desired_matrix
);
13419 goto need_larger_matrices
;
13421 /* Point was outside the scroll margins. */
13423 new_vpos
= window_box_height (w
) / 2;
13425 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
13427 /* If point does not appear, try to move point so it does
13428 appear. The desired matrix has been built above, so we
13429 can use it here. */
13430 new_vpos
= window_box_height (w
) / 2;
13433 if (!cursor_row_fully_visible_p (w
, 0, 0))
13435 /* Point does appear, but on a line partly visible at end of window.
13436 Move it back to a fully-visible line. */
13437 new_vpos
= window_box_height (w
);
13440 /* If we need to move point for either of the above reasons,
13441 now actually do it. */
13444 struct glyph_row
*row
;
13446 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
13447 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
13450 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
13451 MATRIX_ROW_START_BYTEPOS (row
));
13453 if (w
!= XWINDOW (selected_window
))
13454 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
13455 else if (current_buffer
== old
)
13456 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13458 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
13460 /* If we are highlighting the region, then we just changed
13461 the region, so redisplay to show it. */
13462 if (!NILP (Vtransient_mark_mode
)
13463 && !NILP (current_buffer
->mark_active
))
13465 clear_glyph_matrix (w
->desired_matrix
);
13466 if (!try_window (window
, startp
, 0))
13467 goto need_larger_matrices
;
13472 debug_method_add (w
, "forced window start");
13477 /* Handle case where text has not changed, only point, and it has
13478 not moved off the frame, and we are not retrying after hscroll.
13479 (current_matrix_up_to_date_p is nonzero when retrying.) */
13480 if (current_matrix_up_to_date_p
13481 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
13482 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
13486 case CURSOR_MOVEMENT_SUCCESS
:
13487 used_current_matrix_p
= 1;
13490 #if 0 /* try_cursor_movement never returns this value. */
13491 case CURSOR_MOVEMENT_NEED_LARGER_MATRICES
:
13492 goto need_larger_matrices
;
13495 case CURSOR_MOVEMENT_MUST_SCROLL
:
13496 goto try_to_scroll
;
13502 /* If current starting point was originally the beginning of a line
13503 but no longer is, find a new starting point. */
13504 else if (!NILP (w
->start_at_line_beg
)
13505 && !(CHARPOS (startp
) <= BEGV
13506 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
13509 debug_method_add (w
, "recenter 1");
13514 /* Try scrolling with try_window_id. Value is > 0 if update has
13515 been done, it is -1 if we know that the same window start will
13516 not work. It is 0 if unsuccessful for some other reason. */
13517 else if ((tem
= try_window_id (w
)) != 0)
13520 debug_method_add (w
, "try_window_id %d", tem
);
13523 if (fonts_changed_p
)
13524 goto need_larger_matrices
;
13528 /* Otherwise try_window_id has returned -1 which means that we
13529 don't want the alternative below this comment to execute. */
13531 else if (CHARPOS (startp
) >= BEGV
13532 && CHARPOS (startp
) <= ZV
13533 && PT
>= CHARPOS (startp
)
13534 && (CHARPOS (startp
) < ZV
13535 /* Avoid starting at end of buffer. */
13536 || CHARPOS (startp
) == BEGV
13537 || (XFASTINT (w
->last_modified
) >= MODIFF
13538 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
13541 /* If first window line is a continuation line, and window start
13542 is inside the modified region, but the first change is before
13543 current window start, we must select a new window start.
13545 However, if this is the result of a down-mouse event (e.g. by
13546 extending the mouse-drag-overlay), we don't want to select a
13547 new window start, since that would change the position under
13548 the mouse, resulting in an unwanted mouse-movement rather
13549 than a simple mouse-click. */
13550 if (NILP (w
->start_at_line_beg
)
13551 && NILP (do_mouse_tracking
)
13552 && CHARPOS (startp
) > BEGV
13553 && CHARPOS (startp
) > BEG
+ beg_unchanged
13554 && CHARPOS (startp
) <= Z
- end_unchanged
)
13556 w
->force_start
= Qt
;
13557 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13558 compute_window_start_on_continuation_line (w
);
13559 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13564 debug_method_add (w
, "same window start");
13567 /* Try to redisplay starting at same place as before.
13568 If point has not moved off frame, accept the results. */
13569 if (!current_matrix_up_to_date_p
13570 /* Don't use try_window_reusing_current_matrix in this case
13571 because a window scroll function can have changed the
13573 || !NILP (Vwindow_scroll_functions
)
13574 || MINI_WINDOW_P (w
)
13575 || !(used_current_matrix_p
13576 = try_window_reusing_current_matrix (w
)))
13578 IF_DEBUG (debug_method_add (w
, "1"));
13579 if (try_window (window
, startp
, 1) < 0)
13580 /* -1 means we need to scroll.
13581 0 means we need new matrices, but fonts_changed_p
13582 is set in that case, so we will detect it below. */
13583 goto try_to_scroll
;
13586 if (fonts_changed_p
)
13587 goto need_larger_matrices
;
13589 if (w
->cursor
.vpos
>= 0)
13591 if (!just_this_one_p
13592 || current_buffer
->clip_changed
13593 || BEG_UNCHANGED
< CHARPOS (startp
))
13594 /* Forget any recorded base line for line number display. */
13595 w
->base_line_number
= Qnil
;
13597 if (!cursor_row_fully_visible_p (w
, 1, 0))
13599 clear_glyph_matrix (w
->desired_matrix
);
13600 last_line_misfit
= 1;
13602 /* Drop through and scroll. */
13607 clear_glyph_matrix (w
->desired_matrix
);
13612 w
->last_modified
= make_number (0);
13613 w
->last_overlay_modified
= make_number (0);
13615 /* Redisplay the mode line. Select the buffer properly for that. */
13616 if (!update_mode_line
)
13618 update_mode_line
= 1;
13619 w
->update_mode_line
= Qt
;
13622 /* Try to scroll by specified few lines. */
13623 if ((scroll_conservatively
13625 || temp_scroll_step
13626 || NUMBERP (current_buffer
->scroll_up_aggressively
)
13627 || NUMBERP (current_buffer
->scroll_down_aggressively
))
13628 && !current_buffer
->clip_changed
13629 && CHARPOS (startp
) >= BEGV
13630 && CHARPOS (startp
) <= ZV
)
13632 /* The function returns -1 if new fonts were loaded, 1 if
13633 successful, 0 if not successful. */
13634 int rc
= try_scrolling (window
, just_this_one_p
,
13635 scroll_conservatively
,
13637 temp_scroll_step
, last_line_misfit
);
13640 case SCROLLING_SUCCESS
:
13643 case SCROLLING_NEED_LARGER_MATRICES
:
13644 goto need_larger_matrices
;
13646 case SCROLLING_FAILED
:
13654 /* Finally, just choose place to start which centers point */
13657 if (centering_position
< 0)
13658 centering_position
= window_box_height (w
) / 2;
13661 debug_method_add (w
, "recenter");
13664 /* w->vscroll = 0; */
13666 /* Forget any previously recorded base line for line number display. */
13667 if (!buffer_unchanged_p
)
13668 w
->base_line_number
= Qnil
;
13670 /* Move backward half the height of the window. */
13671 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13672 it
.current_y
= it
.last_visible_y
;
13673 move_it_vertically_backward (&it
, centering_position
);
13674 xassert (IT_CHARPOS (it
) >= BEGV
);
13676 /* The function move_it_vertically_backward may move over more
13677 than the specified y-distance. If it->w is small, e.g. a
13678 mini-buffer window, we may end up in front of the window's
13679 display area. Start displaying at the start of the line
13680 containing PT in this case. */
13681 if (it
.current_y
<= 0)
13683 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13684 move_it_vertically_backward (&it
, 0);
13686 /* I think this assert is bogus if buffer contains
13687 invisible text or images. KFS. */
13688 xassert (IT_CHARPOS (it
) <= PT
);
13693 it
.current_x
= it
.hpos
= 0;
13695 /* Set startp here explicitly in case that helps avoid an infinite loop
13696 in case the window-scroll-functions functions get errors. */
13697 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
13699 /* Run scroll hooks. */
13700 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
13702 /* Redisplay the window. */
13703 if (!current_matrix_up_to_date_p
13704 || windows_or_buffers_changed
13705 || cursor_type_changed
13706 /* Don't use try_window_reusing_current_matrix in this case
13707 because it can have changed the buffer. */
13708 || !NILP (Vwindow_scroll_functions
)
13709 || !just_this_one_p
13710 || MINI_WINDOW_P (w
)
13711 || !(used_current_matrix_p
13712 = try_window_reusing_current_matrix (w
)))
13713 try_window (window
, startp
, 0);
13715 /* If new fonts have been loaded (due to fontsets), give up. We
13716 have to start a new redisplay since we need to re-adjust glyph
13718 if (fonts_changed_p
)
13719 goto need_larger_matrices
;
13721 /* If cursor did not appear assume that the middle of the window is
13722 in the first line of the window. Do it again with the next line.
13723 (Imagine a window of height 100, displaying two lines of height
13724 60. Moving back 50 from it->last_visible_y will end in the first
13726 if (w
->cursor
.vpos
< 0)
13728 if (!NILP (w
->window_end_valid
)
13729 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
13731 clear_glyph_matrix (w
->desired_matrix
);
13732 move_it_by_lines (&it
, 1, 0);
13733 try_window (window
, it
.current
.pos
, 0);
13735 else if (PT
< IT_CHARPOS (it
))
13737 clear_glyph_matrix (w
->desired_matrix
);
13738 move_it_by_lines (&it
, -1, 0);
13739 try_window (window
, it
.current
.pos
, 0);
13743 /* Not much we can do about it. */
13747 /* Consider the following case: Window starts at BEGV, there is
13748 invisible, intangible text at BEGV, so that display starts at
13749 some point START > BEGV. It can happen that we are called with
13750 PT somewhere between BEGV and START. Try to handle that case. */
13751 if (w
->cursor
.vpos
< 0)
13753 struct glyph_row
*row
= w
->current_matrix
->rows
;
13754 if (row
->mode_line_p
)
13756 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13759 if (!cursor_row_fully_visible_p (w
, 0, 0))
13761 /* If vscroll is enabled, disable it and try again. */
13765 clear_glyph_matrix (w
->desired_matrix
);
13769 /* If centering point failed to make the whole line visible,
13770 put point at the top instead. That has to make the whole line
13771 visible, if it can be done. */
13772 if (centering_position
== 0)
13775 clear_glyph_matrix (w
->desired_matrix
);
13776 centering_position
= 0;
13782 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13783 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
13784 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
13787 /* Display the mode line, if we must. */
13788 if ((update_mode_line
13789 /* If window not full width, must redo its mode line
13790 if (a) the window to its side is being redone and
13791 (b) we do a frame-based redisplay. This is a consequence
13792 of how inverted lines are drawn in frame-based redisplay. */
13793 || (!just_this_one_p
13794 && !FRAME_WINDOW_P (f
)
13795 && !WINDOW_FULL_WIDTH_P (w
))
13796 /* Line number to display. */
13797 || INTEGERP (w
->base_line_pos
)
13798 /* Column number is displayed and different from the one displayed. */
13799 || (!NILP (w
->column_number_displayed
)
13800 && (XFASTINT (w
->column_number_displayed
)
13801 != (int) current_column ()))) /* iftc */
13802 /* This means that the window has a mode line. */
13803 && (WINDOW_WANTS_MODELINE_P (w
)
13804 || WINDOW_WANTS_HEADER_LINE_P (w
)))
13806 display_mode_lines (w
);
13808 /* If mode line height has changed, arrange for a thorough
13809 immediate redisplay using the correct mode line height. */
13810 if (WINDOW_WANTS_MODELINE_P (w
)
13811 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
13813 fonts_changed_p
= 1;
13814 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
13815 = DESIRED_MODE_LINE_HEIGHT (w
);
13818 /* If top line height has changed, arrange for a thorough
13819 immediate redisplay using the correct mode line height. */
13820 if (WINDOW_WANTS_HEADER_LINE_P (w
)
13821 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
13823 fonts_changed_p
= 1;
13824 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
13825 = DESIRED_HEADER_LINE_HEIGHT (w
);
13828 if (fonts_changed_p
)
13829 goto need_larger_matrices
;
13832 if (!line_number_displayed
13833 && !BUFFERP (w
->base_line_pos
))
13835 w
->base_line_pos
= Qnil
;
13836 w
->base_line_number
= Qnil
;
13841 /* When we reach a frame's selected window, redo the frame's menu bar. */
13842 if (update_mode_line
13843 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
13845 int redisplay_menu_p
= 0;
13846 int redisplay_tool_bar_p
= 0;
13848 if (FRAME_WINDOW_P (f
))
13850 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
13851 || defined (USE_GTK)
13852 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
13854 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13858 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13860 if (redisplay_menu_p
)
13861 display_menu_bar (w
);
13863 #ifdef HAVE_WINDOW_SYSTEM
13864 if (FRAME_WINDOW_P (f
))
13866 #if defined (USE_GTK) || USE_MAC_TOOLBAR
13867 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
13869 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
13870 && (FRAME_TOOL_BAR_LINES (f
) > 0
13871 || !NILP (Vauto_resize_tool_bars
));
13874 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
13876 extern int ignore_mouse_drag_p
;
13877 ignore_mouse_drag_p
= 1;
13883 #ifdef HAVE_WINDOW_SYSTEM
13884 if (FRAME_WINDOW_P (f
)
13885 && update_window_fringes (w
, (just_this_one_p
13886 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
13887 || w
->pseudo_window_p
)))
13891 if (draw_window_fringes (w
, 1))
13892 x_draw_vertical_border (w
);
13896 #endif /* HAVE_WINDOW_SYSTEM */
13898 /* We go to this label, with fonts_changed_p nonzero,
13899 if it is necessary to try again using larger glyph matrices.
13900 We have to redeem the scroll bar even in this case,
13901 because the loop in redisplay_internal expects that. */
13902 need_larger_matrices
:
13904 finish_scroll_bars
:
13906 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
13908 /* Set the thumb's position and size. */
13909 set_vertical_scroll_bar (w
);
13911 /* Note that we actually used the scroll bar attached to this
13912 window, so it shouldn't be deleted at the end of redisplay. */
13913 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
13914 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
13917 /* Restore current_buffer and value of point in it. */
13918 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
13919 set_buffer_internal_1 (old
);
13920 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
13921 shorter. This can be caused by log truncation in *Messages*. */
13922 if (CHARPOS (lpoint
) <= ZV
)
13923 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
13925 unbind_to (count
, Qnil
);
13929 /* Build the complete desired matrix of WINDOW with a window start
13930 buffer position POS.
13932 Value is 1 if successful. It is zero if fonts were loaded during
13933 redisplay which makes re-adjusting glyph matrices necessary, and -1
13934 if point would appear in the scroll margins.
13935 (We check that only if CHECK_MARGINS is nonzero. */
13938 try_window (window
, pos
, check_margins
)
13939 Lisp_Object window
;
13940 struct text_pos pos
;
13943 struct window
*w
= XWINDOW (window
);
13945 struct glyph_row
*last_text_row
= NULL
;
13946 struct frame
*f
= XFRAME (w
->frame
);
13948 /* Make POS the new window start. */
13949 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
13951 /* Mark cursor position as unknown. No overlay arrow seen. */
13952 w
->cursor
.vpos
= -1;
13953 overlay_arrow_seen
= 0;
13955 /* Initialize iterator and info to start at POS. */
13956 start_display (&it
, w
, pos
);
13958 /* Display all lines of W. */
13959 while (it
.current_y
< it
.last_visible_y
)
13961 if (display_line (&it
))
13962 last_text_row
= it
.glyph_row
- 1;
13963 if (fonts_changed_p
)
13967 /* Don't let the cursor end in the scroll margins. */
13969 && !MINI_WINDOW_P (w
))
13971 int this_scroll_margin
;
13973 this_scroll_margin
= max (0, scroll_margin
);
13974 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13975 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
13977 if ((w
->cursor
.y
>= 0 /* not vscrolled */
13978 && w
->cursor
.y
< this_scroll_margin
13979 && CHARPOS (pos
) > BEGV
13980 && IT_CHARPOS (it
) < ZV
)
13981 /* rms: considering make_cursor_line_fully_visible_p here
13982 seems to give wrong results. We don't want to recenter
13983 when the last line is partly visible, we want to allow
13984 that case to be handled in the usual way. */
13985 || (w
->cursor
.y
+ 1) > it
.last_visible_y
)
13987 w
->cursor
.vpos
= -1;
13988 clear_glyph_matrix (w
->desired_matrix
);
13993 /* If bottom moved off end of frame, change mode line percentage. */
13994 if (XFASTINT (w
->window_end_pos
) <= 0
13995 && Z
!= IT_CHARPOS (it
))
13996 w
->update_mode_line
= Qt
;
13998 /* Set window_end_pos to the offset of the last character displayed
13999 on the window from the end of current_buffer. Set
14000 window_end_vpos to its row number. */
14003 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14004 w
->window_end_bytepos
14005 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14007 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14009 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14010 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14011 ->displays_text_p
);
14015 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14016 w
->window_end_pos
= make_number (Z
- ZV
);
14017 w
->window_end_vpos
= make_number (0);
14020 /* But that is not valid info until redisplay finishes. */
14021 w
->window_end_valid
= Qnil
;
14027 /************************************************************************
14028 Window redisplay reusing current matrix when buffer has not changed
14029 ************************************************************************/
14031 /* Try redisplay of window W showing an unchanged buffer with a
14032 different window start than the last time it was displayed by
14033 reusing its current matrix. Value is non-zero if successful.
14034 W->start is the new window start. */
14037 try_window_reusing_current_matrix (w
)
14040 struct frame
*f
= XFRAME (w
->frame
);
14041 struct glyph_row
*row
, *bottom_row
;
14044 struct text_pos start
, new_start
;
14045 int nrows_scrolled
, i
;
14046 struct glyph_row
*last_text_row
;
14047 struct glyph_row
*last_reused_text_row
;
14048 struct glyph_row
*start_row
;
14049 int start_vpos
, min_y
, max_y
;
14052 if (inhibit_try_window_reusing
)
14056 if (/* This function doesn't handle terminal frames. */
14057 !FRAME_WINDOW_P (f
)
14058 /* Don't try to reuse the display if windows have been split
14060 || windows_or_buffers_changed
14061 || cursor_type_changed
)
14064 /* Can't do this if region may have changed. */
14065 if ((!NILP (Vtransient_mark_mode
)
14066 && !NILP (current_buffer
->mark_active
))
14067 || !NILP (w
->region_showing
)
14068 || !NILP (Vshow_trailing_whitespace
))
14071 /* If top-line visibility has changed, give up. */
14072 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14073 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14076 /* Give up if old or new display is scrolled vertically. We could
14077 make this function handle this, but right now it doesn't. */
14078 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14079 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14082 /* The variable new_start now holds the new window start. The old
14083 start `start' can be determined from the current matrix. */
14084 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14085 start
= start_row
->start
.pos
;
14086 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14088 /* Clear the desired matrix for the display below. */
14089 clear_glyph_matrix (w
->desired_matrix
);
14091 if (CHARPOS (new_start
) <= CHARPOS (start
))
14095 /* Don't use this method if the display starts with an ellipsis
14096 displayed for invisible text. It's not easy to handle that case
14097 below, and it's certainly not worth the effort since this is
14098 not a frequent case. */
14099 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14102 IF_DEBUG (debug_method_add (w
, "twu1"));
14104 /* Display up to a row that can be reused. The variable
14105 last_text_row is set to the last row displayed that displays
14106 text. Note that it.vpos == 0 if or if not there is a
14107 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14108 start_display (&it
, w
, new_start
);
14109 first_row_y
= it
.current_y
;
14110 w
->cursor
.vpos
= -1;
14111 last_text_row
= last_reused_text_row
= NULL
;
14113 while (it
.current_y
< it
.last_visible_y
14114 && !fonts_changed_p
)
14116 /* If we have reached into the characters in the START row,
14117 that means the line boundaries have changed. So we
14118 can't start copying with the row START. Maybe it will
14119 work to start copying with the following row. */
14120 while (IT_CHARPOS (it
) > CHARPOS (start
))
14122 /* Advance to the next row as the "start". */
14124 start
= start_row
->start
.pos
;
14125 /* If there are no more rows to try, or just one, give up. */
14126 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14127 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14128 || CHARPOS (start
) == ZV
)
14130 clear_glyph_matrix (w
->desired_matrix
);
14134 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14136 /* If we have reached alignment,
14137 we can copy the rest of the rows. */
14138 if (IT_CHARPOS (it
) == CHARPOS (start
))
14141 if (display_line (&it
))
14142 last_text_row
= it
.glyph_row
- 1;
14145 /* A value of current_y < last_visible_y means that we stopped
14146 at the previous window start, which in turn means that we
14147 have at least one reusable row. */
14148 if (it
.current_y
< it
.last_visible_y
)
14150 /* IT.vpos always starts from 0; it counts text lines. */
14151 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14153 /* Find PT if not already found in the lines displayed. */
14154 if (w
->cursor
.vpos
< 0)
14156 int dy
= it
.current_y
- start_row
->y
;
14158 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14159 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14161 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14162 dy
, nrows_scrolled
);
14165 clear_glyph_matrix (w
->desired_matrix
);
14170 /* Scroll the display. Do it before the current matrix is
14171 changed. The problem here is that update has not yet
14172 run, i.e. part of the current matrix is not up to date.
14173 scroll_run_hook will clear the cursor, and use the
14174 current matrix to get the height of the row the cursor is
14176 run
.current_y
= start_row
->y
;
14177 run
.desired_y
= it
.current_y
;
14178 run
.height
= it
.last_visible_y
- it
.current_y
;
14180 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14183 FRAME_RIF (f
)->update_window_begin_hook (w
);
14184 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14185 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14186 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14190 /* Shift current matrix down by nrows_scrolled lines. */
14191 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14192 rotate_matrix (w
->current_matrix
,
14194 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14197 /* Disable lines that must be updated. */
14198 for (i
= 0; i
< nrows_scrolled
; ++i
)
14199 (start_row
+ i
)->enabled_p
= 0;
14201 /* Re-compute Y positions. */
14202 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14203 max_y
= it
.last_visible_y
;
14204 for (row
= start_row
+ nrows_scrolled
;
14208 row
->y
= it
.current_y
;
14209 row
->visible_height
= row
->height
;
14211 if (row
->y
< min_y
)
14212 row
->visible_height
-= min_y
- row
->y
;
14213 if (row
->y
+ row
->height
> max_y
)
14214 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14215 row
->redraw_fringe_bitmaps_p
= 1;
14217 it
.current_y
+= row
->height
;
14219 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14220 last_reused_text_row
= row
;
14221 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14225 /* Disable lines in the current matrix which are now
14226 below the window. */
14227 for (++row
; row
< bottom_row
; ++row
)
14228 row
->enabled_p
= row
->mode_line_p
= 0;
14231 /* Update window_end_pos etc.; last_reused_text_row is the last
14232 reused row from the current matrix containing text, if any.
14233 The value of last_text_row is the last displayed line
14234 containing text. */
14235 if (last_reused_text_row
)
14237 w
->window_end_bytepos
14238 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14240 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14242 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14243 w
->current_matrix
));
14245 else if (last_text_row
)
14247 w
->window_end_bytepos
14248 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14250 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14252 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14256 /* This window must be completely empty. */
14257 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14258 w
->window_end_pos
= make_number (Z
- ZV
);
14259 w
->window_end_vpos
= make_number (0);
14261 w
->window_end_valid
= Qnil
;
14263 /* Update hint: don't try scrolling again in update_window. */
14264 w
->desired_matrix
->no_scrolling_p
= 1;
14267 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14271 else if (CHARPOS (new_start
) > CHARPOS (start
))
14273 struct glyph_row
*pt_row
, *row
;
14274 struct glyph_row
*first_reusable_row
;
14275 struct glyph_row
*first_row_to_display
;
14277 int yb
= window_text_bottom_y (w
);
14279 /* Find the row starting at new_start, if there is one. Don't
14280 reuse a partially visible line at the end. */
14281 first_reusable_row
= start_row
;
14282 while (first_reusable_row
->enabled_p
14283 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14284 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14285 < CHARPOS (new_start
)))
14286 ++first_reusable_row
;
14288 /* Give up if there is no row to reuse. */
14289 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14290 || !first_reusable_row
->enabled_p
14291 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14292 != CHARPOS (new_start
)))
14295 /* We can reuse fully visible rows beginning with
14296 first_reusable_row to the end of the window. Set
14297 first_row_to_display to the first row that cannot be reused.
14298 Set pt_row to the row containing point, if there is any. */
14300 for (first_row_to_display
= first_reusable_row
;
14301 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14302 ++first_row_to_display
)
14304 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14305 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14306 pt_row
= first_row_to_display
;
14309 /* Start displaying at the start of first_row_to_display. */
14310 xassert (first_row_to_display
->y
< yb
);
14311 init_to_row_start (&it
, w
, first_row_to_display
);
14313 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14315 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14317 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14318 + WINDOW_HEADER_LINE_HEIGHT (w
));
14320 /* Display lines beginning with first_row_to_display in the
14321 desired matrix. Set last_text_row to the last row displayed
14322 that displays text. */
14323 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14324 if (pt_row
== NULL
)
14325 w
->cursor
.vpos
= -1;
14326 last_text_row
= NULL
;
14327 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14328 if (display_line (&it
))
14329 last_text_row
= it
.glyph_row
- 1;
14331 /* Give up If point isn't in a row displayed or reused. */
14332 if (w
->cursor
.vpos
< 0)
14334 clear_glyph_matrix (w
->desired_matrix
);
14338 /* If point is in a reused row, adjust y and vpos of the cursor
14342 w
->cursor
.vpos
-= nrows_scrolled
;
14343 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14346 /* Scroll the display. */
14347 run
.current_y
= first_reusable_row
->y
;
14348 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14349 run
.height
= it
.last_visible_y
- run
.current_y
;
14350 dy
= run
.current_y
- run
.desired_y
;
14355 FRAME_RIF (f
)->update_window_begin_hook (w
);
14356 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14357 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14358 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14362 /* Adjust Y positions of reused rows. */
14363 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14364 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14365 max_y
= it
.last_visible_y
;
14366 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14369 row
->visible_height
= row
->height
;
14370 if (row
->y
< min_y
)
14371 row
->visible_height
-= min_y
- row
->y
;
14372 if (row
->y
+ row
->height
> max_y
)
14373 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14374 row
->redraw_fringe_bitmaps_p
= 1;
14377 /* Scroll the current matrix. */
14378 xassert (nrows_scrolled
> 0);
14379 rotate_matrix (w
->current_matrix
,
14381 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14384 /* Disable rows not reused. */
14385 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
14386 row
->enabled_p
= 0;
14388 /* Point may have moved to a different line, so we cannot assume that
14389 the previous cursor position is valid; locate the correct row. */
14392 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14393 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
14397 w
->cursor
.y
= row
->y
;
14399 if (row
< bottom_row
)
14401 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14402 while (glyph
->charpos
< PT
)
14405 w
->cursor
.x
+= glyph
->pixel_width
;
14411 /* Adjust window end. A null value of last_text_row means that
14412 the window end is in reused rows which in turn means that
14413 only its vpos can have changed. */
14416 w
->window_end_bytepos
14417 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14419 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14421 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14426 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
14429 w
->window_end_valid
= Qnil
;
14430 w
->desired_matrix
->no_scrolling_p
= 1;
14433 debug_method_add (w
, "try_window_reusing_current_matrix 2");
14443 /************************************************************************
14444 Window redisplay reusing current matrix when buffer has changed
14445 ************************************************************************/
14447 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
14448 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
14450 static struct glyph_row
*
14451 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
14452 struct glyph_row
*));
14455 /* Return the last row in MATRIX displaying text. If row START is
14456 non-null, start searching with that row. IT gives the dimensions
14457 of the display. Value is null if matrix is empty; otherwise it is
14458 a pointer to the row found. */
14460 static struct glyph_row
*
14461 find_last_row_displaying_text (matrix
, it
, start
)
14462 struct glyph_matrix
*matrix
;
14464 struct glyph_row
*start
;
14466 struct glyph_row
*row
, *row_found
;
14468 /* Set row_found to the last row in IT->w's current matrix
14469 displaying text. The loop looks funny but think of partially
14472 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
14473 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14475 xassert (row
->enabled_p
);
14477 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
14486 /* Return the last row in the current matrix of W that is not affected
14487 by changes at the start of current_buffer that occurred since W's
14488 current matrix was built. Value is null if no such row exists.
14490 BEG_UNCHANGED us the number of characters unchanged at the start of
14491 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
14492 first changed character in current_buffer. Characters at positions <
14493 BEG + BEG_UNCHANGED are at the same buffer positions as they were
14494 when the current matrix was built. */
14496 static struct glyph_row
*
14497 find_last_unchanged_at_beg_row (w
)
14500 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
14501 struct glyph_row
*row
;
14502 struct glyph_row
*row_found
= NULL
;
14503 int yb
= window_text_bottom_y (w
);
14505 /* Find the last row displaying unchanged text. */
14506 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14507 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14508 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
)
14510 if (/* If row ends before first_changed_pos, it is unchanged,
14511 except in some case. */
14512 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
14513 /* When row ends in ZV and we write at ZV it is not
14515 && !row
->ends_at_zv_p
14516 /* When first_changed_pos is the end of a continued line,
14517 row is not unchanged because it may be no longer
14519 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
14520 && (row
->continued_p
14521 || row
->exact_window_width_line_p
)))
14524 /* Stop if last visible row. */
14525 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
14535 /* Find the first glyph row in the current matrix of W that is not
14536 affected by changes at the end of current_buffer since the
14537 time W's current matrix was built.
14539 Return in *DELTA the number of chars by which buffer positions in
14540 unchanged text at the end of current_buffer must be adjusted.
14542 Return in *DELTA_BYTES the corresponding number of bytes.
14544 Value is null if no such row exists, i.e. all rows are affected by
14547 static struct glyph_row
*
14548 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
14550 int *delta
, *delta_bytes
;
14552 struct glyph_row
*row
;
14553 struct glyph_row
*row_found
= NULL
;
14555 *delta
= *delta_bytes
= 0;
14557 /* Display must not have been paused, otherwise the current matrix
14558 is not up to date. */
14559 eassert (!NILP (w
->window_end_valid
));
14561 /* A value of window_end_pos >= END_UNCHANGED means that the window
14562 end is in the range of changed text. If so, there is no
14563 unchanged row at the end of W's current matrix. */
14564 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
14567 /* Set row to the last row in W's current matrix displaying text. */
14568 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14570 /* If matrix is entirely empty, no unchanged row exists. */
14571 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14573 /* The value of row is the last glyph row in the matrix having a
14574 meaningful buffer position in it. The end position of row
14575 corresponds to window_end_pos. This allows us to translate
14576 buffer positions in the current matrix to current buffer
14577 positions for characters not in changed text. */
14578 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14579 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14580 int last_unchanged_pos
, last_unchanged_pos_old
;
14581 struct glyph_row
*first_text_row
14582 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14584 *delta
= Z
- Z_old
;
14585 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14587 /* Set last_unchanged_pos to the buffer position of the last
14588 character in the buffer that has not been changed. Z is the
14589 index + 1 of the last character in current_buffer, i.e. by
14590 subtracting END_UNCHANGED we get the index of the last
14591 unchanged character, and we have to add BEG to get its buffer
14593 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
14594 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
14596 /* Search backward from ROW for a row displaying a line that
14597 starts at a minimum position >= last_unchanged_pos_old. */
14598 for (; row
> first_text_row
; --row
)
14600 /* This used to abort, but it can happen.
14601 It is ok to just stop the search instead here. KFS. */
14602 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14605 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
14610 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
14616 /* Make sure that glyph rows in the current matrix of window W
14617 reference the same glyph memory as corresponding rows in the
14618 frame's frame matrix. This function is called after scrolling W's
14619 current matrix on a terminal frame in try_window_id and
14620 try_window_reusing_current_matrix. */
14623 sync_frame_with_window_matrix_rows (w
)
14626 struct frame
*f
= XFRAME (w
->frame
);
14627 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
14629 /* Preconditions: W must be a leaf window and full-width. Its frame
14630 must have a frame matrix. */
14631 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
14632 xassert (WINDOW_FULL_WIDTH_P (w
));
14633 xassert (!FRAME_WINDOW_P (f
));
14635 /* If W is a full-width window, glyph pointers in W's current matrix
14636 have, by definition, to be the same as glyph pointers in the
14637 corresponding frame matrix. Note that frame matrices have no
14638 marginal areas (see build_frame_matrix). */
14639 window_row
= w
->current_matrix
->rows
;
14640 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
14641 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
14642 while (window_row
< window_row_end
)
14644 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
14645 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
14647 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
14648 frame_row
->glyphs
[TEXT_AREA
] = start
;
14649 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
14650 frame_row
->glyphs
[LAST_AREA
] = end
;
14652 /* Disable frame rows whose corresponding window rows have
14653 been disabled in try_window_id. */
14654 if (!window_row
->enabled_p
)
14655 frame_row
->enabled_p
= 0;
14657 ++window_row
, ++frame_row
;
14662 /* Find the glyph row in window W containing CHARPOS. Consider all
14663 rows between START and END (not inclusive). END null means search
14664 all rows to the end of the display area of W. Value is the row
14665 containing CHARPOS or null. */
14668 row_containing_pos (w
, charpos
, start
, end
, dy
)
14671 struct glyph_row
*start
, *end
;
14674 struct glyph_row
*row
= start
;
14677 /* If we happen to start on a header-line, skip that. */
14678 if (row
->mode_line_p
)
14681 if ((end
&& row
>= end
) || !row
->enabled_p
)
14684 last_y
= window_text_bottom_y (w
) - dy
;
14688 /* Give up if we have gone too far. */
14689 if (end
&& row
>= end
)
14691 /* This formerly returned if they were equal.
14692 I think that both quantities are of a "last plus one" type;
14693 if so, when they are equal, the row is within the screen. -- rms. */
14694 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
14697 /* If it is in this row, return this row. */
14698 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
14699 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
14700 /* The end position of a row equals the start
14701 position of the next row. If CHARPOS is there, we
14702 would rather display it in the next line, except
14703 when this line ends in ZV. */
14704 && !row
->ends_at_zv_p
14705 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14706 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
14713 /* Try to redisplay window W by reusing its existing display. W's
14714 current matrix must be up to date when this function is called,
14715 i.e. window_end_valid must not be nil.
14719 1 if display has been updated
14720 0 if otherwise unsuccessful
14721 -1 if redisplay with same window start is known not to succeed
14723 The following steps are performed:
14725 1. Find the last row in the current matrix of W that is not
14726 affected by changes at the start of current_buffer. If no such row
14729 2. Find the first row in W's current matrix that is not affected by
14730 changes at the end of current_buffer. Maybe there is no such row.
14732 3. Display lines beginning with the row + 1 found in step 1 to the
14733 row found in step 2 or, if step 2 didn't find a row, to the end of
14736 4. If cursor is not known to appear on the window, give up.
14738 5. If display stopped at the row found in step 2, scroll the
14739 display and current matrix as needed.
14741 6. Maybe display some lines at the end of W, if we must. This can
14742 happen under various circumstances, like a partially visible line
14743 becoming fully visible, or because newly displayed lines are displayed
14744 in smaller font sizes.
14746 7. Update W's window end information. */
14752 struct frame
*f
= XFRAME (w
->frame
);
14753 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
14754 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
14755 struct glyph_row
*last_unchanged_at_beg_row
;
14756 struct glyph_row
*first_unchanged_at_end_row
;
14757 struct glyph_row
*row
;
14758 struct glyph_row
*bottom_row
;
14761 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
14762 struct text_pos start_pos
;
14764 int first_unchanged_at_end_vpos
= 0;
14765 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
14766 struct text_pos start
;
14767 int first_changed_charpos
, last_changed_charpos
;
14770 if (inhibit_try_window_id
)
14774 /* This is handy for debugging. */
14776 #define GIVE_UP(X) \
14778 fprintf (stderr, "try_window_id give up %d\n", (X)); \
14782 #define GIVE_UP(X) return 0
14785 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
14787 /* Don't use this for mini-windows because these can show
14788 messages and mini-buffers, and we don't handle that here. */
14789 if (MINI_WINDOW_P (w
))
14792 /* This flag is used to prevent redisplay optimizations. */
14793 if (windows_or_buffers_changed
|| cursor_type_changed
)
14796 /* Verify that narrowing has not changed.
14797 Also verify that we were not told to prevent redisplay optimizations.
14798 It would be nice to further
14799 reduce the number of cases where this prevents try_window_id. */
14800 if (current_buffer
->clip_changed
14801 || current_buffer
->prevent_redisplay_optimizations_p
)
14804 /* Window must either use window-based redisplay or be full width. */
14805 if (!FRAME_WINDOW_P (f
)
14806 && (!FRAME_LINE_INS_DEL_OK (f
)
14807 || !WINDOW_FULL_WIDTH_P (w
)))
14810 /* Give up if point is not known NOT to appear in W. */
14811 if (PT
< CHARPOS (start
))
14814 /* Another way to prevent redisplay optimizations. */
14815 if (XFASTINT (w
->last_modified
) == 0)
14818 /* Verify that window is not hscrolled. */
14819 if (XFASTINT (w
->hscroll
) != 0)
14822 /* Verify that display wasn't paused. */
14823 if (NILP (w
->window_end_valid
))
14826 /* Can't use this if highlighting a region because a cursor movement
14827 will do more than just set the cursor. */
14828 if (!NILP (Vtransient_mark_mode
)
14829 && !NILP (current_buffer
->mark_active
))
14832 /* Likewise if highlighting trailing whitespace. */
14833 if (!NILP (Vshow_trailing_whitespace
))
14836 /* Likewise if showing a region. */
14837 if (!NILP (w
->region_showing
))
14840 /* Can use this if overlay arrow position and or string have changed. */
14841 if (overlay_arrows_changed_p ())
14845 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
14846 only if buffer has really changed. The reason is that the gap is
14847 initially at Z for freshly visited files. The code below would
14848 set end_unchanged to 0 in that case. */
14849 if (MODIFF
> SAVE_MODIFF
14850 /* This seems to happen sometimes after saving a buffer. */
14851 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
14853 if (GPT
- BEG
< BEG_UNCHANGED
)
14854 BEG_UNCHANGED
= GPT
- BEG
;
14855 if (Z
- GPT
< END_UNCHANGED
)
14856 END_UNCHANGED
= Z
- GPT
;
14859 /* The position of the first and last character that has been changed. */
14860 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
14861 last_changed_charpos
= Z
- END_UNCHANGED
;
14863 /* If window starts after a line end, and the last change is in
14864 front of that newline, then changes don't affect the display.
14865 This case happens with stealth-fontification. Note that although
14866 the display is unchanged, glyph positions in the matrix have to
14867 be adjusted, of course. */
14868 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14869 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14870 && ((last_changed_charpos
< CHARPOS (start
)
14871 && CHARPOS (start
) == BEGV
)
14872 || (last_changed_charpos
< CHARPOS (start
) - 1
14873 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
14875 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
14876 struct glyph_row
*r0
;
14878 /* Compute how many chars/bytes have been added to or removed
14879 from the buffer. */
14880 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14881 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14883 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14885 /* Give up if PT is not in the window. Note that it already has
14886 been checked at the start of try_window_id that PT is not in
14887 front of the window start. */
14888 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
14891 /* If window start is unchanged, we can reuse the whole matrix
14892 as is, after adjusting glyph positions. No need to compute
14893 the window end again, since its offset from Z hasn't changed. */
14894 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14895 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
14896 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
14897 /* PT must not be in a partially visible line. */
14898 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
14899 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
14901 /* Adjust positions in the glyph matrix. */
14902 if (delta
|| delta_bytes
)
14904 struct glyph_row
*r1
14905 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
14906 increment_matrix_positions (w
->current_matrix
,
14907 MATRIX_ROW_VPOS (r0
, current_matrix
),
14908 MATRIX_ROW_VPOS (r1
, current_matrix
),
14909 delta
, delta_bytes
);
14912 /* Set the cursor. */
14913 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
14915 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
14922 /* Handle the case that changes are all below what is displayed in
14923 the window, and that PT is in the window. This shortcut cannot
14924 be taken if ZV is visible in the window, and text has been added
14925 there that is visible in the window. */
14926 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
14927 /* ZV is not visible in the window, or there are no
14928 changes at ZV, actually. */
14929 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
14930 || first_changed_charpos
== last_changed_charpos
))
14932 struct glyph_row
*r0
;
14934 /* Give up if PT is not in the window. Note that it already has
14935 been checked at the start of try_window_id that PT is not in
14936 front of the window start. */
14937 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
14940 /* If window start is unchanged, we can reuse the whole matrix
14941 as is, without changing glyph positions since no text has
14942 been added/removed in front of the window end. */
14943 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14944 if (TEXT_POS_EQUAL_P (start
, r0
->start
.pos
)
14945 /* PT must not be in a partially visible line. */
14946 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
14947 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
14949 /* We have to compute the window end anew since text
14950 can have been added/removed after it. */
14952 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
14953 w
->window_end_bytepos
14954 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
14956 /* Set the cursor. */
14957 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
14959 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
14966 /* Give up if window start is in the changed area.
14968 The condition used to read
14970 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
14972 but why that was tested escapes me at the moment. */
14973 if (CHARPOS (start
) >= first_changed_charpos
14974 && CHARPOS (start
) <= last_changed_charpos
)
14977 /* Check that window start agrees with the start of the first glyph
14978 row in its current matrix. Check this after we know the window
14979 start is not in changed text, otherwise positions would not be
14981 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14982 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
14985 /* Give up if the window ends in strings. Overlay strings
14986 at the end are difficult to handle, so don't try. */
14987 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
14988 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
14991 /* Compute the position at which we have to start displaying new
14992 lines. Some of the lines at the top of the window might be
14993 reusable because they are not displaying changed text. Find the
14994 last row in W's current matrix not affected by changes at the
14995 start of current_buffer. Value is null if changes start in the
14996 first line of window. */
14997 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
14998 if (last_unchanged_at_beg_row
)
15000 /* Avoid starting to display in the moddle of a character, a TAB
15001 for instance. This is easier than to set up the iterator
15002 exactly, and it's not a frequent case, so the additional
15003 effort wouldn't really pay off. */
15004 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15005 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15006 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15007 --last_unchanged_at_beg_row
;
15009 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15012 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15014 start_pos
= it
.current
.pos
;
15016 /* Start displaying new lines in the desired matrix at the same
15017 vpos we would use in the current matrix, i.e. below
15018 last_unchanged_at_beg_row. */
15019 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15021 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15022 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15024 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15028 /* There are no reusable lines at the start of the window.
15029 Start displaying in the first text line. */
15030 start_display (&it
, w
, start
);
15031 it
.vpos
= it
.first_vpos
;
15032 start_pos
= it
.current
.pos
;
15035 /* Find the first row that is not affected by changes at the end of
15036 the buffer. Value will be null if there is no unchanged row, in
15037 which case we must redisplay to the end of the window. delta
15038 will be set to the value by which buffer positions beginning with
15039 first_unchanged_at_end_row have to be adjusted due to text
15041 first_unchanged_at_end_row
15042 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15043 IF_DEBUG (debug_delta
= delta
);
15044 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15046 /* Set stop_pos to the buffer position up to which we will have to
15047 display new lines. If first_unchanged_at_end_row != NULL, this
15048 is the buffer position of the start of the line displayed in that
15049 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15050 that we don't stop at a buffer position. */
15052 if (first_unchanged_at_end_row
)
15054 xassert (last_unchanged_at_beg_row
== NULL
15055 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15057 /* If this is a continuation line, move forward to the next one
15058 that isn't. Changes in lines above affect this line.
15059 Caution: this may move first_unchanged_at_end_row to a row
15060 not displaying text. */
15061 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15062 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15063 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15064 < it
.last_visible_y
))
15065 ++first_unchanged_at_end_row
;
15067 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15068 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15069 >= it
.last_visible_y
))
15070 first_unchanged_at_end_row
= NULL
;
15073 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15075 first_unchanged_at_end_vpos
15076 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15077 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15080 else if (last_unchanged_at_beg_row
== NULL
)
15086 /* Either there is no unchanged row at the end, or the one we have
15087 now displays text. This is a necessary condition for the window
15088 end pos calculation at the end of this function. */
15089 xassert (first_unchanged_at_end_row
== NULL
15090 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15092 debug_last_unchanged_at_beg_vpos
15093 = (last_unchanged_at_beg_row
15094 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15096 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15098 #endif /* GLYPH_DEBUG != 0 */
15101 /* Display new lines. Set last_text_row to the last new line
15102 displayed which has text on it, i.e. might end up as being the
15103 line where the window_end_vpos is. */
15104 w
->cursor
.vpos
= -1;
15105 last_text_row
= NULL
;
15106 overlay_arrow_seen
= 0;
15107 while (it
.current_y
< it
.last_visible_y
15108 && !fonts_changed_p
15109 && (first_unchanged_at_end_row
== NULL
15110 || IT_CHARPOS (it
) < stop_pos
))
15112 if (display_line (&it
))
15113 last_text_row
= it
.glyph_row
- 1;
15116 if (fonts_changed_p
)
15120 /* Compute differences in buffer positions, y-positions etc. for
15121 lines reused at the bottom of the window. Compute what we can
15123 if (first_unchanged_at_end_row
15124 /* No lines reused because we displayed everything up to the
15125 bottom of the window. */
15126 && it
.current_y
< it
.last_visible_y
)
15129 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15131 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15132 run
.current_y
= first_unchanged_at_end_row
->y
;
15133 run
.desired_y
= run
.current_y
+ dy
;
15134 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15138 delta
= delta_bytes
= dvpos
= dy
15139 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15140 first_unchanged_at_end_row
= NULL
;
15142 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15145 /* Find the cursor if not already found. We have to decide whether
15146 PT will appear on this window (it sometimes doesn't, but this is
15147 not a very frequent case.) This decision has to be made before
15148 the current matrix is altered. A value of cursor.vpos < 0 means
15149 that PT is either in one of the lines beginning at
15150 first_unchanged_at_end_row or below the window. Don't care for
15151 lines that might be displayed later at the window end; as
15152 mentioned, this is not a frequent case. */
15153 if (w
->cursor
.vpos
< 0)
15155 /* Cursor in unchanged rows at the top? */
15156 if (PT
< CHARPOS (start_pos
)
15157 && last_unchanged_at_beg_row
)
15159 row
= row_containing_pos (w
, PT
,
15160 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15161 last_unchanged_at_beg_row
+ 1, 0);
15163 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15166 /* Start from first_unchanged_at_end_row looking for PT. */
15167 else if (first_unchanged_at_end_row
)
15169 row
= row_containing_pos (w
, PT
- delta
,
15170 first_unchanged_at_end_row
, NULL
, 0);
15172 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15173 delta_bytes
, dy
, dvpos
);
15176 /* Give up if cursor was not found. */
15177 if (w
->cursor
.vpos
< 0)
15179 clear_glyph_matrix (w
->desired_matrix
);
15184 /* Don't let the cursor end in the scroll margins. */
15186 int this_scroll_margin
, cursor_height
;
15188 this_scroll_margin
= max (0, scroll_margin
);
15189 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15190 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15191 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15193 if ((w
->cursor
.y
< this_scroll_margin
15194 && CHARPOS (start
) > BEGV
)
15195 /* Old redisplay didn't take scroll margin into account at the bottom,
15196 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15197 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15198 ? cursor_height
+ this_scroll_margin
15199 : 1)) > it
.last_visible_y
)
15201 w
->cursor
.vpos
= -1;
15202 clear_glyph_matrix (w
->desired_matrix
);
15207 /* Scroll the display. Do it before changing the current matrix so
15208 that xterm.c doesn't get confused about where the cursor glyph is
15210 if (dy
&& run
.height
)
15214 if (FRAME_WINDOW_P (f
))
15216 FRAME_RIF (f
)->update_window_begin_hook (w
);
15217 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15218 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15219 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15223 /* Terminal frame. In this case, dvpos gives the number of
15224 lines to scroll by; dvpos < 0 means scroll up. */
15225 int first_unchanged_at_end_vpos
15226 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15227 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
15228 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15229 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15230 + window_internal_height (w
));
15232 /* Perform the operation on the screen. */
15235 /* Scroll last_unchanged_at_beg_row to the end of the
15236 window down dvpos lines. */
15237 set_terminal_window (f
, end
);
15239 /* On dumb terminals delete dvpos lines at the end
15240 before inserting dvpos empty lines. */
15241 if (!FRAME_SCROLL_REGION_OK (f
))
15242 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15244 /* Insert dvpos empty lines in front of
15245 last_unchanged_at_beg_row. */
15246 ins_del_lines (f
, from
, dvpos
);
15248 else if (dvpos
< 0)
15250 /* Scroll up last_unchanged_at_beg_vpos to the end of
15251 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15252 set_terminal_window (f
, end
);
15254 /* Delete dvpos lines in front of
15255 last_unchanged_at_beg_vpos. ins_del_lines will set
15256 the cursor to the given vpos and emit |dvpos| delete
15258 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15260 /* On a dumb terminal insert dvpos empty lines at the
15262 if (!FRAME_SCROLL_REGION_OK (f
))
15263 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15266 set_terminal_window (f
, 0);
15272 /* Shift reused rows of the current matrix to the right position.
15273 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15275 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15276 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15279 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15280 bottom_vpos
, dvpos
);
15281 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15284 else if (dvpos
> 0)
15286 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15287 bottom_vpos
, dvpos
);
15288 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15289 first_unchanged_at_end_vpos
+ dvpos
, 0);
15292 /* For frame-based redisplay, make sure that current frame and window
15293 matrix are in sync with respect to glyph memory. */
15294 if (!FRAME_WINDOW_P (f
))
15295 sync_frame_with_window_matrix_rows (w
);
15297 /* Adjust buffer positions in reused rows. */
15298 if (delta
|| delta_bytes
)
15299 increment_matrix_positions (current_matrix
,
15300 first_unchanged_at_end_vpos
+ dvpos
,
15301 bottom_vpos
, delta
, delta_bytes
);
15303 /* Adjust Y positions. */
15305 shift_glyph_matrix (w
, current_matrix
,
15306 first_unchanged_at_end_vpos
+ dvpos
,
15309 if (first_unchanged_at_end_row
)
15311 first_unchanged_at_end_row
+= dvpos
;
15312 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15313 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15314 first_unchanged_at_end_row
= NULL
;
15317 /* If scrolling up, there may be some lines to display at the end of
15319 last_text_row_at_end
= NULL
;
15322 /* Scrolling up can leave for example a partially visible line
15323 at the end of the window to be redisplayed. */
15324 /* Set last_row to the glyph row in the current matrix where the
15325 window end line is found. It has been moved up or down in
15326 the matrix by dvpos. */
15327 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
15328 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
15330 /* If last_row is the window end line, it should display text. */
15331 xassert (last_row
->displays_text_p
);
15333 /* If window end line was partially visible before, begin
15334 displaying at that line. Otherwise begin displaying with the
15335 line following it. */
15336 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
15338 init_to_row_start (&it
, w
, last_row
);
15339 it
.vpos
= last_vpos
;
15340 it
.current_y
= last_row
->y
;
15344 init_to_row_end (&it
, w
, last_row
);
15345 it
.vpos
= 1 + last_vpos
;
15346 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
15350 /* We may start in a continuation line. If so, we have to
15351 get the right continuation_lines_width and current_x. */
15352 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
15353 it
.hpos
= it
.current_x
= 0;
15355 /* Display the rest of the lines at the window end. */
15356 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15357 while (it
.current_y
< it
.last_visible_y
15358 && !fonts_changed_p
)
15360 /* Is it always sure that the display agrees with lines in
15361 the current matrix? I don't think so, so we mark rows
15362 displayed invalid in the current matrix by setting their
15363 enabled_p flag to zero. */
15364 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
15365 if (display_line (&it
))
15366 last_text_row_at_end
= it
.glyph_row
- 1;
15370 /* Update window_end_pos and window_end_vpos. */
15371 if (first_unchanged_at_end_row
15372 && !last_text_row_at_end
)
15374 /* Window end line if one of the preserved rows from the current
15375 matrix. Set row to the last row displaying text in current
15376 matrix starting at first_unchanged_at_end_row, after
15378 xassert (first_unchanged_at_end_row
->displays_text_p
);
15379 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
15380 first_unchanged_at_end_row
);
15381 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
15383 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15384 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15386 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
15387 xassert (w
->window_end_bytepos
>= 0);
15388 IF_DEBUG (debug_method_add (w
, "A"));
15390 else if (last_text_row_at_end
)
15393 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
15394 w
->window_end_bytepos
15395 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
15397 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
15398 xassert (w
->window_end_bytepos
>= 0);
15399 IF_DEBUG (debug_method_add (w
, "B"));
15401 else if (last_text_row
)
15403 /* We have displayed either to the end of the window or at the
15404 end of the window, i.e. the last row with text is to be found
15405 in the desired matrix. */
15407 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15408 w
->window_end_bytepos
15409 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15411 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
15412 xassert (w
->window_end_bytepos
>= 0);
15414 else if (first_unchanged_at_end_row
== NULL
15415 && last_text_row
== NULL
15416 && last_text_row_at_end
== NULL
)
15418 /* Displayed to end of window, but no line containing text was
15419 displayed. Lines were deleted at the end of the window. */
15420 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
15421 int vpos
= XFASTINT (w
->window_end_vpos
);
15422 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
15423 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
15426 row
== NULL
&& vpos
>= first_vpos
;
15427 --vpos
, --current_row
, --desired_row
)
15429 if (desired_row
->enabled_p
)
15431 if (desired_row
->displays_text_p
)
15434 else if (current_row
->displays_text_p
)
15438 xassert (row
!= NULL
);
15439 w
->window_end_vpos
= make_number (vpos
+ 1);
15440 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15441 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15442 xassert (w
->window_end_bytepos
>= 0);
15443 IF_DEBUG (debug_method_add (w
, "C"));
15448 #if 0 /* This leads to problems, for instance when the cursor is
15449 at ZV, and the cursor line displays no text. */
15450 /* Disable rows below what's displayed in the window. This makes
15451 debugging easier. */
15452 enable_glyph_matrix_rows (current_matrix
,
15453 XFASTINT (w
->window_end_vpos
) + 1,
15457 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
15458 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
15460 /* Record that display has not been completed. */
15461 w
->window_end_valid
= Qnil
;
15462 w
->desired_matrix
->no_scrolling_p
= 1;
15470 /***********************************************************************
15471 More debugging support
15472 ***********************************************************************/
15476 void dump_glyph_row
P_ ((struct glyph_row
*, int, int));
15477 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
15478 void dump_glyph
P_ ((struct glyph_row
*, struct glyph
*, int));
15481 /* Dump the contents of glyph matrix MATRIX on stderr.
15483 GLYPHS 0 means don't show glyph contents.
15484 GLYPHS 1 means show glyphs in short form
15485 GLYPHS > 1 means show glyphs in long form. */
15488 dump_glyph_matrix (matrix
, glyphs
)
15489 struct glyph_matrix
*matrix
;
15493 for (i
= 0; i
< matrix
->nrows
; ++i
)
15494 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
15498 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
15499 the glyph row and area where the glyph comes from. */
15502 dump_glyph (row
, glyph
, area
)
15503 struct glyph_row
*row
;
15504 struct glyph
*glyph
;
15507 if (glyph
->type
== CHAR_GLYPH
)
15510 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15511 glyph
- row
->glyphs
[TEXT_AREA
],
15514 (BUFFERP (glyph
->object
)
15516 : (STRINGP (glyph
->object
)
15519 glyph
->pixel_width
,
15521 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
15525 glyph
->left_box_line_p
,
15526 glyph
->right_box_line_p
);
15528 else if (glyph
->type
== STRETCH_GLYPH
)
15531 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15532 glyph
- row
->glyphs
[TEXT_AREA
],
15535 (BUFFERP (glyph
->object
)
15537 : (STRINGP (glyph
->object
)
15540 glyph
->pixel_width
,
15544 glyph
->left_box_line_p
,
15545 glyph
->right_box_line_p
);
15547 else if (glyph
->type
== IMAGE_GLYPH
)
15550 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15551 glyph
- row
->glyphs
[TEXT_AREA
],
15554 (BUFFERP (glyph
->object
)
15556 : (STRINGP (glyph
->object
)
15559 glyph
->pixel_width
,
15563 glyph
->left_box_line_p
,
15564 glyph
->right_box_line_p
);
15566 else if (glyph
->type
== COMPOSITE_GLYPH
)
15569 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15570 glyph
- row
->glyphs
[TEXT_AREA
],
15573 (BUFFERP (glyph
->object
)
15575 : (STRINGP (glyph
->object
)
15578 glyph
->pixel_width
,
15582 glyph
->left_box_line_p
,
15583 glyph
->right_box_line_p
);
15588 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
15589 GLYPHS 0 means don't show glyph contents.
15590 GLYPHS 1 means show glyphs in short form
15591 GLYPHS > 1 means show glyphs in long form. */
15594 dump_glyph_row (row
, vpos
, glyphs
)
15595 struct glyph_row
*row
;
15600 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
15601 fprintf (stderr
, "======================================================================\n");
15603 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
15604 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
15606 MATRIX_ROW_START_CHARPOS (row
),
15607 MATRIX_ROW_END_CHARPOS (row
),
15608 row
->used
[TEXT_AREA
],
15609 row
->contains_overlapping_glyphs_p
,
15611 row
->truncated_on_left_p
,
15612 row
->truncated_on_right_p
,
15614 MATRIX_ROW_CONTINUATION_LINE_P (row
),
15615 row
->displays_text_p
,
15618 row
->ends_in_middle_of_char_p
,
15619 row
->starts_in_middle_of_char_p
,
15625 row
->visible_height
,
15628 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
15629 row
->end
.overlay_string_index
,
15630 row
->continuation_lines_width
);
15631 fprintf (stderr
, "%9d %5d\n",
15632 CHARPOS (row
->start
.string_pos
),
15633 CHARPOS (row
->end
.string_pos
));
15634 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
15635 row
->end
.dpvec_index
);
15642 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15644 struct glyph
*glyph
= row
->glyphs
[area
];
15645 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
15647 /* Glyph for a line end in text. */
15648 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
15651 if (glyph
< glyph_end
)
15652 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
15654 for (; glyph
< glyph_end
; ++glyph
)
15655 dump_glyph (row
, glyph
, area
);
15658 else if (glyphs
== 1)
15662 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15664 char *s
= (char *) alloca (row
->used
[area
] + 1);
15667 for (i
= 0; i
< row
->used
[area
]; ++i
)
15669 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
15670 if (glyph
->type
== CHAR_GLYPH
15671 && glyph
->u
.ch
< 0x80
15672 && glyph
->u
.ch
>= ' ')
15673 s
[i
] = glyph
->u
.ch
;
15679 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
15685 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
15686 Sdump_glyph_matrix
, 0, 1, "p",
15687 doc
: /* Dump the current matrix of the selected window to stderr.
15688 Shows contents of glyph row structures. With non-nil
15689 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
15690 glyphs in short form, otherwise show glyphs in long form. */)
15692 Lisp_Object glyphs
;
15694 struct window
*w
= XWINDOW (selected_window
);
15695 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15697 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
15698 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
15699 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
15700 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
15701 fprintf (stderr
, "=============================================\n");
15702 dump_glyph_matrix (w
->current_matrix
,
15703 NILP (glyphs
) ? 0 : XINT (glyphs
));
15708 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
15709 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
15712 struct frame
*f
= XFRAME (selected_frame
);
15713 dump_glyph_matrix (f
->current_matrix
, 1);
15718 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
15719 doc
: /* Dump glyph row ROW to stderr.
15720 GLYPH 0 means don't dump glyphs.
15721 GLYPH 1 means dump glyphs in short form.
15722 GLYPH > 1 or omitted means dump glyphs in long form. */)
15724 Lisp_Object row
, glyphs
;
15726 struct glyph_matrix
*matrix
;
15729 CHECK_NUMBER (row
);
15730 matrix
= XWINDOW (selected_window
)->current_matrix
;
15732 if (vpos
>= 0 && vpos
< matrix
->nrows
)
15733 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
15735 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15740 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
15741 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
15742 GLYPH 0 means don't dump glyphs.
15743 GLYPH 1 means dump glyphs in short form.
15744 GLYPH > 1 or omitted means dump glyphs in long form. */)
15746 Lisp_Object row
, glyphs
;
15748 struct frame
*sf
= SELECTED_FRAME ();
15749 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
15752 CHECK_NUMBER (row
);
15754 if (vpos
>= 0 && vpos
< m
->nrows
)
15755 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
15756 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15761 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
15762 doc
: /* Toggle tracing of redisplay.
15763 With ARG, turn tracing on if and only if ARG is positive. */)
15768 trace_redisplay_p
= !trace_redisplay_p
;
15771 arg
= Fprefix_numeric_value (arg
);
15772 trace_redisplay_p
= XINT (arg
) > 0;
15779 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
15780 doc
: /* Like `format', but print result to stderr.
15781 usage: (trace-to-stderr STRING &rest OBJECTS) */)
15786 Lisp_Object s
= Fformat (nargs
, args
);
15787 fprintf (stderr
, "%s", SDATA (s
));
15791 #endif /* GLYPH_DEBUG */
15795 /***********************************************************************
15796 Building Desired Matrix Rows
15797 ***********************************************************************/
15799 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
15800 Used for non-window-redisplay windows, and for windows w/o left fringe. */
15802 static struct glyph_row
*
15803 get_overlay_arrow_glyph_row (w
, overlay_arrow_string
)
15805 Lisp_Object overlay_arrow_string
;
15807 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
15808 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15809 struct buffer
*old
= current_buffer
;
15810 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
15811 int arrow_len
= SCHARS (overlay_arrow_string
);
15812 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
15813 const unsigned char *p
;
15816 int n_glyphs_before
;
15818 set_buffer_temp (buffer
);
15819 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
15820 it
.glyph_row
->used
[TEXT_AREA
] = 0;
15821 SET_TEXT_POS (it
.position
, 0, 0);
15823 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
15825 while (p
< arrow_end
)
15827 Lisp_Object face
, ilisp
;
15829 /* Get the next character. */
15831 it
.c
= string_char_and_length (p
, arrow_len
, &it
.len
);
15833 it
.c
= *p
, it
.len
= 1;
15836 /* Get its face. */
15837 ilisp
= make_number (p
- arrow_string
);
15838 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
15839 it
.face_id
= compute_char_face (f
, it
.c
, face
);
15841 /* Compute its width, get its glyphs. */
15842 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
15843 SET_TEXT_POS (it
.position
, -1, -1);
15844 PRODUCE_GLYPHS (&it
);
15846 /* If this character doesn't fit any more in the line, we have
15847 to remove some glyphs. */
15848 if (it
.current_x
> it
.last_visible_x
)
15850 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
15855 set_buffer_temp (old
);
15856 return it
.glyph_row
;
15860 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
15861 glyphs are only inserted for terminal frames since we can't really
15862 win with truncation glyphs when partially visible glyphs are
15863 involved. Which glyphs to insert is determined by
15864 produce_special_glyphs. */
15867 insert_left_trunc_glyphs (it
)
15870 struct it truncate_it
;
15871 struct glyph
*from
, *end
, *to
, *toend
;
15873 xassert (!FRAME_WINDOW_P (it
->f
));
15875 /* Get the truncation glyphs. */
15877 truncate_it
.current_x
= 0;
15878 truncate_it
.face_id
= DEFAULT_FACE_ID
;
15879 truncate_it
.glyph_row
= &scratch_glyph_row
;
15880 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
15881 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
15882 truncate_it
.object
= make_number (0);
15883 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
15885 /* Overwrite glyphs from IT with truncation glyphs. */
15886 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15887 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
15888 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
15889 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
15894 /* There may be padding glyphs left over. Overwrite them too. */
15895 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
15897 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15903 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
15907 /* Compute the pixel height and width of IT->glyph_row.
15909 Most of the time, ascent and height of a display line will be equal
15910 to the max_ascent and max_height values of the display iterator
15911 structure. This is not the case if
15913 1. We hit ZV without displaying anything. In this case, max_ascent
15914 and max_height will be zero.
15916 2. We have some glyphs that don't contribute to the line height.
15917 (The glyph row flag contributes_to_line_height_p is for future
15918 pixmap extensions).
15920 The first case is easily covered by using default values because in
15921 these cases, the line height does not really matter, except that it
15922 must not be zero. */
15925 compute_line_metrics (it
)
15928 struct glyph_row
*row
= it
->glyph_row
;
15931 if (FRAME_WINDOW_P (it
->f
))
15933 int i
, min_y
, max_y
;
15935 /* The line may consist of one space only, that was added to
15936 place the cursor on it. If so, the row's height hasn't been
15938 if (row
->height
== 0)
15940 if (it
->max_ascent
+ it
->max_descent
== 0)
15941 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
15942 row
->ascent
= it
->max_ascent
;
15943 row
->height
= it
->max_ascent
+ it
->max_descent
;
15944 row
->phys_ascent
= it
->max_phys_ascent
;
15945 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
15946 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
15949 /* Compute the width of this line. */
15950 row
->pixel_width
= row
->x
;
15951 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
15952 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
15954 xassert (row
->pixel_width
>= 0);
15955 xassert (row
->ascent
>= 0 && row
->height
> 0);
15957 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
15958 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
15960 /* If first line's physical ascent is larger than its logical
15961 ascent, use the physical ascent, and make the row taller.
15962 This makes accented characters fully visible. */
15963 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
15964 && row
->phys_ascent
> row
->ascent
)
15966 row
->height
+= row
->phys_ascent
- row
->ascent
;
15967 row
->ascent
= row
->phys_ascent
;
15970 /* Compute how much of the line is visible. */
15971 row
->visible_height
= row
->height
;
15973 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
15974 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
15976 if (row
->y
< min_y
)
15977 row
->visible_height
-= min_y
- row
->y
;
15978 if (row
->y
+ row
->height
> max_y
)
15979 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15983 row
->pixel_width
= row
->used
[TEXT_AREA
];
15984 if (row
->continued_p
)
15985 row
->pixel_width
-= it
->continuation_pixel_width
;
15986 else if (row
->truncated_on_right_p
)
15987 row
->pixel_width
-= it
->truncation_pixel_width
;
15988 row
->ascent
= row
->phys_ascent
= 0;
15989 row
->height
= row
->phys_height
= row
->visible_height
= 1;
15990 row
->extra_line_spacing
= 0;
15993 /* Compute a hash code for this row. */
15995 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15996 for (i
= 0; i
< row
->used
[area
]; ++i
)
15997 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
15998 + row
->glyphs
[area
][i
].u
.val
15999 + row
->glyphs
[area
][i
].face_id
16000 + row
->glyphs
[area
][i
].padding_p
16001 + (row
->glyphs
[area
][i
].type
<< 2));
16003 it
->max_ascent
= it
->max_descent
= 0;
16004 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16008 /* Append one space to the glyph row of iterator IT if doing a
16009 window-based redisplay. The space has the same face as
16010 IT->face_id. Value is non-zero if a space was added.
16012 This function is called to make sure that there is always one glyph
16013 at the end of a glyph row that the cursor can be set on under
16014 window-systems. (If there weren't such a glyph we would not know
16015 how wide and tall a box cursor should be displayed).
16017 At the same time this space let's a nicely handle clearing to the
16018 end of the line if the row ends in italic text. */
16021 append_space_for_newline (it
, default_face_p
)
16023 int default_face_p
;
16025 if (FRAME_WINDOW_P (it
->f
))
16027 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16029 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16030 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16032 /* Save some values that must not be changed.
16033 Must save IT->c and IT->len because otherwise
16034 ITERATOR_AT_END_P wouldn't work anymore after
16035 append_space_for_newline has been called. */
16036 enum display_element_type saved_what
= it
->what
;
16037 int saved_c
= it
->c
, saved_len
= it
->len
;
16038 int saved_x
= it
->current_x
;
16039 int saved_face_id
= it
->face_id
;
16040 struct text_pos saved_pos
;
16041 Lisp_Object saved_object
;
16044 saved_object
= it
->object
;
16045 saved_pos
= it
->position
;
16047 it
->what
= IT_CHARACTER
;
16048 bzero (&it
->position
, sizeof it
->position
);
16049 it
->object
= make_number (0);
16053 if (default_face_p
)
16054 it
->face_id
= DEFAULT_FACE_ID
;
16055 else if (it
->face_before_selective_p
)
16056 it
->face_id
= it
->saved_face_id
;
16057 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16058 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16060 PRODUCE_GLYPHS (it
);
16062 it
->override_ascent
= -1;
16063 it
->constrain_row_ascent_descent_p
= 0;
16064 it
->current_x
= saved_x
;
16065 it
->object
= saved_object
;
16066 it
->position
= saved_pos
;
16067 it
->what
= saved_what
;
16068 it
->face_id
= saved_face_id
;
16069 it
->len
= saved_len
;
16079 /* Extend the face of the last glyph in the text area of IT->glyph_row
16080 to the end of the display line. Called from display_line.
16081 If the glyph row is empty, add a space glyph to it so that we
16082 know the face to draw. Set the glyph row flag fill_line_p. */
16085 extend_face_to_end_of_line (it
)
16089 struct frame
*f
= it
->f
;
16091 /* If line is already filled, do nothing. */
16092 if (it
->current_x
>= it
->last_visible_x
)
16095 /* Face extension extends the background and box of IT->face_id
16096 to the end of the line. If the background equals the background
16097 of the frame, we don't have to do anything. */
16098 if (it
->face_before_selective_p
)
16099 face
= FACE_FROM_ID (it
->f
, it
->saved_face_id
);
16101 face
= FACE_FROM_ID (f
, it
->face_id
);
16103 if (FRAME_WINDOW_P (f
)
16104 && it
->glyph_row
->displays_text_p
16105 && face
->box
== FACE_NO_BOX
16106 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16110 /* Set the glyph row flag indicating that the face of the last glyph
16111 in the text area has to be drawn to the end of the text area. */
16112 it
->glyph_row
->fill_line_p
= 1;
16114 /* If current character of IT is not ASCII, make sure we have the
16115 ASCII face. This will be automatically undone the next time
16116 get_next_display_element returns a multibyte character. Note
16117 that the character will always be single byte in unibyte text. */
16118 if (!ASCII_CHAR_P (it
->c
))
16120 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16123 if (FRAME_WINDOW_P (f
))
16125 /* If the row is empty, add a space with the current face of IT,
16126 so that we know which face to draw. */
16127 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16129 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16130 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16131 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16136 /* Save some values that must not be changed. */
16137 int saved_x
= it
->current_x
;
16138 struct text_pos saved_pos
;
16139 Lisp_Object saved_object
;
16140 enum display_element_type saved_what
= it
->what
;
16141 int saved_face_id
= it
->face_id
;
16143 saved_object
= it
->object
;
16144 saved_pos
= it
->position
;
16146 it
->what
= IT_CHARACTER
;
16147 bzero (&it
->position
, sizeof it
->position
);
16148 it
->object
= make_number (0);
16151 it
->face_id
= face
->id
;
16153 PRODUCE_GLYPHS (it
);
16155 while (it
->current_x
<= it
->last_visible_x
)
16156 PRODUCE_GLYPHS (it
);
16158 /* Don't count these blanks really. It would let us insert a left
16159 truncation glyph below and make us set the cursor on them, maybe. */
16160 it
->current_x
= saved_x
;
16161 it
->object
= saved_object
;
16162 it
->position
= saved_pos
;
16163 it
->what
= saved_what
;
16164 it
->face_id
= saved_face_id
;
16169 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16170 trailing whitespace. */
16173 trailing_whitespace_p (charpos
)
16176 int bytepos
= CHAR_TO_BYTE (charpos
);
16179 while (bytepos
< ZV_BYTE
16180 && (c
= FETCH_CHAR (bytepos
),
16181 c
== ' ' || c
== '\t'))
16184 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16186 if (bytepos
!= PT_BYTE
)
16193 /* Highlight trailing whitespace, if any, in ROW. */
16196 highlight_trailing_whitespace (f
, row
)
16198 struct glyph_row
*row
;
16200 int used
= row
->used
[TEXT_AREA
];
16204 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16205 struct glyph
*glyph
= start
+ used
- 1;
16207 /* Skip over glyphs inserted to display the cursor at the
16208 end of a line, for extending the face of the last glyph
16209 to the end of the line on terminals, and for truncation
16210 and continuation glyphs. */
16211 while (glyph
>= start
16212 && glyph
->type
== CHAR_GLYPH
16213 && INTEGERP (glyph
->object
))
16216 /* If last glyph is a space or stretch, and it's trailing
16217 whitespace, set the face of all trailing whitespace glyphs in
16218 IT->glyph_row to `trailing-whitespace'. */
16220 && BUFFERP (glyph
->object
)
16221 && (glyph
->type
== STRETCH_GLYPH
16222 || (glyph
->type
== CHAR_GLYPH
16223 && glyph
->u
.ch
== ' '))
16224 && trailing_whitespace_p (glyph
->charpos
))
16226 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
16230 while (glyph
>= start
16231 && BUFFERP (glyph
->object
)
16232 && (glyph
->type
== STRETCH_GLYPH
16233 || (glyph
->type
== CHAR_GLYPH
16234 && glyph
->u
.ch
== ' ')))
16235 (glyph
--)->face_id
= face_id
;
16241 /* Value is non-zero if glyph row ROW in window W should be
16242 used to hold the cursor. */
16245 cursor_row_p (w
, row
)
16247 struct glyph_row
*row
;
16249 int cursor_row_p
= 1;
16251 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
16253 /* Suppose the row ends on a string.
16254 Unless the row is continued, that means it ends on a newline
16255 in the string. If it's anything other than a display string
16256 (e.g. a before-string from an overlay), we don't want the
16257 cursor there. (This heuristic seems to give the optimal
16258 behavior for the various types of multi-line strings.) */
16259 if (CHARPOS (row
->end
.string_pos
) >= 0)
16261 if (row
->continued_p
)
16265 /* Check for `display' property. */
16266 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
16267 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
16268 struct glyph
*glyph
;
16271 for (glyph
= end
; glyph
>= beg
; --glyph
)
16272 if (STRINGP (glyph
->object
))
16275 = Fget_char_property (make_number (PT
),
16279 && display_prop_string_p (prop
, glyph
->object
));
16284 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
16286 /* If the row ends in middle of a real character,
16287 and the line is continued, we want the cursor here.
16288 That's because MATRIX_ROW_END_CHARPOS would equal
16289 PT if PT is before the character. */
16290 if (!row
->ends_in_ellipsis_p
)
16291 cursor_row_p
= row
->continued_p
;
16293 /* If the row ends in an ellipsis, then
16294 MATRIX_ROW_END_CHARPOS will equal point after the invisible text.
16295 We want that position to be displayed after the ellipsis. */
16298 /* If the row ends at ZV, display the cursor at the end of that
16299 row instead of at the start of the row below. */
16300 else if (row
->ends_at_zv_p
)
16306 return cursor_row_p
;
16311 /* Push the display property PROP so that it will be rendered at the
16312 current position in IT. */
16315 push_display_prop (struct it
*it
, Lisp_Object prop
)
16319 /* Never display a cursor on the prefix. */
16320 it
->avoid_cursor_p
= 1;
16322 if (STRINGP (prop
))
16324 if (SCHARS (prop
) == 0)
16331 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
16332 it
->current
.overlay_string_index
= -1;
16333 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
16334 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
16335 it
->method
= GET_FROM_STRING
;
16336 it
->stop_charpos
= 0;
16338 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
16340 it
->method
= GET_FROM_STRETCH
;
16343 #ifdef HAVE_WINDOW_SYSTEM
16344 else if (IMAGEP (prop
))
16346 it
->what
= IT_IMAGE
;
16347 it
->image_id
= lookup_image (it
->f
, prop
);
16348 it
->method
= GET_FROM_IMAGE
;
16350 #endif /* HAVE_WINDOW_SYSTEM */
16353 pop_it (it
); /* bogus display property, give up */
16358 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
16361 handle_line_prefix (struct it
*it
)
16363 Lisp_Object prefix
;
16364 if (it
->continuation_lines_width
> 0)
16366 prefix
= get_it_property (it
, Qwrap_prefix
);
16368 prefix
= Vwrap_prefix
;
16372 prefix
= get_it_property (it
, Qline_prefix
);
16374 prefix
= Vline_prefix
;
16376 if (! NILP (prefix
))
16377 push_display_prop (it
, prefix
);
16382 /* Construct the glyph row IT->glyph_row in the desired matrix of
16383 IT->w from text at the current position of IT. See dispextern.h
16384 for an overview of struct it. Value is non-zero if
16385 IT->glyph_row displays text, as opposed to a line displaying ZV
16392 struct glyph_row
*row
= it
->glyph_row
;
16393 Lisp_Object overlay_arrow_string
;
16395 int may_wrap
= 0, wrap_x
;
16396 int wrap_row_used
= -1, wrap_row_ascent
, wrap_row_height
;
16397 int wrap_row_phys_ascent
, wrap_row_phys_height
;
16398 int wrap_row_extra_line_spacing
;
16400 /* We always start displaying at hpos zero even if hscrolled. */
16401 xassert (it
->hpos
== 0 && it
->current_x
== 0);
16403 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
16404 >= it
->w
->desired_matrix
->nrows
)
16406 it
->w
->nrows_scale_factor
++;
16407 fonts_changed_p
= 1;
16411 /* Is IT->w showing the region? */
16412 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
16414 /* Clear the result glyph row and enable it. */
16415 prepare_desired_row (row
);
16417 row
->y
= it
->current_y
;
16418 row
->start
= it
->start
;
16419 row
->continuation_lines_width
= it
->continuation_lines_width
;
16420 row
->displays_text_p
= 1;
16421 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
16422 it
->starts_in_middle_of_char_p
= 0;
16424 /* Arrange the overlays nicely for our purposes. Usually, we call
16425 display_line on only one line at a time, in which case this
16426 can't really hurt too much, or we call it on lines which appear
16427 one after another in the buffer, in which case all calls to
16428 recenter_overlay_lists but the first will be pretty cheap. */
16429 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
16431 /* Move over display elements that are not visible because we are
16432 hscrolled. This may stop at an x-position < IT->first_visible_x
16433 if the first glyph is partially visible or if we hit a line end. */
16434 if (it
->current_x
< it
->first_visible_x
)
16436 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
16437 MOVE_TO_POS
| MOVE_TO_X
);
16441 /* We only do this when not calling `move_it_in_display_line_to'
16442 above, because move_it_in_display_line_to calls
16443 handle_line_prefix itself. */
16444 handle_line_prefix (it
);
16447 /* Get the initial row height. This is either the height of the
16448 text hscrolled, if there is any, or zero. */
16449 row
->ascent
= it
->max_ascent
;
16450 row
->height
= it
->max_ascent
+ it
->max_descent
;
16451 row
->phys_ascent
= it
->max_phys_ascent
;
16452 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16453 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16455 /* Loop generating characters. The loop is left with IT on the next
16456 character to display. */
16459 int n_glyphs_before
, hpos_before
, x_before
;
16461 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
16463 /* Retrieve the next thing to display. Value is zero if end of
16465 if (!get_next_display_element (it
))
16467 /* Maybe add a space at the end of this line that is used to
16468 display the cursor there under X. Set the charpos of the
16469 first glyph of blank lines not corresponding to any text
16471 #ifdef HAVE_WINDOW_SYSTEM
16472 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16473 row
->exact_window_width_line_p
= 1;
16475 #endif /* HAVE_WINDOW_SYSTEM */
16476 if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
16477 || row
->used
[TEXT_AREA
] == 0)
16479 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
16480 row
->displays_text_p
= 0;
16482 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
16483 && (!MINI_WINDOW_P (it
->w
)
16484 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
16485 row
->indicate_empty_line_p
= 1;
16488 it
->continuation_lines_width
= 0;
16489 row
->ends_at_zv_p
= 1;
16493 /* Now, get the metrics of what we want to display. This also
16494 generates glyphs in `row' (which is IT->glyph_row). */
16495 n_glyphs_before
= row
->used
[TEXT_AREA
];
16498 /* Remember the line height so far in case the next element doesn't
16499 fit on the line. */
16500 if (it
->line_wrap
!= TRUNCATE
)
16502 ascent
= it
->max_ascent
;
16503 descent
= it
->max_descent
;
16504 phys_ascent
= it
->max_phys_ascent
;
16505 phys_descent
= it
->max_phys_descent
;
16507 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
16509 if (it
->what
== IT_CHARACTER
16510 && (it
->c
== ' ' || it
->c
== '\t'))
16516 wrap_row_used
= row
->used
[TEXT_AREA
];
16517 wrap_row_ascent
= row
->ascent
;
16518 wrap_row_height
= row
->height
;
16519 wrap_row_phys_ascent
= row
->phys_ascent
;
16520 wrap_row_phys_height
= row
->phys_height
;
16521 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
16527 PRODUCE_GLYPHS (it
);
16529 /* If this display element was in marginal areas, continue with
16531 if (it
->area
!= TEXT_AREA
)
16533 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16534 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16535 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16536 row
->phys_height
= max (row
->phys_height
,
16537 it
->max_phys_ascent
+ it
->max_phys_descent
);
16538 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16539 it
->max_extra_line_spacing
);
16540 set_iterator_to_next (it
, 1);
16544 /* Does the display element fit on the line? If we truncate
16545 lines, we should draw past the right edge of the window. If
16546 we don't truncate, we want to stop so that we can display the
16547 continuation glyph before the right margin. If lines are
16548 continued, there are two possible strategies for characters
16549 resulting in more than 1 glyph (e.g. tabs): Display as many
16550 glyphs as possible in this line and leave the rest for the
16551 continuation line, or display the whole element in the next
16552 line. Original redisplay did the former, so we do it also. */
16553 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
16554 hpos_before
= it
->hpos
;
16557 if (/* Not a newline. */
16559 /* Glyphs produced fit entirely in the line. */
16560 && it
->current_x
< it
->last_visible_x
)
16562 it
->hpos
+= nglyphs
;
16563 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16564 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16565 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16566 row
->phys_height
= max (row
->phys_height
,
16567 it
->max_phys_ascent
+ it
->max_phys_descent
);
16568 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16569 it
->max_extra_line_spacing
);
16570 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
16571 row
->x
= x
- it
->first_visible_x
;
16576 struct glyph
*glyph
;
16578 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
16580 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
16581 new_x
= x
+ glyph
->pixel_width
;
16583 if (/* Lines are continued. */
16584 it
->line_wrap
!= TRUNCATE
16585 && (/* Glyph doesn't fit on the line. */
16586 new_x
> it
->last_visible_x
16587 /* Or it fits exactly on a window system frame. */
16588 || (new_x
== it
->last_visible_x
16589 && FRAME_WINDOW_P (it
->f
))))
16591 /* End of a continued line. */
16594 || (new_x
== it
->last_visible_x
16595 && FRAME_WINDOW_P (it
->f
)))
16597 /* Current glyph is the only one on the line or
16598 fits exactly on the line. We must continue
16599 the line because we can't draw the cursor
16600 after the glyph. */
16601 row
->continued_p
= 1;
16602 it
->current_x
= new_x
;
16603 it
->continuation_lines_width
+= new_x
;
16605 if (i
== nglyphs
- 1)
16607 set_iterator_to_next (it
, 1);
16608 #ifdef HAVE_WINDOW_SYSTEM
16609 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16611 if (!get_next_display_element (it
))
16613 row
->exact_window_width_line_p
= 1;
16614 it
->continuation_lines_width
= 0;
16615 row
->continued_p
= 0;
16616 row
->ends_at_zv_p
= 1;
16618 else if (ITERATOR_AT_END_OF_LINE_P (it
))
16620 row
->continued_p
= 0;
16621 row
->exact_window_width_line_p
= 1;
16624 #endif /* HAVE_WINDOW_SYSTEM */
16625 if (wrap_row_used
> 0)
16629 else if (CHAR_GLYPH_PADDING_P (*glyph
)
16630 && !FRAME_WINDOW_P (it
->f
))
16632 /* A padding glyph that doesn't fit on this line.
16633 This means the whole character doesn't fit
16635 row
->used
[TEXT_AREA
] = n_glyphs_before
;
16637 /* Fill the rest of the row with continuation
16638 glyphs like in 20.x. */
16639 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
16640 < row
->glyphs
[1 + TEXT_AREA
])
16641 produce_special_glyphs (it
, IT_CONTINUATION
);
16643 row
->continued_p
= 1;
16644 it
->current_x
= x_before
;
16645 it
->continuation_lines_width
+= x_before
;
16647 /* Restore the height to what it was before the
16648 element not fitting on the line. */
16649 it
->max_ascent
= ascent
;
16650 it
->max_descent
= descent
;
16651 it
->max_phys_ascent
= phys_ascent
;
16652 it
->max_phys_descent
= phys_descent
;
16654 else if (wrap_row_used
> 0)
16658 it
->continuation_lines_width
+= wrap_x
;
16659 row
->used
[TEXT_AREA
] = wrap_row_used
;
16660 row
->ascent
= wrap_row_ascent
;
16661 row
->height
= wrap_row_height
;
16662 row
->phys_ascent
= wrap_row_phys_ascent
;
16663 row
->phys_height
= wrap_row_phys_height
;
16664 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
16665 row
->continued_p
= 1;
16666 row
->ends_at_zv_p
= 0;
16667 row
->exact_window_width_line_p
= 0;
16668 it
->continuation_lines_width
+= x
;
16670 /* Make sure that a non-default face is extended
16671 up to the right margin of the window. */
16672 extend_face_to_end_of_line (it
);
16674 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
16676 /* A TAB that extends past the right edge of the
16677 window. This produces a single glyph on
16678 window system frames. We leave the glyph in
16679 this row and let it fill the row, but don't
16680 consume the TAB. */
16681 it
->continuation_lines_width
+= it
->last_visible_x
;
16682 row
->ends_in_middle_of_char_p
= 1;
16683 row
->continued_p
= 1;
16684 glyph
->pixel_width
= it
->last_visible_x
- x
;
16685 it
->starts_in_middle_of_char_p
= 1;
16689 /* Something other than a TAB that draws past
16690 the right edge of the window. Restore
16691 positions to values before the element. */
16692 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
16694 /* Display continuation glyphs. */
16695 if (!FRAME_WINDOW_P (it
->f
))
16696 produce_special_glyphs (it
, IT_CONTINUATION
);
16697 row
->continued_p
= 1;
16699 it
->current_x
= x_before
;
16700 it
->continuation_lines_width
+= x
;
16701 extend_face_to_end_of_line (it
);
16703 if (nglyphs
> 1 && i
> 0)
16705 row
->ends_in_middle_of_char_p
= 1;
16706 it
->starts_in_middle_of_char_p
= 1;
16709 /* Restore the height to what it was before the
16710 element not fitting on the line. */
16711 it
->max_ascent
= ascent
;
16712 it
->max_descent
= descent
;
16713 it
->max_phys_ascent
= phys_ascent
;
16714 it
->max_phys_descent
= phys_descent
;
16719 else if (new_x
> it
->first_visible_x
)
16721 /* Increment number of glyphs actually displayed. */
16724 if (x
< it
->first_visible_x
)
16725 /* Glyph is partially visible, i.e. row starts at
16726 negative X position. */
16727 row
->x
= x
- it
->first_visible_x
;
16731 /* Glyph is completely off the left margin of the
16732 window. This should not happen because of the
16733 move_it_in_display_line at the start of this
16734 function, unless the text display area of the
16735 window is empty. */
16736 xassert (it
->first_visible_x
<= it
->last_visible_x
);
16740 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16741 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16742 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16743 row
->phys_height
= max (row
->phys_height
,
16744 it
->max_phys_ascent
+ it
->max_phys_descent
);
16745 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16746 it
->max_extra_line_spacing
);
16748 /* End of this display line if row is continued. */
16749 if (row
->continued_p
|| row
->ends_at_zv_p
)
16754 /* Is this a line end? If yes, we're also done, after making
16755 sure that a non-default face is extended up to the right
16756 margin of the window. */
16757 if (ITERATOR_AT_END_OF_LINE_P (it
))
16759 int used_before
= row
->used
[TEXT_AREA
];
16761 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
16763 #ifdef HAVE_WINDOW_SYSTEM
16764 /* Add a space at the end of the line that is used to
16765 display the cursor there. */
16766 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16767 append_space_for_newline (it
, 0);
16768 #endif /* HAVE_WINDOW_SYSTEM */
16770 /* Extend the face to the end of the line. */
16771 extend_face_to_end_of_line (it
);
16773 /* Make sure we have the position. */
16774 if (used_before
== 0)
16775 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
16777 /* Consume the line end. This skips over invisible lines. */
16778 set_iterator_to_next (it
, 1);
16779 it
->continuation_lines_width
= 0;
16783 /* Proceed with next display element. Note that this skips
16784 over lines invisible because of selective display. */
16785 set_iterator_to_next (it
, 1);
16787 /* If we truncate lines, we are done when the last displayed
16788 glyphs reach past the right margin of the window. */
16789 if (it
->line_wrap
== TRUNCATE
16790 && (FRAME_WINDOW_P (it
->f
)
16791 ? (it
->current_x
>= it
->last_visible_x
)
16792 : (it
->current_x
> it
->last_visible_x
)))
16794 /* Maybe add truncation glyphs. */
16795 if (!FRAME_WINDOW_P (it
->f
))
16799 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
16800 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
16803 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
16805 row
->used
[TEXT_AREA
] = i
;
16806 produce_special_glyphs (it
, IT_TRUNCATION
);
16809 #ifdef HAVE_WINDOW_SYSTEM
16812 /* Don't truncate if we can overflow newline into fringe. */
16813 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16815 if (!get_next_display_element (it
))
16817 it
->continuation_lines_width
= 0;
16818 row
->ends_at_zv_p
= 1;
16819 row
->exact_window_width_line_p
= 1;
16822 if (ITERATOR_AT_END_OF_LINE_P (it
))
16824 row
->exact_window_width_line_p
= 1;
16825 goto at_end_of_line
;
16829 #endif /* HAVE_WINDOW_SYSTEM */
16831 row
->truncated_on_right_p
= 1;
16832 it
->continuation_lines_width
= 0;
16833 reseat_at_next_visible_line_start (it
, 0);
16834 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
16835 it
->hpos
= hpos_before
;
16836 it
->current_x
= x_before
;
16841 /* If line is not empty and hscrolled, maybe insert truncation glyphs
16842 at the left window margin. */
16843 if (it
->first_visible_x
16844 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
16846 if (!FRAME_WINDOW_P (it
->f
))
16847 insert_left_trunc_glyphs (it
);
16848 row
->truncated_on_left_p
= 1;
16851 /* If the start of this line is the overlay arrow-position, then
16852 mark this glyph row as the one containing the overlay arrow.
16853 This is clearly a mess with variable size fonts. It would be
16854 better to let it be displayed like cursors under X. */
16855 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
16856 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
16857 !NILP (overlay_arrow_string
)))
16859 /* Overlay arrow in window redisplay is a fringe bitmap. */
16860 if (STRINGP (overlay_arrow_string
))
16862 struct glyph_row
*arrow_row
16863 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
16864 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
16865 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
16866 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
16867 struct glyph
*p2
, *end
;
16869 /* Copy the arrow glyphs. */
16870 while (glyph
< arrow_end
)
16873 /* Throw away padding glyphs. */
16875 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16876 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
16882 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
16887 xassert (INTEGERP (overlay_arrow_string
));
16888 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
16890 overlay_arrow_seen
= 1;
16893 /* Compute pixel dimensions of this line. */
16894 compute_line_metrics (it
);
16896 /* Remember the position at which this line ends. */
16897 row
->end
= it
->current
;
16899 /* Record whether this row ends inside an ellipsis. */
16900 row
->ends_in_ellipsis_p
16901 = (it
->method
== GET_FROM_DISPLAY_VECTOR
16902 && it
->ellipsis_p
);
16904 /* Save fringe bitmaps in this row. */
16905 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
16906 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
16907 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
16908 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
16910 it
->left_user_fringe_bitmap
= 0;
16911 it
->left_user_fringe_face_id
= 0;
16912 it
->right_user_fringe_bitmap
= 0;
16913 it
->right_user_fringe_face_id
= 0;
16915 /* Maybe set the cursor. */
16916 if (it
->w
->cursor
.vpos
< 0
16917 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
16918 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
16919 && cursor_row_p (it
->w
, row
))
16920 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
16922 /* Highlight trailing whitespace. */
16923 if (!NILP (Vshow_trailing_whitespace
))
16924 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
16926 /* Prepare for the next line. This line starts horizontally at (X
16927 HPOS) = (0 0). Vertical positions are incremented. As a
16928 convenience for the caller, IT->glyph_row is set to the next
16930 it
->current_x
= it
->hpos
= 0;
16931 it
->current_y
+= row
->height
;
16934 it
->start
= it
->current
;
16935 return row
->displays_text_p
;
16940 /***********************************************************************
16942 ***********************************************************************/
16944 /* Redisplay the menu bar in the frame for window W.
16946 The menu bar of X frames that don't have X toolkit support is
16947 displayed in a special window W->frame->menu_bar_window.
16949 The menu bar of terminal frames is treated specially as far as
16950 glyph matrices are concerned. Menu bar lines are not part of
16951 windows, so the update is done directly on the frame matrix rows
16952 for the menu bar. */
16955 display_menu_bar (w
)
16958 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16963 /* Don't do all this for graphical frames. */
16965 if (FRAME_W32_P (f
))
16968 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
16973 if (FRAME_MAC_P (f
))
16977 #ifdef USE_X_TOOLKIT
16978 xassert (!FRAME_WINDOW_P (f
));
16979 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
16980 it
.first_visible_x
= 0;
16981 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
16982 #else /* not USE_X_TOOLKIT */
16983 if (FRAME_WINDOW_P (f
))
16985 /* Menu bar lines are displayed in the desired matrix of the
16986 dummy window menu_bar_window. */
16987 struct window
*menu_w
;
16988 xassert (WINDOWP (f
->menu_bar_window
));
16989 menu_w
= XWINDOW (f
->menu_bar_window
);
16990 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
16992 it
.first_visible_x
= 0;
16993 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
16997 /* This is a TTY frame, i.e. character hpos/vpos are used as
16999 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
17001 it
.first_visible_x
= 0;
17002 it
.last_visible_x
= FRAME_COLS (f
);
17004 #endif /* not USE_X_TOOLKIT */
17006 if (! mode_line_inverse_video
)
17007 /* Force the menu-bar to be displayed in the default face. */
17008 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
17010 /* Clear all rows of the menu bar. */
17011 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
17013 struct glyph_row
*row
= it
.glyph_row
+ i
;
17014 clear_glyph_row (row
);
17015 row
->enabled_p
= 1;
17016 row
->full_width_p
= 1;
17019 /* Display all items of the menu bar. */
17020 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
17021 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
17023 Lisp_Object string
;
17025 /* Stop at nil string. */
17026 string
= AREF (items
, i
+ 1);
17030 /* Remember where item was displayed. */
17031 ASET (items
, i
+ 3, make_number (it
.hpos
));
17033 /* Display the item, pad with one space. */
17034 if (it
.current_x
< it
.last_visible_x
)
17035 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
17036 SCHARS (string
) + 1, 0, 0, -1);
17039 /* Fill out the line with spaces. */
17040 if (it
.current_x
< it
.last_visible_x
)
17041 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
17043 /* Compute the total height of the lines. */
17044 compute_line_metrics (&it
);
17049 /***********************************************************************
17051 ***********************************************************************/
17053 /* Redisplay mode lines in the window tree whose root is WINDOW. If
17054 FORCE is non-zero, redisplay mode lines unconditionally.
17055 Otherwise, redisplay only mode lines that are garbaged. Value is
17056 the number of windows whose mode lines were redisplayed. */
17059 redisplay_mode_lines (window
, force
)
17060 Lisp_Object window
;
17065 while (!NILP (window
))
17067 struct window
*w
= XWINDOW (window
);
17069 if (WINDOWP (w
->hchild
))
17070 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
17071 else if (WINDOWP (w
->vchild
))
17072 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
17074 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
17075 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
17077 struct text_pos lpoint
;
17078 struct buffer
*old
= current_buffer
;
17080 /* Set the window's buffer for the mode line display. */
17081 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
17082 set_buffer_internal_1 (XBUFFER (w
->buffer
));
17084 /* Point refers normally to the selected window. For any
17085 other window, set up appropriate value. */
17086 if (!EQ (window
, selected_window
))
17088 struct text_pos pt
;
17090 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
17091 if (CHARPOS (pt
) < BEGV
)
17092 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
17093 else if (CHARPOS (pt
) > (ZV
- 1))
17094 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
17096 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
17099 /* Display mode lines. */
17100 clear_glyph_matrix (w
->desired_matrix
);
17101 if (display_mode_lines (w
))
17104 w
->must_be_updated_p
= 1;
17107 /* Restore old settings. */
17108 set_buffer_internal_1 (old
);
17109 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
17119 /* Display the mode and/or top line of window W. Value is the number
17120 of mode lines displayed. */
17123 display_mode_lines (w
)
17126 Lisp_Object old_selected_window
, old_selected_frame
;
17129 old_selected_frame
= selected_frame
;
17130 selected_frame
= w
->frame
;
17131 old_selected_window
= selected_window
;
17132 XSETWINDOW (selected_window
, w
);
17134 /* These will be set while the mode line specs are processed. */
17135 line_number_displayed
= 0;
17136 w
->column_number_displayed
= Qnil
;
17138 if (WINDOW_WANTS_MODELINE_P (w
))
17140 struct window
*sel_w
= XWINDOW (old_selected_window
);
17142 /* Select mode line face based on the real selected window. */
17143 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
17144 current_buffer
->mode_line_format
);
17148 if (WINDOW_WANTS_HEADER_LINE_P (w
))
17150 display_mode_line (w
, HEADER_LINE_FACE_ID
,
17151 current_buffer
->header_line_format
);
17155 selected_frame
= old_selected_frame
;
17156 selected_window
= old_selected_window
;
17161 /* Display mode or top line of window W. FACE_ID specifies which line
17162 to display; it is either MODE_LINE_FACE_ID or HEADER_LINE_FACE_ID.
17163 FORMAT is the mode line format to display. Value is the pixel
17164 height of the mode line displayed. */
17167 display_mode_line (w
, face_id
, format
)
17169 enum face_id face_id
;
17170 Lisp_Object format
;
17174 int count
= SPECPDL_INDEX ();
17176 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
17177 /* Don't extend on a previously drawn mode-line.
17178 This may happen if called from pos_visible_p. */
17179 it
.glyph_row
->enabled_p
= 0;
17180 prepare_desired_row (it
.glyph_row
);
17182 it
.glyph_row
->mode_line_p
= 1;
17184 if (! mode_line_inverse_video
)
17185 /* Force the mode-line to be displayed in the default face. */
17186 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
17188 record_unwind_protect (unwind_format_mode_line
,
17189 format_mode_line_unwind_data (NULL
, Qnil
, 0));
17191 mode_line_target
= MODE_LINE_DISPLAY
;
17193 /* Temporarily make frame's keyboard the current kboard so that
17194 kboard-local variables in the mode_line_format will get the right
17196 push_kboard (FRAME_KBOARD (it
.f
));
17197 record_unwind_save_match_data ();
17198 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
17201 unbind_to (count
, Qnil
);
17203 /* Fill up with spaces. */
17204 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
17206 compute_line_metrics (&it
);
17207 it
.glyph_row
->full_width_p
= 1;
17208 it
.glyph_row
->continued_p
= 0;
17209 it
.glyph_row
->truncated_on_left_p
= 0;
17210 it
.glyph_row
->truncated_on_right_p
= 0;
17212 /* Make a 3D mode-line have a shadow at its right end. */
17213 face
= FACE_FROM_ID (it
.f
, face_id
);
17214 extend_face_to_end_of_line (&it
);
17215 if (face
->box
!= FACE_NO_BOX
)
17217 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
17218 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
17219 last
->right_box_line_p
= 1;
17222 return it
.glyph_row
->height
;
17225 /* Move element ELT in LIST to the front of LIST.
17226 Return the updated list. */
17229 move_elt_to_front (elt
, list
)
17230 Lisp_Object elt
, list
;
17232 register Lisp_Object tail
, prev
;
17233 register Lisp_Object tem
;
17237 while (CONSP (tail
))
17243 /* Splice out the link TAIL. */
17245 list
= XCDR (tail
);
17247 Fsetcdr (prev
, XCDR (tail
));
17249 /* Now make it the first. */
17250 Fsetcdr (tail
, list
);
17255 tail
= XCDR (tail
);
17259 /* Not found--return unchanged LIST. */
17263 /* Contribute ELT to the mode line for window IT->w. How it
17264 translates into text depends on its data type.
17266 IT describes the display environment in which we display, as usual.
17268 DEPTH is the depth in recursion. It is used to prevent
17269 infinite recursion here.
17271 FIELD_WIDTH is the number of characters the display of ELT should
17272 occupy in the mode line, and PRECISION is the maximum number of
17273 characters to display from ELT's representation. See
17274 display_string for details.
17276 Returns the hpos of the end of the text generated by ELT.
17278 PROPS is a property list to add to any string we encounter.
17280 If RISKY is nonzero, remove (disregard) any properties in any string
17281 we encounter, and ignore :eval and :propertize.
17283 The global variable `mode_line_target' determines whether the
17284 output is passed to `store_mode_line_noprop',
17285 `store_mode_line_string', or `display_string'. */
17288 display_mode_element (it
, depth
, field_width
, precision
, elt
, props
, risky
)
17291 int field_width
, precision
;
17292 Lisp_Object elt
, props
;
17295 int n
= 0, field
, prec
;
17300 elt
= build_string ("*too-deep*");
17304 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
17308 /* A string: output it and check for %-constructs within it. */
17312 if (SCHARS (elt
) > 0
17313 && (!NILP (props
) || risky
))
17315 Lisp_Object oprops
, aelt
;
17316 oprops
= Ftext_properties_at (make_number (0), elt
);
17318 /* If the starting string's properties are not what
17319 we want, translate the string. Also, if the string
17320 is risky, do that anyway. */
17322 if (NILP (Fequal (props
, oprops
)) || risky
)
17324 /* If the starting string has properties,
17325 merge the specified ones onto the existing ones. */
17326 if (! NILP (oprops
) && !risky
)
17330 oprops
= Fcopy_sequence (oprops
);
17332 while (CONSP (tem
))
17334 oprops
= Fplist_put (oprops
, XCAR (tem
),
17335 XCAR (XCDR (tem
)));
17336 tem
= XCDR (XCDR (tem
));
17341 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
17342 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
17344 /* AELT is what we want. Move it to the front
17345 without consing. */
17347 mode_line_proptrans_alist
17348 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
17354 /* If AELT has the wrong props, it is useless.
17355 so get rid of it. */
17357 mode_line_proptrans_alist
17358 = Fdelq (aelt
, mode_line_proptrans_alist
);
17360 elt
= Fcopy_sequence (elt
);
17361 Fset_text_properties (make_number (0), Flength (elt
),
17363 /* Add this item to mode_line_proptrans_alist. */
17364 mode_line_proptrans_alist
17365 = Fcons (Fcons (elt
, props
),
17366 mode_line_proptrans_alist
);
17367 /* Truncate mode_line_proptrans_alist
17368 to at most 50 elements. */
17369 tem
= Fnthcdr (make_number (50),
17370 mode_line_proptrans_alist
);
17372 XSETCDR (tem
, Qnil
);
17381 prec
= precision
- n
;
17382 switch (mode_line_target
)
17384 case MODE_LINE_NOPROP
:
17385 case MODE_LINE_TITLE
:
17386 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
17388 case MODE_LINE_STRING
:
17389 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
17391 case MODE_LINE_DISPLAY
:
17392 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
17393 0, prec
, 0, STRING_MULTIBYTE (elt
));
17400 /* Handle the non-literal case. */
17402 while ((precision
<= 0 || n
< precision
)
17403 && SREF (elt
, offset
) != 0
17404 && (mode_line_target
!= MODE_LINE_DISPLAY
17405 || it
->current_x
< it
->last_visible_x
))
17407 int last_offset
= offset
;
17409 /* Advance to end of string or next format specifier. */
17410 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
17413 if (offset
- 1 != last_offset
)
17415 int nchars
, nbytes
;
17417 /* Output to end of string or up to '%'. Field width
17418 is length of string. Don't output more than
17419 PRECISION allows us. */
17422 prec
= c_string_width (SDATA (elt
) + last_offset
,
17423 offset
- last_offset
, precision
- n
,
17426 switch (mode_line_target
)
17428 case MODE_LINE_NOPROP
:
17429 case MODE_LINE_TITLE
:
17430 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
17432 case MODE_LINE_STRING
:
17434 int bytepos
= last_offset
;
17435 int charpos
= string_byte_to_char (elt
, bytepos
);
17436 int endpos
= (precision
<= 0
17437 ? string_byte_to_char (elt
, offset
)
17438 : charpos
+ nchars
);
17440 n
+= store_mode_line_string (NULL
,
17441 Fsubstring (elt
, make_number (charpos
),
17442 make_number (endpos
)),
17446 case MODE_LINE_DISPLAY
:
17448 int bytepos
= last_offset
;
17449 int charpos
= string_byte_to_char (elt
, bytepos
);
17451 if (precision
<= 0)
17452 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
17453 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
17455 STRING_MULTIBYTE (elt
));
17460 else /* c == '%' */
17462 int percent_position
= offset
;
17464 /* Get the specified minimum width. Zero means
17467 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
17468 field
= field
* 10 + c
- '0';
17470 /* Don't pad beyond the total padding allowed. */
17471 if (field_width
- n
> 0 && field
> field_width
- n
)
17472 field
= field_width
- n
;
17474 /* Note that either PRECISION <= 0 or N < PRECISION. */
17475 prec
= precision
- n
;
17478 n
+= display_mode_element (it
, depth
, field
, prec
,
17479 Vglobal_mode_string
, props
,
17484 int bytepos
, charpos
;
17485 unsigned char *spec
;
17487 bytepos
= percent_position
;
17488 charpos
= (STRING_MULTIBYTE (elt
)
17489 ? string_byte_to_char (elt
, bytepos
)
17492 = decode_mode_spec (it
->w
, c
, field
, prec
, &multibyte
);
17494 switch (mode_line_target
)
17496 case MODE_LINE_NOPROP
:
17497 case MODE_LINE_TITLE
:
17498 n
+= store_mode_line_noprop (spec
, field
, prec
);
17500 case MODE_LINE_STRING
:
17502 int len
= strlen (spec
);
17503 Lisp_Object tem
= make_string (spec
, len
);
17504 props
= Ftext_properties_at (make_number (charpos
), elt
);
17505 /* Should only keep face property in props */
17506 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
17509 case MODE_LINE_DISPLAY
:
17511 int nglyphs_before
, nwritten
;
17513 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
17514 nwritten
= display_string (spec
, Qnil
, elt
,
17519 /* Assign to the glyphs written above the
17520 string where the `%x' came from, position
17524 struct glyph
*glyph
17525 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
17529 for (i
= 0; i
< nwritten
; ++i
)
17531 glyph
[i
].object
= elt
;
17532 glyph
[i
].charpos
= charpos
;
17549 /* A symbol: process the value of the symbol recursively
17550 as if it appeared here directly. Avoid error if symbol void.
17551 Special case: if value of symbol is a string, output the string
17554 register Lisp_Object tem
;
17556 /* If the variable is not marked as risky to set
17557 then its contents are risky to use. */
17558 if (NILP (Fget (elt
, Qrisky_local_variable
)))
17561 tem
= Fboundp (elt
);
17564 tem
= Fsymbol_value (elt
);
17565 /* If value is a string, output that string literally:
17566 don't check for % within it. */
17570 if (!EQ (tem
, elt
))
17572 /* Give up right away for nil or t. */
17582 register Lisp_Object car
, tem
;
17584 /* A cons cell: five distinct cases.
17585 If first element is :eval or :propertize, do something special.
17586 If first element is a string or a cons, process all the elements
17587 and effectively concatenate them.
17588 If first element is a negative number, truncate displaying cdr to
17589 at most that many characters. If positive, pad (with spaces)
17590 to at least that many characters.
17591 If first element is a symbol, process the cadr or caddr recursively
17592 according to whether the symbol's value is non-nil or nil. */
17594 if (EQ (car
, QCeval
))
17596 /* An element of the form (:eval FORM) means evaluate FORM
17597 and use the result as mode line elements. */
17602 if (CONSP (XCDR (elt
)))
17605 spec
= safe_eval (XCAR (XCDR (elt
)));
17606 n
+= display_mode_element (it
, depth
, field_width
- n
,
17607 precision
- n
, spec
, props
,
17611 else if (EQ (car
, QCpropertize
))
17613 /* An element of the form (:propertize ELT PROPS...)
17614 means display ELT but applying properties PROPS. */
17619 if (CONSP (XCDR (elt
)))
17620 n
+= display_mode_element (it
, depth
, field_width
- n
,
17621 precision
- n
, XCAR (XCDR (elt
)),
17622 XCDR (XCDR (elt
)), risky
);
17624 else if (SYMBOLP (car
))
17626 tem
= Fboundp (car
);
17630 /* elt is now the cdr, and we know it is a cons cell.
17631 Use its car if CAR has a non-nil value. */
17634 tem
= Fsymbol_value (car
);
17641 /* Symbol's value is nil (or symbol is unbound)
17642 Get the cddr of the original list
17643 and if possible find the caddr and use that. */
17647 else if (!CONSP (elt
))
17652 else if (INTEGERP (car
))
17654 register int lim
= XINT (car
);
17658 /* Negative int means reduce maximum width. */
17659 if (precision
<= 0)
17662 precision
= min (precision
, -lim
);
17666 /* Padding specified. Don't let it be more than
17667 current maximum. */
17669 lim
= min (precision
, lim
);
17671 /* If that's more padding than already wanted, queue it.
17672 But don't reduce padding already specified even if
17673 that is beyond the current truncation point. */
17674 field_width
= max (lim
, field_width
);
17678 else if (STRINGP (car
) || CONSP (car
))
17680 register int limit
= 50;
17681 /* Limit is to protect against circular lists. */
17684 && (precision
<= 0 || n
< precision
))
17686 n
+= display_mode_element (it
, depth
,
17687 /* Do padding only after the last
17688 element in the list. */
17689 (! CONSP (XCDR (elt
))
17692 precision
- n
, XCAR (elt
),
17702 elt
= build_string ("*invalid*");
17706 /* Pad to FIELD_WIDTH. */
17707 if (field_width
> 0 && n
< field_width
)
17709 switch (mode_line_target
)
17711 case MODE_LINE_NOPROP
:
17712 case MODE_LINE_TITLE
:
17713 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
17715 case MODE_LINE_STRING
:
17716 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
17718 case MODE_LINE_DISPLAY
:
17719 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
17728 /* Store a mode-line string element in mode_line_string_list.
17730 If STRING is non-null, display that C string. Otherwise, the Lisp
17731 string LISP_STRING is displayed.
17733 FIELD_WIDTH is the minimum number of output glyphs to produce.
17734 If STRING has fewer characters than FIELD_WIDTH, pad to the right
17735 with spaces. FIELD_WIDTH <= 0 means don't pad.
17737 PRECISION is the maximum number of characters to output from
17738 STRING. PRECISION <= 0 means don't truncate the string.
17740 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
17741 properties to the string.
17743 PROPS are the properties to add to the string.
17744 The mode_line_string_face face property is always added to the string.
17748 store_mode_line_string (string
, lisp_string
, copy_string
, field_width
, precision
, props
)
17750 Lisp_Object lisp_string
;
17759 if (string
!= NULL
)
17761 len
= strlen (string
);
17762 if (precision
> 0 && len
> precision
)
17764 lisp_string
= make_string (string
, len
);
17766 props
= mode_line_string_face_prop
;
17767 else if (!NILP (mode_line_string_face
))
17769 Lisp_Object face
= Fplist_get (props
, Qface
);
17770 props
= Fcopy_sequence (props
);
17772 face
= mode_line_string_face
;
17774 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17775 props
= Fplist_put (props
, Qface
, face
);
17777 Fadd_text_properties (make_number (0), make_number (len
),
17778 props
, lisp_string
);
17782 len
= XFASTINT (Flength (lisp_string
));
17783 if (precision
> 0 && len
> precision
)
17786 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
17789 if (!NILP (mode_line_string_face
))
17793 props
= Ftext_properties_at (make_number (0), lisp_string
);
17794 face
= Fplist_get (props
, Qface
);
17796 face
= mode_line_string_face
;
17798 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17799 props
= Fcons (Qface
, Fcons (face
, Qnil
));
17801 lisp_string
= Fcopy_sequence (lisp_string
);
17804 Fadd_text_properties (make_number (0), make_number (len
),
17805 props
, lisp_string
);
17810 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17814 if (field_width
> len
)
17816 field_width
-= len
;
17817 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
17819 Fadd_text_properties (make_number (0), make_number (field_width
),
17820 props
, lisp_string
);
17821 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17829 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
17831 doc
: /* Format a string out of a mode line format specification.
17832 First arg FORMAT specifies the mode line format (see `mode-line-format'
17833 for details) to use.
17835 Optional second arg FACE specifies the face property to put
17836 on all characters for which no face is specified.
17837 The value t means whatever face the window's mode line currently uses
17838 \(either `mode-line' or `mode-line-inactive', depending).
17839 A value of nil means the default is no face property.
17840 If FACE is an integer, the value string has no text properties.
17842 Optional third and fourth args WINDOW and BUFFER specify the window
17843 and buffer to use as the context for the formatting (defaults
17844 are the selected window and the window's buffer). */)
17845 (format
, face
, window
, buffer
)
17846 Lisp_Object format
, face
, window
, buffer
;
17851 struct buffer
*old_buffer
= NULL
;
17853 int no_props
= INTEGERP (face
);
17854 int count
= SPECPDL_INDEX ();
17856 int string_start
= 0;
17859 window
= selected_window
;
17860 CHECK_WINDOW (window
);
17861 w
= XWINDOW (window
);
17864 buffer
= w
->buffer
;
17865 CHECK_BUFFER (buffer
);
17867 /* Make formatting the modeline a non-op when noninteractive, otherwise
17868 there will be problems later caused by a partially initialized frame. */
17869 if (NILP (format
) || noninteractive
)
17870 return empty_unibyte_string
;
17878 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
17879 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0);
17883 face_id
= DEFAULT_FACE_ID
;
17885 if (XBUFFER (buffer
) != current_buffer
)
17886 old_buffer
= current_buffer
;
17888 /* Save things including mode_line_proptrans_alist,
17889 and set that to nil so that we don't alter the outer value. */
17890 record_unwind_protect (unwind_format_mode_line
,
17891 format_mode_line_unwind_data
17892 (old_buffer
, selected_window
, 1));
17893 mode_line_proptrans_alist
= Qnil
;
17895 Fselect_window (window
, Qt
);
17897 set_buffer_internal_1 (XBUFFER (buffer
));
17899 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
17903 mode_line_target
= MODE_LINE_NOPROP
;
17904 mode_line_string_face_prop
= Qnil
;
17905 mode_line_string_list
= Qnil
;
17906 string_start
= MODE_LINE_NOPROP_LEN (0);
17910 mode_line_target
= MODE_LINE_STRING
;
17911 mode_line_string_list
= Qnil
;
17912 mode_line_string_face
= face
;
17913 mode_line_string_face_prop
17914 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
17917 push_kboard (FRAME_KBOARD (it
.f
));
17918 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
17923 len
= MODE_LINE_NOPROP_LEN (string_start
);
17924 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
17928 mode_line_string_list
= Fnreverse (mode_line_string_list
);
17929 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
17930 empty_unibyte_string
);
17933 unbind_to (count
, Qnil
);
17937 /* Write a null-terminated, right justified decimal representation of
17938 the positive integer D to BUF using a minimal field width WIDTH. */
17941 pint2str (buf
, width
, d
)
17942 register char *buf
;
17943 register int width
;
17946 register char *p
= buf
;
17954 *p
++ = d
% 10 + '0';
17959 for (width
-= (int) (p
- buf
); width
> 0; --width
)
17970 /* Write a null-terminated, right justified decimal and "human
17971 readable" representation of the nonnegative integer D to BUF using
17972 a minimal field width WIDTH. D should be smaller than 999.5e24. */
17974 static const char power_letter
[] =
17988 pint2hrstr (buf
, width
, d
)
17993 /* We aim to represent the nonnegative integer D as
17994 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
17997 /* -1 means: do not use TENTHS. */
18001 /* Length of QUOTIENT.TENTHS as a string. */
18007 if (1000 <= quotient
)
18009 /* Scale to the appropriate EXPONENT. */
18012 remainder
= quotient
% 1000;
18016 while (1000 <= quotient
);
18018 /* Round to nearest and decide whether to use TENTHS or not. */
18021 tenths
= remainder
/ 100;
18022 if (50 <= remainder
% 100)
18029 if (quotient
== 10)
18037 if (500 <= remainder
)
18039 if (quotient
< 999)
18050 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
18051 if (tenths
== -1 && quotient
<= 99)
18058 p
= psuffix
= buf
+ max (width
, length
);
18060 /* Print EXPONENT. */
18062 *psuffix
++ = power_letter
[exponent
];
18065 /* Print TENTHS. */
18068 *--p
= '0' + tenths
;
18072 /* Print QUOTIENT. */
18075 int digit
= quotient
% 10;
18076 *--p
= '0' + digit
;
18078 while ((quotient
/= 10) != 0);
18080 /* Print leading spaces. */
18085 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
18086 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
18087 type of CODING_SYSTEM. Return updated pointer into BUF. */
18089 static unsigned char invalid_eol_type
[] = "(*invalid*)";
18092 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
18093 Lisp_Object coding_system
;
18094 register char *buf
;
18098 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
18099 const unsigned char *eol_str
;
18101 /* The EOL conversion we are using. */
18102 Lisp_Object eoltype
;
18104 val
= CODING_SYSTEM_SPEC (coding_system
);
18107 if (!VECTORP (val
)) /* Not yet decided. */
18112 eoltype
= eol_mnemonic_undecided
;
18113 /* Don't mention EOL conversion if it isn't decided. */
18118 Lisp_Object eolvalue
;
18120 attrs
= AREF (val
, 0);
18121 eolvalue
= AREF (val
, 2);
18124 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
18128 /* The EOL conversion that is normal on this system. */
18130 if (NILP (eolvalue
)) /* Not yet decided. */
18131 eoltype
= eol_mnemonic_undecided
;
18132 else if (VECTORP (eolvalue
)) /* Not yet decided. */
18133 eoltype
= eol_mnemonic_undecided
;
18134 else /* eolvalue is Qunix, Qdos, or Qmac. */
18135 eoltype
= (EQ (eolvalue
, Qunix
)
18136 ? eol_mnemonic_unix
18137 : (EQ (eolvalue
, Qdos
) == 1
18138 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
18144 /* Mention the EOL conversion if it is not the usual one. */
18145 if (STRINGP (eoltype
))
18147 eol_str
= SDATA (eoltype
);
18148 eol_str_len
= SBYTES (eoltype
);
18150 else if (CHARACTERP (eoltype
))
18152 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
18153 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
18158 eol_str
= invalid_eol_type
;
18159 eol_str_len
= sizeof (invalid_eol_type
) - 1;
18161 bcopy (eol_str
, buf
, eol_str_len
);
18162 buf
+= eol_str_len
;
18168 /* Return a string for the output of a mode line %-spec for window W,
18169 generated by character C. PRECISION >= 0 means don't return a
18170 string longer than that value. FIELD_WIDTH > 0 means pad the
18171 string returned with spaces to that value. Return 1 in *MULTIBYTE
18172 if the result is multibyte text.
18174 Note we operate on the current buffer for most purposes,
18175 the exception being w->base_line_pos. */
18177 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
18180 decode_mode_spec (w
, c
, field_width
, precision
, multibyte
)
18183 int field_width
, precision
;
18187 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18188 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
18189 struct buffer
*b
= current_buffer
;
18197 if (!NILP (b
->read_only
))
18199 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18204 /* This differs from %* only for a modified read-only buffer. */
18205 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18207 if (!NILP (b
->read_only
))
18212 /* This differs from %* in ignoring read-only-ness. */
18213 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18225 if (command_loop_level
> 5)
18227 p
= decode_mode_spec_buf
;
18228 for (i
= 0; i
< command_loop_level
; i
++)
18231 return decode_mode_spec_buf
;
18239 if (command_loop_level
> 5)
18241 p
= decode_mode_spec_buf
;
18242 for (i
= 0; i
< command_loop_level
; i
++)
18245 return decode_mode_spec_buf
;
18252 /* Let lots_of_dashes be a string of infinite length. */
18253 if (mode_line_target
== MODE_LINE_NOPROP
||
18254 mode_line_target
== MODE_LINE_STRING
)
18256 if (field_width
<= 0
18257 || field_width
> sizeof (lots_of_dashes
))
18259 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
18260 decode_mode_spec_buf
[i
] = '-';
18261 decode_mode_spec_buf
[i
] = '\0';
18262 return decode_mode_spec_buf
;
18265 return lots_of_dashes
;
18273 /* %c and %l are ignored in `frame-title-format'.
18274 (In redisplay_internal, the frame title is drawn _before_ the
18275 windows are updated, so the stuff which depends on actual
18276 window contents (such as %l) may fail to render properly, or
18277 even crash emacs.) */
18278 if (mode_line_target
== MODE_LINE_TITLE
)
18282 int col
= (int) current_column (); /* iftc */
18283 w
->column_number_displayed
= make_number (col
);
18284 pint2str (decode_mode_spec_buf
, field_width
, col
);
18285 return decode_mode_spec_buf
;
18289 #ifndef SYSTEM_MALLOC
18291 if (NILP (Vmemory_full
))
18294 return "!MEM FULL! ";
18301 /* %F displays the frame name. */
18302 if (!NILP (f
->title
))
18303 return (char *) SDATA (f
->title
);
18304 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
18305 return (char *) SDATA (f
->name
);
18314 int size
= ZV
- BEGV
;
18315 pint2str (decode_mode_spec_buf
, field_width
, size
);
18316 return decode_mode_spec_buf
;
18321 int size
= ZV
- BEGV
;
18322 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
18323 return decode_mode_spec_buf
;
18328 int startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
18329 int topline
, nlines
, junk
, height
;
18331 /* %c and %l are ignored in `frame-title-format'. */
18332 if (mode_line_target
== MODE_LINE_TITLE
)
18335 startpos
= XMARKER (w
->start
)->charpos
;
18336 startpos_byte
= marker_byte_position (w
->start
);
18337 height
= WINDOW_TOTAL_LINES (w
);
18339 /* If we decided that this buffer isn't suitable for line numbers,
18340 don't forget that too fast. */
18341 if (EQ (w
->base_line_pos
, w
->buffer
))
18343 /* But do forget it, if the window shows a different buffer now. */
18344 else if (BUFFERP (w
->base_line_pos
))
18345 w
->base_line_pos
= Qnil
;
18347 /* If the buffer is very big, don't waste time. */
18348 if (INTEGERP (Vline_number_display_limit
)
18349 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
18351 w
->base_line_pos
= Qnil
;
18352 w
->base_line_number
= Qnil
;
18356 if (INTEGERP (w
->base_line_number
)
18357 && INTEGERP (w
->base_line_pos
)
18358 && XFASTINT (w
->base_line_pos
) <= startpos
)
18360 line
= XFASTINT (w
->base_line_number
);
18361 linepos
= XFASTINT (w
->base_line_pos
);
18362 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
18367 linepos
= BUF_BEGV (b
);
18368 linepos_byte
= BUF_BEGV_BYTE (b
);
18371 /* Count lines from base line to window start position. */
18372 nlines
= display_count_lines (linepos
, linepos_byte
,
18376 topline
= nlines
+ line
;
18378 /* Determine a new base line, if the old one is too close
18379 or too far away, or if we did not have one.
18380 "Too close" means it's plausible a scroll-down would
18381 go back past it. */
18382 if (startpos
== BUF_BEGV (b
))
18384 w
->base_line_number
= make_number (topline
);
18385 w
->base_line_pos
= make_number (BUF_BEGV (b
));
18387 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
18388 || linepos
== BUF_BEGV (b
))
18390 int limit
= BUF_BEGV (b
);
18391 int limit_byte
= BUF_BEGV_BYTE (b
);
18393 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
18395 if (startpos
- distance
> limit
)
18397 limit
= startpos
- distance
;
18398 limit_byte
= CHAR_TO_BYTE (limit
);
18401 nlines
= display_count_lines (startpos
, startpos_byte
,
18403 - (height
* 2 + 30),
18405 /* If we couldn't find the lines we wanted within
18406 line_number_display_limit_width chars per line,
18407 give up on line numbers for this window. */
18408 if (position
== limit_byte
&& limit
== startpos
- distance
)
18410 w
->base_line_pos
= w
->buffer
;
18411 w
->base_line_number
= Qnil
;
18415 w
->base_line_number
= make_number (topline
- nlines
);
18416 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
18419 /* Now count lines from the start pos to point. */
18420 nlines
= display_count_lines (startpos
, startpos_byte
,
18421 PT_BYTE
, PT
, &junk
);
18423 /* Record that we did display the line number. */
18424 line_number_displayed
= 1;
18426 /* Make the string to show. */
18427 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
18428 return decode_mode_spec_buf
;
18431 char* p
= decode_mode_spec_buf
;
18432 int pad
= field_width
- 2;
18438 return decode_mode_spec_buf
;
18444 obj
= b
->mode_name
;
18448 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
18454 int pos
= marker_position (w
->start
);
18455 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
18457 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
18459 if (pos
<= BUF_BEGV (b
))
18464 else if (pos
<= BUF_BEGV (b
))
18468 if (total
> 1000000)
18469 /* Do it differently for a large value, to avoid overflow. */
18470 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
18472 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
18473 /* We can't normally display a 3-digit number,
18474 so get us a 2-digit number that is close. */
18477 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
18478 return decode_mode_spec_buf
;
18482 /* Display percentage of size above the bottom of the screen. */
18485 int toppos
= marker_position (w
->start
);
18486 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
18487 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
18489 if (botpos
>= BUF_ZV (b
))
18491 if (toppos
<= BUF_BEGV (b
))
18498 if (total
> 1000000)
18499 /* Do it differently for a large value, to avoid overflow. */
18500 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
18502 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
18503 /* We can't normally display a 3-digit number,
18504 so get us a 2-digit number that is close. */
18507 if (toppos
<= BUF_BEGV (b
))
18508 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
18510 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
18511 return decode_mode_spec_buf
;
18516 /* status of process */
18517 obj
= Fget_buffer_process (Fcurrent_buffer ());
18519 return "no process";
18520 #ifdef subprocesses
18521 obj
= Fsymbol_name (Fprocess_status (obj
));
18528 val
= call1 (intern ("file-remote-p"), current_buffer
->directory
);
18535 case 't': /* indicate TEXT or BINARY */
18536 #ifdef MODE_LINE_BINARY_TEXT
18537 return MODE_LINE_BINARY_TEXT (b
);
18543 /* coding-system (not including end-of-line format) */
18545 /* coding-system (including end-of-line type) */
18547 int eol_flag
= (c
== 'Z');
18548 char *p
= decode_mode_spec_buf
;
18550 if (! FRAME_WINDOW_P (f
))
18552 /* No need to mention EOL here--the terminal never needs
18553 to do EOL conversion. */
18554 p
= decode_mode_spec_coding (CODING_ID_NAME
18555 (FRAME_KEYBOARD_CODING (f
)->id
),
18557 p
= decode_mode_spec_coding (CODING_ID_NAME
18558 (FRAME_TERMINAL_CODING (f
)->id
),
18561 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
18564 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
18565 #ifdef subprocesses
18566 obj
= Fget_buffer_process (Fcurrent_buffer ());
18567 if (PROCESSP (obj
))
18569 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
18571 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
18574 #endif /* subprocesses */
18577 return decode_mode_spec_buf
;
18583 *multibyte
= STRING_MULTIBYTE (obj
);
18584 return (char *) SDATA (obj
);
18591 /* Count up to COUNT lines starting from START / START_BYTE.
18592 But don't go beyond LIMIT_BYTE.
18593 Return the number of lines thus found (always nonnegative).
18595 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
18598 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
18599 int start
, start_byte
, limit_byte
, count
;
18602 register unsigned char *cursor
;
18603 unsigned char *base
;
18605 register int ceiling
;
18606 register unsigned char *ceiling_addr
;
18607 int orig_count
= count
;
18609 /* If we are not in selective display mode,
18610 check only for newlines. */
18611 int selective_display
= (!NILP (current_buffer
->selective_display
)
18612 && !INTEGERP (current_buffer
->selective_display
));
18616 while (start_byte
< limit_byte
)
18618 ceiling
= BUFFER_CEILING_OF (start_byte
);
18619 ceiling
= min (limit_byte
- 1, ceiling
);
18620 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
18621 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
18624 if (selective_display
)
18625 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
18628 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
18631 if (cursor
!= ceiling_addr
)
18635 start_byte
+= cursor
- base
+ 1;
18636 *byte_pos_ptr
= start_byte
;
18640 if (++cursor
== ceiling_addr
)
18646 start_byte
+= cursor
- base
;
18651 while (start_byte
> limit_byte
)
18653 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
18654 ceiling
= max (limit_byte
, ceiling
);
18655 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
18656 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
18659 if (selective_display
)
18660 while (--cursor
!= ceiling_addr
18661 && *cursor
!= '\n' && *cursor
!= 015)
18664 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
18667 if (cursor
!= ceiling_addr
)
18671 start_byte
+= cursor
- base
+ 1;
18672 *byte_pos_ptr
= start_byte
;
18673 /* When scanning backwards, we should
18674 not count the newline posterior to which we stop. */
18675 return - orig_count
- 1;
18681 /* Here we add 1 to compensate for the last decrement
18682 of CURSOR, which took it past the valid range. */
18683 start_byte
+= cursor
- base
+ 1;
18687 *byte_pos_ptr
= limit_byte
;
18690 return - orig_count
+ count
;
18691 return orig_count
- count
;
18697 /***********************************************************************
18699 ***********************************************************************/
18701 /* Display a NUL-terminated string, starting with index START.
18703 If STRING is non-null, display that C string. Otherwise, the Lisp
18704 string LISP_STRING is displayed.
18706 If FACE_STRING is not nil, FACE_STRING_POS is a position in
18707 FACE_STRING. Display STRING or LISP_STRING with the face at
18708 FACE_STRING_POS in FACE_STRING:
18710 Display the string in the environment given by IT, but use the
18711 standard display table, temporarily.
18713 FIELD_WIDTH is the minimum number of output glyphs to produce.
18714 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18715 with spaces. If STRING has more characters, more than FIELD_WIDTH
18716 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
18718 PRECISION is the maximum number of characters to output from
18719 STRING. PRECISION < 0 means don't truncate the string.
18721 This is roughly equivalent to printf format specifiers:
18723 FIELD_WIDTH PRECISION PRINTF
18724 ----------------------------------------
18730 MULTIBYTE zero means do not display multibyte chars, > 0 means do
18731 display them, and < 0 means obey the current buffer's value of
18732 enable_multibyte_characters.
18734 Value is the number of columns displayed. */
18737 display_string (string
, lisp_string
, face_string
, face_string_pos
,
18738 start
, it
, field_width
, precision
, max_x
, multibyte
)
18739 unsigned char *string
;
18740 Lisp_Object lisp_string
;
18741 Lisp_Object face_string
;
18742 EMACS_INT face_string_pos
;
18745 int field_width
, precision
, max_x
;
18748 int hpos_at_start
= it
->hpos
;
18749 int saved_face_id
= it
->face_id
;
18750 struct glyph_row
*row
= it
->glyph_row
;
18752 /* Initialize the iterator IT for iteration over STRING beginning
18753 with index START. */
18754 reseat_to_string (it
, string
, lisp_string
, start
,
18755 precision
, field_width
, multibyte
);
18757 /* If displaying STRING, set up the face of the iterator
18758 from LISP_STRING, if that's given. */
18759 if (STRINGP (face_string
))
18765 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
18766 0, it
->region_beg_charpos
,
18767 it
->region_end_charpos
,
18768 &endptr
, it
->base_face_id
, 0);
18769 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18770 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
18773 /* Set max_x to the maximum allowed X position. Don't let it go
18774 beyond the right edge of the window. */
18776 max_x
= it
->last_visible_x
;
18778 max_x
= min (max_x
, it
->last_visible_x
);
18780 /* Skip over display elements that are not visible. because IT->w is
18782 if (it
->current_x
< it
->first_visible_x
)
18783 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
18784 MOVE_TO_POS
| MOVE_TO_X
);
18786 row
->ascent
= it
->max_ascent
;
18787 row
->height
= it
->max_ascent
+ it
->max_descent
;
18788 row
->phys_ascent
= it
->max_phys_ascent
;
18789 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18790 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18792 /* This condition is for the case that we are called with current_x
18793 past last_visible_x. */
18794 while (it
->current_x
< max_x
)
18796 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
18798 /* Get the next display element. */
18799 if (!get_next_display_element (it
))
18802 /* Produce glyphs. */
18803 x_before
= it
->current_x
;
18804 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18805 PRODUCE_GLYPHS (it
);
18807 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
18810 while (i
< nglyphs
)
18812 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18814 if (it
->line_wrap
!= TRUNCATE
18815 && x
+ glyph
->pixel_width
> max_x
)
18817 /* End of continued line or max_x reached. */
18818 if (CHAR_GLYPH_PADDING_P (*glyph
))
18820 /* A wide character is unbreakable. */
18821 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18822 it
->current_x
= x_before
;
18826 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
18831 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
18833 /* Glyph is at least partially visible. */
18835 if (x
< it
->first_visible_x
)
18836 it
->glyph_row
->x
= x
- it
->first_visible_x
;
18840 /* Glyph is off the left margin of the display area.
18841 Should not happen. */
18845 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18846 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18847 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18848 row
->phys_height
= max (row
->phys_height
,
18849 it
->max_phys_ascent
+ it
->max_phys_descent
);
18850 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18851 it
->max_extra_line_spacing
);
18852 x
+= glyph
->pixel_width
;
18856 /* Stop if max_x reached. */
18860 /* Stop at line ends. */
18861 if (ITERATOR_AT_END_OF_LINE_P (it
))
18863 it
->continuation_lines_width
= 0;
18867 set_iterator_to_next (it
, 1);
18869 /* Stop if truncating at the right edge. */
18870 if (it
->line_wrap
== TRUNCATE
18871 && it
->current_x
>= it
->last_visible_x
)
18873 /* Add truncation mark, but don't do it if the line is
18874 truncated at a padding space. */
18875 if (IT_CHARPOS (*it
) < it
->string_nchars
)
18877 if (!FRAME_WINDOW_P (it
->f
))
18881 if (it
->current_x
> it
->last_visible_x
)
18883 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
18884 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18886 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
18888 row
->used
[TEXT_AREA
] = i
;
18889 produce_special_glyphs (it
, IT_TRUNCATION
);
18892 produce_special_glyphs (it
, IT_TRUNCATION
);
18894 it
->glyph_row
->truncated_on_right_p
= 1;
18900 /* Maybe insert a truncation at the left. */
18901 if (it
->first_visible_x
18902 && IT_CHARPOS (*it
) > 0)
18904 if (!FRAME_WINDOW_P (it
->f
))
18905 insert_left_trunc_glyphs (it
);
18906 it
->glyph_row
->truncated_on_left_p
= 1;
18909 it
->face_id
= saved_face_id
;
18911 /* Value is number of columns displayed. */
18912 return it
->hpos
- hpos_at_start
;
18917 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
18918 appears as an element of LIST or as the car of an element of LIST.
18919 If PROPVAL is a list, compare each element against LIST in that
18920 way, and return 1/2 if any element of PROPVAL is found in LIST.
18921 Otherwise return 0. This function cannot quit.
18922 The return value is 2 if the text is invisible but with an ellipsis
18923 and 1 if it's invisible and without an ellipsis. */
18926 invisible_p (propval
, list
)
18927 register Lisp_Object propval
;
18930 register Lisp_Object tail
, proptail
;
18932 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
18934 register Lisp_Object tem
;
18936 if (EQ (propval
, tem
))
18938 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
18939 return NILP (XCDR (tem
)) ? 1 : 2;
18942 if (CONSP (propval
))
18944 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
18946 Lisp_Object propelt
;
18947 propelt
= XCAR (proptail
);
18948 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
18950 register Lisp_Object tem
;
18952 if (EQ (propelt
, tem
))
18954 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
18955 return NILP (XCDR (tem
)) ? 1 : 2;
18963 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
18964 doc
: /* Non-nil if the property makes the text invisible.
18965 POS-OR-PROP can be a marker or number, in which case it is taken to be
18966 a position in the current buffer and the value of the `invisible' property
18967 is checked; or it can be some other value, which is then presumed to be the
18968 value of the `invisible' property of the text of interest.
18969 The non-nil value returned can be t for truly invisible text or something
18970 else if the text is replaced by an ellipsis. */)
18972 Lisp_Object pos_or_prop
;
18975 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
18976 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
18978 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
18979 return (invis
== 0 ? Qnil
18981 : make_number (invis
));
18984 /* Calculate a width or height in pixels from a specification using
18985 the following elements:
18988 NUM - a (fractional) multiple of the default font width/height
18989 (NUM) - specifies exactly NUM pixels
18990 UNIT - a fixed number of pixels, see below.
18991 ELEMENT - size of a display element in pixels, see below.
18992 (NUM . SPEC) - equals NUM * SPEC
18993 (+ SPEC SPEC ...) - add pixel values
18994 (- SPEC SPEC ...) - subtract pixel values
18995 (- SPEC) - negate pixel value
18998 INT or FLOAT - a number constant
18999 SYMBOL - use symbol's (buffer local) variable binding.
19002 in - pixels per inch *)
19003 mm - pixels per 1/1000 meter *)
19004 cm - pixels per 1/100 meter *)
19005 width - width of current font in pixels.
19006 height - height of current font in pixels.
19008 *) using the ratio(s) defined in display-pixels-per-inch.
19012 left-fringe - left fringe width in pixels
19013 right-fringe - right fringe width in pixels
19015 left-margin - left margin width in pixels
19016 right-margin - right margin width in pixels
19018 scroll-bar - scroll-bar area width in pixels
19022 Pixels corresponding to 5 inches:
19025 Total width of non-text areas on left side of window (if scroll-bar is on left):
19026 '(space :width (+ left-fringe left-margin scroll-bar))
19028 Align to first text column (in header line):
19029 '(space :align-to 0)
19031 Align to middle of text area minus half the width of variable `my-image'
19032 containing a loaded image:
19033 '(space :align-to (0.5 . (- text my-image)))
19035 Width of left margin minus width of 1 character in the default font:
19036 '(space :width (- left-margin 1))
19038 Width of left margin minus width of 2 characters in the current font:
19039 '(space :width (- left-margin (2 . width)))
19041 Center 1 character over left-margin (in header line):
19042 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
19044 Different ways to express width of left fringe plus left margin minus one pixel:
19045 '(space :width (- (+ left-fringe left-margin) (1)))
19046 '(space :width (+ left-fringe left-margin (- (1))))
19047 '(space :width (+ left-fringe left-margin (-1)))
19051 #define NUMVAL(X) \
19052 ((INTEGERP (X) || FLOATP (X)) \
19057 calc_pixel_width_or_height (res
, it
, prop
, font
, width_p
, align_to
)
19062 int width_p
, *align_to
;
19066 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
19067 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
19070 return OK_PIXELS (0);
19072 xassert (FRAME_LIVE_P (it
->f
));
19074 if (SYMBOLP (prop
))
19076 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
19078 char *unit
= SDATA (SYMBOL_NAME (prop
));
19080 if (unit
[0] == 'i' && unit
[1] == 'n')
19082 else if (unit
[0] == 'm' && unit
[1] == 'm')
19084 else if (unit
[0] == 'c' && unit
[1] == 'm')
19091 #ifdef HAVE_WINDOW_SYSTEM
19092 if (FRAME_WINDOW_P (it
->f
)
19094 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
19095 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
19097 return OK_PIXELS (ppi
/ pixels
);
19100 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
19101 || (CONSP (Vdisplay_pixels_per_inch
)
19103 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
19104 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
19106 return OK_PIXELS (ppi
/ pixels
);
19112 #ifdef HAVE_WINDOW_SYSTEM
19113 if (EQ (prop
, Qheight
))
19114 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
19115 if (EQ (prop
, Qwidth
))
19116 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
19118 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
19119 return OK_PIXELS (1);
19122 if (EQ (prop
, Qtext
))
19123 return OK_PIXELS (width_p
19124 ? window_box_width (it
->w
, TEXT_AREA
)
19125 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
19127 if (align_to
&& *align_to
< 0)
19130 if (EQ (prop
, Qleft
))
19131 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
19132 if (EQ (prop
, Qright
))
19133 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
19134 if (EQ (prop
, Qcenter
))
19135 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
19136 + window_box_width (it
->w
, TEXT_AREA
) / 2);
19137 if (EQ (prop
, Qleft_fringe
))
19138 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19139 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
19140 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
19141 if (EQ (prop
, Qright_fringe
))
19142 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19143 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
19144 : window_box_right_offset (it
->w
, TEXT_AREA
));
19145 if (EQ (prop
, Qleft_margin
))
19146 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
19147 if (EQ (prop
, Qright_margin
))
19148 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
19149 if (EQ (prop
, Qscroll_bar
))
19150 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
19152 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
19153 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19154 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19159 if (EQ (prop
, Qleft_fringe
))
19160 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
19161 if (EQ (prop
, Qright_fringe
))
19162 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
19163 if (EQ (prop
, Qleft_margin
))
19164 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
19165 if (EQ (prop
, Qright_margin
))
19166 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
19167 if (EQ (prop
, Qscroll_bar
))
19168 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
19171 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
19174 if (INTEGERP (prop
) || FLOATP (prop
))
19176 int base_unit
= (width_p
19177 ? FRAME_COLUMN_WIDTH (it
->f
)
19178 : FRAME_LINE_HEIGHT (it
->f
));
19179 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
19184 Lisp_Object car
= XCAR (prop
);
19185 Lisp_Object cdr
= XCDR (prop
);
19189 #ifdef HAVE_WINDOW_SYSTEM
19190 if (FRAME_WINDOW_P (it
->f
)
19191 && valid_image_p (prop
))
19193 int id
= lookup_image (it
->f
, prop
);
19194 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
19196 return OK_PIXELS (width_p
? img
->width
: img
->height
);
19199 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
19205 while (CONSP (cdr
))
19207 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
19208 font
, width_p
, align_to
))
19211 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
19216 if (EQ (car
, Qminus
))
19218 return OK_PIXELS (pixels
);
19221 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
19224 if (INTEGERP (car
) || FLOATP (car
))
19227 pixels
= XFLOATINT (car
);
19229 return OK_PIXELS (pixels
);
19230 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
19231 font
, width_p
, align_to
))
19232 return OK_PIXELS (pixels
* fact
);
19243 /***********************************************************************
19245 ***********************************************************************/
19247 #ifdef HAVE_WINDOW_SYSTEM
19252 dump_glyph_string (s
)
19253 struct glyph_string
*s
;
19255 fprintf (stderr
, "glyph string\n");
19256 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
19257 s
->x
, s
->y
, s
->width
, s
->height
);
19258 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
19259 fprintf (stderr
, " hl = %d\n", s
->hl
);
19260 fprintf (stderr
, " left overhang = %d, right = %d\n",
19261 s
->left_overhang
, s
->right_overhang
);
19262 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
19263 fprintf (stderr
, " extends to end of line = %d\n",
19264 s
->extends_to_end_of_line_p
);
19265 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
19266 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
19269 #endif /* GLYPH_DEBUG */
19271 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
19272 of XChar2b structures for S; it can't be allocated in
19273 init_glyph_string because it must be allocated via `alloca'. W
19274 is the window on which S is drawn. ROW and AREA are the glyph row
19275 and area within the row from which S is constructed. START is the
19276 index of the first glyph structure covered by S. HL is a
19277 face-override for drawing S. */
19280 #define OPTIONAL_HDC(hdc) hdc,
19281 #define DECLARE_HDC(hdc) HDC hdc;
19282 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
19283 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
19286 #ifndef OPTIONAL_HDC
19287 #define OPTIONAL_HDC(hdc)
19288 #define DECLARE_HDC(hdc)
19289 #define ALLOCATE_HDC(hdc, f)
19290 #define RELEASE_HDC(hdc, f)
19294 init_glyph_string (s
, OPTIONAL_HDC (hdc
) char2b
, w
, row
, area
, start
, hl
)
19295 struct glyph_string
*s
;
19299 struct glyph_row
*row
;
19300 enum glyph_row_area area
;
19302 enum draw_glyphs_face hl
;
19304 bzero (s
, sizeof *s
);
19306 s
->f
= XFRAME (w
->frame
);
19310 s
->display
= FRAME_X_DISPLAY (s
->f
);
19311 s
->window
= FRAME_X_WINDOW (s
->f
);
19312 s
->char2b
= char2b
;
19316 s
->first_glyph
= row
->glyphs
[area
] + start
;
19317 s
->height
= row
->height
;
19318 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
19320 /* Display the internal border below the tool-bar window. */
19321 if (WINDOWP (s
->f
->tool_bar_window
)
19322 && s
->w
== XWINDOW (s
->f
->tool_bar_window
))
19323 s
->y
-= FRAME_INTERNAL_BORDER_WIDTH (s
->f
);
19325 s
->ybase
= s
->y
+ row
->ascent
;
19329 /* Append the list of glyph strings with head H and tail T to the list
19330 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
19333 append_glyph_string_lists (head
, tail
, h
, t
)
19334 struct glyph_string
**head
, **tail
;
19335 struct glyph_string
*h
, *t
;
19349 /* Prepend the list of glyph strings with head H and tail T to the
19350 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
19354 prepend_glyph_string_lists (head
, tail
, h
, t
)
19355 struct glyph_string
**head
, **tail
;
19356 struct glyph_string
*h
, *t
;
19370 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
19371 Set *HEAD and *TAIL to the resulting list. */
19374 append_glyph_string (head
, tail
, s
)
19375 struct glyph_string
**head
, **tail
;
19376 struct glyph_string
*s
;
19378 s
->next
= s
->prev
= NULL
;
19379 append_glyph_string_lists (head
, tail
, s
, s
);
19383 /* Get face and two-byte form of character C in face FACE_ID on frame
19384 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
19385 means we want to display multibyte text. DISPLAY_P non-zero means
19386 make sure that X resources for the face returned are allocated.
19387 Value is a pointer to a realized face that is ready for display if
19388 DISPLAY_P is non-zero. */
19390 static INLINE
struct face
*
19391 get_char_face_and_encoding (f
, c
, face_id
, char2b
, multibyte_p
, display_p
)
19395 int multibyte_p
, display_p
;
19397 struct face
*face
= FACE_FROM_ID (f
, face_id
);
19401 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
19403 if (code
!= FONT_INVALID_CODE
)
19404 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19406 STORE_XCHAR2B (char2b
, 0, 0);
19409 /* Make sure X resources of the face are allocated. */
19410 #ifdef HAVE_X_WINDOWS
19414 xassert (face
!= NULL
);
19415 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19422 /* Get face and two-byte form of character glyph GLYPH on frame F.
19423 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
19424 a pointer to a realized face that is ready for display. */
19426 static INLINE
struct face
*
19427 get_glyph_face_and_encoding (f
, glyph
, char2b
, two_byte_p
)
19429 struct glyph
*glyph
;
19435 xassert (glyph
->type
== CHAR_GLYPH
);
19436 face
= FACE_FROM_ID (f
, glyph
->face_id
);
19443 unsigned code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
19445 if (code
!= FONT_INVALID_CODE
)
19446 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19448 STORE_XCHAR2B (char2b
, 0, 0);
19451 /* Make sure X resources of the face are allocated. */
19452 xassert (face
!= NULL
);
19453 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19458 /* Fill glyph string S with composition components specified by S->cmp.
19460 BASE_FACE is the base face of the composition.
19461 S->gidx is the index of the first component for S.
19463 OVERLAPS non-zero means S should draw the foreground only, and use
19464 its physical height for clipping. See also draw_glyphs.
19466 Value is the index of a component not in S. */
19469 fill_composite_glyph_string (s
, base_face
, overlaps
)
19470 struct glyph_string
*s
;
19471 struct face
*base_face
;
19478 s
->for_overlaps
= overlaps
;
19480 if (s
->cmp
->method
== COMPOSITION_WITH_GLYPH_STRING
)
19482 Lisp_Object gstring
19483 = AREF (XHASH_TABLE (composition_hash_table
)->key_and_value
,
19484 s
->cmp
->hash_index
* 2);
19486 s
->face
= base_face
;
19487 s
->font
= base_face
->font
;
19488 for (i
= 0, s
->nchars
= 0; i
< s
->cmp
->glyph_len
; i
++, s
->nchars
++)
19490 Lisp_Object g
= LGSTRING_GLYPH (gstring
, i
);
19492 XChar2b
* store_pos
;
19495 code
= LGLYPH_CODE (g
);
19496 store_pos
= s
->char2b
+ i
;
19497 STORE_XCHAR2B (store_pos
, code
>> 8, code
& 0xFF);
19499 s
->width
= s
->cmp
->pixel_width
;
19503 /* For all glyphs of this composition, starting at the offset
19504 S->gidx, until we reach the end of the definition or encounter a
19505 glyph that requires the different face, add it to S. */
19510 for (i
= s
->gidx
; i
< s
->cmp
->glyph_len
; i
++)
19512 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
19516 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
19519 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
19520 s
->char2b
+ i
, 1, 1);
19526 s
->font
= s
->face
->font
;
19528 else if (s
->face
!= face
)
19535 /* All glyph strings for the same composition has the same width,
19536 i.e. the width set for the first component of the composition. */
19537 s
->width
= s
->first_glyph
->pixel_width
;
19540 /* If the specified font could not be loaded, use the frame's
19541 default font, but record the fact that we couldn't load it in
19542 the glyph string so that we can draw rectangles for the
19543 characters of the glyph string. */
19544 if (s
->font
== NULL
)
19546 s
->font_not_found_p
= 1;
19547 s
->font
= FRAME_FONT (s
->f
);
19550 /* Adjust base line for subscript/superscript text. */
19551 s
->ybase
+= s
->first_glyph
->voffset
;
19553 /* This glyph string must always be drawn with 16-bit functions. */
19556 return s
->gidx
+ s
->nchars
;
19560 /* Fill glyph string S from a sequence of character glyphs.
19562 FACE_ID is the face id of the string. START is the index of the
19563 first glyph to consider, END is the index of the last + 1.
19564 OVERLAPS non-zero means S should draw the foreground only, and use
19565 its physical height for clipping. See also draw_glyphs.
19567 Value is the index of the first glyph not in S. */
19570 fill_glyph_string (s
, face_id
, start
, end
, overlaps
)
19571 struct glyph_string
*s
;
19573 int start
, end
, overlaps
;
19575 struct glyph
*glyph
, *last
;
19577 int glyph_not_available_p
;
19579 xassert (s
->f
== XFRAME (s
->w
->frame
));
19580 xassert (s
->nchars
== 0);
19581 xassert (start
>= 0 && end
> start
);
19583 s
->for_overlaps
= overlaps
,
19584 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19585 last
= s
->row
->glyphs
[s
->area
] + end
;
19586 voffset
= glyph
->voffset
;
19587 s
->padding_p
= glyph
->padding_p
;
19588 glyph_not_available_p
= glyph
->glyph_not_available_p
;
19590 while (glyph
< last
19591 && glyph
->type
== CHAR_GLYPH
19592 && glyph
->voffset
== voffset
19593 /* Same face id implies same font, nowadays. */
19594 && glyph
->face_id
== face_id
19595 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
19599 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
19600 s
->char2b
+ s
->nchars
,
19602 s
->two_byte_p
= two_byte_p
;
19604 xassert (s
->nchars
<= end
- start
);
19605 s
->width
+= glyph
->pixel_width
;
19606 if (glyph
++->padding_p
!= s
->padding_p
)
19610 s
->font
= s
->face
->font
;
19612 /* If the specified font could not be loaded, use the frame's font,
19613 but record the fact that we couldn't load it in
19614 S->font_not_found_p so that we can draw rectangles for the
19615 characters of the glyph string. */
19616 if (s
->font
== NULL
|| glyph_not_available_p
)
19618 s
->font_not_found_p
= 1;
19619 s
->font
= FRAME_FONT (s
->f
);
19622 /* Adjust base line for subscript/superscript text. */
19623 s
->ybase
+= voffset
;
19625 xassert (s
->face
&& s
->face
->gc
);
19626 return glyph
- s
->row
->glyphs
[s
->area
];
19630 /* Fill glyph string S from image glyph S->first_glyph. */
19633 fill_image_glyph_string (s
)
19634 struct glyph_string
*s
;
19636 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
19637 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
19639 s
->slice
= s
->first_glyph
->slice
;
19640 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
19641 s
->font
= s
->face
->font
;
19642 s
->width
= s
->first_glyph
->pixel_width
;
19644 /* Adjust base line for subscript/superscript text. */
19645 s
->ybase
+= s
->first_glyph
->voffset
;
19649 /* Fill glyph string S from a sequence of stretch glyphs.
19651 ROW is the glyph row in which the glyphs are found, AREA is the
19652 area within the row. START is the index of the first glyph to
19653 consider, END is the index of the last + 1.
19655 Value is the index of the first glyph not in S. */
19658 fill_stretch_glyph_string (s
, row
, area
, start
, end
)
19659 struct glyph_string
*s
;
19660 struct glyph_row
*row
;
19661 enum glyph_row_area area
;
19664 struct glyph
*glyph
, *last
;
19665 int voffset
, face_id
;
19667 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
19669 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19670 last
= s
->row
->glyphs
[s
->area
] + end
;
19671 face_id
= glyph
->face_id
;
19672 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
19673 s
->font
= s
->face
->font
;
19674 s
->width
= glyph
->pixel_width
;
19676 voffset
= glyph
->voffset
;
19680 && glyph
->type
== STRETCH_GLYPH
19681 && glyph
->voffset
== voffset
19682 && glyph
->face_id
== face_id
);
19684 s
->width
+= glyph
->pixel_width
;
19686 /* Adjust base line for subscript/superscript text. */
19687 s
->ybase
+= voffset
;
19689 /* The case that face->gc == 0 is handled when drawing the glyph
19690 string by calling PREPARE_FACE_FOR_DISPLAY. */
19692 return glyph
- s
->row
->glyphs
[s
->area
];
19695 static struct font_metrics
*
19696 get_per_char_metric (f
, font
, char2b
)
19701 static struct font_metrics metrics
;
19702 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
19703 struct font
*fontp
;
19705 if (! font
|| code
== FONT_INVALID_CODE
)
19707 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
19712 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
19713 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
19714 assumed to be zero. */
19717 x_get_glyph_overhangs (glyph
, f
, left
, right
)
19718 struct glyph
*glyph
;
19722 *left
= *right
= 0;
19724 if (glyph
->type
== CHAR_GLYPH
)
19728 struct font_metrics
*pcm
;
19730 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
19731 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
19733 if (pcm
->rbearing
> pcm
->width
)
19734 *right
= pcm
->rbearing
- pcm
->width
;
19735 if (pcm
->lbearing
< 0)
19736 *left
= -pcm
->lbearing
;
19739 else if (glyph
->type
== COMPOSITE_GLYPH
)
19741 struct composition
*cmp
= composition_table
[glyph
->u
.cmp_id
];
19743 *right
= cmp
->rbearing
- cmp
->pixel_width
;
19744 *left
= - cmp
->lbearing
;
19749 /* Return the index of the first glyph preceding glyph string S that
19750 is overwritten by S because of S's left overhang. Value is -1
19751 if no glyphs are overwritten. */
19754 left_overwritten (s
)
19755 struct glyph_string
*s
;
19759 if (s
->left_overhang
)
19762 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19763 int first
= s
->first_glyph
- glyphs
;
19765 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
19766 x
-= glyphs
[i
].pixel_width
;
19777 /* Return the index of the first glyph preceding glyph string S that
19778 is overwriting S because of its right overhang. Value is -1 if no
19779 glyph in front of S overwrites S. */
19782 left_overwriting (s
)
19783 struct glyph_string
*s
;
19786 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19787 int first
= s
->first_glyph
- glyphs
;
19791 for (i
= first
- 1; i
>= 0; --i
)
19794 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
19797 x
-= glyphs
[i
].pixel_width
;
19804 /* Return the index of the last glyph following glyph string S that is
19805 not overwritten by S because of S's right overhang. Value is -1 if
19806 no such glyph is found. */
19809 right_overwritten (s
)
19810 struct glyph_string
*s
;
19814 if (s
->right_overhang
)
19817 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19818 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19819 int end
= s
->row
->used
[s
->area
];
19821 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
19822 x
+= glyphs
[i
].pixel_width
;
19831 /* Return the index of the last glyph following glyph string S that
19832 overwrites S because of its left overhang. Value is negative
19833 if no such glyph is found. */
19836 right_overwriting (s
)
19837 struct glyph_string
*s
;
19840 int end
= s
->row
->used
[s
->area
];
19841 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19842 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19846 for (i
= first
; i
< end
; ++i
)
19849 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
19852 x
+= glyphs
[i
].pixel_width
;
19859 /* Set background width of glyph string S. START is the index of the
19860 first glyph following S. LAST_X is the right-most x-position + 1
19861 in the drawing area. */
19864 set_glyph_string_background_width (s
, start
, last_x
)
19865 struct glyph_string
*s
;
19869 /* If the face of this glyph string has to be drawn to the end of
19870 the drawing area, set S->extends_to_end_of_line_p. */
19872 if (start
== s
->row
->used
[s
->area
]
19873 && s
->area
== TEXT_AREA
19874 && ((s
->row
->fill_line_p
19875 && (s
->hl
== DRAW_NORMAL_TEXT
19876 || s
->hl
== DRAW_IMAGE_RAISED
19877 || s
->hl
== DRAW_IMAGE_SUNKEN
))
19878 || s
->hl
== DRAW_MOUSE_FACE
))
19879 s
->extends_to_end_of_line_p
= 1;
19881 /* If S extends its face to the end of the line, set its
19882 background_width to the distance to the right edge of the drawing
19884 if (s
->extends_to_end_of_line_p
)
19885 s
->background_width
= last_x
- s
->x
+ 1;
19887 s
->background_width
= s
->width
;
19891 /* Compute overhangs and x-positions for glyph string S and its
19892 predecessors, or successors. X is the starting x-position for S.
19893 BACKWARD_P non-zero means process predecessors. */
19896 compute_overhangs_and_x (s
, x
, backward_p
)
19897 struct glyph_string
*s
;
19905 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
19906 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
19916 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
19917 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
19927 /* The following macros are only called from draw_glyphs below.
19928 They reference the following parameters of that function directly:
19929 `w', `row', `area', and `overlap_p'
19930 as well as the following local variables:
19931 `s', `f', and `hdc' (in W32) */
19934 /* On W32, silently add local `hdc' variable to argument list of
19935 init_glyph_string. */
19936 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
19937 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
19939 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
19940 init_glyph_string (s, char2b, w, row, area, start, hl)
19943 /* Add a glyph string for a stretch glyph to the list of strings
19944 between HEAD and TAIL. START is the index of the stretch glyph in
19945 row area AREA of glyph row ROW. END is the index of the last glyph
19946 in that glyph row area. X is the current output position assigned
19947 to the new glyph string constructed. HL overrides that face of the
19948 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
19949 is the right-most x-position of the drawing area. */
19951 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
19952 and below -- keep them on one line. */
19953 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
19956 s = (struct glyph_string *) alloca (sizeof *s); \
19957 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
19958 START = fill_stretch_glyph_string (s, row, area, START, END); \
19959 append_glyph_string (&HEAD, &TAIL, s); \
19965 /* Add a glyph string for an image glyph to the list of strings
19966 between HEAD and TAIL. START is the index of the image glyph in
19967 row area AREA of glyph row ROW. END is the index of the last glyph
19968 in that glyph row area. X is the current output position assigned
19969 to the new glyph string constructed. HL overrides that face of the
19970 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
19971 is the right-most x-position of the drawing area. */
19973 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
19976 s = (struct glyph_string *) alloca (sizeof *s); \
19977 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
19978 fill_image_glyph_string (s); \
19979 append_glyph_string (&HEAD, &TAIL, s); \
19986 /* Add a glyph string for a sequence of character glyphs to the list
19987 of strings between HEAD and TAIL. START is the index of the first
19988 glyph in row area AREA of glyph row ROW that is part of the new
19989 glyph string. END is the index of the last glyph in that glyph row
19990 area. X is the current output position assigned to the new glyph
19991 string constructed. HL overrides that face of the glyph; e.g. it
19992 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
19993 right-most x-position of the drawing area. */
19995 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
20001 face_id = (row)->glyphs[area][START].face_id; \
20003 s = (struct glyph_string *) alloca (sizeof *s); \
20004 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
20005 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20006 append_glyph_string (&HEAD, &TAIL, s); \
20008 START = fill_glyph_string (s, face_id, START, END, overlaps); \
20013 /* Add a glyph string for a composite sequence to the list of strings
20014 between HEAD and TAIL. START is the index of the first glyph in
20015 row area AREA of glyph row ROW that is part of the new glyph
20016 string. END is the index of the last glyph in that glyph row area.
20017 X is the current output position assigned to the new glyph string
20018 constructed. HL overrides that face of the glyph; e.g. it is
20019 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
20020 x-position of the drawing area. */
20022 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20024 int face_id = (row)->glyphs[area][START].face_id; \
20025 struct face *base_face = FACE_FROM_ID (f, face_id); \
20026 int cmp_id = (row)->glyphs[area][START].u.cmp_id; \
20027 struct composition *cmp = composition_table[cmp_id]; \
20029 struct glyph_string *first_s; \
20032 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
20034 /* Make glyph_strings for each glyph sequence that is drawable by \
20035 the same face, and append them to HEAD/TAIL. */ \
20036 for (n = 0; n < cmp->glyph_len;) \
20038 s = (struct glyph_string *) alloca (sizeof *s); \
20039 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20040 append_glyph_string (&(HEAD), &(TAIL), s); \
20046 n = fill_composite_glyph_string (s, base_face, overlaps); \
20054 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
20055 of AREA of glyph row ROW on window W between indices START and END.
20056 HL overrides the face for drawing glyph strings, e.g. it is
20057 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
20058 x-positions of the drawing area.
20060 This is an ugly monster macro construct because we must use alloca
20061 to allocate glyph strings (because draw_glyphs can be called
20062 asynchronously). */
20064 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
20067 HEAD = TAIL = NULL; \
20068 while (START < END) \
20070 struct glyph *first_glyph = (row)->glyphs[area] + START; \
20071 switch (first_glyph->type) \
20074 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
20078 case COMPOSITE_GLYPH: \
20079 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
20083 case STRETCH_GLYPH: \
20084 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
20088 case IMAGE_GLYPH: \
20089 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
20099 set_glyph_string_background_width (s, START, LAST_X); \
20107 /* Draw glyphs between START and END in AREA of ROW on window W,
20108 starting at x-position X. X is relative to AREA in W. HL is a
20109 face-override with the following meaning:
20111 DRAW_NORMAL_TEXT draw normally
20112 DRAW_CURSOR draw in cursor face
20113 DRAW_MOUSE_FACE draw in mouse face.
20114 DRAW_INVERSE_VIDEO draw in mode line face
20115 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
20116 DRAW_IMAGE_RAISED draw an image with a raised relief around it
20118 If OVERLAPS is non-zero, draw only the foreground of characters and
20119 clip to the physical height of ROW. Non-zero value also defines
20120 the overlapping part to be drawn:
20122 OVERLAPS_PRED overlap with preceding rows
20123 OVERLAPS_SUCC overlap with succeeding rows
20124 OVERLAPS_BOTH overlap with both preceding/succeeding rows
20125 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
20127 Value is the x-position reached, relative to AREA of W. */
20130 draw_glyphs (w
, x
, row
, area
, start
, end
, hl
, overlaps
)
20133 struct glyph_row
*row
;
20134 enum glyph_row_area area
;
20135 EMACS_INT start
, end
;
20136 enum draw_glyphs_face hl
;
20139 struct glyph_string
*head
, *tail
;
20140 struct glyph_string
*s
;
20141 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
20142 int i
, j
, x_reached
, last_x
, area_left
= 0;
20143 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20146 ALLOCATE_HDC (hdc
, f
);
20148 /* Let's rather be paranoid than getting a SEGV. */
20149 end
= min (end
, row
->used
[area
]);
20150 start
= max (0, start
);
20151 start
= min (end
, start
);
20153 /* Translate X to frame coordinates. Set last_x to the right
20154 end of the drawing area. */
20155 if (row
->full_width_p
)
20157 /* X is relative to the left edge of W, without scroll bars
20159 area_left
= WINDOW_LEFT_EDGE_X (w
);
20160 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
20164 area_left
= window_box_left (w
, area
);
20165 last_x
= area_left
+ window_box_width (w
, area
);
20169 /* Build a doubly-linked list of glyph_string structures between
20170 head and tail from what we have to draw. Note that the macro
20171 BUILD_GLYPH_STRINGS will modify its start parameter. That's
20172 the reason we use a separate variable `i'. */
20174 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
20176 x_reached
= tail
->x
+ tail
->background_width
;
20180 /* If there are any glyphs with lbearing < 0 or rbearing > width in
20181 the row, redraw some glyphs in front or following the glyph
20182 strings built above. */
20183 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
20185 struct glyph_string
*h
, *t
;
20186 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
20187 int mouse_beg_col
, mouse_end_col
, check_mouse_face
= 0;
20190 /* If mouse highlighting is on, we may need to draw adjacent
20191 glyphs using mouse-face highlighting. */
20192 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
20194 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
20196 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
20197 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
20199 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
20201 check_mouse_face
= 1;
20202 mouse_beg_col
= (row
== mouse_beg_row
)
20203 ? dpyinfo
->mouse_face_beg_col
: 0;
20204 mouse_end_col
= (row
== mouse_end_row
)
20205 ? dpyinfo
->mouse_face_end_col
20206 : row
->used
[TEXT_AREA
];
20210 /* Compute overhangs for all glyph strings. */
20211 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
20212 for (s
= head
; s
; s
= s
->next
)
20213 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
20215 /* Prepend glyph strings for glyphs in front of the first glyph
20216 string that are overwritten because of the first glyph
20217 string's left overhang. The background of all strings
20218 prepended must be drawn because the first glyph string
20220 i
= left_overwritten (head
);
20223 enum draw_glyphs_face overlap_hl
;
20225 /* If this row contains mouse highlighting, attempt to draw
20226 the overlapped glyphs with the correct highlight. This
20227 code fails if the overlap encompasses more than one glyph
20228 and mouse-highlight spans only some of these glyphs.
20229 However, making it work perfectly involves a lot more
20230 code, and I don't know if the pathological case occurs in
20231 practice, so we'll stick to this for now. --- cyd */
20232 if (check_mouse_face
20233 && mouse_beg_col
< start
&& mouse_end_col
> i
)
20234 overlap_hl
= DRAW_MOUSE_FACE
;
20236 overlap_hl
= DRAW_NORMAL_TEXT
;
20239 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
20240 overlap_hl
, dummy_x
, last_x
);
20241 compute_overhangs_and_x (t
, head
->x
, 1);
20242 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
20246 /* Prepend glyph strings for glyphs in front of the first glyph
20247 string that overwrite that glyph string because of their
20248 right overhang. For these strings, only the foreground must
20249 be drawn, because it draws over the glyph string at `head'.
20250 The background must not be drawn because this would overwrite
20251 right overhangs of preceding glyphs for which no glyph
20253 i
= left_overwriting (head
);
20256 enum draw_glyphs_face overlap_hl
;
20258 if (check_mouse_face
20259 && mouse_beg_col
< start
&& mouse_end_col
> i
)
20260 overlap_hl
= DRAW_MOUSE_FACE
;
20262 overlap_hl
= DRAW_NORMAL_TEXT
;
20265 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
20266 overlap_hl
, dummy_x
, last_x
);
20267 for (s
= h
; s
; s
= s
->next
)
20268 s
->background_filled_p
= 1;
20269 compute_overhangs_and_x (t
, head
->x
, 1);
20270 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
20273 /* Append glyphs strings for glyphs following the last glyph
20274 string tail that are overwritten by tail. The background of
20275 these strings has to be drawn because tail's foreground draws
20277 i
= right_overwritten (tail
);
20280 enum draw_glyphs_face overlap_hl
;
20282 if (check_mouse_face
20283 && mouse_beg_col
< i
&& mouse_end_col
> end
)
20284 overlap_hl
= DRAW_MOUSE_FACE
;
20286 overlap_hl
= DRAW_NORMAL_TEXT
;
20288 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
20289 overlap_hl
, x
, last_x
);
20290 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
20291 append_glyph_string_lists (&head
, &tail
, h
, t
);
20295 /* Append glyph strings for glyphs following the last glyph
20296 string tail that overwrite tail. The foreground of such
20297 glyphs has to be drawn because it writes into the background
20298 of tail. The background must not be drawn because it could
20299 paint over the foreground of following glyphs. */
20300 i
= right_overwriting (tail
);
20303 enum draw_glyphs_face overlap_hl
;
20304 if (check_mouse_face
20305 && mouse_beg_col
< i
&& mouse_end_col
> end
)
20306 overlap_hl
= DRAW_MOUSE_FACE
;
20308 overlap_hl
= DRAW_NORMAL_TEXT
;
20311 i
++; /* We must include the Ith glyph. */
20312 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
20313 overlap_hl
, x
, last_x
);
20314 for (s
= h
; s
; s
= s
->next
)
20315 s
->background_filled_p
= 1;
20316 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
20317 append_glyph_string_lists (&head
, &tail
, h
, t
);
20319 if (clip_head
|| clip_tail
)
20320 for (s
= head
; s
; s
= s
->next
)
20322 s
->clip_head
= clip_head
;
20323 s
->clip_tail
= clip_tail
;
20327 /* Draw all strings. */
20328 for (s
= head
; s
; s
= s
->next
)
20329 FRAME_RIF (f
)->draw_glyph_string (s
);
20331 if (area
== TEXT_AREA
20332 && !row
->full_width_p
20333 /* When drawing overlapping rows, only the glyph strings'
20334 foreground is drawn, which doesn't erase a cursor
20338 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
20339 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
20340 : (tail
? tail
->x
+ tail
->background_width
: x
));
20344 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
20345 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
20348 /* Value is the x-position up to which drawn, relative to AREA of W.
20349 This doesn't include parts drawn because of overhangs. */
20350 if (row
->full_width_p
)
20351 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
20353 x_reached
-= area_left
;
20355 RELEASE_HDC (hdc
, f
);
20360 /* Expand row matrix if too narrow. Don't expand if area
20363 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
20365 if (!fonts_changed_p \
20366 && (it->glyph_row->glyphs[area] \
20367 < it->glyph_row->glyphs[area + 1])) \
20369 it->w->ncols_scale_factor++; \
20370 fonts_changed_p = 1; \
20374 /* Store one glyph for IT->char_to_display in IT->glyph_row.
20375 Called from x_produce_glyphs when IT->glyph_row is non-null. */
20381 struct glyph
*glyph
;
20382 enum glyph_row_area area
= it
->area
;
20384 xassert (it
->glyph_row
);
20385 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
20387 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20388 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20390 glyph
->charpos
= CHARPOS (it
->position
);
20391 glyph
->object
= it
->object
;
20392 if (it
->pixel_width
> 0)
20394 glyph
->pixel_width
= it
->pixel_width
;
20395 glyph
->padding_p
= 0;
20399 /* Assure at least 1-pixel width. Otherwise, cursor can't
20400 be displayed correctly. */
20401 glyph
->pixel_width
= 1;
20402 glyph
->padding_p
= 1;
20404 glyph
->ascent
= it
->ascent
;
20405 glyph
->descent
= it
->descent
;
20406 glyph
->voffset
= it
->voffset
;
20407 glyph
->type
= CHAR_GLYPH
;
20408 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20409 glyph
->multibyte_p
= it
->multibyte_p
;
20410 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20411 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20412 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
20413 || it
->phys_descent
> it
->descent
);
20414 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
20415 glyph
->face_id
= it
->face_id
;
20416 glyph
->u
.ch
= it
->char_to_display
;
20417 glyph
->slice
= null_glyph_slice
;
20418 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20419 ++it
->glyph_row
->used
[area
];
20422 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20425 /* Store one glyph for the composition IT->cmp_id in IT->glyph_row.
20426 Called from x_produce_glyphs when IT->glyph_row is non-null. */
20429 append_composite_glyph (it
)
20432 struct glyph
*glyph
;
20433 enum glyph_row_area area
= it
->area
;
20435 xassert (it
->glyph_row
);
20437 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20438 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20440 glyph
->charpos
= CHARPOS (it
->position
);
20441 glyph
->object
= it
->object
;
20442 glyph
->pixel_width
= it
->pixel_width
;
20443 glyph
->ascent
= it
->ascent
;
20444 glyph
->descent
= it
->descent
;
20445 glyph
->voffset
= it
->voffset
;
20446 glyph
->type
= COMPOSITE_GLYPH
;
20447 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20448 glyph
->multibyte_p
= it
->multibyte_p
;
20449 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20450 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20451 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
20452 || it
->phys_descent
> it
->descent
);
20453 glyph
->padding_p
= 0;
20454 glyph
->glyph_not_available_p
= 0;
20455 glyph
->face_id
= it
->face_id
;
20456 glyph
->u
.cmp_id
= it
->cmp_id
;
20457 glyph
->slice
= null_glyph_slice
;
20458 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20459 ++it
->glyph_row
->used
[area
];
20462 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20466 /* Change IT->ascent and IT->height according to the setting of
20470 take_vertical_position_into_account (it
)
20475 if (it
->voffset
< 0)
20476 /* Increase the ascent so that we can display the text higher
20478 it
->ascent
-= it
->voffset
;
20480 /* Increase the descent so that we can display the text lower
20482 it
->descent
+= it
->voffset
;
20487 /* Produce glyphs/get display metrics for the image IT is loaded with.
20488 See the description of struct display_iterator in dispextern.h for
20489 an overview of struct display_iterator. */
20492 produce_image_glyph (it
)
20497 int glyph_ascent
, crop
;
20498 struct glyph_slice slice
;
20500 xassert (it
->what
== IT_IMAGE
);
20502 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20504 /* Make sure X resources of the face is loaded. */
20505 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
20507 if (it
->image_id
< 0)
20509 /* Fringe bitmap. */
20510 it
->ascent
= it
->phys_ascent
= 0;
20511 it
->descent
= it
->phys_descent
= 0;
20512 it
->pixel_width
= 0;
20517 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
20519 /* Make sure X resources of the image is loaded. */
20520 prepare_image_for_display (it
->f
, img
);
20522 slice
.x
= slice
.y
= 0;
20523 slice
.width
= img
->width
;
20524 slice
.height
= img
->height
;
20526 if (INTEGERP (it
->slice
.x
))
20527 slice
.x
= XINT (it
->slice
.x
);
20528 else if (FLOATP (it
->slice
.x
))
20529 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
20531 if (INTEGERP (it
->slice
.y
))
20532 slice
.y
= XINT (it
->slice
.y
);
20533 else if (FLOATP (it
->slice
.y
))
20534 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
20536 if (INTEGERP (it
->slice
.width
))
20537 slice
.width
= XINT (it
->slice
.width
);
20538 else if (FLOATP (it
->slice
.width
))
20539 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
20541 if (INTEGERP (it
->slice
.height
))
20542 slice
.height
= XINT (it
->slice
.height
);
20543 else if (FLOATP (it
->slice
.height
))
20544 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
20546 if (slice
.x
>= img
->width
)
20547 slice
.x
= img
->width
;
20548 if (slice
.y
>= img
->height
)
20549 slice
.y
= img
->height
;
20550 if (slice
.x
+ slice
.width
>= img
->width
)
20551 slice
.width
= img
->width
- slice
.x
;
20552 if (slice
.y
+ slice
.height
> img
->height
)
20553 slice
.height
= img
->height
- slice
.y
;
20555 if (slice
.width
== 0 || slice
.height
== 0)
20558 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
20560 it
->descent
= slice
.height
- glyph_ascent
;
20562 it
->descent
+= img
->vmargin
;
20563 if (slice
.y
+ slice
.height
== img
->height
)
20564 it
->descent
+= img
->vmargin
;
20565 it
->phys_descent
= it
->descent
;
20567 it
->pixel_width
= slice
.width
;
20569 it
->pixel_width
+= img
->hmargin
;
20570 if (slice
.x
+ slice
.width
== img
->width
)
20571 it
->pixel_width
+= img
->hmargin
;
20573 /* It's quite possible for images to have an ascent greater than
20574 their height, so don't get confused in that case. */
20575 if (it
->descent
< 0)
20578 #if 0 /* this breaks image tiling */
20579 /* If this glyph is alone on the last line, adjust it.ascent to minimum row ascent. */
20580 int face_ascent
= face
->font
? FONT_BASE (face
->font
) : FRAME_BASELINE_OFFSET (it
->f
);
20581 if (face_ascent
> it
->ascent
)
20582 it
->ascent
= it
->phys_ascent
= face_ascent
;
20587 if (face
->box
!= FACE_NO_BOX
)
20589 if (face
->box_line_width
> 0)
20592 it
->ascent
+= face
->box_line_width
;
20593 if (slice
.y
+ slice
.height
== img
->height
)
20594 it
->descent
+= face
->box_line_width
;
20597 if (it
->start_of_box_run_p
&& slice
.x
== 0)
20598 it
->pixel_width
+= eabs (face
->box_line_width
);
20599 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
20600 it
->pixel_width
+= eabs (face
->box_line_width
);
20603 take_vertical_position_into_account (it
);
20605 /* Automatically crop wide image glyphs at right edge so we can
20606 draw the cursor on same display row. */
20607 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
20608 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
20610 it
->pixel_width
-= crop
;
20611 slice
.width
-= crop
;
20616 struct glyph
*glyph
;
20617 enum glyph_row_area area
= it
->area
;
20619 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20620 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20622 glyph
->charpos
= CHARPOS (it
->position
);
20623 glyph
->object
= it
->object
;
20624 glyph
->pixel_width
= it
->pixel_width
;
20625 glyph
->ascent
= glyph_ascent
;
20626 glyph
->descent
= it
->descent
;
20627 glyph
->voffset
= it
->voffset
;
20628 glyph
->type
= IMAGE_GLYPH
;
20629 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20630 glyph
->multibyte_p
= it
->multibyte_p
;
20631 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20632 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20633 glyph
->overlaps_vertically_p
= 0;
20634 glyph
->padding_p
= 0;
20635 glyph
->glyph_not_available_p
= 0;
20636 glyph
->face_id
= it
->face_id
;
20637 glyph
->u
.img_id
= img
->id
;
20638 glyph
->slice
= slice
;
20639 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20640 ++it
->glyph_row
->used
[area
];
20643 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20648 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
20649 of the glyph, WIDTH and HEIGHT are the width and height of the
20650 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
20653 append_stretch_glyph (it
, object
, width
, height
, ascent
)
20655 Lisp_Object object
;
20659 struct glyph
*glyph
;
20660 enum glyph_row_area area
= it
->area
;
20662 xassert (ascent
>= 0 && ascent
<= height
);
20664 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20665 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20667 glyph
->charpos
= CHARPOS (it
->position
);
20668 glyph
->object
= object
;
20669 glyph
->pixel_width
= width
;
20670 glyph
->ascent
= ascent
;
20671 glyph
->descent
= height
- ascent
;
20672 glyph
->voffset
= it
->voffset
;
20673 glyph
->type
= STRETCH_GLYPH
;
20674 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20675 glyph
->multibyte_p
= it
->multibyte_p
;
20676 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20677 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20678 glyph
->overlaps_vertically_p
= 0;
20679 glyph
->padding_p
= 0;
20680 glyph
->glyph_not_available_p
= 0;
20681 glyph
->face_id
= it
->face_id
;
20682 glyph
->u
.stretch
.ascent
= ascent
;
20683 glyph
->u
.stretch
.height
= height
;
20684 glyph
->slice
= null_glyph_slice
;
20685 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20686 ++it
->glyph_row
->used
[area
];
20689 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20693 /* Produce a stretch glyph for iterator IT. IT->object is the value
20694 of the glyph property displayed. The value must be a list
20695 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
20698 1. `:width WIDTH' specifies that the space should be WIDTH *
20699 canonical char width wide. WIDTH may be an integer or floating
20702 2. `:relative-width FACTOR' specifies that the width of the stretch
20703 should be computed from the width of the first character having the
20704 `glyph' property, and should be FACTOR times that width.
20706 3. `:align-to HPOS' specifies that the space should be wide enough
20707 to reach HPOS, a value in canonical character units.
20709 Exactly one of the above pairs must be present.
20711 4. `:height HEIGHT' specifies that the height of the stretch produced
20712 should be HEIGHT, measured in canonical character units.
20714 5. `:relative-height FACTOR' specifies that the height of the
20715 stretch should be FACTOR times the height of the characters having
20716 the glyph property.
20718 Either none or exactly one of 4 or 5 must be present.
20720 6. `:ascent ASCENT' specifies that ASCENT percent of the height
20721 of the stretch should be used for the ascent of the stretch.
20722 ASCENT must be in the range 0 <= ASCENT <= 100. */
20725 produce_stretch_glyph (it
)
20728 /* (space :width WIDTH :height HEIGHT ...) */
20729 Lisp_Object prop
, plist
;
20730 int width
= 0, height
= 0, align_to
= -1;
20731 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
20734 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20735 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
20737 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
20739 /* List should start with `space'. */
20740 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
20741 plist
= XCDR (it
->object
);
20743 /* Compute the width of the stretch. */
20744 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
20745 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
20747 /* Absolute width `:width WIDTH' specified and valid. */
20748 zero_width_ok_p
= 1;
20751 else if (prop
= Fplist_get (plist
, QCrelative_width
),
20754 /* Relative width `:relative-width FACTOR' specified and valid.
20755 Compute the width of the characters having the `glyph'
20758 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
20761 if (it
->multibyte_p
)
20763 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
20764 - IT_BYTEPOS (*it
));
20765 it2
.c
= STRING_CHAR_AND_LENGTH (p
, maxlen
, it2
.len
);
20768 it2
.c
= *p
, it2
.len
= 1;
20770 it2
.glyph_row
= NULL
;
20771 it2
.what
= IT_CHARACTER
;
20772 x_produce_glyphs (&it2
);
20773 width
= NUMVAL (prop
) * it2
.pixel_width
;
20775 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
20776 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
20778 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
20779 align_to
= (align_to
< 0
20781 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
20782 else if (align_to
< 0)
20783 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
20784 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
20785 zero_width_ok_p
= 1;
20788 /* Nothing specified -> width defaults to canonical char width. */
20789 width
= FRAME_COLUMN_WIDTH (it
->f
);
20791 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
20794 /* Compute height. */
20795 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
20796 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
20799 zero_height_ok_p
= 1;
20801 else if (prop
= Fplist_get (plist
, QCrelative_height
),
20803 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
20805 height
= FONT_HEIGHT (font
);
20807 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
20810 /* Compute percentage of height used for ascent. If
20811 `:ascent ASCENT' is present and valid, use that. Otherwise,
20812 derive the ascent from the font in use. */
20813 if (prop
= Fplist_get (plist
, QCascent
),
20814 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
20815 ascent
= height
* NUMVAL (prop
) / 100.0;
20816 else if (!NILP (prop
)
20817 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
20818 ascent
= min (max (0, (int)tem
), height
);
20820 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
20822 if (width
> 0 && it
->line_wrap
!= TRUNCATE
20823 && it
->current_x
+ width
> it
->last_visible_x
)
20824 width
= it
->last_visible_x
- it
->current_x
- 1;
20826 if (width
> 0 && height
> 0 && it
->glyph_row
)
20828 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
20829 if (!STRINGP (object
))
20830 object
= it
->w
->buffer
;
20831 append_stretch_glyph (it
, object
, width
, height
, ascent
);
20834 it
->pixel_width
= width
;
20835 it
->ascent
= it
->phys_ascent
= ascent
;
20836 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
20837 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
20839 take_vertical_position_into_account (it
);
20842 /* Return the character-property PROP at the current position in IT. */
20845 get_it_property (it
, prop
)
20849 Lisp_Object position
;
20851 if (STRINGP (it
->object
))
20852 position
= make_number (IT_STRING_CHARPOS (*it
));
20853 else if (BUFFERP (it
->object
))
20854 position
= make_number (IT_CHARPOS (*it
));
20858 return Fget_char_property (position
, prop
, it
->object
);
20861 /* Calculate line-height and line-spacing properties.
20862 An integer value specifies explicit pixel value.
20863 A float value specifies relative value to current face height.
20864 A cons (float . face-name) specifies relative value to
20865 height of specified face font.
20867 Returns height in pixels, or nil. */
20871 calc_line_height_property (it
, val
, font
, boff
, override
)
20875 int boff
, override
;
20877 Lisp_Object face_name
= Qnil
;
20878 int ascent
, descent
, height
;
20880 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
20885 face_name
= XCAR (val
);
20887 if (!NUMBERP (val
))
20888 val
= make_number (1);
20889 if (NILP (face_name
))
20891 height
= it
->ascent
+ it
->descent
;
20896 if (NILP (face_name
))
20898 font
= FRAME_FONT (it
->f
);
20899 boff
= FRAME_BASELINE_OFFSET (it
->f
);
20901 else if (EQ (face_name
, Qt
))
20910 face_id
= lookup_named_face (it
->f
, face_name
, 0);
20912 return make_number (-1);
20914 face
= FACE_FROM_ID (it
->f
, face_id
);
20917 return make_number (-1);
20918 boff
= font
->baseline_offset
;
20919 if (font
->vertical_centering
)
20920 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
20923 ascent
= FONT_BASE (font
) + boff
;
20924 descent
= FONT_DESCENT (font
) - boff
;
20928 it
->override_ascent
= ascent
;
20929 it
->override_descent
= descent
;
20930 it
->override_boff
= boff
;
20933 height
= ascent
+ descent
;
20937 height
= (int)(XFLOAT_DATA (val
) * height
);
20938 else if (INTEGERP (val
))
20939 height
*= XINT (val
);
20941 return make_number (height
);
20946 Produce glyphs/get display metrics for the display element IT is
20947 loaded with. See the description of struct it in dispextern.h
20948 for an overview of struct it. */
20951 x_produce_glyphs (it
)
20954 int extra_line_spacing
= it
->extra_line_spacing
;
20956 it
->glyph_not_available_p
= 0;
20958 if (it
->what
== IT_CHARACTER
)
20962 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20963 struct font_metrics
*pcm
;
20964 int font_not_found_p
;
20965 int boff
; /* baseline offset */
20966 /* We may change it->multibyte_p upon unibyte<->multibyte
20967 conversion. So, save the current value now and restore it
20970 Note: It seems that we don't have to record multibyte_p in
20971 struct glyph because the character code itself tells if or
20972 not the character is multibyte. Thus, in the future, we must
20973 consider eliminating the field `multibyte_p' in the struct
20975 int saved_multibyte_p
= it
->multibyte_p
;
20977 /* Maybe translate single-byte characters to multibyte, or the
20979 it
->char_to_display
= it
->c
;
20980 if (!ASCII_BYTE_P (it
->c
)
20981 && ! it
->multibyte_p
)
20983 if (SINGLE_BYTE_CHAR_P (it
->c
)
20984 && unibyte_display_via_language_environment
)
20985 it
->char_to_display
= unibyte_char_to_multibyte (it
->c
);
20986 if (! SINGLE_BYTE_CHAR_P (it
->char_to_display
))
20988 it
->multibyte_p
= 1;
20989 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
,
20991 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20995 /* Get font to use. Encode IT->char_to_display. */
20996 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
20997 &char2b
, it
->multibyte_p
, 0);
21000 /* When no suitable font found, use the default font. */
21001 font_not_found_p
= font
== NULL
;
21002 if (font_not_found_p
)
21004 font
= FRAME_FONT (it
->f
);
21005 boff
= FRAME_BASELINE_OFFSET (it
->f
);
21009 boff
= font
->baseline_offset
;
21010 if (font
->vertical_centering
)
21011 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21014 if (it
->char_to_display
>= ' '
21015 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
21017 /* Either unibyte or ASCII. */
21022 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21024 if (it
->override_ascent
>= 0)
21026 it
->ascent
= it
->override_ascent
;
21027 it
->descent
= it
->override_descent
;
21028 boff
= it
->override_boff
;
21032 it
->ascent
= FONT_BASE (font
) + boff
;
21033 it
->descent
= FONT_DESCENT (font
) - boff
;
21038 it
->phys_ascent
= pcm
->ascent
+ boff
;
21039 it
->phys_descent
= pcm
->descent
- boff
;
21040 it
->pixel_width
= pcm
->width
;
21044 it
->glyph_not_available_p
= 1;
21045 it
->phys_ascent
= it
->ascent
;
21046 it
->phys_descent
= it
->descent
;
21047 it
->pixel_width
= FONT_WIDTH (font
);
21050 if (it
->constrain_row_ascent_descent_p
)
21052 if (it
->descent
> it
->max_descent
)
21054 it
->ascent
+= it
->descent
- it
->max_descent
;
21055 it
->descent
= it
->max_descent
;
21057 if (it
->ascent
> it
->max_ascent
)
21059 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
21060 it
->ascent
= it
->max_ascent
;
21062 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
21063 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
21064 extra_line_spacing
= 0;
21067 /* If this is a space inside a region of text with
21068 `space-width' property, change its width. */
21069 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
21071 it
->pixel_width
*= XFLOATINT (it
->space_width
);
21073 /* If face has a box, add the box thickness to the character
21074 height. If character has a box line to the left and/or
21075 right, add the box line width to the character's width. */
21076 if (face
->box
!= FACE_NO_BOX
)
21078 int thick
= face
->box_line_width
;
21082 it
->ascent
+= thick
;
21083 it
->descent
+= thick
;
21088 if (it
->start_of_box_run_p
)
21089 it
->pixel_width
+= thick
;
21090 if (it
->end_of_box_run_p
)
21091 it
->pixel_width
+= thick
;
21094 /* If face has an overline, add the height of the overline
21095 (1 pixel) and a 1 pixel margin to the character height. */
21096 if (face
->overline_p
)
21097 it
->ascent
+= overline_margin
;
21099 if (it
->constrain_row_ascent_descent_p
)
21101 if (it
->ascent
> it
->max_ascent
)
21102 it
->ascent
= it
->max_ascent
;
21103 if (it
->descent
> it
->max_descent
)
21104 it
->descent
= it
->max_descent
;
21107 take_vertical_position_into_account (it
);
21109 /* If we have to actually produce glyphs, do it. */
21114 /* Translate a space with a `space-width' property
21115 into a stretch glyph. */
21116 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
21117 / FONT_HEIGHT (font
));
21118 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
21119 it
->ascent
+ it
->descent
, ascent
);
21124 /* If characters with lbearing or rbearing are displayed
21125 in this line, record that fact in a flag of the
21126 glyph row. This is used to optimize X output code. */
21127 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
21128 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21130 if (! stretched_p
&& it
->pixel_width
== 0)
21131 /* We assure that all visible glyphs have at least 1-pixel
21133 it
->pixel_width
= 1;
21135 else if (it
->char_to_display
== '\n')
21137 /* A newline has no width but we need the height of the line.
21138 But if previous part of the line set a height, don't
21139 increase that height */
21141 Lisp_Object height
;
21142 Lisp_Object total_height
= Qnil
;
21144 it
->override_ascent
= -1;
21145 it
->pixel_width
= 0;
21148 height
= get_it_property(it
, Qline_height
);
21149 /* Split (line-height total-height) list */
21151 && CONSP (XCDR (height
))
21152 && NILP (XCDR (XCDR (height
))))
21154 total_height
= XCAR (XCDR (height
));
21155 height
= XCAR (height
);
21157 height
= calc_line_height_property(it
, height
, font
, boff
, 1);
21159 if (it
->override_ascent
>= 0)
21161 it
->ascent
= it
->override_ascent
;
21162 it
->descent
= it
->override_descent
;
21163 boff
= it
->override_boff
;
21167 it
->ascent
= FONT_BASE (font
) + boff
;
21168 it
->descent
= FONT_DESCENT (font
) - boff
;
21171 if (EQ (height
, Qt
))
21173 if (it
->descent
> it
->max_descent
)
21175 it
->ascent
+= it
->descent
- it
->max_descent
;
21176 it
->descent
= it
->max_descent
;
21178 if (it
->ascent
> it
->max_ascent
)
21180 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
21181 it
->ascent
= it
->max_ascent
;
21183 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
21184 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
21185 it
->constrain_row_ascent_descent_p
= 1;
21186 extra_line_spacing
= 0;
21190 Lisp_Object spacing
;
21192 it
->phys_ascent
= it
->ascent
;
21193 it
->phys_descent
= it
->descent
;
21195 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
21196 && face
->box
!= FACE_NO_BOX
21197 && face
->box_line_width
> 0)
21199 it
->ascent
+= face
->box_line_width
;
21200 it
->descent
+= face
->box_line_width
;
21203 && XINT (height
) > it
->ascent
+ it
->descent
)
21204 it
->ascent
= XINT (height
) - it
->descent
;
21206 if (!NILP (total_height
))
21207 spacing
= calc_line_height_property(it
, total_height
, font
, boff
, 0);
21210 spacing
= get_it_property(it
, Qline_spacing
);
21211 spacing
= calc_line_height_property(it
, spacing
, font
, boff
, 0);
21213 if (INTEGERP (spacing
))
21215 extra_line_spacing
= XINT (spacing
);
21216 if (!NILP (total_height
))
21217 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
21221 else if (it
->char_to_display
== '\t')
21223 int tab_width
= it
->tab_width
* font
->space_width
;
21224 int x
= it
->current_x
+ it
->continuation_lines_width
;
21225 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
21227 /* If the distance from the current position to the next tab
21228 stop is less than a space character width, use the
21229 tab stop after that. */
21230 if (next_tab_x
- x
< font
->space_width
)
21231 next_tab_x
+= tab_width
;
21233 it
->pixel_width
= next_tab_x
- x
;
21235 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
21236 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
21240 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
21241 it
->ascent
+ it
->descent
, it
->ascent
);
21246 /* A multi-byte character. Assume that the display width of the
21247 character is the width of the character multiplied by the
21248 width of the font. */
21250 /* If we found a font, this font should give us the right
21251 metrics. If we didn't find a font, use the frame's
21252 default font and calculate the width of the character by
21253 multiplying the width of font by the width of the
21256 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21258 if (font_not_found_p
|| !pcm
)
21260 int char_width
= CHAR_WIDTH (it
->char_to_display
);
21262 if (char_width
== 0)
21263 /* This is a non spacing character. But, as we are
21264 going to display an empty box, the box must occupy
21265 at least one column. */
21267 it
->glyph_not_available_p
= 1;
21268 it
->pixel_width
= FRAME_COLUMN_WIDTH (it
->f
) * char_width
;
21269 it
->phys_ascent
= FONT_BASE (font
) + boff
;
21270 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
21274 it
->pixel_width
= pcm
->width
;
21275 it
->phys_ascent
= pcm
->ascent
+ boff
;
21276 it
->phys_descent
= pcm
->descent
- boff
;
21278 && (pcm
->lbearing
< 0
21279 || pcm
->rbearing
> pcm
->width
))
21280 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21283 it
->ascent
= FONT_BASE (font
) + boff
;
21284 it
->descent
= FONT_DESCENT (font
) - boff
;
21285 if (face
->box
!= FACE_NO_BOX
)
21287 int thick
= face
->box_line_width
;
21291 it
->ascent
+= thick
;
21292 it
->descent
+= thick
;
21297 if (it
->start_of_box_run_p
)
21298 it
->pixel_width
+= thick
;
21299 if (it
->end_of_box_run_p
)
21300 it
->pixel_width
+= thick
;
21303 /* If face has an overline, add the height of the overline
21304 (1 pixel) and a 1 pixel margin to the character height. */
21305 if (face
->overline_p
)
21306 it
->ascent
+= overline_margin
;
21308 take_vertical_position_into_account (it
);
21310 if (it
->ascent
< 0)
21312 if (it
->descent
< 0)
21317 if (it
->pixel_width
== 0)
21318 /* We assure that all visible glyphs have at least 1-pixel
21320 it
->pixel_width
= 1;
21322 it
->multibyte_p
= saved_multibyte_p
;
21324 else if (it
->what
== IT_COMPOSITION
)
21326 /* Note: A composition is represented as one glyph in the
21327 glyph matrix. There are no padding glyphs.
21329 Important is that pixel_width, ascent, and descent are the
21330 values of what is drawn by draw_glyphs (i.e. the values of
21331 the overall glyphs composed). */
21332 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21333 int boff
; /* baseline offset */
21334 struct composition
*cmp
= composition_table
[it
->cmp_id
];
21335 int glyph_len
= cmp
->glyph_len
;
21336 struct font
*font
= face
->font
;
21340 if (cmp
->method
== COMPOSITION_WITH_GLYPH_STRING
)
21342 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21343 font_prepare_composition (cmp
, it
->f
);
21346 /* If we have not yet calculated pixel size data of glyphs of
21347 the composition for the current face font, calculate them
21348 now. Theoretically, we have to check all fonts for the
21349 glyphs, but that requires much time and memory space. So,
21350 here we check only the font of the first glyph. This leads
21351 to incorrect display, but it's very rare, and C-l (recenter)
21352 can correct the display anyway. */
21353 if (! cmp
->font
|| cmp
->font
!= font
)
21355 /* Ascent and descent of the font of the first character
21356 of this composition (adjusted by baseline offset).
21357 Ascent and descent of overall glyphs should not be less
21358 than them respectively. */
21359 int font_ascent
, font_descent
, font_height
;
21360 /* Bounding box of the overall glyphs. */
21361 int leftmost
, rightmost
, lowest
, highest
;
21362 int lbearing
, rbearing
;
21363 int i
, width
, ascent
, descent
;
21364 int left_padded
= 0, right_padded
= 0;
21368 struct font_metrics
*pcm
;
21369 int font_not_found_p
;
21372 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
21373 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
21375 if (glyph_len
< cmp
->glyph_len
)
21377 for (i
= 0; i
< glyph_len
; i
++)
21379 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
21381 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
21386 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
21387 : IT_CHARPOS (*it
));
21388 /* When no suitable font found, use the default font. */
21389 font_not_found_p
= font
== NULL
;
21390 if (font_not_found_p
)
21392 face
= face
->ascii_face
;
21395 boff
= font
->baseline_offset
;
21396 if (font
->vertical_centering
)
21397 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21398 font_ascent
= FONT_BASE (font
) + boff
;
21399 font_descent
= FONT_DESCENT (font
) - boff
;
21400 font_height
= FONT_HEIGHT (font
);
21402 cmp
->font
= (void *) font
;
21405 if (! font_not_found_p
)
21407 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
21408 &char2b
, it
->multibyte_p
, 0);
21409 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21412 /* Initialize the bounding box. */
21415 width
= pcm
->width
;
21416 ascent
= pcm
->ascent
;
21417 descent
= pcm
->descent
;
21418 lbearing
= pcm
->lbearing
;
21419 rbearing
= pcm
->rbearing
;
21423 width
= FONT_WIDTH (font
);
21424 ascent
= FONT_BASE (font
);
21425 descent
= FONT_DESCENT (font
);
21432 lowest
= - descent
+ boff
;
21433 highest
= ascent
+ boff
;
21435 if (! font_not_found_p
21436 && font
->default_ascent
21437 && CHAR_TABLE_P (Vuse_default_ascent
)
21438 && !NILP (Faref (Vuse_default_ascent
,
21439 make_number (it
->char_to_display
))))
21440 highest
= font
->default_ascent
+ boff
;
21442 /* Draw the first glyph at the normal position. It may be
21443 shifted to right later if some other glyphs are drawn
21445 cmp
->offsets
[i
* 2] = 0;
21446 cmp
->offsets
[i
* 2 + 1] = boff
;
21447 cmp
->lbearing
= lbearing
;
21448 cmp
->rbearing
= rbearing
;
21450 /* Set cmp->offsets for the remaining glyphs. */
21451 for (i
++; i
< glyph_len
; i
++)
21453 int left
, right
, btm
, top
;
21454 int ch
= COMPOSITION_GLYPH (cmp
, i
);
21456 struct face
*this_face
;
21461 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
21462 this_face
= FACE_FROM_ID (it
->f
, face_id
);
21463 font
= this_face
->font
;
21469 this_boff
= font
->baseline_offset
;
21470 if (font
->vertical_centering
)
21471 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21472 get_char_face_and_encoding (it
->f
, ch
, face_id
,
21473 &char2b
, it
->multibyte_p
, 0);
21474 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21477 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
21480 width
= pcm
->width
;
21481 ascent
= pcm
->ascent
;
21482 descent
= pcm
->descent
;
21483 lbearing
= pcm
->lbearing
;
21484 rbearing
= pcm
->rbearing
;
21485 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
21487 /* Relative composition with or without
21488 alternate chars. */
21489 left
= (leftmost
+ rightmost
- width
) / 2;
21490 btm
= - descent
+ boff
;
21491 if (font
->relative_compose
21492 && (! CHAR_TABLE_P (Vignore_relative_composition
)
21493 || NILP (Faref (Vignore_relative_composition
,
21494 make_number (ch
)))))
21497 if (- descent
>= font
->relative_compose
)
21498 /* One extra pixel between two glyphs. */
21500 else if (ascent
<= 0)
21501 /* One extra pixel between two glyphs. */
21502 btm
= lowest
- 1 - ascent
- descent
;
21507 /* A composition rule is specified by an integer
21508 value that encodes global and new reference
21509 points (GREF and NREF). GREF and NREF are
21510 specified by numbers as below:
21512 0---1---2 -- ascent
21516 9--10--11 -- center
21518 ---3---4---5--- baseline
21520 6---7---8 -- descent
21522 int rule
= COMPOSITION_RULE (cmp
, i
);
21523 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
21525 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
21526 grefx
= gref
% 3, nrefx
= nref
% 3;
21527 grefy
= gref
/ 3, nrefy
= nref
/ 3;
21529 xoff
= font_height
* (xoff
- 128) / 256;
21531 yoff
= font_height
* (yoff
- 128) / 256;
21534 + grefx
* (rightmost
- leftmost
) / 2
21535 - nrefx
* width
/ 2
21538 btm
= ((grefy
== 0 ? highest
21540 : grefy
== 2 ? lowest
21541 : (highest
+ lowest
) / 2)
21542 - (nrefy
== 0 ? ascent
+ descent
21543 : nrefy
== 1 ? descent
- boff
21545 : (ascent
+ descent
) / 2)
21549 cmp
->offsets
[i
* 2] = left
;
21550 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
21552 /* Update the bounding box of the overall glyphs. */
21555 right
= left
+ width
;
21556 if (left
< leftmost
)
21558 if (right
> rightmost
)
21561 top
= btm
+ descent
+ ascent
;
21567 if (cmp
->lbearing
> left
+ lbearing
)
21568 cmp
->lbearing
= left
+ lbearing
;
21569 if (cmp
->rbearing
< left
+ rbearing
)
21570 cmp
->rbearing
= left
+ rbearing
;
21574 /* If there are glyphs whose x-offsets are negative,
21575 shift all glyphs to the right and make all x-offsets
21579 for (i
= 0; i
< cmp
->glyph_len
; i
++)
21580 cmp
->offsets
[i
* 2] -= leftmost
;
21581 rightmost
-= leftmost
;
21582 cmp
->lbearing
-= leftmost
;
21583 cmp
->rbearing
-= leftmost
;
21586 if (left_padded
&& cmp
->lbearing
< 0)
21588 for (i
= 0; i
< cmp
->glyph_len
; i
++)
21589 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
21590 rightmost
-= cmp
->lbearing
;
21591 cmp
->rbearing
-= cmp
->lbearing
;
21594 if (right_padded
&& rightmost
< cmp
->rbearing
)
21596 rightmost
= cmp
->rbearing
;
21599 cmp
->pixel_width
= rightmost
;
21600 cmp
->ascent
= highest
;
21601 cmp
->descent
= - lowest
;
21602 if (cmp
->ascent
< font_ascent
)
21603 cmp
->ascent
= font_ascent
;
21604 if (cmp
->descent
< font_descent
)
21605 cmp
->descent
= font_descent
;
21609 && (cmp
->lbearing
< 0
21610 || cmp
->rbearing
> cmp
->pixel_width
))
21611 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21613 it
->pixel_width
= cmp
->pixel_width
;
21614 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
21615 it
->descent
= it
->phys_descent
= cmp
->descent
;
21616 if (face
->box
!= FACE_NO_BOX
)
21618 int thick
= face
->box_line_width
;
21622 it
->ascent
+= thick
;
21623 it
->descent
+= thick
;
21628 if (it
->start_of_box_run_p
)
21629 it
->pixel_width
+= thick
;
21630 if (it
->end_of_box_run_p
)
21631 it
->pixel_width
+= thick
;
21634 /* If face has an overline, add the height of the overline
21635 (1 pixel) and a 1 pixel margin to the character height. */
21636 if (face
->overline_p
)
21637 it
->ascent
+= overline_margin
;
21639 take_vertical_position_into_account (it
);
21640 if (it
->ascent
< 0)
21642 if (it
->descent
< 0)
21646 append_composite_glyph (it
);
21648 else if (it
->what
== IT_IMAGE
)
21649 produce_image_glyph (it
);
21650 else if (it
->what
== IT_STRETCH
)
21651 produce_stretch_glyph (it
);
21653 /* Accumulate dimensions. Note: can't assume that it->descent > 0
21654 because this isn't true for images with `:ascent 100'. */
21655 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
21656 if (it
->area
== TEXT_AREA
)
21657 it
->current_x
+= it
->pixel_width
;
21659 if (extra_line_spacing
> 0)
21661 it
->descent
+= extra_line_spacing
;
21662 if (extra_line_spacing
> it
->max_extra_line_spacing
)
21663 it
->max_extra_line_spacing
= extra_line_spacing
;
21666 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
21667 it
->max_descent
= max (it
->max_descent
, it
->descent
);
21668 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
21669 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
21673 Output LEN glyphs starting at START at the nominal cursor position.
21674 Advance the nominal cursor over the text. The global variable
21675 updated_window contains the window being updated, updated_row is
21676 the glyph row being updated, and updated_area is the area of that
21677 row being updated. */
21680 x_write_glyphs (start
, len
)
21681 struct glyph
*start
;
21686 xassert (updated_window
&& updated_row
);
21689 /* Write glyphs. */
21691 hpos
= start
- updated_row
->glyphs
[updated_area
];
21692 x
= draw_glyphs (updated_window
, output_cursor
.x
,
21693 updated_row
, updated_area
,
21695 DRAW_NORMAL_TEXT
, 0);
21697 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
21698 if (updated_area
== TEXT_AREA
21699 && updated_window
->phys_cursor_on_p
21700 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
21701 && updated_window
->phys_cursor
.hpos
>= hpos
21702 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
21703 updated_window
->phys_cursor_on_p
= 0;
21707 /* Advance the output cursor. */
21708 output_cursor
.hpos
+= len
;
21709 output_cursor
.x
= x
;
21714 Insert LEN glyphs from START at the nominal cursor position. */
21717 x_insert_glyphs (start
, len
)
21718 struct glyph
*start
;
21723 int line_height
, shift_by_width
, shifted_region_width
;
21724 struct glyph_row
*row
;
21725 struct glyph
*glyph
;
21726 int frame_x
, frame_y
;
21729 xassert (updated_window
&& updated_row
);
21731 w
= updated_window
;
21732 f
= XFRAME (WINDOW_FRAME (w
));
21734 /* Get the height of the line we are in. */
21736 line_height
= row
->height
;
21738 /* Get the width of the glyphs to insert. */
21739 shift_by_width
= 0;
21740 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
21741 shift_by_width
+= glyph
->pixel_width
;
21743 /* Get the width of the region to shift right. */
21744 shifted_region_width
= (window_box_width (w
, updated_area
)
21749 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
21750 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
21752 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
21753 line_height
, shift_by_width
);
21755 /* Write the glyphs. */
21756 hpos
= start
- row
->glyphs
[updated_area
];
21757 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
21759 DRAW_NORMAL_TEXT
, 0);
21761 /* Advance the output cursor. */
21762 output_cursor
.hpos
+= len
;
21763 output_cursor
.x
+= shift_by_width
;
21769 Erase the current text line from the nominal cursor position
21770 (inclusive) to pixel column TO_X (exclusive). The idea is that
21771 everything from TO_X onward is already erased.
21773 TO_X is a pixel position relative to updated_area of
21774 updated_window. TO_X == -1 means clear to the end of this area. */
21777 x_clear_end_of_line (to_x
)
21781 struct window
*w
= updated_window
;
21782 int max_x
, min_y
, max_y
;
21783 int from_x
, from_y
, to_y
;
21785 xassert (updated_window
&& updated_row
);
21786 f
= XFRAME (w
->frame
);
21788 if (updated_row
->full_width_p
)
21789 max_x
= WINDOW_TOTAL_WIDTH (w
);
21791 max_x
= window_box_width (w
, updated_area
);
21792 max_y
= window_text_bottom_y (w
);
21794 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
21795 of window. For TO_X > 0, truncate to end of drawing area. */
21801 to_x
= min (to_x
, max_x
);
21803 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
21805 /* Notice if the cursor will be cleared by this operation. */
21806 if (!updated_row
->full_width_p
)
21807 notice_overwritten_cursor (w
, updated_area
,
21808 output_cursor
.x
, -1,
21810 MATRIX_ROW_BOTTOM_Y (updated_row
));
21812 from_x
= output_cursor
.x
;
21814 /* Translate to frame coordinates. */
21815 if (updated_row
->full_width_p
)
21817 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
21818 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
21822 int area_left
= window_box_left (w
, updated_area
);
21823 from_x
+= area_left
;
21827 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
21828 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
21829 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
21831 /* Prevent inadvertently clearing to end of the X window. */
21832 if (to_x
> from_x
&& to_y
> from_y
)
21835 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
21836 to_x
- from_x
, to_y
- from_y
);
21841 #endif /* HAVE_WINDOW_SYSTEM */
21845 /***********************************************************************
21847 ***********************************************************************/
21849 /* Value is the internal representation of the specified cursor type
21850 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
21851 of the bar cursor. */
21853 static enum text_cursor_kinds
21854 get_specified_cursor_type (arg
, width
)
21858 enum text_cursor_kinds type
;
21863 if (EQ (arg
, Qbox
))
21864 return FILLED_BOX_CURSOR
;
21866 if (EQ (arg
, Qhollow
))
21867 return HOLLOW_BOX_CURSOR
;
21869 if (EQ (arg
, Qbar
))
21876 && EQ (XCAR (arg
), Qbar
)
21877 && INTEGERP (XCDR (arg
))
21878 && XINT (XCDR (arg
)) >= 0)
21880 *width
= XINT (XCDR (arg
));
21884 if (EQ (arg
, Qhbar
))
21887 return HBAR_CURSOR
;
21891 && EQ (XCAR (arg
), Qhbar
)
21892 && INTEGERP (XCDR (arg
))
21893 && XINT (XCDR (arg
)) >= 0)
21895 *width
= XINT (XCDR (arg
));
21896 return HBAR_CURSOR
;
21899 /* Treat anything unknown as "hollow box cursor".
21900 It was bad to signal an error; people have trouble fixing
21901 .Xdefaults with Emacs, when it has something bad in it. */
21902 type
= HOLLOW_BOX_CURSOR
;
21907 /* Set the default cursor types for specified frame. */
21909 set_frame_cursor_types (f
, arg
)
21916 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
21917 FRAME_CURSOR_WIDTH (f
) = width
;
21919 /* By default, set up the blink-off state depending on the on-state. */
21921 tem
= Fassoc (arg
, Vblink_cursor_alist
);
21924 FRAME_BLINK_OFF_CURSOR (f
)
21925 = get_specified_cursor_type (XCDR (tem
), &width
);
21926 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
21929 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
21933 /* Return the cursor we want to be displayed in window W. Return
21934 width of bar/hbar cursor through WIDTH arg. Return with
21935 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
21936 (i.e. if the `system caret' should track this cursor).
21938 In a mini-buffer window, we want the cursor only to appear if we
21939 are reading input from this window. For the selected window, we
21940 want the cursor type given by the frame parameter or buffer local
21941 setting of cursor-type. If explicitly marked off, draw no cursor.
21942 In all other cases, we want a hollow box cursor. */
21944 static enum text_cursor_kinds
21945 get_window_cursor_type (w
, glyph
, width
, active_cursor
)
21947 struct glyph
*glyph
;
21949 int *active_cursor
;
21951 struct frame
*f
= XFRAME (w
->frame
);
21952 struct buffer
*b
= XBUFFER (w
->buffer
);
21953 int cursor_type
= DEFAULT_CURSOR
;
21954 Lisp_Object alt_cursor
;
21955 int non_selected
= 0;
21957 *active_cursor
= 1;
21960 if (cursor_in_echo_area
21961 && FRAME_HAS_MINIBUF_P (f
)
21962 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
21964 if (w
== XWINDOW (echo_area_window
))
21966 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
21968 *width
= FRAME_CURSOR_WIDTH (f
);
21969 return FRAME_DESIRED_CURSOR (f
);
21972 return get_specified_cursor_type (b
->cursor_type
, width
);
21975 *active_cursor
= 0;
21979 /* Detect a nonselected window or nonselected frame. */
21980 else if (w
!= XWINDOW (f
->selected_window
)
21981 #ifdef HAVE_WINDOW_SYSTEM
21982 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
21986 *active_cursor
= 0;
21988 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
21994 /* Never display a cursor in a window in which cursor-type is nil. */
21995 if (NILP (b
->cursor_type
))
21998 /* Get the normal cursor type for this window. */
21999 if (EQ (b
->cursor_type
, Qt
))
22001 cursor_type
= FRAME_DESIRED_CURSOR (f
);
22002 *width
= FRAME_CURSOR_WIDTH (f
);
22005 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
22007 /* Use cursor-in-non-selected-windows instead
22008 for non-selected window or frame. */
22011 alt_cursor
= b
->cursor_in_non_selected_windows
;
22012 if (!EQ (Qt
, alt_cursor
))
22013 return get_specified_cursor_type (alt_cursor
, width
);
22014 /* t means modify the normal cursor type. */
22015 if (cursor_type
== FILLED_BOX_CURSOR
)
22016 cursor_type
= HOLLOW_BOX_CURSOR
;
22017 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
22019 return cursor_type
;
22022 /* Use normal cursor if not blinked off. */
22023 if (!w
->cursor_off_p
)
22025 #ifdef HAVE_WINDOW_SYSTEM
22026 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
22028 if (cursor_type
== FILLED_BOX_CURSOR
)
22030 /* Using a block cursor on large images can be very annoying.
22031 So use a hollow cursor for "large" images.
22032 If image is not transparent (no mask), also use hollow cursor. */
22033 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
22034 if (img
!= NULL
&& IMAGEP (img
->spec
))
22036 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
22037 where N = size of default frame font size.
22038 This should cover most of the "tiny" icons people may use. */
22040 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
22041 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
22042 cursor_type
= HOLLOW_BOX_CURSOR
;
22045 else if (cursor_type
!= NO_CURSOR
)
22047 /* Display current only supports BOX and HOLLOW cursors for images.
22048 So for now, unconditionally use a HOLLOW cursor when cursor is
22049 not a solid box cursor. */
22050 cursor_type
= HOLLOW_BOX_CURSOR
;
22054 return cursor_type
;
22057 /* Cursor is blinked off, so determine how to "toggle" it. */
22059 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
22060 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
22061 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
22063 /* Then see if frame has specified a specific blink off cursor type. */
22064 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
22066 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
22067 return FRAME_BLINK_OFF_CURSOR (f
);
22071 /* Some people liked having a permanently visible blinking cursor,
22072 while others had very strong opinions against it. So it was
22073 decided to remove it. KFS 2003-09-03 */
22075 /* Finally perform built-in cursor blinking:
22076 filled box <-> hollow box
22077 wide [h]bar <-> narrow [h]bar
22078 narrow [h]bar <-> no cursor
22079 other type <-> no cursor */
22081 if (cursor_type
== FILLED_BOX_CURSOR
)
22082 return HOLLOW_BOX_CURSOR
;
22084 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
22087 return cursor_type
;
22095 #ifdef HAVE_WINDOW_SYSTEM
22097 /* Notice when the text cursor of window W has been completely
22098 overwritten by a drawing operation that outputs glyphs in AREA
22099 starting at X0 and ending at X1 in the line starting at Y0 and
22100 ending at Y1. X coordinates are area-relative. X1 < 0 means all
22101 the rest of the line after X0 has been written. Y coordinates
22102 are window-relative. */
22105 notice_overwritten_cursor (w
, area
, x0
, x1
, y0
, y1
)
22107 enum glyph_row_area area
;
22108 int x0
, y0
, x1
, y1
;
22110 int cx0
, cx1
, cy0
, cy1
;
22111 struct glyph_row
*row
;
22113 if (!w
->phys_cursor_on_p
)
22115 if (area
!= TEXT_AREA
)
22118 if (w
->phys_cursor
.vpos
< 0
22119 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
22120 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
22121 !(row
->enabled_p
&& row
->displays_text_p
)))
22124 if (row
->cursor_in_fringe_p
)
22126 row
->cursor_in_fringe_p
= 0;
22127 draw_fringe_bitmap (w
, row
, 0);
22128 w
->phys_cursor_on_p
= 0;
22132 cx0
= w
->phys_cursor
.x
;
22133 cx1
= cx0
+ w
->phys_cursor_width
;
22134 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
22137 /* The cursor image will be completely removed from the
22138 screen if the output area intersects the cursor area in
22139 y-direction. When we draw in [y0 y1[, and some part of
22140 the cursor is at y < y0, that part must have been drawn
22141 before. When scrolling, the cursor is erased before
22142 actually scrolling, so we don't come here. When not
22143 scrolling, the rows above the old cursor row must have
22144 changed, and in this case these rows must have written
22145 over the cursor image.
22147 Likewise if part of the cursor is below y1, with the
22148 exception of the cursor being in the first blank row at
22149 the buffer and window end because update_text_area
22150 doesn't draw that row. (Except when it does, but
22151 that's handled in update_text_area.) */
22153 cy0
= w
->phys_cursor
.y
;
22154 cy1
= cy0
+ w
->phys_cursor_height
;
22155 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
22158 w
->phys_cursor_on_p
= 0;
22161 #endif /* HAVE_WINDOW_SYSTEM */
22164 /************************************************************************
22166 ************************************************************************/
22168 #ifdef HAVE_WINDOW_SYSTEM
22171 Fix the display of area AREA of overlapping row ROW in window W
22172 with respect to the overlapping part OVERLAPS. */
22175 x_fix_overlapping_area (w
, row
, area
, overlaps
)
22177 struct glyph_row
*row
;
22178 enum glyph_row_area area
;
22186 for (i
= 0; i
< row
->used
[area
];)
22188 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
22190 int start
= i
, start_x
= x
;
22194 x
+= row
->glyphs
[area
][i
].pixel_width
;
22197 while (i
< row
->used
[area
]
22198 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
22200 draw_glyphs (w
, start_x
, row
, area
,
22202 DRAW_NORMAL_TEXT
, overlaps
);
22206 x
+= row
->glyphs
[area
][i
].pixel_width
;
22216 Draw the cursor glyph of window W in glyph row ROW. See the
22217 comment of draw_glyphs for the meaning of HL. */
22220 draw_phys_cursor_glyph (w
, row
, hl
)
22222 struct glyph_row
*row
;
22223 enum draw_glyphs_face hl
;
22225 /* If cursor hpos is out of bounds, don't draw garbage. This can
22226 happen in mini-buffer windows when switching between echo area
22227 glyphs and mini-buffer. */
22228 if (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])
22230 int on_p
= w
->phys_cursor_on_p
;
22232 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
22233 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
22235 w
->phys_cursor_on_p
= on_p
;
22237 if (hl
== DRAW_CURSOR
)
22238 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
22239 /* When we erase the cursor, and ROW is overlapped by other
22240 rows, make sure that these overlapping parts of other rows
22242 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
22244 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
22246 if (row
> w
->current_matrix
->rows
22247 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
22248 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
22249 OVERLAPS_ERASED_CURSOR
);
22251 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
22252 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
22253 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
22254 OVERLAPS_ERASED_CURSOR
);
22261 Erase the image of a cursor of window W from the screen. */
22264 erase_phys_cursor (w
)
22267 struct frame
*f
= XFRAME (w
->frame
);
22268 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
22269 int hpos
= w
->phys_cursor
.hpos
;
22270 int vpos
= w
->phys_cursor
.vpos
;
22271 int mouse_face_here_p
= 0;
22272 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
22273 struct glyph_row
*cursor_row
;
22274 struct glyph
*cursor_glyph
;
22275 enum draw_glyphs_face hl
;
22277 /* No cursor displayed or row invalidated => nothing to do on the
22279 if (w
->phys_cursor_type
== NO_CURSOR
)
22280 goto mark_cursor_off
;
22282 /* VPOS >= active_glyphs->nrows means that window has been resized.
22283 Don't bother to erase the cursor. */
22284 if (vpos
>= active_glyphs
->nrows
)
22285 goto mark_cursor_off
;
22287 /* If row containing cursor is marked invalid, there is nothing we
22289 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
22290 if (!cursor_row
->enabled_p
)
22291 goto mark_cursor_off
;
22293 /* If line spacing is > 0, old cursor may only be partially visible in
22294 window after split-window. So adjust visible height. */
22295 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
22296 window_text_bottom_y (w
) - cursor_row
->y
);
22298 /* If row is completely invisible, don't attempt to delete a cursor which
22299 isn't there. This can happen if cursor is at top of a window, and
22300 we switch to a buffer with a header line in that window. */
22301 if (cursor_row
->visible_height
<= 0)
22302 goto mark_cursor_off
;
22304 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
22305 if (cursor_row
->cursor_in_fringe_p
)
22307 cursor_row
->cursor_in_fringe_p
= 0;
22308 draw_fringe_bitmap (w
, cursor_row
, 0);
22309 goto mark_cursor_off
;
22312 /* This can happen when the new row is shorter than the old one.
22313 In this case, either draw_glyphs or clear_end_of_line
22314 should have cleared the cursor. Note that we wouldn't be
22315 able to erase the cursor in this case because we don't have a
22316 cursor glyph at hand. */
22317 if (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])
22318 goto mark_cursor_off
;
22320 /* If the cursor is in the mouse face area, redisplay that when
22321 we clear the cursor. */
22322 if (! NILP (dpyinfo
->mouse_face_window
)
22323 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
22324 && (vpos
> dpyinfo
->mouse_face_beg_row
22325 || (vpos
== dpyinfo
->mouse_face_beg_row
22326 && hpos
>= dpyinfo
->mouse_face_beg_col
))
22327 && (vpos
< dpyinfo
->mouse_face_end_row
22328 || (vpos
== dpyinfo
->mouse_face_end_row
22329 && hpos
< dpyinfo
->mouse_face_end_col
))
22330 /* Don't redraw the cursor's spot in mouse face if it is at the
22331 end of a line (on a newline). The cursor appears there, but
22332 mouse highlighting does not. */
22333 && cursor_row
->used
[TEXT_AREA
] > hpos
)
22334 mouse_face_here_p
= 1;
22336 /* Maybe clear the display under the cursor. */
22337 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
22340 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
22343 cursor_glyph
= get_phys_cursor_glyph (w
);
22344 if (cursor_glyph
== NULL
)
22345 goto mark_cursor_off
;
22347 width
= cursor_glyph
->pixel_width
;
22348 left_x
= window_box_left_offset (w
, TEXT_AREA
);
22349 x
= w
->phys_cursor
.x
;
22351 width
-= left_x
- x
;
22352 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
22353 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
22354 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
22357 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
22360 /* Erase the cursor by redrawing the character underneath it. */
22361 if (mouse_face_here_p
)
22362 hl
= DRAW_MOUSE_FACE
;
22364 hl
= DRAW_NORMAL_TEXT
;
22365 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
22368 w
->phys_cursor_on_p
= 0;
22369 w
->phys_cursor_type
= NO_CURSOR
;
22374 Display or clear cursor of window W. If ON is zero, clear the
22375 cursor. If it is non-zero, display the cursor. If ON is nonzero,
22376 where to put the cursor is specified by HPOS, VPOS, X and Y. */
22379 display_and_set_cursor (w
, on
, hpos
, vpos
, x
, y
)
22381 int on
, hpos
, vpos
, x
, y
;
22383 struct frame
*f
= XFRAME (w
->frame
);
22384 int new_cursor_type
;
22385 int new_cursor_width
;
22387 struct glyph_row
*glyph_row
;
22388 struct glyph
*glyph
;
22390 /* This is pointless on invisible frames, and dangerous on garbaged
22391 windows and frames; in the latter case, the frame or window may
22392 be in the midst of changing its size, and x and y may be off the
22394 if (! FRAME_VISIBLE_P (f
)
22395 || FRAME_GARBAGED_P (f
)
22396 || vpos
>= w
->current_matrix
->nrows
22397 || hpos
>= w
->current_matrix
->matrix_w
)
22400 /* If cursor is off and we want it off, return quickly. */
22401 if (!on
&& !w
->phys_cursor_on_p
)
22404 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
22405 /* If cursor row is not enabled, we don't really know where to
22406 display the cursor. */
22407 if (!glyph_row
->enabled_p
)
22409 w
->phys_cursor_on_p
= 0;
22414 if (!glyph_row
->exact_window_width_line_p
22415 || hpos
< glyph_row
->used
[TEXT_AREA
])
22416 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
22418 xassert (interrupt_input_blocked
);
22420 /* Set new_cursor_type to the cursor we want to be displayed. */
22421 new_cursor_type
= get_window_cursor_type (w
, glyph
,
22422 &new_cursor_width
, &active_cursor
);
22424 /* If cursor is currently being shown and we don't want it to be or
22425 it is in the wrong place, or the cursor type is not what we want,
22427 if (w
->phys_cursor_on_p
22429 || w
->phys_cursor
.x
!= x
22430 || w
->phys_cursor
.y
!= y
22431 || new_cursor_type
!= w
->phys_cursor_type
22432 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
22433 && new_cursor_width
!= w
->phys_cursor_width
)))
22434 erase_phys_cursor (w
);
22436 /* Don't check phys_cursor_on_p here because that flag is only set
22437 to zero in some cases where we know that the cursor has been
22438 completely erased, to avoid the extra work of erasing the cursor
22439 twice. In other words, phys_cursor_on_p can be 1 and the cursor
22440 still not be visible, or it has only been partly erased. */
22443 w
->phys_cursor_ascent
= glyph_row
->ascent
;
22444 w
->phys_cursor_height
= glyph_row
->height
;
22446 /* Set phys_cursor_.* before x_draw_.* is called because some
22447 of them may need the information. */
22448 w
->phys_cursor
.x
= x
;
22449 w
->phys_cursor
.y
= glyph_row
->y
;
22450 w
->phys_cursor
.hpos
= hpos
;
22451 w
->phys_cursor
.vpos
= vpos
;
22454 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
22455 new_cursor_type
, new_cursor_width
,
22456 on
, active_cursor
);
22460 /* Switch the display of W's cursor on or off, according to the value
22464 update_window_cursor (w
, on
)
22468 /* Don't update cursor in windows whose frame is in the process
22469 of being deleted. */
22470 if (w
->current_matrix
)
22473 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
22474 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
22480 /* Call update_window_cursor with parameter ON_P on all leaf windows
22481 in the window tree rooted at W. */
22484 update_cursor_in_window_tree (w
, on_p
)
22490 if (!NILP (w
->hchild
))
22491 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
22492 else if (!NILP (w
->vchild
))
22493 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
22495 update_window_cursor (w
, on_p
);
22497 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
22503 Display the cursor on window W, or clear it, according to ON_P.
22504 Don't change the cursor's position. */
22507 x_update_cursor (f
, on_p
)
22511 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
22516 Clear the cursor of window W to background color, and mark the
22517 cursor as not shown. This is used when the text where the cursor
22518 is is about to be rewritten. */
22524 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
22525 update_window_cursor (w
, 0);
22530 Display the active region described by mouse_face_* according to DRAW. */
22533 show_mouse_face (dpyinfo
, draw
)
22534 Display_Info
*dpyinfo
;
22535 enum draw_glyphs_face draw
;
22537 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
22538 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22540 if (/* If window is in the process of being destroyed, don't bother
22542 w
->current_matrix
!= NULL
22543 /* Don't update mouse highlight if hidden */
22544 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
22545 /* Recognize when we are called to operate on rows that don't exist
22546 anymore. This can happen when a window is split. */
22547 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
22549 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
22550 struct glyph_row
*row
, *first
, *last
;
22552 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
22553 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
22555 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
22557 int start_hpos
, end_hpos
, start_x
;
22559 /* For all but the first row, the highlight starts at column 0. */
22562 start_hpos
= dpyinfo
->mouse_face_beg_col
;
22563 start_x
= dpyinfo
->mouse_face_beg_x
;
22572 end_hpos
= dpyinfo
->mouse_face_end_col
;
22575 end_hpos
= row
->used
[TEXT_AREA
];
22576 if (draw
== DRAW_NORMAL_TEXT
)
22577 row
->fill_line_p
= 1; /* Clear to end of line */
22580 if (end_hpos
> start_hpos
)
22582 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
22583 start_hpos
, end_hpos
,
22587 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
22591 /* When we've written over the cursor, arrange for it to
22592 be displayed again. */
22593 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
22596 display_and_set_cursor (w
, 1,
22597 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
22598 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
22603 /* Change the mouse cursor. */
22604 if (draw
== DRAW_NORMAL_TEXT
&& !EQ (dpyinfo
->mouse_face_window
, f
->tool_bar_window
))
22605 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
22606 else if (draw
== DRAW_MOUSE_FACE
)
22607 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
22609 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
22613 Clear out the mouse-highlighted active region.
22614 Redraw it un-highlighted first. Value is non-zero if mouse
22615 face was actually drawn unhighlighted. */
22618 clear_mouse_face (dpyinfo
)
22619 Display_Info
*dpyinfo
;
22623 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
22625 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
22629 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
22630 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
22631 dpyinfo
->mouse_face_window
= Qnil
;
22632 dpyinfo
->mouse_face_overlay
= Qnil
;
22638 Non-zero if physical cursor of window W is within mouse face. */
22641 cursor_in_mouse_face_p (w
)
22644 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
22645 int in_mouse_face
= 0;
22647 if (WINDOWP (dpyinfo
->mouse_face_window
)
22648 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
22650 int hpos
= w
->phys_cursor
.hpos
;
22651 int vpos
= w
->phys_cursor
.vpos
;
22653 if (vpos
>= dpyinfo
->mouse_face_beg_row
22654 && vpos
<= dpyinfo
->mouse_face_end_row
22655 && (vpos
> dpyinfo
->mouse_face_beg_row
22656 || hpos
>= dpyinfo
->mouse_face_beg_col
)
22657 && (vpos
< dpyinfo
->mouse_face_end_row
22658 || hpos
< dpyinfo
->mouse_face_end_col
22659 || dpyinfo
->mouse_face_past_end
))
22663 return in_mouse_face
;
22669 /* Find the glyph matrix position of buffer position CHARPOS in window
22670 *W. HPOS, *VPOS, *X, and *Y are set to the positions found. W's
22671 current glyphs must be up to date. If CHARPOS is above window
22672 start return (0, 0, 0, 0). If CHARPOS is after end of W, return end
22673 of last line in W. In the row containing CHARPOS, stop before glyphs
22674 having STOP as object. */
22676 #if 1 /* This is a version of fast_find_position that's more correct
22677 in the presence of hscrolling, for example. I didn't install
22678 it right away because the problem fixed is minor, it failed
22679 in 20.x as well, and I think it's too risky to install
22680 so near the release of 21.1. 2001-09-25 gerd. */
22682 #ifndef HAVE_CARBON
22686 fast_find_position (w
, charpos
, hpos
, vpos
, x
, y
, stop
)
22689 int *hpos
, *vpos
, *x
, *y
;
22692 struct glyph_row
*row
, *first
;
22693 struct glyph
*glyph
, *end
;
22696 first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22697 if (charpos
< MATRIX_ROW_START_CHARPOS (first
))
22702 *vpos
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
22706 row
= row_containing_pos (w
, charpos
, first
, NULL
, 0);
22709 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
22713 /* If whole rows or last part of a row came from a display overlay,
22714 row_containing_pos will skip over such rows because their end pos
22715 equals the start pos of the overlay or interval.
22717 Move back if we have a STOP object and previous row's
22718 end glyph came from STOP. */
22721 struct glyph_row
*prev
;
22722 while ((prev
= row
- 1, prev
>= first
)
22723 && MATRIX_ROW_END_CHARPOS (prev
) == charpos
22724 && prev
->used
[TEXT_AREA
] > 0)
22726 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
22727 glyph
= beg
+ prev
->used
[TEXT_AREA
];
22728 while (--glyph
>= beg
22729 && INTEGERP (glyph
->object
));
22731 || !EQ (stop
, glyph
->object
))
22739 *vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
22741 glyph
= row
->glyphs
[TEXT_AREA
];
22742 end
= glyph
+ row
->used
[TEXT_AREA
];
22744 /* Skip over glyphs not having an object at the start of the row.
22745 These are special glyphs like truncation marks on terminal
22747 if (row
->displays_text_p
)
22749 && INTEGERP (glyph
->object
)
22750 && !EQ (stop
, glyph
->object
)
22751 && glyph
->charpos
< 0)
22753 *x
+= glyph
->pixel_width
;
22758 && !INTEGERP (glyph
->object
)
22759 && !EQ (stop
, glyph
->object
)
22760 && (!BUFFERP (glyph
->object
)
22761 || glyph
->charpos
< charpos
))
22763 *x
+= glyph
->pixel_width
;
22767 *hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
22774 fast_find_position (w
, pos
, hpos
, vpos
, x
, y
, stop
)
22777 int *hpos
, *vpos
, *x
, *y
;
22782 int maybe_next_line_p
= 0;
22783 int line_start_position
;
22784 int yb
= window_text_bottom_y (w
);
22785 struct glyph_row
*row
, *best_row
;
22786 int row_vpos
, best_row_vpos
;
22789 row
= best_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22790 row_vpos
= best_row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
22792 while (row
->y
< yb
)
22794 if (row
->used
[TEXT_AREA
])
22795 line_start_position
= row
->glyphs
[TEXT_AREA
]->charpos
;
22797 line_start_position
= 0;
22799 if (line_start_position
> pos
)
22801 /* If the position sought is the end of the buffer,
22802 don't include the blank lines at the bottom of the window. */
22803 else if (line_start_position
== pos
22804 && pos
== BUF_ZV (XBUFFER (w
->buffer
)))
22806 maybe_next_line_p
= 1;
22809 else if (line_start_position
> 0)
22812 best_row_vpos
= row_vpos
;
22815 if (row
->y
+ row
->height
>= yb
)
22822 /* Find the right column within BEST_ROW. */
22824 current_x
= best_row
->x
;
22825 for (i
= 0; i
< best_row
->used
[TEXT_AREA
]; i
++)
22827 struct glyph
*glyph
= best_row
->glyphs
[TEXT_AREA
] + i
;
22828 int charpos
= glyph
->charpos
;
22830 if (BUFFERP (glyph
->object
))
22832 if (charpos
== pos
)
22835 *vpos
= best_row_vpos
;
22840 else if (charpos
> pos
)
22843 else if (EQ (glyph
->object
, stop
))
22848 current_x
+= glyph
->pixel_width
;
22851 /* If we're looking for the end of the buffer,
22852 and we didn't find it in the line we scanned,
22853 use the start of the following line. */
22854 if (maybe_next_line_p
)
22859 current_x
= best_row
->x
;
22862 *vpos
= best_row_vpos
;
22863 *hpos
= lastcol
+ 1;
22872 /* Find the position of the glyph for position POS in OBJECT in
22873 window W's current matrix, and return in *X, *Y the pixel
22874 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
22876 RIGHT_P non-zero means return the position of the right edge of the
22877 glyph, RIGHT_P zero means return the left edge position.
22879 If no glyph for POS exists in the matrix, return the position of
22880 the glyph with the next smaller position that is in the matrix, if
22881 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
22882 exists in the matrix, return the position of the glyph with the
22883 next larger position in OBJECT.
22885 Value is non-zero if a glyph was found. */
22888 fast_find_string_pos (w
, pos
, object
, hpos
, vpos
, x
, y
, right_p
)
22891 Lisp_Object object
;
22892 int *hpos
, *vpos
, *x
, *y
;
22895 int yb
= window_text_bottom_y (w
);
22896 struct glyph_row
*r
;
22897 struct glyph
*best_glyph
= NULL
;
22898 struct glyph_row
*best_row
= NULL
;
22901 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22902 r
->enabled_p
&& r
->y
< yb
;
22905 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
22906 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
22909 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
22910 if (EQ (g
->object
, object
))
22912 if (g
->charpos
== pos
)
22919 else if (best_glyph
== NULL
22920 || ((eabs (g
->charpos
- pos
)
22921 < eabs (best_glyph
->charpos
- pos
))
22924 : g
->charpos
> pos
)))
22938 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
22942 *x
+= best_glyph
->pixel_width
;
22947 *vpos
= best_row
- w
->current_matrix
->rows
;
22950 return best_glyph
!= NULL
;
22954 /* See if position X, Y is within a hot-spot of an image. */
22957 on_hot_spot_p (hot_spot
, x
, y
)
22958 Lisp_Object hot_spot
;
22961 if (!CONSP (hot_spot
))
22964 if (EQ (XCAR (hot_spot
), Qrect
))
22966 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
22967 Lisp_Object rect
= XCDR (hot_spot
);
22971 if (!CONSP (XCAR (rect
)))
22973 if (!CONSP (XCDR (rect
)))
22975 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
22977 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
22979 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
22981 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
22985 else if (EQ (XCAR (hot_spot
), Qcircle
))
22987 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
22988 Lisp_Object circ
= XCDR (hot_spot
);
22989 Lisp_Object lr
, lx0
, ly0
;
22991 && CONSP (XCAR (circ
))
22992 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
22993 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
22994 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
22996 double r
= XFLOATINT (lr
);
22997 double dx
= XINT (lx0
) - x
;
22998 double dy
= XINT (ly0
) - y
;
22999 return (dx
* dx
+ dy
* dy
<= r
* r
);
23002 else if (EQ (XCAR (hot_spot
), Qpoly
))
23004 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
23005 if (VECTORP (XCDR (hot_spot
)))
23007 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
23008 Lisp_Object
*poly
= v
->contents
;
23012 Lisp_Object lx
, ly
;
23015 /* Need an even number of coordinates, and at least 3 edges. */
23016 if (n
< 6 || n
& 1)
23019 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
23020 If count is odd, we are inside polygon. Pixels on edges
23021 may or may not be included depending on actual geometry of the
23023 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
23024 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
23026 x0
= XINT (lx
), y0
= XINT (ly
);
23027 for (i
= 0; i
< n
; i
+= 2)
23029 int x1
= x0
, y1
= y0
;
23030 if ((lx
= poly
[i
], !INTEGERP (lx
))
23031 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
23033 x0
= XINT (lx
), y0
= XINT (ly
);
23035 /* Does this segment cross the X line? */
23043 if (y
> y0
&& y
> y1
)
23045 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
23055 find_hot_spot (map
, x
, y
)
23059 while (CONSP (map
))
23061 if (CONSP (XCAR (map
))
23062 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
23070 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
23072 doc
: /* Lookup in image map MAP coordinates X and Y.
23073 An image map is an alist where each element has the format (AREA ID PLIST).
23074 An AREA is specified as either a rectangle, a circle, or a polygon:
23075 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
23076 pixel coordinates of the upper left and bottom right corners.
23077 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
23078 and the radius of the circle; r may be a float or integer.
23079 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
23080 vector describes one corner in the polygon.
23081 Returns the alist element for the first matching AREA in MAP. */)
23092 return find_hot_spot (map
, XINT (x
), XINT (y
));
23096 /* Display frame CURSOR, optionally using shape defined by POINTER. */
23098 define_frame_cursor1 (f
, cursor
, pointer
)
23101 Lisp_Object pointer
;
23103 /* Do not change cursor shape while dragging mouse. */
23104 if (!NILP (do_mouse_tracking
))
23107 if (!NILP (pointer
))
23109 if (EQ (pointer
, Qarrow
))
23110 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23111 else if (EQ (pointer
, Qhand
))
23112 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
23113 else if (EQ (pointer
, Qtext
))
23114 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
23115 else if (EQ (pointer
, intern ("hdrag")))
23116 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
23117 #ifdef HAVE_X_WINDOWS
23118 else if (EQ (pointer
, intern ("vdrag")))
23119 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
23121 else if (EQ (pointer
, intern ("hourglass")))
23122 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
23123 else if (EQ (pointer
, Qmodeline
))
23124 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
23126 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23129 if (cursor
!= No_Cursor
)
23130 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
23133 /* Take proper action when mouse has moved to the mode or header line
23134 or marginal area AREA of window W, x-position X and y-position Y.
23135 X is relative to the start of the text display area of W, so the
23136 width of bitmap areas and scroll bars must be subtracted to get a
23137 position relative to the start of the mode line. */
23140 note_mode_line_or_margin_highlight (window
, x
, y
, area
)
23141 Lisp_Object window
;
23143 enum window_part area
;
23145 struct window
*w
= XWINDOW (window
);
23146 struct frame
*f
= XFRAME (w
->frame
);
23147 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23148 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23149 Lisp_Object pointer
= Qnil
;
23150 int charpos
, dx
, dy
, width
, height
;
23151 Lisp_Object string
, object
= Qnil
;
23152 Lisp_Object pos
, help
;
23154 Lisp_Object mouse_face
;
23155 int original_x_pixel
= x
;
23156 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
23157 struct glyph_row
*row
;
23159 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
23164 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
23165 &object
, &dx
, &dy
, &width
, &height
);
23167 row
= (area
== ON_MODE_LINE
23168 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
23169 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
23172 if (row
->mode_line_p
&& row
->enabled_p
)
23174 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
23175 end
= glyph
+ row
->used
[TEXT_AREA
];
23177 for (x0
= original_x_pixel
;
23178 glyph
< end
&& x0
>= glyph
->pixel_width
;
23180 x0
-= glyph
->pixel_width
;
23188 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
23189 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
23190 &object
, &dx
, &dy
, &width
, &height
);
23195 if (IMAGEP (object
))
23197 Lisp_Object image_map
, hotspot
;
23198 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
23200 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
23202 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
23204 Lisp_Object area_id
, plist
;
23206 area_id
= XCAR (hotspot
);
23207 /* Could check AREA_ID to see if we enter/leave this hot-spot.
23208 If so, we could look for mouse-enter, mouse-leave
23209 properties in PLIST (and do something...). */
23210 hotspot
= XCDR (hotspot
);
23211 if (CONSP (hotspot
)
23212 && (plist
= XCAR (hotspot
), CONSP (plist
)))
23214 pointer
= Fplist_get (plist
, Qpointer
);
23215 if (NILP (pointer
))
23217 help
= Fplist_get (plist
, Qhelp_echo
);
23220 help_echo_string
= help
;
23221 /* Is this correct? ++kfs */
23222 XSETWINDOW (help_echo_window
, w
);
23223 help_echo_object
= w
->buffer
;
23224 help_echo_pos
= charpos
;
23228 if (NILP (pointer
))
23229 pointer
= Fplist_get (XCDR (object
), QCpointer
);
23232 if (STRINGP (string
))
23234 pos
= make_number (charpos
);
23235 /* If we're on a string with `help-echo' text property, arrange
23236 for the help to be displayed. This is done by setting the
23237 global variable help_echo_string to the help string. */
23240 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
23243 help_echo_string
= help
;
23244 XSETWINDOW (help_echo_window
, w
);
23245 help_echo_object
= string
;
23246 help_echo_pos
= charpos
;
23250 if (NILP (pointer
))
23251 pointer
= Fget_text_property (pos
, Qpointer
, string
);
23253 /* Change the mouse pointer according to what is under X/Y. */
23254 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
23257 map
= Fget_text_property (pos
, Qlocal_map
, string
);
23258 if (!KEYMAPP (map
))
23259 map
= Fget_text_property (pos
, Qkeymap
, string
);
23260 if (!KEYMAPP (map
))
23261 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
23264 /* Change the mouse face according to what is under X/Y. */
23265 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
23266 if (!NILP (mouse_face
)
23267 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
23272 struct glyph
* tmp_glyph
;
23276 int total_pixel_width
;
23281 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
23282 Qmouse_face
, string
, Qnil
);
23284 b
= make_number (0);
23286 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
23288 e
= make_number (SCHARS (string
));
23290 /* Calculate the position(glyph position: GPOS) of GLYPH in
23291 displayed string. GPOS is different from CHARPOS.
23293 CHARPOS is the position of glyph in internal string
23294 object. A mode line string format has structures which
23295 is converted to a flatten by emacs lisp interpreter.
23296 The internal string is an element of the structures.
23297 The displayed string is the flatten string. */
23299 if (glyph
> row_start_glyph
)
23301 tmp_glyph
= glyph
- 1;
23302 while (tmp_glyph
>= row_start_glyph
23303 && tmp_glyph
->charpos
>= XINT (b
)
23304 && EQ (tmp_glyph
->object
, glyph
->object
))
23311 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
23312 displayed string holding GLYPH.
23314 GSEQ_LENGTH is different from SCHARS (STRING).
23315 SCHARS (STRING) returns the length of the internal string. */
23316 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
23317 tmp_glyph
->charpos
< XINT (e
);
23318 tmp_glyph
++, gseq_length
++)
23320 if (!EQ (tmp_glyph
->object
, glyph
->object
))
23324 total_pixel_width
= 0;
23325 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
23326 total_pixel_width
+= tmp_glyph
->pixel_width
;
23328 /* Pre calculation of re-rendering position */
23330 hpos
= (area
== ON_MODE_LINE
23331 ? (w
->current_matrix
)->nrows
- 1
23334 /* If the re-rendering position is included in the last
23335 re-rendering area, we should do nothing. */
23336 if ( EQ (window
, dpyinfo
->mouse_face_window
)
23337 && dpyinfo
->mouse_face_beg_col
<= vpos
23338 && vpos
< dpyinfo
->mouse_face_end_col
23339 && dpyinfo
->mouse_face_beg_row
== hpos
)
23342 if (clear_mouse_face (dpyinfo
))
23343 cursor
= No_Cursor
;
23345 dpyinfo
->mouse_face_beg_col
= vpos
;
23346 dpyinfo
->mouse_face_beg_row
= hpos
;
23348 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
23349 dpyinfo
->mouse_face_beg_y
= 0;
23351 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
23352 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
23354 dpyinfo
->mouse_face_end_x
= 0;
23355 dpyinfo
->mouse_face_end_y
= 0;
23357 dpyinfo
->mouse_face_past_end
= 0;
23358 dpyinfo
->mouse_face_window
= window
;
23360 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
23363 glyph
->face_id
, 1);
23364 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23366 if (NILP (pointer
))
23369 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
23370 clear_mouse_face (dpyinfo
);
23372 define_frame_cursor1 (f
, cursor
, pointer
);
23377 Take proper action when the mouse has moved to position X, Y on
23378 frame F as regards highlighting characters that have mouse-face
23379 properties. Also de-highlighting chars where the mouse was before.
23380 X and Y can be negative or out of range. */
23383 note_mouse_highlight (f
, x
, y
)
23387 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23388 enum window_part part
;
23389 Lisp_Object window
;
23391 Cursor cursor
= No_Cursor
;
23392 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
23395 /* When a menu is active, don't highlight because this looks odd. */
23396 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (MAC_OS)
23397 if (popup_activated ())
23401 if (NILP (Vmouse_highlight
)
23402 || !f
->glyphs_initialized_p
)
23405 dpyinfo
->mouse_face_mouse_x
= x
;
23406 dpyinfo
->mouse_face_mouse_y
= y
;
23407 dpyinfo
->mouse_face_mouse_frame
= f
;
23409 if (dpyinfo
->mouse_face_defer
)
23412 if (gc_in_progress
)
23414 dpyinfo
->mouse_face_deferred_gc
= 1;
23418 /* Which window is that in? */
23419 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
23421 /* If we were displaying active text in another window, clear that.
23422 Also clear if we move out of text area in same window. */
23423 if (! EQ (window
, dpyinfo
->mouse_face_window
)
23424 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
23425 && !NILP (dpyinfo
->mouse_face_window
)))
23426 clear_mouse_face (dpyinfo
);
23428 /* Not on a window -> return. */
23429 if (!WINDOWP (window
))
23432 /* Reset help_echo_string. It will get recomputed below. */
23433 help_echo_string
= Qnil
;
23435 /* Convert to window-relative pixel coordinates. */
23436 w
= XWINDOW (window
);
23437 frame_to_window_pixel_xy (w
, &x
, &y
);
23439 /* Handle tool-bar window differently since it doesn't display a
23441 if (EQ (window
, f
->tool_bar_window
))
23443 note_tool_bar_highlight (f
, x
, y
);
23447 /* Mouse is on the mode, header line or margin? */
23448 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
23449 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
23451 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
23455 if (part
== ON_VERTICAL_BORDER
)
23457 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
23458 help_echo_string
= build_string ("drag-mouse-1: resize");
23460 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
23461 || part
== ON_SCROLL_BAR
)
23462 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23464 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
23466 /* Are we in a window whose display is up to date?
23467 And verify the buffer's text has not changed. */
23468 b
= XBUFFER (w
->buffer
);
23469 if (part
== ON_TEXT
23470 && EQ (w
->window_end_valid
, w
->buffer
)
23471 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
23472 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
23474 int hpos
, vpos
, pos
, i
, dx
, dy
, area
;
23475 struct glyph
*glyph
;
23476 Lisp_Object object
;
23477 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
23478 Lisp_Object
*overlay_vec
= NULL
;
23480 struct buffer
*obuf
;
23481 int obegv
, ozv
, same_region
;
23483 /* Find the glyph under X/Y. */
23484 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
23486 /* Look for :pointer property on image. */
23487 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23489 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23490 if (img
!= NULL
&& IMAGEP (img
->spec
))
23492 Lisp_Object image_map
, hotspot
;
23493 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
23495 && (hotspot
= find_hot_spot (image_map
,
23496 glyph
->slice
.x
+ dx
,
23497 glyph
->slice
.y
+ dy
),
23499 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
23501 Lisp_Object area_id
, plist
;
23503 area_id
= XCAR (hotspot
);
23504 /* Could check AREA_ID to see if we enter/leave this hot-spot.
23505 If so, we could look for mouse-enter, mouse-leave
23506 properties in PLIST (and do something...). */
23507 hotspot
= XCDR (hotspot
);
23508 if (CONSP (hotspot
)
23509 && (plist
= XCAR (hotspot
), CONSP (plist
)))
23511 pointer
= Fplist_get (plist
, Qpointer
);
23512 if (NILP (pointer
))
23514 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
23515 if (!NILP (help_echo_string
))
23517 help_echo_window
= window
;
23518 help_echo_object
= glyph
->object
;
23519 help_echo_pos
= glyph
->charpos
;
23523 if (NILP (pointer
))
23524 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
23528 /* Clear mouse face if X/Y not over text. */
23530 || area
!= TEXT_AREA
23531 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
23533 if (clear_mouse_face (dpyinfo
))
23534 cursor
= No_Cursor
;
23535 if (NILP (pointer
))
23537 if (area
!= TEXT_AREA
)
23538 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23540 pointer
= Vvoid_text_area_pointer
;
23545 pos
= glyph
->charpos
;
23546 object
= glyph
->object
;
23547 if (!STRINGP (object
) && !BUFFERP (object
))
23550 /* If we get an out-of-range value, return now; avoid an error. */
23551 if (BUFFERP (object
) && pos
> BUF_Z (b
))
23554 /* Make the window's buffer temporarily current for
23555 overlays_at and compute_char_face. */
23556 obuf
= current_buffer
;
23557 current_buffer
= b
;
23563 /* Is this char mouse-active or does it have help-echo? */
23564 position
= make_number (pos
);
23566 if (BUFFERP (object
))
23568 /* Put all the overlays we want in a vector in overlay_vec. */
23569 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
23570 /* Sort overlays into increasing priority order. */
23571 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
23576 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
23577 && vpos
>= dpyinfo
->mouse_face_beg_row
23578 && vpos
<= dpyinfo
->mouse_face_end_row
23579 && (vpos
> dpyinfo
->mouse_face_beg_row
23580 || hpos
>= dpyinfo
->mouse_face_beg_col
)
23581 && (vpos
< dpyinfo
->mouse_face_end_row
23582 || hpos
< dpyinfo
->mouse_face_end_col
23583 || dpyinfo
->mouse_face_past_end
));
23586 cursor
= No_Cursor
;
23588 /* Check mouse-face highlighting. */
23590 /* If there exists an overlay with mouse-face overlapping
23591 the one we are currently highlighting, we have to
23592 check if we enter the overlapping overlay, and then
23593 highlight only that. */
23594 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
23595 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
23597 /* Find the highest priority overlay that has a mouse-face
23600 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
23602 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
23603 if (!NILP (mouse_face
))
23604 overlay
= overlay_vec
[i
];
23607 /* If we're actually highlighting the same overlay as
23608 before, there's no need to do that again. */
23609 if (!NILP (overlay
)
23610 && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
23611 goto check_help_echo
;
23613 dpyinfo
->mouse_face_overlay
= overlay
;
23615 /* Clear the display of the old active region, if any. */
23616 if (clear_mouse_face (dpyinfo
))
23617 cursor
= No_Cursor
;
23619 /* If no overlay applies, get a text property. */
23620 if (NILP (overlay
))
23621 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
23623 /* Handle the overlay case. */
23624 if (!NILP (overlay
))
23626 /* Find the range of text around this char that
23627 should be active. */
23628 Lisp_Object before
, after
;
23631 before
= Foverlay_start (overlay
);
23632 after
= Foverlay_end (overlay
);
23633 /* Record this as the current active region. */
23634 fast_find_position (w
, XFASTINT (before
),
23635 &dpyinfo
->mouse_face_beg_col
,
23636 &dpyinfo
->mouse_face_beg_row
,
23637 &dpyinfo
->mouse_face_beg_x
,
23638 &dpyinfo
->mouse_face_beg_y
, Qnil
);
23640 dpyinfo
->mouse_face_past_end
23641 = !fast_find_position (w
, XFASTINT (after
),
23642 &dpyinfo
->mouse_face_end_col
,
23643 &dpyinfo
->mouse_face_end_row
,
23644 &dpyinfo
->mouse_face_end_x
,
23645 &dpyinfo
->mouse_face_end_y
, Qnil
);
23646 dpyinfo
->mouse_face_window
= window
;
23648 dpyinfo
->mouse_face_face_id
23649 = face_at_buffer_position (w
, pos
, 0, 0,
23651 !dpyinfo
->mouse_face_hidden
);
23653 /* Display it as active. */
23654 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23655 cursor
= No_Cursor
;
23657 /* Handle the text property case. */
23658 else if (!NILP (mouse_face
) && BUFFERP (object
))
23660 /* Find the range of text around this char that
23661 should be active. */
23662 Lisp_Object before
, after
, beginning
, end
;
23665 beginning
= Fmarker_position (w
->start
);
23666 end
= make_number (BUF_Z (XBUFFER (object
))
23667 - XFASTINT (w
->window_end_pos
));
23669 = Fprevious_single_property_change (make_number (pos
+ 1),
23671 object
, beginning
);
23673 = Fnext_single_property_change (position
, Qmouse_face
,
23676 /* Record this as the current active region. */
23677 fast_find_position (w
, XFASTINT (before
),
23678 &dpyinfo
->mouse_face_beg_col
,
23679 &dpyinfo
->mouse_face_beg_row
,
23680 &dpyinfo
->mouse_face_beg_x
,
23681 &dpyinfo
->mouse_face_beg_y
, Qnil
);
23682 dpyinfo
->mouse_face_past_end
23683 = !fast_find_position (w
, XFASTINT (after
),
23684 &dpyinfo
->mouse_face_end_col
,
23685 &dpyinfo
->mouse_face_end_row
,
23686 &dpyinfo
->mouse_face_end_x
,
23687 &dpyinfo
->mouse_face_end_y
, Qnil
);
23688 dpyinfo
->mouse_face_window
= window
;
23690 if (BUFFERP (object
))
23691 dpyinfo
->mouse_face_face_id
23692 = face_at_buffer_position (w
, pos
, 0, 0,
23694 !dpyinfo
->mouse_face_hidden
);
23696 /* Display it as active. */
23697 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23698 cursor
= No_Cursor
;
23700 else if (!NILP (mouse_face
) && STRINGP (object
))
23705 b
= Fprevious_single_property_change (make_number (pos
+ 1),
23708 e
= Fnext_single_property_change (position
, Qmouse_face
,
23711 b
= make_number (0);
23713 e
= make_number (SCHARS (object
) - 1);
23715 fast_find_string_pos (w
, XINT (b
), object
,
23716 &dpyinfo
->mouse_face_beg_col
,
23717 &dpyinfo
->mouse_face_beg_row
,
23718 &dpyinfo
->mouse_face_beg_x
,
23719 &dpyinfo
->mouse_face_beg_y
, 0);
23720 fast_find_string_pos (w
, XINT (e
), object
,
23721 &dpyinfo
->mouse_face_end_col
,
23722 &dpyinfo
->mouse_face_end_row
,
23723 &dpyinfo
->mouse_face_end_x
,
23724 &dpyinfo
->mouse_face_end_y
, 1);
23725 dpyinfo
->mouse_face_past_end
= 0;
23726 dpyinfo
->mouse_face_window
= window
;
23727 dpyinfo
->mouse_face_face_id
23728 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
23729 glyph
->face_id
, 1);
23730 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23731 cursor
= No_Cursor
;
23733 else if (STRINGP (object
) && NILP (mouse_face
))
23735 /* A string which doesn't have mouse-face, but
23736 the text ``under'' it might have. */
23737 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
23738 int start
= MATRIX_ROW_START_CHARPOS (r
);
23740 pos
= string_buffer_position (w
, object
, start
);
23742 mouse_face
= get_char_property_and_overlay (make_number (pos
),
23746 if (!NILP (mouse_face
) && !NILP (overlay
))
23748 Lisp_Object before
= Foverlay_start (overlay
);
23749 Lisp_Object after
= Foverlay_end (overlay
);
23752 /* Note that we might not be able to find position
23753 BEFORE in the glyph matrix if the overlay is
23754 entirely covered by a `display' property. In
23755 this case, we overshoot. So let's stop in
23756 the glyph matrix before glyphs for OBJECT. */
23757 fast_find_position (w
, XFASTINT (before
),
23758 &dpyinfo
->mouse_face_beg_col
,
23759 &dpyinfo
->mouse_face_beg_row
,
23760 &dpyinfo
->mouse_face_beg_x
,
23761 &dpyinfo
->mouse_face_beg_y
,
23764 dpyinfo
->mouse_face_past_end
23765 = !fast_find_position (w
, XFASTINT (after
),
23766 &dpyinfo
->mouse_face_end_col
,
23767 &dpyinfo
->mouse_face_end_row
,
23768 &dpyinfo
->mouse_face_end_x
,
23769 &dpyinfo
->mouse_face_end_y
,
23771 dpyinfo
->mouse_face_window
= window
;
23772 dpyinfo
->mouse_face_face_id
23773 = face_at_buffer_position (w
, pos
, 0, 0,
23775 !dpyinfo
->mouse_face_hidden
);
23777 /* Display it as active. */
23778 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23779 cursor
= No_Cursor
;
23786 /* Look for a `help-echo' property. */
23787 if (NILP (help_echo_string
)) {
23788 Lisp_Object help
, overlay
;
23790 /* Check overlays first. */
23791 help
= overlay
= Qnil
;
23792 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
23794 overlay
= overlay_vec
[i
];
23795 help
= Foverlay_get (overlay
, Qhelp_echo
);
23800 help_echo_string
= help
;
23801 help_echo_window
= window
;
23802 help_echo_object
= overlay
;
23803 help_echo_pos
= pos
;
23807 Lisp_Object object
= glyph
->object
;
23808 int charpos
= glyph
->charpos
;
23810 /* Try text properties. */
23811 if (STRINGP (object
)
23813 && charpos
< SCHARS (object
))
23815 help
= Fget_text_property (make_number (charpos
),
23816 Qhelp_echo
, object
);
23819 /* If the string itself doesn't specify a help-echo,
23820 see if the buffer text ``under'' it does. */
23821 struct glyph_row
*r
23822 = MATRIX_ROW (w
->current_matrix
, vpos
);
23823 int start
= MATRIX_ROW_START_CHARPOS (r
);
23824 int pos
= string_buffer_position (w
, object
, start
);
23827 help
= Fget_char_property (make_number (pos
),
23828 Qhelp_echo
, w
->buffer
);
23832 object
= w
->buffer
;
23837 else if (BUFFERP (object
)
23840 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
23845 help_echo_string
= help
;
23846 help_echo_window
= window
;
23847 help_echo_object
= object
;
23848 help_echo_pos
= charpos
;
23853 /* Look for a `pointer' property. */
23854 if (NILP (pointer
))
23856 /* Check overlays first. */
23857 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
23858 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
23860 if (NILP (pointer
))
23862 Lisp_Object object
= glyph
->object
;
23863 int charpos
= glyph
->charpos
;
23865 /* Try text properties. */
23866 if (STRINGP (object
)
23868 && charpos
< SCHARS (object
))
23870 pointer
= Fget_text_property (make_number (charpos
),
23872 if (NILP (pointer
))
23874 /* If the string itself doesn't specify a pointer,
23875 see if the buffer text ``under'' it does. */
23876 struct glyph_row
*r
23877 = MATRIX_ROW (w
->current_matrix
, vpos
);
23878 int start
= MATRIX_ROW_START_CHARPOS (r
);
23879 int pos
= string_buffer_position (w
, object
, start
);
23881 pointer
= Fget_char_property (make_number (pos
),
23882 Qpointer
, w
->buffer
);
23885 else if (BUFFERP (object
)
23888 pointer
= Fget_text_property (make_number (charpos
),
23895 current_buffer
= obuf
;
23900 define_frame_cursor1 (f
, cursor
, pointer
);
23905 Clear any mouse-face on window W. This function is part of the
23906 redisplay interface, and is called from try_window_id and similar
23907 functions to ensure the mouse-highlight is off. */
23910 x_clear_window_mouse_face (w
)
23913 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
23914 Lisp_Object window
;
23917 XSETWINDOW (window
, w
);
23918 if (EQ (window
, dpyinfo
->mouse_face_window
))
23919 clear_mouse_face (dpyinfo
);
23925 Just discard the mouse face information for frame F, if any.
23926 This is used when the size of F is changed. */
23929 cancel_mouse_face (f
)
23932 Lisp_Object window
;
23933 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23935 window
= dpyinfo
->mouse_face_window
;
23936 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
23938 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
23939 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
23940 dpyinfo
->mouse_face_window
= Qnil
;
23945 #endif /* HAVE_WINDOW_SYSTEM */
23948 /***********************************************************************
23950 ***********************************************************************/
23952 #ifdef HAVE_WINDOW_SYSTEM
23954 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
23955 which intersects rectangle R. R is in window-relative coordinates. */
23958 expose_area (w
, row
, r
, area
)
23960 struct glyph_row
*row
;
23962 enum glyph_row_area area
;
23964 struct glyph
*first
= row
->glyphs
[area
];
23965 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
23966 struct glyph
*last
;
23967 int first_x
, start_x
, x
;
23969 if (area
== TEXT_AREA
&& row
->fill_line_p
)
23970 /* If row extends face to end of line write the whole line. */
23971 draw_glyphs (w
, 0, row
, area
,
23972 0, row
->used
[area
],
23973 DRAW_NORMAL_TEXT
, 0);
23976 /* Set START_X to the window-relative start position for drawing glyphs of
23977 AREA. The first glyph of the text area can be partially visible.
23978 The first glyphs of other areas cannot. */
23979 start_x
= window_box_left_offset (w
, area
);
23981 if (area
== TEXT_AREA
)
23984 /* Find the first glyph that must be redrawn. */
23986 && x
+ first
->pixel_width
< r
->x
)
23988 x
+= first
->pixel_width
;
23992 /* Find the last one. */
23996 && x
< r
->x
+ r
->width
)
23998 x
+= last
->pixel_width
;
24004 draw_glyphs (w
, first_x
- start_x
, row
, area
,
24005 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
24006 DRAW_NORMAL_TEXT
, 0);
24011 /* Redraw the parts of the glyph row ROW on window W intersecting
24012 rectangle R. R is in window-relative coordinates. Value is
24013 non-zero if mouse-face was overwritten. */
24016 expose_line (w
, row
, r
)
24018 struct glyph_row
*row
;
24021 xassert (row
->enabled_p
);
24023 if (row
->mode_line_p
|| w
->pseudo_window_p
)
24024 draw_glyphs (w
, 0, row
, TEXT_AREA
,
24025 0, row
->used
[TEXT_AREA
],
24026 DRAW_NORMAL_TEXT
, 0);
24029 if (row
->used
[LEFT_MARGIN_AREA
])
24030 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
24031 if (row
->used
[TEXT_AREA
])
24032 expose_area (w
, row
, r
, TEXT_AREA
);
24033 if (row
->used
[RIGHT_MARGIN_AREA
])
24034 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
24035 draw_row_fringe_bitmaps (w
, row
);
24038 return row
->mouse_face_p
;
24042 /* Redraw those parts of glyphs rows during expose event handling that
24043 overlap other rows. Redrawing of an exposed line writes over parts
24044 of lines overlapping that exposed line; this function fixes that.
24046 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
24047 row in W's current matrix that is exposed and overlaps other rows.
24048 LAST_OVERLAPPING_ROW is the last such row. */
24051 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
, r
)
24053 struct glyph_row
*first_overlapping_row
;
24054 struct glyph_row
*last_overlapping_row
;
24057 struct glyph_row
*row
;
24059 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
24060 if (row
->overlapping_p
)
24062 xassert (row
->enabled_p
&& !row
->mode_line_p
);
24065 if (row
->used
[LEFT_MARGIN_AREA
])
24066 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
24068 if (row
->used
[TEXT_AREA
])
24069 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
24071 if (row
->used
[RIGHT_MARGIN_AREA
])
24072 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
24078 /* Return non-zero if W's cursor intersects rectangle R. */
24081 phys_cursor_in_rect_p (w
, r
)
24085 XRectangle cr
, result
;
24086 struct glyph
*cursor_glyph
;
24087 struct glyph_row
*row
;
24089 if (w
->phys_cursor
.vpos
>= 0
24090 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
24091 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
24093 && row
->cursor_in_fringe_p
)
24095 /* Cursor is in the fringe. */
24096 cr
.x
= window_box_right_offset (w
,
24097 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
24098 ? RIGHT_MARGIN_AREA
24101 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
24102 cr
.height
= row
->height
;
24103 return x_intersect_rectangles (&cr
, r
, &result
);
24106 cursor_glyph
= get_phys_cursor_glyph (w
);
24109 /* r is relative to W's box, but w->phys_cursor.x is relative
24110 to left edge of W's TEXT area. Adjust it. */
24111 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
24112 cr
.y
= w
->phys_cursor
.y
;
24113 cr
.width
= cursor_glyph
->pixel_width
;
24114 cr
.height
= w
->phys_cursor_height
;
24115 /* ++KFS: W32 version used W32-specific IntersectRect here, but
24116 I assume the effect is the same -- and this is portable. */
24117 return x_intersect_rectangles (&cr
, r
, &result
);
24119 /* If we don't understand the format, pretend we're not in the hot-spot. */
24125 Draw a vertical window border to the right of window W if W doesn't
24126 have vertical scroll bars. */
24129 x_draw_vertical_border (w
)
24132 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24134 /* We could do better, if we knew what type of scroll-bar the adjacent
24135 windows (on either side) have... But we don't :-(
24136 However, I think this works ok. ++KFS 2003-04-25 */
24138 /* Redraw borders between horizontally adjacent windows. Don't
24139 do it for frames with vertical scroll bars because either the
24140 right scroll bar of a window, or the left scroll bar of its
24141 neighbor will suffice as a border. */
24142 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
24145 if (!WINDOW_RIGHTMOST_P (w
)
24146 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
24148 int x0
, x1
, y0
, y1
;
24150 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
24153 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
24156 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
24158 else if (!WINDOW_LEFTMOST_P (w
)
24159 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
24161 int x0
, x1
, y0
, y1
;
24163 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
24166 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
24169 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
24174 /* Redraw the part of window W intersection rectangle FR. Pixel
24175 coordinates in FR are frame-relative. Call this function with
24176 input blocked. Value is non-zero if the exposure overwrites
24180 expose_window (w
, fr
)
24184 struct frame
*f
= XFRAME (w
->frame
);
24186 int mouse_face_overwritten_p
= 0;
24188 /* If window is not yet fully initialized, do nothing. This can
24189 happen when toolkit scroll bars are used and a window is split.
24190 Reconfiguring the scroll bar will generate an expose for a newly
24192 if (w
->current_matrix
== NULL
)
24195 /* When we're currently updating the window, display and current
24196 matrix usually don't agree. Arrange for a thorough display
24198 if (w
== updated_window
)
24200 SET_FRAME_GARBAGED (f
);
24204 /* Frame-relative pixel rectangle of W. */
24205 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
24206 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
24207 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
24208 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
24210 if (x_intersect_rectangles (fr
, &wr
, &r
))
24212 int yb
= window_text_bottom_y (w
);
24213 struct glyph_row
*row
;
24214 int cursor_cleared_p
;
24215 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
24217 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
24218 r
.x
, r
.y
, r
.width
, r
.height
));
24220 /* Convert to window coordinates. */
24221 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
24222 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
24224 /* Turn off the cursor. */
24225 if (!w
->pseudo_window_p
24226 && phys_cursor_in_rect_p (w
, &r
))
24228 x_clear_cursor (w
);
24229 cursor_cleared_p
= 1;
24232 cursor_cleared_p
= 0;
24234 /* Update lines intersecting rectangle R. */
24235 first_overlapping_row
= last_overlapping_row
= NULL
;
24236 for (row
= w
->current_matrix
->rows
;
24241 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
24243 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
24244 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
24245 || (r
.y
>= y0
&& r
.y
< y1
)
24246 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
24248 /* A header line may be overlapping, but there is no need
24249 to fix overlapping areas for them. KFS 2005-02-12 */
24250 if (row
->overlapping_p
&& !row
->mode_line_p
)
24252 if (first_overlapping_row
== NULL
)
24253 first_overlapping_row
= row
;
24254 last_overlapping_row
= row
;
24258 if (expose_line (w
, row
, &r
))
24259 mouse_face_overwritten_p
= 1;
24262 else if (row
->overlapping_p
)
24264 /* We must redraw a row overlapping the exposed area. */
24266 ? y0
+ row
->phys_height
> r
.y
24267 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
24269 if (first_overlapping_row
== NULL
)
24270 first_overlapping_row
= row
;
24271 last_overlapping_row
= row
;
24279 /* Display the mode line if there is one. */
24280 if (WINDOW_WANTS_MODELINE_P (w
)
24281 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
24283 && row
->y
< r
.y
+ r
.height
)
24285 if (expose_line (w
, row
, &r
))
24286 mouse_face_overwritten_p
= 1;
24289 if (!w
->pseudo_window_p
)
24291 /* Fix the display of overlapping rows. */
24292 if (first_overlapping_row
)
24293 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
24296 /* Draw border between windows. */
24297 x_draw_vertical_border (w
);
24299 /* Turn the cursor on again. */
24300 if (cursor_cleared_p
)
24301 update_window_cursor (w
, 1);
24305 return mouse_face_overwritten_p
;
24310 /* Redraw (parts) of all windows in the window tree rooted at W that
24311 intersect R. R contains frame pixel coordinates. Value is
24312 non-zero if the exposure overwrites mouse-face. */
24315 expose_window_tree (w
, r
)
24319 struct frame
*f
= XFRAME (w
->frame
);
24320 int mouse_face_overwritten_p
= 0;
24322 while (w
&& !FRAME_GARBAGED_P (f
))
24324 if (!NILP (w
->hchild
))
24325 mouse_face_overwritten_p
24326 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
24327 else if (!NILP (w
->vchild
))
24328 mouse_face_overwritten_p
24329 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
24331 mouse_face_overwritten_p
|= expose_window (w
, r
);
24333 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
24336 return mouse_face_overwritten_p
;
24341 Redisplay an exposed area of frame F. X and Y are the upper-left
24342 corner of the exposed rectangle. W and H are width and height of
24343 the exposed area. All are pixel values. W or H zero means redraw
24344 the entire frame. */
24347 expose_frame (f
, x
, y
, w
, h
)
24352 int mouse_face_overwritten_p
= 0;
24354 TRACE ((stderr
, "expose_frame "));
24356 /* No need to redraw if frame will be redrawn soon. */
24357 if (FRAME_GARBAGED_P (f
))
24359 TRACE ((stderr
, " garbaged\n"));
24363 /* If basic faces haven't been realized yet, there is no point in
24364 trying to redraw anything. This can happen when we get an expose
24365 event while Emacs is starting, e.g. by moving another window. */
24366 if (FRAME_FACE_CACHE (f
) == NULL
24367 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
24369 TRACE ((stderr
, " no faces\n"));
24373 if (w
== 0 || h
== 0)
24376 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
24377 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
24387 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
24388 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
24390 if (WINDOWP (f
->tool_bar_window
))
24391 mouse_face_overwritten_p
24392 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
24394 #ifdef HAVE_X_WINDOWS
24396 #ifndef USE_X_TOOLKIT
24397 if (WINDOWP (f
->menu_bar_window
))
24398 mouse_face_overwritten_p
24399 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
24400 #endif /* not USE_X_TOOLKIT */
24404 /* Some window managers support a focus-follows-mouse style with
24405 delayed raising of frames. Imagine a partially obscured frame,
24406 and moving the mouse into partially obscured mouse-face on that
24407 frame. The visible part of the mouse-face will be highlighted,
24408 then the WM raises the obscured frame. With at least one WM, KDE
24409 2.1, Emacs is not getting any event for the raising of the frame
24410 (even tried with SubstructureRedirectMask), only Expose events.
24411 These expose events will draw text normally, i.e. not
24412 highlighted. Which means we must redo the highlight here.
24413 Subsume it under ``we love X''. --gerd 2001-08-15 */
24414 /* Included in Windows version because Windows most likely does not
24415 do the right thing if any third party tool offers
24416 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
24417 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
24419 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24420 if (f
== dpyinfo
->mouse_face_mouse_frame
)
24422 int x
= dpyinfo
->mouse_face_mouse_x
;
24423 int y
= dpyinfo
->mouse_face_mouse_y
;
24424 clear_mouse_face (dpyinfo
);
24425 note_mouse_highlight (f
, x
, y
);
24432 Determine the intersection of two rectangles R1 and R2. Return
24433 the intersection in *RESULT. Value is non-zero if RESULT is not
24437 x_intersect_rectangles (r1
, r2
, result
)
24438 XRectangle
*r1
, *r2
, *result
;
24440 XRectangle
*left
, *right
;
24441 XRectangle
*upper
, *lower
;
24442 int intersection_p
= 0;
24444 /* Rearrange so that R1 is the left-most rectangle. */
24446 left
= r1
, right
= r2
;
24448 left
= r2
, right
= r1
;
24450 /* X0 of the intersection is right.x0, if this is inside R1,
24451 otherwise there is no intersection. */
24452 if (right
->x
<= left
->x
+ left
->width
)
24454 result
->x
= right
->x
;
24456 /* The right end of the intersection is the minimum of the
24457 the right ends of left and right. */
24458 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
24461 /* Same game for Y. */
24463 upper
= r1
, lower
= r2
;
24465 upper
= r2
, lower
= r1
;
24467 /* The upper end of the intersection is lower.y0, if this is inside
24468 of upper. Otherwise, there is no intersection. */
24469 if (lower
->y
<= upper
->y
+ upper
->height
)
24471 result
->y
= lower
->y
;
24473 /* The lower end of the intersection is the minimum of the lower
24474 ends of upper and lower. */
24475 result
->height
= (min (lower
->y
+ lower
->height
,
24476 upper
->y
+ upper
->height
)
24478 intersection_p
= 1;
24482 return intersection_p
;
24485 #endif /* HAVE_WINDOW_SYSTEM */
24488 /***********************************************************************
24490 ***********************************************************************/
24495 Vwith_echo_area_save_vector
= Qnil
;
24496 staticpro (&Vwith_echo_area_save_vector
);
24498 Vmessage_stack
= Qnil
;
24499 staticpro (&Vmessage_stack
);
24501 Qinhibit_redisplay
= intern ("inhibit-redisplay");
24502 staticpro (&Qinhibit_redisplay
);
24504 message_dolog_marker1
= Fmake_marker ();
24505 staticpro (&message_dolog_marker1
);
24506 message_dolog_marker2
= Fmake_marker ();
24507 staticpro (&message_dolog_marker2
);
24508 message_dolog_marker3
= Fmake_marker ();
24509 staticpro (&message_dolog_marker3
);
24512 defsubr (&Sdump_frame_glyph_matrix
);
24513 defsubr (&Sdump_glyph_matrix
);
24514 defsubr (&Sdump_glyph_row
);
24515 defsubr (&Sdump_tool_bar_row
);
24516 defsubr (&Strace_redisplay
);
24517 defsubr (&Strace_to_stderr
);
24519 #ifdef HAVE_WINDOW_SYSTEM
24520 defsubr (&Stool_bar_lines_needed
);
24521 defsubr (&Slookup_image_map
);
24523 defsubr (&Sformat_mode_line
);
24524 defsubr (&Sinvisible_p
);
24526 staticpro (&Qmenu_bar_update_hook
);
24527 Qmenu_bar_update_hook
= intern ("menu-bar-update-hook");
24529 staticpro (&Qoverriding_terminal_local_map
);
24530 Qoverriding_terminal_local_map
= intern ("overriding-terminal-local-map");
24532 staticpro (&Qoverriding_local_map
);
24533 Qoverriding_local_map
= intern ("overriding-local-map");
24535 staticpro (&Qwindow_scroll_functions
);
24536 Qwindow_scroll_functions
= intern ("window-scroll-functions");
24538 staticpro (&Qwindow_text_change_functions
);
24539 Qwindow_text_change_functions
= intern ("window-text-change-functions");
24541 staticpro (&Qredisplay_end_trigger_functions
);
24542 Qredisplay_end_trigger_functions
= intern ("redisplay-end-trigger-functions");
24544 staticpro (&Qinhibit_point_motion_hooks
);
24545 Qinhibit_point_motion_hooks
= intern ("inhibit-point-motion-hooks");
24547 Qeval
= intern ("eval");
24548 staticpro (&Qeval
);
24550 QCdata
= intern (":data");
24551 staticpro (&QCdata
);
24552 Qdisplay
= intern ("display");
24553 staticpro (&Qdisplay
);
24554 Qspace_width
= intern ("space-width");
24555 staticpro (&Qspace_width
);
24556 Qraise
= intern ("raise");
24557 staticpro (&Qraise
);
24558 Qslice
= intern ("slice");
24559 staticpro (&Qslice
);
24560 Qspace
= intern ("space");
24561 staticpro (&Qspace
);
24562 Qmargin
= intern ("margin");
24563 staticpro (&Qmargin
);
24564 Qpointer
= intern ("pointer");
24565 staticpro (&Qpointer
);
24566 Qleft_margin
= intern ("left-margin");
24567 staticpro (&Qleft_margin
);
24568 Qright_margin
= intern ("right-margin");
24569 staticpro (&Qright_margin
);
24570 Qcenter
= intern ("center");
24571 staticpro (&Qcenter
);
24572 Qline_height
= intern ("line-height");
24573 staticpro (&Qline_height
);
24574 QCalign_to
= intern (":align-to");
24575 staticpro (&QCalign_to
);
24576 QCrelative_width
= intern (":relative-width");
24577 staticpro (&QCrelative_width
);
24578 QCrelative_height
= intern (":relative-height");
24579 staticpro (&QCrelative_height
);
24580 QCeval
= intern (":eval");
24581 staticpro (&QCeval
);
24582 QCpropertize
= intern (":propertize");
24583 staticpro (&QCpropertize
);
24584 QCfile
= intern (":file");
24585 staticpro (&QCfile
);
24586 Qfontified
= intern ("fontified");
24587 staticpro (&Qfontified
);
24588 Qfontification_functions
= intern ("fontification-functions");
24589 staticpro (&Qfontification_functions
);
24590 Qtrailing_whitespace
= intern ("trailing-whitespace");
24591 staticpro (&Qtrailing_whitespace
);
24592 Qescape_glyph
= intern ("escape-glyph");
24593 staticpro (&Qescape_glyph
);
24594 Qnobreak_space
= intern ("nobreak-space");
24595 staticpro (&Qnobreak_space
);
24596 Qimage
= intern ("image");
24597 staticpro (&Qimage
);
24598 QCmap
= intern (":map");
24599 staticpro (&QCmap
);
24600 QCpointer
= intern (":pointer");
24601 staticpro (&QCpointer
);
24602 Qrect
= intern ("rect");
24603 staticpro (&Qrect
);
24604 Qcircle
= intern ("circle");
24605 staticpro (&Qcircle
);
24606 Qpoly
= intern ("poly");
24607 staticpro (&Qpoly
);
24608 Qmessage_truncate_lines
= intern ("message-truncate-lines");
24609 staticpro (&Qmessage_truncate_lines
);
24610 Qgrow_only
= intern ("grow-only");
24611 staticpro (&Qgrow_only
);
24612 Qinhibit_menubar_update
= intern ("inhibit-menubar-update");
24613 staticpro (&Qinhibit_menubar_update
);
24614 Qinhibit_eval_during_redisplay
= intern ("inhibit-eval-during-redisplay");
24615 staticpro (&Qinhibit_eval_during_redisplay
);
24616 Qposition
= intern ("position");
24617 staticpro (&Qposition
);
24618 Qbuffer_position
= intern ("buffer-position");
24619 staticpro (&Qbuffer_position
);
24620 Qobject
= intern ("object");
24621 staticpro (&Qobject
);
24622 Qbar
= intern ("bar");
24624 Qhbar
= intern ("hbar");
24625 staticpro (&Qhbar
);
24626 Qbox
= intern ("box");
24628 Qhollow
= intern ("hollow");
24629 staticpro (&Qhollow
);
24630 Qhand
= intern ("hand");
24631 staticpro (&Qhand
);
24632 Qarrow
= intern ("arrow");
24633 staticpro (&Qarrow
);
24634 Qtext
= intern ("text");
24635 staticpro (&Qtext
);
24636 Qrisky_local_variable
= intern ("risky-local-variable");
24637 staticpro (&Qrisky_local_variable
);
24638 Qinhibit_free_realized_faces
= intern ("inhibit-free-realized-faces");
24639 staticpro (&Qinhibit_free_realized_faces
);
24641 list_of_error
= Fcons (Fcons (intern ("error"),
24642 Fcons (intern ("void-variable"), Qnil
)),
24644 staticpro (&list_of_error
);
24646 Qlast_arrow_position
= intern ("last-arrow-position");
24647 staticpro (&Qlast_arrow_position
);
24648 Qlast_arrow_string
= intern ("last-arrow-string");
24649 staticpro (&Qlast_arrow_string
);
24651 Qoverlay_arrow_string
= intern ("overlay-arrow-string");
24652 staticpro (&Qoverlay_arrow_string
);
24653 Qoverlay_arrow_bitmap
= intern ("overlay-arrow-bitmap");
24654 staticpro (&Qoverlay_arrow_bitmap
);
24656 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
24657 staticpro (&echo_buffer
[0]);
24658 staticpro (&echo_buffer
[1]);
24660 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
24661 staticpro (&echo_area_buffer
[0]);
24662 staticpro (&echo_area_buffer
[1]);
24664 Vmessages_buffer_name
= build_string ("*Messages*");
24665 staticpro (&Vmessages_buffer_name
);
24667 mode_line_proptrans_alist
= Qnil
;
24668 staticpro (&mode_line_proptrans_alist
);
24669 mode_line_string_list
= Qnil
;
24670 staticpro (&mode_line_string_list
);
24671 mode_line_string_face
= Qnil
;
24672 staticpro (&mode_line_string_face
);
24673 mode_line_string_face_prop
= Qnil
;
24674 staticpro (&mode_line_string_face_prop
);
24675 Vmode_line_unwind_vector
= Qnil
;
24676 staticpro (&Vmode_line_unwind_vector
);
24678 help_echo_string
= Qnil
;
24679 staticpro (&help_echo_string
);
24680 help_echo_object
= Qnil
;
24681 staticpro (&help_echo_object
);
24682 help_echo_window
= Qnil
;
24683 staticpro (&help_echo_window
);
24684 previous_help_echo_string
= Qnil
;
24685 staticpro (&previous_help_echo_string
);
24686 help_echo_pos
= -1;
24688 #ifdef HAVE_WINDOW_SYSTEM
24689 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
24690 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
24691 For example, if a block cursor is over a tab, it will be drawn as
24692 wide as that tab on the display. */);
24693 x_stretch_cursor_p
= 0;
24696 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
24697 doc
: /* *Non-nil means highlight trailing whitespace.
24698 The face used for trailing whitespace is `trailing-whitespace'. */);
24699 Vshow_trailing_whitespace
= Qnil
;
24701 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
24702 doc
: /* *Control highlighting of nobreak space and soft hyphen.
24703 A value of t means highlight the character itself (for nobreak space,
24704 use face `nobreak-space').
24705 A value of nil means no highlighting.
24706 Other values mean display the escape glyph followed by an ordinary
24707 space or ordinary hyphen. */);
24708 Vnobreak_char_display
= Qt
;
24710 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
24711 doc
: /* *The pointer shape to show in void text areas.
24712 A value of nil means to show the text pointer. Other options are `arrow',
24713 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
24714 Vvoid_text_area_pointer
= Qarrow
;
24716 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
24717 doc
: /* Non-nil means don't actually do any redisplay.
24718 This is used for internal purposes. */);
24719 Vinhibit_redisplay
= Qnil
;
24721 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
24722 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
24723 Vglobal_mode_string
= Qnil
;
24725 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
24726 doc
: /* Marker for where to display an arrow on top of the buffer text.
24727 This must be the beginning of a line in order to work.
24728 See also `overlay-arrow-string'. */);
24729 Voverlay_arrow_position
= Qnil
;
24731 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
24732 doc
: /* String to display as an arrow in non-window frames.
24733 See also `overlay-arrow-position'. */);
24734 Voverlay_arrow_string
= build_string ("=>");
24736 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
24737 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
24738 The symbols on this list are examined during redisplay to determine
24739 where to display overlay arrows. */);
24740 Voverlay_arrow_variable_list
24741 = Fcons (intern ("overlay-arrow-position"), Qnil
);
24743 DEFVAR_INT ("scroll-step", &scroll_step
,
24744 doc
: /* *The number of lines to try scrolling a window by when point moves out.
24745 If that fails to bring point back on frame, point is centered instead.
24746 If this is zero, point is always centered after it moves off frame.
24747 If you want scrolling to always be a line at a time, you should set
24748 `scroll-conservatively' to a large value rather than set this to 1. */);
24750 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
24751 doc
: /* *Scroll up to this many lines, to bring point back on screen.
24752 If point moves off-screen, redisplay will scroll by up to
24753 `scroll-conservatively' lines in order to bring point just barely
24754 onto the screen again. If that cannot be done, then redisplay
24755 recenters point as usual.
24757 A value of zero means always recenter point if it moves off screen. */);
24758 scroll_conservatively
= 0;
24760 DEFVAR_INT ("scroll-margin", &scroll_margin
,
24761 doc
: /* *Number of lines of margin at the top and bottom of a window.
24762 Recenter the window whenever point gets within this many lines
24763 of the top or bottom of the window. */);
24766 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
24767 doc
: /* Pixels per inch value for non-window system displays.
24768 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
24769 Vdisplay_pixels_per_inch
= make_float (72.0);
24772 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
24775 DEFVAR_LISP ("truncate-partial-width-windows",
24776 &Vtruncate_partial_width_windows
,
24777 doc
: /* Non-nil means truncate lines in windows with less than the frame width.
24778 For an integer value, truncate lines in each window with less than the
24779 full frame width, provided the window width is less than that integer;
24780 otherwise, respect the value of `truncate-lines'.
24782 For any other non-nil value, truncate lines in all windows with
24783 less than the full frame width.
24785 A value of nil means to respect the value of `truncate-lines'. */);
24786 Vtruncate_partial_width_windows
= make_number (30);
24788 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
24789 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
24790 Any other value means to use the appropriate face, `mode-line',
24791 `header-line', or `menu' respectively. */);
24792 mode_line_inverse_video
= 1;
24794 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
24795 doc
: /* *Maximum buffer size for which line number should be displayed.
24796 If the buffer is bigger than this, the line number does not appear
24797 in the mode line. A value of nil means no limit. */);
24798 Vline_number_display_limit
= Qnil
;
24800 DEFVAR_INT ("line-number-display-limit-width",
24801 &line_number_display_limit_width
,
24802 doc
: /* *Maximum line width (in characters) for line number display.
24803 If the average length of the lines near point is bigger than this, then the
24804 line number may be omitted from the mode line. */);
24805 line_number_display_limit_width
= 200;
24807 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
24808 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
24809 highlight_nonselected_windows
= 0;
24811 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
24812 doc
: /* Non-nil if more than one frame is visible on this display.
24813 Minibuffer-only frames don't count, but iconified frames do.
24814 This variable is not guaranteed to be accurate except while processing
24815 `frame-title-format' and `icon-title-format'. */);
24817 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
24818 doc
: /* Template for displaying the title bar of visible frames.
24819 \(Assuming the window manager supports this feature.)
24821 This variable has the same structure as `mode-line-format', except that
24822 the %c and %l constructs are ignored. It is used only on frames for
24823 which no explicit name has been set \(see `modify-frame-parameters'). */);
24825 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
24826 doc
: /* Template for displaying the title bar of an iconified frame.
24827 \(Assuming the window manager supports this feature.)
24828 This variable has the same structure as `mode-line-format' (which see),
24829 and is used only on frames for which no explicit name has been set
24830 \(see `modify-frame-parameters'). */);
24832 = Vframe_title_format
24833 = Fcons (intern ("multiple-frames"),
24834 Fcons (build_string ("%b"),
24835 Fcons (Fcons (empty_unibyte_string
,
24836 Fcons (intern ("invocation-name"),
24837 Fcons (build_string ("@"),
24838 Fcons (intern ("system-name"),
24842 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
24843 doc
: /* Maximum number of lines to keep in the message log buffer.
24844 If nil, disable message logging. If t, log messages but don't truncate
24845 the buffer when it becomes large. */);
24846 Vmessage_log_max
= make_number (100);
24848 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
24849 doc
: /* Functions called before redisplay, if window sizes have changed.
24850 The value should be a list of functions that take one argument.
24851 Just before redisplay, for each frame, if any of its windows have changed
24852 size since the last redisplay, or have been split or deleted,
24853 all the functions in the list are called, with the frame as argument. */);
24854 Vwindow_size_change_functions
= Qnil
;
24856 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
24857 doc
: /* List of functions to call before redisplaying a window with scrolling.
24858 Each function is called with two arguments, the window
24859 and its new display-start position. Note that the value of `window-end'
24860 is not valid when these functions are called. */);
24861 Vwindow_scroll_functions
= Qnil
;
24863 DEFVAR_LISP ("window-text-change-functions",
24864 &Vwindow_text_change_functions
,
24865 doc
: /* Functions to call in redisplay when text in the window might change. */);
24866 Vwindow_text_change_functions
= Qnil
;
24868 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
24869 doc
: /* Functions called when redisplay of a window reaches the end trigger.
24870 Each function is called with two arguments, the window and the end trigger value.
24871 See `set-window-redisplay-end-trigger'. */);
24872 Vredisplay_end_trigger_functions
= Qnil
;
24874 DEFVAR_LISP ("mouse-autoselect-window", &Vmouse_autoselect_window
,
24875 doc
: /* *Non-nil means autoselect window with mouse pointer.
24876 If nil, do not autoselect windows.
24877 A positive number means delay autoselection by that many seconds: a
24878 window is autoselected only after the mouse has remained in that
24879 window for the duration of the delay.
24880 A negative number has a similar effect, but causes windows to be
24881 autoselected only after the mouse has stopped moving. \(Because of
24882 the way Emacs compares mouse events, you will occasionally wait twice
24883 that time before the window gets selected.\)
24884 Any other value means to autoselect window instantaneously when the
24885 mouse pointer enters it.
24887 Autoselection selects the minibuffer only if it is active, and never
24888 unselects the minibuffer if it is active.
24890 When customizing this variable make sure that the actual value of
24891 `focus-follows-mouse' matches the behavior of your window manager. */);
24892 Vmouse_autoselect_window
= Qnil
;
24894 DEFVAR_LISP ("auto-resize-tool-bars", &Vauto_resize_tool_bars
,
24895 doc
: /* *Non-nil means automatically resize tool-bars.
24896 This dynamically changes the tool-bar's height to the minimum height
24897 that is needed to make all tool-bar items visible.
24898 If value is `grow-only', the tool-bar's height is only increased
24899 automatically; to decrease the tool-bar height, use \\[recenter]. */);
24900 Vauto_resize_tool_bars
= Qt
;
24902 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
24903 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
24904 auto_raise_tool_bar_buttons_p
= 1;
24906 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
24907 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
24908 make_cursor_line_fully_visible_p
= 1;
24910 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
24911 doc
: /* *Border below tool-bar in pixels.
24912 If an integer, use it as the height of the border.
24913 If it is one of `internal-border-width' or `border-width', use the
24914 value of the corresponding frame parameter.
24915 Otherwise, no border is added below the tool-bar. */);
24916 Vtool_bar_border
= Qinternal_border_width
;
24918 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
24919 doc
: /* *Margin around tool-bar buttons in pixels.
24920 If an integer, use that for both horizontal and vertical margins.
24921 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
24922 HORZ specifying the horizontal margin, and VERT specifying the
24923 vertical margin. */);
24924 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
24926 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
24927 doc
: /* *Relief thickness of tool-bar buttons. */);
24928 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
24930 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
24931 doc
: /* List of functions to call to fontify regions of text.
24932 Each function is called with one argument POS. Functions must
24933 fontify a region starting at POS in the current buffer, and give
24934 fontified regions the property `fontified'. */);
24935 Vfontification_functions
= Qnil
;
24936 Fmake_variable_buffer_local (Qfontification_functions
);
24938 DEFVAR_BOOL ("unibyte-display-via-language-environment",
24939 &unibyte_display_via_language_environment
,
24940 doc
: /* *Non-nil means display unibyte text according to language environment.
24941 Specifically this means that unibyte non-ASCII characters
24942 are displayed by converting them to the equivalent multibyte characters
24943 according to the current language environment. As a result, they are
24944 displayed according to the current fontset. */);
24945 unibyte_display_via_language_environment
= 0;
24947 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
24948 doc
: /* *Maximum height for resizing mini-windows.
24949 If a float, it specifies a fraction of the mini-window frame's height.
24950 If an integer, it specifies a number of lines. */);
24951 Vmax_mini_window_height
= make_float (0.25);
24953 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
24954 doc
: /* *How to resize mini-windows.
24955 A value of nil means don't automatically resize mini-windows.
24956 A value of t means resize them to fit the text displayed in them.
24957 A value of `grow-only', the default, means let mini-windows grow
24958 only, until their display becomes empty, at which point the windows
24959 go back to their normal size. */);
24960 Vresize_mini_windows
= Qgrow_only
;
24962 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
24963 doc
: /* Alist specifying how to blink the cursor off.
24964 Each element has the form (ON-STATE . OFF-STATE). Whenever the
24965 `cursor-type' frame-parameter or variable equals ON-STATE,
24966 comparing using `equal', Emacs uses OFF-STATE to specify
24967 how to blink it off. ON-STATE and OFF-STATE are values for
24968 the `cursor-type' frame parameter.
24970 If a frame's ON-STATE has no entry in this list,
24971 the frame's other specifications determine how to blink the cursor off. */);
24972 Vblink_cursor_alist
= Qnil
;
24974 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
24975 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
24976 automatic_hscrolling_p
= 1;
24977 Qauto_hscroll_mode
= intern ("auto-hscroll-mode");
24978 staticpro (&Qauto_hscroll_mode
);
24980 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
24981 doc
: /* *How many columns away from the window edge point is allowed to get
24982 before automatic hscrolling will horizontally scroll the window. */);
24983 hscroll_margin
= 5;
24985 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
24986 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
24987 When point is less than `hscroll-margin' columns from the window
24988 edge, automatic hscrolling will scroll the window by the amount of columns
24989 determined by this variable. If its value is a positive integer, scroll that
24990 many columns. If it's a positive floating-point number, it specifies the
24991 fraction of the window's width to scroll. If it's nil or zero, point will be
24992 centered horizontally after the scroll. Any other value, including negative
24993 numbers, are treated as if the value were zero.
24995 Automatic hscrolling always moves point outside the scroll margin, so if
24996 point was more than scroll step columns inside the margin, the window will
24997 scroll more than the value given by the scroll step.
24999 Note that the lower bound for automatic hscrolling specified by `scroll-left'
25000 and `scroll-right' overrides this variable's effect. */);
25001 Vhscroll_step
= make_number (0);
25003 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
25004 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
25005 Bind this around calls to `message' to let it take effect. */);
25006 message_truncate_lines
= 0;
25008 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
25009 doc
: /* Normal hook run to update the menu bar definitions.
25010 Redisplay runs this hook before it redisplays the menu bar.
25011 This is used to update submenus such as Buffers,
25012 whose contents depend on various data. */);
25013 Vmenu_bar_update_hook
= Qnil
;
25015 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
25016 doc
: /* Frame for which we are updating a menu.
25017 The enable predicate for a menu binding should check this variable. */);
25018 Vmenu_updating_frame
= Qnil
;
25020 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
25021 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
25022 inhibit_menubar_update
= 0;
25024 DEFVAR_LISP ("wrap-prefix", &Vwrap_prefix
,
25025 doc
: /* Prefix added to the beginning of all continuation lines at display-time.
25026 May be a string, an image, or a stretch-glyph such as used by the
25027 `display' text-property.
25029 This variable is overridden by any `wrap-prefix' text-property.
25031 To add a prefix to non-continuation lines, use the `line-prefix' variable. */);
25032 Vwrap_prefix
= Qnil
;
25033 staticpro (&Qwrap_prefix
);
25034 Qwrap_prefix
= intern ("wrap-prefix");
25035 Fmake_variable_buffer_local (Qwrap_prefix
);
25037 DEFVAR_LISP ("line-prefix", &Vline_prefix
,
25038 doc
: /* Prefix added to the beginning of all non-continuation lines at display-time.
25039 May be a string, an image, or a stretch-glyph such as used by the
25040 `display' text-property.
25042 This variable is overridden by any `line-prefix' text-property.
25044 To add a prefix to continuation lines, use the `wrap-prefix' variable. */);
25045 Vline_prefix
= Qnil
;
25046 staticpro (&Qline_prefix
);
25047 Qline_prefix
= intern ("line-prefix");
25048 Fmake_variable_buffer_local (Qline_prefix
);
25050 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
25051 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
25052 inhibit_eval_during_redisplay
= 0;
25054 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
25055 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
25056 inhibit_free_realized_faces
= 0;
25059 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
25060 doc
: /* Inhibit try_window_id display optimization. */);
25061 inhibit_try_window_id
= 0;
25063 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
25064 doc
: /* Inhibit try_window_reusing display optimization. */);
25065 inhibit_try_window_reusing
= 0;
25067 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
25068 doc
: /* Inhibit try_cursor_movement display optimization. */);
25069 inhibit_try_cursor_movement
= 0;
25070 #endif /* GLYPH_DEBUG */
25072 DEFVAR_INT ("overline-margin", &overline_margin
,
25073 doc
: /* *Space between overline and text, in pixels.
25074 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
25075 margin to the caracter height. */);
25076 overline_margin
= 2;
25078 DEFVAR_INT ("underline-minimum-offset",
25079 &underline_minimum_offset
,
25080 doc
: /* Minimum distance between baseline and underline.
25081 This can improve legibility of underlined text at small font sizes,
25082 particularly when using variable `x-use-underline-position-properties'
25083 with fonts that specify an UNDERLINE_POSITION relatively close to the
25084 baseline. The default value is 1. */);
25085 underline_minimum_offset
= 1;
25089 /* Initialize this module when Emacs starts. */
25094 Lisp_Object root_window
;
25095 struct window
*mini_w
;
25097 current_header_line_height
= current_mode_line_height
= -1;
25099 CHARPOS (this_line_start_pos
) = 0;
25101 mini_w
= XWINDOW (minibuf_window
);
25102 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
25104 if (!noninteractive
)
25106 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
25109 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
25110 set_window_height (root_window
,
25111 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
25113 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
25114 set_window_height (minibuf_window
, 1, 0);
25116 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
25117 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
25119 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
25120 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
25121 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
25123 /* The default ellipsis glyphs `...'. */
25124 for (i
= 0; i
< 3; ++i
)
25125 default_invis_vector
[i
] = make_number ('.');
25129 /* Allocate the buffer for frame titles.
25130 Also used for `format-mode-line'. */
25132 mode_line_noprop_buf
= (char *) xmalloc (size
);
25133 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
25134 mode_line_noprop_ptr
= mode_line_noprop_buf
;
25135 mode_line_target
= MODE_LINE_DISPLAY
;
25138 help_echo_showing_p
= 0;
25142 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
25143 (do not change this comment) */