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, 2009, 2010
5 Free Software Foundation, Inc.
7 This file is part of GNU Emacs.
9 GNU Emacs is free software: you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation, either version 3 of the License, or
12 (at your option) any later version.
14 GNU Emacs is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
26 Emacs separates the task of updating the display from code
27 modifying global state, e.g. buffer text. This way functions
28 operating on buffers don't also have to be concerned with updating
31 Updating the display is triggered by the Lisp interpreter when it
32 decides it's time to do it. This is done either automatically for
33 you as part of the interpreter's command loop or as the result of
34 calling Lisp functions like `sit-for'. The C function `redisplay'
35 in xdisp.c is the only entry into the inner redisplay code.
37 The following diagram shows how redisplay code is invoked. As you
38 can see, Lisp calls redisplay and vice versa. Under window systems
39 like X, some portions of the redisplay code are also called
40 asynchronously during mouse movement or expose events. It is very
41 important that these code parts do NOT use the C library (malloc,
42 free) because many C libraries under Unix are not reentrant. They
43 may also NOT call functions of the Lisp interpreter which could
44 change the interpreter's state. If you don't follow these rules,
45 you will encounter bugs which are very hard to explain.
47 +--------------+ redisplay +----------------+
48 | Lisp machine |---------------->| Redisplay code |<--+
49 +--------------+ (xdisp.c) +----------------+ |
51 +----------------------------------+ |
52 Don't use this path when called |
55 expose_window (asynchronous) |
57 X expose events -----+
59 What does redisplay do? Obviously, it has to figure out somehow what
60 has been changed since the last time the display has been updated,
61 and to make these changes visible. Preferably it would do that in
62 a moderately intelligent way, i.e. fast.
64 Changes in buffer text can be deduced from window and buffer
65 structures, and from some global variables like `beg_unchanged' and
66 `end_unchanged'. The contents of the display are additionally
67 recorded in a `glyph matrix', a two-dimensional matrix of glyph
68 structures. Each row in such a matrix corresponds to a line on the
69 display, and each glyph in a row corresponds to a column displaying
70 a character, an image, or what else. This matrix is called the
71 `current glyph matrix' or `current matrix' in redisplay
74 For buffer parts that have been changed since the last update, a
75 second glyph matrix is constructed, the so called `desired glyph
76 matrix' or short `desired matrix'. Current and desired matrix are
77 then compared to find a cheap way to update the display, e.g. by
78 reusing part of the display by scrolling lines.
80 You will find a lot of redisplay optimizations when you start
81 looking at the innards of redisplay. The overall goal of all these
82 optimizations is to make redisplay fast because it is done
87 Desired matrices are always built per Emacs window. The function
88 `display_line' is the central function to look at if you are
89 interested. It constructs one row in a desired matrix given an
90 iterator structure containing both a buffer position and a
91 description of the environment in which the text is to be
92 displayed. But this is too early, read on.
94 Characters and pixmaps displayed for a range of buffer text depend
95 on various settings of buffers and windows, on overlays and text
96 properties, on display tables, on selective display. The good news
97 is that all this hairy stuff is hidden behind a small set of
98 interface functions taking an iterator structure (struct it)
101 Iteration over things to be displayed is then simple. It is
102 started by initializing an iterator with a call to init_iterator.
103 Calls to get_next_display_element fill the iterator structure with
104 relevant information about the next thing to display. Calls to
105 set_iterator_to_next move the iterator to the next thing.
107 Besides this, an iterator also contains information about the
108 display environment in which glyphs for display elements are to be
109 produced. It has fields for the width and height of the display,
110 the information whether long lines are truncated or continued, a
111 current X and Y position, and lots of other stuff you can better
114 Glyphs in a desired matrix are normally constructed in a loop
115 calling get_next_display_element and then produce_glyphs. The call
116 to produce_glyphs will fill the iterator structure with pixel
117 information about the element being displayed and at the same time
118 produce glyphs for it. If the display element fits on the line
119 being displayed, set_iterator_to_next is called next, otherwise the
120 glyphs produced are discarded.
125 That just couldn't be all, could it? What about terminal types not
126 supporting operations on sub-windows of the screen? To update the
127 display on such a terminal, window-based glyph matrices are not
128 well suited. To be able to reuse part of the display (scrolling
129 lines up and down), we must instead have a view of the whole
130 screen. This is what `frame matrices' are for. They are a trick.
132 Frames on terminals like above have a glyph pool. Windows on such
133 a frame sub-allocate their glyph memory from their frame's glyph
134 pool. The frame itself is given its own glyph matrices. By
135 coincidence---or maybe something else---rows in window glyph
136 matrices are slices of corresponding rows in frame matrices. Thus
137 writing to window matrices implicitly updates a frame matrix which
138 provides us with the view of the whole screen that we originally
139 wanted to have without having to move many bytes around. To be
140 honest, there is a little bit more done, but not much more. If you
141 plan to extend that code, take a look at dispnew.c. The function
142 build_frame_matrix is a good starting point. */
150 #include "keyboard.h"
153 #include "termchar.h"
154 #include "dispextern.h"
156 #include "character.h"
159 #include "commands.h"
163 #include "termhooks.h"
164 #include "intervals.h"
167 #include "region-cache.h"
170 #include "blockinput.h"
172 #ifdef HAVE_X_WINDOWS
187 #ifndef FRAME_X_OUTPUT
188 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
191 #define INFINITY 10000000
193 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
194 || defined(HAVE_NS) || defined (USE_GTK)
195 extern void set_frame_menubar
P_ ((struct frame
*f
, int, int));
196 extern int pending_menu_activation
;
199 extern int interrupt_input
;
200 extern int command_loop_level
;
202 extern Lisp_Object do_mouse_tracking
;
204 extern int minibuffer_auto_raise
;
205 extern Lisp_Object Vminibuffer_list
;
207 extern Lisp_Object Qface
;
208 extern Lisp_Object Qmode_line
, Qmode_line_inactive
, Qheader_line
;
210 extern Lisp_Object Voverriding_local_map
;
211 extern Lisp_Object Voverriding_local_map_menu_flag
;
212 extern Lisp_Object Qmenu_item
;
213 extern Lisp_Object Qwhen
;
214 extern Lisp_Object Qhelp_echo
;
215 extern Lisp_Object Qbefore_string
, Qafter_string
;
217 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
218 Lisp_Object Qwindow_scroll_functions
, Vwindow_scroll_functions
;
219 Lisp_Object Qwindow_text_change_functions
, Vwindow_text_change_functions
;
220 Lisp_Object Qredisplay_end_trigger_functions
, Vredisplay_end_trigger_functions
;
221 Lisp_Object Qinhibit_point_motion_hooks
;
222 Lisp_Object QCeval
, QCfile
, QCdata
, QCpropertize
;
223 Lisp_Object Qfontified
;
224 Lisp_Object Qgrow_only
;
225 Lisp_Object Qinhibit_eval_during_redisplay
;
226 Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
227 Lisp_Object Qright_to_left
, Qleft_to_right
;
230 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
233 Lisp_Object Qarrow
, Qhand
, Qtext
;
235 Lisp_Object Qrisky_local_variable
;
237 /* Holds the list (error). */
238 Lisp_Object list_of_error
;
240 /* Functions called to fontify regions of text. */
242 Lisp_Object Vfontification_functions
;
243 Lisp_Object Qfontification_functions
;
245 /* Non-nil means automatically select any window when the mouse
246 cursor moves into it. */
247 Lisp_Object Vmouse_autoselect_window
;
249 Lisp_Object Vwrap_prefix
, Qwrap_prefix
;
250 Lisp_Object Vline_prefix
, Qline_prefix
;
252 /* Non-zero means draw tool bar buttons raised when the mouse moves
255 int auto_raise_tool_bar_buttons_p
;
257 /* Non-zero means to reposition window if cursor line is only partially visible. */
259 int make_cursor_line_fully_visible_p
;
261 /* Margin below tool bar in pixels. 0 or nil means no margin.
262 If value is `internal-border-width' or `border-width',
263 the corresponding frame parameter is used. */
265 Lisp_Object Vtool_bar_border
;
267 /* Margin around tool bar buttons in pixels. */
269 Lisp_Object Vtool_bar_button_margin
;
271 /* Thickness of shadow to draw around tool bar buttons. */
273 EMACS_INT tool_bar_button_relief
;
275 /* Non-nil means automatically resize tool-bars so that all tool-bar
276 items are visible, and no blank lines remain.
278 If value is `grow-only', only make tool-bar bigger. */
280 Lisp_Object Vauto_resize_tool_bars
;
282 /* Non-zero means draw block and hollow cursor as wide as the glyph
283 under it. For example, if a block cursor is over a tab, it will be
284 drawn as wide as that tab on the display. */
286 int x_stretch_cursor_p
;
288 /* Non-nil means don't actually do any redisplay. */
290 Lisp_Object Vinhibit_redisplay
, Qinhibit_redisplay
;
292 /* Non-zero means Lisp evaluation during redisplay is inhibited. */
294 int inhibit_eval_during_redisplay
;
296 /* Names of text properties relevant for redisplay. */
298 Lisp_Object Qdisplay
;
299 extern Lisp_Object Qface
, Qinvisible
, Qwidth
;
301 /* Symbols used in text property values. */
303 Lisp_Object Vdisplay_pixels_per_inch
;
304 Lisp_Object Qspace
, QCalign_to
, QCrelative_width
, QCrelative_height
;
305 Lisp_Object Qleft_margin
, Qright_margin
, Qspace_width
, Qraise
;
308 Lisp_Object Qmargin
, Qpointer
;
309 Lisp_Object Qline_height
;
310 extern Lisp_Object Qheight
;
311 extern Lisp_Object QCwidth
, QCheight
, QCascent
;
312 extern Lisp_Object Qscroll_bar
;
313 extern Lisp_Object Qcursor
;
315 /* Non-nil means highlight trailing whitespace. */
317 Lisp_Object Vshow_trailing_whitespace
;
319 /* Non-nil means escape non-break space and hyphens. */
321 Lisp_Object Vnobreak_char_display
;
323 #ifdef HAVE_WINDOW_SYSTEM
324 extern Lisp_Object Voverflow_newline_into_fringe
;
326 /* Test if overflow newline into fringe. Called with iterator IT
327 at or past right window margin, and with IT->current_x set. */
329 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) \
330 (!NILP (Voverflow_newline_into_fringe) \
331 && FRAME_WINDOW_P (it->f) \
332 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) > 0 \
333 && it->current_x == it->last_visible_x \
334 && it->line_wrap != WORD_WRAP)
336 #else /* !HAVE_WINDOW_SYSTEM */
337 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
338 #endif /* HAVE_WINDOW_SYSTEM */
340 /* Test if the display element loaded in IT is a space or tab
341 character. This is used to determine word wrapping. */
343 #define IT_DISPLAYING_WHITESPACE(it) \
344 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
346 /* Non-nil means show the text cursor in void text areas
347 i.e. in blank areas after eol and eob. This used to be
348 the default in 21.3. */
350 Lisp_Object Vvoid_text_area_pointer
;
352 /* Name of the face used to highlight trailing whitespace. */
354 Lisp_Object Qtrailing_whitespace
;
356 /* Name and number of the face used to highlight escape glyphs. */
358 Lisp_Object Qescape_glyph
;
360 /* Name and number of the face used to highlight non-breaking spaces. */
362 Lisp_Object Qnobreak_space
;
364 /* The symbol `image' which is the car of the lists used to represent
369 /* The image map types. */
370 Lisp_Object QCmap
, QCpointer
;
371 Lisp_Object Qrect
, Qcircle
, Qpoly
;
373 /* Non-zero means print newline to stdout before next mini-buffer
376 int noninteractive_need_newline
;
378 /* Non-zero means print newline to message log before next message. */
380 static int message_log_need_newline
;
382 /* Three markers that message_dolog uses.
383 It could allocate them itself, but that causes trouble
384 in handling memory-full errors. */
385 static Lisp_Object message_dolog_marker1
;
386 static Lisp_Object message_dolog_marker2
;
387 static Lisp_Object message_dolog_marker3
;
389 /* The buffer position of the first character appearing entirely or
390 partially on the line of the selected window which contains the
391 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
392 redisplay optimization in redisplay_internal. */
394 static struct text_pos this_line_start_pos
;
396 /* Number of characters past the end of the line above, including the
397 terminating newline. */
399 static struct text_pos this_line_end_pos
;
401 /* The vertical positions and the height of this line. */
403 static int this_line_vpos
;
404 static int this_line_y
;
405 static int this_line_pixel_height
;
407 /* X position at which this display line starts. Usually zero;
408 negative if first character is partially visible. */
410 static int this_line_start_x
;
412 /* Buffer that this_line_.* variables are referring to. */
414 static struct buffer
*this_line_buffer
;
416 /* Nonzero means truncate lines in all windows less wide than the
419 Lisp_Object Vtruncate_partial_width_windows
;
421 /* A flag to control how to display unibyte 8-bit character. */
423 int unibyte_display_via_language_environment
;
425 /* Nonzero means we have more than one non-mini-buffer-only frame.
426 Not guaranteed to be accurate except while parsing
427 frame-title-format. */
431 Lisp_Object Vglobal_mode_string
;
434 /* List of variables (symbols) which hold markers for overlay arrows.
435 The symbols on this list are examined during redisplay to determine
436 where to display overlay arrows. */
438 Lisp_Object Voverlay_arrow_variable_list
;
440 /* Marker for where to display an arrow on top of the buffer text. */
442 Lisp_Object Voverlay_arrow_position
;
444 /* String to display for the arrow. Only used on terminal frames. */
446 Lisp_Object Voverlay_arrow_string
;
448 /* Values of those variables at last redisplay are stored as
449 properties on `overlay-arrow-position' symbol. However, if
450 Voverlay_arrow_position is a marker, last-arrow-position is its
451 numerical position. */
453 Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
455 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
456 properties on a symbol in overlay-arrow-variable-list. */
458 Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
460 /* Like mode-line-format, but for the title bar on a visible frame. */
462 Lisp_Object Vframe_title_format
;
464 /* Like mode-line-format, but for the title bar on an iconified frame. */
466 Lisp_Object Vicon_title_format
;
468 /* List of functions to call when a window's size changes. These
469 functions get one arg, a frame on which one or more windows' sizes
472 static Lisp_Object Vwindow_size_change_functions
;
474 Lisp_Object Qmenu_bar_update_hook
, Vmenu_bar_update_hook
;
476 /* Nonzero if an overlay arrow has been displayed in this window. */
478 static int overlay_arrow_seen
;
480 /* Nonzero means highlight the region even in nonselected windows. */
482 int highlight_nonselected_windows
;
484 /* If cursor motion alone moves point off frame, try scrolling this
485 many lines up or down if that will bring it back. */
487 static EMACS_INT scroll_step
;
489 /* Nonzero means scroll just far enough to bring point back on the
490 screen, when appropriate. */
492 static EMACS_INT scroll_conservatively
;
494 /* Recenter the window whenever point gets within this many lines of
495 the top or bottom of the window. This value is translated into a
496 pixel value by multiplying it with FRAME_LINE_HEIGHT, which means
497 that there is really a fixed pixel height scroll margin. */
499 EMACS_INT scroll_margin
;
501 /* Number of windows showing the buffer of the selected window (or
502 another buffer with the same base buffer). keyboard.c refers to
507 /* Vector containing glyphs for an ellipsis `...'. */
509 static Lisp_Object default_invis_vector
[3];
511 /* Zero means display the mode-line/header-line/menu-bar in the default face
512 (this slightly odd definition is for compatibility with previous versions
513 of emacs), non-zero means display them using their respective faces.
515 This variable is deprecated. */
517 int mode_line_inverse_video
;
519 /* Prompt to display in front of the mini-buffer contents. */
521 Lisp_Object minibuf_prompt
;
523 /* Width of current mini-buffer prompt. Only set after display_line
524 of the line that contains the prompt. */
526 int minibuf_prompt_width
;
528 /* This is the window where the echo area message was displayed. It
529 is always a mini-buffer window, but it may not be the same window
530 currently active as a mini-buffer. */
532 Lisp_Object echo_area_window
;
534 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
535 pushes the current message and the value of
536 message_enable_multibyte on the stack, the function restore_message
537 pops the stack and displays MESSAGE again. */
539 Lisp_Object Vmessage_stack
;
541 /* Nonzero means multibyte characters were enabled when the echo area
542 message was specified. */
544 int message_enable_multibyte
;
546 /* Nonzero if we should redraw the mode lines on the next redisplay. */
548 int update_mode_lines
;
550 /* Nonzero if window sizes or contents have changed since last
551 redisplay that finished. */
553 int windows_or_buffers_changed
;
555 /* Nonzero means a frame's cursor type has been changed. */
557 int cursor_type_changed
;
559 /* Nonzero after display_mode_line if %l was used and it displayed a
562 int line_number_displayed
;
564 /* Maximum buffer size for which to display line numbers. */
566 Lisp_Object Vline_number_display_limit
;
568 /* Line width to consider when repositioning for line number display. */
570 static EMACS_INT line_number_display_limit_width
;
572 /* Number of lines to keep in the message log buffer. t means
573 infinite. nil means don't log at all. */
575 Lisp_Object Vmessage_log_max
;
577 /* The name of the *Messages* buffer, a string. */
579 static Lisp_Object Vmessages_buffer_name
;
581 /* Current, index 0, and last displayed echo area message. Either
582 buffers from echo_buffers, or nil to indicate no message. */
584 Lisp_Object echo_area_buffer
[2];
586 /* The buffers referenced from echo_area_buffer. */
588 static Lisp_Object echo_buffer
[2];
590 /* A vector saved used in with_area_buffer to reduce consing. */
592 static Lisp_Object Vwith_echo_area_save_vector
;
594 /* Non-zero means display_echo_area should display the last echo area
595 message again. Set by redisplay_preserve_echo_area. */
597 static int display_last_displayed_message_p
;
599 /* Nonzero if echo area is being used by print; zero if being used by
602 int message_buf_print
;
604 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
606 Lisp_Object Qinhibit_menubar_update
;
607 int inhibit_menubar_update
;
609 /* When evaluating expressions from menu bar items (enable conditions,
610 for instance), this is the frame they are being processed for. */
612 Lisp_Object Vmenu_updating_frame
;
614 /* Maximum height for resizing mini-windows. Either a float
615 specifying a fraction of the available height, or an integer
616 specifying a number of lines. */
618 Lisp_Object Vmax_mini_window_height
;
620 /* Non-zero means messages should be displayed with truncated
621 lines instead of being continued. */
623 int message_truncate_lines
;
624 Lisp_Object Qmessage_truncate_lines
;
626 /* Set to 1 in clear_message to make redisplay_internal aware
627 of an emptied echo area. */
629 static int message_cleared_p
;
631 /* How to blink the default frame cursor off. */
632 Lisp_Object Vblink_cursor_alist
;
634 /* A scratch glyph row with contents used for generating truncation
635 glyphs. Also used in direct_output_for_insert. */
637 #define MAX_SCRATCH_GLYPHS 100
638 struct glyph_row scratch_glyph_row
;
639 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
641 /* Ascent and height of the last line processed by move_it_to. */
643 static int last_max_ascent
, last_height
;
645 /* Non-zero if there's a help-echo in the echo area. */
647 int help_echo_showing_p
;
649 /* If >= 0, computed, exact values of mode-line and header-line height
650 to use in the macros CURRENT_MODE_LINE_HEIGHT and
651 CURRENT_HEADER_LINE_HEIGHT. */
653 int current_mode_line_height
, current_header_line_height
;
655 /* The maximum distance to look ahead for text properties. Values
656 that are too small let us call compute_char_face and similar
657 functions too often which is expensive. Values that are too large
658 let us call compute_char_face and alike too often because we
659 might not be interested in text properties that far away. */
661 #define TEXT_PROP_DISTANCE_LIMIT 100
665 /* Variables to turn off display optimizations from Lisp. */
667 int inhibit_try_window_id
, inhibit_try_window_reusing
;
668 int inhibit_try_cursor_movement
;
670 /* Non-zero means print traces of redisplay if compiled with
673 int trace_redisplay_p
;
675 #endif /* GLYPH_DEBUG */
677 #ifdef DEBUG_TRACE_MOVE
678 /* Non-zero means trace with TRACE_MOVE to stderr. */
681 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
683 #define TRACE_MOVE(x) (void) 0
686 /* Non-zero means automatically scroll windows horizontally to make
689 int automatic_hscrolling_p
;
690 Lisp_Object Qauto_hscroll_mode
;
692 /* How close to the margin can point get before the window is scrolled
694 EMACS_INT hscroll_margin
;
696 /* How much to scroll horizontally when point is inside the above margin. */
697 Lisp_Object Vhscroll_step
;
699 /* The variable `resize-mini-windows'. If nil, don't resize
700 mini-windows. If t, always resize them to fit the text they
701 display. If `grow-only', let mini-windows grow only until they
704 Lisp_Object Vresize_mini_windows
;
706 /* Buffer being redisplayed -- for redisplay_window_error. */
708 struct buffer
*displayed_buffer
;
710 /* Space between overline and text. */
712 EMACS_INT overline_margin
;
714 /* Require underline to be at least this many screen pixels below baseline
715 This to avoid underline "merging" with the base of letters at small
716 font sizes, particularly when x_use_underline_position_properties is on. */
718 EMACS_INT underline_minimum_offset
;
720 /* Value returned from text property handlers (see below). */
725 HANDLED_RECOMPUTE_PROPS
,
726 HANDLED_OVERLAY_STRING_CONSUMED
,
730 /* A description of text properties that redisplay is interested
735 /* The name of the property. */
738 /* A unique index for the property. */
741 /* A handler function called to set up iterator IT from the property
742 at IT's current position. Value is used to steer handle_stop. */
743 enum prop_handled (*handler
) P_ ((struct it
*it
));
746 static enum prop_handled handle_face_prop
P_ ((struct it
*));
747 static enum prop_handled handle_invisible_prop
P_ ((struct it
*));
748 static enum prop_handled handle_display_prop
P_ ((struct it
*));
749 static enum prop_handled handle_composition_prop
P_ ((struct it
*));
750 static enum prop_handled handle_overlay_change
P_ ((struct it
*));
751 static enum prop_handled handle_fontified_prop
P_ ((struct it
*));
753 /* Properties handled by iterators. */
755 static struct props it_props
[] =
757 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
758 /* Handle `face' before `display' because some sub-properties of
759 `display' need to know the face. */
760 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
761 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
762 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
763 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
767 /* Value is the position described by X. If X is a marker, value is
768 the marker_position of X. Otherwise, value is X. */
770 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
772 /* Enumeration returned by some move_it_.* functions internally. */
776 /* Not used. Undefined value. */
779 /* Move ended at the requested buffer position or ZV. */
780 MOVE_POS_MATCH_OR_ZV
,
782 /* Move ended at the requested X pixel position. */
785 /* Move within a line ended at the end of a line that must be
789 /* Move within a line ended at the end of a line that would
790 be displayed truncated. */
793 /* Move within a line ended at a line end. */
797 /* This counter is used to clear the face cache every once in a while
798 in redisplay_internal. It is incremented for each redisplay.
799 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
802 #define CLEAR_FACE_CACHE_COUNT 500
803 static int clear_face_cache_count
;
805 /* Similarly for the image cache. */
807 #ifdef HAVE_WINDOW_SYSTEM
808 #define CLEAR_IMAGE_CACHE_COUNT 101
809 static int clear_image_cache_count
;
812 /* Non-zero while redisplay_internal is in progress. */
816 /* Non-zero means don't free realized faces. Bound while freeing
817 realized faces is dangerous because glyph matrices might still
820 int inhibit_free_realized_faces
;
821 Lisp_Object Qinhibit_free_realized_faces
;
823 /* If a string, XTread_socket generates an event to display that string.
824 (The display is done in read_char.) */
826 Lisp_Object help_echo_string
;
827 Lisp_Object help_echo_window
;
828 Lisp_Object help_echo_object
;
831 /* Temporary variable for XTread_socket. */
833 Lisp_Object previous_help_echo_string
;
835 /* Null glyph slice */
837 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
839 /* Platform-independent portion of hourglass implementation. */
841 /* Non-zero means we're allowed to display a hourglass pointer. */
842 int display_hourglass_p
;
844 /* Non-zero means an hourglass cursor is currently shown. */
845 int hourglass_shown_p
;
847 /* If non-null, an asynchronous timer that, when it expires, displays
848 an hourglass cursor on all frames. */
849 struct atimer
*hourglass_atimer
;
851 /* Number of seconds to wait before displaying an hourglass cursor. */
852 Lisp_Object Vhourglass_delay
;
854 /* Default number of seconds to wait before displaying an hourglass
856 #define DEFAULT_HOURGLASS_DELAY 1
859 /* Function prototypes. */
861 static void setup_for_ellipsis
P_ ((struct it
*, int));
862 static void mark_window_display_accurate_1
P_ ((struct window
*, int));
863 static int single_display_spec_string_p
P_ ((Lisp_Object
, Lisp_Object
));
864 static int display_prop_string_p
P_ ((Lisp_Object
, Lisp_Object
));
865 static int cursor_row_p
P_ ((struct window
*, struct glyph_row
*));
866 static int redisplay_mode_lines
P_ ((Lisp_Object
, int));
867 static char *decode_mode_spec_coding
P_ ((Lisp_Object
, char *, int));
869 static Lisp_Object get_it_property
P_ ((struct it
*it
, Lisp_Object prop
));
871 static void handle_line_prefix
P_ ((struct it
*));
873 static void pint2str
P_ ((char *, int, int));
874 static void pint2hrstr
P_ ((char *, int, int));
875 static struct text_pos run_window_scroll_functions
P_ ((Lisp_Object
,
877 static void reconsider_clip_changes
P_ ((struct window
*, struct buffer
*));
878 static int text_outside_line_unchanged_p
P_ ((struct window
*, int, int));
879 static void store_mode_line_noprop_char
P_ ((char));
880 static int store_mode_line_noprop
P_ ((const unsigned char *, int, int));
881 static void x_consider_frame_title
P_ ((Lisp_Object
));
882 static void handle_stop
P_ ((struct it
*));
883 static void handle_stop_backwards
P_ ((struct it
*, EMACS_INT
));
884 static int tool_bar_lines_needed
P_ ((struct frame
*, int *));
885 static int single_display_spec_intangible_p
P_ ((Lisp_Object
));
886 static void ensure_echo_area_buffers
P_ ((void));
887 static Lisp_Object unwind_with_echo_area_buffer
P_ ((Lisp_Object
));
888 static Lisp_Object with_echo_area_buffer_unwind_data
P_ ((struct window
*));
889 static int with_echo_area_buffer
P_ ((struct window
*, int,
890 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
891 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
892 static void clear_garbaged_frames
P_ ((void));
893 static int current_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
894 static int truncate_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
895 static int set_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
896 static int display_echo_area
P_ ((struct window
*));
897 static int display_echo_area_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
898 static int resize_mini_window_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
899 static Lisp_Object unwind_redisplay
P_ ((Lisp_Object
));
900 static int string_char_and_length
P_ ((const unsigned char *, int *));
901 static struct text_pos display_prop_end
P_ ((struct it
*, Lisp_Object
,
903 static int compute_window_start_on_continuation_line
P_ ((struct window
*));
904 static Lisp_Object safe_eval_handler
P_ ((Lisp_Object
));
905 static void insert_left_trunc_glyphs
P_ ((struct it
*));
906 static struct glyph_row
*get_overlay_arrow_glyph_row
P_ ((struct window
*,
908 static void extend_face_to_end_of_line
P_ ((struct it
*));
909 static int append_space_for_newline
P_ ((struct it
*, int));
910 static int cursor_row_fully_visible_p
P_ ((struct window
*, int, int));
911 static int try_scrolling
P_ ((Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int));
912 static int try_cursor_movement
P_ ((Lisp_Object
, struct text_pos
, int *));
913 static int trailing_whitespace_p
P_ ((int));
914 static int message_log_check_duplicate
P_ ((int, int, int, int));
915 static void push_it
P_ ((struct it
*));
916 static void pop_it
P_ ((struct it
*));
917 static void sync_frame_with_window_matrix_rows
P_ ((struct window
*));
918 static void select_frame_for_redisplay
P_ ((Lisp_Object
));
919 static void redisplay_internal
P_ ((int));
920 static int echo_area_display
P_ ((int));
921 static void redisplay_windows
P_ ((Lisp_Object
));
922 static void redisplay_window
P_ ((Lisp_Object
, int));
923 static Lisp_Object
redisplay_window_error ();
924 static Lisp_Object redisplay_window_0
P_ ((Lisp_Object
));
925 static Lisp_Object redisplay_window_1
P_ ((Lisp_Object
));
926 static int update_menu_bar
P_ ((struct frame
*, int, int));
927 static int try_window_reusing_current_matrix
P_ ((struct window
*));
928 static int try_window_id
P_ ((struct window
*));
929 static int display_line
P_ ((struct it
*));
930 static int display_mode_lines
P_ ((struct window
*));
931 static int display_mode_line
P_ ((struct window
*, enum face_id
, Lisp_Object
));
932 static int display_mode_element
P_ ((struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int));
933 static int store_mode_line_string
P_ ((char *, Lisp_Object
, int, int, int, Lisp_Object
));
934 static char *decode_mode_spec
P_ ((struct window
*, int, int, int,
936 static void display_menu_bar
P_ ((struct window
*));
937 static int display_count_lines
P_ ((int, int, int, int, int *));
938 static int display_string
P_ ((unsigned char *, Lisp_Object
, Lisp_Object
,
939 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int));
940 static void compute_line_metrics
P_ ((struct it
*));
941 static void run_redisplay_end_trigger_hook
P_ ((struct it
*));
942 static int get_overlay_strings
P_ ((struct it
*, int));
943 static int get_overlay_strings_1
P_ ((struct it
*, int, int));
944 static void next_overlay_string
P_ ((struct it
*));
945 static void reseat
P_ ((struct it
*, struct text_pos
, int));
946 static void reseat_1
P_ ((struct it
*, struct text_pos
, int));
947 static void back_to_previous_visible_line_start
P_ ((struct it
*));
948 void reseat_at_previous_visible_line_start
P_ ((struct it
*));
949 static void reseat_at_next_visible_line_start
P_ ((struct it
*, int));
950 static int next_element_from_ellipsis
P_ ((struct it
*));
951 static int next_element_from_display_vector
P_ ((struct it
*));
952 static int next_element_from_string
P_ ((struct it
*));
953 static int next_element_from_c_string
P_ ((struct it
*));
954 static int next_element_from_buffer
P_ ((struct it
*));
955 static int next_element_from_composition
P_ ((struct it
*));
956 static int next_element_from_image
P_ ((struct it
*));
957 static int next_element_from_stretch
P_ ((struct it
*));
958 static void load_overlay_strings
P_ ((struct it
*, int));
959 static int init_from_display_pos
P_ ((struct it
*, struct window
*,
960 struct display_pos
*));
961 static void reseat_to_string
P_ ((struct it
*, unsigned char *,
962 Lisp_Object
, int, int, int, int));
963 static enum move_it_result
964 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
965 enum move_operation_enum
);
966 void move_it_vertically_backward
P_ ((struct it
*, int));
967 static void init_to_row_start
P_ ((struct it
*, struct window
*,
968 struct glyph_row
*));
969 static int init_to_row_end
P_ ((struct it
*, struct window
*,
970 struct glyph_row
*));
971 static void back_to_previous_line_start
P_ ((struct it
*));
972 static int forward_to_next_line_start
P_ ((struct it
*, int *));
973 static struct text_pos string_pos_nchars_ahead
P_ ((struct text_pos
,
975 static struct text_pos string_pos
P_ ((int, Lisp_Object
));
976 static struct text_pos c_string_pos
P_ ((int, unsigned char *, int));
977 static int number_of_chars
P_ ((unsigned char *, int));
978 static void compute_stop_pos
P_ ((struct it
*));
979 static void compute_string_pos
P_ ((struct text_pos
*, struct text_pos
,
981 static int face_before_or_after_it_pos
P_ ((struct it
*, int));
982 static EMACS_INT next_overlay_change
P_ ((EMACS_INT
));
983 static int handle_single_display_spec
P_ ((struct it
*, Lisp_Object
,
984 Lisp_Object
, Lisp_Object
,
985 struct text_pos
*, int));
986 static int underlying_face_id
P_ ((struct it
*));
987 static int in_ellipses_for_invisible_text_p
P_ ((struct display_pos
*,
990 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
991 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
993 #ifdef HAVE_WINDOW_SYSTEM
995 static void update_tool_bar
P_ ((struct frame
*, int));
996 static void build_desired_tool_bar_string
P_ ((struct frame
*f
));
997 static int redisplay_tool_bar
P_ ((struct frame
*));
998 static void display_tool_bar_line
P_ ((struct it
*, int));
999 static void notice_overwritten_cursor
P_ ((struct window
*,
1000 enum glyph_row_area
,
1001 int, int, int, int));
1005 #endif /* HAVE_WINDOW_SYSTEM */
1008 /***********************************************************************
1009 Window display dimensions
1010 ***********************************************************************/
1012 /* Return the bottom boundary y-position for text lines in window W.
1013 This is the first y position at which a line cannot start.
1014 It is relative to the top of the window.
1016 This is the height of W minus the height of a mode line, if any. */
1019 window_text_bottom_y (w
)
1022 int height
= WINDOW_TOTAL_HEIGHT (w
);
1024 if (WINDOW_WANTS_MODELINE_P (w
))
1025 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
1029 /* Return the pixel width of display area AREA of window W. AREA < 0
1030 means return the total width of W, not including fringes to
1031 the left and right of the window. */
1034 window_box_width (w
, area
)
1038 int cols
= XFASTINT (w
->total_cols
);
1041 if (!w
->pseudo_window_p
)
1043 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
1045 if (area
== TEXT_AREA
)
1047 if (INTEGERP (w
->left_margin_cols
))
1048 cols
-= XFASTINT (w
->left_margin_cols
);
1049 if (INTEGERP (w
->right_margin_cols
))
1050 cols
-= XFASTINT (w
->right_margin_cols
);
1051 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
1053 else if (area
== LEFT_MARGIN_AREA
)
1055 cols
= (INTEGERP (w
->left_margin_cols
)
1056 ? XFASTINT (w
->left_margin_cols
) : 0);
1059 else if (area
== RIGHT_MARGIN_AREA
)
1061 cols
= (INTEGERP (w
->right_margin_cols
)
1062 ? XFASTINT (w
->right_margin_cols
) : 0);
1067 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1071 /* Return the pixel height of the display area of window W, not
1072 including mode lines of W, if any. */
1075 window_box_height (w
)
1078 struct frame
*f
= XFRAME (w
->frame
);
1079 int height
= WINDOW_TOTAL_HEIGHT (w
);
1081 xassert (height
>= 0);
1083 /* Note: the code below that determines the mode-line/header-line
1084 height is essentially the same as that contained in the macro
1085 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1086 the appropriate glyph row has its `mode_line_p' flag set,
1087 and if it doesn't, uses estimate_mode_line_height instead. */
1089 if (WINDOW_WANTS_MODELINE_P (w
))
1091 struct glyph_row
*ml_row
1092 = (w
->current_matrix
&& w
->current_matrix
->rows
1093 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1095 if (ml_row
&& ml_row
->mode_line_p
)
1096 height
-= ml_row
->height
;
1098 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1101 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1103 struct glyph_row
*hl_row
1104 = (w
->current_matrix
&& w
->current_matrix
->rows
1105 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1107 if (hl_row
&& hl_row
->mode_line_p
)
1108 height
-= hl_row
->height
;
1110 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1113 /* With a very small font and a mode-line that's taller than
1114 default, we might end up with a negative height. */
1115 return max (0, height
);
1118 /* Return the window-relative coordinate of the left edge of display
1119 area AREA of window W. AREA < 0 means return the left edge of the
1120 whole window, to the right of the left fringe of W. */
1123 window_box_left_offset (w
, area
)
1129 if (w
->pseudo_window_p
)
1132 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1134 if (area
== TEXT_AREA
)
1135 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1136 + window_box_width (w
, LEFT_MARGIN_AREA
));
1137 else if (area
== RIGHT_MARGIN_AREA
)
1138 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1139 + window_box_width (w
, LEFT_MARGIN_AREA
)
1140 + window_box_width (w
, TEXT_AREA
)
1141 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1143 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1144 else if (area
== LEFT_MARGIN_AREA
1145 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1146 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1152 /* Return the window-relative coordinate of the right edge of display
1153 area AREA of window W. AREA < 0 means return the left edge of the
1154 whole window, to the left of the right fringe of W. */
1157 window_box_right_offset (w
, area
)
1161 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1164 /* Return the frame-relative coordinate of the left edge of display
1165 area AREA of window W. AREA < 0 means return the left edge of the
1166 whole window, to the right of the left fringe of W. */
1169 window_box_left (w
, area
)
1173 struct frame
*f
= XFRAME (w
->frame
);
1176 if (w
->pseudo_window_p
)
1177 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1179 x
= (WINDOW_LEFT_EDGE_X (w
)
1180 + window_box_left_offset (w
, area
));
1186 /* Return the frame-relative coordinate of the right edge of display
1187 area AREA of window W. AREA < 0 means return the left edge of the
1188 whole window, to the left of the right fringe of W. */
1191 window_box_right (w
, area
)
1195 return window_box_left (w
, area
) + window_box_width (w
, area
);
1198 /* Get the bounding box of the display area AREA of window W, without
1199 mode lines, in frame-relative coordinates. AREA < 0 means the
1200 whole window, not including the left and right fringes of
1201 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1202 coordinates of the upper-left corner of the box. Return in
1203 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1206 window_box (w
, area
, box_x
, box_y
, box_width
, box_height
)
1209 int *box_x
, *box_y
, *box_width
, *box_height
;
1212 *box_width
= window_box_width (w
, area
);
1214 *box_height
= window_box_height (w
);
1216 *box_x
= window_box_left (w
, area
);
1219 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1220 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1221 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1226 /* Get the bounding box of the display area AREA of window W, without
1227 mode lines. AREA < 0 means the whole window, not including the
1228 left and right fringe of the window. Return in *TOP_LEFT_X
1229 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1230 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1231 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1235 window_box_edges (w
, area
, top_left_x
, top_left_y
,
1236 bottom_right_x
, bottom_right_y
)
1239 int *top_left_x
, *top_left_y
, *bottom_right_x
, *bottom_right_y
;
1241 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1243 *bottom_right_x
+= *top_left_x
;
1244 *bottom_right_y
+= *top_left_y
;
1249 /***********************************************************************
1251 ***********************************************************************/
1253 /* Return the bottom y-position of the line the iterator IT is in.
1254 This can modify IT's settings. */
1260 int line_height
= it
->max_ascent
+ it
->max_descent
;
1261 int line_top_y
= it
->current_y
;
1263 if (line_height
== 0)
1266 line_height
= last_height
;
1267 else if (IT_CHARPOS (*it
) < ZV
)
1269 move_it_by_lines (it
, 1, 1);
1270 line_height
= (it
->max_ascent
|| it
->max_descent
1271 ? it
->max_ascent
+ it
->max_descent
1276 struct glyph_row
*row
= it
->glyph_row
;
1278 /* Use the default character height. */
1279 it
->glyph_row
= NULL
;
1280 it
->what
= IT_CHARACTER
;
1283 PRODUCE_GLYPHS (it
);
1284 line_height
= it
->ascent
+ it
->descent
;
1285 it
->glyph_row
= row
;
1289 return line_top_y
+ line_height
;
1293 /* Return 1 if position CHARPOS is visible in window W.
1294 CHARPOS < 0 means return info about WINDOW_END position.
1295 If visible, set *X and *Y to pixel coordinates of top left corner.
1296 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1297 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1300 pos_visible_p (w
, charpos
, x
, y
, rtop
, rbot
, rowh
, vpos
)
1302 int charpos
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
;
1305 struct text_pos top
;
1307 struct buffer
*old_buffer
= NULL
;
1309 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1312 if (XBUFFER (w
->buffer
) != current_buffer
)
1314 old_buffer
= current_buffer
;
1315 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1318 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1320 /* Compute exact mode line heights. */
1321 if (WINDOW_WANTS_MODELINE_P (w
))
1322 current_mode_line_height
1323 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1324 current_buffer
->mode_line_format
);
1326 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1327 current_header_line_height
1328 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1329 current_buffer
->header_line_format
);
1331 start_display (&it
, w
, top
);
1332 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1333 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1335 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1337 /* We have reached CHARPOS, or passed it. How the call to
1338 move_it_to can overshoot: (i) If CHARPOS is on invisible
1339 text, move_it_to stops at the end of the invisible text,
1340 after CHARPOS. (ii) If CHARPOS is in a display vector,
1341 move_it_to stops on its last glyph. */
1342 int top_x
= it
.current_x
;
1343 int top_y
= it
.current_y
;
1344 enum it_method it_method
= it
.method
;
1345 /* Calling line_bottom_y may change it.method, it.position, etc. */
1346 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1347 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1349 if (top_y
< window_top_y
)
1350 visible_p
= bottom_y
> window_top_y
;
1351 else if (top_y
< it
.last_visible_y
)
1355 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1357 /* We stopped on the last glyph of a display vector.
1358 Try and recompute. Hack alert! */
1359 if (charpos
< 2 || top
.charpos
>= charpos
)
1360 top_x
= it
.glyph_row
->x
;
1364 start_display (&it2
, w
, top
);
1365 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1366 get_next_display_element (&it2
);
1367 PRODUCE_GLYPHS (&it2
);
1368 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1369 || it2
.current_x
> it2
.last_visible_x
)
1370 top_x
= it
.glyph_row
->x
;
1373 top_x
= it2
.current_x
;
1374 top_y
= it2
.current_y
;
1380 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1381 *rtop
= max (0, window_top_y
- top_y
);
1382 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1383 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1384 - max (top_y
, window_top_y
)));
1393 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1394 move_it_by_lines (&it
, 1, 0);
1395 if (charpos
< IT_CHARPOS (it
)
1396 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1399 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1401 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1402 *rtop
= max (0, -it2
.current_y
);
1403 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1404 - it
.last_visible_y
));
1405 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1407 - max (it2
.current_y
,
1408 WINDOW_HEADER_LINE_HEIGHT (w
))));
1414 set_buffer_internal_1 (old_buffer
);
1416 current_header_line_height
= current_mode_line_height
= -1;
1418 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1419 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1422 /* Debugging code. */
1424 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1425 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1427 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1434 /* Return the next character from STR which is MAXLEN bytes long.
1435 Return in *LEN the length of the character. This is like
1436 STRING_CHAR_AND_LENGTH but never returns an invalid character. If
1437 we find one, we return a `?', but with the length of the invalid
1441 string_char_and_length (str
, len
)
1442 const unsigned char *str
;
1447 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1448 if (!CHAR_VALID_P (c
, 1))
1449 /* We may not change the length here because other places in Emacs
1450 don't use this function, i.e. they silently accept invalid
1459 /* Given a position POS containing a valid character and byte position
1460 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1462 static struct text_pos
1463 string_pos_nchars_ahead (pos
, string
, nchars
)
1464 struct text_pos pos
;
1468 xassert (STRINGP (string
) && nchars
>= 0);
1470 if (STRING_MULTIBYTE (string
))
1472 int rest
= SBYTES (string
) - BYTEPOS (pos
);
1473 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1478 string_char_and_length (p
, &len
);
1479 p
+= len
, rest
-= len
;
1480 xassert (rest
>= 0);
1482 BYTEPOS (pos
) += len
;
1486 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1492 /* Value is the text position, i.e. character and byte position,
1493 for character position CHARPOS in STRING. */
1495 static INLINE
struct text_pos
1496 string_pos (charpos
, string
)
1500 struct text_pos pos
;
1501 xassert (STRINGP (string
));
1502 xassert (charpos
>= 0);
1503 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1508 /* Value is a text position, i.e. character and byte position, for
1509 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1510 means recognize multibyte characters. */
1512 static struct text_pos
1513 c_string_pos (charpos
, s
, multibyte_p
)
1518 struct text_pos pos
;
1520 xassert (s
!= NULL
);
1521 xassert (charpos
>= 0);
1525 int rest
= strlen (s
), len
;
1527 SET_TEXT_POS (pos
, 0, 0);
1530 string_char_and_length (s
, &len
);
1531 s
+= len
, rest
-= len
;
1532 xassert (rest
>= 0);
1534 BYTEPOS (pos
) += len
;
1538 SET_TEXT_POS (pos
, charpos
, charpos
);
1544 /* Value is the number of characters in C string S. MULTIBYTE_P
1545 non-zero means recognize multibyte characters. */
1548 number_of_chars (s
, multibyte_p
)
1556 int rest
= strlen (s
), len
;
1557 unsigned char *p
= (unsigned char *) s
;
1559 for (nchars
= 0; rest
> 0; ++nchars
)
1561 string_char_and_length (p
, &len
);
1562 rest
-= len
, p
+= len
;
1566 nchars
= strlen (s
);
1572 /* Compute byte position NEWPOS->bytepos corresponding to
1573 NEWPOS->charpos. POS is a known position in string STRING.
1574 NEWPOS->charpos must be >= POS.charpos. */
1577 compute_string_pos (newpos
, pos
, string
)
1578 struct text_pos
*newpos
, pos
;
1581 xassert (STRINGP (string
));
1582 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1584 if (STRING_MULTIBYTE (string
))
1585 *newpos
= string_pos_nchars_ahead (pos
, string
,
1586 CHARPOS (*newpos
) - CHARPOS (pos
));
1588 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1592 Return an estimation of the pixel height of mode or header lines on
1593 frame F. FACE_ID specifies what line's height to estimate. */
1596 estimate_mode_line_height (f
, face_id
)
1598 enum face_id face_id
;
1600 #ifdef HAVE_WINDOW_SYSTEM
1601 if (FRAME_WINDOW_P (f
))
1603 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1605 /* This function is called so early when Emacs starts that the face
1606 cache and mode line face are not yet initialized. */
1607 if (FRAME_FACE_CACHE (f
))
1609 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1613 height
= FONT_HEIGHT (face
->font
);
1614 if (face
->box_line_width
> 0)
1615 height
+= 2 * face
->box_line_width
;
1626 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1627 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1628 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1629 not force the value into range. */
1632 pixel_to_glyph_coords (f
, pix_x
, pix_y
, x
, y
, bounds
, noclip
)
1634 register int pix_x
, pix_y
;
1636 NativeRectangle
*bounds
;
1640 #ifdef HAVE_WINDOW_SYSTEM
1641 if (FRAME_WINDOW_P (f
))
1643 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1644 even for negative values. */
1646 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1648 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1650 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1651 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1654 STORE_NATIVE_RECT (*bounds
,
1655 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1656 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1657 FRAME_COLUMN_WIDTH (f
) - 1,
1658 FRAME_LINE_HEIGHT (f
) - 1);
1664 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1665 pix_x
= FRAME_TOTAL_COLS (f
);
1669 else if (pix_y
> FRAME_LINES (f
))
1670 pix_y
= FRAME_LINES (f
);
1680 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1681 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1682 can't tell the positions because W's display is not up to date,
1686 glyph_to_pixel_coords (w
, hpos
, vpos
, frame_x
, frame_y
)
1689 int *frame_x
, *frame_y
;
1691 #ifdef HAVE_WINDOW_SYSTEM
1692 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1696 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1697 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1699 if (display_completed
)
1701 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1702 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1703 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1709 hpos
+= glyph
->pixel_width
;
1713 /* If first glyph is partially visible, its first visible position is still 0. */
1725 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1726 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1737 #ifdef HAVE_WINDOW_SYSTEM
1739 /* Find the glyph under window-relative coordinates X/Y in window W.
1740 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1741 strings. Return in *HPOS and *VPOS the row and column number of
1742 the glyph found. Return in *AREA the glyph area containing X.
1743 Value is a pointer to the glyph found or null if X/Y is not on
1744 text, or we can't tell because W's current matrix is not up to
1749 x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, dx
, dy
, area
)
1752 int *hpos
, *vpos
, *dx
, *dy
, *area
;
1754 struct glyph
*glyph
, *end
;
1755 struct glyph_row
*row
= NULL
;
1758 /* Find row containing Y. Give up if some row is not enabled. */
1759 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1761 row
= MATRIX_ROW (w
->current_matrix
, i
);
1762 if (!row
->enabled_p
)
1764 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1771 /* Give up if Y is not in the window. */
1772 if (i
== w
->current_matrix
->nrows
)
1775 /* Get the glyph area containing X. */
1776 if (w
->pseudo_window_p
)
1783 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1785 *area
= LEFT_MARGIN_AREA
;
1786 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1788 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1791 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1795 *area
= RIGHT_MARGIN_AREA
;
1796 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1800 /* Find glyph containing X. */
1801 glyph
= row
->glyphs
[*area
];
1802 end
= glyph
+ row
->used
[*area
];
1804 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1806 x
-= glyph
->pixel_width
;
1816 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1819 *hpos
= glyph
- row
->glyphs
[*area
];
1825 Convert frame-relative x/y to coordinates relative to window W.
1826 Takes pseudo-windows into account. */
1829 frame_to_window_pixel_xy (w
, x
, y
)
1833 if (w
->pseudo_window_p
)
1835 /* A pseudo-window is always full-width, and starts at the
1836 left edge of the frame, plus a frame border. */
1837 struct frame
*f
= XFRAME (w
->frame
);
1838 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1839 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1843 *x
-= WINDOW_LEFT_EDGE_X (w
);
1844 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1849 Return in RECTS[] at most N clipping rectangles for glyph string S.
1850 Return the number of stored rectangles. */
1853 get_glyph_string_clip_rects (s
, rects
, n
)
1854 struct glyph_string
*s
;
1855 NativeRectangle
*rects
;
1863 if (s
->row
->full_width_p
)
1865 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1866 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1867 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1869 /* Unless displaying a mode or menu bar line, which are always
1870 fully visible, clip to the visible part of the row. */
1871 if (s
->w
->pseudo_window_p
)
1872 r
.height
= s
->row
->visible_height
;
1874 r
.height
= s
->height
;
1878 /* This is a text line that may be partially visible. */
1879 r
.x
= window_box_left (s
->w
, s
->area
);
1880 r
.width
= window_box_width (s
->w
, s
->area
);
1881 r
.height
= s
->row
->visible_height
;
1885 if (r
.x
< s
->clip_head
->x
)
1887 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1888 r
.width
-= s
->clip_head
->x
- r
.x
;
1891 r
.x
= s
->clip_head
->x
;
1894 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1896 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1897 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1902 /* If S draws overlapping rows, it's sufficient to use the top and
1903 bottom of the window for clipping because this glyph string
1904 intentionally draws over other lines. */
1905 if (s
->for_overlaps
)
1907 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1908 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1910 /* Alas, the above simple strategy does not work for the
1911 environments with anti-aliased text: if the same text is
1912 drawn onto the same place multiple times, it gets thicker.
1913 If the overlap we are processing is for the erased cursor, we
1914 take the intersection with the rectagle of the cursor. */
1915 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1917 XRectangle rc
, r_save
= r
;
1919 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1920 rc
.y
= s
->w
->phys_cursor
.y
;
1921 rc
.width
= s
->w
->phys_cursor_width
;
1922 rc
.height
= s
->w
->phys_cursor_height
;
1924 x_intersect_rectangles (&r_save
, &rc
, &r
);
1929 /* Don't use S->y for clipping because it doesn't take partially
1930 visible lines into account. For example, it can be negative for
1931 partially visible lines at the top of a window. */
1932 if (!s
->row
->full_width_p
1933 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1934 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1936 r
.y
= max (0, s
->row
->y
);
1939 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1941 /* If drawing the cursor, don't let glyph draw outside its
1942 advertised boundaries. Cleartype does this under some circumstances. */
1943 if (s
->hl
== DRAW_CURSOR
)
1945 struct glyph
*glyph
= s
->first_glyph
;
1950 r
.width
-= s
->x
- r
.x
;
1953 r
.width
= min (r
.width
, glyph
->pixel_width
);
1955 /* If r.y is below window bottom, ensure that we still see a cursor. */
1956 height
= min (glyph
->ascent
+ glyph
->descent
,
1957 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1958 max_y
= window_text_bottom_y (s
->w
) - height
;
1959 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1960 if (s
->ybase
- glyph
->ascent
> max_y
)
1967 /* Don't draw cursor glyph taller than our actual glyph. */
1968 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1969 if (height
< r
.height
)
1971 max_y
= r
.y
+ r
.height
;
1972 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1973 r
.height
= min (max_y
- r
.y
, height
);
1980 XRectangle r_save
= r
;
1982 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1986 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1987 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1989 #ifdef CONVERT_FROM_XRECT
1990 CONVERT_FROM_XRECT (r
, *rects
);
1998 /* If we are processing overlapping and allowed to return
1999 multiple clipping rectangles, we exclude the row of the glyph
2000 string from the clipping rectangle. This is to avoid drawing
2001 the same text on the environment with anti-aliasing. */
2002 #ifdef CONVERT_FROM_XRECT
2005 XRectangle
*rs
= rects
;
2007 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2009 if (s
->for_overlaps
& OVERLAPS_PRED
)
2012 if (r
.y
+ r
.height
> row_y
)
2015 rs
[i
].height
= row_y
- r
.y
;
2021 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2024 if (r
.y
< row_y
+ s
->row
->visible_height
)
2026 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2028 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2029 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2038 #ifdef CONVERT_FROM_XRECT
2039 for (i
= 0; i
< n
; i
++)
2040 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2047 Return in *NR the clipping rectangle for glyph string S. */
2050 get_glyph_string_clip_rect (s
, nr
)
2051 struct glyph_string
*s
;
2052 NativeRectangle
*nr
;
2054 get_glyph_string_clip_rects (s
, nr
, 1);
2059 Return the position and height of the phys cursor in window W.
2060 Set w->phys_cursor_width to width of phys cursor.
2064 get_phys_cursor_geometry (w
, row
, glyph
, xp
, yp
, heightp
)
2066 struct glyph_row
*row
;
2067 struct glyph
*glyph
;
2068 int *xp
, *yp
, *heightp
;
2070 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2071 int x
, y
, wd
, h
, h0
, y0
;
2073 /* Compute the width of the rectangle to draw. If on a stretch
2074 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2075 rectangle as wide as the glyph, but use a canonical character
2077 wd
= glyph
->pixel_width
- 1;
2078 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
2082 x
= w
->phys_cursor
.x
;
2089 if (glyph
->type
== STRETCH_GLYPH
2090 && !x_stretch_cursor_p
)
2091 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2092 w
->phys_cursor_width
= wd
;
2094 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2096 /* If y is below window bottom, ensure that we still see a cursor. */
2097 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2099 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2100 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2102 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2105 h
= max (h
- (y0
- y
) + 1, h0
);
2110 y0
= window_text_bottom_y (w
) - h0
;
2118 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2119 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2124 * Remember which glyph the mouse is over.
2128 remember_mouse_glyph (f
, gx
, gy
, rect
)
2131 NativeRectangle
*rect
;
2135 struct glyph_row
*r
, *gr
, *end_row
;
2136 enum window_part part
;
2137 enum glyph_row_area area
;
2138 int x
, y
, width
, height
;
2140 /* Try to determine frame pixel position and size of the glyph under
2141 frame pixel coordinates X/Y on frame F. */
2143 if (!f
->glyphs_initialized_p
2144 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, &x
, &y
, 0),
2147 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2148 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2152 w
= XWINDOW (window
);
2153 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2154 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2156 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2157 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2159 if (w
->pseudo_window_p
)
2162 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2168 case ON_LEFT_MARGIN
:
2169 area
= LEFT_MARGIN_AREA
;
2172 case ON_RIGHT_MARGIN
:
2173 area
= RIGHT_MARGIN_AREA
;
2176 case ON_HEADER_LINE
:
2178 gr
= (part
== ON_HEADER_LINE
2179 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2180 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2183 goto text_glyph_row_found
;
2190 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2191 if (r
->y
+ r
->height
> y
)
2197 text_glyph_row_found
:
2200 struct glyph
*g
= gr
->glyphs
[area
];
2201 struct glyph
*end
= g
+ gr
->used
[area
];
2203 height
= gr
->height
;
2204 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2205 if (gx
+ g
->pixel_width
> x
)
2210 if (g
->type
== IMAGE_GLYPH
)
2212 /* Don't remember when mouse is over image, as
2213 image may have hot-spots. */
2214 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2217 width
= g
->pixel_width
;
2221 /* Use nominal char spacing at end of line. */
2223 gx
+= (x
/ width
) * width
;
2226 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2227 gx
+= window_box_left_offset (w
, area
);
2231 /* Use nominal line height at end of window. */
2232 gx
= (x
/ width
) * width
;
2234 gy
+= (y
/ height
) * height
;
2238 case ON_LEFT_FRINGE
:
2239 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2240 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2241 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2242 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2245 case ON_RIGHT_FRINGE
:
2246 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2247 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2248 : window_box_right_offset (w
, TEXT_AREA
));
2249 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2253 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2255 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2256 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2257 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2259 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2263 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2264 if (r
->y
+ r
->height
> y
)
2271 height
= gr
->height
;
2274 /* Use nominal line height at end of window. */
2276 gy
+= (y
/ height
) * height
;
2283 /* If there is no glyph under the mouse, then we divide the screen
2284 into a grid of the smallest glyph in the frame, and use that
2287 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2288 round down even for negative values. */
2294 gx
= (gx
/ width
) * width
;
2295 gy
= (gy
/ height
) * height
;
2300 gx
+= WINDOW_LEFT_EDGE_X (w
);
2301 gy
+= WINDOW_TOP_EDGE_Y (w
);
2304 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2306 /* Visible feedback for debugging. */
2309 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2310 f
->output_data
.x
->normal_gc
,
2311 gx
, gy
, width
, height
);
2317 #endif /* HAVE_WINDOW_SYSTEM */
2320 /***********************************************************************
2321 Lisp form evaluation
2322 ***********************************************************************/
2324 /* Error handler for safe_eval and safe_call. */
2327 safe_eval_handler (arg
)
2330 add_to_log ("Error during redisplay: %s", arg
, Qnil
);
2335 /* Evaluate SEXPR and return the result, or nil if something went
2336 wrong. Prevent redisplay during the evaluation. */
2338 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2339 Return the result, or nil if something went wrong. Prevent
2340 redisplay during the evaluation. */
2343 safe_call (nargs
, args
)
2349 if (inhibit_eval_during_redisplay
)
2353 int count
= SPECPDL_INDEX ();
2354 struct gcpro gcpro1
;
2357 gcpro1
.nvars
= nargs
;
2358 specbind (Qinhibit_redisplay
, Qt
);
2359 /* Use Qt to ensure debugger does not run,
2360 so there is no possibility of wanting to redisplay. */
2361 val
= internal_condition_case_2 (Ffuncall
, nargs
, args
, Qt
,
2364 val
= unbind_to (count
, val
);
2371 /* Call function FN with one argument ARG.
2372 Return the result, or nil if something went wrong. */
2375 safe_call1 (fn
, arg
)
2376 Lisp_Object fn
, arg
;
2378 Lisp_Object args
[2];
2381 return safe_call (2, args
);
2384 static Lisp_Object Qeval
;
2387 safe_eval (Lisp_Object sexpr
)
2389 return safe_call1 (Qeval
, sexpr
);
2392 /* Call function FN with one argument ARG.
2393 Return the result, or nil if something went wrong. */
2396 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2398 Lisp_Object args
[3];
2402 return safe_call (3, args
);
2407 /***********************************************************************
2409 ***********************************************************************/
2413 /* Define CHECK_IT to perform sanity checks on iterators.
2414 This is for debugging. It is too slow to do unconditionally. */
2420 if (it
->method
== GET_FROM_STRING
)
2422 xassert (STRINGP (it
->string
));
2423 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2427 xassert (IT_STRING_CHARPOS (*it
) < 0);
2428 if (it
->method
== GET_FROM_BUFFER
)
2430 /* Check that character and byte positions agree. */
2431 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2436 xassert (it
->current
.dpvec_index
>= 0);
2438 xassert (it
->current
.dpvec_index
< 0);
2441 #define CHECK_IT(IT) check_it ((IT))
2445 #define CHECK_IT(IT) (void) 0
2452 /* Check that the window end of window W is what we expect it
2453 to be---the last row in the current matrix displaying text. */
2456 check_window_end (w
)
2459 if (!MINI_WINDOW_P (w
)
2460 && !NILP (w
->window_end_valid
))
2462 struct glyph_row
*row
;
2463 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2464 XFASTINT (w
->window_end_vpos
)),
2466 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2467 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2471 #define CHECK_WINDOW_END(W) check_window_end ((W))
2473 #else /* not GLYPH_DEBUG */
2475 #define CHECK_WINDOW_END(W) (void) 0
2477 #endif /* not GLYPH_DEBUG */
2481 /***********************************************************************
2482 Iterator initialization
2483 ***********************************************************************/
2485 /* Initialize IT for displaying current_buffer in window W, starting
2486 at character position CHARPOS. CHARPOS < 0 means that no buffer
2487 position is specified which is useful when the iterator is assigned
2488 a position later. BYTEPOS is the byte position corresponding to
2489 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2491 If ROW is not null, calls to produce_glyphs with IT as parameter
2492 will produce glyphs in that row.
2494 BASE_FACE_ID is the id of a base face to use. It must be one of
2495 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2496 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2497 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2499 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2500 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2501 will be initialized to use the corresponding mode line glyph row of
2502 the desired matrix of W. */
2505 init_iterator (it
, w
, charpos
, bytepos
, row
, base_face_id
)
2508 int charpos
, bytepos
;
2509 struct glyph_row
*row
;
2510 enum face_id base_face_id
;
2512 int highlight_region_p
;
2513 enum face_id remapped_base_face_id
= base_face_id
;
2515 /* Some precondition checks. */
2516 xassert (w
!= NULL
&& it
!= NULL
);
2517 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2520 /* If face attributes have been changed since the last redisplay,
2521 free realized faces now because they depend on face definitions
2522 that might have changed. Don't free faces while there might be
2523 desired matrices pending which reference these faces. */
2524 if (face_change_count
&& !inhibit_free_realized_faces
)
2526 face_change_count
= 0;
2527 free_all_realized_faces (Qnil
);
2530 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2531 if (! NILP (Vface_remapping_alist
))
2532 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2534 /* Use one of the mode line rows of W's desired matrix if
2538 if (base_face_id
== MODE_LINE_FACE_ID
2539 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2540 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2541 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2542 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2546 bzero (it
, sizeof *it
);
2547 it
->current
.overlay_string_index
= -1;
2548 it
->current
.dpvec_index
= -1;
2549 it
->base_face_id
= remapped_base_face_id
;
2551 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2553 /* The window in which we iterate over current_buffer: */
2554 XSETWINDOW (it
->window
, w
);
2556 it
->f
= XFRAME (w
->frame
);
2560 /* Extra space between lines (on window systems only). */
2561 if (base_face_id
== DEFAULT_FACE_ID
2562 && FRAME_WINDOW_P (it
->f
))
2564 if (NATNUMP (current_buffer
->extra_line_spacing
))
2565 it
->extra_line_spacing
= XFASTINT (current_buffer
->extra_line_spacing
);
2566 else if (FLOATP (current_buffer
->extra_line_spacing
))
2567 it
->extra_line_spacing
= (XFLOAT_DATA (current_buffer
->extra_line_spacing
)
2568 * FRAME_LINE_HEIGHT (it
->f
));
2569 else if (it
->f
->extra_line_spacing
> 0)
2570 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2571 it
->max_extra_line_spacing
= 0;
2574 /* If realized faces have been removed, e.g. because of face
2575 attribute changes of named faces, recompute them. When running
2576 in batch mode, the face cache of the initial frame is null. If
2577 we happen to get called, make a dummy face cache. */
2578 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2579 init_frame_faces (it
->f
);
2580 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2581 recompute_basic_faces (it
->f
);
2583 /* Current value of the `slice', `space-width', and 'height' properties. */
2584 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2585 it
->space_width
= Qnil
;
2586 it
->font_height
= Qnil
;
2587 it
->override_ascent
= -1;
2589 /* Are control characters displayed as `^C'? */
2590 it
->ctl_arrow_p
= !NILP (current_buffer
->ctl_arrow
);
2592 /* -1 means everything between a CR and the following line end
2593 is invisible. >0 means lines indented more than this value are
2595 it
->selective
= (INTEGERP (current_buffer
->selective_display
)
2596 ? XFASTINT (current_buffer
->selective_display
)
2597 : (!NILP (current_buffer
->selective_display
)
2599 it
->selective_display_ellipsis_p
2600 = !NILP (current_buffer
->selective_display_ellipses
);
2602 /* Display table to use. */
2603 it
->dp
= window_display_table (w
);
2605 /* Are multibyte characters enabled in current_buffer? */
2606 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
2608 /* Do we need to reorder bidirectional text? */
2609 it
->bidi_p
= !NILP (current_buffer
->bidi_display_reordering
);
2611 /* Non-zero if we should highlight the region. */
2613 = (!NILP (Vtransient_mark_mode
)
2614 && !NILP (current_buffer
->mark_active
)
2615 && XMARKER (current_buffer
->mark
)->buffer
!= 0);
2617 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2618 start and end of a visible region in window IT->w. Set both to
2619 -1 to indicate no region. */
2620 if (highlight_region_p
2621 /* Maybe highlight only in selected window. */
2622 && (/* Either show region everywhere. */
2623 highlight_nonselected_windows
2624 /* Or show region in the selected window. */
2625 || w
== XWINDOW (selected_window
)
2626 /* Or show the region if we are in the mini-buffer and W is
2627 the window the mini-buffer refers to. */
2628 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2629 && WINDOWP (minibuf_selected_window
)
2630 && w
== XWINDOW (minibuf_selected_window
))))
2632 int charpos
= marker_position (current_buffer
->mark
);
2633 it
->region_beg_charpos
= min (PT
, charpos
);
2634 it
->region_end_charpos
= max (PT
, charpos
);
2637 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2639 /* Get the position at which the redisplay_end_trigger hook should
2640 be run, if it is to be run at all. */
2641 if (MARKERP (w
->redisplay_end_trigger
)
2642 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2643 it
->redisplay_end_trigger_charpos
2644 = marker_position (w
->redisplay_end_trigger
);
2645 else if (INTEGERP (w
->redisplay_end_trigger
))
2646 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2648 /* Correct bogus values of tab_width. */
2649 it
->tab_width
= XINT (current_buffer
->tab_width
);
2650 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2653 /* Are lines in the display truncated? */
2654 if (base_face_id
!= DEFAULT_FACE_ID
2655 || XINT (it
->w
->hscroll
)
2656 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2657 && ((!NILP (Vtruncate_partial_width_windows
)
2658 && !INTEGERP (Vtruncate_partial_width_windows
))
2659 || (INTEGERP (Vtruncate_partial_width_windows
)
2660 && (WINDOW_TOTAL_COLS (it
->w
)
2661 < XINT (Vtruncate_partial_width_windows
))))))
2662 it
->line_wrap
= TRUNCATE
;
2663 else if (NILP (current_buffer
->truncate_lines
))
2664 it
->line_wrap
= NILP (current_buffer
->word_wrap
)
2665 ? WINDOW_WRAP
: WORD_WRAP
;
2667 it
->line_wrap
= TRUNCATE
;
2669 /* Get dimensions of truncation and continuation glyphs. These are
2670 displayed as fringe bitmaps under X, so we don't need them for such
2672 if (!FRAME_WINDOW_P (it
->f
))
2674 if (it
->line_wrap
== TRUNCATE
)
2676 /* We will need the truncation glyph. */
2677 xassert (it
->glyph_row
== NULL
);
2678 produce_special_glyphs (it
, IT_TRUNCATION
);
2679 it
->truncation_pixel_width
= it
->pixel_width
;
2683 /* We will need the continuation glyph. */
2684 xassert (it
->glyph_row
== NULL
);
2685 produce_special_glyphs (it
, IT_CONTINUATION
);
2686 it
->continuation_pixel_width
= it
->pixel_width
;
2689 /* Reset these values to zero because the produce_special_glyphs
2690 above has changed them. */
2691 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2692 it
->phys_ascent
= it
->phys_descent
= 0;
2695 /* Set this after getting the dimensions of truncation and
2696 continuation glyphs, so that we don't produce glyphs when calling
2697 produce_special_glyphs, above. */
2698 it
->glyph_row
= row
;
2699 it
->area
= TEXT_AREA
;
2701 /* Forget any previous info about this row being reversed. */
2703 it
->glyph_row
->reversed_p
= 0;
2705 /* Get the dimensions of the display area. The display area
2706 consists of the visible window area plus a horizontally scrolled
2707 part to the left of the window. All x-values are relative to the
2708 start of this total display area. */
2709 if (base_face_id
!= DEFAULT_FACE_ID
)
2711 /* Mode lines, menu bar in terminal frames. */
2712 it
->first_visible_x
= 0;
2713 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2718 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2719 it
->last_visible_x
= (it
->first_visible_x
2720 + window_box_width (w
, TEXT_AREA
));
2722 /* If we truncate lines, leave room for the truncator glyph(s) at
2723 the right margin. Otherwise, leave room for the continuation
2724 glyph(s). Truncation and continuation glyphs are not inserted
2725 for window-based redisplay. */
2726 if (!FRAME_WINDOW_P (it
->f
))
2728 if (it
->line_wrap
== TRUNCATE
)
2729 it
->last_visible_x
-= it
->truncation_pixel_width
;
2731 it
->last_visible_x
-= it
->continuation_pixel_width
;
2734 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2735 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2738 /* Leave room for a border glyph. */
2739 if (!FRAME_WINDOW_P (it
->f
)
2740 && !WINDOW_RIGHTMOST_P (it
->w
))
2741 it
->last_visible_x
-= 1;
2743 it
->last_visible_y
= window_text_bottom_y (w
);
2745 /* For mode lines and alike, arrange for the first glyph having a
2746 left box line if the face specifies a box. */
2747 if (base_face_id
!= DEFAULT_FACE_ID
)
2751 it
->face_id
= remapped_base_face_id
;
2753 /* If we have a boxed mode line, make the first character appear
2754 with a left box line. */
2755 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2756 if (face
->box
!= FACE_NO_BOX
)
2757 it
->start_of_box_run_p
= 1;
2760 /* If we are to reorder bidirectional text, init the bidi
2764 /* Note the paragraph direction that this buffer wants to
2766 if (EQ (current_buffer
->bidi_paragraph_direction
, Qleft_to_right
))
2767 it
->paragraph_embedding
= L2R
;
2768 else if (EQ (current_buffer
->bidi_paragraph_direction
, Qright_to_left
))
2769 it
->paragraph_embedding
= R2L
;
2771 it
->paragraph_embedding
= NEUTRAL_DIR
;
2772 bidi_init_it (charpos
, bytepos
, &it
->bidi_it
);
2775 /* If a buffer position was specified, set the iterator there,
2776 getting overlays and face properties from that position. */
2777 if (charpos
>= BUF_BEG (current_buffer
))
2779 it
->end_charpos
= ZV
;
2781 IT_CHARPOS (*it
) = charpos
;
2783 /* Compute byte position if not specified. */
2784 if (bytepos
< charpos
)
2785 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2787 IT_BYTEPOS (*it
) = bytepos
;
2789 it
->start
= it
->current
;
2791 /* Compute faces etc. */
2792 reseat (it
, it
->current
.pos
, 1);
2799 /* Initialize IT for the display of window W with window start POS. */
2802 start_display (it
, w
, pos
)
2805 struct text_pos pos
;
2807 struct glyph_row
*row
;
2808 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2810 row
= w
->desired_matrix
->rows
+ first_vpos
;
2811 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2812 it
->first_vpos
= first_vpos
;
2814 /* Don't reseat to previous visible line start if current start
2815 position is in a string or image. */
2816 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2818 int start_at_line_beg_p
;
2819 int first_y
= it
->current_y
;
2821 /* If window start is not at a line start, skip forward to POS to
2822 get the correct continuation lines width. */
2823 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2824 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2825 if (!start_at_line_beg_p
)
2829 reseat_at_previous_visible_line_start (it
);
2830 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2832 new_x
= it
->current_x
+ it
->pixel_width
;
2834 /* If lines are continued, this line may end in the middle
2835 of a multi-glyph character (e.g. a control character
2836 displayed as \003, or in the middle of an overlay
2837 string). In this case move_it_to above will not have
2838 taken us to the start of the continuation line but to the
2839 end of the continued line. */
2840 if (it
->current_x
> 0
2841 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2842 && (/* And glyph doesn't fit on the line. */
2843 new_x
> it
->last_visible_x
2844 /* Or it fits exactly and we're on a window
2846 || (new_x
== it
->last_visible_x
2847 && FRAME_WINDOW_P (it
->f
))))
2849 if (it
->current
.dpvec_index
>= 0
2850 || it
->current
.overlay_string_index
>= 0)
2852 set_iterator_to_next (it
, 1);
2853 move_it_in_display_line_to (it
, -1, -1, 0);
2856 it
->continuation_lines_width
+= it
->current_x
;
2859 /* We're starting a new display line, not affected by the
2860 height of the continued line, so clear the appropriate
2861 fields in the iterator structure. */
2862 it
->max_ascent
= it
->max_descent
= 0;
2863 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2865 it
->current_y
= first_y
;
2867 it
->current_x
= it
->hpos
= 0;
2873 /* Return 1 if POS is a position in ellipses displayed for invisible
2874 text. W is the window we display, for text property lookup. */
2877 in_ellipses_for_invisible_text_p (pos
, w
)
2878 struct display_pos
*pos
;
2881 Lisp_Object prop
, window
;
2883 int charpos
= CHARPOS (pos
->pos
);
2885 /* If POS specifies a position in a display vector, this might
2886 be for an ellipsis displayed for invisible text. We won't
2887 get the iterator set up for delivering that ellipsis unless
2888 we make sure that it gets aware of the invisible text. */
2889 if (pos
->dpvec_index
>= 0
2890 && pos
->overlay_string_index
< 0
2891 && CHARPOS (pos
->string_pos
) < 0
2893 && (XSETWINDOW (window
, w
),
2894 prop
= Fget_char_property (make_number (charpos
),
2895 Qinvisible
, window
),
2896 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2898 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2900 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2907 /* Initialize IT for stepping through current_buffer in window W,
2908 starting at position POS that includes overlay string and display
2909 vector/ control character translation position information. Value
2910 is zero if there are overlay strings with newlines at POS. */
2913 init_from_display_pos (it
, w
, pos
)
2916 struct display_pos
*pos
;
2918 int charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2919 int i
, overlay_strings_with_newlines
= 0;
2921 /* If POS specifies a position in a display vector, this might
2922 be for an ellipsis displayed for invisible text. We won't
2923 get the iterator set up for delivering that ellipsis unless
2924 we make sure that it gets aware of the invisible text. */
2925 if (in_ellipses_for_invisible_text_p (pos
, w
))
2931 /* Keep in mind: the call to reseat in init_iterator skips invisible
2932 text, so we might end up at a position different from POS. This
2933 is only a problem when POS is a row start after a newline and an
2934 overlay starts there with an after-string, and the overlay has an
2935 invisible property. Since we don't skip invisible text in
2936 display_line and elsewhere immediately after consuming the
2937 newline before the row start, such a POS will not be in a string,
2938 but the call to init_iterator below will move us to the
2940 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2942 /* This only scans the current chunk -- it should scan all chunks.
2943 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2944 to 16 in 22.1 to make this a lesser problem. */
2945 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2947 const char *s
= SDATA (it
->overlay_strings
[i
]);
2948 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2950 while (s
< e
&& *s
!= '\n')
2955 overlay_strings_with_newlines
= 1;
2960 /* If position is within an overlay string, set up IT to the right
2962 if (pos
->overlay_string_index
>= 0)
2966 /* If the first overlay string happens to have a `display'
2967 property for an image, the iterator will be set up for that
2968 image, and we have to undo that setup first before we can
2969 correct the overlay string index. */
2970 if (it
->method
== GET_FROM_IMAGE
)
2973 /* We already have the first chunk of overlay strings in
2974 IT->overlay_strings. Load more until the one for
2975 pos->overlay_string_index is in IT->overlay_strings. */
2976 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2978 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2979 it
->current
.overlay_string_index
= 0;
2982 load_overlay_strings (it
, 0);
2983 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2987 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2988 relative_index
= (it
->current
.overlay_string_index
2989 % OVERLAY_STRING_CHUNK_SIZE
);
2990 it
->string
= it
->overlay_strings
[relative_index
];
2991 xassert (STRINGP (it
->string
));
2992 it
->current
.string_pos
= pos
->string_pos
;
2993 it
->method
= GET_FROM_STRING
;
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;
3086 /* Use face of preceding text for ellipsis (if invisible) */
3087 if (it
->selective_display_ellipsis_p
)
3088 it
->saved_face_id
= it
->face_id
;
3092 handled
= HANDLED_NORMALLY
;
3094 /* Call text property handlers. */
3095 for (p
= it_props
; p
->handler
; ++p
)
3097 handled
= p
->handler (it
);
3099 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3101 else if (handled
== HANDLED_RETURN
)
3103 /* We still want to show before and after strings from
3104 overlays even if the actual buffer text is replaced. */
3105 if (!handle_overlay_change_p
3107 || !get_overlay_strings_1 (it
, 0, 0))
3110 setup_for_ellipsis (it
, 0);
3111 /* When handling a display spec, we might load an
3112 empty string. In that case, discard it here. We
3113 used to discard it in handle_single_display_spec,
3114 but that causes get_overlay_strings_1, above, to
3115 ignore overlay strings that we must check. */
3116 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3120 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3124 it
->ignore_overlay_strings_at_pos_p
= 1;
3125 it
->string_from_display_prop_p
= 0;
3126 handle_overlay_change_p
= 0;
3128 handled
= HANDLED_RECOMPUTE_PROPS
;
3131 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3132 handle_overlay_change_p
= 0;
3135 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3137 /* Don't check for overlay strings below when set to deliver
3138 characters from a display vector. */
3139 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3140 handle_overlay_change_p
= 0;
3142 /* Handle overlay changes.
3143 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3144 if it finds overlays. */
3145 if (handle_overlay_change_p
)
3146 handled
= handle_overlay_change (it
);
3151 setup_for_ellipsis (it
, 0);
3155 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3157 /* Determine where to stop next. */
3158 if (handled
== HANDLED_NORMALLY
)
3159 compute_stop_pos (it
);
3163 /* Compute IT->stop_charpos from text property and overlay change
3164 information for IT's current position. */
3167 compute_stop_pos (it
)
3170 register INTERVAL iv
, next_iv
;
3171 Lisp_Object object
, limit
, position
;
3172 EMACS_INT charpos
, bytepos
;
3174 /* If nowhere else, stop at the end. */
3175 it
->stop_charpos
= it
->end_charpos
;
3177 if (STRINGP (it
->string
))
3179 /* Strings are usually short, so don't limit the search for
3181 object
= it
->string
;
3183 charpos
= IT_STRING_CHARPOS (*it
);
3184 bytepos
= IT_STRING_BYTEPOS (*it
);
3190 /* If next overlay change is in front of the current stop pos
3191 (which is IT->end_charpos), stop there. Note: value of
3192 next_overlay_change is point-max if no overlay change
3194 charpos
= IT_CHARPOS (*it
);
3195 bytepos
= IT_BYTEPOS (*it
);
3196 pos
= next_overlay_change (charpos
);
3197 if (pos
< it
->stop_charpos
)
3198 it
->stop_charpos
= pos
;
3200 /* If showing the region, we have to stop at the region
3201 start or end because the face might change there. */
3202 if (it
->region_beg_charpos
> 0)
3204 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3205 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3206 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3207 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3210 /* Set up variables for computing the stop position from text
3211 property changes. */
3212 XSETBUFFER (object
, current_buffer
);
3213 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3216 /* Get the interval containing IT's position. Value is a null
3217 interval if there isn't such an interval. */
3218 position
= make_number (charpos
);
3219 iv
= validate_interval_range (object
, &position
, &position
, 0);
3220 if (!NULL_INTERVAL_P (iv
))
3222 Lisp_Object values_here
[LAST_PROP_IDX
];
3225 /* Get properties here. */
3226 for (p
= it_props
; p
->handler
; ++p
)
3227 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3229 /* Look for an interval following iv that has different
3231 for (next_iv
= next_interval (iv
);
3232 (!NULL_INTERVAL_P (next_iv
)
3234 || XFASTINT (limit
) > next_iv
->position
));
3235 next_iv
= next_interval (next_iv
))
3237 for (p
= it_props
; p
->handler
; ++p
)
3239 Lisp_Object new_value
;
3241 new_value
= textget (next_iv
->plist
, *p
->name
);
3242 if (!EQ (values_here
[p
->idx
], new_value
))
3250 if (!NULL_INTERVAL_P (next_iv
))
3252 if (INTEGERP (limit
)
3253 && next_iv
->position
>= XFASTINT (limit
))
3254 /* No text property change up to limit. */
3255 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3257 /* Text properties change in next_iv. */
3258 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3262 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3263 it
->stop_charpos
, it
->string
);
3265 xassert (STRINGP (it
->string
)
3266 || (it
->stop_charpos
>= BEGV
3267 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3271 /* Return the position of the next overlay change after POS in
3272 current_buffer. Value is point-max if no overlay change
3273 follows. This is like `next-overlay-change' but doesn't use
3277 next_overlay_change (pos
)
3282 Lisp_Object
*overlays
;
3285 /* Get all overlays at the given position. */
3286 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3288 /* If any of these overlays ends before endpos,
3289 use its ending point instead. */
3290 for (i
= 0; i
< noverlays
; ++i
)
3295 oend
= OVERLAY_END (overlays
[i
]);
3296 oendpos
= OVERLAY_POSITION (oend
);
3297 endpos
= min (endpos
, oendpos
);
3305 /***********************************************************************
3307 ***********************************************************************/
3309 /* Handle changes in the `fontified' property of the current buffer by
3310 calling hook functions from Qfontification_functions to fontify
3313 static enum prop_handled
3314 handle_fontified_prop (it
)
3317 Lisp_Object prop
, pos
;
3318 enum prop_handled handled
= HANDLED_NORMALLY
;
3320 if (!NILP (Vmemory_full
))
3323 /* Get the value of the `fontified' property at IT's current buffer
3324 position. (The `fontified' property doesn't have a special
3325 meaning in strings.) If the value is nil, call functions from
3326 Qfontification_functions. */
3327 if (!STRINGP (it
->string
)
3329 && !NILP (Vfontification_functions
)
3330 && !NILP (Vrun_hooks
)
3331 && (pos
= make_number (IT_CHARPOS (*it
)),
3332 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3333 /* Ignore the special cased nil value always present at EOB since
3334 no amount of fontifying will be able to change it. */
3335 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3337 int count
= SPECPDL_INDEX ();
3340 val
= Vfontification_functions
;
3341 specbind (Qfontification_functions
, Qnil
);
3343 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3344 safe_call1 (val
, pos
);
3347 Lisp_Object globals
, fn
;
3348 struct gcpro gcpro1
, gcpro2
;
3351 GCPRO2 (val
, globals
);
3353 for (; CONSP (val
); val
= XCDR (val
))
3359 /* A value of t indicates this hook has a local
3360 binding; it means to run the global binding too.
3361 In a global value, t should not occur. If it
3362 does, we must ignore it to avoid an endless
3364 for (globals
= Fdefault_value (Qfontification_functions
);
3366 globals
= XCDR (globals
))
3368 fn
= XCAR (globals
);
3370 safe_call1 (fn
, pos
);
3374 safe_call1 (fn
, pos
);
3380 unbind_to (count
, Qnil
);
3382 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3383 something. This avoids an endless loop if they failed to
3384 fontify the text for which reason ever. */
3385 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3386 handled
= HANDLED_RECOMPUTE_PROPS
;
3394 /***********************************************************************
3396 ***********************************************************************/
3398 /* Set up iterator IT from face properties at its current position.
3399 Called from handle_stop. */
3401 static enum prop_handled
3402 handle_face_prop (it
)
3406 EMACS_INT next_stop
;
3408 if (!STRINGP (it
->string
))
3411 = face_at_buffer_position (it
->w
,
3413 it
->region_beg_charpos
,
3414 it
->region_end_charpos
,
3417 + TEXT_PROP_DISTANCE_LIMIT
),
3418 0, it
->base_face_id
);
3420 /* Is this a start of a run of characters with box face?
3421 Caveat: this can be called for a freshly initialized
3422 iterator; face_id is -1 in this case. We know that the new
3423 face will not change until limit, i.e. if the new face has a
3424 box, all characters up to limit will have one. But, as
3425 usual, we don't know whether limit is really the end. */
3426 if (new_face_id
!= it
->face_id
)
3428 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3430 /* If new face has a box but old face has not, this is
3431 the start of a run of characters with box, i.e. it has
3432 a shadow on the left side. The value of face_id of the
3433 iterator will be -1 if this is the initial call that gets
3434 the face. In this case, we have to look in front of IT's
3435 position and see whether there is a face != new_face_id. */
3436 it
->start_of_box_run_p
3437 = (new_face
->box
!= FACE_NO_BOX
3438 && (it
->face_id
>= 0
3439 || IT_CHARPOS (*it
) == BEG
3440 || new_face_id
!= face_before_it_pos (it
)));
3441 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3446 int base_face_id
, bufpos
;
3448 Lisp_Object from_overlay
3449 = (it
->current
.overlay_string_index
>= 0
3450 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3453 /* See if we got to this string directly or indirectly from
3454 an overlay property. That includes the before-string or
3455 after-string of an overlay, strings in display properties
3456 provided by an overlay, their text properties, etc.
3458 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3459 if (! NILP (from_overlay
))
3460 for (i
= it
->sp
- 1; i
>= 0; i
--)
3462 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3464 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3465 else if (! NILP (it
->stack
[i
].from_overlay
))
3466 from_overlay
= it
->stack
[i
].from_overlay
;
3468 if (!NILP (from_overlay
))
3472 if (! NILP (from_overlay
))
3474 bufpos
= IT_CHARPOS (*it
);
3475 /* For a string from an overlay, the base face depends
3476 only on text properties and ignores overlays. */
3478 = face_for_overlay_string (it
->w
,
3480 it
->region_beg_charpos
,
3481 it
->region_end_charpos
,
3484 + TEXT_PROP_DISTANCE_LIMIT
),
3492 /* For strings from a `display' property, use the face at
3493 IT's current buffer position as the base face to merge
3494 with, so that overlay strings appear in the same face as
3495 surrounding text, unless they specify their own
3497 base_face_id
= underlying_face_id (it
);
3500 new_face_id
= face_at_string_position (it
->w
,
3502 IT_STRING_CHARPOS (*it
),
3504 it
->region_beg_charpos
,
3505 it
->region_end_charpos
,
3509 /* Is this a start of a run of characters with box? Caveat:
3510 this can be called for a freshly allocated iterator; face_id
3511 is -1 is this case. We know that the new face will not
3512 change until the next check pos, i.e. if the new face has a
3513 box, all characters up to that position will have a
3514 box. But, as usual, we don't know whether that position
3515 is really the end. */
3516 if (new_face_id
!= it
->face_id
)
3518 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3519 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3521 /* If new face has a box but old face hasn't, this is the
3522 start of a run of characters with box, i.e. it has a
3523 shadow on the left side. */
3524 it
->start_of_box_run_p
3525 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3526 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3530 it
->face_id
= new_face_id
;
3531 return HANDLED_NORMALLY
;
3535 /* Return the ID of the face ``underlying'' IT's current position,
3536 which is in a string. If the iterator is associated with a
3537 buffer, return the face at IT's current buffer position.
3538 Otherwise, use the iterator's base_face_id. */
3541 underlying_face_id (it
)
3544 int face_id
= it
->base_face_id
, i
;
3546 xassert (STRINGP (it
->string
));
3548 for (i
= it
->sp
- 1; i
>= 0; --i
)
3549 if (NILP (it
->stack
[i
].string
))
3550 face_id
= it
->stack
[i
].face_id
;
3556 /* Compute the face one character before or after the current position
3557 of IT. BEFORE_P non-zero means get the face in front of IT's
3558 position. Value is the id of the face. */
3561 face_before_or_after_it_pos (it
, before_p
)
3566 EMACS_INT next_check_charpos
;
3567 struct text_pos pos
;
3569 xassert (it
->s
== NULL
);
3571 if (STRINGP (it
->string
))
3573 int bufpos
, base_face_id
;
3575 /* No face change past the end of the string (for the case
3576 we are padding with spaces). No face change before the
3578 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3579 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3582 /* Set pos to the position before or after IT's current position. */
3584 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3586 /* For composition, we must check the character after the
3588 pos
= (it
->what
== IT_COMPOSITION
3589 ? string_pos (IT_STRING_CHARPOS (*it
)
3590 + it
->cmp_it
.nchars
, it
->string
)
3591 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3593 if (it
->current
.overlay_string_index
>= 0)
3594 bufpos
= IT_CHARPOS (*it
);
3598 base_face_id
= underlying_face_id (it
);
3600 /* Get the face for ASCII, or unibyte. */
3601 face_id
= face_at_string_position (it
->w
,
3605 it
->region_beg_charpos
,
3606 it
->region_end_charpos
,
3607 &next_check_charpos
,
3610 /* Correct the face for charsets different from ASCII. Do it
3611 for the multibyte case only. The face returned above is
3612 suitable for unibyte text if IT->string is unibyte. */
3613 if (STRING_MULTIBYTE (it
->string
))
3615 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3616 int rest
= SBYTES (it
->string
) - BYTEPOS (pos
);
3618 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3620 c
= string_char_and_length (p
, &len
);
3621 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3626 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3627 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3630 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3631 pos
= it
->current
.pos
;
3634 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3637 if (it
->what
== IT_COMPOSITION
)
3638 /* For composition, we must check the position after the
3640 pos
.charpos
+= it
->cmp_it
.nchars
, pos
.bytepos
+= it
->len
;
3642 INC_TEXT_POS (pos
, it
->multibyte_p
);
3645 /* Determine face for CHARSET_ASCII, or unibyte. */
3646 face_id
= face_at_buffer_position (it
->w
,
3648 it
->region_beg_charpos
,
3649 it
->region_end_charpos
,
3650 &next_check_charpos
,
3653 /* Correct the face for charsets different from ASCII. Do it
3654 for the multibyte case only. The face returned above is
3655 suitable for unibyte text if current_buffer is unibyte. */
3656 if (it
->multibyte_p
)
3658 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3659 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3660 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3669 /***********************************************************************
3671 ***********************************************************************/
3673 /* Set up iterator IT from invisible properties at its current
3674 position. Called from handle_stop. */
3676 static enum prop_handled
3677 handle_invisible_prop (it
)
3680 enum prop_handled handled
= HANDLED_NORMALLY
;
3682 if (STRINGP (it
->string
))
3684 extern Lisp_Object Qinvisible
;
3685 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3687 /* Get the value of the invisible text property at the
3688 current position. Value will be nil if there is no such
3690 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3691 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3694 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3696 handled
= HANDLED_RECOMPUTE_PROPS
;
3698 /* Get the position at which the next change of the
3699 invisible text property can be found in IT->string.
3700 Value will be nil if the property value is the same for
3701 all the rest of IT->string. */
3702 XSETINT (limit
, SCHARS (it
->string
));
3703 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3706 /* Text at current position is invisible. The next
3707 change in the property is at position end_charpos.
3708 Move IT's current position to that position. */
3709 if (INTEGERP (end_charpos
)
3710 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3712 struct text_pos old
;
3713 old
= it
->current
.string_pos
;
3714 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3715 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3719 /* The rest of the string is invisible. If this is an
3720 overlay string, proceed with the next overlay string
3721 or whatever comes and return a character from there. */
3722 if (it
->current
.overlay_string_index
>= 0)
3724 next_overlay_string (it
);
3725 /* Don't check for overlay strings when we just
3726 finished processing them. */
3727 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3731 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3732 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3740 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3741 Lisp_Object pos
, prop
, overlay
;
3743 /* First of all, is there invisible text at this position? */
3744 tem
= start_charpos
= IT_CHARPOS (*it
);
3745 pos
= make_number (tem
);
3746 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3748 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3750 /* If we are on invisible text, skip over it. */
3751 if (invis_p
&& start_charpos
< it
->end_charpos
)
3753 /* Record whether we have to display an ellipsis for the
3755 int display_ellipsis_p
= invis_p
== 2;
3757 handled
= HANDLED_RECOMPUTE_PROPS
;
3759 /* Loop skipping over invisible text. The loop is left at
3760 ZV or with IT on the first char being visible again. */
3763 /* Try to skip some invisible text. Return value is the
3764 position reached which can be equal to where we start
3765 if there is nothing invisible there. This skips both
3766 over invisible text properties and overlays with
3767 invisible property. */
3768 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3770 /* If we skipped nothing at all we weren't at invisible
3771 text in the first place. If everything to the end of
3772 the buffer was skipped, end the loop. */
3773 if (newpos
== tem
|| newpos
>= ZV
)
3777 /* We skipped some characters but not necessarily
3778 all there are. Check if we ended up on visible
3779 text. Fget_char_property returns the property of
3780 the char before the given position, i.e. if we
3781 get invis_p = 0, this means that the char at
3782 newpos is visible. */
3783 pos
= make_number (newpos
);
3784 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3785 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3788 /* If we ended up on invisible text, proceed to
3789 skip starting with next_stop. */
3793 /* If there are adjacent invisible texts, don't lose the
3794 second one's ellipsis. */
3796 display_ellipsis_p
= 1;
3800 /* The position newpos is now either ZV or on visible text. */
3801 if (it
->bidi_p
&& newpos
< ZV
)
3803 /* With bidi iteration, the region of invisible text
3804 could start and/or end in the middle of a non-base
3805 embedding level. Therefore, we need to skip
3806 invisible text using the bidi iterator, starting at
3807 IT's current position, until we find ourselves
3808 outside the invisible text. Skipping invisible text
3809 _after_ bidi iteration avoids affecting the visual
3810 order of the displayed text when invisible properties
3811 are added or removed. */
3812 if (it
->bidi_it
.first_elt
)
3814 /* If we were `reseat'ed to a new paragraph,
3815 determine the paragraph base direction. We need
3816 to do it now because next_element_from_buffer may
3817 not have a chance to do it, if we are going to
3818 skip any text at the beginning, which resets the
3820 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
3824 bidi_get_next_char_visually (&it
->bidi_it
);
3826 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3827 && it
->bidi_it
.charpos
< newpos
);
3828 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3829 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3830 /* If we overstepped NEWPOS, record its position in the
3831 iterator, so that we skip invisible text if later the
3832 bidi iteration lands us in the invisible region
3834 if (IT_CHARPOS (*it
) >= newpos
)
3835 it
->prev_stop
= newpos
;
3839 IT_CHARPOS (*it
) = newpos
;
3840 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3843 /* If there are before-strings at the start of invisible
3844 text, and the text is invisible because of a text
3845 property, arrange to show before-strings because 20.x did
3846 it that way. (If the text is invisible because of an
3847 overlay property instead of a text property, this is
3848 already handled in the overlay code.) */
3850 && get_overlay_strings (it
, it
->stop_charpos
))
3852 handled
= HANDLED_RECOMPUTE_PROPS
;
3853 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3855 else if (display_ellipsis_p
)
3857 /* Make sure that the glyphs of the ellipsis will get
3858 correct `charpos' values. If we would not update
3859 it->position here, the glyphs would belong to the
3860 last visible character _before_ the invisible
3861 text, which confuses `set_cursor_from_row'.
3863 We use the last invisible position instead of the
3864 first because this way the cursor is always drawn on
3865 the first "." of the ellipsis, whenever PT is inside
3866 the invisible text. Otherwise the cursor would be
3867 placed _after_ the ellipsis when the point is after the
3868 first invisible character. */
3869 if (!STRINGP (it
->object
))
3871 it
->position
.charpos
= newpos
- 1;
3872 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3875 /* Let the ellipsis display before
3876 considering any properties of the following char.
3877 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3878 handled
= HANDLED_RETURN
;
3887 /* Make iterator IT return `...' next.
3888 Replaces LEN characters from buffer. */
3891 setup_for_ellipsis (it
, len
)
3895 /* Use the display table definition for `...'. Invalid glyphs
3896 will be handled by the method returning elements from dpvec. */
3897 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3899 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3900 it
->dpvec
= v
->contents
;
3901 it
->dpend
= v
->contents
+ v
->size
;
3905 /* Default `...'. */
3906 it
->dpvec
= default_invis_vector
;
3907 it
->dpend
= default_invis_vector
+ 3;
3910 it
->dpvec_char_len
= len
;
3911 it
->current
.dpvec_index
= 0;
3912 it
->dpvec_face_id
= -1;
3914 /* Remember the current face id in case glyphs specify faces.
3915 IT's face is restored in set_iterator_to_next.
3916 saved_face_id was set to preceding char's face in handle_stop. */
3917 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3918 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3920 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3926 /***********************************************************************
3928 ***********************************************************************/
3930 /* Set up iterator IT from `display' property at its current position.
3931 Called from handle_stop.
3932 We return HANDLED_RETURN if some part of the display property
3933 overrides the display of the buffer text itself.
3934 Otherwise we return HANDLED_NORMALLY. */
3936 static enum prop_handled
3937 handle_display_prop (it
)
3940 Lisp_Object prop
, object
, overlay
;
3941 struct text_pos
*position
;
3942 /* Nonzero if some property replaces the display of the text itself. */
3943 int display_replaced_p
= 0;
3945 if (STRINGP (it
->string
))
3947 object
= it
->string
;
3948 position
= &it
->current
.string_pos
;
3952 XSETWINDOW (object
, it
->w
);
3953 position
= &it
->current
.pos
;
3956 /* Reset those iterator values set from display property values. */
3957 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3958 it
->space_width
= Qnil
;
3959 it
->font_height
= Qnil
;
3962 /* We don't support recursive `display' properties, i.e. string
3963 values that have a string `display' property, that have a string
3964 `display' property etc. */
3965 if (!it
->string_from_display_prop_p
)
3966 it
->area
= TEXT_AREA
;
3968 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
3969 Qdisplay
, object
, &overlay
);
3971 return HANDLED_NORMALLY
;
3972 /* Now OVERLAY is the overlay that gave us this property, or nil
3973 if it was a text property. */
3975 if (!STRINGP (it
->string
))
3976 object
= it
->w
->buffer
;
3979 /* Simple properties. */
3980 && !EQ (XCAR (prop
), Qimage
)
3981 && !EQ (XCAR (prop
), Qspace
)
3982 && !EQ (XCAR (prop
), Qwhen
)
3983 && !EQ (XCAR (prop
), Qslice
)
3984 && !EQ (XCAR (prop
), Qspace_width
)
3985 && !EQ (XCAR (prop
), Qheight
)
3986 && !EQ (XCAR (prop
), Qraise
)
3987 /* Marginal area specifications. */
3988 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3989 && !EQ (XCAR (prop
), Qleft_fringe
)
3990 && !EQ (XCAR (prop
), Qright_fringe
)
3991 && !NILP (XCAR (prop
)))
3993 for (; CONSP (prop
); prop
= XCDR (prop
))
3995 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
3996 position
, display_replaced_p
))
3998 display_replaced_p
= 1;
3999 /* If some text in a string is replaced, `position' no
4000 longer points to the position of `object'. */
4001 if (STRINGP (object
))
4006 else if (VECTORP (prop
))
4009 for (i
= 0; i
< ASIZE (prop
); ++i
)
4010 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
4011 position
, display_replaced_p
))
4013 display_replaced_p
= 1;
4014 /* If some text in a string is replaced, `position' no
4015 longer points to the position of `object'. */
4016 if (STRINGP (object
))
4022 if (handle_single_display_spec (it
, prop
, object
, overlay
,
4024 display_replaced_p
= 1;
4027 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4031 /* Value is the position of the end of the `display' property starting
4032 at START_POS in OBJECT. */
4034 static struct text_pos
4035 display_prop_end (it
, object
, start_pos
)
4038 struct text_pos start_pos
;
4041 struct text_pos end_pos
;
4043 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4044 Qdisplay
, object
, Qnil
);
4045 CHARPOS (end_pos
) = XFASTINT (end
);
4046 if (STRINGP (object
))
4047 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4049 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4055 /* Set up IT from a single `display' specification PROP. OBJECT
4056 is the object in which the `display' property was found. *POSITION
4057 is the position at which it was found. DISPLAY_REPLACED_P non-zero
4058 means that we previously saw a display specification which already
4059 replaced text display with something else, for example an image;
4060 we ignore such properties after the first one has been processed.
4062 OVERLAY is the overlay this `display' property came from,
4063 or nil if it was a text property.
4065 If PROP is a `space' or `image' specification, and in some other
4066 cases too, set *POSITION to the position where the `display'
4069 Value is non-zero if something was found which replaces the display
4070 of buffer or string text. */
4073 handle_single_display_spec (it
, spec
, object
, overlay
, position
,
4074 display_replaced_before_p
)
4078 Lisp_Object overlay
;
4079 struct text_pos
*position
;
4080 int display_replaced_before_p
;
4083 Lisp_Object location
, value
;
4084 struct text_pos start_pos
, save_pos
;
4087 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4088 If the result is non-nil, use VALUE instead of SPEC. */
4090 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4099 if (!NILP (form
) && !EQ (form
, Qt
))
4101 int count
= SPECPDL_INDEX ();
4102 struct gcpro gcpro1
;
4104 /* Bind `object' to the object having the `display' property, a
4105 buffer or string. Bind `position' to the position in the
4106 object where the property was found, and `buffer-position'
4107 to the current position in the buffer. */
4108 specbind (Qobject
, object
);
4109 specbind (Qposition
, make_number (CHARPOS (*position
)));
4110 specbind (Qbuffer_position
,
4111 make_number (STRINGP (object
)
4112 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
4114 form
= safe_eval (form
);
4116 unbind_to (count
, Qnil
);
4122 /* Handle `(height HEIGHT)' specifications. */
4124 && EQ (XCAR (spec
), Qheight
)
4125 && CONSP (XCDR (spec
)))
4127 if (!FRAME_WINDOW_P (it
->f
))
4130 it
->font_height
= XCAR (XCDR (spec
));
4131 if (!NILP (it
->font_height
))
4133 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4134 int new_height
= -1;
4136 if (CONSP (it
->font_height
)
4137 && (EQ (XCAR (it
->font_height
), Qplus
)
4138 || EQ (XCAR (it
->font_height
), Qminus
))
4139 && CONSP (XCDR (it
->font_height
))
4140 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4142 /* `(+ N)' or `(- N)' where N is an integer. */
4143 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4144 if (EQ (XCAR (it
->font_height
), Qplus
))
4146 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4148 else if (FUNCTIONP (it
->font_height
))
4150 /* Call function with current height as argument.
4151 Value is the new height. */
4153 height
= safe_call1 (it
->font_height
,
4154 face
->lface
[LFACE_HEIGHT_INDEX
]);
4155 if (NUMBERP (height
))
4156 new_height
= XFLOATINT (height
);
4158 else if (NUMBERP (it
->font_height
))
4160 /* Value is a multiple of the canonical char height. */
4163 face
= FACE_FROM_ID (it
->f
,
4164 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4165 new_height
= (XFLOATINT (it
->font_height
)
4166 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
4170 /* Evaluate IT->font_height with `height' bound to the
4171 current specified height to get the new height. */
4172 int count
= SPECPDL_INDEX ();
4174 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4175 value
= safe_eval (it
->font_height
);
4176 unbind_to (count
, Qnil
);
4178 if (NUMBERP (value
))
4179 new_height
= XFLOATINT (value
);
4183 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4189 /* Handle `(space-width WIDTH)'. */
4191 && EQ (XCAR (spec
), Qspace_width
)
4192 && CONSP (XCDR (spec
)))
4194 if (!FRAME_WINDOW_P (it
->f
))
4197 value
= XCAR (XCDR (spec
));
4198 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4199 it
->space_width
= value
;
4204 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4206 && EQ (XCAR (spec
), Qslice
))
4210 if (!FRAME_WINDOW_P (it
->f
))
4213 if (tem
= XCDR (spec
), CONSP (tem
))
4215 it
->slice
.x
= XCAR (tem
);
4216 if (tem
= XCDR (tem
), CONSP (tem
))
4218 it
->slice
.y
= XCAR (tem
);
4219 if (tem
= XCDR (tem
), CONSP (tem
))
4221 it
->slice
.width
= XCAR (tem
);
4222 if (tem
= XCDR (tem
), CONSP (tem
))
4223 it
->slice
.height
= XCAR (tem
);
4231 /* Handle `(raise FACTOR)'. */
4233 && EQ (XCAR (spec
), Qraise
)
4234 && CONSP (XCDR (spec
)))
4236 if (!FRAME_WINDOW_P (it
->f
))
4239 #ifdef HAVE_WINDOW_SYSTEM
4240 value
= XCAR (XCDR (spec
));
4241 if (NUMBERP (value
))
4243 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4244 it
->voffset
= - (XFLOATINT (value
)
4245 * (FONT_HEIGHT (face
->font
)));
4247 #endif /* HAVE_WINDOW_SYSTEM */
4252 /* Don't handle the other kinds of display specifications
4253 inside a string that we got from a `display' property. */
4254 if (it
->string_from_display_prop_p
)
4257 /* Characters having this form of property are not displayed, so
4258 we have to find the end of the property. */
4259 start_pos
= *position
;
4260 *position
= display_prop_end (it
, object
, start_pos
);
4263 /* Stop the scan at that end position--we assume that all
4264 text properties change there. */
4265 it
->stop_charpos
= position
->charpos
;
4267 /* Handle `(left-fringe BITMAP [FACE])'
4268 and `(right-fringe BITMAP [FACE])'. */
4270 && (EQ (XCAR (spec
), Qleft_fringe
)
4271 || EQ (XCAR (spec
), Qright_fringe
))
4272 && CONSP (XCDR (spec
)))
4274 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4277 if (!FRAME_WINDOW_P (it
->f
))
4278 /* If we return here, POSITION has been advanced
4279 across the text with this property. */
4282 #ifdef HAVE_WINDOW_SYSTEM
4283 value
= XCAR (XCDR (spec
));
4284 if (!SYMBOLP (value
)
4285 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4286 /* If we return here, POSITION has been advanced
4287 across the text with this property. */
4290 if (CONSP (XCDR (XCDR (spec
))))
4292 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4293 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4299 /* Save current settings of IT so that we can restore them
4300 when we are finished with the glyph property value. */
4302 save_pos
= it
->position
;
4303 it
->position
= *position
;
4305 it
->position
= save_pos
;
4307 it
->area
= TEXT_AREA
;
4308 it
->what
= IT_IMAGE
;
4309 it
->image_id
= -1; /* no image */
4310 it
->position
= start_pos
;
4311 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4312 it
->method
= GET_FROM_IMAGE
;
4313 it
->from_overlay
= Qnil
;
4314 it
->face_id
= face_id
;
4316 /* Say that we haven't consumed the characters with
4317 `display' property yet. The call to pop_it in
4318 set_iterator_to_next will clean this up. */
4319 *position
= start_pos
;
4321 if (EQ (XCAR (spec
), Qleft_fringe
))
4323 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4324 it
->left_user_fringe_face_id
= face_id
;
4328 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4329 it
->right_user_fringe_face_id
= face_id
;
4331 #endif /* HAVE_WINDOW_SYSTEM */
4335 /* Prepare to handle `((margin left-margin) ...)',
4336 `((margin right-margin) ...)' and `((margin nil) ...)'
4337 prefixes for display specifications. */
4338 location
= Qunbound
;
4339 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4343 value
= XCDR (spec
);
4345 value
= XCAR (value
);
4348 if (EQ (XCAR (tem
), Qmargin
)
4349 && (tem
= XCDR (tem
),
4350 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4352 || EQ (tem
, Qleft_margin
)
4353 || EQ (tem
, Qright_margin
))))
4357 if (EQ (location
, Qunbound
))
4363 /* After this point, VALUE is the property after any
4364 margin prefix has been stripped. It must be a string,
4365 an image specification, or `(space ...)'.
4367 LOCATION specifies where to display: `left-margin',
4368 `right-margin' or nil. */
4370 valid_p
= (STRINGP (value
)
4371 #ifdef HAVE_WINDOW_SYSTEM
4372 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4373 #endif /* not HAVE_WINDOW_SYSTEM */
4374 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4376 if (valid_p
&& !display_replaced_before_p
)
4378 /* Save current settings of IT so that we can restore them
4379 when we are finished with the glyph property value. */
4380 save_pos
= it
->position
;
4381 it
->position
= *position
;
4383 it
->position
= save_pos
;
4384 it
->from_overlay
= overlay
;
4386 if (NILP (location
))
4387 it
->area
= TEXT_AREA
;
4388 else if (EQ (location
, Qleft_margin
))
4389 it
->area
= LEFT_MARGIN_AREA
;
4391 it
->area
= RIGHT_MARGIN_AREA
;
4393 if (STRINGP (value
))
4396 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4397 it
->current
.overlay_string_index
= -1;
4398 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4399 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4400 it
->method
= GET_FROM_STRING
;
4401 it
->stop_charpos
= 0;
4402 it
->string_from_display_prop_p
= 1;
4403 /* Say that we haven't consumed the characters with
4404 `display' property yet. The call to pop_it in
4405 set_iterator_to_next will clean this up. */
4406 if (BUFFERP (object
))
4407 *position
= start_pos
;
4409 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4411 it
->method
= GET_FROM_STRETCH
;
4413 *position
= it
->position
= start_pos
;
4415 #ifdef HAVE_WINDOW_SYSTEM
4418 it
->what
= IT_IMAGE
;
4419 it
->image_id
= lookup_image (it
->f
, value
);
4420 it
->position
= start_pos
;
4421 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4422 it
->method
= GET_FROM_IMAGE
;
4424 /* Say that we haven't consumed the characters with
4425 `display' property yet. The call to pop_it in
4426 set_iterator_to_next will clean this up. */
4427 *position
= start_pos
;
4429 #endif /* HAVE_WINDOW_SYSTEM */
4434 /* Invalid property or property not supported. Restore
4435 POSITION to what it was before. */
4436 *position
= start_pos
;
4441 /* Check if SPEC is a display sub-property value whose text should be
4442 treated as intangible. */
4445 single_display_spec_intangible_p (prop
)
4448 /* Skip over `when FORM'. */
4449 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4463 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4464 we don't need to treat text as intangible. */
4465 if (EQ (XCAR (prop
), Qmargin
))
4473 || EQ (XCAR (prop
), Qleft_margin
)
4474 || EQ (XCAR (prop
), Qright_margin
))
4478 return (CONSP (prop
)
4479 && (EQ (XCAR (prop
), Qimage
)
4480 || EQ (XCAR (prop
), Qspace
)));
4484 /* Check if PROP is a display property value whose text should be
4485 treated as intangible. */
4488 display_prop_intangible_p (prop
)
4492 && CONSP (XCAR (prop
))
4493 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4495 /* A list of sub-properties. */
4496 while (CONSP (prop
))
4498 if (single_display_spec_intangible_p (XCAR (prop
)))
4503 else if (VECTORP (prop
))
4505 /* A vector of sub-properties. */
4507 for (i
= 0; i
< ASIZE (prop
); ++i
)
4508 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4512 return single_display_spec_intangible_p (prop
);
4518 /* Return 1 if PROP is a display sub-property value containing STRING. */
4521 single_display_spec_string_p (prop
, string
)
4522 Lisp_Object prop
, string
;
4524 if (EQ (string
, prop
))
4527 /* Skip over `when FORM'. */
4528 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4537 /* Skip over `margin LOCATION'. */
4538 if (EQ (XCAR (prop
), Qmargin
))
4549 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4553 /* Return 1 if STRING appears in the `display' property PROP. */
4556 display_prop_string_p (prop
, string
)
4557 Lisp_Object prop
, string
;
4560 && CONSP (XCAR (prop
))
4561 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4563 /* A list of sub-properties. */
4564 while (CONSP (prop
))
4566 if (single_display_spec_string_p (XCAR (prop
), string
))
4571 else if (VECTORP (prop
))
4573 /* A vector of sub-properties. */
4575 for (i
= 0; i
< ASIZE (prop
); ++i
)
4576 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4580 return single_display_spec_string_p (prop
, string
);
4585 /* Look for STRING in overlays and text properties in W's buffer,
4586 between character positions FROM and TO (excluding TO).
4587 BACK_P non-zero means look back (in this case, TO is supposed to be
4589 Value is the first character position where STRING was found, or
4590 zero if it wasn't found before hitting TO.
4592 W's buffer must be current.
4594 This function may only use code that doesn't eval because it is
4595 called asynchronously from note_mouse_highlight. */
4598 string_buffer_position_lim (w
, string
, from
, to
, back_p
)
4604 Lisp_Object limit
, prop
, pos
;
4607 pos
= make_number (from
);
4609 if (!back_p
) /* looking forward */
4611 limit
= make_number (min (to
, ZV
));
4612 while (!found
&& !EQ (pos
, limit
))
4614 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4615 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4618 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4622 else /* looking back */
4624 limit
= make_number (max (to
, BEGV
));
4625 while (!found
&& !EQ (pos
, limit
))
4627 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4628 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4631 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4636 return found
? XINT (pos
) : 0;
4639 /* Determine which buffer position in W's buffer STRING comes from.
4640 AROUND_CHARPOS is an approximate position where it could come from.
4641 Value is the buffer position or 0 if it couldn't be determined.
4643 W's buffer must be current.
4645 This function is necessary because we don't record buffer positions
4646 in glyphs generated from strings (to keep struct glyph small).
4647 This function may only use code that doesn't eval because it is
4648 called asynchronously from note_mouse_highlight. */
4651 string_buffer_position (w
, string
, around_charpos
)
4654 EMACS_INT around_charpos
;
4656 Lisp_Object limit
, prop
, pos
;
4657 const int MAX_DISTANCE
= 1000;
4658 EMACS_INT found
= string_buffer_position_lim (w
, string
, around_charpos
,
4659 around_charpos
+ MAX_DISTANCE
,
4663 found
= string_buffer_position_lim (w
, string
, around_charpos
,
4664 around_charpos
- MAX_DISTANCE
, 1);
4670 /***********************************************************************
4671 `composition' property
4672 ***********************************************************************/
4674 /* Set up iterator IT from `composition' property at its current
4675 position. Called from handle_stop. */
4677 static enum prop_handled
4678 handle_composition_prop (it
)
4681 Lisp_Object prop
, string
;
4682 EMACS_INT pos
, pos_byte
, start
, end
;
4684 if (STRINGP (it
->string
))
4688 pos
= IT_STRING_CHARPOS (*it
);
4689 pos_byte
= IT_STRING_BYTEPOS (*it
);
4690 string
= it
->string
;
4691 s
= SDATA (string
) + pos_byte
;
4692 it
->c
= STRING_CHAR (s
);
4696 pos
= IT_CHARPOS (*it
);
4697 pos_byte
= IT_BYTEPOS (*it
);
4699 it
->c
= FETCH_CHAR (pos_byte
);
4702 /* If there's a valid composition and point is not inside of the
4703 composition (in the case that the composition is from the current
4704 buffer), draw a glyph composed from the composition components. */
4705 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4706 && COMPOSITION_VALID_P (start
, end
, prop
)
4707 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4711 if (STRINGP (it
->string
))
4712 pos_byte
= string_char_to_byte (it
->string
, start
);
4714 pos_byte
= CHAR_TO_BYTE (start
);
4716 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4719 if (it
->cmp_it
.id
>= 0)
4722 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4723 it
->cmp_it
.nglyphs
= -1;
4727 return HANDLED_NORMALLY
;
4732 /***********************************************************************
4734 ***********************************************************************/
4736 /* The following structure is used to record overlay strings for
4737 later sorting in load_overlay_strings. */
4739 struct overlay_entry
4741 Lisp_Object overlay
;
4748 /* Set up iterator IT from overlay strings at its current position.
4749 Called from handle_stop. */
4751 static enum prop_handled
4752 handle_overlay_change (it
)
4755 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4756 return HANDLED_RECOMPUTE_PROPS
;
4758 return HANDLED_NORMALLY
;
4762 /* Set up the next overlay string for delivery by IT, if there is an
4763 overlay string to deliver. Called by set_iterator_to_next when the
4764 end of the current overlay string is reached. If there are more
4765 overlay strings to display, IT->string and
4766 IT->current.overlay_string_index are set appropriately here.
4767 Otherwise IT->string is set to nil. */
4770 next_overlay_string (it
)
4773 ++it
->current
.overlay_string_index
;
4774 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4776 /* No more overlay strings. Restore IT's settings to what
4777 they were before overlay strings were processed, and
4778 continue to deliver from current_buffer. */
4780 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4783 || (NILP (it
->string
)
4784 && it
->method
== GET_FROM_BUFFER
4785 && it
->stop_charpos
>= BEGV
4786 && it
->stop_charpos
<= it
->end_charpos
));
4787 it
->current
.overlay_string_index
= -1;
4788 it
->n_overlay_strings
= 0;
4790 /* If we're at the end of the buffer, record that we have
4791 processed the overlay strings there already, so that
4792 next_element_from_buffer doesn't try it again. */
4793 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4794 it
->overlay_strings_at_end_processed_p
= 1;
4798 /* There are more overlay strings to process. If
4799 IT->current.overlay_string_index has advanced to a position
4800 where we must load IT->overlay_strings with more strings, do
4802 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4804 if (it
->current
.overlay_string_index
&& i
== 0)
4805 load_overlay_strings (it
, 0);
4807 /* Initialize IT to deliver display elements from the overlay
4809 it
->string
= it
->overlay_strings
[i
];
4810 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4811 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4812 it
->method
= GET_FROM_STRING
;
4813 it
->stop_charpos
= 0;
4814 if (it
->cmp_it
.stop_pos
>= 0)
4815 it
->cmp_it
.stop_pos
= 0;
4822 /* Compare two overlay_entry structures E1 and E2. Used as a
4823 comparison function for qsort in load_overlay_strings. Overlay
4824 strings for the same position are sorted so that
4826 1. All after-strings come in front of before-strings, except
4827 when they come from the same overlay.
4829 2. Within after-strings, strings are sorted so that overlay strings
4830 from overlays with higher priorities come first.
4832 2. Within before-strings, strings are sorted so that overlay
4833 strings from overlays with higher priorities come last.
4835 Value is analogous to strcmp. */
4839 compare_overlay_entries (e1
, e2
)
4842 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4843 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4846 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4848 /* Let after-strings appear in front of before-strings if
4849 they come from different overlays. */
4850 if (EQ (entry1
->overlay
, entry2
->overlay
))
4851 result
= entry1
->after_string_p
? 1 : -1;
4853 result
= entry1
->after_string_p
? -1 : 1;
4855 else if (entry1
->after_string_p
)
4856 /* After-strings sorted in order of decreasing priority. */
4857 result
= entry2
->priority
- entry1
->priority
;
4859 /* Before-strings sorted in order of increasing priority. */
4860 result
= entry1
->priority
- entry2
->priority
;
4866 /* Load the vector IT->overlay_strings with overlay strings from IT's
4867 current buffer position, or from CHARPOS if that is > 0. Set
4868 IT->n_overlays to the total number of overlay strings found.
4870 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4871 a time. On entry into load_overlay_strings,
4872 IT->current.overlay_string_index gives the number of overlay
4873 strings that have already been loaded by previous calls to this
4876 IT->add_overlay_start contains an additional overlay start
4877 position to consider for taking overlay strings from, if non-zero.
4878 This position comes into play when the overlay has an `invisible'
4879 property, and both before and after-strings. When we've skipped to
4880 the end of the overlay, because of its `invisible' property, we
4881 nevertheless want its before-string to appear.
4882 IT->add_overlay_start will contain the overlay start position
4885 Overlay strings are sorted so that after-string strings come in
4886 front of before-string strings. Within before and after-strings,
4887 strings are sorted by overlay priority. See also function
4888 compare_overlay_entries. */
4891 load_overlay_strings (it
, charpos
)
4895 extern Lisp_Object Qwindow
, Qpriority
;
4896 Lisp_Object overlay
, window
, str
, invisible
;
4897 struct Lisp_Overlay
*ov
;
4900 int n
= 0, i
, j
, invis_p
;
4901 struct overlay_entry
*entries
4902 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4905 charpos
= IT_CHARPOS (*it
);
4907 /* Append the overlay string STRING of overlay OVERLAY to vector
4908 `entries' which has size `size' and currently contains `n'
4909 elements. AFTER_P non-zero means STRING is an after-string of
4911 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4914 Lisp_Object priority; \
4918 int new_size = 2 * size; \
4919 struct overlay_entry *old = entries; \
4921 (struct overlay_entry *) alloca (new_size \
4922 * sizeof *entries); \
4923 bcopy (old, entries, size * sizeof *entries); \
4927 entries[n].string = (STRING); \
4928 entries[n].overlay = (OVERLAY); \
4929 priority = Foverlay_get ((OVERLAY), Qpriority); \
4930 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4931 entries[n].after_string_p = (AFTER_P); \
4936 /* Process overlay before the overlay center. */
4937 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4939 XSETMISC (overlay
, ov
);
4940 xassert (OVERLAYP (overlay
));
4941 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4942 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4947 /* Skip this overlay if it doesn't start or end at IT's current
4949 if (end
!= charpos
&& start
!= charpos
)
4952 /* Skip this overlay if it doesn't apply to IT->w. */
4953 window
= Foverlay_get (overlay
, Qwindow
);
4954 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4957 /* If the text ``under'' the overlay is invisible, both before-
4958 and after-strings from this overlay are visible; start and
4959 end position are indistinguishable. */
4960 invisible
= Foverlay_get (overlay
, Qinvisible
);
4961 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4963 /* If overlay has a non-empty before-string, record it. */
4964 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4965 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4967 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4969 /* If overlay has a non-empty after-string, record it. */
4970 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4971 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4973 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4976 /* Process overlays after the overlay center. */
4977 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4979 XSETMISC (overlay
, ov
);
4980 xassert (OVERLAYP (overlay
));
4981 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4982 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4984 if (start
> charpos
)
4987 /* Skip this overlay if it doesn't start or end at IT's current
4989 if (end
!= charpos
&& start
!= charpos
)
4992 /* Skip this overlay if it doesn't apply to IT->w. */
4993 window
= Foverlay_get (overlay
, Qwindow
);
4994 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4997 /* If the text ``under'' the overlay is invisible, it has a zero
4998 dimension, and both before- and after-strings apply. */
4999 invisible
= Foverlay_get (overlay
, Qinvisible
);
5000 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5002 /* If overlay has a non-empty before-string, record it. */
5003 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5004 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5006 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5008 /* If overlay has a non-empty after-string, record it. */
5009 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5010 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5012 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5015 #undef RECORD_OVERLAY_STRING
5019 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5021 /* Record the total number of strings to process. */
5022 it
->n_overlay_strings
= n
;
5024 /* IT->current.overlay_string_index is the number of overlay strings
5025 that have already been consumed by IT. Copy some of the
5026 remaining overlay strings to IT->overlay_strings. */
5028 j
= it
->current
.overlay_string_index
;
5029 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5031 it
->overlay_strings
[i
] = entries
[j
].string
;
5032 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5039 /* Get the first chunk of overlay strings at IT's current buffer
5040 position, or at CHARPOS if that is > 0. Value is non-zero if at
5041 least one overlay string was found. */
5044 get_overlay_strings_1 (it
, charpos
, compute_stop_p
)
5049 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5050 process. This fills IT->overlay_strings with strings, and sets
5051 IT->n_overlay_strings to the total number of strings to process.
5052 IT->pos.overlay_string_index has to be set temporarily to zero
5053 because load_overlay_strings needs this; it must be set to -1
5054 when no overlay strings are found because a zero value would
5055 indicate a position in the first overlay string. */
5056 it
->current
.overlay_string_index
= 0;
5057 load_overlay_strings (it
, charpos
);
5059 /* If we found overlay strings, set up IT to deliver display
5060 elements from the first one. Otherwise set up IT to deliver
5061 from current_buffer. */
5062 if (it
->n_overlay_strings
)
5064 /* Make sure we know settings in current_buffer, so that we can
5065 restore meaningful values when we're done with the overlay
5068 compute_stop_pos (it
);
5069 xassert (it
->face_id
>= 0);
5071 /* Save IT's settings. They are restored after all overlay
5072 strings have been processed. */
5073 xassert (!compute_stop_p
|| it
->sp
== 0);
5075 /* When called from handle_stop, there might be an empty display
5076 string loaded. In that case, don't bother saving it. */
5077 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5080 /* Set up IT to deliver display elements from the first overlay
5082 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5083 it
->string
= it
->overlay_strings
[0];
5084 it
->from_overlay
= Qnil
;
5085 it
->stop_charpos
= 0;
5086 xassert (STRINGP (it
->string
));
5087 it
->end_charpos
= SCHARS (it
->string
);
5088 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5089 it
->method
= GET_FROM_STRING
;
5093 it
->current
.overlay_string_index
= -1;
5098 get_overlay_strings (it
, charpos
)
5103 it
->method
= GET_FROM_BUFFER
;
5105 (void) get_overlay_strings_1 (it
, charpos
, 1);
5109 /* Value is non-zero if we found at least one overlay string. */
5110 return STRINGP (it
->string
);
5115 /***********************************************************************
5116 Saving and restoring state
5117 ***********************************************************************/
5119 /* Save current settings of IT on IT->stack. Called, for example,
5120 before setting up IT for an overlay string, to be able to restore
5121 IT's settings to what they were after the overlay string has been
5128 struct iterator_stack_entry
*p
;
5130 xassert (it
->sp
< IT_STACK_SIZE
);
5131 p
= it
->stack
+ it
->sp
;
5133 p
->stop_charpos
= it
->stop_charpos
;
5134 p
->prev_stop
= it
->prev_stop
;
5135 p
->base_level_stop
= it
->base_level_stop
;
5136 p
->cmp_it
= it
->cmp_it
;
5137 xassert (it
->face_id
>= 0);
5138 p
->face_id
= it
->face_id
;
5139 p
->string
= it
->string
;
5140 p
->method
= it
->method
;
5141 p
->from_overlay
= it
->from_overlay
;
5144 case GET_FROM_IMAGE
:
5145 p
->u
.image
.object
= it
->object
;
5146 p
->u
.image
.image_id
= it
->image_id
;
5147 p
->u
.image
.slice
= it
->slice
;
5149 case GET_FROM_STRETCH
:
5150 p
->u
.stretch
.object
= it
->object
;
5153 p
->position
= it
->position
;
5154 p
->current
= it
->current
;
5155 p
->end_charpos
= it
->end_charpos
;
5156 p
->string_nchars
= it
->string_nchars
;
5158 p
->multibyte_p
= it
->multibyte_p
;
5159 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5160 p
->space_width
= it
->space_width
;
5161 p
->font_height
= it
->font_height
;
5162 p
->voffset
= it
->voffset
;
5163 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5164 p
->display_ellipsis_p
= 0;
5165 p
->line_wrap
= it
->line_wrap
;
5170 /* Restore IT's settings from IT->stack. Called, for example, when no
5171 more overlay strings must be processed, and we return to delivering
5172 display elements from a buffer, or when the end of a string from a
5173 `display' property is reached and we return to delivering display
5174 elements from an overlay string, or from a buffer. */
5180 struct iterator_stack_entry
*p
;
5182 xassert (it
->sp
> 0);
5184 p
= it
->stack
+ it
->sp
;
5185 it
->stop_charpos
= p
->stop_charpos
;
5186 it
->prev_stop
= p
->prev_stop
;
5187 it
->base_level_stop
= p
->base_level_stop
;
5188 it
->cmp_it
= p
->cmp_it
;
5189 it
->face_id
= p
->face_id
;
5190 it
->current
= p
->current
;
5191 it
->position
= p
->position
;
5192 it
->string
= p
->string
;
5193 it
->from_overlay
= p
->from_overlay
;
5194 if (NILP (it
->string
))
5195 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5196 it
->method
= p
->method
;
5199 case GET_FROM_IMAGE
:
5200 it
->image_id
= p
->u
.image
.image_id
;
5201 it
->object
= p
->u
.image
.object
;
5202 it
->slice
= p
->u
.image
.slice
;
5204 case GET_FROM_STRETCH
:
5205 it
->object
= p
->u
.comp
.object
;
5207 case GET_FROM_BUFFER
:
5208 it
->object
= it
->w
->buffer
;
5210 case GET_FROM_STRING
:
5211 it
->object
= it
->string
;
5213 case GET_FROM_DISPLAY_VECTOR
:
5215 it
->method
= GET_FROM_C_STRING
;
5216 else if (STRINGP (it
->string
))
5217 it
->method
= GET_FROM_STRING
;
5220 it
->method
= GET_FROM_BUFFER
;
5221 it
->object
= it
->w
->buffer
;
5224 it
->end_charpos
= p
->end_charpos
;
5225 it
->string_nchars
= p
->string_nchars
;
5227 it
->multibyte_p
= p
->multibyte_p
;
5228 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5229 it
->space_width
= p
->space_width
;
5230 it
->font_height
= p
->font_height
;
5231 it
->voffset
= p
->voffset
;
5232 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5233 it
->line_wrap
= p
->line_wrap
;
5238 /***********************************************************************
5240 ***********************************************************************/
5242 /* Set IT's current position to the previous line start. */
5245 back_to_previous_line_start (it
)
5248 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5249 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5253 /* Move IT to the next line start.
5255 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5256 we skipped over part of the text (as opposed to moving the iterator
5257 continuously over the text). Otherwise, don't change the value
5260 Newlines may come from buffer text, overlay strings, or strings
5261 displayed via the `display' property. That's the reason we can't
5262 simply use find_next_newline_no_quit.
5264 Note that this function may not skip over invisible text that is so
5265 because of text properties and immediately follows a newline. If
5266 it would, function reseat_at_next_visible_line_start, when called
5267 from set_iterator_to_next, would effectively make invisible
5268 characters following a newline part of the wrong glyph row, which
5269 leads to wrong cursor motion. */
5272 forward_to_next_line_start (it
, skipped_p
)
5276 int old_selective
, newline_found_p
, n
;
5277 const int MAX_NEWLINE_DISTANCE
= 500;
5279 /* If already on a newline, just consume it to avoid unintended
5280 skipping over invisible text below. */
5281 if (it
->what
== IT_CHARACTER
5283 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5285 set_iterator_to_next (it
, 0);
5290 /* Don't handle selective display in the following. It's (a)
5291 unnecessary because it's done by the caller, and (b) leads to an
5292 infinite recursion because next_element_from_ellipsis indirectly
5293 calls this function. */
5294 old_selective
= it
->selective
;
5297 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5298 from buffer text. */
5299 for (n
= newline_found_p
= 0;
5300 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5301 n
+= STRINGP (it
->string
) ? 0 : 1)
5303 if (!get_next_display_element (it
))
5305 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5306 set_iterator_to_next (it
, 0);
5309 /* If we didn't find a newline near enough, see if we can use a
5311 if (!newline_found_p
)
5313 int start
= IT_CHARPOS (*it
);
5314 int limit
= find_next_newline_no_quit (start
, 1);
5317 xassert (!STRINGP (it
->string
));
5319 /* If there isn't any `display' property in sight, and no
5320 overlays, we can just use the position of the newline in
5322 if (it
->stop_charpos
>= limit
5323 || ((pos
= Fnext_single_property_change (make_number (start
),
5325 Qnil
, make_number (limit
)),
5327 && next_overlay_change (start
) == ZV
))
5329 IT_CHARPOS (*it
) = limit
;
5330 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5331 *skipped_p
= newline_found_p
= 1;
5335 while (get_next_display_element (it
)
5336 && !newline_found_p
)
5338 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5339 set_iterator_to_next (it
, 0);
5344 it
->selective
= old_selective
;
5345 return newline_found_p
;
5349 /* Set IT's current position to the previous visible line start. Skip
5350 invisible text that is so either due to text properties or due to
5351 selective display. Caution: this does not change IT->current_x and
5355 back_to_previous_visible_line_start (it
)
5358 while (IT_CHARPOS (*it
) > BEGV
)
5360 back_to_previous_line_start (it
);
5362 if (IT_CHARPOS (*it
) <= BEGV
)
5365 /* If selective > 0, then lines indented more than its value are
5367 if (it
->selective
> 0
5368 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5369 (double) it
->selective
)) /* iftc */
5372 /* Check the newline before point for invisibility. */
5375 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5376 Qinvisible
, it
->window
);
5377 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5381 if (IT_CHARPOS (*it
) <= BEGV
)
5388 Lisp_Object val
, overlay
;
5390 /* If newline is part of a composition, continue from start of composition */
5391 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5392 && beg
< IT_CHARPOS (*it
))
5395 /* If newline is replaced by a display property, find start of overlay
5396 or interval and continue search from that point. */
5398 pos
= --IT_CHARPOS (it2
);
5401 it2
.string_from_display_prop_p
= 0;
5402 if (handle_display_prop (&it2
) == HANDLED_RETURN
5403 && !NILP (val
= get_char_property_and_overlay
5404 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5405 && (OVERLAYP (overlay
)
5406 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5407 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5410 /* Newline is not replaced by anything -- so we are done. */
5416 IT_CHARPOS (*it
) = beg
;
5417 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5421 it
->continuation_lines_width
= 0;
5423 xassert (IT_CHARPOS (*it
) >= BEGV
);
5424 xassert (IT_CHARPOS (*it
) == BEGV
5425 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5430 /* Reseat iterator IT at the previous visible line start. Skip
5431 invisible text that is so either due to text properties or due to
5432 selective display. At the end, update IT's overlay information,
5433 face information etc. */
5436 reseat_at_previous_visible_line_start (it
)
5439 back_to_previous_visible_line_start (it
);
5440 reseat (it
, it
->current
.pos
, 1);
5445 /* Reseat iterator IT on the next visible line start in the current
5446 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5447 preceding the line start. Skip over invisible text that is so
5448 because of selective display. Compute faces, overlays etc at the
5449 new position. Note that this function does not skip over text that
5450 is invisible because of text properties. */
5453 reseat_at_next_visible_line_start (it
, on_newline_p
)
5457 int newline_found_p
, skipped_p
= 0;
5459 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5461 /* Skip over lines that are invisible because they are indented
5462 more than the value of IT->selective. */
5463 if (it
->selective
> 0)
5464 while (IT_CHARPOS (*it
) < ZV
5465 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5466 (double) it
->selective
)) /* iftc */
5468 xassert (IT_BYTEPOS (*it
) == BEGV
5469 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5470 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5473 /* Position on the newline if that's what's requested. */
5474 if (on_newline_p
&& newline_found_p
)
5476 if (STRINGP (it
->string
))
5478 if (IT_STRING_CHARPOS (*it
) > 0)
5480 --IT_STRING_CHARPOS (*it
);
5481 --IT_STRING_BYTEPOS (*it
);
5484 else if (IT_CHARPOS (*it
) > BEGV
)
5488 reseat (it
, it
->current
.pos
, 0);
5492 reseat (it
, it
->current
.pos
, 0);
5499 /***********************************************************************
5500 Changing an iterator's position
5501 ***********************************************************************/
5503 /* Change IT's current position to POS in current_buffer. If FORCE_P
5504 is non-zero, always check for text properties at the new position.
5505 Otherwise, text properties are only looked up if POS >=
5506 IT->check_charpos of a property. */
5509 reseat (it
, pos
, force_p
)
5511 struct text_pos pos
;
5514 int original_pos
= IT_CHARPOS (*it
);
5516 reseat_1 (it
, pos
, 0);
5518 /* Determine where to check text properties. Avoid doing it
5519 where possible because text property lookup is very expensive. */
5521 || CHARPOS (pos
) > it
->stop_charpos
5522 || CHARPOS (pos
) < original_pos
)
5526 /* For bidi iteration, we need to prime prev_stop and
5527 base_level_stop with our best estimations. */
5528 if (CHARPOS (pos
) < it
->prev_stop
)
5530 handle_stop_backwards (it
, BEGV
);
5531 if (CHARPOS (pos
) < it
->base_level_stop
)
5532 it
->base_level_stop
= 0;
5534 else if (CHARPOS (pos
) > it
->stop_charpos
5535 && it
->stop_charpos
>= BEGV
)
5536 handle_stop_backwards (it
, it
->stop_charpos
);
5543 it
->prev_stop
= it
->base_level_stop
= 0;
5552 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5553 IT->stop_pos to POS, also. */
5556 reseat_1 (it
, pos
, set_stop_p
)
5558 struct text_pos pos
;
5561 /* Don't call this function when scanning a C string. */
5562 xassert (it
->s
== NULL
);
5564 /* POS must be a reasonable value. */
5565 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5567 it
->current
.pos
= it
->position
= pos
;
5568 it
->end_charpos
= ZV
;
5570 it
->current
.dpvec_index
= -1;
5571 it
->current
.overlay_string_index
= -1;
5572 IT_STRING_CHARPOS (*it
) = -1;
5573 IT_STRING_BYTEPOS (*it
) = -1;
5575 it
->string_from_display_prop_p
= 0;
5576 it
->method
= GET_FROM_BUFFER
;
5577 it
->object
= it
->w
->buffer
;
5578 it
->area
= TEXT_AREA
;
5579 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
5581 it
->string_from_display_prop_p
= 0;
5582 it
->face_before_selective_p
= 0;
5584 it
->bidi_it
.first_elt
= 1;
5588 it
->stop_charpos
= CHARPOS (pos
);
5589 it
->base_level_stop
= CHARPOS (pos
);
5594 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5595 If S is non-null, it is a C string to iterate over. Otherwise,
5596 STRING gives a Lisp string to iterate over.
5598 If PRECISION > 0, don't return more then PRECISION number of
5599 characters from the string.
5601 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5602 characters have been returned. FIELD_WIDTH < 0 means an infinite
5605 MULTIBYTE = 0 means disable processing of multibyte characters,
5606 MULTIBYTE > 0 means enable it,
5607 MULTIBYTE < 0 means use IT->multibyte_p.
5609 IT must be initialized via a prior call to init_iterator before
5610 calling this function. */
5613 reseat_to_string (it
, s
, string
, charpos
, precision
, field_width
, multibyte
)
5618 int precision
, field_width
, multibyte
;
5620 /* No region in strings. */
5621 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5623 /* No text property checks performed by default, but see below. */
5624 it
->stop_charpos
= -1;
5626 /* Set iterator position and end position. */
5627 bzero (&it
->current
, sizeof it
->current
);
5628 it
->current
.overlay_string_index
= -1;
5629 it
->current
.dpvec_index
= -1;
5630 xassert (charpos
>= 0);
5632 /* If STRING is specified, use its multibyteness, otherwise use the
5633 setting of MULTIBYTE, if specified. */
5635 it
->multibyte_p
= multibyte
> 0;
5639 xassert (STRINGP (string
));
5640 it
->string
= string
;
5642 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5643 it
->method
= GET_FROM_STRING
;
5644 it
->current
.string_pos
= string_pos (charpos
, string
);
5651 /* Note that we use IT->current.pos, not it->current.string_pos,
5652 for displaying C strings. */
5653 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5654 if (it
->multibyte_p
)
5656 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5657 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5661 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5662 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5665 it
->method
= GET_FROM_C_STRING
;
5668 /* PRECISION > 0 means don't return more than PRECISION characters
5670 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5671 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5673 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5674 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5675 FIELD_WIDTH < 0 means infinite field width. This is useful for
5676 padding with `-' at the end of a mode line. */
5677 if (field_width
< 0)
5678 field_width
= INFINITY
;
5679 if (field_width
> it
->end_charpos
- charpos
)
5680 it
->end_charpos
= charpos
+ field_width
;
5682 /* Use the standard display table for displaying strings. */
5683 if (DISP_TABLE_P (Vstandard_display_table
))
5684 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5686 it
->stop_charpos
= charpos
;
5687 if (s
== NULL
&& it
->multibyte_p
)
5689 EMACS_INT endpos
= SCHARS (it
->string
);
5690 if (endpos
> it
->end_charpos
)
5691 endpos
= it
->end_charpos
;
5692 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5700 /***********************************************************************
5702 ***********************************************************************/
5704 /* Map enum it_method value to corresponding next_element_from_* function. */
5706 static int (* get_next_element
[NUM_IT_METHODS
]) P_ ((struct it
*it
)) =
5708 next_element_from_buffer
,
5709 next_element_from_display_vector
,
5710 next_element_from_string
,
5711 next_element_from_c_string
,
5712 next_element_from_image
,
5713 next_element_from_stretch
5716 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5719 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5720 (possibly with the following characters). */
5722 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
5723 ((IT)->cmp_it.id >= 0 \
5724 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5725 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5726 END_CHARPOS, (IT)->w, \
5727 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5731 /* Load IT's display element fields with information about the next
5732 display element from the current position of IT. Value is zero if
5733 end of buffer (or C string) is reached. */
5735 static struct frame
*last_escape_glyph_frame
= NULL
;
5736 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5737 static int last_escape_glyph_merged_face_id
= 0;
5740 get_next_display_element (it
)
5743 /* Non-zero means that we found a display element. Zero means that
5744 we hit the end of what we iterate over. Performance note: the
5745 function pointer `method' used here turns out to be faster than
5746 using a sequence of if-statements. */
5750 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5752 if (it
->what
== IT_CHARACTER
)
5754 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
5755 and only if (a) the resolved directionality of that character
5757 /* FIXME: Do we need an exception for characters from display
5759 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
5760 it
->c
= bidi_mirror_char (it
->c
);
5761 /* Map via display table or translate control characters.
5762 IT->c, IT->len etc. have been set to the next character by
5763 the function call above. If we have a display table, and it
5764 contains an entry for IT->c, translate it. Don't do this if
5765 IT->c itself comes from a display table, otherwise we could
5766 end up in an infinite recursion. (An alternative could be to
5767 count the recursion depth of this function and signal an
5768 error when a certain maximum depth is reached.) Is it worth
5770 if (success_p
&& it
->dpvec
== NULL
)
5773 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
5774 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
5775 nbsp_or_shy
= char_is_other
;
5776 int decoded
= it
->c
;
5779 && (dv
= DISP_CHAR_VECTOR (it
->dp
, it
->c
),
5782 struct Lisp_Vector
*v
= XVECTOR (dv
);
5784 /* Return the first character from the display table
5785 entry, if not empty. If empty, don't display the
5786 current character. */
5789 it
->dpvec_char_len
= it
->len
;
5790 it
->dpvec
= v
->contents
;
5791 it
->dpend
= v
->contents
+ v
->size
;
5792 it
->current
.dpvec_index
= 0;
5793 it
->dpvec_face_id
= -1;
5794 it
->saved_face_id
= it
->face_id
;
5795 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5800 set_iterator_to_next (it
, 0);
5805 if (unibyte_display_via_language_environment
5806 && !ASCII_CHAR_P (it
->c
))
5807 decoded
= DECODE_CHAR (unibyte
, it
->c
);
5809 if (it
->c
>= 0x80 && ! NILP (Vnobreak_char_display
))
5811 if (it
->multibyte_p
)
5812 nbsp_or_shy
= (it
->c
== 0xA0 ? char_is_nbsp
5813 : it
->c
== 0xAD ? char_is_soft_hyphen
5815 else if (unibyte_display_via_language_environment
)
5816 nbsp_or_shy
= (decoded
== 0xA0 ? char_is_nbsp
5817 : decoded
== 0xAD ? char_is_soft_hyphen
5821 /* Translate control characters into `\003' or `^C' form.
5822 Control characters coming from a display table entry are
5823 currently not translated because we use IT->dpvec to hold
5824 the translation. This could easily be changed but I
5825 don't believe that it is worth doing.
5827 If it->multibyte_p is nonzero, non-printable non-ASCII
5828 characters are also translated to octal form.
5830 If it->multibyte_p is zero, eight-bit characters that
5831 don't have corresponding multibyte char code are also
5832 translated to octal form. */
5834 ? (it
->area
!= TEXT_AREA
5835 /* In mode line, treat \n, \t like other crl chars. */
5838 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
5839 || (it
->c
!= '\n' && it
->c
!= '\t'))
5842 ? ! CHAR_PRINTABLE_P (it
->c
)
5843 : (! unibyte_display_via_language_environment
5845 : (decoded
>= 0x80 && decoded
< 0xA0))))))
5847 /* IT->c is a control character which must be displayed
5848 either as '\003' or as `^C' where the '\\' and '^'
5849 can be defined in the display table. Fill
5850 IT->ctl_chars with glyphs for what we have to
5851 display. Then, set IT->dpvec to these glyphs. */
5854 int face_id
, lface_id
= 0 ;
5857 /* Handle control characters with ^. */
5859 if (it
->c
< 128 && it
->ctl_arrow_p
)
5863 g
= '^'; /* default glyph for Control */
5864 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5866 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5867 && GLYPH_CODE_CHAR_VALID_P (gc
))
5869 g
= GLYPH_CODE_CHAR (gc
);
5870 lface_id
= GLYPH_CODE_FACE (gc
);
5874 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5876 else if (it
->f
== last_escape_glyph_frame
5877 && it
->face_id
== last_escape_glyph_face_id
)
5879 face_id
= last_escape_glyph_merged_face_id
;
5883 /* Merge the escape-glyph face into the current face. */
5884 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5886 last_escape_glyph_frame
= it
->f
;
5887 last_escape_glyph_face_id
= it
->face_id
;
5888 last_escape_glyph_merged_face_id
= face_id
;
5891 XSETINT (it
->ctl_chars
[0], g
);
5892 XSETINT (it
->ctl_chars
[1], it
->c
^ 0100);
5894 goto display_control
;
5897 /* Handle non-break space in the mode where it only gets
5900 if (EQ (Vnobreak_char_display
, Qt
)
5901 && nbsp_or_shy
== char_is_nbsp
)
5903 /* Merge the no-break-space face into the current face. */
5904 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5908 XSETINT (it
->ctl_chars
[0], ' ');
5910 goto display_control
;
5913 /* Handle sequences that start with the "escape glyph". */
5915 /* the default escape glyph is \. */
5916 escape_glyph
= '\\';
5919 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5920 && GLYPH_CODE_CHAR_VALID_P (gc
))
5922 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5923 lface_id
= GLYPH_CODE_FACE (gc
);
5927 /* The display table specified a face.
5928 Merge it into face_id and also into escape_glyph. */
5929 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5932 else if (it
->f
== last_escape_glyph_frame
5933 && it
->face_id
== last_escape_glyph_face_id
)
5935 face_id
= last_escape_glyph_merged_face_id
;
5939 /* Merge the escape-glyph face into the current face. */
5940 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5942 last_escape_glyph_frame
= it
->f
;
5943 last_escape_glyph_face_id
= it
->face_id
;
5944 last_escape_glyph_merged_face_id
= face_id
;
5947 /* Handle soft hyphens in the mode where they only get
5950 if (EQ (Vnobreak_char_display
, Qt
)
5951 && nbsp_or_shy
== char_is_soft_hyphen
)
5954 XSETINT (it
->ctl_chars
[0], '-');
5956 goto display_control
;
5959 /* Handle non-break space and soft hyphen
5960 with the escape glyph. */
5964 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5965 it
->c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
5966 XSETINT (it
->ctl_chars
[1], it
->c
);
5968 goto display_control
;
5972 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
5976 /* Set IT->ctl_chars[0] to the glyph for `\\'. */
5977 if (CHAR_BYTE8_P (it
->c
))
5979 str
[0] = CHAR_TO_BYTE8 (it
->c
);
5982 else if (it
->c
< 256)
5989 /* It's an invalid character, which shouldn't
5990 happen actually, but due to bugs it may
5991 happen. Let's print the char as is, there's
5992 not much meaningful we can do with it. */
5994 str
[1] = it
->c
>> 8;
5995 str
[2] = it
->c
>> 16;
5996 str
[3] = it
->c
>> 24;
6000 for (i
= 0; i
< len
; i
++)
6003 XSETINT (it
->ctl_chars
[i
* 4], escape_glyph
);
6004 /* Insert three more glyphs into IT->ctl_chars for
6005 the octal display of the character. */
6006 g
= ((str
[i
] >> 6) & 7) + '0';
6007 XSETINT (it
->ctl_chars
[i
* 4 + 1], g
);
6008 g
= ((str
[i
] >> 3) & 7) + '0';
6009 XSETINT (it
->ctl_chars
[i
* 4 + 2], g
);
6010 g
= (str
[i
] & 7) + '0';
6011 XSETINT (it
->ctl_chars
[i
* 4 + 3], g
);
6017 /* Set up IT->dpvec and return first character from it. */
6018 it
->dpvec_char_len
= it
->len
;
6019 it
->dpvec
= it
->ctl_chars
;
6020 it
->dpend
= it
->dpvec
+ ctl_len
;
6021 it
->current
.dpvec_index
= 0;
6022 it
->dpvec_face_id
= face_id
;
6023 it
->saved_face_id
= it
->face_id
;
6024 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6031 #ifdef HAVE_WINDOW_SYSTEM
6032 /* Adjust face id for a multibyte character. There are no multibyte
6033 character in unibyte text. */
6034 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6037 && FRAME_WINDOW_P (it
->f
))
6039 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6041 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6043 /* Automatic composition with glyph-string. */
6044 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6046 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6050 int pos
= (it
->s
? -1
6051 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6052 : IT_CHARPOS (*it
));
6054 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->c
, pos
, it
->string
);
6059 /* Is this character the last one of a run of characters with
6060 box? If yes, set IT->end_of_box_run_p to 1. */
6064 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6066 int face_id
= underlying_face_id (it
);
6067 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6071 if (face
->box
== FACE_NO_BOX
)
6073 /* If the box comes from face properties in a
6074 display string, check faces in that string. */
6075 int string_face_id
= face_after_it_pos (it
);
6076 it
->end_of_box_run_p
6077 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6080 /* Otherwise, the box comes from the underlying face.
6081 If this is the last string character displayed, check
6082 the next buffer location. */
6083 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6084 && (it
->current
.overlay_string_index
6085 == it
->n_overlay_strings
- 1))
6089 struct text_pos pos
= it
->current
.pos
;
6090 INC_TEXT_POS (pos
, it
->multibyte_p
);
6092 next_face_id
= face_at_buffer_position
6093 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6094 it
->region_end_charpos
, &ignore
,
6095 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6097 it
->end_of_box_run_p
6098 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6105 int face_id
= face_after_it_pos (it
);
6106 it
->end_of_box_run_p
6107 = (face_id
!= it
->face_id
6108 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6112 /* Value is 0 if end of buffer or string reached. */
6117 /* Move IT to the next display element.
6119 RESEAT_P non-zero means if called on a newline in buffer text,
6120 skip to the next visible line start.
6122 Functions get_next_display_element and set_iterator_to_next are
6123 separate because I find this arrangement easier to handle than a
6124 get_next_display_element function that also increments IT's
6125 position. The way it is we can first look at an iterator's current
6126 display element, decide whether it fits on a line, and if it does,
6127 increment the iterator position. The other way around we probably
6128 would either need a flag indicating whether the iterator has to be
6129 incremented the next time, or we would have to implement a
6130 decrement position function which would not be easy to write. */
6133 set_iterator_to_next (it
, reseat_p
)
6137 /* Reset flags indicating start and end of a sequence of characters
6138 with box. Reset them at the start of this function because
6139 moving the iterator to a new position might set them. */
6140 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6144 case GET_FROM_BUFFER
:
6145 /* The current display element of IT is a character from
6146 current_buffer. Advance in the buffer, and maybe skip over
6147 invisible lines that are so because of selective display. */
6148 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6149 reseat_at_next_visible_line_start (it
, 0);
6150 else if (it
->cmp_it
.id
>= 0)
6152 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6153 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6154 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6155 it
->cmp_it
.from
= it
->cmp_it
.to
;
6159 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6160 IT_BYTEPOS (*it
), it
->stop_charpos
,
6166 xassert (it
->len
!= 0);
6170 IT_BYTEPOS (*it
) += it
->len
;
6171 IT_CHARPOS (*it
) += 1;
6175 /* If this is a new paragraph, determine its base
6176 direction (a.k.a. its base embedding level). */
6177 if (it
->bidi_it
.new_paragraph
)
6178 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6179 bidi_get_next_char_visually (&it
->bidi_it
);
6180 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6181 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6183 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6187 case GET_FROM_C_STRING
:
6188 /* Current display element of IT is from a C string. */
6189 IT_BYTEPOS (*it
) += it
->len
;
6190 IT_CHARPOS (*it
) += 1;
6193 case GET_FROM_DISPLAY_VECTOR
:
6194 /* Current display element of IT is from a display table entry.
6195 Advance in the display table definition. Reset it to null if
6196 end reached, and continue with characters from buffers/
6198 ++it
->current
.dpvec_index
;
6200 /* Restore face of the iterator to what they were before the
6201 display vector entry (these entries may contain faces). */
6202 it
->face_id
= it
->saved_face_id
;
6204 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6206 int recheck_faces
= it
->ellipsis_p
;
6209 it
->method
= GET_FROM_C_STRING
;
6210 else if (STRINGP (it
->string
))
6211 it
->method
= GET_FROM_STRING
;
6214 it
->method
= GET_FROM_BUFFER
;
6215 it
->object
= it
->w
->buffer
;
6219 it
->current
.dpvec_index
= -1;
6221 /* Skip over characters which were displayed via IT->dpvec. */
6222 if (it
->dpvec_char_len
< 0)
6223 reseat_at_next_visible_line_start (it
, 1);
6224 else if (it
->dpvec_char_len
> 0)
6226 if (it
->method
== GET_FROM_STRING
6227 && it
->n_overlay_strings
> 0)
6228 it
->ignore_overlay_strings_at_pos_p
= 1;
6229 it
->len
= it
->dpvec_char_len
;
6230 set_iterator_to_next (it
, reseat_p
);
6233 /* Maybe recheck faces after display vector */
6235 it
->stop_charpos
= IT_CHARPOS (*it
);
6239 case GET_FROM_STRING
:
6240 /* Current display element is a character from a Lisp string. */
6241 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6242 if (it
->cmp_it
.id
>= 0)
6244 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6245 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6246 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6247 it
->cmp_it
.from
= it
->cmp_it
.to
;
6251 composition_compute_stop_pos (&it
->cmp_it
,
6252 IT_STRING_CHARPOS (*it
),
6253 IT_STRING_BYTEPOS (*it
),
6254 it
->stop_charpos
, it
->string
);
6259 IT_STRING_BYTEPOS (*it
) += it
->len
;
6260 IT_STRING_CHARPOS (*it
) += 1;
6263 consider_string_end
:
6265 if (it
->current
.overlay_string_index
>= 0)
6267 /* IT->string is an overlay string. Advance to the
6268 next, if there is one. */
6269 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6272 next_overlay_string (it
);
6274 setup_for_ellipsis (it
, 0);
6279 /* IT->string is not an overlay string. If we reached
6280 its end, and there is something on IT->stack, proceed
6281 with what is on the stack. This can be either another
6282 string, this time an overlay string, or a buffer. */
6283 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6287 if (it
->method
== GET_FROM_STRING
)
6288 goto consider_string_end
;
6293 case GET_FROM_IMAGE
:
6294 case GET_FROM_STRETCH
:
6295 /* The position etc with which we have to proceed are on
6296 the stack. The position may be at the end of a string,
6297 if the `display' property takes up the whole string. */
6298 xassert (it
->sp
> 0);
6300 if (it
->method
== GET_FROM_STRING
)
6301 goto consider_string_end
;
6305 /* There are no other methods defined, so this should be a bug. */
6309 xassert (it
->method
!= GET_FROM_STRING
6310 || (STRINGP (it
->string
)
6311 && IT_STRING_CHARPOS (*it
) >= 0));
6314 /* Load IT's display element fields with information about the next
6315 display element which comes from a display table entry or from the
6316 result of translating a control character to one of the forms `^C'
6319 IT->dpvec holds the glyphs to return as characters.
6320 IT->saved_face_id holds the face id before the display vector--it
6321 is restored into IT->face_id in set_iterator_to_next. */
6324 next_element_from_display_vector (it
)
6330 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6332 it
->face_id
= it
->saved_face_id
;
6334 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6335 That seemed totally bogus - so I changed it... */
6336 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6338 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6340 it
->c
= GLYPH_CODE_CHAR (gc
);
6341 it
->len
= CHAR_BYTES (it
->c
);
6343 /* The entry may contain a face id to use. Such a face id is
6344 the id of a Lisp face, not a realized face. A face id of
6345 zero means no face is specified. */
6346 if (it
->dpvec_face_id
>= 0)
6347 it
->face_id
= it
->dpvec_face_id
;
6350 int lface_id
= GLYPH_CODE_FACE (gc
);
6352 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6357 /* Display table entry is invalid. Return a space. */
6358 it
->c
= ' ', it
->len
= 1;
6360 /* Don't change position and object of the iterator here. They are
6361 still the values of the character that had this display table
6362 entry or was translated, and that's what we want. */
6363 it
->what
= IT_CHARACTER
;
6368 /* Load IT with the next display element from Lisp string IT->string.
6369 IT->current.string_pos is the current position within the string.
6370 If IT->current.overlay_string_index >= 0, the Lisp string is an
6374 next_element_from_string (it
)
6377 struct text_pos position
;
6379 xassert (STRINGP (it
->string
));
6380 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6381 position
= it
->current
.string_pos
;
6383 /* Time to check for invisible text? */
6384 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6385 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6389 /* Since a handler may have changed IT->method, we must
6391 return GET_NEXT_DISPLAY_ELEMENT (it
);
6394 if (it
->current
.overlay_string_index
>= 0)
6396 /* Get the next character from an overlay string. In overlay
6397 strings, There is no field width or padding with spaces to
6399 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6404 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6405 IT_STRING_BYTEPOS (*it
), SCHARS (it
->string
))
6406 && next_element_from_composition (it
))
6410 else if (STRING_MULTIBYTE (it
->string
))
6412 int remaining
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6413 const unsigned char *s
= (SDATA (it
->string
)
6414 + IT_STRING_BYTEPOS (*it
));
6415 it
->c
= string_char_and_length (s
, &it
->len
);
6419 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6425 /* Get the next character from a Lisp string that is not an
6426 overlay string. Such strings come from the mode line, for
6427 example. We may have to pad with spaces, or truncate the
6428 string. See also next_element_from_c_string. */
6429 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6434 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6436 /* Pad with spaces. */
6437 it
->c
= ' ', it
->len
= 1;
6438 CHARPOS (position
) = BYTEPOS (position
) = -1;
6440 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6441 IT_STRING_BYTEPOS (*it
), it
->string_nchars
)
6442 && next_element_from_composition (it
))
6446 else if (STRING_MULTIBYTE (it
->string
))
6448 int maxlen
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6449 const unsigned char *s
= (SDATA (it
->string
)
6450 + IT_STRING_BYTEPOS (*it
));
6451 it
->c
= string_char_and_length (s
, &it
->len
);
6455 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6460 /* Record what we have and where it came from. */
6461 it
->what
= IT_CHARACTER
;
6462 it
->object
= it
->string
;
6463 it
->position
= position
;
6468 /* Load IT with next display element from C string IT->s.
6469 IT->string_nchars is the maximum number of characters to return
6470 from the string. IT->end_charpos may be greater than
6471 IT->string_nchars when this function is called, in which case we
6472 may have to return padding spaces. Value is zero if end of string
6473 reached, including padding spaces. */
6476 next_element_from_c_string (it
)
6482 it
->what
= IT_CHARACTER
;
6483 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6486 /* IT's position can be greater IT->string_nchars in case a field
6487 width or precision has been specified when the iterator was
6489 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6491 /* End of the game. */
6495 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6497 /* Pad with spaces. */
6498 it
->c
= ' ', it
->len
= 1;
6499 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6501 else if (it
->multibyte_p
)
6503 /* Implementation note: The calls to strlen apparently aren't a
6504 performance problem because there is no noticeable performance
6505 difference between Emacs running in unibyte or multibyte mode. */
6506 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
6507 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
6510 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6516 /* Set up IT to return characters from an ellipsis, if appropriate.
6517 The definition of the ellipsis glyphs may come from a display table
6518 entry. This function fills IT with the first glyph from the
6519 ellipsis if an ellipsis is to be displayed. */
6522 next_element_from_ellipsis (it
)
6525 if (it
->selective_display_ellipsis_p
)
6526 setup_for_ellipsis (it
, it
->len
);
6529 /* The face at the current position may be different from the
6530 face we find after the invisible text. Remember what it
6531 was in IT->saved_face_id, and signal that it's there by
6532 setting face_before_selective_p. */
6533 it
->saved_face_id
= it
->face_id
;
6534 it
->method
= GET_FROM_BUFFER
;
6535 it
->object
= it
->w
->buffer
;
6536 reseat_at_next_visible_line_start (it
, 1);
6537 it
->face_before_selective_p
= 1;
6540 return GET_NEXT_DISPLAY_ELEMENT (it
);
6544 /* Deliver an image display element. The iterator IT is already
6545 filled with image information (done in handle_display_prop). Value
6550 next_element_from_image (it
)
6553 it
->what
= IT_IMAGE
;
6558 /* Fill iterator IT with next display element from a stretch glyph
6559 property. IT->object is the value of the text property. Value is
6563 next_element_from_stretch (it
)
6566 it
->what
= IT_STRETCH
;
6570 /* Scan forward from CHARPOS in the current buffer, until we find a
6571 stop position > current IT's position. Then handle the stop
6572 position before that. This is called when we bump into a stop
6573 position while reordering bidirectional text. */
6576 handle_stop_backwards (it
, charpos
)
6580 EMACS_INT where_we_are
= IT_CHARPOS (*it
);
6581 struct display_pos save_current
= it
->current
;
6582 struct text_pos save_position
= it
->position
;
6583 struct text_pos pos1
;
6584 EMACS_INT next_stop
;
6586 /* Scan in strict logical order. */
6590 it
->prev_stop
= charpos
;
6591 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
6592 reseat_1 (it
, pos1
, 0);
6593 compute_stop_pos (it
);
6594 /* We must advance forward, right? */
6595 if (it
->stop_charpos
<= it
->prev_stop
)
6597 charpos
= it
->stop_charpos
;
6599 while (charpos
<= where_we_are
);
6601 next_stop
= it
->stop_charpos
;
6602 it
->stop_charpos
= it
->prev_stop
;
6604 it
->current
= save_current
;
6605 it
->position
= save_position
;
6607 it
->stop_charpos
= next_stop
;
6610 /* Load IT with the next display element from current_buffer. Value
6611 is zero if end of buffer reached. IT->stop_charpos is the next
6612 position at which to stop and check for text properties or buffer
6616 next_element_from_buffer (it
)
6621 xassert (IT_CHARPOS (*it
) >= BEGV
);
6623 /* With bidi reordering, the character to display might not be the
6624 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
6625 we were reseat()ed to a new buffer position, which is potentially
6626 a different paragraph. */
6627 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6629 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6630 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6631 /* If we are at the beginning of a line, we can produce the next
6632 element right away. */
6633 if (it
->bidi_it
.bytepos
== BEGV_BYTE
6634 /* FIXME: Should support all Unicode line separators. */
6635 || FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6636 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')
6638 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6639 bidi_get_next_char_visually (&it
->bidi_it
);
6643 int orig_bytepos
= IT_BYTEPOS (*it
);
6645 /* We need to prime the bidi iterator starting at the line's
6646 beginning, before we will be able to produce the next
6648 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
), -1);
6649 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
6650 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6651 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6652 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6655 /* Now return to buffer position where we were asked to
6656 get the next display element, and produce that. */
6657 bidi_get_next_char_visually (&it
->bidi_it
);
6659 while (it
->bidi_it
.bytepos
!= orig_bytepos
6660 && it
->bidi_it
.bytepos
< ZV_BYTE
);
6663 it
->bidi_it
.first_elt
= 0; /* paranoia: bidi.c does this */
6664 /* Adjust IT's position information to where we ended up. */
6665 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6666 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6667 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6670 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6672 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6674 int overlay_strings_follow_p
;
6676 /* End of the game, except when overlay strings follow that
6677 haven't been returned yet. */
6678 if (it
->overlay_strings_at_end_processed_p
)
6679 overlay_strings_follow_p
= 0;
6682 it
->overlay_strings_at_end_processed_p
= 1;
6683 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6686 if (overlay_strings_follow_p
)
6687 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6691 it
->position
= it
->current
.pos
;
6695 else if (!(!it
->bidi_p
6696 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6697 || IT_CHARPOS (*it
) == it
->stop_charpos
))
6699 /* With bidi non-linear iteration, we could find ourselves
6700 far beyond the last computed stop_charpos, with several
6701 other stop positions in between that we missed. Scan
6702 them all now, in buffer's logical order, until we find
6703 and handle the last stop_charpos that precedes our
6704 current position. */
6705 handle_stop_backwards (it
, it
->stop_charpos
);
6706 return GET_NEXT_DISPLAY_ELEMENT (it
);
6712 /* Take note of the stop position we just moved across,
6713 for when we will move back across it. */
6714 it
->prev_stop
= it
->stop_charpos
;
6715 /* If we are at base paragraph embedding level, take
6716 note of the last stop position seen at this
6718 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6719 it
->base_level_stop
= it
->stop_charpos
;
6722 return GET_NEXT_DISPLAY_ELEMENT (it
);
6726 /* We can sometimes back up for reasons that have nothing
6727 to do with bidi reordering. E.g., compositions. The
6728 code below is only needed when we are above the base
6729 embedding level, so test for that explicitly. */
6730 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6731 && IT_CHARPOS (*it
) < it
->prev_stop
)
6733 if (it
->base_level_stop
<= 0)
6734 it
->base_level_stop
= BEGV
;
6735 if (IT_CHARPOS (*it
) < it
->base_level_stop
)
6737 handle_stop_backwards (it
, it
->base_level_stop
);
6738 return GET_NEXT_DISPLAY_ELEMENT (it
);
6742 /* No face changes, overlays etc. in sight, so just return a
6743 character from current_buffer. */
6746 /* Maybe run the redisplay end trigger hook. Performance note:
6747 This doesn't seem to cost measurable time. */
6748 if (it
->redisplay_end_trigger_charpos
6750 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6751 run_redisplay_end_trigger_hook (it
);
6753 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6755 && next_element_from_composition (it
))
6760 /* Get the next character, maybe multibyte. */
6761 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6762 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6763 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
6765 it
->c
= *p
, it
->len
= 1;
6767 /* Record what we have and where it came from. */
6768 it
->what
= IT_CHARACTER
;
6769 it
->object
= it
->w
->buffer
;
6770 it
->position
= it
->current
.pos
;
6772 /* Normally we return the character found above, except when we
6773 really want to return an ellipsis for selective display. */
6778 /* A value of selective > 0 means hide lines indented more
6779 than that number of columns. */
6780 if (it
->selective
> 0
6781 && IT_CHARPOS (*it
) + 1 < ZV
6782 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6783 IT_BYTEPOS (*it
) + 1,
6784 (double) it
->selective
)) /* iftc */
6786 success_p
= next_element_from_ellipsis (it
);
6787 it
->dpvec_char_len
= -1;
6790 else if (it
->c
== '\r' && it
->selective
== -1)
6792 /* A value of selective == -1 means that everything from the
6793 CR to the end of the line is invisible, with maybe an
6794 ellipsis displayed for it. */
6795 success_p
= next_element_from_ellipsis (it
);
6796 it
->dpvec_char_len
= -1;
6801 /* Value is zero if end of buffer reached. */
6802 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6807 /* Run the redisplay end trigger hook for IT. */
6810 run_redisplay_end_trigger_hook (it
)
6813 Lisp_Object args
[3];
6815 /* IT->glyph_row should be non-null, i.e. we should be actually
6816 displaying something, or otherwise we should not run the hook. */
6817 xassert (it
->glyph_row
);
6819 /* Set up hook arguments. */
6820 args
[0] = Qredisplay_end_trigger_functions
;
6821 args
[1] = it
->window
;
6822 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6823 it
->redisplay_end_trigger_charpos
= 0;
6825 /* Since we are *trying* to run these functions, don't try to run
6826 them again, even if they get an error. */
6827 it
->w
->redisplay_end_trigger
= Qnil
;
6828 Frun_hook_with_args (3, args
);
6830 /* Notice if it changed the face of the character we are on. */
6831 handle_face_prop (it
);
6835 /* Deliver a composition display element. Unlike the other
6836 next_element_from_XXX, this function is not registered in the array
6837 get_next_element[]. It is called from next_element_from_buffer and
6838 next_element_from_string when necessary. */
6841 next_element_from_composition (it
)
6844 it
->what
= IT_COMPOSITION
;
6845 it
->len
= it
->cmp_it
.nbytes
;
6846 if (STRINGP (it
->string
))
6850 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6851 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6854 it
->position
= it
->current
.string_pos
;
6855 it
->object
= it
->string
;
6856 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6857 IT_STRING_BYTEPOS (*it
), it
->string
);
6863 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6864 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6867 it
->position
= it
->current
.pos
;
6868 it
->object
= it
->w
->buffer
;
6869 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6870 IT_BYTEPOS (*it
), Qnil
);
6877 /***********************************************************************
6878 Moving an iterator without producing glyphs
6879 ***********************************************************************/
6881 /* Check if iterator is at a position corresponding to a valid buffer
6882 position after some move_it_ call. */
6884 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6885 ((it)->method == GET_FROM_STRING \
6886 ? IT_STRING_CHARPOS (*it) == 0 \
6890 /* Move iterator IT to a specified buffer or X position within one
6891 line on the display without producing glyphs.
6893 OP should be a bit mask including some or all of these bits:
6894 MOVE_TO_X: Stop upon reaching x-position TO_X.
6895 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
6896 Regardless of OP's value, stop upon reaching the end of the display line.
6898 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6899 This means, in particular, that TO_X includes window's horizontal
6902 The return value has several possible values that
6903 say what condition caused the scan to stop:
6905 MOVE_POS_MATCH_OR_ZV
6906 - when TO_POS or ZV was reached.
6909 -when TO_X was reached before TO_POS or ZV were reached.
6912 - when we reached the end of the display area and the line must
6916 - when we reached the end of the display area and the line is
6920 - when we stopped at a line end, i.e. a newline or a CR and selective
6923 static enum move_it_result
6924 move_it_in_display_line_to (struct it
*it
,
6925 EMACS_INT to_charpos
, int to_x
,
6926 enum move_operation_enum op
)
6928 enum move_it_result result
= MOVE_UNDEFINED
;
6929 struct glyph_row
*saved_glyph_row
;
6930 struct it wrap_it
, atpos_it
, atx_it
;
6932 enum it_method prev_method
= it
->method
;
6933 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
6935 /* Don't produce glyphs in produce_glyphs. */
6936 saved_glyph_row
= it
->glyph_row
;
6937 it
->glyph_row
= NULL
;
6939 /* Use wrap_it to save a copy of IT wherever a word wrap could
6940 occur. Use atpos_it to save a copy of IT at the desired buffer
6941 position, if found, so that we can scan ahead and check if the
6942 word later overshoots the window edge. Use atx_it similarly, for
6948 #define BUFFER_POS_REACHED_P() \
6949 ((op & MOVE_TO_POS) != 0 \
6950 && BUFFERP (it->object) \
6951 && (IT_CHARPOS (*it) == to_charpos \
6952 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
6953 && (it->method == GET_FROM_BUFFER \
6954 || (it->method == GET_FROM_DISPLAY_VECTOR \
6955 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6957 /* If there's a line-/wrap-prefix, handle it. */
6958 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
6959 && it
->current_y
< it
->last_visible_y
)
6960 handle_line_prefix (it
);
6964 int x
, i
, ascent
= 0, descent
= 0;
6966 /* Utility macro to reset an iterator with x, ascent, and descent. */
6967 #define IT_RESET_X_ASCENT_DESCENT(IT) \
6968 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
6969 (IT)->max_descent = descent)
6971 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
6973 if ((op
& MOVE_TO_POS
) != 0
6974 && BUFFERP (it
->object
)
6975 && it
->method
== GET_FROM_BUFFER
6976 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
6978 && (prev_method
== GET_FROM_IMAGE
6979 || prev_method
== GET_FROM_STRETCH
)
6980 /* Passed TO_CHARPOS from left to right. */
6981 && ((prev_pos
< to_charpos
6982 && IT_CHARPOS (*it
) > to_charpos
)
6983 /* Passed TO_CHARPOS from right to left. */
6984 || (prev_pos
> to_charpos
6985 && IT_CHARPOS (*it
) < to_charpos
)))))
6987 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6989 result
= MOVE_POS_MATCH_OR_ZV
;
6992 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
6993 /* If wrap_it is valid, the current position might be in a
6994 word that is wrapped. So, save the iterator in
6995 atpos_it and continue to see if wrapping happens. */
6999 prev_method
= it
->method
;
7000 if (it
->method
== GET_FROM_BUFFER
)
7001 prev_pos
= IT_CHARPOS (*it
);
7002 /* Stop when ZV reached.
7003 We used to stop here when TO_CHARPOS reached as well, but that is
7004 too soon if this glyph does not fit on this line. So we handle it
7005 explicitly below. */
7006 if (!get_next_display_element (it
))
7008 result
= MOVE_POS_MATCH_OR_ZV
;
7012 if (it
->line_wrap
== TRUNCATE
)
7014 if (BUFFER_POS_REACHED_P ())
7016 result
= MOVE_POS_MATCH_OR_ZV
;
7022 if (it
->line_wrap
== WORD_WRAP
)
7024 if (IT_DISPLAYING_WHITESPACE (it
))
7028 /* We have reached a glyph that follows one or more
7029 whitespace characters. If the position is
7030 already found, we are done. */
7031 if (atpos_it
.sp
>= 0)
7034 result
= MOVE_POS_MATCH_OR_ZV
;
7040 result
= MOVE_X_REACHED
;
7043 /* Otherwise, we can wrap here. */
7050 /* Remember the line height for the current line, in case
7051 the next element doesn't fit on the line. */
7052 ascent
= it
->max_ascent
;
7053 descent
= it
->max_descent
;
7055 /* The call to produce_glyphs will get the metrics of the
7056 display element IT is loaded with. Record the x-position
7057 before this display element, in case it doesn't fit on the
7061 PRODUCE_GLYPHS (it
);
7063 if (it
->area
!= TEXT_AREA
)
7065 set_iterator_to_next (it
, 1);
7069 /* The number of glyphs we get back in IT->nglyphs will normally
7070 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7071 character on a terminal frame, or (iii) a line end. For the
7072 second case, IT->nglyphs - 1 padding glyphs will be present.
7073 (On X frames, there is only one glyph produced for a
7074 composite character.)
7076 The behavior implemented below means, for continuation lines,
7077 that as many spaces of a TAB as fit on the current line are
7078 displayed there. For terminal frames, as many glyphs of a
7079 multi-glyph character are displayed in the current line, too.
7080 This is what the old redisplay code did, and we keep it that
7081 way. Under X, the whole shape of a complex character must
7082 fit on the line or it will be completely displayed in the
7085 Note that both for tabs and padding glyphs, all glyphs have
7089 /* More than one glyph or glyph doesn't fit on line. All
7090 glyphs have the same width. */
7091 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7093 int x_before_this_char
= x
;
7094 int hpos_before_this_char
= it
->hpos
;
7096 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7098 new_x
= x
+ single_glyph_width
;
7100 /* We want to leave anything reaching TO_X to the caller. */
7101 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7103 if (BUFFER_POS_REACHED_P ())
7105 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7106 goto buffer_pos_reached
;
7107 if (atpos_it
.sp
< 0)
7110 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7115 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7118 result
= MOVE_X_REACHED
;
7124 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7129 if (/* Lines are continued. */
7130 it
->line_wrap
!= TRUNCATE
7131 && (/* And glyph doesn't fit on the line. */
7132 new_x
> it
->last_visible_x
7133 /* Or it fits exactly and we're on a window
7135 || (new_x
== it
->last_visible_x
7136 && FRAME_WINDOW_P (it
->f
))))
7138 if (/* IT->hpos == 0 means the very first glyph
7139 doesn't fit on the line, e.g. a wide image. */
7141 || (new_x
== it
->last_visible_x
7142 && FRAME_WINDOW_P (it
->f
)))
7145 it
->current_x
= new_x
;
7147 /* The character's last glyph just barely fits
7149 if (i
== it
->nglyphs
- 1)
7151 /* If this is the destination position,
7152 return a position *before* it in this row,
7153 now that we know it fits in this row. */
7154 if (BUFFER_POS_REACHED_P ())
7156 if (it
->line_wrap
!= WORD_WRAP
7159 it
->hpos
= hpos_before_this_char
;
7160 it
->current_x
= x_before_this_char
;
7161 result
= MOVE_POS_MATCH_OR_ZV
;
7164 if (it
->line_wrap
== WORD_WRAP
7168 atpos_it
.current_x
= x_before_this_char
;
7169 atpos_it
.hpos
= hpos_before_this_char
;
7173 set_iterator_to_next (it
, 1);
7174 /* On graphical terminals, newlines may
7175 "overflow" into the fringe if
7176 overflow-newline-into-fringe is non-nil.
7177 On text-only terminals, newlines may
7178 overflow into the last glyph on the
7180 if (!FRAME_WINDOW_P (it
->f
)
7181 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7183 if (!get_next_display_element (it
))
7185 result
= MOVE_POS_MATCH_OR_ZV
;
7188 if (BUFFER_POS_REACHED_P ())
7190 if (ITERATOR_AT_END_OF_LINE_P (it
))
7191 result
= MOVE_POS_MATCH_OR_ZV
;
7193 result
= MOVE_LINE_CONTINUED
;
7196 if (ITERATOR_AT_END_OF_LINE_P (it
))
7198 result
= MOVE_NEWLINE_OR_CR
;
7205 IT_RESET_X_ASCENT_DESCENT (it
);
7207 if (wrap_it
.sp
>= 0)
7214 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7216 result
= MOVE_LINE_CONTINUED
;
7220 if (BUFFER_POS_REACHED_P ())
7222 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7223 goto buffer_pos_reached
;
7224 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7227 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7231 if (new_x
> it
->first_visible_x
)
7233 /* Glyph is visible. Increment number of glyphs that
7234 would be displayed. */
7239 if (result
!= MOVE_UNDEFINED
)
7242 else if (BUFFER_POS_REACHED_P ())
7245 IT_RESET_X_ASCENT_DESCENT (it
);
7246 result
= MOVE_POS_MATCH_OR_ZV
;
7249 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7251 /* Stop when TO_X specified and reached. This check is
7252 necessary here because of lines consisting of a line end,
7253 only. The line end will not produce any glyphs and we
7254 would never get MOVE_X_REACHED. */
7255 xassert (it
->nglyphs
== 0);
7256 result
= MOVE_X_REACHED
;
7260 /* Is this a line end? If yes, we're done. */
7261 if (ITERATOR_AT_END_OF_LINE_P (it
))
7263 result
= MOVE_NEWLINE_OR_CR
;
7267 if (it
->method
== GET_FROM_BUFFER
)
7268 prev_pos
= IT_CHARPOS (*it
);
7269 /* The current display element has been consumed. Advance
7271 set_iterator_to_next (it
, 1);
7273 /* Stop if lines are truncated and IT's current x-position is
7274 past the right edge of the window now. */
7275 if (it
->line_wrap
== TRUNCATE
7276 && it
->current_x
>= it
->last_visible_x
)
7278 if (!FRAME_WINDOW_P (it
->f
)
7279 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7281 if (!get_next_display_element (it
)
7282 || BUFFER_POS_REACHED_P ())
7284 result
= MOVE_POS_MATCH_OR_ZV
;
7287 if (ITERATOR_AT_END_OF_LINE_P (it
))
7289 result
= MOVE_NEWLINE_OR_CR
;
7293 result
= MOVE_LINE_TRUNCATED
;
7296 #undef IT_RESET_X_ASCENT_DESCENT
7299 #undef BUFFER_POS_REACHED_P
7301 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7302 restore the saved iterator. */
7303 if (atpos_it
.sp
>= 0)
7305 else if (atx_it
.sp
>= 0)
7310 /* Restore the iterator settings altered at the beginning of this
7312 it
->glyph_row
= saved_glyph_row
;
7316 /* For external use. */
7318 move_it_in_display_line (struct it
*it
,
7319 EMACS_INT to_charpos
, int to_x
,
7320 enum move_operation_enum op
)
7322 if (it
->line_wrap
== WORD_WRAP
7323 && (op
& MOVE_TO_X
))
7325 struct it save_it
= *it
;
7326 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7327 /* When word-wrap is on, TO_X may lie past the end
7328 of a wrapped line. Then it->current is the
7329 character on the next line, so backtrack to the
7330 space before the wrap point. */
7331 if (skip
== MOVE_LINE_CONTINUED
)
7333 int prev_x
= max (it
->current_x
- 1, 0);
7335 move_it_in_display_line_to
7336 (it
, -1, prev_x
, MOVE_TO_X
);
7340 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7344 /* Move IT forward until it satisfies one or more of the criteria in
7345 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7347 OP is a bit-mask that specifies where to stop, and in particular,
7348 which of those four position arguments makes a difference. See the
7349 description of enum move_operation_enum.
7351 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7352 screen line, this function will set IT to the next position >
7356 move_it_to (it
, to_charpos
, to_x
, to_y
, to_vpos
, op
)
7358 int to_charpos
, to_x
, to_y
, to_vpos
;
7361 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7362 int line_height
, line_start_x
= 0, reached
= 0;
7366 if (op
& MOVE_TO_VPOS
)
7368 /* If no TO_CHARPOS and no TO_X specified, stop at the
7369 start of the line TO_VPOS. */
7370 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7372 if (it
->vpos
== to_vpos
)
7378 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7382 /* TO_VPOS >= 0 means stop at TO_X in the line at
7383 TO_VPOS, or at TO_POS, whichever comes first. */
7384 if (it
->vpos
== to_vpos
)
7390 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7392 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7397 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7399 /* We have reached TO_X but not in the line we want. */
7400 skip
= move_it_in_display_line_to (it
, to_charpos
,
7402 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7410 else if (op
& MOVE_TO_Y
)
7412 struct it it_backup
;
7414 if (it
->line_wrap
== WORD_WRAP
)
7417 /* TO_Y specified means stop at TO_X in the line containing
7418 TO_Y---or at TO_CHARPOS if this is reached first. The
7419 problem is that we can't really tell whether the line
7420 contains TO_Y before we have completely scanned it, and
7421 this may skip past TO_X. What we do is to first scan to
7424 If TO_X is not specified, use a TO_X of zero. The reason
7425 is to make the outcome of this function more predictable.
7426 If we didn't use TO_X == 0, we would stop at the end of
7427 the line which is probably not what a caller would expect
7429 skip
= move_it_in_display_line_to
7430 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7431 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7433 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7434 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7436 else if (skip
== MOVE_X_REACHED
)
7438 /* If TO_X was reached, we want to know whether TO_Y is
7439 in the line. We know this is the case if the already
7440 scanned glyphs make the line tall enough. Otherwise,
7441 we must check by scanning the rest of the line. */
7442 line_height
= it
->max_ascent
+ it
->max_descent
;
7443 if (to_y
>= it
->current_y
7444 && to_y
< it
->current_y
+ line_height
)
7450 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7451 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7453 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7454 line_height
= it
->max_ascent
+ it
->max_descent
;
7455 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7457 if (to_y
>= it
->current_y
7458 && to_y
< it
->current_y
+ line_height
)
7460 /* If TO_Y is in this line and TO_X was reached
7461 above, we scanned too far. We have to restore
7462 IT's settings to the ones before skipping. */
7469 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7475 /* Check whether TO_Y is in this line. */
7476 line_height
= it
->max_ascent
+ it
->max_descent
;
7477 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7479 if (to_y
>= it
->current_y
7480 && to_y
< it
->current_y
+ line_height
)
7482 /* When word-wrap is on, TO_X may lie past the end
7483 of a wrapped line. Then it->current is the
7484 character on the next line, so backtrack to the
7485 space before the wrap point. */
7486 if (skip
== MOVE_LINE_CONTINUED
7487 && it
->line_wrap
== WORD_WRAP
)
7489 int prev_x
= max (it
->current_x
- 1, 0);
7491 skip
= move_it_in_display_line_to
7492 (it
, -1, prev_x
, MOVE_TO_X
);
7501 else if (BUFFERP (it
->object
)
7502 && (it
->method
== GET_FROM_BUFFER
7503 || it
->method
== GET_FROM_STRETCH
)
7504 && IT_CHARPOS (*it
) >= to_charpos
)
7505 skip
= MOVE_POS_MATCH_OR_ZV
;
7507 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7511 case MOVE_POS_MATCH_OR_ZV
:
7515 case MOVE_NEWLINE_OR_CR
:
7516 set_iterator_to_next (it
, 1);
7517 it
->continuation_lines_width
= 0;
7520 case MOVE_LINE_TRUNCATED
:
7521 it
->continuation_lines_width
= 0;
7522 reseat_at_next_visible_line_start (it
, 0);
7523 if ((op
& MOVE_TO_POS
) != 0
7524 && IT_CHARPOS (*it
) > to_charpos
)
7531 case MOVE_LINE_CONTINUED
:
7532 /* For continued lines ending in a tab, some of the glyphs
7533 associated with the tab are displayed on the current
7534 line. Since it->current_x does not include these glyphs,
7535 we use it->last_visible_x instead. */
7538 it
->continuation_lines_width
+= it
->last_visible_x
;
7539 /* When moving by vpos, ensure that the iterator really
7540 advances to the next line (bug#847, bug#969). Fixme:
7541 do we need to do this in other circumstances? */
7542 if (it
->current_x
!= it
->last_visible_x
7543 && (op
& MOVE_TO_VPOS
)
7544 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7546 line_start_x
= it
->current_x
+ it
->pixel_width
7547 - it
->last_visible_x
;
7548 set_iterator_to_next (it
, 0);
7552 it
->continuation_lines_width
+= it
->current_x
;
7559 /* Reset/increment for the next run. */
7560 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7561 it
->current_x
= line_start_x
;
7564 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7566 last_height
= it
->max_ascent
+ it
->max_descent
;
7567 last_max_ascent
= it
->max_ascent
;
7568 it
->max_ascent
= it
->max_descent
= 0;
7573 /* On text terminals, we may stop at the end of a line in the middle
7574 of a multi-character glyph. If the glyph itself is continued,
7575 i.e. it is actually displayed on the next line, don't treat this
7576 stopping point as valid; move to the next line instead (unless
7577 that brings us offscreen). */
7578 if (!FRAME_WINDOW_P (it
->f
)
7580 && IT_CHARPOS (*it
) == to_charpos
7581 && it
->what
== IT_CHARACTER
7583 && it
->line_wrap
== WINDOW_WRAP
7584 && it
->current_x
== it
->last_visible_x
- 1
7587 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7589 it
->continuation_lines_width
+= it
->current_x
;
7590 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7591 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7593 last_height
= it
->max_ascent
+ it
->max_descent
;
7594 last_max_ascent
= it
->max_ascent
;
7597 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7601 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7603 If DY > 0, move IT backward at least that many pixels. DY = 0
7604 means move IT backward to the preceding line start or BEGV. This
7605 function may move over more than DY pixels if IT->current_y - DY
7606 ends up in the middle of a line; in this case IT->current_y will be
7607 set to the top of the line moved to. */
7610 move_it_vertically_backward (it
, dy
)
7621 start_pos
= IT_CHARPOS (*it
);
7623 /* Estimate how many newlines we must move back. */
7624 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7626 /* Set the iterator's position that many lines back. */
7627 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7628 back_to_previous_visible_line_start (it
);
7630 /* Reseat the iterator here. When moving backward, we don't want
7631 reseat to skip forward over invisible text, set up the iterator
7632 to deliver from overlay strings at the new position etc. So,
7633 use reseat_1 here. */
7634 reseat_1 (it
, it
->current
.pos
, 1);
7636 /* We are now surely at a line start. */
7637 it
->current_x
= it
->hpos
= 0;
7638 it
->continuation_lines_width
= 0;
7640 /* Move forward and see what y-distance we moved. First move to the
7641 start of the next line so that we get its height. We need this
7642 height to be able to tell whether we reached the specified
7645 it2
.max_ascent
= it2
.max_descent
= 0;
7648 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7649 MOVE_TO_POS
| MOVE_TO_VPOS
);
7651 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7652 xassert (IT_CHARPOS (*it
) >= BEGV
);
7655 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7656 xassert (IT_CHARPOS (*it
) >= BEGV
);
7657 /* H is the actual vertical distance from the position in *IT
7658 and the starting position. */
7659 h
= it2
.current_y
- it
->current_y
;
7660 /* NLINES is the distance in number of lines. */
7661 nlines
= it2
.vpos
- it
->vpos
;
7663 /* Correct IT's y and vpos position
7664 so that they are relative to the starting point. */
7670 /* DY == 0 means move to the start of the screen line. The
7671 value of nlines is > 0 if continuation lines were involved. */
7673 move_it_by_lines (it
, nlines
, 1);
7677 /* The y-position we try to reach, relative to *IT.
7678 Note that H has been subtracted in front of the if-statement. */
7679 int target_y
= it
->current_y
+ h
- dy
;
7680 int y0
= it3
.current_y
;
7681 int y1
= line_bottom_y (&it3
);
7682 int line_height
= y1
- y0
;
7684 /* If we did not reach target_y, try to move further backward if
7685 we can. If we moved too far backward, try to move forward. */
7686 if (target_y
< it
->current_y
7687 /* This is heuristic. In a window that's 3 lines high, with
7688 a line height of 13 pixels each, recentering with point
7689 on the bottom line will try to move -39/2 = 19 pixels
7690 backward. Try to avoid moving into the first line. */
7691 && (it
->current_y
- target_y
7692 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7693 && IT_CHARPOS (*it
) > BEGV
)
7695 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7696 target_y
- it
->current_y
));
7697 dy
= it
->current_y
- target_y
;
7698 goto move_further_back
;
7700 else if (target_y
>= it
->current_y
+ line_height
7701 && IT_CHARPOS (*it
) < ZV
)
7703 /* Should move forward by at least one line, maybe more.
7705 Note: Calling move_it_by_lines can be expensive on
7706 terminal frames, where compute_motion is used (via
7707 vmotion) to do the job, when there are very long lines
7708 and truncate-lines is nil. That's the reason for
7709 treating terminal frames specially here. */
7711 if (!FRAME_WINDOW_P (it
->f
))
7712 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7717 move_it_by_lines (it
, 1, 1);
7719 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7726 /* Move IT by a specified amount of pixel lines DY. DY negative means
7727 move backwards. DY = 0 means move to start of screen line. At the
7728 end, IT will be on the start of a screen line. */
7731 move_it_vertically (it
, dy
)
7736 move_it_vertically_backward (it
, -dy
);
7739 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7740 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7741 MOVE_TO_POS
| MOVE_TO_Y
);
7742 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7744 /* If buffer ends in ZV without a newline, move to the start of
7745 the line to satisfy the post-condition. */
7746 if (IT_CHARPOS (*it
) == ZV
7748 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7749 move_it_by_lines (it
, 0, 0);
7754 /* Move iterator IT past the end of the text line it is in. */
7757 move_it_past_eol (it
)
7760 enum move_it_result rc
;
7762 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7763 if (rc
== MOVE_NEWLINE_OR_CR
)
7764 set_iterator_to_next (it
, 0);
7768 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7769 negative means move up. DVPOS == 0 means move to the start of the
7770 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7771 NEED_Y_P is zero, IT->current_y will be left unchanged.
7773 Further optimization ideas: If we would know that IT->f doesn't use
7774 a face with proportional font, we could be faster for
7775 truncate-lines nil. */
7778 move_it_by_lines (it
, dvpos
, need_y_p
)
7780 int dvpos
, need_y_p
;
7782 struct position pos
;
7784 /* The commented-out optimization uses vmotion on terminals. This
7785 gives bad results, because elements like it->what, on which
7786 callers such as pos_visible_p rely, aren't updated. */
7787 /* if (!FRAME_WINDOW_P (it->f))
7789 struct text_pos textpos;
7791 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7792 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7793 reseat (it, textpos, 1);
7794 it->vpos += pos.vpos;
7795 it->current_y += pos.vpos;
7801 /* DVPOS == 0 means move to the start of the screen line. */
7802 move_it_vertically_backward (it
, 0);
7803 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7804 /* Let next call to line_bottom_y calculate real line height */
7809 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7810 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7811 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7816 int start_charpos
, i
;
7818 /* Start at the beginning of the screen line containing IT's
7819 position. This may actually move vertically backwards,
7820 in case of overlays, so adjust dvpos accordingly. */
7822 move_it_vertically_backward (it
, 0);
7825 /* Go back -DVPOS visible lines and reseat the iterator there. */
7826 start_charpos
= IT_CHARPOS (*it
);
7827 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7828 back_to_previous_visible_line_start (it
);
7829 reseat (it
, it
->current
.pos
, 1);
7831 /* Move further back if we end up in a string or an image. */
7832 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7834 /* First try to move to start of display line. */
7836 move_it_vertically_backward (it
, 0);
7838 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7840 /* If start of line is still in string or image,
7841 move further back. */
7842 back_to_previous_visible_line_start (it
);
7843 reseat (it
, it
->current
.pos
, 1);
7847 it
->current_x
= it
->hpos
= 0;
7849 /* Above call may have moved too far if continuation lines
7850 are involved. Scan forward and see if it did. */
7852 it2
.vpos
= it2
.current_y
= 0;
7853 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7854 it
->vpos
-= it2
.vpos
;
7855 it
->current_y
-= it2
.current_y
;
7856 it
->current_x
= it
->hpos
= 0;
7858 /* If we moved too far back, move IT some lines forward. */
7859 if (it2
.vpos
> -dvpos
)
7861 int delta
= it2
.vpos
+ dvpos
;
7863 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7864 /* Move back again if we got too far ahead. */
7865 if (IT_CHARPOS (*it
) >= start_charpos
)
7871 /* Return 1 if IT points into the middle of a display vector. */
7874 in_display_vector_p (it
)
7877 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7878 && it
->current
.dpvec_index
> 0
7879 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7883 /***********************************************************************
7885 ***********************************************************************/
7888 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7892 add_to_log (format
, arg1
, arg2
)
7894 Lisp_Object arg1
, arg2
;
7896 Lisp_Object args
[3];
7897 Lisp_Object msg
, fmt
;
7900 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7903 /* Do nothing if called asynchronously. Inserting text into
7904 a buffer may call after-change-functions and alike and
7905 that would means running Lisp asynchronously. */
7906 if (handling_signal
)
7910 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7912 args
[0] = fmt
= build_string (format
);
7915 msg
= Fformat (3, args
);
7917 len
= SBYTES (msg
) + 1;
7918 SAFE_ALLOCA (buffer
, char *, len
);
7919 bcopy (SDATA (msg
), buffer
, len
);
7921 message_dolog (buffer
, len
- 1, 1, 0);
7928 /* Output a newline in the *Messages* buffer if "needs" one. */
7931 message_log_maybe_newline ()
7933 if (message_log_need_newline
)
7934 message_dolog ("", 0, 1, 0);
7938 /* Add a string M of length NBYTES to the message log, optionally
7939 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7940 nonzero, means interpret the contents of M as multibyte. This
7941 function calls low-level routines in order to bypass text property
7942 hooks, etc. which might not be safe to run.
7944 This may GC (insert may run before/after change hooks),
7945 so the buffer M must NOT point to a Lisp string. */
7948 message_dolog (m
, nbytes
, nlflag
, multibyte
)
7950 int nbytes
, nlflag
, multibyte
;
7952 if (!NILP (Vmemory_full
))
7955 if (!NILP (Vmessage_log_max
))
7957 struct buffer
*oldbuf
;
7958 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7959 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7960 int point_at_end
= 0;
7962 Lisp_Object old_deactivate_mark
, tem
;
7963 struct gcpro gcpro1
;
7965 old_deactivate_mark
= Vdeactivate_mark
;
7966 oldbuf
= current_buffer
;
7967 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7968 current_buffer
->undo_list
= Qt
;
7970 oldpoint
= message_dolog_marker1
;
7971 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7972 oldbegv
= message_dolog_marker2
;
7973 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7974 oldzv
= message_dolog_marker3
;
7975 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7976 GCPRO1 (old_deactivate_mark
);
7984 BEGV_BYTE
= BEG_BYTE
;
7987 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7989 /* Insert the string--maybe converting multibyte to single byte
7990 or vice versa, so that all the text fits the buffer. */
7992 && NILP (current_buffer
->enable_multibyte_characters
))
7994 int i
, c
, char_bytes
;
7995 unsigned char work
[1];
7997 /* Convert a multibyte string to single-byte
7998 for the *Message* buffer. */
7999 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
8001 c
= string_char_and_length (m
+ i
, &char_bytes
);
8002 work
[0] = (ASCII_CHAR_P (c
)
8004 : multibyte_char_to_unibyte (c
, Qnil
));
8005 insert_1_both (work
, 1, 1, 1, 0, 0);
8008 else if (! multibyte
8009 && ! NILP (current_buffer
->enable_multibyte_characters
))
8011 int i
, c
, char_bytes
;
8012 unsigned char *msg
= (unsigned char *) m
;
8013 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8014 /* Convert a single-byte string to multibyte
8015 for the *Message* buffer. */
8016 for (i
= 0; i
< nbytes
; i
++)
8019 MAKE_CHAR_MULTIBYTE (c
);
8020 char_bytes
= CHAR_STRING (c
, str
);
8021 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
8025 insert_1 (m
, nbytes
, 1, 0, 0);
8029 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
8030 insert_1 ("\n", 1, 1, 0, 0);
8032 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8034 this_bol_byte
= PT_BYTE
;
8036 /* See if this line duplicates the previous one.
8037 If so, combine duplicates. */
8040 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8042 prev_bol_byte
= PT_BYTE
;
8044 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
8045 this_bol
, this_bol_byte
);
8048 del_range_both (prev_bol
, prev_bol_byte
,
8049 this_bol
, this_bol_byte
, 0);
8055 /* If you change this format, don't forget to also
8056 change message_log_check_duplicate. */
8057 sprintf (dupstr
, " [%d times]", dup
);
8058 duplen
= strlen (dupstr
);
8059 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8060 insert_1 (dupstr
, duplen
, 1, 0, 1);
8065 /* If we have more than the desired maximum number of lines
8066 in the *Messages* buffer now, delete the oldest ones.
8067 This is safe because we don't have undo in this buffer. */
8069 if (NATNUMP (Vmessage_log_max
))
8071 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8072 -XFASTINT (Vmessage_log_max
) - 1, 0);
8073 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8076 BEGV
= XMARKER (oldbegv
)->charpos
;
8077 BEGV_BYTE
= marker_byte_position (oldbegv
);
8086 ZV
= XMARKER (oldzv
)->charpos
;
8087 ZV_BYTE
= marker_byte_position (oldzv
);
8091 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8093 /* We can't do Fgoto_char (oldpoint) because it will run some
8095 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8096 XMARKER (oldpoint
)->bytepos
);
8099 unchain_marker (XMARKER (oldpoint
));
8100 unchain_marker (XMARKER (oldbegv
));
8101 unchain_marker (XMARKER (oldzv
));
8103 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8104 set_buffer_internal (oldbuf
);
8106 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8107 message_log_need_newline
= !nlflag
;
8108 Vdeactivate_mark
= old_deactivate_mark
;
8113 /* We are at the end of the buffer after just having inserted a newline.
8114 (Note: We depend on the fact we won't be crossing the gap.)
8115 Check to see if the most recent message looks a lot like the previous one.
8116 Return 0 if different, 1 if the new one should just replace it, or a
8117 value N > 1 if we should also append " [N times]". */
8120 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
8121 int prev_bol
, this_bol
;
8122 int prev_bol_byte
, this_bol_byte
;
8125 int len
= Z_BYTE
- 1 - this_bol_byte
;
8127 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8128 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8130 for (i
= 0; i
< len
; i
++)
8132 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8140 if (*p1
++ == ' ' && *p1
++ == '[')
8143 while (*p1
>= '0' && *p1
<= '9')
8144 n
= n
* 10 + *p1
++ - '0';
8145 if (strncmp (p1
, " times]\n", 8) == 0)
8152 /* Display an echo area message M with a specified length of NBYTES
8153 bytes. The string may include null characters. If M is 0, clear
8154 out any existing message, and let the mini-buffer text show
8157 This may GC, so the buffer M must NOT point to a Lisp string. */
8160 message2 (m
, nbytes
, multibyte
)
8165 /* First flush out any partial line written with print. */
8166 message_log_maybe_newline ();
8168 message_dolog (m
, nbytes
, 1, multibyte
);
8169 message2_nolog (m
, nbytes
, multibyte
);
8173 /* The non-logging counterpart of message2. */
8176 message2_nolog (m
, nbytes
, multibyte
)
8178 int nbytes
, multibyte
;
8180 struct frame
*sf
= SELECTED_FRAME ();
8181 message_enable_multibyte
= multibyte
;
8183 if (FRAME_INITIAL_P (sf
))
8185 if (noninteractive_need_newline
)
8186 putc ('\n', stderr
);
8187 noninteractive_need_newline
= 0;
8189 fwrite (m
, nbytes
, 1, stderr
);
8190 if (cursor_in_echo_area
== 0)
8191 fprintf (stderr
, "\n");
8194 /* A null message buffer means that the frame hasn't really been
8195 initialized yet. Error messages get reported properly by
8196 cmd_error, so this must be just an informative message; toss it. */
8197 else if (INTERACTIVE
8198 && sf
->glyphs_initialized_p
8199 && FRAME_MESSAGE_BUF (sf
))
8201 Lisp_Object mini_window
;
8204 /* Get the frame containing the mini-buffer
8205 that the selected frame is using. */
8206 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8207 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8209 FRAME_SAMPLE_VISIBILITY (f
);
8210 if (FRAME_VISIBLE_P (sf
)
8211 && ! FRAME_VISIBLE_P (f
))
8212 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8216 set_message (m
, Qnil
, nbytes
, multibyte
);
8217 if (minibuffer_auto_raise
)
8218 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8221 clear_message (1, 1);
8223 do_pending_window_change (0);
8224 echo_area_display (1);
8225 do_pending_window_change (0);
8226 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8227 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8232 /* Display an echo area message M with a specified length of NBYTES
8233 bytes. The string may include null characters. If M is not a
8234 string, clear out any existing message, and let the mini-buffer
8237 This function cancels echoing. */
8240 message3 (m
, nbytes
, multibyte
)
8245 struct gcpro gcpro1
;
8248 clear_message (1,1);
8251 /* First flush out any partial line written with print. */
8252 message_log_maybe_newline ();
8258 SAFE_ALLOCA (buffer
, char *, nbytes
);
8259 bcopy (SDATA (m
), buffer
, nbytes
);
8260 message_dolog (buffer
, nbytes
, 1, multibyte
);
8263 message3_nolog (m
, nbytes
, multibyte
);
8269 /* The non-logging version of message3.
8270 This does not cancel echoing, because it is used for echoing.
8271 Perhaps we need to make a separate function for echoing
8272 and make this cancel echoing. */
8275 message3_nolog (m
, nbytes
, multibyte
)
8277 int nbytes
, multibyte
;
8279 struct frame
*sf
= SELECTED_FRAME ();
8280 message_enable_multibyte
= multibyte
;
8282 if (FRAME_INITIAL_P (sf
))
8284 if (noninteractive_need_newline
)
8285 putc ('\n', stderr
);
8286 noninteractive_need_newline
= 0;
8288 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8289 if (cursor_in_echo_area
== 0)
8290 fprintf (stderr
, "\n");
8293 /* A null message buffer means that the frame hasn't really been
8294 initialized yet. Error messages get reported properly by
8295 cmd_error, so this must be just an informative message; toss it. */
8296 else if (INTERACTIVE
8297 && sf
->glyphs_initialized_p
8298 && FRAME_MESSAGE_BUF (sf
))
8300 Lisp_Object mini_window
;
8304 /* Get the frame containing the mini-buffer
8305 that the selected frame is using. */
8306 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8307 frame
= XWINDOW (mini_window
)->frame
;
8310 FRAME_SAMPLE_VISIBILITY (f
);
8311 if (FRAME_VISIBLE_P (sf
)
8312 && !FRAME_VISIBLE_P (f
))
8313 Fmake_frame_visible (frame
);
8315 if (STRINGP (m
) && SCHARS (m
) > 0)
8317 set_message (NULL
, m
, nbytes
, multibyte
);
8318 if (minibuffer_auto_raise
)
8319 Fraise_frame (frame
);
8320 /* Assume we are not echoing.
8321 (If we are, echo_now will override this.) */
8322 echo_message_buffer
= Qnil
;
8325 clear_message (1, 1);
8327 do_pending_window_change (0);
8328 echo_area_display (1);
8329 do_pending_window_change (0);
8330 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8331 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8336 /* Display a null-terminated echo area message M. If M is 0, clear
8337 out any existing message, and let the mini-buffer text show through.
8339 The buffer M must continue to exist until after the echo area gets
8340 cleared or some other message gets displayed there. Do not pass
8341 text that is stored in a Lisp string. Do not pass text in a buffer
8342 that was alloca'd. */
8348 message2 (m
, (m
? strlen (m
) : 0), 0);
8352 /* The non-logging counterpart of message1. */
8358 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8361 /* Display a message M which contains a single %s
8362 which gets replaced with STRING. */
8365 message_with_string (m
, string
, log
)
8370 CHECK_STRING (string
);
8376 if (noninteractive_need_newline
)
8377 putc ('\n', stderr
);
8378 noninteractive_need_newline
= 0;
8379 fprintf (stderr
, m
, SDATA (string
));
8380 if (!cursor_in_echo_area
)
8381 fprintf (stderr
, "\n");
8385 else if (INTERACTIVE
)
8387 /* The frame whose minibuffer we're going to display the message on.
8388 It may be larger than the selected frame, so we need
8389 to use its buffer, not the selected frame's buffer. */
8390 Lisp_Object mini_window
;
8391 struct frame
*f
, *sf
= SELECTED_FRAME ();
8393 /* Get the frame containing the minibuffer
8394 that the selected frame is using. */
8395 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8396 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8398 /* A null message buffer means that the frame hasn't really been
8399 initialized yet. Error messages get reported properly by
8400 cmd_error, so this must be just an informative message; toss it. */
8401 if (FRAME_MESSAGE_BUF (f
))
8403 Lisp_Object args
[2], message
;
8404 struct gcpro gcpro1
, gcpro2
;
8406 args
[0] = build_string (m
);
8407 args
[1] = message
= string
;
8408 GCPRO2 (args
[0], message
);
8411 message
= Fformat (2, args
);
8414 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8416 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8420 /* Print should start at the beginning of the message
8421 buffer next time. */
8422 message_buf_print
= 0;
8428 /* Dump an informative message to the minibuf. If M is 0, clear out
8429 any existing message, and let the mini-buffer text show through. */
8433 message (m
, a1
, a2
, a3
)
8435 EMACS_INT a1
, a2
, a3
;
8441 if (noninteractive_need_newline
)
8442 putc ('\n', stderr
);
8443 noninteractive_need_newline
= 0;
8444 fprintf (stderr
, m
, a1
, a2
, a3
);
8445 if (cursor_in_echo_area
== 0)
8446 fprintf (stderr
, "\n");
8450 else if (INTERACTIVE
)
8452 /* The frame whose mini-buffer we're going to display the message
8453 on. It may be larger than the selected frame, so we need to
8454 use its buffer, not the selected frame's buffer. */
8455 Lisp_Object mini_window
;
8456 struct frame
*f
, *sf
= SELECTED_FRAME ();
8458 /* Get the frame containing the mini-buffer
8459 that the selected frame is using. */
8460 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8461 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8463 /* A null message buffer means that the frame hasn't really been
8464 initialized yet. Error messages get reported properly by
8465 cmd_error, so this must be just an informative message; toss
8467 if (FRAME_MESSAGE_BUF (f
))
8478 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8479 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
8481 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8482 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3,
8484 #endif /* NO_ARG_ARRAY */
8486 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8491 /* Print should start at the beginning of the message
8492 buffer next time. */
8493 message_buf_print
= 0;
8499 /* The non-logging version of message. */
8502 message_nolog (m
, a1
, a2
, a3
)
8504 EMACS_INT a1
, a2
, a3
;
8506 Lisp_Object old_log_max
;
8507 old_log_max
= Vmessage_log_max
;
8508 Vmessage_log_max
= Qnil
;
8509 message (m
, a1
, a2
, a3
);
8510 Vmessage_log_max
= old_log_max
;
8514 /* Display the current message in the current mini-buffer. This is
8515 only called from error handlers in process.c, and is not time
8521 if (!NILP (echo_area_buffer
[0]))
8524 string
= Fcurrent_message ();
8525 message3 (string
, SBYTES (string
),
8526 !NILP (current_buffer
->enable_multibyte_characters
));
8531 /* Make sure echo area buffers in `echo_buffers' are live.
8532 If they aren't, make new ones. */
8535 ensure_echo_area_buffers ()
8539 for (i
= 0; i
< 2; ++i
)
8540 if (!BUFFERP (echo_buffer
[i
])
8541 || NILP (XBUFFER (echo_buffer
[i
])->name
))
8544 Lisp_Object old_buffer
;
8547 old_buffer
= echo_buffer
[i
];
8548 sprintf (name
, " *Echo Area %d*", i
);
8549 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8550 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
8551 /* to force word wrap in echo area -
8552 it was decided to postpone this*/
8553 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8555 for (j
= 0; j
< 2; ++j
)
8556 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8557 echo_area_buffer
[j
] = echo_buffer
[i
];
8562 /* Call FN with args A1..A4 with either the current or last displayed
8563 echo_area_buffer as current buffer.
8565 WHICH zero means use the current message buffer
8566 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8567 from echo_buffer[] and clear it.
8569 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8570 suitable buffer from echo_buffer[] and clear it.
8572 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8573 that the current message becomes the last displayed one, make
8574 choose a suitable buffer for echo_area_buffer[0], and clear it.
8576 Value is what FN returns. */
8579 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
)
8582 int (*fn
) P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
8588 int this_one
, the_other
, clear_buffer_p
, rc
;
8589 int count
= SPECPDL_INDEX ();
8591 /* If buffers aren't live, make new ones. */
8592 ensure_echo_area_buffers ();
8597 this_one
= 0, the_other
= 1;
8599 this_one
= 1, the_other
= 0;
8602 this_one
= 0, the_other
= 1;
8605 /* We need a fresh one in case the current echo buffer equals
8606 the one containing the last displayed echo area message. */
8607 if (!NILP (echo_area_buffer
[this_one
])
8608 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8609 echo_area_buffer
[this_one
] = Qnil
;
8612 /* Choose a suitable buffer from echo_buffer[] is we don't
8614 if (NILP (echo_area_buffer
[this_one
]))
8616 echo_area_buffer
[this_one
]
8617 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8618 ? echo_buffer
[the_other
]
8619 : echo_buffer
[this_one
]);
8623 buffer
= echo_area_buffer
[this_one
];
8625 /* Don't get confused by reusing the buffer used for echoing
8626 for a different purpose. */
8627 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8630 record_unwind_protect (unwind_with_echo_area_buffer
,
8631 with_echo_area_buffer_unwind_data (w
));
8633 /* Make the echo area buffer current. Note that for display
8634 purposes, it is not necessary that the displayed window's buffer
8635 == current_buffer, except for text property lookup. So, let's
8636 only set that buffer temporarily here without doing a full
8637 Fset_window_buffer. We must also change w->pointm, though,
8638 because otherwise an assertions in unshow_buffer fails, and Emacs
8640 set_buffer_internal_1 (XBUFFER (buffer
));
8644 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8647 current_buffer
->undo_list
= Qt
;
8648 current_buffer
->read_only
= Qnil
;
8649 specbind (Qinhibit_read_only
, Qt
);
8650 specbind (Qinhibit_modification_hooks
, Qt
);
8652 if (clear_buffer_p
&& Z
> BEG
)
8655 xassert (BEGV
>= BEG
);
8656 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8658 rc
= fn (a1
, a2
, a3
, a4
);
8660 xassert (BEGV
>= BEG
);
8661 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8663 unbind_to (count
, Qnil
);
8668 /* Save state that should be preserved around the call to the function
8669 FN called in with_echo_area_buffer. */
8672 with_echo_area_buffer_unwind_data (w
)
8676 Lisp_Object vector
, tmp
;
8678 /* Reduce consing by keeping one vector in
8679 Vwith_echo_area_save_vector. */
8680 vector
= Vwith_echo_area_save_vector
;
8681 Vwith_echo_area_save_vector
= Qnil
;
8684 vector
= Fmake_vector (make_number (7), Qnil
);
8686 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8687 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8688 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8692 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8693 ASET (vector
, i
, w
->buffer
); ++i
;
8694 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8695 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8700 for (; i
< end
; ++i
)
8701 ASET (vector
, i
, Qnil
);
8704 xassert (i
== ASIZE (vector
));
8709 /* Restore global state from VECTOR which was created by
8710 with_echo_area_buffer_unwind_data. */
8713 unwind_with_echo_area_buffer (vector
)
8716 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8717 Vdeactivate_mark
= AREF (vector
, 1);
8718 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8720 if (WINDOWP (AREF (vector
, 3)))
8723 Lisp_Object buffer
, charpos
, bytepos
;
8725 w
= XWINDOW (AREF (vector
, 3));
8726 buffer
= AREF (vector
, 4);
8727 charpos
= AREF (vector
, 5);
8728 bytepos
= AREF (vector
, 6);
8731 set_marker_both (w
->pointm
, buffer
,
8732 XFASTINT (charpos
), XFASTINT (bytepos
));
8735 Vwith_echo_area_save_vector
= vector
;
8740 /* Set up the echo area for use by print functions. MULTIBYTE_P
8741 non-zero means we will print multibyte. */
8744 setup_echo_area_for_printing (multibyte_p
)
8747 /* If we can't find an echo area any more, exit. */
8748 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8751 ensure_echo_area_buffers ();
8753 if (!message_buf_print
)
8755 /* A message has been output since the last time we printed.
8756 Choose a fresh echo area buffer. */
8757 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8758 echo_area_buffer
[0] = echo_buffer
[1];
8760 echo_area_buffer
[0] = echo_buffer
[0];
8762 /* Switch to that buffer and clear it. */
8763 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8764 current_buffer
->truncate_lines
= Qnil
;
8768 int count
= SPECPDL_INDEX ();
8769 specbind (Qinhibit_read_only
, Qt
);
8770 /* Note that undo recording is always disabled. */
8772 unbind_to (count
, Qnil
);
8774 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8776 /* Set up the buffer for the multibyteness we need. */
8778 != !NILP (current_buffer
->enable_multibyte_characters
))
8779 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8781 /* Raise the frame containing the echo area. */
8782 if (minibuffer_auto_raise
)
8784 struct frame
*sf
= SELECTED_FRAME ();
8785 Lisp_Object mini_window
;
8786 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8787 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8790 message_log_maybe_newline ();
8791 message_buf_print
= 1;
8795 if (NILP (echo_area_buffer
[0]))
8797 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8798 echo_area_buffer
[0] = echo_buffer
[1];
8800 echo_area_buffer
[0] = echo_buffer
[0];
8803 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8805 /* Someone switched buffers between print requests. */
8806 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8807 current_buffer
->truncate_lines
= Qnil
;
8813 /* Display an echo area message in window W. Value is non-zero if W's
8814 height is changed. If display_last_displayed_message_p is
8815 non-zero, display the message that was last displayed, otherwise
8816 display the current message. */
8819 display_echo_area (w
)
8822 int i
, no_message_p
, window_height_changed_p
, count
;
8824 /* Temporarily disable garbage collections while displaying the echo
8825 area. This is done because a GC can print a message itself.
8826 That message would modify the echo area buffer's contents while a
8827 redisplay of the buffer is going on, and seriously confuse
8829 count
= inhibit_garbage_collection ();
8831 /* If there is no message, we must call display_echo_area_1
8832 nevertheless because it resizes the window. But we will have to
8833 reset the echo_area_buffer in question to nil at the end because
8834 with_echo_area_buffer will sets it to an empty buffer. */
8835 i
= display_last_displayed_message_p
? 1 : 0;
8836 no_message_p
= NILP (echo_area_buffer
[i
]);
8838 window_height_changed_p
8839 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8840 display_echo_area_1
,
8841 (EMACS_INT
) w
, Qnil
, 0, 0);
8844 echo_area_buffer
[i
] = Qnil
;
8846 unbind_to (count
, Qnil
);
8847 return window_height_changed_p
;
8851 /* Helper for display_echo_area. Display the current buffer which
8852 contains the current echo area message in window W, a mini-window,
8853 a pointer to which is passed in A1. A2..A4 are currently not used.
8854 Change the height of W so that all of the message is displayed.
8855 Value is non-zero if height of W was changed. */
8858 display_echo_area_1 (a1
, a2
, a3
, a4
)
8863 struct window
*w
= (struct window
*) a1
;
8865 struct text_pos start
;
8866 int window_height_changed_p
= 0;
8868 /* Do this before displaying, so that we have a large enough glyph
8869 matrix for the display. If we can't get enough space for the
8870 whole text, display the last N lines. That works by setting w->start. */
8871 window_height_changed_p
= resize_mini_window (w
, 0);
8873 /* Use the starting position chosen by resize_mini_window. */
8874 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8877 clear_glyph_matrix (w
->desired_matrix
);
8878 XSETWINDOW (window
, w
);
8879 try_window (window
, start
, 0);
8881 return window_height_changed_p
;
8885 /* Resize the echo area window to exactly the size needed for the
8886 currently displayed message, if there is one. If a mini-buffer
8887 is active, don't shrink it. */
8890 resize_echo_area_exactly ()
8892 if (BUFFERP (echo_area_buffer
[0])
8893 && WINDOWP (echo_area_window
))
8895 struct window
*w
= XWINDOW (echo_area_window
);
8897 Lisp_Object resize_exactly
;
8899 if (minibuf_level
== 0)
8900 resize_exactly
= Qt
;
8902 resize_exactly
= Qnil
;
8904 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8905 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8908 ++windows_or_buffers_changed
;
8909 ++update_mode_lines
;
8910 redisplay_internal (0);
8916 /* Callback function for with_echo_area_buffer, when used from
8917 resize_echo_area_exactly. A1 contains a pointer to the window to
8918 resize, EXACTLY non-nil means resize the mini-window exactly to the
8919 size of the text displayed. A3 and A4 are not used. Value is what
8920 resize_mini_window returns. */
8923 resize_mini_window_1 (a1
, exactly
, a3
, a4
)
8925 Lisp_Object exactly
;
8928 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8932 /* Resize mini-window W to fit the size of its contents. EXACT_P
8933 means size the window exactly to the size needed. Otherwise, it's
8934 only enlarged until W's buffer is empty.
8936 Set W->start to the right place to begin display. If the whole
8937 contents fit, start at the beginning. Otherwise, start so as
8938 to make the end of the contents appear. This is particularly
8939 important for y-or-n-p, but seems desirable generally.
8941 Value is non-zero if the window height has been changed. */
8944 resize_mini_window (w
, exact_p
)
8948 struct frame
*f
= XFRAME (w
->frame
);
8949 int window_height_changed_p
= 0;
8951 xassert (MINI_WINDOW_P (w
));
8953 /* By default, start display at the beginning. */
8954 set_marker_both (w
->start
, w
->buffer
,
8955 BUF_BEGV (XBUFFER (w
->buffer
)),
8956 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8958 /* Don't resize windows while redisplaying a window; it would
8959 confuse redisplay functions when the size of the window they are
8960 displaying changes from under them. Such a resizing can happen,
8961 for instance, when which-func prints a long message while
8962 we are running fontification-functions. We're running these
8963 functions with safe_call which binds inhibit-redisplay to t. */
8964 if (!NILP (Vinhibit_redisplay
))
8967 /* Nil means don't try to resize. */
8968 if (NILP (Vresize_mini_windows
)
8969 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8972 if (!FRAME_MINIBUF_ONLY_P (f
))
8975 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8976 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8977 int height
, max_height
;
8978 int unit
= FRAME_LINE_HEIGHT (f
);
8979 struct text_pos start
;
8980 struct buffer
*old_current_buffer
= NULL
;
8982 if (current_buffer
!= XBUFFER (w
->buffer
))
8984 old_current_buffer
= current_buffer
;
8985 set_buffer_internal (XBUFFER (w
->buffer
));
8988 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8990 /* Compute the max. number of lines specified by the user. */
8991 if (FLOATP (Vmax_mini_window_height
))
8992 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8993 else if (INTEGERP (Vmax_mini_window_height
))
8994 max_height
= XINT (Vmax_mini_window_height
);
8996 max_height
= total_height
/ 4;
8998 /* Correct that max. height if it's bogus. */
8999 max_height
= max (1, max_height
);
9000 max_height
= min (total_height
, max_height
);
9002 /* Find out the height of the text in the window. */
9003 if (it
.line_wrap
== TRUNCATE
)
9008 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
9009 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
9010 height
= it
.current_y
+ last_height
;
9012 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9013 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
9014 height
= (height
+ unit
- 1) / unit
;
9017 /* Compute a suitable window start. */
9018 if (height
> max_height
)
9020 height
= max_height
;
9021 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9022 move_it_vertically_backward (&it
, (height
- 1) * unit
);
9023 start
= it
.current
.pos
;
9026 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
9027 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
9029 if (EQ (Vresize_mini_windows
, Qgrow_only
))
9031 /* Let it grow only, until we display an empty message, in which
9032 case the window shrinks again. */
9033 if (height
> WINDOW_TOTAL_LINES (w
))
9035 int old_height
= WINDOW_TOTAL_LINES (w
);
9036 freeze_window_starts (f
, 1);
9037 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9038 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9040 else if (height
< WINDOW_TOTAL_LINES (w
)
9041 && (exact_p
|| BEGV
== ZV
))
9043 int old_height
= WINDOW_TOTAL_LINES (w
);
9044 freeze_window_starts (f
, 0);
9045 shrink_mini_window (w
);
9046 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9051 /* Always resize to exact size needed. */
9052 if (height
> WINDOW_TOTAL_LINES (w
))
9054 int old_height
= WINDOW_TOTAL_LINES (w
);
9055 freeze_window_starts (f
, 1);
9056 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9057 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9059 else if (height
< WINDOW_TOTAL_LINES (w
))
9061 int old_height
= WINDOW_TOTAL_LINES (w
);
9062 freeze_window_starts (f
, 0);
9063 shrink_mini_window (w
);
9067 freeze_window_starts (f
, 1);
9068 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9071 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9075 if (old_current_buffer
)
9076 set_buffer_internal (old_current_buffer
);
9079 return window_height_changed_p
;
9083 /* Value is the current message, a string, or nil if there is no
9091 if (!BUFFERP (echo_area_buffer
[0]))
9095 with_echo_area_buffer (0, 0, current_message_1
,
9096 (EMACS_INT
) &msg
, Qnil
, 0, 0);
9098 echo_area_buffer
[0] = Qnil
;
9106 current_message_1 (a1
, a2
, a3
, a4
)
9111 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
9114 *msg
= make_buffer_string (BEG
, Z
, 1);
9121 /* Push the current message on Vmessage_stack for later restauration
9122 by restore_message. Value is non-zero if the current message isn't
9123 empty. This is a relatively infrequent operation, so it's not
9124 worth optimizing. */
9130 msg
= current_message ();
9131 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9132 return STRINGP (msg
);
9136 /* Restore message display from the top of Vmessage_stack. */
9143 xassert (CONSP (Vmessage_stack
));
9144 msg
= XCAR (Vmessage_stack
);
9146 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9148 message3_nolog (msg
, 0, 0);
9152 /* Handler for record_unwind_protect calling pop_message. */
9155 pop_message_unwind (dummy
)
9162 /* Pop the top-most entry off Vmessage_stack. */
9167 xassert (CONSP (Vmessage_stack
));
9168 Vmessage_stack
= XCDR (Vmessage_stack
);
9172 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9173 exits. If the stack is not empty, we have a missing pop_message
9177 check_message_stack ()
9179 if (!NILP (Vmessage_stack
))
9184 /* Truncate to NCHARS what will be displayed in the echo area the next
9185 time we display it---but don't redisplay it now. */
9188 truncate_echo_area (nchars
)
9192 echo_area_buffer
[0] = Qnil
;
9193 /* A null message buffer means that the frame hasn't really been
9194 initialized yet. Error messages get reported properly by
9195 cmd_error, so this must be just an informative message; toss it. */
9196 else if (!noninteractive
9198 && !NILP (echo_area_buffer
[0]))
9200 struct frame
*sf
= SELECTED_FRAME ();
9201 if (FRAME_MESSAGE_BUF (sf
))
9202 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9207 /* Helper function for truncate_echo_area. Truncate the current
9208 message to at most NCHARS characters. */
9211 truncate_message_1 (nchars
, a2
, a3
, a4
)
9216 if (BEG
+ nchars
< Z
)
9217 del_range (BEG
+ nchars
, Z
);
9219 echo_area_buffer
[0] = Qnil
;
9224 /* Set the current message to a substring of S or STRING.
9226 If STRING is a Lisp string, set the message to the first NBYTES
9227 bytes from STRING. NBYTES zero means use the whole string. If
9228 STRING is multibyte, the message will be displayed multibyte.
9230 If S is not null, set the message to the first LEN bytes of S. LEN
9231 zero means use the whole string. MULTIBYTE_P non-zero means S is
9232 multibyte. Display the message multibyte in that case.
9234 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9235 to t before calling set_message_1 (which calls insert).
9239 set_message (s
, string
, nbytes
, multibyte_p
)
9242 int nbytes
, multibyte_p
;
9244 message_enable_multibyte
9245 = ((s
&& multibyte_p
)
9246 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9248 with_echo_area_buffer (0, -1, set_message_1
,
9249 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
9250 message_buf_print
= 0;
9251 help_echo_showing_p
= 0;
9255 /* Helper function for set_message. Arguments have the same meaning
9256 as there, with A1 corresponding to S and A2 corresponding to STRING
9257 This function is called with the echo area buffer being
9261 set_message_1 (a1
, a2
, nbytes
, multibyte_p
)
9264 EMACS_INT nbytes
, multibyte_p
;
9266 const char *s
= (const char *) a1
;
9267 Lisp_Object string
= a2
;
9269 /* Change multibyteness of the echo buffer appropriately. */
9270 if (message_enable_multibyte
9271 != !NILP (current_buffer
->enable_multibyte_characters
))
9272 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9274 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
9276 /* Insert new message at BEG. */
9277 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9279 if (STRINGP (string
))
9284 nbytes
= SBYTES (string
);
9285 nchars
= string_byte_to_char (string
, nbytes
);
9287 /* This function takes care of single/multibyte conversion. We
9288 just have to ensure that the echo area buffer has the right
9289 setting of enable_multibyte_characters. */
9290 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9295 nbytes
= strlen (s
);
9297 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
9299 /* Convert from multi-byte to single-byte. */
9301 unsigned char work
[1];
9303 /* Convert a multibyte string to single-byte. */
9304 for (i
= 0; i
< nbytes
; i
+= n
)
9306 c
= string_char_and_length (s
+ i
, &n
);
9307 work
[0] = (ASCII_CHAR_P (c
)
9309 : multibyte_char_to_unibyte (c
, Qnil
));
9310 insert_1_both (work
, 1, 1, 1, 0, 0);
9313 else if (!multibyte_p
9314 && !NILP (current_buffer
->enable_multibyte_characters
))
9316 /* Convert from single-byte to multi-byte. */
9318 const unsigned char *msg
= (const unsigned char *) s
;
9319 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9321 /* Convert a single-byte string to multibyte. */
9322 for (i
= 0; i
< nbytes
; i
++)
9325 MAKE_CHAR_MULTIBYTE (c
);
9326 n
= CHAR_STRING (c
, str
);
9327 insert_1_both (str
, 1, n
, 1, 0, 0);
9331 insert_1 (s
, nbytes
, 1, 0, 0);
9338 /* Clear messages. CURRENT_P non-zero means clear the current
9339 message. LAST_DISPLAYED_P non-zero means clear the message
9343 clear_message (current_p
, last_displayed_p
)
9344 int current_p
, last_displayed_p
;
9348 echo_area_buffer
[0] = Qnil
;
9349 message_cleared_p
= 1;
9352 if (last_displayed_p
)
9353 echo_area_buffer
[1] = Qnil
;
9355 message_buf_print
= 0;
9358 /* Clear garbaged frames.
9360 This function is used where the old redisplay called
9361 redraw_garbaged_frames which in turn called redraw_frame which in
9362 turn called clear_frame. The call to clear_frame was a source of
9363 flickering. I believe a clear_frame is not necessary. It should
9364 suffice in the new redisplay to invalidate all current matrices,
9365 and ensure a complete redisplay of all windows. */
9368 clear_garbaged_frames ()
9372 Lisp_Object tail
, frame
;
9373 int changed_count
= 0;
9375 FOR_EACH_FRAME (tail
, frame
)
9377 struct frame
*f
= XFRAME (frame
);
9379 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9383 Fredraw_frame (frame
);
9384 f
->force_flush_display_p
= 1;
9386 clear_current_matrices (f
);
9395 ++windows_or_buffers_changed
;
9400 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9401 is non-zero update selected_frame. Value is non-zero if the
9402 mini-windows height has been changed. */
9405 echo_area_display (update_frame_p
)
9408 Lisp_Object mini_window
;
9411 int window_height_changed_p
= 0;
9412 struct frame
*sf
= SELECTED_FRAME ();
9414 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9415 w
= XWINDOW (mini_window
);
9416 f
= XFRAME (WINDOW_FRAME (w
));
9418 /* Don't display if frame is invisible or not yet initialized. */
9419 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9422 #ifdef HAVE_WINDOW_SYSTEM
9423 /* When Emacs starts, selected_frame may be the initial terminal
9424 frame. If we let this through, a message would be displayed on
9426 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9428 #endif /* HAVE_WINDOW_SYSTEM */
9430 /* Redraw garbaged frames. */
9432 clear_garbaged_frames ();
9434 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9436 echo_area_window
= mini_window
;
9437 window_height_changed_p
= display_echo_area (w
);
9438 w
->must_be_updated_p
= 1;
9440 /* Update the display, unless called from redisplay_internal.
9441 Also don't update the screen during redisplay itself. The
9442 update will happen at the end of redisplay, and an update
9443 here could cause confusion. */
9444 if (update_frame_p
&& !redisplaying_p
)
9448 /* If the display update has been interrupted by pending
9449 input, update mode lines in the frame. Due to the
9450 pending input, it might have been that redisplay hasn't
9451 been called, so that mode lines above the echo area are
9452 garbaged. This looks odd, so we prevent it here. */
9453 if (!display_completed
)
9454 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9456 if (window_height_changed_p
9457 /* Don't do this if Emacs is shutting down. Redisplay
9458 needs to run hooks. */
9459 && !NILP (Vrun_hooks
))
9461 /* Must update other windows. Likewise as in other
9462 cases, don't let this update be interrupted by
9464 int count
= SPECPDL_INDEX ();
9465 specbind (Qredisplay_dont_pause
, Qt
);
9466 windows_or_buffers_changed
= 1;
9467 redisplay_internal (0);
9468 unbind_to (count
, Qnil
);
9470 else if (FRAME_WINDOW_P (f
) && n
== 0)
9472 /* Window configuration is the same as before.
9473 Can do with a display update of the echo area,
9474 unless we displayed some mode lines. */
9475 update_single_window (w
, 1);
9476 FRAME_RIF (f
)->flush_display (f
);
9479 update_frame (f
, 1, 1);
9481 /* If cursor is in the echo area, make sure that the next
9482 redisplay displays the minibuffer, so that the cursor will
9483 be replaced with what the minibuffer wants. */
9484 if (cursor_in_echo_area
)
9485 ++windows_or_buffers_changed
;
9488 else if (!EQ (mini_window
, selected_window
))
9489 windows_or_buffers_changed
++;
9491 /* Last displayed message is now the current message. */
9492 echo_area_buffer
[1] = echo_area_buffer
[0];
9493 /* Inform read_char that we're not echoing. */
9494 echo_message_buffer
= Qnil
;
9496 /* Prevent redisplay optimization in redisplay_internal by resetting
9497 this_line_start_pos. This is done because the mini-buffer now
9498 displays the message instead of its buffer text. */
9499 if (EQ (mini_window
, selected_window
))
9500 CHARPOS (this_line_start_pos
) = 0;
9502 return window_height_changed_p
;
9507 /***********************************************************************
9508 Mode Lines and Frame Titles
9509 ***********************************************************************/
9511 /* A buffer for constructing non-propertized mode-line strings and
9512 frame titles in it; allocated from the heap in init_xdisp and
9513 resized as needed in store_mode_line_noprop_char. */
9515 static char *mode_line_noprop_buf
;
9517 /* The buffer's end, and a current output position in it. */
9519 static char *mode_line_noprop_buf_end
;
9520 static char *mode_line_noprop_ptr
;
9522 #define MODE_LINE_NOPROP_LEN(start) \
9523 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9526 MODE_LINE_DISPLAY
= 0,
9532 /* Alist that caches the results of :propertize.
9533 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9534 static Lisp_Object mode_line_proptrans_alist
;
9536 /* List of strings making up the mode-line. */
9537 static Lisp_Object mode_line_string_list
;
9539 /* Base face property when building propertized mode line string. */
9540 static Lisp_Object mode_line_string_face
;
9541 static Lisp_Object mode_line_string_face_prop
;
9544 /* Unwind data for mode line strings */
9546 static Lisp_Object Vmode_line_unwind_vector
;
9549 format_mode_line_unwind_data (struct buffer
*obuf
,
9553 Lisp_Object vector
, tmp
;
9555 /* Reduce consing by keeping one vector in
9556 Vwith_echo_area_save_vector. */
9557 vector
= Vmode_line_unwind_vector
;
9558 Vmode_line_unwind_vector
= Qnil
;
9561 vector
= Fmake_vector (make_number (8), Qnil
);
9563 ASET (vector
, 0, make_number (mode_line_target
));
9564 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9565 ASET (vector
, 2, mode_line_string_list
);
9566 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9567 ASET (vector
, 4, mode_line_string_face
);
9568 ASET (vector
, 5, mode_line_string_face_prop
);
9571 XSETBUFFER (tmp
, obuf
);
9574 ASET (vector
, 6, tmp
);
9575 ASET (vector
, 7, owin
);
9581 unwind_format_mode_line (vector
)
9584 mode_line_target
= XINT (AREF (vector
, 0));
9585 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9586 mode_line_string_list
= AREF (vector
, 2);
9587 if (! EQ (AREF (vector
, 3), Qt
))
9588 mode_line_proptrans_alist
= AREF (vector
, 3);
9589 mode_line_string_face
= AREF (vector
, 4);
9590 mode_line_string_face_prop
= AREF (vector
, 5);
9592 if (!NILP (AREF (vector
, 7)))
9593 /* Select window before buffer, since it may change the buffer. */
9594 Fselect_window (AREF (vector
, 7), Qt
);
9596 if (!NILP (AREF (vector
, 6)))
9598 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9599 ASET (vector
, 6, Qnil
);
9602 Vmode_line_unwind_vector
= vector
;
9607 /* Store a single character C for the frame title in mode_line_noprop_buf.
9608 Re-allocate mode_line_noprop_buf if necessary. */
9612 store_mode_line_noprop_char (char c
)
9614 store_mode_line_noprop_char (c
)
9618 /* If output position has reached the end of the allocated buffer,
9619 double the buffer's size. */
9620 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9622 int len
= MODE_LINE_NOPROP_LEN (0);
9623 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9624 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9625 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9626 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9629 *mode_line_noprop_ptr
++ = c
;
9633 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9634 mode_line_noprop_ptr. STR is the string to store. Do not copy
9635 characters that yield more columns than PRECISION; PRECISION <= 0
9636 means copy the whole string. Pad with spaces until FIELD_WIDTH
9637 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9638 pad. Called from display_mode_element when it is used to build a
9642 store_mode_line_noprop (str
, field_width
, precision
)
9643 const unsigned char *str
;
9644 int field_width
, precision
;
9649 /* Copy at most PRECISION chars from STR. */
9650 nbytes
= strlen (str
);
9651 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9653 store_mode_line_noprop_char (*str
++);
9655 /* Fill up with spaces until FIELD_WIDTH reached. */
9656 while (field_width
> 0
9659 store_mode_line_noprop_char (' ');
9666 /***********************************************************************
9668 ***********************************************************************/
9670 #ifdef HAVE_WINDOW_SYSTEM
9672 /* Set the title of FRAME, if it has changed. The title format is
9673 Vicon_title_format if FRAME is iconified, otherwise it is
9674 frame_title_format. */
9677 x_consider_frame_title (frame
)
9680 struct frame
*f
= XFRAME (frame
);
9682 if (FRAME_WINDOW_P (f
)
9683 || FRAME_MINIBUF_ONLY_P (f
)
9684 || f
->explicit_name
)
9686 /* Do we have more than one visible frame on this X display? */
9693 int count
= SPECPDL_INDEX ();
9695 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9697 Lisp_Object other_frame
= XCAR (tail
);
9698 struct frame
*tf
= XFRAME (other_frame
);
9701 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9702 && !FRAME_MINIBUF_ONLY_P (tf
)
9703 && !EQ (other_frame
, tip_frame
)
9704 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9708 /* Set global variable indicating that multiple frames exist. */
9709 multiple_frames
= CONSP (tail
);
9711 /* Switch to the buffer of selected window of the frame. Set up
9712 mode_line_target so that display_mode_element will output into
9713 mode_line_noprop_buf; then display the title. */
9714 record_unwind_protect (unwind_format_mode_line
,
9715 format_mode_line_unwind_data
9716 (current_buffer
, selected_window
, 0));
9718 Fselect_window (f
->selected_window
, Qt
);
9719 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9720 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9722 mode_line_target
= MODE_LINE_TITLE
;
9723 title_start
= MODE_LINE_NOPROP_LEN (0);
9724 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9725 NULL
, DEFAULT_FACE_ID
);
9726 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9727 len
= MODE_LINE_NOPROP_LEN (title_start
);
9728 title
= mode_line_noprop_buf
+ title_start
;
9729 unbind_to (count
, Qnil
);
9731 /* Set the title only if it's changed. This avoids consing in
9732 the common case where it hasn't. (If it turns out that we've
9733 already wasted too much time by walking through the list with
9734 display_mode_element, then we might need to optimize at a
9735 higher level than this.) */
9736 if (! STRINGP (f
->name
)
9737 || SBYTES (f
->name
) != len
9738 || bcmp (title
, SDATA (f
->name
), len
) != 0)
9739 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9743 #endif /* not HAVE_WINDOW_SYSTEM */
9748 /***********************************************************************
9750 ***********************************************************************/
9753 /* Prepare for redisplay by updating menu-bar item lists when
9754 appropriate. This can call eval. */
9757 prepare_menu_bars ()
9760 struct gcpro gcpro1
, gcpro2
;
9762 Lisp_Object tooltip_frame
;
9764 #ifdef HAVE_WINDOW_SYSTEM
9765 tooltip_frame
= tip_frame
;
9767 tooltip_frame
= Qnil
;
9770 /* Update all frame titles based on their buffer names, etc. We do
9771 this before the menu bars so that the buffer-menu will show the
9772 up-to-date frame titles. */
9773 #ifdef HAVE_WINDOW_SYSTEM
9774 if (windows_or_buffers_changed
|| update_mode_lines
)
9776 Lisp_Object tail
, frame
;
9778 FOR_EACH_FRAME (tail
, frame
)
9781 if (!EQ (frame
, tooltip_frame
)
9782 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9783 x_consider_frame_title (frame
);
9786 #endif /* HAVE_WINDOW_SYSTEM */
9788 /* Update the menu bar item lists, if appropriate. This has to be
9789 done before any actual redisplay or generation of display lines. */
9790 all_windows
= (update_mode_lines
9791 || buffer_shared
> 1
9792 || windows_or_buffers_changed
);
9795 Lisp_Object tail
, frame
;
9796 int count
= SPECPDL_INDEX ();
9797 /* 1 means that update_menu_bar has run its hooks
9798 so any further calls to update_menu_bar shouldn't do so again. */
9799 int menu_bar_hooks_run
= 0;
9801 record_unwind_save_match_data ();
9803 FOR_EACH_FRAME (tail
, frame
)
9807 /* Ignore tooltip frame. */
9808 if (EQ (frame
, tooltip_frame
))
9811 /* If a window on this frame changed size, report that to
9812 the user and clear the size-change flag. */
9813 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9815 Lisp_Object functions
;
9817 /* Clear flag first in case we get an error below. */
9818 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9819 functions
= Vwindow_size_change_functions
;
9820 GCPRO2 (tail
, functions
);
9822 while (CONSP (functions
))
9824 if (!EQ (XCAR (functions
), Qt
))
9825 call1 (XCAR (functions
), frame
);
9826 functions
= XCDR (functions
);
9832 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9833 #ifdef HAVE_WINDOW_SYSTEM
9834 update_tool_bar (f
, 0);
9837 if (windows_or_buffers_changed
)
9838 ns_set_doc_edited (f
, Fbuffer_modified_p
9839 (XWINDOW (f
->selected_window
)->buffer
));
9844 unbind_to (count
, Qnil
);
9848 struct frame
*sf
= SELECTED_FRAME ();
9849 update_menu_bar (sf
, 1, 0);
9850 #ifdef HAVE_WINDOW_SYSTEM
9851 update_tool_bar (sf
, 1);
9855 /* Motif needs this. See comment in xmenu.c. Turn it off when
9856 pending_menu_activation is not defined. */
9857 #ifdef USE_X_TOOLKIT
9858 pending_menu_activation
= 0;
9863 /* Update the menu bar item list for frame F. This has to be done
9864 before we start to fill in any display lines, because it can call
9867 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9869 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9870 already ran the menu bar hooks for this redisplay, so there
9871 is no need to run them again. The return value is the
9872 updated value of this flag, to pass to the next call. */
9875 update_menu_bar (f
, save_match_data
, hooks_run
)
9877 int save_match_data
;
9881 register struct window
*w
;
9883 /* If called recursively during a menu update, do nothing. This can
9884 happen when, for instance, an activate-menubar-hook causes a
9886 if (inhibit_menubar_update
)
9889 window
= FRAME_SELECTED_WINDOW (f
);
9890 w
= XWINDOW (window
);
9892 if (FRAME_WINDOW_P (f
)
9894 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9895 || defined (HAVE_NS) || defined (USE_GTK)
9896 FRAME_EXTERNAL_MENU_BAR (f
)
9898 FRAME_MENU_BAR_LINES (f
) > 0
9900 : FRAME_MENU_BAR_LINES (f
) > 0)
9902 /* If the user has switched buffers or windows, we need to
9903 recompute to reflect the new bindings. But we'll
9904 recompute when update_mode_lines is set too; that means
9905 that people can use force-mode-line-update to request
9906 that the menu bar be recomputed. The adverse effect on
9907 the rest of the redisplay algorithm is about the same as
9908 windows_or_buffers_changed anyway. */
9909 if (windows_or_buffers_changed
9910 /* This used to test w->update_mode_line, but we believe
9911 there is no need to recompute the menu in that case. */
9912 || update_mode_lines
9913 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9914 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9915 != !NILP (w
->last_had_star
))
9916 || ((!NILP (Vtransient_mark_mode
)
9917 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9918 != !NILP (w
->region_showing
)))
9920 struct buffer
*prev
= current_buffer
;
9921 int count
= SPECPDL_INDEX ();
9923 specbind (Qinhibit_menubar_update
, Qt
);
9925 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9926 if (save_match_data
)
9927 record_unwind_save_match_data ();
9928 if (NILP (Voverriding_local_map_menu_flag
))
9930 specbind (Qoverriding_terminal_local_map
, Qnil
);
9931 specbind (Qoverriding_local_map
, Qnil
);
9936 /* Run the Lucid hook. */
9937 safe_run_hooks (Qactivate_menubar_hook
);
9939 /* If it has changed current-menubar from previous value,
9940 really recompute the menu-bar from the value. */
9941 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9942 call0 (Qrecompute_lucid_menubar
);
9944 safe_run_hooks (Qmenu_bar_update_hook
);
9949 XSETFRAME (Vmenu_updating_frame
, f
);
9950 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9952 /* Redisplay the menu bar in case we changed it. */
9953 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9954 || defined (HAVE_NS) || defined (USE_GTK)
9955 if (FRAME_WINDOW_P (f
))
9957 #if defined (HAVE_NS)
9958 /* All frames on Mac OS share the same menubar. So only
9959 the selected frame should be allowed to set it. */
9960 if (f
== SELECTED_FRAME ())
9962 set_frame_menubar (f
, 0, 0);
9965 /* On a terminal screen, the menu bar is an ordinary screen
9966 line, and this makes it get updated. */
9967 w
->update_mode_line
= Qt
;
9968 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9969 /* In the non-toolkit version, the menu bar is an ordinary screen
9970 line, and this makes it get updated. */
9971 w
->update_mode_line
= Qt
;
9972 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9974 unbind_to (count
, Qnil
);
9975 set_buffer_internal_1 (prev
);
9984 /***********************************************************************
9986 ***********************************************************************/
9988 #ifdef HAVE_WINDOW_SYSTEM
9991 Nominal cursor position -- where to draw output.
9992 HPOS and VPOS are window relative glyph matrix coordinates.
9993 X and Y are window relative pixel coordinates. */
9995 struct cursor_pos output_cursor
;
9999 Set the global variable output_cursor to CURSOR. All cursor
10000 positions are relative to updated_window. */
10003 set_output_cursor (cursor
)
10004 struct cursor_pos
*cursor
;
10006 output_cursor
.hpos
= cursor
->hpos
;
10007 output_cursor
.vpos
= cursor
->vpos
;
10008 output_cursor
.x
= cursor
->x
;
10009 output_cursor
.y
= cursor
->y
;
10014 Set a nominal cursor position.
10016 HPOS and VPOS are column/row positions in a window glyph matrix. X
10017 and Y are window text area relative pixel positions.
10019 If this is done during an update, updated_window will contain the
10020 window that is being updated and the position is the future output
10021 cursor position for that window. If updated_window is null, use
10022 selected_window and display the cursor at the given position. */
10025 x_cursor_to (vpos
, hpos
, y
, x
)
10026 int vpos
, hpos
, y
, x
;
10030 /* If updated_window is not set, work on selected_window. */
10031 if (updated_window
)
10032 w
= updated_window
;
10034 w
= XWINDOW (selected_window
);
10036 /* Set the output cursor. */
10037 output_cursor
.hpos
= hpos
;
10038 output_cursor
.vpos
= vpos
;
10039 output_cursor
.x
= x
;
10040 output_cursor
.y
= y
;
10042 /* If not called as part of an update, really display the cursor.
10043 This will also set the cursor position of W. */
10044 if (updated_window
== NULL
)
10047 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
10048 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
10049 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
10054 #endif /* HAVE_WINDOW_SYSTEM */
10057 /***********************************************************************
10059 ***********************************************************************/
10061 #ifdef HAVE_WINDOW_SYSTEM
10063 /* Where the mouse was last time we reported a mouse event. */
10065 FRAME_PTR last_mouse_frame
;
10067 /* Tool-bar item index of the item on which a mouse button was pressed
10070 int last_tool_bar_item
;
10074 update_tool_bar_unwind (frame
)
10077 selected_frame
= frame
;
10081 /* Update the tool-bar item list for frame F. This has to be done
10082 before we start to fill in any display lines. Called from
10083 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
10084 and restore it here. */
10087 update_tool_bar (f
, save_match_data
)
10089 int save_match_data
;
10091 #if defined (USE_GTK) || defined (HAVE_NS)
10092 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10094 int do_update
= WINDOWP (f
->tool_bar_window
)
10095 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10100 Lisp_Object window
;
10103 window
= FRAME_SELECTED_WINDOW (f
);
10104 w
= XWINDOW (window
);
10106 /* If the user has switched buffers or windows, we need to
10107 recompute to reflect the new bindings. But we'll
10108 recompute when update_mode_lines is set too; that means
10109 that people can use force-mode-line-update to request
10110 that the menu bar be recomputed. The adverse effect on
10111 the rest of the redisplay algorithm is about the same as
10112 windows_or_buffers_changed anyway. */
10113 if (windows_or_buffers_changed
10114 || !NILP (w
->update_mode_line
)
10115 || update_mode_lines
10116 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10117 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10118 != !NILP (w
->last_had_star
))
10119 || ((!NILP (Vtransient_mark_mode
)
10120 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
10121 != !NILP (w
->region_showing
)))
10123 struct buffer
*prev
= current_buffer
;
10124 int count
= SPECPDL_INDEX ();
10125 Lisp_Object frame
, new_tool_bar
;
10126 int new_n_tool_bar
;
10127 struct gcpro gcpro1
;
10129 /* Set current_buffer to the buffer of the selected
10130 window of the frame, so that we get the right local
10132 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10134 /* Save match data, if we must. */
10135 if (save_match_data
)
10136 record_unwind_save_match_data ();
10138 /* Make sure that we don't accidentally use bogus keymaps. */
10139 if (NILP (Voverriding_local_map_menu_flag
))
10141 specbind (Qoverriding_terminal_local_map
, Qnil
);
10142 specbind (Qoverriding_local_map
, Qnil
);
10145 GCPRO1 (new_tool_bar
);
10147 /* We must temporarily set the selected frame to this frame
10148 before calling tool_bar_items, because the calculation of
10149 the tool-bar keymap uses the selected frame (see
10150 `tool-bar-make-keymap' in tool-bar.el). */
10151 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10152 XSETFRAME (frame
, f
);
10153 selected_frame
= frame
;
10155 /* Build desired tool-bar items from keymaps. */
10156 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10159 /* Redisplay the tool-bar if we changed it. */
10160 if (new_n_tool_bar
!= f
->n_tool_bar_items
10161 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10163 /* Redisplay that happens asynchronously due to an expose event
10164 may access f->tool_bar_items. Make sure we update both
10165 variables within BLOCK_INPUT so no such event interrupts. */
10167 f
->tool_bar_items
= new_tool_bar
;
10168 f
->n_tool_bar_items
= new_n_tool_bar
;
10169 w
->update_mode_line
= Qt
;
10175 unbind_to (count
, Qnil
);
10176 set_buffer_internal_1 (prev
);
10182 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10183 F's desired tool-bar contents. F->tool_bar_items must have
10184 been set up previously by calling prepare_menu_bars. */
10187 build_desired_tool_bar_string (f
)
10190 int i
, size
, size_needed
;
10191 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10192 Lisp_Object image
, plist
, props
;
10194 image
= plist
= props
= Qnil
;
10195 GCPRO3 (image
, plist
, props
);
10197 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10198 Otherwise, make a new string. */
10200 /* The size of the string we might be able to reuse. */
10201 size
= (STRINGP (f
->desired_tool_bar_string
)
10202 ? SCHARS (f
->desired_tool_bar_string
)
10205 /* We need one space in the string for each image. */
10206 size_needed
= f
->n_tool_bar_items
;
10208 /* Reuse f->desired_tool_bar_string, if possible. */
10209 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10210 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10211 make_number (' '));
10214 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10215 Fremove_text_properties (make_number (0), make_number (size
),
10216 props
, f
->desired_tool_bar_string
);
10219 /* Put a `display' property on the string for the images to display,
10220 put a `menu_item' property on tool-bar items with a value that
10221 is the index of the item in F's tool-bar item vector. */
10222 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10224 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10226 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10227 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10228 int hmargin
, vmargin
, relief
, idx
, end
;
10229 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
;
10231 /* If image is a vector, choose the image according to the
10233 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10234 if (VECTORP (image
))
10238 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10239 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10242 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10243 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10245 xassert (ASIZE (image
) >= idx
);
10246 image
= AREF (image
, idx
);
10251 /* Ignore invalid image specifications. */
10252 if (!valid_image_p (image
))
10255 /* Display the tool-bar button pressed, or depressed. */
10256 plist
= Fcopy_sequence (XCDR (image
));
10258 /* Compute margin and relief to draw. */
10259 relief
= (tool_bar_button_relief
>= 0
10260 ? tool_bar_button_relief
10261 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10262 hmargin
= vmargin
= relief
;
10264 if (INTEGERP (Vtool_bar_button_margin
)
10265 && XINT (Vtool_bar_button_margin
) > 0)
10267 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10268 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10270 else if (CONSP (Vtool_bar_button_margin
))
10272 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10273 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10274 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10276 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10277 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10278 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10281 if (auto_raise_tool_bar_buttons_p
)
10283 /* Add a `:relief' property to the image spec if the item is
10287 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10294 /* If image is selected, display it pressed, i.e. with a
10295 negative relief. If it's not selected, display it with a
10297 plist
= Fplist_put (plist
, QCrelief
,
10299 ? make_number (-relief
)
10300 : make_number (relief
)));
10305 /* Put a margin around the image. */
10306 if (hmargin
|| vmargin
)
10308 if (hmargin
== vmargin
)
10309 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10311 plist
= Fplist_put (plist
, QCmargin
,
10312 Fcons (make_number (hmargin
),
10313 make_number (vmargin
)));
10316 /* If button is not enabled, and we don't have special images
10317 for the disabled state, make the image appear disabled by
10318 applying an appropriate algorithm to it. */
10319 if (!enabled_p
&& idx
< 0)
10320 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10322 /* Put a `display' text property on the string for the image to
10323 display. Put a `menu-item' property on the string that gives
10324 the start of this item's properties in the tool-bar items
10326 image
= Fcons (Qimage
, plist
);
10327 props
= list4 (Qdisplay
, image
,
10328 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10330 /* Let the last image hide all remaining spaces in the tool bar
10331 string. The string can be longer than needed when we reuse a
10332 previous string. */
10333 if (i
+ 1 == f
->n_tool_bar_items
)
10334 end
= SCHARS (f
->desired_tool_bar_string
);
10337 Fadd_text_properties (make_number (i
), make_number (end
),
10338 props
, f
->desired_tool_bar_string
);
10346 /* Display one line of the tool-bar of frame IT->f.
10348 HEIGHT specifies the desired height of the tool-bar line.
10349 If the actual height of the glyph row is less than HEIGHT, the
10350 row's height is increased to HEIGHT, and the icons are centered
10351 vertically in the new height.
10353 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10354 count a final empty row in case the tool-bar width exactly matches
10359 display_tool_bar_line (it
, height
)
10363 struct glyph_row
*row
= it
->glyph_row
;
10364 int max_x
= it
->last_visible_x
;
10365 struct glyph
*last
;
10367 prepare_desired_row (row
);
10368 row
->y
= it
->current_y
;
10370 /* Note that this isn't made use of if the face hasn't a box,
10371 so there's no need to check the face here. */
10372 it
->start_of_box_run_p
= 1;
10374 while (it
->current_x
< max_x
)
10376 int x
, n_glyphs_before
, i
, nglyphs
;
10377 struct it it_before
;
10379 /* Get the next display element. */
10380 if (!get_next_display_element (it
))
10382 /* Don't count empty row if we are counting needed tool-bar lines. */
10383 if (height
< 0 && !it
->hpos
)
10388 /* Produce glyphs. */
10389 n_glyphs_before
= row
->used
[TEXT_AREA
];
10392 PRODUCE_GLYPHS (it
);
10394 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10396 x
= it_before
.current_x
;
10397 while (i
< nglyphs
)
10399 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10401 if (x
+ glyph
->pixel_width
> max_x
)
10403 /* Glyph doesn't fit on line. Backtrack. */
10404 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10406 /* If this is the only glyph on this line, it will never fit on the
10407 toolbar, so skip it. But ensure there is at least one glyph,
10408 so we don't accidentally disable the tool-bar. */
10409 if (n_glyphs_before
== 0
10410 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10416 x
+= glyph
->pixel_width
;
10420 /* Stop at line ends. */
10421 if (ITERATOR_AT_END_OF_LINE_P (it
))
10424 set_iterator_to_next (it
, 1);
10429 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10431 /* Use default face for the border below the tool bar.
10433 FIXME: When auto-resize-tool-bars is grow-only, there is
10434 no additional border below the possibly empty tool-bar lines.
10435 So to make the extra empty lines look "normal", we have to
10436 use the tool-bar face for the border too. */
10437 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10438 it
->face_id
= DEFAULT_FACE_ID
;
10440 extend_face_to_end_of_line (it
);
10441 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10442 last
->right_box_line_p
= 1;
10443 if (last
== row
->glyphs
[TEXT_AREA
])
10444 last
->left_box_line_p
= 1;
10446 /* Make line the desired height and center it vertically. */
10447 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10449 /* Don't add more than one line height. */
10450 height
%= FRAME_LINE_HEIGHT (it
->f
);
10451 it
->max_ascent
+= height
/ 2;
10452 it
->max_descent
+= (height
+ 1) / 2;
10455 compute_line_metrics (it
);
10457 /* If line is empty, make it occupy the rest of the tool-bar. */
10458 if (!row
->displays_text_p
)
10460 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10461 row
->visible_height
= row
->height
;
10462 row
->ascent
= row
->phys_ascent
= 0;
10463 row
->extra_line_spacing
= 0;
10466 row
->full_width_p
= 1;
10467 row
->continued_p
= 0;
10468 row
->truncated_on_left_p
= 0;
10469 row
->truncated_on_right_p
= 0;
10471 it
->current_x
= it
->hpos
= 0;
10472 it
->current_y
+= row
->height
;
10478 /* Max tool-bar height. */
10480 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10481 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10483 /* Value is the number of screen lines needed to make all tool-bar
10484 items of frame F visible. The number of actual rows needed is
10485 returned in *N_ROWS if non-NULL. */
10488 tool_bar_lines_needed (f
, n_rows
)
10492 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10494 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10495 the desired matrix, so use (unused) mode-line row as temporary row to
10496 avoid destroying the first tool-bar row. */
10497 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10499 /* Initialize an iterator for iteration over
10500 F->desired_tool_bar_string in the tool-bar window of frame F. */
10501 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10502 it
.first_visible_x
= 0;
10503 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10504 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10506 while (!ITERATOR_AT_END_P (&it
))
10508 clear_glyph_row (temp_row
);
10509 it
.glyph_row
= temp_row
;
10510 display_tool_bar_line (&it
, -1);
10512 clear_glyph_row (temp_row
);
10514 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10516 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10518 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10522 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10524 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10533 frame
= selected_frame
;
10535 CHECK_FRAME (frame
);
10536 f
= XFRAME (frame
);
10538 if (WINDOWP (f
->tool_bar_window
)
10539 || (w
= XWINDOW (f
->tool_bar_window
),
10540 WINDOW_TOTAL_LINES (w
) > 0))
10542 update_tool_bar (f
, 1);
10543 if (f
->n_tool_bar_items
)
10545 build_desired_tool_bar_string (f
);
10546 nlines
= tool_bar_lines_needed (f
, NULL
);
10550 return make_number (nlines
);
10554 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10555 height should be changed. */
10558 redisplay_tool_bar (f
)
10563 struct glyph_row
*row
;
10565 #if defined (USE_GTK) || defined (HAVE_NS)
10566 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10567 update_frame_tool_bar (f
);
10571 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10572 do anything. This means you must start with tool-bar-lines
10573 non-zero to get the auto-sizing effect. Or in other words, you
10574 can turn off tool-bars by specifying tool-bar-lines zero. */
10575 if (!WINDOWP (f
->tool_bar_window
)
10576 || (w
= XWINDOW (f
->tool_bar_window
),
10577 WINDOW_TOTAL_LINES (w
) == 0))
10580 /* Set up an iterator for the tool-bar window. */
10581 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10582 it
.first_visible_x
= 0;
10583 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10584 row
= it
.glyph_row
;
10586 /* Build a string that represents the contents of the tool-bar. */
10587 build_desired_tool_bar_string (f
);
10588 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10590 if (f
->n_tool_bar_rows
== 0)
10594 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10595 nlines
!= WINDOW_TOTAL_LINES (w
)))
10597 extern Lisp_Object Qtool_bar_lines
;
10599 int old_height
= WINDOW_TOTAL_LINES (w
);
10601 XSETFRAME (frame
, f
);
10602 Fmodify_frame_parameters (frame
,
10603 Fcons (Fcons (Qtool_bar_lines
,
10604 make_number (nlines
)),
10606 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10608 clear_glyph_matrix (w
->desired_matrix
);
10609 fonts_changed_p
= 1;
10615 /* Display as many lines as needed to display all tool-bar items. */
10617 if (f
->n_tool_bar_rows
> 0)
10619 int border
, rows
, height
, extra
;
10621 if (INTEGERP (Vtool_bar_border
))
10622 border
= XINT (Vtool_bar_border
);
10623 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10624 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10625 else if (EQ (Vtool_bar_border
, Qborder_width
))
10626 border
= f
->border_width
;
10632 rows
= f
->n_tool_bar_rows
;
10633 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10634 extra
= it
.last_visible_y
- border
- height
* rows
;
10636 while (it
.current_y
< it
.last_visible_y
)
10639 if (extra
> 0 && rows
-- > 0)
10641 h
= (extra
+ rows
- 1) / rows
;
10644 display_tool_bar_line (&it
, height
+ h
);
10649 while (it
.current_y
< it
.last_visible_y
)
10650 display_tool_bar_line (&it
, 0);
10653 /* It doesn't make much sense to try scrolling in the tool-bar
10654 window, so don't do it. */
10655 w
->desired_matrix
->no_scrolling_p
= 1;
10656 w
->must_be_updated_p
= 1;
10658 if (!NILP (Vauto_resize_tool_bars
))
10660 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10661 int change_height_p
= 0;
10663 /* If we couldn't display everything, change the tool-bar's
10664 height if there is room for more. */
10665 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10666 && it
.current_y
< max_tool_bar_height
)
10667 change_height_p
= 1;
10669 row
= it
.glyph_row
- 1;
10671 /* If there are blank lines at the end, except for a partially
10672 visible blank line at the end that is smaller than
10673 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10674 if (!row
->displays_text_p
10675 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10676 change_height_p
= 1;
10678 /* If row displays tool-bar items, but is partially visible,
10679 change the tool-bar's height. */
10680 if (row
->displays_text_p
10681 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10682 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10683 change_height_p
= 1;
10685 /* Resize windows as needed by changing the `tool-bar-lines'
10686 frame parameter. */
10687 if (change_height_p
)
10689 extern Lisp_Object Qtool_bar_lines
;
10691 int old_height
= WINDOW_TOTAL_LINES (w
);
10693 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10695 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10696 && !f
->minimize_tool_bar_window_p
)
10697 ? (nlines
> old_height
)
10698 : (nlines
!= old_height
));
10699 f
->minimize_tool_bar_window_p
= 0;
10701 if (change_height_p
)
10703 XSETFRAME (frame
, f
);
10704 Fmodify_frame_parameters (frame
,
10705 Fcons (Fcons (Qtool_bar_lines
,
10706 make_number (nlines
)),
10708 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10710 clear_glyph_matrix (w
->desired_matrix
);
10711 f
->n_tool_bar_rows
= nrows
;
10712 fonts_changed_p
= 1;
10719 f
->minimize_tool_bar_window_p
= 0;
10724 /* Get information about the tool-bar item which is displayed in GLYPH
10725 on frame F. Return in *PROP_IDX the index where tool-bar item
10726 properties start in F->tool_bar_items. Value is zero if
10727 GLYPH doesn't display a tool-bar item. */
10730 tool_bar_item_info (f
, glyph
, prop_idx
)
10732 struct glyph
*glyph
;
10739 /* This function can be called asynchronously, which means we must
10740 exclude any possibility that Fget_text_property signals an
10742 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10743 charpos
= max (0, charpos
);
10745 /* Get the text property `menu-item' at pos. The value of that
10746 property is the start index of this item's properties in
10747 F->tool_bar_items. */
10748 prop
= Fget_text_property (make_number (charpos
),
10749 Qmenu_item
, f
->current_tool_bar_string
);
10750 if (INTEGERP (prop
))
10752 *prop_idx
= XINT (prop
);
10762 /* Get information about the tool-bar item at position X/Y on frame F.
10763 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10764 the current matrix of the tool-bar window of F, or NULL if not
10765 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10766 item in F->tool_bar_items. Value is
10768 -1 if X/Y is not on a tool-bar item
10769 0 if X/Y is on the same item that was highlighted before.
10773 get_tool_bar_item (f
, x
, y
, glyph
, hpos
, vpos
, prop_idx
)
10776 struct glyph
**glyph
;
10777 int *hpos
, *vpos
, *prop_idx
;
10779 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10780 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10783 /* Find the glyph under X/Y. */
10784 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10785 if (*glyph
== NULL
)
10788 /* Get the start of this tool-bar item's properties in
10789 f->tool_bar_items. */
10790 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10793 /* Is mouse on the highlighted item? */
10794 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
10795 && *vpos
>= dpyinfo
->mouse_face_beg_row
10796 && *vpos
<= dpyinfo
->mouse_face_end_row
10797 && (*vpos
> dpyinfo
->mouse_face_beg_row
10798 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
10799 && (*vpos
< dpyinfo
->mouse_face_end_row
10800 || *hpos
< dpyinfo
->mouse_face_end_col
10801 || dpyinfo
->mouse_face_past_end
))
10809 Handle mouse button event on the tool-bar of frame F, at
10810 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10811 0 for button release. MODIFIERS is event modifiers for button
10815 handle_tool_bar_click (f
, x
, y
, down_p
, modifiers
)
10818 unsigned int modifiers
;
10820 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10821 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10822 int hpos
, vpos
, prop_idx
;
10823 struct glyph
*glyph
;
10824 Lisp_Object enabled_p
;
10826 /* If not on the highlighted tool-bar item, return. */
10827 frame_to_window_pixel_xy (w
, &x
, &y
);
10828 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10831 /* If item is disabled, do nothing. */
10832 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10833 if (NILP (enabled_p
))
10838 /* Show item in pressed state. */
10839 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
10840 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10841 last_tool_bar_item
= prop_idx
;
10845 Lisp_Object key
, frame
;
10846 struct input_event event
;
10847 EVENT_INIT (event
);
10849 /* Show item in released state. */
10850 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
10851 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10853 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10855 XSETFRAME (frame
, f
);
10856 event
.kind
= TOOL_BAR_EVENT
;
10857 event
.frame_or_window
= frame
;
10859 kbd_buffer_store_event (&event
);
10861 event
.kind
= TOOL_BAR_EVENT
;
10862 event
.frame_or_window
= frame
;
10864 event
.modifiers
= modifiers
;
10865 kbd_buffer_store_event (&event
);
10866 last_tool_bar_item
= -1;
10871 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10872 tool-bar window-relative coordinates X/Y. Called from
10873 note_mouse_highlight. */
10876 note_tool_bar_highlight (f
, x
, y
)
10880 Lisp_Object window
= f
->tool_bar_window
;
10881 struct window
*w
= XWINDOW (window
);
10882 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10884 struct glyph
*glyph
;
10885 struct glyph_row
*row
;
10887 Lisp_Object enabled_p
;
10889 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10890 int mouse_down_p
, rc
;
10892 /* Function note_mouse_highlight is called with negative x(y
10893 values when mouse moves outside of the frame. */
10894 if (x
<= 0 || y
<= 0)
10896 clear_mouse_face (dpyinfo
);
10900 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10903 /* Not on tool-bar item. */
10904 clear_mouse_face (dpyinfo
);
10908 /* On same tool-bar item as before. */
10909 goto set_help_echo
;
10911 clear_mouse_face (dpyinfo
);
10913 /* Mouse is down, but on different tool-bar item? */
10914 mouse_down_p
= (dpyinfo
->grabbed
10915 && f
== last_mouse_frame
10916 && FRAME_LIVE_P (f
));
10918 && last_tool_bar_item
!= prop_idx
)
10921 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10922 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10924 /* If tool-bar item is not enabled, don't highlight it. */
10925 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10926 if (!NILP (enabled_p
))
10928 /* Compute the x-position of the glyph. In front and past the
10929 image is a space. We include this in the highlighted area. */
10930 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10931 for (i
= x
= 0; i
< hpos
; ++i
)
10932 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10934 /* Record this as the current active region. */
10935 dpyinfo
->mouse_face_beg_col
= hpos
;
10936 dpyinfo
->mouse_face_beg_row
= vpos
;
10937 dpyinfo
->mouse_face_beg_x
= x
;
10938 dpyinfo
->mouse_face_beg_y
= row
->y
;
10939 dpyinfo
->mouse_face_past_end
= 0;
10941 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
10942 dpyinfo
->mouse_face_end_row
= vpos
;
10943 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10944 dpyinfo
->mouse_face_end_y
= row
->y
;
10945 dpyinfo
->mouse_face_window
= window
;
10946 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10948 /* Display it as active. */
10949 show_mouse_face (dpyinfo
, draw
);
10950 dpyinfo
->mouse_face_image_state
= draw
;
10955 /* Set help_echo_string to a help string to display for this tool-bar item.
10956 XTread_socket does the rest. */
10957 help_echo_object
= help_echo_window
= Qnil
;
10958 help_echo_pos
= -1;
10959 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10960 if (NILP (help_echo_string
))
10961 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10964 #endif /* HAVE_WINDOW_SYSTEM */
10968 /************************************************************************
10969 Horizontal scrolling
10970 ************************************************************************/
10972 static int hscroll_window_tree
P_ ((Lisp_Object
));
10973 static int hscroll_windows
P_ ((Lisp_Object
));
10975 /* For all leaf windows in the window tree rooted at WINDOW, set their
10976 hscroll value so that PT is (i) visible in the window, and (ii) so
10977 that it is not within a certain margin at the window's left and
10978 right border. Value is non-zero if any window's hscroll has been
10982 hscroll_window_tree (window
)
10983 Lisp_Object window
;
10985 int hscrolled_p
= 0;
10986 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10987 int hscroll_step_abs
= 0;
10988 double hscroll_step_rel
= 0;
10990 if (hscroll_relative_p
)
10992 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10993 if (hscroll_step_rel
< 0)
10995 hscroll_relative_p
= 0;
10996 hscroll_step_abs
= 0;
10999 else if (INTEGERP (Vhscroll_step
))
11001 hscroll_step_abs
= XINT (Vhscroll_step
);
11002 if (hscroll_step_abs
< 0)
11003 hscroll_step_abs
= 0;
11006 hscroll_step_abs
= 0;
11008 while (WINDOWP (window
))
11010 struct window
*w
= XWINDOW (window
);
11012 if (WINDOWP (w
->hchild
))
11013 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
11014 else if (WINDOWP (w
->vchild
))
11015 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
11016 else if (w
->cursor
.vpos
>= 0)
11019 int text_area_width
;
11020 struct glyph_row
*current_cursor_row
11021 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
11022 struct glyph_row
*desired_cursor_row
11023 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
11024 struct glyph_row
*cursor_row
11025 = (desired_cursor_row
->enabled_p
11026 ? desired_cursor_row
11027 : current_cursor_row
);
11029 text_area_width
= window_box_width (w
, TEXT_AREA
);
11031 /* Scroll when cursor is inside this scroll margin. */
11032 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
11034 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
11035 && ((XFASTINT (w
->hscroll
)
11036 && w
->cursor
.x
<= h_margin
)
11037 || (cursor_row
->enabled_p
11038 && cursor_row
->truncated_on_right_p
11039 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
11043 struct buffer
*saved_current_buffer
;
11047 /* Find point in a display of infinite width. */
11048 saved_current_buffer
= current_buffer
;
11049 current_buffer
= XBUFFER (w
->buffer
);
11051 if (w
== XWINDOW (selected_window
))
11052 pt
= BUF_PT (current_buffer
);
11055 pt
= marker_position (w
->pointm
);
11056 pt
= max (BEGV
, pt
);
11060 /* Move iterator to pt starting at cursor_row->start in
11061 a line with infinite width. */
11062 init_to_row_start (&it
, w
, cursor_row
);
11063 it
.last_visible_x
= INFINITY
;
11064 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11065 current_buffer
= saved_current_buffer
;
11067 /* Position cursor in window. */
11068 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11069 hscroll
= max (0, (it
.current_x
11070 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11071 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11072 : (text_area_width
/ 2))))
11073 / FRAME_COLUMN_WIDTH (it
.f
);
11074 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11076 if (hscroll_relative_p
)
11077 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11080 wanted_x
= text_area_width
11081 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11084 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11088 if (hscroll_relative_p
)
11089 wanted_x
= text_area_width
* hscroll_step_rel
11092 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11095 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11097 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11099 /* Don't call Fset_window_hscroll if value hasn't
11100 changed because it will prevent redisplay
11102 if (XFASTINT (w
->hscroll
) != hscroll
)
11104 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11105 w
->hscroll
= make_number (hscroll
);
11114 /* Value is non-zero if hscroll of any leaf window has been changed. */
11115 return hscrolled_p
;
11119 /* Set hscroll so that cursor is visible and not inside horizontal
11120 scroll margins for all windows in the tree rooted at WINDOW. See
11121 also hscroll_window_tree above. Value is non-zero if any window's
11122 hscroll has been changed. If it has, desired matrices on the frame
11123 of WINDOW are cleared. */
11126 hscroll_windows (window
)
11127 Lisp_Object window
;
11129 int hscrolled_p
= hscroll_window_tree (window
);
11131 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11132 return hscrolled_p
;
11137 /************************************************************************
11139 ************************************************************************/
11141 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11142 to a non-zero value. This is sometimes handy to have in a debugger
11147 /* First and last unchanged row for try_window_id. */
11149 int debug_first_unchanged_at_end_vpos
;
11150 int debug_last_unchanged_at_beg_vpos
;
11152 /* Delta vpos and y. */
11154 int debug_dvpos
, debug_dy
;
11156 /* Delta in characters and bytes for try_window_id. */
11158 int debug_delta
, debug_delta_bytes
;
11160 /* Values of window_end_pos and window_end_vpos at the end of
11163 EMACS_INT debug_end_pos
, debug_end_vpos
;
11165 /* Append a string to W->desired_matrix->method. FMT is a printf
11166 format string. A1...A9 are a supplement for a variable-length
11167 argument list. If trace_redisplay_p is non-zero also printf the
11168 resulting string to stderr. */
11171 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11174 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11177 char *method
= w
->desired_matrix
->method
;
11178 int len
= strlen (method
);
11179 int size
= sizeof w
->desired_matrix
->method
;
11180 int remaining
= size
- len
- 1;
11182 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11183 if (len
&& remaining
)
11186 --remaining
, ++len
;
11189 strncpy (method
+ len
, buffer
, remaining
);
11191 if (trace_redisplay_p
)
11192 fprintf (stderr
, "%p (%s): %s\n",
11194 ((BUFFERP (w
->buffer
)
11195 && STRINGP (XBUFFER (w
->buffer
)->name
))
11196 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
11201 #endif /* GLYPH_DEBUG */
11204 /* Value is non-zero if all changes in window W, which displays
11205 current_buffer, are in the text between START and END. START is a
11206 buffer position, END is given as a distance from Z. Used in
11207 redisplay_internal for display optimization. */
11210 text_outside_line_unchanged_p (w
, start
, end
)
11214 int unchanged_p
= 1;
11216 /* If text or overlays have changed, see where. */
11217 if (XFASTINT (w
->last_modified
) < MODIFF
11218 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11220 /* Gap in the line? */
11221 if (GPT
< start
|| Z
- GPT
< end
)
11224 /* Changes start in front of the line, or end after it? */
11226 && (BEG_UNCHANGED
< start
- 1
11227 || END_UNCHANGED
< end
))
11230 /* If selective display, can't optimize if changes start at the
11231 beginning of the line. */
11233 && INTEGERP (current_buffer
->selective_display
)
11234 && XINT (current_buffer
->selective_display
) > 0
11235 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11238 /* If there are overlays at the start or end of the line, these
11239 may have overlay strings with newlines in them. A change at
11240 START, for instance, may actually concern the display of such
11241 overlay strings as well, and they are displayed on different
11242 lines. So, quickly rule out this case. (For the future, it
11243 might be desirable to implement something more telling than
11244 just BEG/END_UNCHANGED.) */
11247 if (BEG
+ BEG_UNCHANGED
== start
11248 && overlay_touches_p (start
))
11250 if (END_UNCHANGED
== end
11251 && overlay_touches_p (Z
- end
))
11255 /* Under bidi reordering, adding or deleting a character in the
11256 beginning of a paragraph, before the first strong directional
11257 character, can change the base direction of the paragraph (unless
11258 the buffer specifies a fixed paragraph direction), which will
11259 require to redisplay the whole paragraph. It might be worthwhile
11260 to find the paragraph limits and widen the range of redisplayed
11261 lines to that, but for now just give up this optimization. */
11262 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
11263 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
11267 return unchanged_p
;
11271 /* Do a frame update, taking possible shortcuts into account. This is
11272 the main external entry point for redisplay.
11274 If the last redisplay displayed an echo area message and that message
11275 is no longer requested, we clear the echo area or bring back the
11276 mini-buffer if that is in use. */
11281 redisplay_internal (0);
11286 overlay_arrow_string_or_property (var
)
11291 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11294 return Voverlay_arrow_string
;
11297 /* Return 1 if there are any overlay-arrows in current_buffer. */
11299 overlay_arrow_in_current_buffer_p ()
11303 for (vlist
= Voverlay_arrow_variable_list
;
11305 vlist
= XCDR (vlist
))
11307 Lisp_Object var
= XCAR (vlist
);
11310 if (!SYMBOLP (var
))
11312 val
= find_symbol_value (var
);
11314 && current_buffer
== XMARKER (val
)->buffer
)
11321 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11325 overlay_arrows_changed_p ()
11329 for (vlist
= Voverlay_arrow_variable_list
;
11331 vlist
= XCDR (vlist
))
11333 Lisp_Object var
= XCAR (vlist
);
11334 Lisp_Object val
, pstr
;
11336 if (!SYMBOLP (var
))
11338 val
= find_symbol_value (var
);
11339 if (!MARKERP (val
))
11341 if (! EQ (COERCE_MARKER (val
),
11342 Fget (var
, Qlast_arrow_position
))
11343 || ! (pstr
= overlay_arrow_string_or_property (var
),
11344 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11350 /* Mark overlay arrows to be updated on next redisplay. */
11353 update_overlay_arrows (up_to_date
)
11358 for (vlist
= Voverlay_arrow_variable_list
;
11360 vlist
= XCDR (vlist
))
11362 Lisp_Object var
= XCAR (vlist
);
11364 if (!SYMBOLP (var
))
11367 if (up_to_date
> 0)
11369 Lisp_Object val
= find_symbol_value (var
);
11370 Fput (var
, Qlast_arrow_position
,
11371 COERCE_MARKER (val
));
11372 Fput (var
, Qlast_arrow_string
,
11373 overlay_arrow_string_or_property (var
));
11375 else if (up_to_date
< 0
11376 || !NILP (Fget (var
, Qlast_arrow_position
)))
11378 Fput (var
, Qlast_arrow_position
, Qt
);
11379 Fput (var
, Qlast_arrow_string
, Qt
);
11385 /* Return overlay arrow string to display at row.
11386 Return integer (bitmap number) for arrow bitmap in left fringe.
11387 Return nil if no overlay arrow. */
11390 overlay_arrow_at_row (it
, row
)
11392 struct glyph_row
*row
;
11396 for (vlist
= Voverlay_arrow_variable_list
;
11398 vlist
= XCDR (vlist
))
11400 Lisp_Object var
= XCAR (vlist
);
11403 if (!SYMBOLP (var
))
11406 val
= find_symbol_value (var
);
11409 && current_buffer
== XMARKER (val
)->buffer
11410 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11412 if (FRAME_WINDOW_P (it
->f
)
11413 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11415 #ifdef HAVE_WINDOW_SYSTEM
11416 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11419 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11420 return make_number (fringe_bitmap
);
11423 return make_number (-1); /* Use default arrow bitmap */
11425 return overlay_arrow_string_or_property (var
);
11432 /* Return 1 if point moved out of or into a composition. Otherwise
11433 return 0. PREV_BUF and PREV_PT are the last point buffer and
11434 position. BUF and PT are the current point buffer and position. */
11437 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
11438 struct buffer
*prev_buf
, *buf
;
11441 EMACS_INT start
, end
;
11443 Lisp_Object buffer
;
11445 XSETBUFFER (buffer
, buf
);
11446 /* Check a composition at the last point if point moved within the
11448 if (prev_buf
== buf
)
11451 /* Point didn't move. */
11454 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11455 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11456 && COMPOSITION_VALID_P (start
, end
, prop
)
11457 && start
< prev_pt
&& end
> prev_pt
)
11458 /* The last point was within the composition. Return 1 iff
11459 point moved out of the composition. */
11460 return (pt
<= start
|| pt
>= end
);
11463 /* Check a composition at the current point. */
11464 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11465 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11466 && COMPOSITION_VALID_P (start
, end
, prop
)
11467 && start
< pt
&& end
> pt
);
11471 /* Reconsider the setting of B->clip_changed which is displayed
11475 reconsider_clip_changes (w
, b
)
11479 if (b
->clip_changed
11480 && !NILP (w
->window_end_valid
)
11481 && w
->current_matrix
->buffer
== b
11482 && w
->current_matrix
->zv
== BUF_ZV (b
)
11483 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11484 b
->clip_changed
= 0;
11486 /* If display wasn't paused, and W is not a tool bar window, see if
11487 point has been moved into or out of a composition. In that case,
11488 we set b->clip_changed to 1 to force updating the screen. If
11489 b->clip_changed has already been set to 1, we can skip this
11491 if (!b
->clip_changed
11492 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11496 if (w
== XWINDOW (selected_window
))
11497 pt
= BUF_PT (current_buffer
);
11499 pt
= marker_position (w
->pointm
);
11501 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11502 || pt
!= XINT (w
->last_point
))
11503 && check_point_in_composition (w
->current_matrix
->buffer
,
11504 XINT (w
->last_point
),
11505 XBUFFER (w
->buffer
), pt
))
11506 b
->clip_changed
= 1;
11511 /* Select FRAME to forward the values of frame-local variables into C
11512 variables so that the redisplay routines can access those values
11516 select_frame_for_redisplay (frame
)
11519 Lisp_Object tail
, symbol
, val
;
11520 Lisp_Object old
= selected_frame
;
11521 struct Lisp_Symbol
*sym
;
11523 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11525 selected_frame
= frame
;
11529 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11530 if (CONSP (XCAR (tail
))
11531 && (symbol
= XCAR (XCAR (tail
)),
11533 && (sym
= indirect_variable (XSYMBOL (symbol
)),
11535 (BUFFER_LOCAL_VALUEP (val
)))
11536 && XBUFFER_LOCAL_VALUE (val
)->check_frame
)
11537 /* Use find_symbol_value rather than Fsymbol_value
11538 to avoid an error if it is void. */
11539 find_symbol_value (symbol
);
11540 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11544 #define STOP_POLLING \
11545 do { if (! polling_stopped_here) stop_polling (); \
11546 polling_stopped_here = 1; } while (0)
11548 #define RESUME_POLLING \
11549 do { if (polling_stopped_here) start_polling (); \
11550 polling_stopped_here = 0; } while (0)
11553 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11554 response to any user action; therefore, we should preserve the echo
11555 area. (Actually, our caller does that job.) Perhaps in the future
11556 avoid recentering windows if it is not necessary; currently that
11557 causes some problems. */
11560 redisplay_internal (preserve_echo_area
)
11561 int preserve_echo_area
;
11563 struct window
*w
= XWINDOW (selected_window
);
11566 int must_finish
= 0;
11567 struct text_pos tlbufpos
, tlendpos
;
11568 int number_of_visible_frames
;
11571 int polling_stopped_here
= 0;
11572 Lisp_Object old_frame
= selected_frame
;
11574 /* Non-zero means redisplay has to consider all windows on all
11575 frames. Zero means, only selected_window is considered. */
11576 int consider_all_windows_p
;
11578 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11580 /* No redisplay if running in batch mode or frame is not yet fully
11581 initialized, or redisplay is explicitly turned off by setting
11582 Vinhibit_redisplay. */
11583 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11584 || !NILP (Vinhibit_redisplay
))
11587 /* Don't examine these until after testing Vinhibit_redisplay.
11588 When Emacs is shutting down, perhaps because its connection to
11589 X has dropped, we should not look at them at all. */
11590 f
= XFRAME (w
->frame
);
11591 sf
= SELECTED_FRAME ();
11593 if (!f
->glyphs_initialized_p
)
11596 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11597 if (popup_activated ())
11601 /* I don't think this happens but let's be paranoid. */
11602 if (redisplaying_p
)
11605 /* Record a function that resets redisplaying_p to its old value
11606 when we leave this function. */
11607 count
= SPECPDL_INDEX ();
11608 record_unwind_protect (unwind_redisplay
,
11609 Fcons (make_number (redisplaying_p
), selected_frame
));
11611 specbind (Qinhibit_free_realized_faces
, Qnil
);
11614 Lisp_Object tail
, frame
;
11616 FOR_EACH_FRAME (tail
, frame
)
11618 struct frame
*f
= XFRAME (frame
);
11619 f
->already_hscrolled_p
= 0;
11624 if (!EQ (old_frame
, selected_frame
)
11625 && FRAME_LIVE_P (XFRAME (old_frame
)))
11626 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11627 selected_frame and selected_window to be temporarily out-of-sync so
11628 when we come back here via `goto retry', we need to resync because we
11629 may need to run Elisp code (via prepare_menu_bars). */
11630 select_frame_for_redisplay (old_frame
);
11633 reconsider_clip_changes (w
, current_buffer
);
11634 last_escape_glyph_frame
= NULL
;
11635 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11637 /* If new fonts have been loaded that make a glyph matrix adjustment
11638 necessary, do it. */
11639 if (fonts_changed_p
)
11641 adjust_glyphs (NULL
);
11642 ++windows_or_buffers_changed
;
11643 fonts_changed_p
= 0;
11646 /* If face_change_count is non-zero, init_iterator will free all
11647 realized faces, which includes the faces referenced from current
11648 matrices. So, we can't reuse current matrices in this case. */
11649 if (face_change_count
)
11650 ++windows_or_buffers_changed
;
11652 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11653 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11655 /* Since frames on a single ASCII terminal share the same
11656 display area, displaying a different frame means redisplay
11657 the whole thing. */
11658 windows_or_buffers_changed
++;
11659 SET_FRAME_GARBAGED (sf
);
11661 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11663 FRAME_TTY (sf
)->previous_frame
= sf
;
11666 /* Set the visible flags for all frames. Do this before checking
11667 for resized or garbaged frames; they want to know if their frames
11668 are visible. See the comment in frame.h for
11669 FRAME_SAMPLE_VISIBILITY. */
11671 Lisp_Object tail
, frame
;
11673 number_of_visible_frames
= 0;
11675 FOR_EACH_FRAME (tail
, frame
)
11677 struct frame
*f
= XFRAME (frame
);
11679 FRAME_SAMPLE_VISIBILITY (f
);
11680 if (FRAME_VISIBLE_P (f
))
11681 ++number_of_visible_frames
;
11682 clear_desired_matrices (f
);
11686 /* Notice any pending interrupt request to change frame size. */
11687 do_pending_window_change (1);
11689 /* Clear frames marked as garbaged. */
11690 if (frame_garbaged
)
11691 clear_garbaged_frames ();
11693 /* Build menubar and tool-bar items. */
11694 if (NILP (Vmemory_full
))
11695 prepare_menu_bars ();
11697 if (windows_or_buffers_changed
)
11698 update_mode_lines
++;
11700 /* Detect case that we need to write or remove a star in the mode line. */
11701 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11703 w
->update_mode_line
= Qt
;
11704 if (buffer_shared
> 1)
11705 update_mode_lines
++;
11708 /* Avoid invocation of point motion hooks by `current_column' below. */
11709 count1
= SPECPDL_INDEX ();
11710 specbind (Qinhibit_point_motion_hooks
, Qt
);
11712 /* If %c is in the mode line, update it if needed. */
11713 if (!NILP (w
->column_number_displayed
)
11714 /* This alternative quickly identifies a common case
11715 where no change is needed. */
11716 && !(PT
== XFASTINT (w
->last_point
)
11717 && XFASTINT (w
->last_modified
) >= MODIFF
11718 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11719 && (XFASTINT (w
->column_number_displayed
)
11720 != (int) current_column ())) /* iftc */
11721 w
->update_mode_line
= Qt
;
11723 unbind_to (count1
, Qnil
);
11725 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11727 /* The variable buffer_shared is set in redisplay_window and
11728 indicates that we redisplay a buffer in different windows. See
11730 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11731 || cursor_type_changed
);
11733 /* If specs for an arrow have changed, do thorough redisplay
11734 to ensure we remove any arrow that should no longer exist. */
11735 if (overlay_arrows_changed_p ())
11736 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11738 /* Normally the message* functions will have already displayed and
11739 updated the echo area, but the frame may have been trashed, or
11740 the update may have been preempted, so display the echo area
11741 again here. Checking message_cleared_p captures the case that
11742 the echo area should be cleared. */
11743 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11744 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11745 || (message_cleared_p
11746 && minibuf_level
== 0
11747 /* If the mini-window is currently selected, this means the
11748 echo-area doesn't show through. */
11749 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11751 int window_height_changed_p
= echo_area_display (0);
11754 /* If we don't display the current message, don't clear the
11755 message_cleared_p flag, because, if we did, we wouldn't clear
11756 the echo area in the next redisplay which doesn't preserve
11758 if (!display_last_displayed_message_p
)
11759 message_cleared_p
= 0;
11761 if (fonts_changed_p
)
11763 else if (window_height_changed_p
)
11765 consider_all_windows_p
= 1;
11766 ++update_mode_lines
;
11767 ++windows_or_buffers_changed
;
11769 /* If window configuration was changed, frames may have been
11770 marked garbaged. Clear them or we will experience
11771 surprises wrt scrolling. */
11772 if (frame_garbaged
)
11773 clear_garbaged_frames ();
11776 else if (EQ (selected_window
, minibuf_window
)
11777 && (current_buffer
->clip_changed
11778 || XFASTINT (w
->last_modified
) < MODIFF
11779 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11780 && resize_mini_window (w
, 0))
11782 /* Resized active mini-window to fit the size of what it is
11783 showing if its contents might have changed. */
11785 /* FIXME: this causes all frames to be updated, which seems unnecessary
11786 since only the current frame needs to be considered. This function needs
11787 to be rewritten with two variables, consider_all_windows and
11788 consider_all_frames. */
11789 consider_all_windows_p
= 1;
11790 ++windows_or_buffers_changed
;
11791 ++update_mode_lines
;
11793 /* If window configuration was changed, frames may have been
11794 marked garbaged. Clear them or we will experience
11795 surprises wrt scrolling. */
11796 if (frame_garbaged
)
11797 clear_garbaged_frames ();
11801 /* If showing the region, and mark has changed, we must redisplay
11802 the whole window. The assignment to this_line_start_pos prevents
11803 the optimization directly below this if-statement. */
11804 if (((!NILP (Vtransient_mark_mode
)
11805 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
11806 != !NILP (w
->region_showing
))
11807 || (!NILP (w
->region_showing
)
11808 && !EQ (w
->region_showing
,
11809 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
11810 CHARPOS (this_line_start_pos
) = 0;
11812 /* Optimize the case that only the line containing the cursor in the
11813 selected window has changed. Variables starting with this_ are
11814 set in display_line and record information about the line
11815 containing the cursor. */
11816 tlbufpos
= this_line_start_pos
;
11817 tlendpos
= this_line_end_pos
;
11818 if (!consider_all_windows_p
11819 && CHARPOS (tlbufpos
) > 0
11820 && NILP (w
->update_mode_line
)
11821 && !current_buffer
->clip_changed
11822 && !current_buffer
->prevent_redisplay_optimizations_p
11823 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11824 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11825 /* Make sure recorded data applies to current buffer, etc. */
11826 && this_line_buffer
== current_buffer
11827 && current_buffer
== XBUFFER (w
->buffer
)
11828 && NILP (w
->force_start
)
11829 && NILP (w
->optional_new_start
)
11830 /* Point must be on the line that we have info recorded about. */
11831 && PT
>= CHARPOS (tlbufpos
)
11832 && PT
<= Z
- CHARPOS (tlendpos
)
11833 /* All text outside that line, including its final newline,
11834 must be unchanged. */
11835 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11836 CHARPOS (tlendpos
)))
11838 if (CHARPOS (tlbufpos
) > BEGV
11839 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11840 && (CHARPOS (tlbufpos
) == ZV
11841 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11842 /* Former continuation line has disappeared by becoming empty. */
11844 else if (XFASTINT (w
->last_modified
) < MODIFF
11845 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11846 || MINI_WINDOW_P (w
))
11848 /* We have to handle the case of continuation around a
11849 wide-column character (see the comment in indent.c around
11852 For instance, in the following case:
11854 -------- Insert --------
11855 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11856 J_I_ ==> J_I_ `^^' are cursors.
11860 As we have to redraw the line above, we cannot use this
11864 int line_height_before
= this_line_pixel_height
;
11866 /* Note that start_display will handle the case that the
11867 line starting at tlbufpos is a continuation line. */
11868 start_display (&it
, w
, tlbufpos
);
11870 /* Implementation note: It this still necessary? */
11871 if (it
.current_x
!= this_line_start_x
)
11874 TRACE ((stderr
, "trying display optimization 1\n"));
11875 w
->cursor
.vpos
= -1;
11876 overlay_arrow_seen
= 0;
11877 it
.vpos
= this_line_vpos
;
11878 it
.current_y
= this_line_y
;
11879 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11880 display_line (&it
);
11882 /* If line contains point, is not continued,
11883 and ends at same distance from eob as before, we win. */
11884 if (w
->cursor
.vpos
>= 0
11885 /* Line is not continued, otherwise this_line_start_pos
11886 would have been set to 0 in display_line. */
11887 && CHARPOS (this_line_start_pos
)
11888 /* Line ends as before. */
11889 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11890 /* Line has same height as before. Otherwise other lines
11891 would have to be shifted up or down. */
11892 && this_line_pixel_height
== line_height_before
)
11894 /* If this is not the window's last line, we must adjust
11895 the charstarts of the lines below. */
11896 if (it
.current_y
< it
.last_visible_y
)
11898 struct glyph_row
*row
11899 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11900 int delta
, delta_bytes
;
11902 /* We used to distinguish between two cases here,
11903 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11904 when the line ends in a newline or the end of the
11905 buffer's accessible portion. But both cases did
11906 the same, so they were collapsed. */
11908 - CHARPOS (tlendpos
)
11909 - MATRIX_ROW_START_CHARPOS (row
));
11910 delta_bytes
= (Z_BYTE
11911 - BYTEPOS (tlendpos
)
11912 - MATRIX_ROW_START_BYTEPOS (row
));
11914 increment_matrix_positions (w
->current_matrix
,
11915 this_line_vpos
+ 1,
11916 w
->current_matrix
->nrows
,
11917 delta
, delta_bytes
);
11920 /* If this row displays text now but previously didn't,
11921 or vice versa, w->window_end_vpos may have to be
11923 if ((it
.glyph_row
- 1)->displays_text_p
)
11925 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11926 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11928 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11929 && this_line_vpos
> 0)
11930 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11931 w
->window_end_valid
= Qnil
;
11933 /* Update hint: No need to try to scroll in update_window. */
11934 w
->desired_matrix
->no_scrolling_p
= 1;
11937 *w
->desired_matrix
->method
= 0;
11938 debug_method_add (w
, "optimization 1");
11940 #ifdef HAVE_WINDOW_SYSTEM
11941 update_window_fringes (w
, 0);
11948 else if (/* Cursor position hasn't changed. */
11949 PT
== XFASTINT (w
->last_point
)
11950 /* Make sure the cursor was last displayed
11951 in this window. Otherwise we have to reposition it. */
11952 && 0 <= w
->cursor
.vpos
11953 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11957 do_pending_window_change (1);
11959 /* We used to always goto end_of_redisplay here, but this
11960 isn't enough if we have a blinking cursor. */
11961 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11962 goto end_of_redisplay
;
11966 /* If highlighting the region, or if the cursor is in the echo area,
11967 then we can't just move the cursor. */
11968 else if (! (!NILP (Vtransient_mark_mode
)
11969 && !NILP (current_buffer
->mark_active
))
11970 && (EQ (selected_window
, current_buffer
->last_selected_window
)
11971 || highlight_nonselected_windows
)
11972 && NILP (w
->region_showing
)
11973 && NILP (Vshow_trailing_whitespace
)
11974 && !cursor_in_echo_area
)
11977 struct glyph_row
*row
;
11979 /* Skip from tlbufpos to PT and see where it is. Note that
11980 PT may be in invisible text. If so, we will end at the
11981 next visible position. */
11982 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11983 NULL
, DEFAULT_FACE_ID
);
11984 it
.current_x
= this_line_start_x
;
11985 it
.current_y
= this_line_y
;
11986 it
.vpos
= this_line_vpos
;
11988 /* The call to move_it_to stops in front of PT, but
11989 moves over before-strings. */
11990 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11992 if (it
.vpos
== this_line_vpos
11993 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11996 xassert (this_line_vpos
== it
.vpos
);
11997 xassert (this_line_y
== it
.current_y
);
11998 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
12000 *w
->desired_matrix
->method
= 0;
12001 debug_method_add (w
, "optimization 3");
12010 /* Text changed drastically or point moved off of line. */
12011 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
12014 CHARPOS (this_line_start_pos
) = 0;
12015 consider_all_windows_p
|= buffer_shared
> 1;
12016 ++clear_face_cache_count
;
12017 #ifdef HAVE_WINDOW_SYSTEM
12018 ++clear_image_cache_count
;
12021 /* Build desired matrices, and update the display. If
12022 consider_all_windows_p is non-zero, do it for all windows on all
12023 frames. Otherwise do it for selected_window, only. */
12025 if (consider_all_windows_p
)
12027 Lisp_Object tail
, frame
;
12029 FOR_EACH_FRAME (tail
, frame
)
12030 XFRAME (frame
)->updated_p
= 0;
12032 /* Recompute # windows showing selected buffer. This will be
12033 incremented each time such a window is displayed. */
12036 FOR_EACH_FRAME (tail
, frame
)
12038 struct frame
*f
= XFRAME (frame
);
12040 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
12042 if (! EQ (frame
, selected_frame
))
12043 /* Select the frame, for the sake of frame-local
12045 select_frame_for_redisplay (frame
);
12047 /* Mark all the scroll bars to be removed; we'll redeem
12048 the ones we want when we redisplay their windows. */
12049 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
12050 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
12052 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12053 redisplay_windows (FRAME_ROOT_WINDOW (f
));
12055 /* The X error handler may have deleted that frame. */
12056 if (!FRAME_LIVE_P (f
))
12059 /* Any scroll bars which redisplay_windows should have
12060 nuked should now go away. */
12061 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
12062 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
12064 /* If fonts changed, display again. */
12065 /* ??? rms: I suspect it is a mistake to jump all the way
12066 back to retry here. It should just retry this frame. */
12067 if (fonts_changed_p
)
12070 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12072 /* See if we have to hscroll. */
12073 if (!f
->already_hscrolled_p
)
12075 f
->already_hscrolled_p
= 1;
12076 if (hscroll_windows (f
->root_window
))
12080 /* Prevent various kinds of signals during display
12081 update. stdio is not robust about handling
12082 signals, which can cause an apparent I/O
12084 if (interrupt_input
)
12085 unrequest_sigio ();
12088 /* Update the display. */
12089 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12090 pause
|= update_frame (f
, 0, 0);
12096 if (!EQ (old_frame
, selected_frame
)
12097 && FRAME_LIVE_P (XFRAME (old_frame
)))
12098 /* We played a bit fast-and-loose above and allowed selected_frame
12099 and selected_window to be temporarily out-of-sync but let's make
12100 sure this stays contained. */
12101 select_frame_for_redisplay (old_frame
);
12102 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12106 /* Do the mark_window_display_accurate after all windows have
12107 been redisplayed because this call resets flags in buffers
12108 which are needed for proper redisplay. */
12109 FOR_EACH_FRAME (tail
, frame
)
12111 struct frame
*f
= XFRAME (frame
);
12114 mark_window_display_accurate (f
->root_window
, 1);
12115 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12116 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12121 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12123 Lisp_Object mini_window
;
12124 struct frame
*mini_frame
;
12126 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12127 /* Use list_of_error, not Qerror, so that
12128 we catch only errors and don't run the debugger. */
12129 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12131 redisplay_window_error
);
12133 /* Compare desired and current matrices, perform output. */
12136 /* If fonts changed, display again. */
12137 if (fonts_changed_p
)
12140 /* Prevent various kinds of signals during display update.
12141 stdio is not robust about handling signals,
12142 which can cause an apparent I/O error. */
12143 if (interrupt_input
)
12144 unrequest_sigio ();
12147 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12149 if (hscroll_windows (selected_window
))
12152 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12153 pause
= update_frame (sf
, 0, 0);
12156 /* We may have called echo_area_display at the top of this
12157 function. If the echo area is on another frame, that may
12158 have put text on a frame other than the selected one, so the
12159 above call to update_frame would not have caught it. Catch
12161 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12162 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12164 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12166 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12167 pause
|= update_frame (mini_frame
, 0, 0);
12168 if (!pause
&& hscroll_windows (mini_window
))
12173 /* If display was paused because of pending input, make sure we do a
12174 thorough update the next time. */
12177 /* Prevent the optimization at the beginning of
12178 redisplay_internal that tries a single-line update of the
12179 line containing the cursor in the selected window. */
12180 CHARPOS (this_line_start_pos
) = 0;
12182 /* Let the overlay arrow be updated the next time. */
12183 update_overlay_arrows (0);
12185 /* If we pause after scrolling, some rows in the current
12186 matrices of some windows are not valid. */
12187 if (!WINDOW_FULL_WIDTH_P (w
)
12188 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12189 update_mode_lines
= 1;
12193 if (!consider_all_windows_p
)
12195 /* This has already been done above if
12196 consider_all_windows_p is set. */
12197 mark_window_display_accurate_1 (w
, 1);
12199 /* Say overlay arrows are up to date. */
12200 update_overlay_arrows (1);
12202 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12203 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12206 update_mode_lines
= 0;
12207 windows_or_buffers_changed
= 0;
12208 cursor_type_changed
= 0;
12211 /* Start SIGIO interrupts coming again. Having them off during the
12212 code above makes it less likely one will discard output, but not
12213 impossible, since there might be stuff in the system buffer here.
12214 But it is much hairier to try to do anything about that. */
12215 if (interrupt_input
)
12219 /* If a frame has become visible which was not before, redisplay
12220 again, so that we display it. Expose events for such a frame
12221 (which it gets when becoming visible) don't call the parts of
12222 redisplay constructing glyphs, so simply exposing a frame won't
12223 display anything in this case. So, we have to display these
12224 frames here explicitly. */
12227 Lisp_Object tail
, frame
;
12230 FOR_EACH_FRAME (tail
, frame
)
12232 int this_is_visible
= 0;
12234 if (XFRAME (frame
)->visible
)
12235 this_is_visible
= 1;
12236 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12237 if (XFRAME (frame
)->visible
)
12238 this_is_visible
= 1;
12240 if (this_is_visible
)
12244 if (new_count
!= number_of_visible_frames
)
12245 windows_or_buffers_changed
++;
12248 /* Change frame size now if a change is pending. */
12249 do_pending_window_change (1);
12251 /* If we just did a pending size change, or have additional
12252 visible frames, redisplay again. */
12253 if (windows_or_buffers_changed
&& !pause
)
12256 /* Clear the face cache eventually. */
12257 if (consider_all_windows_p
)
12259 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12261 clear_face_cache (0);
12262 clear_face_cache_count
= 0;
12264 #ifdef HAVE_WINDOW_SYSTEM
12265 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12267 clear_image_caches (Qnil
);
12268 clear_image_cache_count
= 0;
12270 #endif /* HAVE_WINDOW_SYSTEM */
12274 unbind_to (count
, Qnil
);
12279 /* Redisplay, but leave alone any recent echo area message unless
12280 another message has been requested in its place.
12282 This is useful in situations where you need to redisplay but no
12283 user action has occurred, making it inappropriate for the message
12284 area to be cleared. See tracking_off and
12285 wait_reading_process_output for examples of these situations.
12287 FROM_WHERE is an integer saying from where this function was
12288 called. This is useful for debugging. */
12291 redisplay_preserve_echo_area (from_where
)
12294 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12296 if (!NILP (echo_area_buffer
[1]))
12298 /* We have a previously displayed message, but no current
12299 message. Redisplay the previous message. */
12300 display_last_displayed_message_p
= 1;
12301 redisplay_internal (1);
12302 display_last_displayed_message_p
= 0;
12305 redisplay_internal (1);
12307 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12308 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12309 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12313 /* Function registered with record_unwind_protect in
12314 redisplay_internal. Reset redisplaying_p to the value it had
12315 before redisplay_internal was called, and clear
12316 prevent_freeing_realized_faces_p. It also selects the previously
12317 selected frame, unless it has been deleted (by an X connection
12318 failure during redisplay, for example). */
12321 unwind_redisplay (val
)
12324 Lisp_Object old_redisplaying_p
, old_frame
;
12326 old_redisplaying_p
= XCAR (val
);
12327 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12328 old_frame
= XCDR (val
);
12329 if (! EQ (old_frame
, selected_frame
)
12330 && FRAME_LIVE_P (XFRAME (old_frame
)))
12331 select_frame_for_redisplay (old_frame
);
12336 /* Mark the display of window W as accurate or inaccurate. If
12337 ACCURATE_P is non-zero mark display of W as accurate. If
12338 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12339 redisplay_internal is called. */
12342 mark_window_display_accurate_1 (w
, accurate_p
)
12346 if (BUFFERP (w
->buffer
))
12348 struct buffer
*b
= XBUFFER (w
->buffer
);
12351 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12352 w
->last_overlay_modified
12353 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12355 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12359 b
->clip_changed
= 0;
12360 b
->prevent_redisplay_optimizations_p
= 0;
12362 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12363 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12364 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12365 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12367 w
->current_matrix
->buffer
= b
;
12368 w
->current_matrix
->begv
= BUF_BEGV (b
);
12369 w
->current_matrix
->zv
= BUF_ZV (b
);
12371 w
->last_cursor
= w
->cursor
;
12372 w
->last_cursor_off_p
= w
->cursor_off_p
;
12374 if (w
== XWINDOW (selected_window
))
12375 w
->last_point
= make_number (BUF_PT (b
));
12377 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12383 w
->window_end_valid
= w
->buffer
;
12384 w
->update_mode_line
= Qnil
;
12389 /* Mark the display of windows in the window tree rooted at WINDOW as
12390 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12391 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12392 be redisplayed the next time redisplay_internal is called. */
12395 mark_window_display_accurate (window
, accurate_p
)
12396 Lisp_Object window
;
12401 for (; !NILP (window
); window
= w
->next
)
12403 w
= XWINDOW (window
);
12404 mark_window_display_accurate_1 (w
, accurate_p
);
12406 if (!NILP (w
->vchild
))
12407 mark_window_display_accurate (w
->vchild
, accurate_p
);
12408 if (!NILP (w
->hchild
))
12409 mark_window_display_accurate (w
->hchild
, accurate_p
);
12414 update_overlay_arrows (1);
12418 /* Force a thorough redisplay the next time by setting
12419 last_arrow_position and last_arrow_string to t, which is
12420 unequal to any useful value of Voverlay_arrow_... */
12421 update_overlay_arrows (-1);
12426 /* Return value in display table DP (Lisp_Char_Table *) for character
12427 C. Since a display table doesn't have any parent, we don't have to
12428 follow parent. Do not call this function directly but use the
12429 macro DISP_CHAR_VECTOR. */
12432 disp_char_vector (dp
, c
)
12433 struct Lisp_Char_Table
*dp
;
12438 if (ASCII_CHAR_P (c
))
12441 if (SUB_CHAR_TABLE_P (val
))
12442 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12448 XSETCHAR_TABLE (table
, dp
);
12449 val
= char_table_ref (table
, c
);
12458 /***********************************************************************
12460 ***********************************************************************/
12462 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12465 redisplay_windows (window
)
12466 Lisp_Object window
;
12468 while (!NILP (window
))
12470 struct window
*w
= XWINDOW (window
);
12472 if (!NILP (w
->hchild
))
12473 redisplay_windows (w
->hchild
);
12474 else if (!NILP (w
->vchild
))
12475 redisplay_windows (w
->vchild
);
12476 else if (!NILP (w
->buffer
))
12478 displayed_buffer
= XBUFFER (w
->buffer
);
12479 /* Use list_of_error, not Qerror, so that
12480 we catch only errors and don't run the debugger. */
12481 internal_condition_case_1 (redisplay_window_0
, window
,
12483 redisplay_window_error
);
12491 redisplay_window_error ()
12493 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12498 redisplay_window_0 (window
)
12499 Lisp_Object window
;
12501 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12502 redisplay_window (window
, 0);
12507 redisplay_window_1 (window
)
12508 Lisp_Object window
;
12510 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12511 redisplay_window (window
, 1);
12516 /* Increment GLYPH until it reaches END or CONDITION fails while
12517 adding (GLYPH)->pixel_width to X. */
12519 #define SKIP_GLYPHS(glyph, end, x, condition) \
12522 (x) += (glyph)->pixel_width; \
12525 while ((glyph) < (end) && (condition))
12528 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12529 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12530 which positions recorded in ROW differ from current buffer
12533 Return 0 if cursor is not on this row, 1 otherwise. */
12536 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
12538 struct glyph_row
*row
;
12539 struct glyph_matrix
*matrix
;
12540 int delta
, delta_bytes
, dy
, dvpos
;
12542 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12543 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12544 struct glyph
*cursor
= NULL
;
12545 /* The last known character position in row. */
12546 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12549 EMACS_INT pt_old
= PT
- delta
;
12550 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12551 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12552 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12553 /* Non-zero means we've found a match for cursor position, but that
12554 glyph has the avoid_cursor_p flag set. */
12555 int match_with_avoid_cursor
= 0;
12556 /* Non-zero means we've seen at least one glyph that came from a
12558 int string_seen
= 0;
12559 /* Largest buffer position seen so far during scan of glyph row. */
12560 EMACS_INT bpos_max
= last_pos
;
12561 /* Last buffer position covered by an overlay string with an integer
12562 `cursor' property. */
12563 EMACS_INT bpos_covered
= 0;
12565 /* Skip over glyphs not having an object at the start and the end of
12566 the row. These are special glyphs like truncation marks on
12567 terminal frames. */
12568 if (row
->displays_text_p
)
12570 if (!row
->reversed_p
)
12573 && INTEGERP (glyph
->object
)
12574 && glyph
->charpos
< 0)
12576 x
+= glyph
->pixel_width
;
12580 && INTEGERP ((end
- 1)->object
)
12581 /* CHARPOS is zero for blanks inserted by
12582 extend_face_to_end_of_line. */
12583 && (end
- 1)->charpos
<= 0)
12585 glyph_before
= glyph
- 1;
12592 /* If the glyph row is reversed, we need to process it from back
12593 to front, so swap the edge pointers. */
12595 glyph
+= row
->used
[TEXT_AREA
] - 1;
12596 /* Reverse the known positions in the row. */
12597 last_pos
= pos_after
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12598 pos_before
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12600 while (glyph
> end
+ 1
12601 && INTEGERP (glyph
->object
)
12602 && glyph
->charpos
< 0)
12605 x
-= glyph
->pixel_width
;
12607 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12609 /* By default, put the cursor on the rightmost glyph. */
12610 for (g
= end
+ 1; g
< glyph
; g
++)
12611 x
+= g
->pixel_width
;
12614 && INTEGERP ((end
+ 1)->object
)
12615 && (end
+ 1)->charpos
<= 0)
12617 glyph_before
= glyph
+ 1;
12621 else if (row
->reversed_p
)
12623 /* In R2L rows that don't display text, put the cursor on the
12624 rightmost glyph. Case in point: an empty last line that is
12625 part of an R2L paragraph. */
12627 x
= -1; /* will be computed below, at lable compute_x */
12630 /* Step 1: Try to find the glyph whose character position
12631 corresponds to point. If that's not possible, find 2 glyphs
12632 whose character positions are the closest to point, one before
12633 point, the other after it. */
12634 if (!row
->reversed_p
)
12635 while (/* not marched to end of glyph row */
12637 /* glyph was not inserted by redisplay for internal purposes */
12638 && !INTEGERP (glyph
->object
))
12640 if (BUFFERP (glyph
->object
))
12642 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12644 if (glyph
->charpos
> bpos_max
)
12645 bpos_max
= glyph
->charpos
;
12646 if (!glyph
->avoid_cursor_p
)
12648 /* If we hit point, we've found the glyph on which to
12649 display the cursor. */
12652 match_with_avoid_cursor
= 0;
12655 /* See if we've found a better approximation to
12656 POS_BEFORE or to POS_AFTER. Note that we want the
12657 first (leftmost) glyph of all those that are the
12658 closest from below, and the last (rightmost) of all
12659 those from above. */
12660 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12662 pos_before
= glyph
->charpos
;
12663 glyph_before
= glyph
;
12665 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12667 pos_after
= glyph
->charpos
;
12668 glyph_after
= glyph
;
12671 else if (dpos
== 0)
12672 match_with_avoid_cursor
= 1;
12674 else if (STRINGP (glyph
->object
))
12676 Lisp_Object chprop
;
12677 int glyph_pos
= glyph
->charpos
;
12679 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12681 if (INTEGERP (chprop
))
12683 bpos_covered
= bpos_max
+ XINT (chprop
);
12684 /* If the `cursor' property covers buffer positions up
12685 to and including point, we should display cursor on
12687 /* Implementation note: bpos_max == pt_old when, e.g.,
12688 we are in an empty line, where bpos_max is set to
12689 MATRIX_ROW_START_CHARPOS, see above. */
12690 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12699 x
+= glyph
->pixel_width
;
12702 else if (glyph
> end
) /* row is reversed */
12703 while (!INTEGERP (glyph
->object
))
12705 if (BUFFERP (glyph
->object
))
12707 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12709 if (glyph
->charpos
> bpos_max
)
12710 bpos_max
= glyph
->charpos
;
12711 if (!glyph
->avoid_cursor_p
)
12715 match_with_avoid_cursor
= 0;
12718 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12720 pos_before
= glyph
->charpos
;
12721 glyph_before
= glyph
;
12723 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12725 pos_after
= glyph
->charpos
;
12726 glyph_after
= glyph
;
12729 else if (dpos
== 0)
12730 match_with_avoid_cursor
= 1;
12732 else if (STRINGP (glyph
->object
))
12734 Lisp_Object chprop
;
12735 int glyph_pos
= glyph
->charpos
;
12737 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12739 if (INTEGERP (chprop
))
12741 bpos_covered
= bpos_max
+ XINT (chprop
);
12742 /* If the `cursor' property covers buffer positions up
12743 to and including point, we should display cursor on
12745 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12756 x
-= glyph
->pixel_width
;
12759 /* Step 2: If we didn't find an exact match for point, we need to
12760 look for a proper place to put the cursor among glyphs between
12761 GLYPH_BEFORE and GLYPH_AFTER. */
12762 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12763 && bpos_covered
< pt_old
)
12765 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12767 EMACS_INT ellipsis_pos
;
12769 /* Scan back over the ellipsis glyphs. */
12770 if (!row
->reversed_p
)
12772 ellipsis_pos
= (glyph
- 1)->charpos
;
12773 while (glyph
> row
->glyphs
[TEXT_AREA
]
12774 && (glyph
- 1)->charpos
== ellipsis_pos
)
12775 glyph
--, x
-= glyph
->pixel_width
;
12776 /* That loop always goes one position too far, including
12777 the glyph before the ellipsis. So scan forward over
12779 x
+= glyph
->pixel_width
;
12782 else /* row is reversed */
12784 ellipsis_pos
= (glyph
+ 1)->charpos
;
12785 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12786 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12787 glyph
++, x
+= glyph
->pixel_width
;
12788 x
-= glyph
->pixel_width
;
12792 else if (match_with_avoid_cursor
12793 /* zero-width characters produce no glyphs */
12794 || eabs (glyph_after
- glyph_before
) == 1)
12796 cursor
= glyph_after
;
12799 else if (string_seen
)
12801 int incr
= row
->reversed_p
? -1 : +1;
12803 /* Need to find the glyph that came out of a string which is
12804 present at point. That glyph is somewhere between
12805 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12806 positioned between POS_BEFORE and POS_AFTER in the
12808 struct glyph
*stop
= glyph_after
;
12809 EMACS_INT pos
= pos_before
;
12812 for (glyph
= glyph_before
+ incr
;
12813 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12816 /* Any glyphs that come from the buffer are here because
12817 of bidi reordering. Skip them, and only pay
12818 attention to glyphs that came from some string. */
12819 if (STRINGP (glyph
->object
))
12824 str
= glyph
->object
;
12825 tem
= string_buffer_position_lim (w
, str
, pos
, pos_after
, 0);
12826 if (tem
== 0 /* from overlay */
12829 /* If the string from which this glyph came is
12830 found in the buffer at point, then we've
12831 found the glyph we've been looking for. If
12832 it comes from an overlay (tem == 0), and it
12833 has the `cursor' property on one of its
12834 glyphs, record that glyph as a candidate for
12835 displaying the cursor. (As in the
12836 unidirectional version, we will display the
12837 cursor on the last candidate we find.) */
12838 if (tem
== 0 || tem
== pt_old
)
12840 /* The glyphs from this string could have
12841 been reordered. Find the one with the
12842 smallest string position. Or there could
12843 be a character in the string with the
12844 `cursor' property, which means display
12845 cursor on that character's glyph. */
12846 int strpos
= glyph
->charpos
;
12849 for (glyph
+= incr
;
12850 EQ (glyph
->object
, str
);
12854 int gpos
= glyph
->charpos
;
12856 cprop
= Fget_char_property (make_number (gpos
),
12864 if (glyph
->charpos
< strpos
)
12866 strpos
= glyph
->charpos
;
12875 pos
= tem
+ 1; /* don't find previous instances */
12877 /* This string is not what we want; skip all of the
12878 glyphs that came from it. */
12881 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12882 && EQ (glyph
->object
, str
));
12888 /* If we reached the end of the line, and END was from a string,
12889 the cursor is not on this line. */
12891 && STRINGP ((glyph
- incr
)->object
)
12892 && row
->continued_p
)
12898 if (cursor
!= NULL
)
12904 /* Need to compute x that corresponds to GLYPH. */
12905 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
12907 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
12909 x
+= g
->pixel_width
;
12913 /* ROW could be part of a continued line, which might have other
12914 rows whose start and end charpos occlude point. Only set
12915 w->cursor if we found a better approximation to the cursor
12916 position than we have from previously examined rows. */
12917 if (w
->cursor
.vpos
>= 0
12918 /* Make sure cursor.vpos specifies a row whose start and end
12919 charpos occlude point. This is because some callers of this
12920 function leave cursor.vpos at the row where the cursor was
12921 displayed during the last redisplay cycle. */
12922 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
12923 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
12926 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
12928 /* Keep the candidate whose buffer position is the closest to
12930 if (BUFFERP (g1
->object
)
12931 && (g1
->charpos
== pt_old
/* an exact match always wins */
12932 || (BUFFERP (glyph
->object
)
12933 && eabs (g1
->charpos
- pt_old
)
12934 < eabs (glyph
->charpos
- pt_old
))))
12936 /* If this candidate gives an exact match, use that. */
12937 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12938 /* Otherwise, keep the candidate that comes from a row
12939 spanning less buffer positions. This may win when one or
12940 both candidate positions are on glyphs that came from
12941 display strings, for which we cannot compare buffer
12943 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12944 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12945 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
12948 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12950 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12951 w
->cursor
.y
= row
->y
+ dy
;
12953 if (w
== XWINDOW (selected_window
))
12955 if (!row
->continued_p
12956 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12959 this_line_buffer
= XBUFFER (w
->buffer
);
12961 CHARPOS (this_line_start_pos
)
12962 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12963 BYTEPOS (this_line_start_pos
)
12964 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12966 CHARPOS (this_line_end_pos
)
12967 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12968 BYTEPOS (this_line_end_pos
)
12969 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12971 this_line_y
= w
->cursor
.y
;
12972 this_line_pixel_height
= row
->height
;
12973 this_line_vpos
= w
->cursor
.vpos
;
12974 this_line_start_x
= row
->x
;
12977 CHARPOS (this_line_start_pos
) = 0;
12984 /* Run window scroll functions, if any, for WINDOW with new window
12985 start STARTP. Sets the window start of WINDOW to that position.
12987 We assume that the window's buffer is really current. */
12989 static INLINE
struct text_pos
12990 run_window_scroll_functions (window
, startp
)
12991 Lisp_Object window
;
12992 struct text_pos startp
;
12994 struct window
*w
= XWINDOW (window
);
12995 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12997 if (current_buffer
!= XBUFFER (w
->buffer
))
13000 if (!NILP (Vwindow_scroll_functions
))
13002 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
13003 make_number (CHARPOS (startp
)));
13004 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13005 /* In case the hook functions switch buffers. */
13006 if (current_buffer
!= XBUFFER (w
->buffer
))
13007 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13014 /* Make sure the line containing the cursor is fully visible.
13015 A value of 1 means there is nothing to be done.
13016 (Either the line is fully visible, or it cannot be made so,
13017 or we cannot tell.)
13019 If FORCE_P is non-zero, return 0 even if partial visible cursor row
13020 is higher than window.
13022 A value of 0 means the caller should do scrolling
13023 as if point had gone off the screen. */
13026 cursor_row_fully_visible_p (w
, force_p
, current_matrix_p
)
13029 int current_matrix_p
;
13031 struct glyph_matrix
*matrix
;
13032 struct glyph_row
*row
;
13035 if (!make_cursor_line_fully_visible_p
)
13038 /* It's not always possible to find the cursor, e.g, when a window
13039 is full of overlay strings. Don't do anything in that case. */
13040 if (w
->cursor
.vpos
< 0)
13043 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13044 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13046 /* If the cursor row is not partially visible, there's nothing to do. */
13047 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13050 /* If the row the cursor is in is taller than the window's height,
13051 it's not clear what to do, so do nothing. */
13052 window_height
= window_box_height (w
);
13053 if (row
->height
>= window_height
)
13055 if (!force_p
|| MINI_WINDOW_P (w
)
13056 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13063 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13064 non-zero means only WINDOW is redisplayed in redisplay_internal.
13065 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
13066 in redisplay_window to bring a partially visible line into view in
13067 the case that only the cursor has moved.
13069 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13070 last screen line's vertical height extends past the end of the screen.
13074 1 if scrolling succeeded
13076 0 if scrolling didn't find point.
13078 -1 if new fonts have been loaded so that we must interrupt
13079 redisplay, adjust glyph matrices, and try again. */
13085 SCROLLING_NEED_LARGER_MATRICES
13089 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
13090 scroll_step
, temp_scroll_step
, last_line_misfit
)
13091 Lisp_Object window
;
13092 int just_this_one_p
;
13093 EMACS_INT scroll_conservatively
, scroll_step
;
13094 int temp_scroll_step
;
13095 int last_line_misfit
;
13097 struct window
*w
= XWINDOW (window
);
13098 struct frame
*f
= XFRAME (w
->frame
);
13099 struct text_pos pos
, startp
;
13101 int this_scroll_margin
, scroll_max
, rc
, height
;
13102 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13103 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13104 Lisp_Object aggressive
;
13105 int scroll_limit
= INT_MAX
/ FRAME_LINE_HEIGHT (f
);
13108 debug_method_add (w
, "try_scrolling");
13111 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13113 /* Compute scroll margin height in pixels. We scroll when point is
13114 within this distance from the top or bottom of the window. */
13115 if (scroll_margin
> 0)
13116 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13117 * FRAME_LINE_HEIGHT (f
);
13119 this_scroll_margin
= 0;
13121 /* Force scroll_conservatively to have a reasonable value, to avoid
13122 overflow while computing how much to scroll. Note that the user
13123 can supply scroll-conservatively equal to `most-positive-fixnum',
13124 which can be larger than INT_MAX. */
13125 if (scroll_conservatively
> scroll_limit
)
13127 scroll_conservatively
= scroll_limit
;
13128 scroll_max
= INT_MAX
;
13130 else if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
13131 /* Compute how much we should try to scroll maximally to bring
13132 point into view. */
13133 scroll_max
= (max (scroll_step
,
13134 max (scroll_conservatively
, temp_scroll_step
))
13135 * FRAME_LINE_HEIGHT (f
));
13136 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
13137 || NUMBERP (current_buffer
->scroll_up_aggressively
))
13138 /* We're trying to scroll because of aggressive scrolling but no
13139 scroll_step is set. Choose an arbitrary one. */
13140 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13146 /* Decide whether to scroll down. */
13147 if (PT
> CHARPOS (startp
))
13149 int scroll_margin_y
;
13151 /* Compute the pixel ypos of the scroll margin, then move it to
13152 either that ypos or PT, whichever comes first. */
13153 start_display (&it
, w
, startp
);
13154 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13155 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13156 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13157 (MOVE_TO_POS
| MOVE_TO_Y
));
13159 if (PT
> CHARPOS (it
.current
.pos
))
13161 int y0
= line_bottom_y (&it
);
13163 /* Compute the distance from the scroll margin to PT
13164 (including the height of the cursor line). Moving the
13165 iterator unconditionally to PT can be slow if PT is far
13166 away, so stop 10 lines past the window bottom (is there a
13167 way to do the right thing quickly?). */
13168 move_it_to (&it
, PT
, -1,
13169 it
.last_visible_y
+ 10 * FRAME_LINE_HEIGHT (f
),
13170 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13171 dy
= line_bottom_y (&it
) - y0
;
13173 if (dy
> scroll_max
)
13174 return SCROLLING_FAILED
;
13182 /* Point is in or below the bottom scroll margin, so move the
13183 window start down. If scrolling conservatively, move it just
13184 enough down to make point visible. If scroll_step is set,
13185 move it down by scroll_step. */
13186 if (scroll_conservatively
)
13188 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13189 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
13190 else if (scroll_step
|| temp_scroll_step
)
13191 amount_to_scroll
= scroll_max
;
13194 aggressive
= current_buffer
->scroll_up_aggressively
;
13195 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13196 if (NUMBERP (aggressive
))
13198 double float_amount
= XFLOATINT (aggressive
) * height
;
13199 amount_to_scroll
= float_amount
;
13200 if (amount_to_scroll
== 0 && float_amount
> 0)
13201 amount_to_scroll
= 1;
13205 if (amount_to_scroll
<= 0)
13206 return SCROLLING_FAILED
;
13208 start_display (&it
, w
, startp
);
13209 move_it_vertically (&it
, amount_to_scroll
);
13211 /* If STARTP is unchanged, move it down another screen line. */
13212 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13213 move_it_by_lines (&it
, 1, 1);
13214 startp
= it
.current
.pos
;
13218 struct text_pos scroll_margin_pos
= startp
;
13220 /* See if point is inside the scroll margin at the top of the
13222 if (this_scroll_margin
)
13224 start_display (&it
, w
, startp
);
13225 move_it_vertically (&it
, this_scroll_margin
);
13226 scroll_margin_pos
= it
.current
.pos
;
13229 if (PT
< CHARPOS (scroll_margin_pos
))
13231 /* Point is in the scroll margin at the top of the window or
13232 above what is displayed in the window. */
13235 /* Compute the vertical distance from PT to the scroll
13236 margin position. Give up if distance is greater than
13238 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13239 start_display (&it
, w
, pos
);
13241 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13242 it
.last_visible_y
, -1,
13243 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13244 dy
= it
.current_y
- y0
;
13245 if (dy
> scroll_max
)
13246 return SCROLLING_FAILED
;
13248 /* Compute new window start. */
13249 start_display (&it
, w
, startp
);
13251 if (scroll_conservatively
)
13253 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
13254 else if (scroll_step
|| temp_scroll_step
)
13255 amount_to_scroll
= scroll_max
;
13258 aggressive
= current_buffer
->scroll_down_aggressively
;
13259 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13260 if (NUMBERP (aggressive
))
13262 double float_amount
= XFLOATINT (aggressive
) * height
;
13263 amount_to_scroll
= float_amount
;
13264 if (amount_to_scroll
== 0 && float_amount
> 0)
13265 amount_to_scroll
= 1;
13269 if (amount_to_scroll
<= 0)
13270 return SCROLLING_FAILED
;
13272 move_it_vertically_backward (&it
, amount_to_scroll
);
13273 startp
= it
.current
.pos
;
13277 /* Run window scroll functions. */
13278 startp
= run_window_scroll_functions (window
, startp
);
13280 /* Display the window. Give up if new fonts are loaded, or if point
13282 if (!try_window (window
, startp
, 0))
13283 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13284 else if (w
->cursor
.vpos
< 0)
13286 clear_glyph_matrix (w
->desired_matrix
);
13287 rc
= SCROLLING_FAILED
;
13291 /* Maybe forget recorded base line for line number display. */
13292 if (!just_this_one_p
13293 || current_buffer
->clip_changed
13294 || BEG_UNCHANGED
< CHARPOS (startp
))
13295 w
->base_line_number
= Qnil
;
13297 /* If cursor ends up on a partially visible line,
13298 treat that as being off the bottom of the screen. */
13299 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
13301 clear_glyph_matrix (w
->desired_matrix
);
13302 ++extra_scroll_margin_lines
;
13305 rc
= SCROLLING_SUCCESS
;
13312 /* Compute a suitable window start for window W if display of W starts
13313 on a continuation line. Value is non-zero if a new window start
13316 The new window start will be computed, based on W's width, starting
13317 from the start of the continued line. It is the start of the
13318 screen line with the minimum distance from the old start W->start. */
13321 compute_window_start_on_continuation_line (w
)
13324 struct text_pos pos
, start_pos
;
13325 int window_start_changed_p
= 0;
13327 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13329 /* If window start is on a continuation line... Window start may be
13330 < BEGV in case there's invisible text at the start of the
13331 buffer (M-x rmail, for example). */
13332 if (CHARPOS (start_pos
) > BEGV
13333 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13336 struct glyph_row
*row
;
13338 /* Handle the case that the window start is out of range. */
13339 if (CHARPOS (start_pos
) < BEGV
)
13340 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13341 else if (CHARPOS (start_pos
) > ZV
)
13342 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13344 /* Find the start of the continued line. This should be fast
13345 because scan_buffer is fast (newline cache). */
13346 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13347 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13348 row
, DEFAULT_FACE_ID
);
13349 reseat_at_previous_visible_line_start (&it
);
13351 /* If the line start is "too far" away from the window start,
13352 say it takes too much time to compute a new window start. */
13353 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13354 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13356 int min_distance
, distance
;
13358 /* Move forward by display lines to find the new window
13359 start. If window width was enlarged, the new start can
13360 be expected to be > the old start. If window width was
13361 decreased, the new window start will be < the old start.
13362 So, we're looking for the display line start with the
13363 minimum distance from the old window start. */
13364 pos
= it
.current
.pos
;
13365 min_distance
= INFINITY
;
13366 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13367 distance
< min_distance
)
13369 min_distance
= distance
;
13370 pos
= it
.current
.pos
;
13371 move_it_by_lines (&it
, 1, 0);
13374 /* Set the window start there. */
13375 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13376 window_start_changed_p
= 1;
13380 return window_start_changed_p
;
13384 /* Try cursor movement in case text has not changed in window WINDOW,
13385 with window start STARTP. Value is
13387 CURSOR_MOVEMENT_SUCCESS if successful
13389 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13391 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13392 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13393 we want to scroll as if scroll-step were set to 1. See the code.
13395 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13396 which case we have to abort this redisplay, and adjust matrices
13401 CURSOR_MOVEMENT_SUCCESS
,
13402 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13403 CURSOR_MOVEMENT_MUST_SCROLL
,
13404 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13408 try_cursor_movement (window
, startp
, scroll_step
)
13409 Lisp_Object window
;
13410 struct text_pos startp
;
13413 struct window
*w
= XWINDOW (window
);
13414 struct frame
*f
= XFRAME (w
->frame
);
13415 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13418 if (inhibit_try_cursor_movement
)
13422 /* Handle case where text has not changed, only point, and it has
13423 not moved off the frame. */
13424 if (/* Point may be in this window. */
13425 PT
>= CHARPOS (startp
)
13426 /* Selective display hasn't changed. */
13427 && !current_buffer
->clip_changed
13428 /* Function force-mode-line-update is used to force a thorough
13429 redisplay. It sets either windows_or_buffers_changed or
13430 update_mode_lines. So don't take a shortcut here for these
13432 && !update_mode_lines
13433 && !windows_or_buffers_changed
13434 && !cursor_type_changed
13435 /* Can't use this case if highlighting a region. When a
13436 region exists, cursor movement has to do more than just
13438 && !(!NILP (Vtransient_mark_mode
)
13439 && !NILP (current_buffer
->mark_active
))
13440 && NILP (w
->region_showing
)
13441 && NILP (Vshow_trailing_whitespace
)
13442 /* Right after splitting windows, last_point may be nil. */
13443 && INTEGERP (w
->last_point
)
13444 /* This code is not used for mini-buffer for the sake of the case
13445 of redisplaying to replace an echo area message; since in
13446 that case the mini-buffer contents per se are usually
13447 unchanged. This code is of no real use in the mini-buffer
13448 since the handling of this_line_start_pos, etc., in redisplay
13449 handles the same cases. */
13450 && !EQ (window
, minibuf_window
)
13451 /* When splitting windows or for new windows, it happens that
13452 redisplay is called with a nil window_end_vpos or one being
13453 larger than the window. This should really be fixed in
13454 window.c. I don't have this on my list, now, so we do
13455 approximately the same as the old redisplay code. --gerd. */
13456 && INTEGERP (w
->window_end_vpos
)
13457 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13458 && (FRAME_WINDOW_P (f
)
13459 || !overlay_arrow_in_current_buffer_p ()))
13461 int this_scroll_margin
, top_scroll_margin
;
13462 struct glyph_row
*row
= NULL
;
13465 debug_method_add (w
, "cursor movement");
13468 /* Scroll if point within this distance from the top or bottom
13469 of the window. This is a pixel value. */
13470 if (scroll_margin
> 0)
13472 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13473 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13476 this_scroll_margin
= 0;
13478 top_scroll_margin
= this_scroll_margin
;
13479 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13480 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13482 /* Start with the row the cursor was displayed during the last
13483 not paused redisplay. Give up if that row is not valid. */
13484 if (w
->last_cursor
.vpos
< 0
13485 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13486 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13489 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13490 if (row
->mode_line_p
)
13492 if (!row
->enabled_p
)
13493 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13494 /* If rows are bidi-reordered, back up until we find a row
13495 that does not belong to a continuation line. This is
13496 because we must consider all rows of a continued line as
13497 candidates for cursor positioning, since row start and
13498 end positions change non-linearly with vertical position
13500 /* FIXME: Revisit this when glyph ``spilling'' in
13501 continuation lines' rows is implemented for
13502 bidi-reordered rows. */
13503 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13505 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13507 xassert (row
->enabled_p
);
13509 /* If we hit the beginning of the displayed portion
13510 without finding the first row of a continued
13512 if (row
<= w
->current_matrix
->rows
)
13514 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13522 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13525 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13527 if (PT
> XFASTINT (w
->last_point
))
13529 /* Point has moved forward. */
13530 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13531 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13533 xassert (row
->enabled_p
);
13537 /* The end position of a row equals the start position
13538 of the next row. If PT is there, we would rather
13539 display it in the next line. */
13540 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13541 && MATRIX_ROW_END_CHARPOS (row
) == PT
13542 && !cursor_row_p (w
, row
))
13545 /* If within the scroll margin, scroll. Note that
13546 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13547 the next line would be drawn, and that
13548 this_scroll_margin can be zero. */
13549 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13550 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13551 /* Line is completely visible last line in window
13552 and PT is to be set in the next line. */
13553 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13554 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13555 && !row
->ends_at_zv_p
13556 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13559 else if (PT
< XFASTINT (w
->last_point
))
13561 /* Cursor has to be moved backward. Note that PT >=
13562 CHARPOS (startp) because of the outer if-statement. */
13563 while (!row
->mode_line_p
13564 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13565 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13566 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13567 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13568 row
> w
->current_matrix
->rows
13569 && (row
-1)->ends_in_newline_from_string_p
))))
13570 && (row
->y
> top_scroll_margin
13571 || CHARPOS (startp
) == BEGV
))
13573 xassert (row
->enabled_p
);
13577 /* Consider the following case: Window starts at BEGV,
13578 there is invisible, intangible text at BEGV, so that
13579 display starts at some point START > BEGV. It can
13580 happen that we are called with PT somewhere between
13581 BEGV and START. Try to handle that case. */
13582 if (row
< w
->current_matrix
->rows
13583 || row
->mode_line_p
)
13585 row
= w
->current_matrix
->rows
;
13586 if (row
->mode_line_p
)
13590 /* Due to newlines in overlay strings, we may have to
13591 skip forward over overlay strings. */
13592 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13593 && MATRIX_ROW_END_CHARPOS (row
) == PT
13594 && !cursor_row_p (w
, row
))
13597 /* If within the scroll margin, scroll. */
13598 if (row
->y
< top_scroll_margin
13599 && CHARPOS (startp
) != BEGV
)
13604 /* Cursor did not move. So don't scroll even if cursor line
13605 is partially visible, as it was so before. */
13606 rc
= CURSOR_MOVEMENT_SUCCESS
;
13609 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13610 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13612 /* if PT is not in the glyph row, give up. */
13613 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13615 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13616 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13617 && make_cursor_line_fully_visible_p
)
13619 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13620 && !row
->ends_at_zv_p
13621 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13622 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13623 else if (row
->height
> window_box_height (w
))
13625 /* If we end up in a partially visible line, let's
13626 make it fully visible, except when it's taller
13627 than the window, in which case we can't do much
13630 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13634 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13635 if (!cursor_row_fully_visible_p (w
, 0, 1))
13636 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13638 rc
= CURSOR_MOVEMENT_SUCCESS
;
13642 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13643 else if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13645 /* With bidi-reordered rows, there could be more than
13646 one candidate row whose start and end positions
13647 occlude point. We need to let set_cursor_from_row
13648 find the best candidate. */
13649 /* FIXME: Revisit this when glyph ``spilling'' in
13650 continuation lines' rows is implemented for
13651 bidi-reordered rows. */
13656 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13658 /* As soon as we've found the first suitable row
13659 whose ends_at_zv_p flag is set, we are done. */
13661 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13663 rc
= CURSOR_MOVEMENT_SUCCESS
;
13668 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13669 && MATRIX_ROW_START_CHARPOS (row
) <= PT
13670 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13671 && cursor_row_p (w
, row
));
13672 /* If we didn't find any candidate rows, or exited the
13673 loop before all the candidates were examined, signal
13674 to the caller that this method failed. */
13675 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13677 || (MATRIX_ROW_START_CHARPOS (row
) <= PT
13678 && PT
<= MATRIX_ROW_END_CHARPOS (row
))))
13679 rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13681 rc
= CURSOR_MOVEMENT_SUCCESS
;
13687 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13689 rc
= CURSOR_MOVEMENT_SUCCESS
;
13694 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13695 && MATRIX_ROW_START_CHARPOS (row
) == PT
13696 && cursor_row_p (w
, row
));
13705 set_vertical_scroll_bar (w
)
13708 int start
, end
, whole
;
13710 /* Calculate the start and end positions for the current window.
13711 At some point, it would be nice to choose between scrollbars
13712 which reflect the whole buffer size, with special markers
13713 indicating narrowing, and scrollbars which reflect only the
13716 Note that mini-buffers sometimes aren't displaying any text. */
13717 if (!MINI_WINDOW_P (w
)
13718 || (w
== XWINDOW (minibuf_window
)
13719 && NILP (echo_area_buffer
[0])))
13721 struct buffer
*buf
= XBUFFER (w
->buffer
);
13722 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13723 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13724 /* I don't think this is guaranteed to be right. For the
13725 moment, we'll pretend it is. */
13726 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13730 if (whole
< (end
- start
))
13731 whole
= end
- start
;
13734 start
= end
= whole
= 0;
13736 /* Indicate what this scroll bar ought to be displaying now. */
13737 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13738 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13739 (w
, end
- start
, whole
, start
);
13743 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13744 selected_window is redisplayed.
13746 We can return without actually redisplaying the window if
13747 fonts_changed_p is nonzero. In that case, redisplay_internal will
13751 redisplay_window (window
, just_this_one_p
)
13752 Lisp_Object window
;
13753 int just_this_one_p
;
13755 struct window
*w
= XWINDOW (window
);
13756 struct frame
*f
= XFRAME (w
->frame
);
13757 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13758 struct buffer
*old
= current_buffer
;
13759 struct text_pos lpoint
, opoint
, startp
;
13760 int update_mode_line
;
13763 /* Record it now because it's overwritten. */
13764 int current_matrix_up_to_date_p
= 0;
13765 int used_current_matrix_p
= 0;
13766 /* This is less strict than current_matrix_up_to_date_p.
13767 It indictes that the buffer contents and narrowing are unchanged. */
13768 int buffer_unchanged_p
= 0;
13769 int temp_scroll_step
= 0;
13770 int count
= SPECPDL_INDEX ();
13772 int centering_position
= -1;
13773 int last_line_misfit
= 0;
13774 int beg_unchanged
, end_unchanged
;
13776 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13779 /* W must be a leaf window here. */
13780 xassert (!NILP (w
->buffer
));
13782 *w
->desired_matrix
->method
= 0;
13786 reconsider_clip_changes (w
, buffer
);
13788 /* Has the mode line to be updated? */
13789 update_mode_line
= (!NILP (w
->update_mode_line
)
13790 || update_mode_lines
13791 || buffer
->clip_changed
13792 || buffer
->prevent_redisplay_optimizations_p
);
13794 if (MINI_WINDOW_P (w
))
13796 if (w
== XWINDOW (echo_area_window
)
13797 && !NILP (echo_area_buffer
[0]))
13799 if (update_mode_line
)
13800 /* We may have to update a tty frame's menu bar or a
13801 tool-bar. Example `M-x C-h C-h C-g'. */
13802 goto finish_menu_bars
;
13804 /* We've already displayed the echo area glyphs in this window. */
13805 goto finish_scroll_bars
;
13807 else if ((w
!= XWINDOW (minibuf_window
)
13808 || minibuf_level
== 0)
13809 /* When buffer is nonempty, redisplay window normally. */
13810 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13811 /* Quail displays non-mini buffers in minibuffer window.
13812 In that case, redisplay the window normally. */
13813 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13815 /* W is a mini-buffer window, but it's not active, so clear
13817 int yb
= window_text_bottom_y (w
);
13818 struct glyph_row
*row
;
13821 for (y
= 0, row
= w
->desired_matrix
->rows
;
13823 y
+= row
->height
, ++row
)
13824 blank_row (w
, row
, y
);
13825 goto finish_scroll_bars
;
13828 clear_glyph_matrix (w
->desired_matrix
);
13831 /* Otherwise set up data on this window; select its buffer and point
13833 /* Really select the buffer, for the sake of buffer-local
13835 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13837 current_matrix_up_to_date_p
13838 = (!NILP (w
->window_end_valid
)
13839 && !current_buffer
->clip_changed
13840 && !current_buffer
->prevent_redisplay_optimizations_p
13841 && XFASTINT (w
->last_modified
) >= MODIFF
13842 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13844 /* Run the window-bottom-change-functions
13845 if it is possible that the text on the screen has changed
13846 (either due to modification of the text, or any other reason). */
13847 if (!current_matrix_up_to_date_p
13848 && !NILP (Vwindow_text_change_functions
))
13850 safe_run_hooks (Qwindow_text_change_functions
);
13854 beg_unchanged
= BEG_UNCHANGED
;
13855 end_unchanged
= END_UNCHANGED
;
13857 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13859 specbind (Qinhibit_point_motion_hooks
, Qt
);
13862 = (!NILP (w
->window_end_valid
)
13863 && !current_buffer
->clip_changed
13864 && XFASTINT (w
->last_modified
) >= MODIFF
13865 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13867 /* When windows_or_buffers_changed is non-zero, we can't rely on
13868 the window end being valid, so set it to nil there. */
13869 if (windows_or_buffers_changed
)
13871 /* If window starts on a continuation line, maybe adjust the
13872 window start in case the window's width changed. */
13873 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13874 compute_window_start_on_continuation_line (w
);
13876 w
->window_end_valid
= Qnil
;
13879 /* Some sanity checks. */
13880 CHECK_WINDOW_END (w
);
13881 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13883 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13886 /* If %c is in mode line, update it if needed. */
13887 if (!NILP (w
->column_number_displayed
)
13888 /* This alternative quickly identifies a common case
13889 where no change is needed. */
13890 && !(PT
== XFASTINT (w
->last_point
)
13891 && XFASTINT (w
->last_modified
) >= MODIFF
13892 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13893 && (XFASTINT (w
->column_number_displayed
)
13894 != (int) current_column ())) /* iftc */
13895 update_mode_line
= 1;
13897 /* Count number of windows showing the selected buffer. An indirect
13898 buffer counts as its base buffer. */
13899 if (!just_this_one_p
)
13901 struct buffer
*current_base
, *window_base
;
13902 current_base
= current_buffer
;
13903 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13904 if (current_base
->base_buffer
)
13905 current_base
= current_base
->base_buffer
;
13906 if (window_base
->base_buffer
)
13907 window_base
= window_base
->base_buffer
;
13908 if (current_base
== window_base
)
13912 /* Point refers normally to the selected window. For any other
13913 window, set up appropriate value. */
13914 if (!EQ (window
, selected_window
))
13916 int new_pt
= XMARKER (w
->pointm
)->charpos
;
13917 int new_pt_byte
= marker_byte_position (w
->pointm
);
13921 new_pt_byte
= BEGV_BYTE
;
13922 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13924 else if (new_pt
> (ZV
- 1))
13927 new_pt_byte
= ZV_BYTE
;
13928 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13931 /* We don't use SET_PT so that the point-motion hooks don't run. */
13932 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13935 /* If any of the character widths specified in the display table
13936 have changed, invalidate the width run cache. It's true that
13937 this may be a bit late to catch such changes, but the rest of
13938 redisplay goes (non-fatally) haywire when the display table is
13939 changed, so why should we worry about doing any better? */
13940 if (current_buffer
->width_run_cache
)
13942 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13944 if (! disptab_matches_widthtab (disptab
,
13945 XVECTOR (current_buffer
->width_table
)))
13947 invalidate_region_cache (current_buffer
,
13948 current_buffer
->width_run_cache
,
13950 recompute_width_table (current_buffer
, disptab
);
13954 /* If window-start is screwed up, choose a new one. */
13955 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13958 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13960 /* If someone specified a new starting point but did not insist,
13961 check whether it can be used. */
13962 if (!NILP (w
->optional_new_start
)
13963 && CHARPOS (startp
) >= BEGV
13964 && CHARPOS (startp
) <= ZV
)
13966 w
->optional_new_start
= Qnil
;
13967 start_display (&it
, w
, startp
);
13968 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13969 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13970 if (IT_CHARPOS (it
) == PT
)
13971 w
->force_start
= Qt
;
13972 /* IT may overshoot PT if text at PT is invisible. */
13973 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13974 w
->force_start
= Qt
;
13979 /* Handle case where place to start displaying has been specified,
13980 unless the specified location is outside the accessible range. */
13981 if (!NILP (w
->force_start
)
13982 || w
->frozen_window_start_p
)
13984 /* We set this later on if we have to adjust point. */
13987 w
->force_start
= Qnil
;
13989 w
->window_end_valid
= Qnil
;
13991 /* Forget any recorded base line for line number display. */
13992 if (!buffer_unchanged_p
)
13993 w
->base_line_number
= Qnil
;
13995 /* Redisplay the mode line. Select the buffer properly for that.
13996 Also, run the hook window-scroll-functions
13997 because we have scrolled. */
13998 /* Note, we do this after clearing force_start because
13999 if there's an error, it is better to forget about force_start
14000 than to get into an infinite loop calling the hook functions
14001 and having them get more errors. */
14002 if (!update_mode_line
14003 || ! NILP (Vwindow_scroll_functions
))
14005 update_mode_line
= 1;
14006 w
->update_mode_line
= Qt
;
14007 startp
= run_window_scroll_functions (window
, startp
);
14010 w
->last_modified
= make_number (0);
14011 w
->last_overlay_modified
= make_number (0);
14012 if (CHARPOS (startp
) < BEGV
)
14013 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
14014 else if (CHARPOS (startp
) > ZV
)
14015 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
14017 /* Redisplay, then check if cursor has been set during the
14018 redisplay. Give up if new fonts were loaded. */
14019 /* We used to issue a CHECK_MARGINS argument to try_window here,
14020 but this causes scrolling to fail when point begins inside
14021 the scroll margin (bug#148) -- cyd */
14022 if (!try_window (window
, startp
, 0))
14024 w
->force_start
= Qt
;
14025 clear_glyph_matrix (w
->desired_matrix
);
14026 goto need_larger_matrices
;
14029 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
14031 /* If point does not appear, try to move point so it does
14032 appear. The desired matrix has been built above, so we
14033 can use it here. */
14034 new_vpos
= window_box_height (w
) / 2;
14037 if (!cursor_row_fully_visible_p (w
, 0, 0))
14039 /* Point does appear, but on a line partly visible at end of window.
14040 Move it back to a fully-visible line. */
14041 new_vpos
= window_box_height (w
);
14044 /* If we need to move point for either of the above reasons,
14045 now actually do it. */
14048 struct glyph_row
*row
;
14050 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14051 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14054 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14055 MATRIX_ROW_START_BYTEPOS (row
));
14057 if (w
!= XWINDOW (selected_window
))
14058 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14059 else if (current_buffer
== old
)
14060 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14062 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14064 /* If we are highlighting the region, then we just changed
14065 the region, so redisplay to show it. */
14066 if (!NILP (Vtransient_mark_mode
)
14067 && !NILP (current_buffer
->mark_active
))
14069 clear_glyph_matrix (w
->desired_matrix
);
14070 if (!try_window (window
, startp
, 0))
14071 goto need_larger_matrices
;
14076 debug_method_add (w
, "forced window start");
14081 /* Handle case where text has not changed, only point, and it has
14082 not moved off the frame, and we are not retrying after hscroll.
14083 (current_matrix_up_to_date_p is nonzero when retrying.) */
14084 if (current_matrix_up_to_date_p
14085 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14086 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14090 case CURSOR_MOVEMENT_SUCCESS
:
14091 used_current_matrix_p
= 1;
14094 case CURSOR_MOVEMENT_MUST_SCROLL
:
14095 goto try_to_scroll
;
14101 /* If current starting point was originally the beginning of a line
14102 but no longer is, find a new starting point. */
14103 else if (!NILP (w
->start_at_line_beg
)
14104 && !(CHARPOS (startp
) <= BEGV
14105 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14108 debug_method_add (w
, "recenter 1");
14113 /* Try scrolling with try_window_id. Value is > 0 if update has
14114 been done, it is -1 if we know that the same window start will
14115 not work. It is 0 if unsuccessful for some other reason. */
14116 else if ((tem
= try_window_id (w
)) != 0)
14119 debug_method_add (w
, "try_window_id %d", tem
);
14122 if (fonts_changed_p
)
14123 goto need_larger_matrices
;
14127 /* Otherwise try_window_id has returned -1 which means that we
14128 don't want the alternative below this comment to execute. */
14130 else if (CHARPOS (startp
) >= BEGV
14131 && CHARPOS (startp
) <= ZV
14132 && PT
>= CHARPOS (startp
)
14133 && (CHARPOS (startp
) < ZV
14134 /* Avoid starting at end of buffer. */
14135 || CHARPOS (startp
) == BEGV
14136 || (XFASTINT (w
->last_modified
) >= MODIFF
14137 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14140 /* If first window line is a continuation line, and window start
14141 is inside the modified region, but the first change is before
14142 current window start, we must select a new window start.
14144 However, if this is the result of a down-mouse event (e.g. by
14145 extending the mouse-drag-overlay), we don't want to select a
14146 new window start, since that would change the position under
14147 the mouse, resulting in an unwanted mouse-movement rather
14148 than a simple mouse-click. */
14149 if (NILP (w
->start_at_line_beg
)
14150 && NILP (do_mouse_tracking
)
14151 && CHARPOS (startp
) > BEGV
14152 && CHARPOS (startp
) > BEG
+ beg_unchanged
14153 && CHARPOS (startp
) <= Z
- end_unchanged
14154 /* Even if w->start_at_line_beg is nil, a new window may
14155 start at a line_beg, since that's how set_buffer_window
14156 sets it. So, we need to check the return value of
14157 compute_window_start_on_continuation_line. (See also
14159 && XMARKER (w
->start
)->buffer
== current_buffer
14160 && compute_window_start_on_continuation_line (w
))
14162 w
->force_start
= Qt
;
14163 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14168 debug_method_add (w
, "same window start");
14171 /* Try to redisplay starting at same place as before.
14172 If point has not moved off frame, accept the results. */
14173 if (!current_matrix_up_to_date_p
14174 /* Don't use try_window_reusing_current_matrix in this case
14175 because a window scroll function can have changed the
14177 || !NILP (Vwindow_scroll_functions
)
14178 || MINI_WINDOW_P (w
)
14179 || !(used_current_matrix_p
14180 = try_window_reusing_current_matrix (w
)))
14182 IF_DEBUG (debug_method_add (w
, "1"));
14183 if (try_window (window
, startp
, 1) < 0)
14184 /* -1 means we need to scroll.
14185 0 means we need new matrices, but fonts_changed_p
14186 is set in that case, so we will detect it below. */
14187 goto try_to_scroll
;
14190 if (fonts_changed_p
)
14191 goto need_larger_matrices
;
14193 if (w
->cursor
.vpos
>= 0)
14195 if (!just_this_one_p
14196 || current_buffer
->clip_changed
14197 || BEG_UNCHANGED
< CHARPOS (startp
))
14198 /* Forget any recorded base line for line number display. */
14199 w
->base_line_number
= Qnil
;
14201 if (!cursor_row_fully_visible_p (w
, 1, 0))
14203 clear_glyph_matrix (w
->desired_matrix
);
14204 last_line_misfit
= 1;
14206 /* Drop through and scroll. */
14211 clear_glyph_matrix (w
->desired_matrix
);
14216 w
->last_modified
= make_number (0);
14217 w
->last_overlay_modified
= make_number (0);
14219 /* Redisplay the mode line. Select the buffer properly for that. */
14220 if (!update_mode_line
)
14222 update_mode_line
= 1;
14223 w
->update_mode_line
= Qt
;
14226 /* Try to scroll by specified few lines. */
14227 if ((scroll_conservatively
14229 || temp_scroll_step
14230 || NUMBERP (current_buffer
->scroll_up_aggressively
)
14231 || NUMBERP (current_buffer
->scroll_down_aggressively
))
14232 && !current_buffer
->clip_changed
14233 && CHARPOS (startp
) >= BEGV
14234 && CHARPOS (startp
) <= ZV
)
14236 /* The function returns -1 if new fonts were loaded, 1 if
14237 successful, 0 if not successful. */
14238 int rc
= try_scrolling (window
, just_this_one_p
,
14239 scroll_conservatively
,
14241 temp_scroll_step
, last_line_misfit
);
14244 case SCROLLING_SUCCESS
:
14247 case SCROLLING_NEED_LARGER_MATRICES
:
14248 goto need_larger_matrices
;
14250 case SCROLLING_FAILED
:
14258 /* Finally, just choose place to start which centers point */
14261 if (centering_position
< 0)
14262 centering_position
= window_box_height (w
) / 2;
14265 debug_method_add (w
, "recenter");
14268 /* w->vscroll = 0; */
14270 /* Forget any previously recorded base line for line number display. */
14271 if (!buffer_unchanged_p
)
14272 w
->base_line_number
= Qnil
;
14274 /* Move backward half the height of the window. */
14275 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14276 it
.current_y
= it
.last_visible_y
;
14277 move_it_vertically_backward (&it
, centering_position
);
14278 xassert (IT_CHARPOS (it
) >= BEGV
);
14280 /* The function move_it_vertically_backward may move over more
14281 than the specified y-distance. If it->w is small, e.g. a
14282 mini-buffer window, we may end up in front of the window's
14283 display area. Start displaying at the start of the line
14284 containing PT in this case. */
14285 if (it
.current_y
<= 0)
14287 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14288 move_it_vertically_backward (&it
, 0);
14292 it
.current_x
= it
.hpos
= 0;
14294 /* Set startp here explicitly in case that helps avoid an infinite loop
14295 in case the window-scroll-functions functions get errors. */
14296 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14298 /* Run scroll hooks. */
14299 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14301 /* Redisplay the window. */
14302 if (!current_matrix_up_to_date_p
14303 || windows_or_buffers_changed
14304 || cursor_type_changed
14305 /* Don't use try_window_reusing_current_matrix in this case
14306 because it can have changed the buffer. */
14307 || !NILP (Vwindow_scroll_functions
)
14308 || !just_this_one_p
14309 || MINI_WINDOW_P (w
)
14310 || !(used_current_matrix_p
14311 = try_window_reusing_current_matrix (w
)))
14312 try_window (window
, startp
, 0);
14314 /* If new fonts have been loaded (due to fontsets), give up. We
14315 have to start a new redisplay since we need to re-adjust glyph
14317 if (fonts_changed_p
)
14318 goto need_larger_matrices
;
14320 /* If cursor did not appear assume that the middle of the window is
14321 in the first line of the window. Do it again with the next line.
14322 (Imagine a window of height 100, displaying two lines of height
14323 60. Moving back 50 from it->last_visible_y will end in the first
14325 if (w
->cursor
.vpos
< 0)
14327 if (!NILP (w
->window_end_valid
)
14328 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14330 clear_glyph_matrix (w
->desired_matrix
);
14331 move_it_by_lines (&it
, 1, 0);
14332 try_window (window
, it
.current
.pos
, 0);
14334 else if (PT
< IT_CHARPOS (it
))
14336 clear_glyph_matrix (w
->desired_matrix
);
14337 move_it_by_lines (&it
, -1, 0);
14338 try_window (window
, it
.current
.pos
, 0);
14342 /* Not much we can do about it. */
14346 /* Consider the following case: Window starts at BEGV, there is
14347 invisible, intangible text at BEGV, so that display starts at
14348 some point START > BEGV. It can happen that we are called with
14349 PT somewhere between BEGV and START. Try to handle that case. */
14350 if (w
->cursor
.vpos
< 0)
14352 struct glyph_row
*row
= w
->current_matrix
->rows
;
14353 if (row
->mode_line_p
)
14355 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14358 if (!cursor_row_fully_visible_p (w
, 0, 0))
14360 /* If vscroll is enabled, disable it and try again. */
14364 clear_glyph_matrix (w
->desired_matrix
);
14368 /* If centering point failed to make the whole line visible,
14369 put point at the top instead. That has to make the whole line
14370 visible, if it can be done. */
14371 if (centering_position
== 0)
14374 clear_glyph_matrix (w
->desired_matrix
);
14375 centering_position
= 0;
14381 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14382 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14383 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14386 /* Display the mode line, if we must. */
14387 if ((update_mode_line
14388 /* If window not full width, must redo its mode line
14389 if (a) the window to its side is being redone and
14390 (b) we do a frame-based redisplay. This is a consequence
14391 of how inverted lines are drawn in frame-based redisplay. */
14392 || (!just_this_one_p
14393 && !FRAME_WINDOW_P (f
)
14394 && !WINDOW_FULL_WIDTH_P (w
))
14395 /* Line number to display. */
14396 || INTEGERP (w
->base_line_pos
)
14397 /* Column number is displayed and different from the one displayed. */
14398 || (!NILP (w
->column_number_displayed
)
14399 && (XFASTINT (w
->column_number_displayed
)
14400 != (int) current_column ()))) /* iftc */
14401 /* This means that the window has a mode line. */
14402 && (WINDOW_WANTS_MODELINE_P (w
)
14403 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14405 display_mode_lines (w
);
14407 /* If mode line height has changed, arrange for a thorough
14408 immediate redisplay using the correct mode line height. */
14409 if (WINDOW_WANTS_MODELINE_P (w
)
14410 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14412 fonts_changed_p
= 1;
14413 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14414 = DESIRED_MODE_LINE_HEIGHT (w
);
14417 /* If header line height has changed, arrange for a thorough
14418 immediate redisplay using the correct header line height. */
14419 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14420 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14422 fonts_changed_p
= 1;
14423 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14424 = DESIRED_HEADER_LINE_HEIGHT (w
);
14427 if (fonts_changed_p
)
14428 goto need_larger_matrices
;
14431 if (!line_number_displayed
14432 && !BUFFERP (w
->base_line_pos
))
14434 w
->base_line_pos
= Qnil
;
14435 w
->base_line_number
= Qnil
;
14440 /* When we reach a frame's selected window, redo the frame's menu bar. */
14441 if (update_mode_line
14442 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14444 int redisplay_menu_p
= 0;
14445 int redisplay_tool_bar_p
= 0;
14447 if (FRAME_WINDOW_P (f
))
14449 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14450 || defined (HAVE_NS) || defined (USE_GTK)
14451 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14453 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14457 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14459 if (redisplay_menu_p
)
14460 display_menu_bar (w
);
14462 #ifdef HAVE_WINDOW_SYSTEM
14463 if (FRAME_WINDOW_P (f
))
14465 #if defined (USE_GTK) || defined (HAVE_NS)
14466 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
14468 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
14469 && (FRAME_TOOL_BAR_LINES (f
) > 0
14470 || !NILP (Vauto_resize_tool_bars
));
14473 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
14475 extern int ignore_mouse_drag_p
;
14476 ignore_mouse_drag_p
= 1;
14482 #ifdef HAVE_WINDOW_SYSTEM
14483 if (FRAME_WINDOW_P (f
)
14484 && update_window_fringes (w
, (just_this_one_p
14485 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14486 || w
->pseudo_window_p
)))
14490 if (draw_window_fringes (w
, 1))
14491 x_draw_vertical_border (w
);
14495 #endif /* HAVE_WINDOW_SYSTEM */
14497 /* We go to this label, with fonts_changed_p nonzero,
14498 if it is necessary to try again using larger glyph matrices.
14499 We have to redeem the scroll bar even in this case,
14500 because the loop in redisplay_internal expects that. */
14501 need_larger_matrices
:
14503 finish_scroll_bars
:
14505 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14507 /* Set the thumb's position and size. */
14508 set_vertical_scroll_bar (w
);
14510 /* Note that we actually used the scroll bar attached to this
14511 window, so it shouldn't be deleted at the end of redisplay. */
14512 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14513 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14516 /* Restore current_buffer and value of point in it. */
14517 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14518 set_buffer_internal_1 (old
);
14519 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14520 shorter. This can be caused by log truncation in *Messages*. */
14521 if (CHARPOS (lpoint
) <= ZV
)
14522 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14524 unbind_to (count
, Qnil
);
14528 /* Build the complete desired matrix of WINDOW with a window start
14529 buffer position POS.
14531 Value is 1 if successful. It is zero if fonts were loaded during
14532 redisplay which makes re-adjusting glyph matrices necessary, and -1
14533 if point would appear in the scroll margins.
14534 (We check that only if CHECK_MARGINS is nonzero. */
14537 try_window (window
, pos
, check_margins
)
14538 Lisp_Object window
;
14539 struct text_pos pos
;
14542 struct window
*w
= XWINDOW (window
);
14544 struct glyph_row
*last_text_row
= NULL
;
14545 struct frame
*f
= XFRAME (w
->frame
);
14547 /* Make POS the new window start. */
14548 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14550 /* Mark cursor position as unknown. No overlay arrow seen. */
14551 w
->cursor
.vpos
= -1;
14552 overlay_arrow_seen
= 0;
14554 /* Initialize iterator and info to start at POS. */
14555 start_display (&it
, w
, pos
);
14557 /* Display all lines of W. */
14558 while (it
.current_y
< it
.last_visible_y
)
14560 if (display_line (&it
))
14561 last_text_row
= it
.glyph_row
- 1;
14562 if (fonts_changed_p
)
14566 /* Don't let the cursor end in the scroll margins. */
14568 && !MINI_WINDOW_P (w
))
14570 int this_scroll_margin
;
14572 if (scroll_margin
> 0)
14574 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14575 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14578 this_scroll_margin
= 0;
14580 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14581 && w
->cursor
.y
< this_scroll_margin
14582 && CHARPOS (pos
) > BEGV
14583 && IT_CHARPOS (it
) < ZV
)
14584 /* rms: considering make_cursor_line_fully_visible_p here
14585 seems to give wrong results. We don't want to recenter
14586 when the last line is partly visible, we want to allow
14587 that case to be handled in the usual way. */
14588 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14590 w
->cursor
.vpos
= -1;
14591 clear_glyph_matrix (w
->desired_matrix
);
14596 /* If bottom moved off end of frame, change mode line percentage. */
14597 if (XFASTINT (w
->window_end_pos
) <= 0
14598 && Z
!= IT_CHARPOS (it
))
14599 w
->update_mode_line
= Qt
;
14601 /* Set window_end_pos to the offset of the last character displayed
14602 on the window from the end of current_buffer. Set
14603 window_end_vpos to its row number. */
14606 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14607 w
->window_end_bytepos
14608 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14610 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14612 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14613 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14614 ->displays_text_p
);
14618 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14619 w
->window_end_pos
= make_number (Z
- ZV
);
14620 w
->window_end_vpos
= make_number (0);
14623 /* But that is not valid info until redisplay finishes. */
14624 w
->window_end_valid
= Qnil
;
14630 /************************************************************************
14631 Window redisplay reusing current matrix when buffer has not changed
14632 ************************************************************************/
14634 /* Try redisplay of window W showing an unchanged buffer with a
14635 different window start than the last time it was displayed by
14636 reusing its current matrix. Value is non-zero if successful.
14637 W->start is the new window start. */
14640 try_window_reusing_current_matrix (w
)
14643 struct frame
*f
= XFRAME (w
->frame
);
14644 struct glyph_row
*row
, *bottom_row
;
14647 struct text_pos start
, new_start
;
14648 int nrows_scrolled
, i
;
14649 struct glyph_row
*last_text_row
;
14650 struct glyph_row
*last_reused_text_row
;
14651 struct glyph_row
*start_row
;
14652 int start_vpos
, min_y
, max_y
;
14655 if (inhibit_try_window_reusing
)
14659 if (/* This function doesn't handle terminal frames. */
14660 !FRAME_WINDOW_P (f
)
14661 /* Don't try to reuse the display if windows have been split
14663 || windows_or_buffers_changed
14664 || cursor_type_changed
)
14667 /* Can't do this if region may have changed. */
14668 if ((!NILP (Vtransient_mark_mode
)
14669 && !NILP (current_buffer
->mark_active
))
14670 || !NILP (w
->region_showing
)
14671 || !NILP (Vshow_trailing_whitespace
))
14674 /* If top-line visibility has changed, give up. */
14675 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14676 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14679 /* Give up if old or new display is scrolled vertically. We could
14680 make this function handle this, but right now it doesn't. */
14681 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14682 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14685 /* The variable new_start now holds the new window start. The old
14686 start `start' can be determined from the current matrix. */
14687 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14688 start
= start_row
->start
.pos
;
14689 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14691 /* Clear the desired matrix for the display below. */
14692 clear_glyph_matrix (w
->desired_matrix
);
14694 if (CHARPOS (new_start
) <= CHARPOS (start
))
14698 /* Don't use this method if the display starts with an ellipsis
14699 displayed for invisible text. It's not easy to handle that case
14700 below, and it's certainly not worth the effort since this is
14701 not a frequent case. */
14702 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14705 IF_DEBUG (debug_method_add (w
, "twu1"));
14707 /* Display up to a row that can be reused. The variable
14708 last_text_row is set to the last row displayed that displays
14709 text. Note that it.vpos == 0 if or if not there is a
14710 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14711 start_display (&it
, w
, new_start
);
14712 first_row_y
= it
.current_y
;
14713 w
->cursor
.vpos
= -1;
14714 last_text_row
= last_reused_text_row
= NULL
;
14716 while (it
.current_y
< it
.last_visible_y
14717 && !fonts_changed_p
)
14719 /* If we have reached into the characters in the START row,
14720 that means the line boundaries have changed. So we
14721 can't start copying with the row START. Maybe it will
14722 work to start copying with the following row. */
14723 while (IT_CHARPOS (it
) > CHARPOS (start
))
14725 /* Advance to the next row as the "start". */
14727 start
= start_row
->start
.pos
;
14728 /* If there are no more rows to try, or just one, give up. */
14729 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14730 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14731 || CHARPOS (start
) == ZV
)
14733 clear_glyph_matrix (w
->desired_matrix
);
14737 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14739 /* If we have reached alignment,
14740 we can copy the rest of the rows. */
14741 if (IT_CHARPOS (it
) == CHARPOS (start
))
14744 if (display_line (&it
))
14745 last_text_row
= it
.glyph_row
- 1;
14748 /* A value of current_y < last_visible_y means that we stopped
14749 at the previous window start, which in turn means that we
14750 have at least one reusable row. */
14751 if (it
.current_y
< it
.last_visible_y
)
14753 /* IT.vpos always starts from 0; it counts text lines. */
14754 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14756 /* Find PT if not already found in the lines displayed. */
14757 if (w
->cursor
.vpos
< 0)
14759 int dy
= it
.current_y
- start_row
->y
;
14761 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14762 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14764 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14765 dy
, nrows_scrolled
);
14768 clear_glyph_matrix (w
->desired_matrix
);
14773 /* Scroll the display. Do it before the current matrix is
14774 changed. The problem here is that update has not yet
14775 run, i.e. part of the current matrix is not up to date.
14776 scroll_run_hook will clear the cursor, and use the
14777 current matrix to get the height of the row the cursor is
14779 run
.current_y
= start_row
->y
;
14780 run
.desired_y
= it
.current_y
;
14781 run
.height
= it
.last_visible_y
- it
.current_y
;
14783 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14786 FRAME_RIF (f
)->update_window_begin_hook (w
);
14787 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14788 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14789 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14793 /* Shift current matrix down by nrows_scrolled lines. */
14794 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14795 rotate_matrix (w
->current_matrix
,
14797 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14800 /* Disable lines that must be updated. */
14801 for (i
= 0; i
< nrows_scrolled
; ++i
)
14802 (start_row
+ i
)->enabled_p
= 0;
14804 /* Re-compute Y positions. */
14805 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14806 max_y
= it
.last_visible_y
;
14807 for (row
= start_row
+ nrows_scrolled
;
14811 row
->y
= it
.current_y
;
14812 row
->visible_height
= row
->height
;
14814 if (row
->y
< min_y
)
14815 row
->visible_height
-= min_y
- row
->y
;
14816 if (row
->y
+ row
->height
> max_y
)
14817 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14818 row
->redraw_fringe_bitmaps_p
= 1;
14820 it
.current_y
+= row
->height
;
14822 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14823 last_reused_text_row
= row
;
14824 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14828 /* Disable lines in the current matrix which are now
14829 below the window. */
14830 for (++row
; row
< bottom_row
; ++row
)
14831 row
->enabled_p
= row
->mode_line_p
= 0;
14834 /* Update window_end_pos etc.; last_reused_text_row is the last
14835 reused row from the current matrix containing text, if any.
14836 The value of last_text_row is the last displayed line
14837 containing text. */
14838 if (last_reused_text_row
)
14840 w
->window_end_bytepos
14841 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14843 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14845 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14846 w
->current_matrix
));
14848 else if (last_text_row
)
14850 w
->window_end_bytepos
14851 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14853 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14855 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14859 /* This window must be completely empty. */
14860 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14861 w
->window_end_pos
= make_number (Z
- ZV
);
14862 w
->window_end_vpos
= make_number (0);
14864 w
->window_end_valid
= Qnil
;
14866 /* Update hint: don't try scrolling again in update_window. */
14867 w
->desired_matrix
->no_scrolling_p
= 1;
14870 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14874 else if (CHARPOS (new_start
) > CHARPOS (start
))
14876 struct glyph_row
*pt_row
, *row
;
14877 struct glyph_row
*first_reusable_row
;
14878 struct glyph_row
*first_row_to_display
;
14880 int yb
= window_text_bottom_y (w
);
14882 /* Find the row starting at new_start, if there is one. Don't
14883 reuse a partially visible line at the end. */
14884 first_reusable_row
= start_row
;
14885 while (first_reusable_row
->enabled_p
14886 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14887 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14888 < CHARPOS (new_start
)))
14889 ++first_reusable_row
;
14891 /* Give up if there is no row to reuse. */
14892 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14893 || !first_reusable_row
->enabled_p
14894 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14895 != CHARPOS (new_start
)))
14898 /* We can reuse fully visible rows beginning with
14899 first_reusable_row to the end of the window. Set
14900 first_row_to_display to the first row that cannot be reused.
14901 Set pt_row to the row containing point, if there is any. */
14903 for (first_row_to_display
= first_reusable_row
;
14904 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14905 ++first_row_to_display
)
14907 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14908 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14909 pt_row
= first_row_to_display
;
14912 /* Start displaying at the start of first_row_to_display. */
14913 xassert (first_row_to_display
->y
< yb
);
14914 init_to_row_start (&it
, w
, first_row_to_display
);
14916 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14918 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14920 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14921 + WINDOW_HEADER_LINE_HEIGHT (w
));
14923 /* Display lines beginning with first_row_to_display in the
14924 desired matrix. Set last_text_row to the last row displayed
14925 that displays text. */
14926 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14927 if (pt_row
== NULL
)
14928 w
->cursor
.vpos
= -1;
14929 last_text_row
= NULL
;
14930 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14931 if (display_line (&it
))
14932 last_text_row
= it
.glyph_row
- 1;
14934 /* If point is in a reused row, adjust y and vpos of the cursor
14938 w
->cursor
.vpos
-= nrows_scrolled
;
14939 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14942 /* Give up if point isn't in a row displayed or reused. (This
14943 also handles the case where w->cursor.vpos < nrows_scrolled
14944 after the calls to display_line, which can happen with scroll
14945 margins. See bug#1295.) */
14946 if (w
->cursor
.vpos
< 0)
14948 clear_glyph_matrix (w
->desired_matrix
);
14952 /* Scroll the display. */
14953 run
.current_y
= first_reusable_row
->y
;
14954 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14955 run
.height
= it
.last_visible_y
- run
.current_y
;
14956 dy
= run
.current_y
- run
.desired_y
;
14961 FRAME_RIF (f
)->update_window_begin_hook (w
);
14962 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14963 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14964 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14968 /* Adjust Y positions of reused rows. */
14969 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14970 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14971 max_y
= it
.last_visible_y
;
14972 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14975 row
->visible_height
= row
->height
;
14976 if (row
->y
< min_y
)
14977 row
->visible_height
-= min_y
- row
->y
;
14978 if (row
->y
+ row
->height
> max_y
)
14979 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14980 row
->redraw_fringe_bitmaps_p
= 1;
14983 /* Scroll the current matrix. */
14984 xassert (nrows_scrolled
> 0);
14985 rotate_matrix (w
->current_matrix
,
14987 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14990 /* Disable rows not reused. */
14991 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
14992 row
->enabled_p
= 0;
14994 /* Point may have moved to a different line, so we cannot assume that
14995 the previous cursor position is valid; locate the correct row. */
14998 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14999 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15003 w
->cursor
.y
= row
->y
;
15005 if (row
< bottom_row
)
15007 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15008 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15009 struct glyph
*orig_glyph
= glyph
;
15010 struct cursor_pos orig_cursor
= w
->cursor
;
15013 && (!BUFFERP (glyph
->object
)
15014 || glyph
->charpos
!= PT
);
15018 w
->cursor
.x
+= glyph
->pixel_width
;
15020 /* With bidi reordering, charpos changes non-linearly
15021 with hpos, so the right glyph could be to the
15023 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
15024 && (!BUFFERP (glyph
->object
) || glyph
->charpos
!= PT
))
15026 struct glyph
*start_glyph
= row
->glyphs
[TEXT_AREA
];
15028 glyph
= orig_glyph
- 1;
15029 orig_cursor
.hpos
--;
15030 orig_cursor
.x
-= glyph
->pixel_width
;
15031 for (; glyph
>= start_glyph
15032 && (!BUFFERP (glyph
->object
)
15033 || glyph
->charpos
!= PT
);
15037 w
->cursor
.x
-= glyph
->pixel_width
;
15039 if (BUFFERP (glyph
->object
) && glyph
->charpos
== PT
)
15040 w
->cursor
= orig_cursor
;
15045 /* Adjust window end. A null value of last_text_row means that
15046 the window end is in reused rows which in turn means that
15047 only its vpos can have changed. */
15050 w
->window_end_bytepos
15051 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15053 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15055 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15060 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15063 w
->window_end_valid
= Qnil
;
15064 w
->desired_matrix
->no_scrolling_p
= 1;
15067 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15077 /************************************************************************
15078 Window redisplay reusing current matrix when buffer has changed
15079 ************************************************************************/
15081 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
15082 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
15084 static struct glyph_row
*
15085 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
15086 struct glyph_row
*));
15089 /* Return the last row in MATRIX displaying text. If row START is
15090 non-null, start searching with that row. IT gives the dimensions
15091 of the display. Value is null if matrix is empty; otherwise it is
15092 a pointer to the row found. */
15094 static struct glyph_row
*
15095 find_last_row_displaying_text (matrix
, it
, start
)
15096 struct glyph_matrix
*matrix
;
15098 struct glyph_row
*start
;
15100 struct glyph_row
*row
, *row_found
;
15102 /* Set row_found to the last row in IT->w's current matrix
15103 displaying text. The loop looks funny but think of partially
15106 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15107 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15109 xassert (row
->enabled_p
);
15111 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15120 /* Return the last row in the current matrix of W that is not affected
15121 by changes at the start of current_buffer that occurred since W's
15122 current matrix was built. Value is null if no such row exists.
15124 BEG_UNCHANGED us the number of characters unchanged at the start of
15125 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15126 first changed character in current_buffer. Characters at positions <
15127 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15128 when the current matrix was built. */
15130 static struct glyph_row
*
15131 find_last_unchanged_at_beg_row (w
)
15134 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15135 struct glyph_row
*row
;
15136 struct glyph_row
*row_found
= NULL
;
15137 int yb
= window_text_bottom_y (w
);
15139 /* Find the last row displaying unchanged text. */
15140 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15141 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15142 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15145 if (/* If row ends before first_changed_pos, it is unchanged,
15146 except in some case. */
15147 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15148 /* When row ends in ZV and we write at ZV it is not
15150 && !row
->ends_at_zv_p
15151 /* When first_changed_pos is the end of a continued line,
15152 row is not unchanged because it may be no longer
15154 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15155 && (row
->continued_p
15156 || row
->exact_window_width_line_p
)))
15159 /* Stop if last visible row. */
15160 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15168 /* Find the first glyph row in the current matrix of W that is not
15169 affected by changes at the end of current_buffer since the
15170 time W's current matrix was built.
15172 Return in *DELTA the number of chars by which buffer positions in
15173 unchanged text at the end of current_buffer must be adjusted.
15175 Return in *DELTA_BYTES the corresponding number of bytes.
15177 Value is null if no such row exists, i.e. all rows are affected by
15180 static struct glyph_row
*
15181 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
15183 int *delta
, *delta_bytes
;
15185 struct glyph_row
*row
;
15186 struct glyph_row
*row_found
= NULL
;
15188 *delta
= *delta_bytes
= 0;
15190 /* Display must not have been paused, otherwise the current matrix
15191 is not up to date. */
15192 eassert (!NILP (w
->window_end_valid
));
15194 /* A value of window_end_pos >= END_UNCHANGED means that the window
15195 end is in the range of changed text. If so, there is no
15196 unchanged row at the end of W's current matrix. */
15197 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15200 /* Set row to the last row in W's current matrix displaying text. */
15201 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15203 /* If matrix is entirely empty, no unchanged row exists. */
15204 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15206 /* The value of row is the last glyph row in the matrix having a
15207 meaningful buffer position in it. The end position of row
15208 corresponds to window_end_pos. This allows us to translate
15209 buffer positions in the current matrix to current buffer
15210 positions for characters not in changed text. */
15211 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15212 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15213 int last_unchanged_pos
, last_unchanged_pos_old
;
15214 struct glyph_row
*first_text_row
15215 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15217 *delta
= Z
- Z_old
;
15218 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15220 /* Set last_unchanged_pos to the buffer position of the last
15221 character in the buffer that has not been changed. Z is the
15222 index + 1 of the last character in current_buffer, i.e. by
15223 subtracting END_UNCHANGED we get the index of the last
15224 unchanged character, and we have to add BEG to get its buffer
15226 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15227 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15229 /* Search backward from ROW for a row displaying a line that
15230 starts at a minimum position >= last_unchanged_pos_old. */
15231 for (; row
> first_text_row
; --row
)
15233 /* This used to abort, but it can happen.
15234 It is ok to just stop the search instead here. KFS. */
15235 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15238 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15243 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15249 /* Make sure that glyph rows in the current matrix of window W
15250 reference the same glyph memory as corresponding rows in the
15251 frame's frame matrix. This function is called after scrolling W's
15252 current matrix on a terminal frame in try_window_id and
15253 try_window_reusing_current_matrix. */
15256 sync_frame_with_window_matrix_rows (w
)
15259 struct frame
*f
= XFRAME (w
->frame
);
15260 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15262 /* Preconditions: W must be a leaf window and full-width. Its frame
15263 must have a frame matrix. */
15264 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15265 xassert (WINDOW_FULL_WIDTH_P (w
));
15266 xassert (!FRAME_WINDOW_P (f
));
15268 /* If W is a full-width window, glyph pointers in W's current matrix
15269 have, by definition, to be the same as glyph pointers in the
15270 corresponding frame matrix. Note that frame matrices have no
15271 marginal areas (see build_frame_matrix). */
15272 window_row
= w
->current_matrix
->rows
;
15273 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15274 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15275 while (window_row
< window_row_end
)
15277 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15278 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15280 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15281 frame_row
->glyphs
[TEXT_AREA
] = start
;
15282 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15283 frame_row
->glyphs
[LAST_AREA
] = end
;
15285 /* Disable frame rows whose corresponding window rows have
15286 been disabled in try_window_id. */
15287 if (!window_row
->enabled_p
)
15288 frame_row
->enabled_p
= 0;
15290 ++window_row
, ++frame_row
;
15295 /* Find the glyph row in window W containing CHARPOS. Consider all
15296 rows between START and END (not inclusive). END null means search
15297 all rows to the end of the display area of W. Value is the row
15298 containing CHARPOS or null. */
15301 row_containing_pos (w
, charpos
, start
, end
, dy
)
15304 struct glyph_row
*start
, *end
;
15307 struct glyph_row
*row
= start
;
15308 struct glyph_row
*best_row
= NULL
;
15309 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15312 /* If we happen to start on a header-line, skip that. */
15313 if (row
->mode_line_p
)
15316 if ((end
&& row
>= end
) || !row
->enabled_p
)
15319 last_y
= window_text_bottom_y (w
) - dy
;
15323 /* Give up if we have gone too far. */
15324 if (end
&& row
>= end
)
15326 /* This formerly returned if they were equal.
15327 I think that both quantities are of a "last plus one" type;
15328 if so, when they are equal, the row is within the screen. -- rms. */
15329 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15332 /* If it is in this row, return this row. */
15333 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15334 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15335 /* The end position of a row equals the start
15336 position of the next row. If CHARPOS is there, we
15337 would rather display it in the next line, except
15338 when this line ends in ZV. */
15339 && !row
->ends_at_zv_p
15340 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15341 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15345 if (NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
15347 /* In bidi-reordered rows, there could be several rows
15348 occluding point. We need to find the one which fits
15349 CHARPOS the best. */
15350 for (g
= row
->glyphs
[TEXT_AREA
];
15351 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15354 if (!STRINGP (g
->object
))
15356 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15358 mindif
= eabs (g
->charpos
- charpos
);
15371 /* Try to redisplay window W by reusing its existing display. W's
15372 current matrix must be up to date when this function is called,
15373 i.e. window_end_valid must not be nil.
15377 1 if display has been updated
15378 0 if otherwise unsuccessful
15379 -1 if redisplay with same window start is known not to succeed
15381 The following steps are performed:
15383 1. Find the last row in the current matrix of W that is not
15384 affected by changes at the start of current_buffer. If no such row
15387 2. Find the first row in W's current matrix that is not affected by
15388 changes at the end of current_buffer. Maybe there is no such row.
15390 3. Display lines beginning with the row + 1 found in step 1 to the
15391 row found in step 2 or, if step 2 didn't find a row, to the end of
15394 4. If cursor is not known to appear on the window, give up.
15396 5. If display stopped at the row found in step 2, scroll the
15397 display and current matrix as needed.
15399 6. Maybe display some lines at the end of W, if we must. This can
15400 happen under various circumstances, like a partially visible line
15401 becoming fully visible, or because newly displayed lines are displayed
15402 in smaller font sizes.
15404 7. Update W's window end information. */
15410 struct frame
*f
= XFRAME (w
->frame
);
15411 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15412 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15413 struct glyph_row
*last_unchanged_at_beg_row
;
15414 struct glyph_row
*first_unchanged_at_end_row
;
15415 struct glyph_row
*row
;
15416 struct glyph_row
*bottom_row
;
15419 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
15420 struct text_pos start_pos
;
15422 int first_unchanged_at_end_vpos
= 0;
15423 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15424 struct text_pos start
;
15425 int first_changed_charpos
, last_changed_charpos
;
15428 if (inhibit_try_window_id
)
15432 /* This is handy for debugging. */
15434 #define GIVE_UP(X) \
15436 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15440 #define GIVE_UP(X) return 0
15443 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15445 /* Don't use this for mini-windows because these can show
15446 messages and mini-buffers, and we don't handle that here. */
15447 if (MINI_WINDOW_P (w
))
15450 /* This flag is used to prevent redisplay optimizations. */
15451 if (windows_or_buffers_changed
|| cursor_type_changed
)
15454 /* Verify that narrowing has not changed.
15455 Also verify that we were not told to prevent redisplay optimizations.
15456 It would be nice to further
15457 reduce the number of cases where this prevents try_window_id. */
15458 if (current_buffer
->clip_changed
15459 || current_buffer
->prevent_redisplay_optimizations_p
)
15462 /* Window must either use window-based redisplay or be full width. */
15463 if (!FRAME_WINDOW_P (f
)
15464 && (!FRAME_LINE_INS_DEL_OK (f
)
15465 || !WINDOW_FULL_WIDTH_P (w
)))
15468 /* Give up if point is known NOT to appear in W. */
15469 if (PT
< CHARPOS (start
))
15472 /* Another way to prevent redisplay optimizations. */
15473 if (XFASTINT (w
->last_modified
) == 0)
15476 /* Verify that window is not hscrolled. */
15477 if (XFASTINT (w
->hscroll
) != 0)
15480 /* Verify that display wasn't paused. */
15481 if (NILP (w
->window_end_valid
))
15484 /* Can't use this if highlighting a region because a cursor movement
15485 will do more than just set the cursor. */
15486 if (!NILP (Vtransient_mark_mode
)
15487 && !NILP (current_buffer
->mark_active
))
15490 /* Likewise if highlighting trailing whitespace. */
15491 if (!NILP (Vshow_trailing_whitespace
))
15494 /* Likewise if showing a region. */
15495 if (!NILP (w
->region_showing
))
15498 /* Can't use this if overlay arrow position and/or string have
15500 if (overlay_arrows_changed_p ())
15503 /* When word-wrap is on, adding a space to the first word of a
15504 wrapped line can change the wrap position, altering the line
15505 above it. It might be worthwhile to handle this more
15506 intelligently, but for now just redisplay from scratch. */
15507 if (!NILP (XBUFFER (w
->buffer
)->word_wrap
))
15510 /* Under bidi reordering, adding or deleting a character in the
15511 beginning of a paragraph, before the first strong directional
15512 character, can change the base direction of the paragraph (unless
15513 the buffer specifies a fixed paragraph direction), which will
15514 require to redisplay the whole paragraph. It might be worthwhile
15515 to find the paragraph limits and widen the range of redisplayed
15516 lines to that, but for now just give up this optimization and
15517 redisplay from scratch. */
15518 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
15519 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
15522 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15523 only if buffer has really changed. The reason is that the gap is
15524 initially at Z for freshly visited files. The code below would
15525 set end_unchanged to 0 in that case. */
15526 if (MODIFF
> SAVE_MODIFF
15527 /* This seems to happen sometimes after saving a buffer. */
15528 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15530 if (GPT
- BEG
< BEG_UNCHANGED
)
15531 BEG_UNCHANGED
= GPT
- BEG
;
15532 if (Z
- GPT
< END_UNCHANGED
)
15533 END_UNCHANGED
= Z
- GPT
;
15536 /* The position of the first and last character that has been changed. */
15537 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15538 last_changed_charpos
= Z
- END_UNCHANGED
;
15540 /* If window starts after a line end, and the last change is in
15541 front of that newline, then changes don't affect the display.
15542 This case happens with stealth-fontification. Note that although
15543 the display is unchanged, glyph positions in the matrix have to
15544 be adjusted, of course. */
15545 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15546 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15547 && ((last_changed_charpos
< CHARPOS (start
)
15548 && CHARPOS (start
) == BEGV
)
15549 || (last_changed_charpos
< CHARPOS (start
) - 1
15550 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15552 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
15553 struct glyph_row
*r0
;
15555 /* Compute how many chars/bytes have been added to or removed
15556 from the buffer. */
15557 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15558 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15560 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15562 /* Give up if PT is not in the window. Note that it already has
15563 been checked at the start of try_window_id that PT is not in
15564 front of the window start. */
15565 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
15568 /* If window start is unchanged, we can reuse the whole matrix
15569 as is, after adjusting glyph positions. No need to compute
15570 the window end again, since its offset from Z hasn't changed. */
15571 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15572 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
15573 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
15574 /* PT must not be in a partially visible line. */
15575 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
15576 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15578 /* Adjust positions in the glyph matrix. */
15579 if (delta
|| delta_bytes
)
15581 struct glyph_row
*r1
15582 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15583 increment_matrix_positions (w
->current_matrix
,
15584 MATRIX_ROW_VPOS (r0
, current_matrix
),
15585 MATRIX_ROW_VPOS (r1
, current_matrix
),
15586 delta
, delta_bytes
);
15589 /* Set the cursor. */
15590 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15592 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15599 /* Handle the case that changes are all below what is displayed in
15600 the window, and that PT is in the window. This shortcut cannot
15601 be taken if ZV is visible in the window, and text has been added
15602 there that is visible in the window. */
15603 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15604 /* ZV is not visible in the window, or there are no
15605 changes at ZV, actually. */
15606 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15607 || first_changed_charpos
== last_changed_charpos
))
15609 struct glyph_row
*r0
;
15611 /* Give up if PT is not in the window. Note that it already has
15612 been checked at the start of try_window_id that PT is not in
15613 front of the window start. */
15614 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15617 /* If window start is unchanged, we can reuse the whole matrix
15618 as is, without changing glyph positions since no text has
15619 been added/removed in front of the window end. */
15620 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15621 if (TEXT_POS_EQUAL_P (start
, r0
->start
.pos
)
15622 /* PT must not be in a partially visible line. */
15623 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15624 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15626 /* We have to compute the window end anew since text
15627 can have been added/removed after it. */
15629 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15630 w
->window_end_bytepos
15631 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15633 /* Set the cursor. */
15634 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15636 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15643 /* Give up if window start is in the changed area.
15645 The condition used to read
15647 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15649 but why that was tested escapes me at the moment. */
15650 if (CHARPOS (start
) >= first_changed_charpos
15651 && CHARPOS (start
) <= last_changed_charpos
)
15654 /* Check that window start agrees with the start of the first glyph
15655 row in its current matrix. Check this after we know the window
15656 start is not in changed text, otherwise positions would not be
15658 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15659 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
15662 /* Give up if the window ends in strings. Overlay strings
15663 at the end are difficult to handle, so don't try. */
15664 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15665 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15668 /* Compute the position at which we have to start displaying new
15669 lines. Some of the lines at the top of the window might be
15670 reusable because they are not displaying changed text. Find the
15671 last row in W's current matrix not affected by changes at the
15672 start of current_buffer. Value is null if changes start in the
15673 first line of window. */
15674 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15675 if (last_unchanged_at_beg_row
)
15677 /* Avoid starting to display in the moddle of a character, a TAB
15678 for instance. This is easier than to set up the iterator
15679 exactly, and it's not a frequent case, so the additional
15680 effort wouldn't really pay off. */
15681 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15682 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15683 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15684 --last_unchanged_at_beg_row
;
15686 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15689 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15691 start_pos
= it
.current
.pos
;
15693 /* Start displaying new lines in the desired matrix at the same
15694 vpos we would use in the current matrix, i.e. below
15695 last_unchanged_at_beg_row. */
15696 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15698 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15699 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15701 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15705 /* There are no reusable lines at the start of the window.
15706 Start displaying in the first text line. */
15707 start_display (&it
, w
, start
);
15708 it
.vpos
= it
.first_vpos
;
15709 start_pos
= it
.current
.pos
;
15712 /* Find the first row that is not affected by changes at the end of
15713 the buffer. Value will be null if there is no unchanged row, in
15714 which case we must redisplay to the end of the window. delta
15715 will be set to the value by which buffer positions beginning with
15716 first_unchanged_at_end_row have to be adjusted due to text
15718 first_unchanged_at_end_row
15719 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15720 IF_DEBUG (debug_delta
= delta
);
15721 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15723 /* Set stop_pos to the buffer position up to which we will have to
15724 display new lines. If first_unchanged_at_end_row != NULL, this
15725 is the buffer position of the start of the line displayed in that
15726 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15727 that we don't stop at a buffer position. */
15729 if (first_unchanged_at_end_row
)
15731 xassert (last_unchanged_at_beg_row
== NULL
15732 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15734 /* If this is a continuation line, move forward to the next one
15735 that isn't. Changes in lines above affect this line.
15736 Caution: this may move first_unchanged_at_end_row to a row
15737 not displaying text. */
15738 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15739 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15740 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15741 < it
.last_visible_y
))
15742 ++first_unchanged_at_end_row
;
15744 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15745 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15746 >= it
.last_visible_y
))
15747 first_unchanged_at_end_row
= NULL
;
15750 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15752 first_unchanged_at_end_vpos
15753 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15754 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15757 else if (last_unchanged_at_beg_row
== NULL
)
15763 /* Either there is no unchanged row at the end, or the one we have
15764 now displays text. This is a necessary condition for the window
15765 end pos calculation at the end of this function. */
15766 xassert (first_unchanged_at_end_row
== NULL
15767 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15769 debug_last_unchanged_at_beg_vpos
15770 = (last_unchanged_at_beg_row
15771 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15773 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15775 #endif /* GLYPH_DEBUG != 0 */
15778 /* Display new lines. Set last_text_row to the last new line
15779 displayed which has text on it, i.e. might end up as being the
15780 line where the window_end_vpos is. */
15781 w
->cursor
.vpos
= -1;
15782 last_text_row
= NULL
;
15783 overlay_arrow_seen
= 0;
15784 while (it
.current_y
< it
.last_visible_y
15785 && !fonts_changed_p
15786 && (first_unchanged_at_end_row
== NULL
15787 || IT_CHARPOS (it
) < stop_pos
))
15789 if (display_line (&it
))
15790 last_text_row
= it
.glyph_row
- 1;
15793 if (fonts_changed_p
)
15797 /* Compute differences in buffer positions, y-positions etc. for
15798 lines reused at the bottom of the window. Compute what we can
15800 if (first_unchanged_at_end_row
15801 /* No lines reused because we displayed everything up to the
15802 bottom of the window. */
15803 && it
.current_y
< it
.last_visible_y
)
15806 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15808 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15809 run
.current_y
= first_unchanged_at_end_row
->y
;
15810 run
.desired_y
= run
.current_y
+ dy
;
15811 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15815 delta
= delta_bytes
= dvpos
= dy
15816 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15817 first_unchanged_at_end_row
= NULL
;
15819 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15822 /* Find the cursor if not already found. We have to decide whether
15823 PT will appear on this window (it sometimes doesn't, but this is
15824 not a very frequent case.) This decision has to be made before
15825 the current matrix is altered. A value of cursor.vpos < 0 means
15826 that PT is either in one of the lines beginning at
15827 first_unchanged_at_end_row or below the window. Don't care for
15828 lines that might be displayed later at the window end; as
15829 mentioned, this is not a frequent case. */
15830 if (w
->cursor
.vpos
< 0)
15832 /* Cursor in unchanged rows at the top? */
15833 if (PT
< CHARPOS (start_pos
)
15834 && last_unchanged_at_beg_row
)
15836 row
= row_containing_pos (w
, PT
,
15837 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15838 last_unchanged_at_beg_row
+ 1, 0);
15840 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15843 /* Start from first_unchanged_at_end_row looking for PT. */
15844 else if (first_unchanged_at_end_row
)
15846 row
= row_containing_pos (w
, PT
- delta
,
15847 first_unchanged_at_end_row
, NULL
, 0);
15849 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15850 delta_bytes
, dy
, dvpos
);
15853 /* Give up if cursor was not found. */
15854 if (w
->cursor
.vpos
< 0)
15856 clear_glyph_matrix (w
->desired_matrix
);
15861 /* Don't let the cursor end in the scroll margins. */
15863 int this_scroll_margin
, cursor_height
;
15865 this_scroll_margin
= max (0, scroll_margin
);
15866 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15867 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15868 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15870 if ((w
->cursor
.y
< this_scroll_margin
15871 && CHARPOS (start
) > BEGV
)
15872 /* Old redisplay didn't take scroll margin into account at the bottom,
15873 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15874 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15875 ? cursor_height
+ this_scroll_margin
15876 : 1)) > it
.last_visible_y
)
15878 w
->cursor
.vpos
= -1;
15879 clear_glyph_matrix (w
->desired_matrix
);
15884 /* Scroll the display. Do it before changing the current matrix so
15885 that xterm.c doesn't get confused about where the cursor glyph is
15887 if (dy
&& run
.height
)
15891 if (FRAME_WINDOW_P (f
))
15893 FRAME_RIF (f
)->update_window_begin_hook (w
);
15894 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15895 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15896 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15900 /* Terminal frame. In this case, dvpos gives the number of
15901 lines to scroll by; dvpos < 0 means scroll up. */
15902 int first_unchanged_at_end_vpos
15903 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15904 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
15905 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15906 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15907 + window_internal_height (w
));
15909 /* Perform the operation on the screen. */
15912 /* Scroll last_unchanged_at_beg_row to the end of the
15913 window down dvpos lines. */
15914 set_terminal_window (f
, end
);
15916 /* On dumb terminals delete dvpos lines at the end
15917 before inserting dvpos empty lines. */
15918 if (!FRAME_SCROLL_REGION_OK (f
))
15919 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15921 /* Insert dvpos empty lines in front of
15922 last_unchanged_at_beg_row. */
15923 ins_del_lines (f
, from
, dvpos
);
15925 else if (dvpos
< 0)
15927 /* Scroll up last_unchanged_at_beg_vpos to the end of
15928 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15929 set_terminal_window (f
, end
);
15931 /* Delete dvpos lines in front of
15932 last_unchanged_at_beg_vpos. ins_del_lines will set
15933 the cursor to the given vpos and emit |dvpos| delete
15935 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15937 /* On a dumb terminal insert dvpos empty lines at the
15939 if (!FRAME_SCROLL_REGION_OK (f
))
15940 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15943 set_terminal_window (f
, 0);
15949 /* Shift reused rows of the current matrix to the right position.
15950 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15952 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15953 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15956 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15957 bottom_vpos
, dvpos
);
15958 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15961 else if (dvpos
> 0)
15963 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15964 bottom_vpos
, dvpos
);
15965 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15966 first_unchanged_at_end_vpos
+ dvpos
, 0);
15969 /* For frame-based redisplay, make sure that current frame and window
15970 matrix are in sync with respect to glyph memory. */
15971 if (!FRAME_WINDOW_P (f
))
15972 sync_frame_with_window_matrix_rows (w
);
15974 /* Adjust buffer positions in reused rows. */
15975 if (delta
|| delta_bytes
)
15976 increment_matrix_positions (current_matrix
,
15977 first_unchanged_at_end_vpos
+ dvpos
,
15978 bottom_vpos
, delta
, delta_bytes
);
15980 /* Adjust Y positions. */
15982 shift_glyph_matrix (w
, current_matrix
,
15983 first_unchanged_at_end_vpos
+ dvpos
,
15986 if (first_unchanged_at_end_row
)
15988 first_unchanged_at_end_row
+= dvpos
;
15989 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15990 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15991 first_unchanged_at_end_row
= NULL
;
15994 /* If scrolling up, there may be some lines to display at the end of
15996 last_text_row_at_end
= NULL
;
15999 /* Scrolling up can leave for example a partially visible line
16000 at the end of the window to be redisplayed. */
16001 /* Set last_row to the glyph row in the current matrix where the
16002 window end line is found. It has been moved up or down in
16003 the matrix by dvpos. */
16004 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
16005 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
16007 /* If last_row is the window end line, it should display text. */
16008 xassert (last_row
->displays_text_p
);
16010 /* If window end line was partially visible before, begin
16011 displaying at that line. Otherwise begin displaying with the
16012 line following it. */
16013 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16015 init_to_row_start (&it
, w
, last_row
);
16016 it
.vpos
= last_vpos
;
16017 it
.current_y
= last_row
->y
;
16021 init_to_row_end (&it
, w
, last_row
);
16022 it
.vpos
= 1 + last_vpos
;
16023 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16027 /* We may start in a continuation line. If so, we have to
16028 get the right continuation_lines_width and current_x. */
16029 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16030 it
.hpos
= it
.current_x
= 0;
16032 /* Display the rest of the lines at the window end. */
16033 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16034 while (it
.current_y
< it
.last_visible_y
16035 && !fonts_changed_p
)
16037 /* Is it always sure that the display agrees with lines in
16038 the current matrix? I don't think so, so we mark rows
16039 displayed invalid in the current matrix by setting their
16040 enabled_p flag to zero. */
16041 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16042 if (display_line (&it
))
16043 last_text_row_at_end
= it
.glyph_row
- 1;
16047 /* Update window_end_pos and window_end_vpos. */
16048 if (first_unchanged_at_end_row
16049 && !last_text_row_at_end
)
16051 /* Window end line if one of the preserved rows from the current
16052 matrix. Set row to the last row displaying text in current
16053 matrix starting at first_unchanged_at_end_row, after
16055 xassert (first_unchanged_at_end_row
->displays_text_p
);
16056 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16057 first_unchanged_at_end_row
);
16058 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16060 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16061 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16063 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16064 xassert (w
->window_end_bytepos
>= 0);
16065 IF_DEBUG (debug_method_add (w
, "A"));
16067 else if (last_text_row_at_end
)
16070 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16071 w
->window_end_bytepos
16072 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16074 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16075 xassert (w
->window_end_bytepos
>= 0);
16076 IF_DEBUG (debug_method_add (w
, "B"));
16078 else if (last_text_row
)
16080 /* We have displayed either to the end of the window or at the
16081 end of the window, i.e. the last row with text is to be found
16082 in the desired matrix. */
16084 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16085 w
->window_end_bytepos
16086 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16088 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16089 xassert (w
->window_end_bytepos
>= 0);
16091 else if (first_unchanged_at_end_row
== NULL
16092 && last_text_row
== NULL
16093 && last_text_row_at_end
== NULL
)
16095 /* Displayed to end of window, but no line containing text was
16096 displayed. Lines were deleted at the end of the window. */
16097 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16098 int vpos
= XFASTINT (w
->window_end_vpos
);
16099 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16100 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16103 row
== NULL
&& vpos
>= first_vpos
;
16104 --vpos
, --current_row
, --desired_row
)
16106 if (desired_row
->enabled_p
)
16108 if (desired_row
->displays_text_p
)
16111 else if (current_row
->displays_text_p
)
16115 xassert (row
!= NULL
);
16116 w
->window_end_vpos
= make_number (vpos
+ 1);
16117 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16118 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16119 xassert (w
->window_end_bytepos
>= 0);
16120 IF_DEBUG (debug_method_add (w
, "C"));
16125 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16126 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16128 /* Record that display has not been completed. */
16129 w
->window_end_valid
= Qnil
;
16130 w
->desired_matrix
->no_scrolling_p
= 1;
16138 /***********************************************************************
16139 More debugging support
16140 ***********************************************************************/
16144 void dump_glyph_row
P_ ((struct glyph_row
*, int, int));
16145 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
16146 void dump_glyph
P_ ((struct glyph_row
*, struct glyph
*, int));
16149 /* Dump the contents of glyph matrix MATRIX on stderr.
16151 GLYPHS 0 means don't show glyph contents.
16152 GLYPHS 1 means show glyphs in short form
16153 GLYPHS > 1 means show glyphs in long form. */
16156 dump_glyph_matrix (matrix
, glyphs
)
16157 struct glyph_matrix
*matrix
;
16161 for (i
= 0; i
< matrix
->nrows
; ++i
)
16162 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16166 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16167 the glyph row and area where the glyph comes from. */
16170 dump_glyph (row
, glyph
, area
)
16171 struct glyph_row
*row
;
16172 struct glyph
*glyph
;
16175 if (glyph
->type
== CHAR_GLYPH
)
16178 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16179 glyph
- row
->glyphs
[TEXT_AREA
],
16182 (BUFFERP (glyph
->object
)
16184 : (STRINGP (glyph
->object
)
16187 glyph
->pixel_width
,
16189 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16193 glyph
->left_box_line_p
,
16194 glyph
->right_box_line_p
);
16196 else if (glyph
->type
== STRETCH_GLYPH
)
16199 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16200 glyph
- row
->glyphs
[TEXT_AREA
],
16203 (BUFFERP (glyph
->object
)
16205 : (STRINGP (glyph
->object
)
16208 glyph
->pixel_width
,
16212 glyph
->left_box_line_p
,
16213 glyph
->right_box_line_p
);
16215 else if (glyph
->type
== IMAGE_GLYPH
)
16218 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16219 glyph
- row
->glyphs
[TEXT_AREA
],
16222 (BUFFERP (glyph
->object
)
16224 : (STRINGP (glyph
->object
)
16227 glyph
->pixel_width
,
16231 glyph
->left_box_line_p
,
16232 glyph
->right_box_line_p
);
16234 else if (glyph
->type
== COMPOSITE_GLYPH
)
16237 " %5d %4c %6d %c %3d 0x%05x",
16238 glyph
- row
->glyphs
[TEXT_AREA
],
16241 (BUFFERP (glyph
->object
)
16243 : (STRINGP (glyph
->object
)
16246 glyph
->pixel_width
,
16248 if (glyph
->u
.cmp
.automatic
)
16251 glyph
->u
.cmp
.from
, glyph
->u
.cmp
.to
);
16252 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16254 glyph
->left_box_line_p
,
16255 glyph
->right_box_line_p
);
16260 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16261 GLYPHS 0 means don't show glyph contents.
16262 GLYPHS 1 means show glyphs in short form
16263 GLYPHS > 1 means show glyphs in long form. */
16266 dump_glyph_row (row
, vpos
, glyphs
)
16267 struct glyph_row
*row
;
16272 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16273 fprintf (stderr
, "======================================================================\n");
16275 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16276 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16278 MATRIX_ROW_START_CHARPOS (row
),
16279 MATRIX_ROW_END_CHARPOS (row
),
16280 row
->used
[TEXT_AREA
],
16281 row
->contains_overlapping_glyphs_p
,
16283 row
->truncated_on_left_p
,
16284 row
->truncated_on_right_p
,
16286 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16287 row
->displays_text_p
,
16290 row
->ends_in_middle_of_char_p
,
16291 row
->starts_in_middle_of_char_p
,
16297 row
->visible_height
,
16300 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16301 row
->end
.overlay_string_index
,
16302 row
->continuation_lines_width
);
16303 fprintf (stderr
, "%9d %5d\n",
16304 CHARPOS (row
->start
.string_pos
),
16305 CHARPOS (row
->end
.string_pos
));
16306 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16307 row
->end
.dpvec_index
);
16314 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16316 struct glyph
*glyph
= row
->glyphs
[area
];
16317 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16319 /* Glyph for a line end in text. */
16320 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16323 if (glyph
< glyph_end
)
16324 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16326 for (; glyph
< glyph_end
; ++glyph
)
16327 dump_glyph (row
, glyph
, area
);
16330 else if (glyphs
== 1)
16334 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16336 char *s
= (char *) alloca (row
->used
[area
] + 1);
16339 for (i
= 0; i
< row
->used
[area
]; ++i
)
16341 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16342 if (glyph
->type
== CHAR_GLYPH
16343 && glyph
->u
.ch
< 0x80
16344 && glyph
->u
.ch
>= ' ')
16345 s
[i
] = glyph
->u
.ch
;
16351 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16357 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16358 Sdump_glyph_matrix
, 0, 1, "p",
16359 doc
: /* Dump the current matrix of the selected window to stderr.
16360 Shows contents of glyph row structures. With non-nil
16361 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16362 glyphs in short form, otherwise show glyphs in long form. */)
16364 Lisp_Object glyphs
;
16366 struct window
*w
= XWINDOW (selected_window
);
16367 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16369 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16370 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16371 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16372 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16373 fprintf (stderr
, "=============================================\n");
16374 dump_glyph_matrix (w
->current_matrix
,
16375 NILP (glyphs
) ? 0 : XINT (glyphs
));
16380 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16381 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16384 struct frame
*f
= XFRAME (selected_frame
);
16385 dump_glyph_matrix (f
->current_matrix
, 1);
16390 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16391 doc
: /* Dump glyph row ROW to stderr.
16392 GLYPH 0 means don't dump glyphs.
16393 GLYPH 1 means dump glyphs in short form.
16394 GLYPH > 1 or omitted means dump glyphs in long form. */)
16396 Lisp_Object row
, glyphs
;
16398 struct glyph_matrix
*matrix
;
16401 CHECK_NUMBER (row
);
16402 matrix
= XWINDOW (selected_window
)->current_matrix
;
16404 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16405 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16407 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16412 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16413 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16414 GLYPH 0 means don't dump glyphs.
16415 GLYPH 1 means dump glyphs in short form.
16416 GLYPH > 1 or omitted means dump glyphs in long form. */)
16418 Lisp_Object row
, glyphs
;
16420 struct frame
*sf
= SELECTED_FRAME ();
16421 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16424 CHECK_NUMBER (row
);
16426 if (vpos
>= 0 && vpos
< m
->nrows
)
16427 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16428 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16433 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16434 doc
: /* Toggle tracing of redisplay.
16435 With ARG, turn tracing on if and only if ARG is positive. */)
16440 trace_redisplay_p
= !trace_redisplay_p
;
16443 arg
= Fprefix_numeric_value (arg
);
16444 trace_redisplay_p
= XINT (arg
) > 0;
16451 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16452 doc
: /* Like `format', but print result to stderr.
16453 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16458 Lisp_Object s
= Fformat (nargs
, args
);
16459 fprintf (stderr
, "%s", SDATA (s
));
16463 #endif /* GLYPH_DEBUG */
16467 /***********************************************************************
16468 Building Desired Matrix Rows
16469 ***********************************************************************/
16471 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16472 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16474 static struct glyph_row
*
16475 get_overlay_arrow_glyph_row (w
, overlay_arrow_string
)
16477 Lisp_Object overlay_arrow_string
;
16479 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16480 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16481 struct buffer
*old
= current_buffer
;
16482 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16483 int arrow_len
= SCHARS (overlay_arrow_string
);
16484 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16485 const unsigned char *p
;
16488 int n_glyphs_before
;
16490 set_buffer_temp (buffer
);
16491 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16492 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16493 SET_TEXT_POS (it
.position
, 0, 0);
16495 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
16497 while (p
< arrow_end
)
16499 Lisp_Object face
, ilisp
;
16501 /* Get the next character. */
16503 it
.c
= string_char_and_length (p
, &it
.len
);
16505 it
.c
= *p
, it
.len
= 1;
16508 /* Get its face. */
16509 ilisp
= make_number (p
- arrow_string
);
16510 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16511 it
.face_id
= compute_char_face (f
, it
.c
, face
);
16513 /* Compute its width, get its glyphs. */
16514 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16515 SET_TEXT_POS (it
.position
, -1, -1);
16516 PRODUCE_GLYPHS (&it
);
16518 /* If this character doesn't fit any more in the line, we have
16519 to remove some glyphs. */
16520 if (it
.current_x
> it
.last_visible_x
)
16522 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16527 set_buffer_temp (old
);
16528 return it
.glyph_row
;
16532 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16533 glyphs are only inserted for terminal frames since we can't really
16534 win with truncation glyphs when partially visible glyphs are
16535 involved. Which glyphs to insert is determined by
16536 produce_special_glyphs. */
16539 insert_left_trunc_glyphs (it
)
16542 struct it truncate_it
;
16543 struct glyph
*from
, *end
, *to
, *toend
;
16545 xassert (!FRAME_WINDOW_P (it
->f
));
16547 /* Get the truncation glyphs. */
16549 truncate_it
.current_x
= 0;
16550 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16551 truncate_it
.glyph_row
= &scratch_glyph_row
;
16552 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16553 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16554 truncate_it
.object
= make_number (0);
16555 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16557 /* Overwrite glyphs from IT with truncation glyphs. */
16558 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16559 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16560 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16561 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16566 /* There may be padding glyphs left over. Overwrite them too. */
16567 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16569 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16575 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16579 /* Compute the pixel height and width of IT->glyph_row.
16581 Most of the time, ascent and height of a display line will be equal
16582 to the max_ascent and max_height values of the display iterator
16583 structure. This is not the case if
16585 1. We hit ZV without displaying anything. In this case, max_ascent
16586 and max_height will be zero.
16588 2. We have some glyphs that don't contribute to the line height.
16589 (The glyph row flag contributes_to_line_height_p is for future
16590 pixmap extensions).
16592 The first case is easily covered by using default values because in
16593 these cases, the line height does not really matter, except that it
16594 must not be zero. */
16597 compute_line_metrics (it
)
16600 struct glyph_row
*row
= it
->glyph_row
;
16603 if (FRAME_WINDOW_P (it
->f
))
16605 int i
, min_y
, max_y
;
16607 /* The line may consist of one space only, that was added to
16608 place the cursor on it. If so, the row's height hasn't been
16610 if (row
->height
== 0)
16612 if (it
->max_ascent
+ it
->max_descent
== 0)
16613 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16614 row
->ascent
= it
->max_ascent
;
16615 row
->height
= it
->max_ascent
+ it
->max_descent
;
16616 row
->phys_ascent
= it
->max_phys_ascent
;
16617 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16618 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16621 /* Compute the width of this line. */
16622 row
->pixel_width
= row
->x
;
16623 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16624 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16626 xassert (row
->pixel_width
>= 0);
16627 xassert (row
->ascent
>= 0 && row
->height
> 0);
16629 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16630 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16632 /* If first line's physical ascent is larger than its logical
16633 ascent, use the physical ascent, and make the row taller.
16634 This makes accented characters fully visible. */
16635 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16636 && row
->phys_ascent
> row
->ascent
)
16638 row
->height
+= row
->phys_ascent
- row
->ascent
;
16639 row
->ascent
= row
->phys_ascent
;
16642 /* Compute how much of the line is visible. */
16643 row
->visible_height
= row
->height
;
16645 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16646 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16648 if (row
->y
< min_y
)
16649 row
->visible_height
-= min_y
- row
->y
;
16650 if (row
->y
+ row
->height
> max_y
)
16651 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16655 row
->pixel_width
= row
->used
[TEXT_AREA
];
16656 if (row
->continued_p
)
16657 row
->pixel_width
-= it
->continuation_pixel_width
;
16658 else if (row
->truncated_on_right_p
)
16659 row
->pixel_width
-= it
->truncation_pixel_width
;
16660 row
->ascent
= row
->phys_ascent
= 0;
16661 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16662 row
->extra_line_spacing
= 0;
16665 /* Compute a hash code for this row. */
16667 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16668 for (i
= 0; i
< row
->used
[area
]; ++i
)
16669 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16670 + row
->glyphs
[area
][i
].u
.val
16671 + row
->glyphs
[area
][i
].face_id
16672 + row
->glyphs
[area
][i
].padding_p
16673 + (row
->glyphs
[area
][i
].type
<< 2));
16675 it
->max_ascent
= it
->max_descent
= 0;
16676 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16680 /* Append one space to the glyph row of iterator IT if doing a
16681 window-based redisplay. The space has the same face as
16682 IT->face_id. Value is non-zero if a space was added.
16684 This function is called to make sure that there is always one glyph
16685 at the end of a glyph row that the cursor can be set on under
16686 window-systems. (If there weren't such a glyph we would not know
16687 how wide and tall a box cursor should be displayed).
16689 At the same time this space let's a nicely handle clearing to the
16690 end of the line if the row ends in italic text. */
16693 append_space_for_newline (it
, default_face_p
)
16695 int default_face_p
;
16697 if (FRAME_WINDOW_P (it
->f
))
16699 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16701 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16702 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16704 /* Save some values that must not be changed.
16705 Must save IT->c and IT->len because otherwise
16706 ITERATOR_AT_END_P wouldn't work anymore after
16707 append_space_for_newline has been called. */
16708 enum display_element_type saved_what
= it
->what
;
16709 int saved_c
= it
->c
, saved_len
= it
->len
;
16710 int saved_x
= it
->current_x
;
16711 int saved_face_id
= it
->face_id
;
16712 struct text_pos saved_pos
;
16713 Lisp_Object saved_object
;
16716 saved_object
= it
->object
;
16717 saved_pos
= it
->position
;
16719 it
->what
= IT_CHARACTER
;
16720 bzero (&it
->position
, sizeof it
->position
);
16721 it
->object
= make_number (0);
16725 if (default_face_p
)
16726 it
->face_id
= DEFAULT_FACE_ID
;
16727 else if (it
->face_before_selective_p
)
16728 it
->face_id
= it
->saved_face_id
;
16729 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16730 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16732 PRODUCE_GLYPHS (it
);
16734 it
->override_ascent
= -1;
16735 it
->constrain_row_ascent_descent_p
= 0;
16736 it
->current_x
= saved_x
;
16737 it
->object
= saved_object
;
16738 it
->position
= saved_pos
;
16739 it
->what
= saved_what
;
16740 it
->face_id
= saved_face_id
;
16741 it
->len
= saved_len
;
16751 /* Extend the face of the last glyph in the text area of IT->glyph_row
16752 to the end of the display line. Called from display_line.
16753 If the glyph row is empty, add a space glyph to it so that we
16754 know the face to draw. Set the glyph row flag fill_line_p. */
16757 extend_face_to_end_of_line (it
)
16761 struct frame
*f
= it
->f
;
16763 /* If line is already filled, do nothing. */
16764 if (it
->current_x
>= it
->last_visible_x
)
16767 /* Face extension extends the background and box of IT->face_id
16768 to the end of the line. If the background equals the background
16769 of the frame, we don't have to do anything. */
16770 if (it
->face_before_selective_p
)
16771 face
= FACE_FROM_ID (it
->f
, it
->saved_face_id
);
16773 face
= FACE_FROM_ID (f
, it
->face_id
);
16775 if (FRAME_WINDOW_P (f
)
16776 && it
->glyph_row
->displays_text_p
16777 && face
->box
== FACE_NO_BOX
16778 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16782 /* Set the glyph row flag indicating that the face of the last glyph
16783 in the text area has to be drawn to the end of the text area. */
16784 it
->glyph_row
->fill_line_p
= 1;
16786 /* If current character of IT is not ASCII, make sure we have the
16787 ASCII face. This will be automatically undone the next time
16788 get_next_display_element returns a multibyte character. Note
16789 that the character will always be single byte in unibyte
16791 if (!ASCII_CHAR_P (it
->c
))
16793 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16796 if (FRAME_WINDOW_P (f
))
16798 /* If the row is empty, add a space with the current face of IT,
16799 so that we know which face to draw. */
16800 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16802 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16803 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16804 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16809 /* Save some values that must not be changed. */
16810 int saved_x
= it
->current_x
;
16811 struct text_pos saved_pos
;
16812 Lisp_Object saved_object
;
16813 enum display_element_type saved_what
= it
->what
;
16814 int saved_face_id
= it
->face_id
;
16816 saved_object
= it
->object
;
16817 saved_pos
= it
->position
;
16819 it
->what
= IT_CHARACTER
;
16820 bzero (&it
->position
, sizeof it
->position
);
16821 it
->object
= make_number (0);
16824 it
->face_id
= face
->id
;
16826 PRODUCE_GLYPHS (it
);
16828 while (it
->current_x
<= it
->last_visible_x
)
16829 PRODUCE_GLYPHS (it
);
16831 /* Don't count these blanks really. It would let us insert a left
16832 truncation glyph below and make us set the cursor on them, maybe. */
16833 it
->current_x
= saved_x
;
16834 it
->object
= saved_object
;
16835 it
->position
= saved_pos
;
16836 it
->what
= saved_what
;
16837 it
->face_id
= saved_face_id
;
16842 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16843 trailing whitespace. */
16846 trailing_whitespace_p (charpos
)
16849 int bytepos
= CHAR_TO_BYTE (charpos
);
16852 while (bytepos
< ZV_BYTE
16853 && (c
= FETCH_CHAR (bytepos
),
16854 c
== ' ' || c
== '\t'))
16857 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16859 if (bytepos
!= PT_BYTE
)
16866 /* Highlight trailing whitespace, if any, in ROW. */
16869 highlight_trailing_whitespace (f
, row
)
16871 struct glyph_row
*row
;
16873 int used
= row
->used
[TEXT_AREA
];
16877 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16878 struct glyph
*glyph
= start
+ used
- 1;
16880 if (row
->reversed_p
)
16882 /* Right-to-left rows need to be processed in the opposite
16883 direction, so swap the edge pointers. */
16885 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
16888 /* Skip over glyphs inserted to display the cursor at the
16889 end of a line, for extending the face of the last glyph
16890 to the end of the line on terminals, and for truncation
16891 and continuation glyphs. */
16892 if (!row
->reversed_p
)
16894 while (glyph
>= start
16895 && glyph
->type
== CHAR_GLYPH
16896 && INTEGERP (glyph
->object
))
16901 while (glyph
<= start
16902 && glyph
->type
== CHAR_GLYPH
16903 && INTEGERP (glyph
->object
))
16907 /* If last glyph is a space or stretch, and it's trailing
16908 whitespace, set the face of all trailing whitespace glyphs in
16909 IT->glyph_row to `trailing-whitespace'. */
16910 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
16911 && BUFFERP (glyph
->object
)
16912 && (glyph
->type
== STRETCH_GLYPH
16913 || (glyph
->type
== CHAR_GLYPH
16914 && glyph
->u
.ch
== ' '))
16915 && trailing_whitespace_p (glyph
->charpos
))
16917 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
16921 if (!row
->reversed_p
)
16923 while (glyph
>= start
16924 && BUFFERP (glyph
->object
)
16925 && (glyph
->type
== STRETCH_GLYPH
16926 || (glyph
->type
== CHAR_GLYPH
16927 && glyph
->u
.ch
== ' ')))
16928 (glyph
--)->face_id
= face_id
;
16932 while (glyph
<= start
16933 && BUFFERP (glyph
->object
)
16934 && (glyph
->type
== STRETCH_GLYPH
16935 || (glyph
->type
== CHAR_GLYPH
16936 && glyph
->u
.ch
== ' ')))
16937 (glyph
++)->face_id
= face_id
;
16944 /* Value is non-zero if glyph row ROW in window W should be
16945 used to hold the cursor. */
16948 cursor_row_p (w
, row
)
16950 struct glyph_row
*row
;
16952 int cursor_row_p
= 1;
16954 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
16956 /* Suppose the row ends on a string.
16957 Unless the row is continued, that means it ends on a newline
16958 in the string. If it's anything other than a display string
16959 (e.g. a before-string from an overlay), we don't want the
16960 cursor there. (This heuristic seems to give the optimal
16961 behavior for the various types of multi-line strings.) */
16962 if (CHARPOS (row
->end
.string_pos
) >= 0)
16964 if (row
->continued_p
)
16968 /* Check for `display' property. */
16969 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
16970 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
16971 struct glyph
*glyph
;
16974 for (glyph
= end
; glyph
>= beg
; --glyph
)
16975 if (STRINGP (glyph
->object
))
16978 = Fget_char_property (make_number (PT
),
16982 && display_prop_string_p (prop
, glyph
->object
));
16987 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
16989 /* If the row ends in middle of a real character,
16990 and the line is continued, we want the cursor here.
16991 That's because MATRIX_ROW_END_CHARPOS would equal
16992 PT if PT is before the character. */
16993 if (!row
->ends_in_ellipsis_p
)
16994 cursor_row_p
= row
->continued_p
;
16996 /* If the row ends in an ellipsis, then
16997 MATRIX_ROW_END_CHARPOS will equal point after the invisible text.
16998 We want that position to be displayed after the ellipsis. */
17001 /* If the row ends at ZV, display the cursor at the end of that
17002 row instead of at the start of the row below. */
17003 else if (row
->ends_at_zv_p
)
17009 return cursor_row_p
;
17014 /* Push the display property PROP so that it will be rendered at the
17015 current position in IT. Return 1 if PROP was successfully pushed,
17019 push_display_prop (struct it
*it
, Lisp_Object prop
)
17023 if (STRINGP (prop
))
17025 if (SCHARS (prop
) == 0)
17032 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17033 it
->current
.overlay_string_index
= -1;
17034 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17035 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17036 it
->method
= GET_FROM_STRING
;
17037 it
->stop_charpos
= 0;
17039 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17041 it
->method
= GET_FROM_STRETCH
;
17044 #ifdef HAVE_WINDOW_SYSTEM
17045 else if (IMAGEP (prop
))
17047 it
->what
= IT_IMAGE
;
17048 it
->image_id
= lookup_image (it
->f
, prop
);
17049 it
->method
= GET_FROM_IMAGE
;
17051 #endif /* HAVE_WINDOW_SYSTEM */
17054 pop_it (it
); /* bogus display property, give up */
17061 /* Return the character-property PROP at the current position in IT. */
17064 get_it_property (it
, prop
)
17068 Lisp_Object position
;
17070 if (STRINGP (it
->object
))
17071 position
= make_number (IT_STRING_CHARPOS (*it
));
17072 else if (BUFFERP (it
->object
))
17073 position
= make_number (IT_CHARPOS (*it
));
17077 return Fget_char_property (position
, prop
, it
->object
);
17080 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17083 handle_line_prefix (struct it
*it
)
17085 Lisp_Object prefix
;
17086 if (it
->continuation_lines_width
> 0)
17088 prefix
= get_it_property (it
, Qwrap_prefix
);
17090 prefix
= Vwrap_prefix
;
17094 prefix
= get_it_property (it
, Qline_prefix
);
17096 prefix
= Vline_prefix
;
17098 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17100 /* If the prefix is wider than the window, and we try to wrap
17101 it, it would acquire its own wrap prefix, and so on till the
17102 iterator stack overflows. So, don't wrap the prefix. */
17103 it
->line_wrap
= TRUNCATE
;
17104 it
->avoid_cursor_p
= 1;
17110 /* Construct the glyph row IT->glyph_row in the desired matrix of
17111 IT->w from text at the current position of IT. See dispextern.h
17112 for an overview of struct it. Value is non-zero if
17113 IT->glyph_row displays text, as opposed to a line displaying ZV
17120 struct glyph_row
*row
= it
->glyph_row
;
17121 Lisp_Object overlay_arrow_string
;
17123 int may_wrap
= 0, wrap_x
;
17124 int wrap_row_used
= -1, wrap_row_ascent
, wrap_row_height
;
17125 int wrap_row_phys_ascent
, wrap_row_phys_height
;
17126 int wrap_row_extra_line_spacing
;
17127 struct display_pos row_end
;
17130 /* We always start displaying at hpos zero even if hscrolled. */
17131 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17133 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17134 >= it
->w
->desired_matrix
->nrows
)
17136 it
->w
->nrows_scale_factor
++;
17137 fonts_changed_p
= 1;
17141 /* Is IT->w showing the region? */
17142 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17144 /* Clear the result glyph row and enable it. */
17145 prepare_desired_row (row
);
17147 row
->y
= it
->current_y
;
17148 row
->start
= it
->start
;
17149 row
->continuation_lines_width
= it
->continuation_lines_width
;
17150 row
->displays_text_p
= 1;
17151 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17152 it
->starts_in_middle_of_char_p
= 0;
17154 /* Arrange the overlays nicely for our purposes. Usually, we call
17155 display_line on only one line at a time, in which case this
17156 can't really hurt too much, or we call it on lines which appear
17157 one after another in the buffer, in which case all calls to
17158 recenter_overlay_lists but the first will be pretty cheap. */
17159 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17161 /* Move over display elements that are not visible because we are
17162 hscrolled. This may stop at an x-position < IT->first_visible_x
17163 if the first glyph is partially visible or if we hit a line end. */
17164 if (it
->current_x
< it
->first_visible_x
)
17166 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17167 MOVE_TO_POS
| MOVE_TO_X
);
17171 /* We only do this when not calling `move_it_in_display_line_to'
17172 above, because move_it_in_display_line_to calls
17173 handle_line_prefix itself. */
17174 handle_line_prefix (it
);
17177 /* Get the initial row height. This is either the height of the
17178 text hscrolled, if there is any, or zero. */
17179 row
->ascent
= it
->max_ascent
;
17180 row
->height
= it
->max_ascent
+ it
->max_descent
;
17181 row
->phys_ascent
= it
->max_phys_ascent
;
17182 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17183 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17185 /* Loop generating characters. The loop is left with IT on the next
17186 character to display. */
17189 int n_glyphs_before
, hpos_before
, x_before
;
17191 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17193 /* Retrieve the next thing to display. Value is zero if end of
17195 if (!get_next_display_element (it
))
17197 /* Maybe add a space at the end of this line that is used to
17198 display the cursor there under X. Set the charpos of the
17199 first glyph of blank lines not corresponding to any text
17201 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17202 row
->exact_window_width_line_p
= 1;
17203 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17204 || row
->used
[TEXT_AREA
] == 0)
17206 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17207 row
->displays_text_p
= 0;
17209 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
17210 && (!MINI_WINDOW_P (it
->w
)
17211 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17212 row
->indicate_empty_line_p
= 1;
17215 it
->continuation_lines_width
= 0;
17216 row
->ends_at_zv_p
= 1;
17217 /* A row that displays right-to-left text must always have
17218 its last face extended all the way to the end of line,
17219 even if this row ends in ZV. */
17220 if (row
->reversed_p
)
17221 extend_face_to_end_of_line (it
);
17225 /* Now, get the metrics of what we want to display. This also
17226 generates glyphs in `row' (which is IT->glyph_row). */
17227 n_glyphs_before
= row
->used
[TEXT_AREA
];
17230 /* Remember the line height so far in case the next element doesn't
17231 fit on the line. */
17232 if (it
->line_wrap
!= TRUNCATE
)
17234 ascent
= it
->max_ascent
;
17235 descent
= it
->max_descent
;
17236 phys_ascent
= it
->max_phys_ascent
;
17237 phys_descent
= it
->max_phys_descent
;
17239 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17241 if (IT_DISPLAYING_WHITESPACE (it
))
17247 wrap_row_used
= row
->used
[TEXT_AREA
];
17248 wrap_row_ascent
= row
->ascent
;
17249 wrap_row_height
= row
->height
;
17250 wrap_row_phys_ascent
= row
->phys_ascent
;
17251 wrap_row_phys_height
= row
->phys_height
;
17252 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17258 PRODUCE_GLYPHS (it
);
17260 /* If this display element was in marginal areas, continue with
17262 if (it
->area
!= TEXT_AREA
)
17264 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17265 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17266 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17267 row
->phys_height
= max (row
->phys_height
,
17268 it
->max_phys_ascent
+ it
->max_phys_descent
);
17269 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17270 it
->max_extra_line_spacing
);
17271 set_iterator_to_next (it
, 1);
17275 /* Does the display element fit on the line? If we truncate
17276 lines, we should draw past the right edge of the window. If
17277 we don't truncate, we want to stop so that we can display the
17278 continuation glyph before the right margin. If lines are
17279 continued, there are two possible strategies for characters
17280 resulting in more than 1 glyph (e.g. tabs): Display as many
17281 glyphs as possible in this line and leave the rest for the
17282 continuation line, or display the whole element in the next
17283 line. Original redisplay did the former, so we do it also. */
17284 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17285 hpos_before
= it
->hpos
;
17288 if (/* Not a newline. */
17290 /* Glyphs produced fit entirely in the line. */
17291 && it
->current_x
< it
->last_visible_x
)
17293 it
->hpos
+= nglyphs
;
17294 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17295 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17296 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17297 row
->phys_height
= max (row
->phys_height
,
17298 it
->max_phys_ascent
+ it
->max_phys_descent
);
17299 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17300 it
->max_extra_line_spacing
);
17301 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17302 row
->x
= x
- it
->first_visible_x
;
17307 struct glyph
*glyph
;
17309 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17311 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17312 new_x
= x
+ glyph
->pixel_width
;
17314 if (/* Lines are continued. */
17315 it
->line_wrap
!= TRUNCATE
17316 && (/* Glyph doesn't fit on the line. */
17317 new_x
> it
->last_visible_x
17318 /* Or it fits exactly on a window system frame. */
17319 || (new_x
== it
->last_visible_x
17320 && FRAME_WINDOW_P (it
->f
))))
17322 /* End of a continued line. */
17325 || (new_x
== it
->last_visible_x
17326 && FRAME_WINDOW_P (it
->f
)))
17328 /* Current glyph is the only one on the line or
17329 fits exactly on the line. We must continue
17330 the line because we can't draw the cursor
17331 after the glyph. */
17332 row
->continued_p
= 1;
17333 it
->current_x
= new_x
;
17334 it
->continuation_lines_width
+= new_x
;
17336 if (i
== nglyphs
- 1)
17338 /* If line-wrap is on, check if a previous
17339 wrap point was found. */
17340 if (wrap_row_used
> 0
17341 /* Even if there is a previous wrap
17342 point, continue the line here as
17343 usual, if (i) the previous character
17344 was a space or tab AND (ii) the
17345 current character is not. */
17347 || IT_DISPLAYING_WHITESPACE (it
)))
17350 set_iterator_to_next (it
, 1);
17351 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17353 if (!get_next_display_element (it
))
17355 row
->exact_window_width_line_p
= 1;
17356 it
->continuation_lines_width
= 0;
17357 row
->continued_p
= 0;
17358 row
->ends_at_zv_p
= 1;
17360 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17362 row
->continued_p
= 0;
17363 row
->exact_window_width_line_p
= 1;
17368 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17369 && !FRAME_WINDOW_P (it
->f
))
17371 /* A padding glyph that doesn't fit on this line.
17372 This means the whole character doesn't fit
17374 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17376 /* Fill the rest of the row with continuation
17377 glyphs like in 20.x. */
17378 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17379 < row
->glyphs
[1 + TEXT_AREA
])
17380 produce_special_glyphs (it
, IT_CONTINUATION
);
17382 row
->continued_p
= 1;
17383 it
->current_x
= x_before
;
17384 it
->continuation_lines_width
+= x_before
;
17386 /* Restore the height to what it was before the
17387 element not fitting on the line. */
17388 it
->max_ascent
= ascent
;
17389 it
->max_descent
= descent
;
17390 it
->max_phys_ascent
= phys_ascent
;
17391 it
->max_phys_descent
= phys_descent
;
17393 else if (wrap_row_used
> 0)
17397 it
->continuation_lines_width
+= wrap_x
;
17398 row
->used
[TEXT_AREA
] = wrap_row_used
;
17399 row
->ascent
= wrap_row_ascent
;
17400 row
->height
= wrap_row_height
;
17401 row
->phys_ascent
= wrap_row_phys_ascent
;
17402 row
->phys_height
= wrap_row_phys_height
;
17403 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17404 row
->continued_p
= 1;
17405 row
->ends_at_zv_p
= 0;
17406 row
->exact_window_width_line_p
= 0;
17407 it
->continuation_lines_width
+= x
;
17409 /* Make sure that a non-default face is extended
17410 up to the right margin of the window. */
17411 extend_face_to_end_of_line (it
);
17413 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17415 /* A TAB that extends past the right edge of the
17416 window. This produces a single glyph on
17417 window system frames. We leave the glyph in
17418 this row and let it fill the row, but don't
17419 consume the TAB. */
17420 it
->continuation_lines_width
+= it
->last_visible_x
;
17421 row
->ends_in_middle_of_char_p
= 1;
17422 row
->continued_p
= 1;
17423 glyph
->pixel_width
= it
->last_visible_x
- x
;
17424 it
->starts_in_middle_of_char_p
= 1;
17428 /* Something other than a TAB that draws past
17429 the right edge of the window. Restore
17430 positions to values before the element. */
17431 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17433 /* Display continuation glyphs. */
17434 if (!FRAME_WINDOW_P (it
->f
))
17435 produce_special_glyphs (it
, IT_CONTINUATION
);
17436 row
->continued_p
= 1;
17438 it
->current_x
= x_before
;
17439 it
->continuation_lines_width
+= x
;
17440 extend_face_to_end_of_line (it
);
17442 if (nglyphs
> 1 && i
> 0)
17444 row
->ends_in_middle_of_char_p
= 1;
17445 it
->starts_in_middle_of_char_p
= 1;
17448 /* Restore the height to what it was before the
17449 element not fitting on the line. */
17450 it
->max_ascent
= ascent
;
17451 it
->max_descent
= descent
;
17452 it
->max_phys_ascent
= phys_ascent
;
17453 it
->max_phys_descent
= phys_descent
;
17458 else if (new_x
> it
->first_visible_x
)
17460 /* Increment number of glyphs actually displayed. */
17463 if (x
< it
->first_visible_x
)
17464 /* Glyph is partially visible, i.e. row starts at
17465 negative X position. */
17466 row
->x
= x
- it
->first_visible_x
;
17470 /* Glyph is completely off the left margin of the
17471 window. This should not happen because of the
17472 move_it_in_display_line at the start of this
17473 function, unless the text display area of the
17474 window is empty. */
17475 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17479 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17480 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17481 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17482 row
->phys_height
= max (row
->phys_height
,
17483 it
->max_phys_ascent
+ it
->max_phys_descent
);
17484 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17485 it
->max_extra_line_spacing
);
17487 /* End of this display line if row is continued. */
17488 if (row
->continued_p
|| row
->ends_at_zv_p
)
17493 /* Is this a line end? If yes, we're also done, after making
17494 sure that a non-default face is extended up to the right
17495 margin of the window. */
17496 if (ITERATOR_AT_END_OF_LINE_P (it
))
17498 int used_before
= row
->used
[TEXT_AREA
];
17500 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17502 /* Add a space at the end of the line that is used to
17503 display the cursor there. */
17504 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17505 append_space_for_newline (it
, 0);
17507 /* Extend the face to the end of the line. */
17508 extend_face_to_end_of_line (it
);
17510 /* Make sure we have the position. */
17511 if (used_before
== 0)
17512 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17514 /* Consume the line end. This skips over invisible lines. */
17515 set_iterator_to_next (it
, 1);
17516 it
->continuation_lines_width
= 0;
17520 /* Proceed with next display element. Note that this skips
17521 over lines invisible because of selective display. */
17522 set_iterator_to_next (it
, 1);
17524 /* If we truncate lines, we are done when the last displayed
17525 glyphs reach past the right margin of the window. */
17526 if (it
->line_wrap
== TRUNCATE
17527 && (FRAME_WINDOW_P (it
->f
)
17528 ? (it
->current_x
>= it
->last_visible_x
)
17529 : (it
->current_x
> it
->last_visible_x
)))
17531 /* Maybe add truncation glyphs. */
17532 if (!FRAME_WINDOW_P (it
->f
))
17536 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17537 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17540 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17542 row
->used
[TEXT_AREA
] = i
;
17543 produce_special_glyphs (it
, IT_TRUNCATION
);
17546 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17548 /* Don't truncate if we can overflow newline into fringe. */
17549 if (!get_next_display_element (it
))
17551 it
->continuation_lines_width
= 0;
17552 row
->ends_at_zv_p
= 1;
17553 row
->exact_window_width_line_p
= 1;
17556 if (ITERATOR_AT_END_OF_LINE_P (it
))
17558 row
->exact_window_width_line_p
= 1;
17559 goto at_end_of_line
;
17563 row
->truncated_on_right_p
= 1;
17564 it
->continuation_lines_width
= 0;
17565 reseat_at_next_visible_line_start (it
, 0);
17566 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
17567 it
->hpos
= hpos_before
;
17568 it
->current_x
= x_before
;
17573 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17574 at the left window margin. */
17575 if (it
->first_visible_x
17576 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
17578 if (!FRAME_WINDOW_P (it
->f
))
17579 insert_left_trunc_glyphs (it
);
17580 row
->truncated_on_left_p
= 1;
17583 /* If the start of this line is the overlay arrow-position, then
17584 mark this glyph row as the one containing the overlay arrow.
17585 This is clearly a mess with variable size fonts. It would be
17586 better to let it be displayed like cursors under X. */
17587 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
17588 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
17589 !NILP (overlay_arrow_string
)))
17591 /* Overlay arrow in window redisplay is a fringe bitmap. */
17592 if (STRINGP (overlay_arrow_string
))
17594 struct glyph_row
*arrow_row
17595 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
17596 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
17597 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
17598 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
17599 struct glyph
*p2
, *end
;
17601 /* Copy the arrow glyphs. */
17602 while (glyph
< arrow_end
)
17605 /* Throw away padding glyphs. */
17607 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17608 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
17614 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
17619 xassert (INTEGERP (overlay_arrow_string
));
17620 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
17622 overlay_arrow_seen
= 1;
17625 /* Compute pixel dimensions of this line. */
17626 compute_line_metrics (it
);
17628 /* Remember the position at which this line ends. */
17629 row
->end
= row_end
= it
->current
;
17632 /* ROW->start and ROW->end must be the smallest and largest
17633 buffer positions in ROW. But if ROW was bidi-reordered,
17634 these two positions can be anywhere in the row, so we must
17635 rescan all of the ROW's glyphs to find them. */
17636 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17637 lines' rows is implemented for bidi-reordered rows. */
17638 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
17641 struct text_pos tpos
;
17643 for (g
= row
->glyphs
[TEXT_AREA
];
17644 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17647 if (BUFFERP (g
->object
))
17649 if (g
->charpos
> 0 && g
->charpos
< min_pos
)
17650 min_pos
= g
->charpos
;
17651 if (g
->charpos
> max_pos
)
17652 max_pos
= g
->charpos
;
17655 /* Empty lines have a valid buffer position at their first
17656 glyph, but that glyph's OBJECT is zero, as if it didn't come
17657 from a buffer. If we didn't find any valid buffer positions
17658 in this row, maybe we have such an empty line. */
17659 if (min_pos
== ZV
+ 1 && row
->used
[TEXT_AREA
])
17661 for (g
= row
->glyphs
[TEXT_AREA
];
17662 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17665 if (INTEGERP (g
->object
))
17667 if (g
->charpos
> 0 && g
->charpos
< min_pos
)
17668 min_pos
= g
->charpos
;
17669 if (g
->charpos
> max_pos
)
17670 max_pos
= g
->charpos
;
17676 if (min_pos
!= row
->start
.pos
.charpos
)
17678 row
->start
.pos
.charpos
= min_pos
;
17679 row
->start
.pos
.bytepos
= CHAR_TO_BYTE (min_pos
);
17684 /* For ROW->end, we need the position that is _after_ max_pos,
17685 in the logical order, unless we are at ZV. */
17686 if (row
->ends_at_zv_p
)
17688 row_end
= row
->end
= it
->current
;
17689 if (!row
->used
[TEXT_AREA
])
17691 row
->start
.pos
.charpos
= row_end
.pos
.charpos
;
17692 row
->start
.pos
.bytepos
= row_end
.pos
.bytepos
;
17695 else if (row
->used
[TEXT_AREA
] && max_pos
)
17697 SET_TEXT_POS (tpos
, max_pos
+ 1, CHAR_TO_BYTE (max_pos
+ 1));
17698 row_end
= it
->current
;
17699 row_end
.pos
= tpos
;
17700 /* If the character at max_pos+1 is a newline, skip that as
17701 well. Note that this may skip some invisible text. */
17702 if (FETCH_CHAR (tpos
.bytepos
) == '\n'
17703 || (FETCH_CHAR (tpos
.bytepos
) == '\r' && it
->selective
))
17707 reseat_1 (it
, tpos
, 0);
17708 set_iterator_to_next (it
, 1);
17709 /* Record the position after the newline of a continued
17710 row. We will need that to set ROW->end of the last
17711 row produced for a continued line. */
17712 if (row
->continued_p
)
17714 save_it
.eol_pos
.charpos
= IT_CHARPOS (*it
);
17715 save_it
.eol_pos
.bytepos
= IT_BYTEPOS (*it
);
17719 row_end
= it
->current
;
17720 save_it
.eol_pos
.charpos
= save_it
.eol_pos
.bytepos
= 0;
17724 else if (!row
->continued_p
17725 && row
->continuation_lines_width
17726 && it
->eol_pos
.charpos
> 0)
17728 /* Last row of a continued line. Use the position
17729 recorded in ROW->eol_pos, to the effect that the
17730 newline belongs to this row, not to the row which
17731 displays the character with the largest buffer
17733 row_end
.pos
= it
->eol_pos
;
17734 it
->eol_pos
.charpos
= it
->eol_pos
.bytepos
= 0;
17736 row
->end
= row_end
;
17740 /* Record whether this row ends inside an ellipsis. */
17741 row
->ends_in_ellipsis_p
17742 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17743 && it
->ellipsis_p
);
17745 /* Save fringe bitmaps in this row. */
17746 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17747 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17748 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17749 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17751 it
->left_user_fringe_bitmap
= 0;
17752 it
->left_user_fringe_face_id
= 0;
17753 it
->right_user_fringe_bitmap
= 0;
17754 it
->right_user_fringe_face_id
= 0;
17756 /* Maybe set the cursor. */
17757 cvpos
= it
->w
->cursor
.vpos
;
17759 /* In bidi-reordered rows, keep checking for proper cursor
17760 position even if one has been found already, because buffer
17761 positions in such rows change non-linearly with ROW->VPOS,
17762 when a line is continued. One exception: when we are at ZV,
17763 display cursor on the first suitable glyph row, since all
17764 the empty rows after that also have their position set to ZV. */
17765 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17766 lines' rows is implemented for bidi-reordered rows. */
17768 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
17769 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17770 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17771 && cursor_row_p (it
->w
, row
))
17772 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17774 /* Highlight trailing whitespace. */
17775 if (!NILP (Vshow_trailing_whitespace
))
17776 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17778 /* Prepare for the next line. This line starts horizontally at (X
17779 HPOS) = (0 0). Vertical positions are incremented. As a
17780 convenience for the caller, IT->glyph_row is set to the next
17782 it
->current_x
= it
->hpos
= 0;
17783 it
->current_y
+= row
->height
;
17786 /* The next row should use same value of the reversed_p flag as this
17787 one. set_iterator_to_next decides when it's a new paragraph, and
17788 PRODUCE_GLYPHS recomputes the value of the flag accordingly. */
17789 it
->glyph_row
->reversed_p
= row
->reversed_p
;
17790 it
->start
= row_end
;
17791 return row
->displays_text_p
;
17796 /***********************************************************************
17798 ***********************************************************************/
17800 /* Redisplay the menu bar in the frame for window W.
17802 The menu bar of X frames that don't have X toolkit support is
17803 displayed in a special window W->frame->menu_bar_window.
17805 The menu bar of terminal frames is treated specially as far as
17806 glyph matrices are concerned. Menu bar lines are not part of
17807 windows, so the update is done directly on the frame matrix rows
17808 for the menu bar. */
17811 display_menu_bar (w
)
17814 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17819 /* Don't do all this for graphical frames. */
17821 if (FRAME_W32_P (f
))
17824 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
17830 if (FRAME_NS_P (f
))
17832 #endif /* HAVE_NS */
17834 #ifdef USE_X_TOOLKIT
17835 xassert (!FRAME_WINDOW_P (f
));
17836 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
17837 it
.first_visible_x
= 0;
17838 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
17839 #else /* not USE_X_TOOLKIT */
17840 if (FRAME_WINDOW_P (f
))
17842 /* Menu bar lines are displayed in the desired matrix of the
17843 dummy window menu_bar_window. */
17844 struct window
*menu_w
;
17845 xassert (WINDOWP (f
->menu_bar_window
));
17846 menu_w
= XWINDOW (f
->menu_bar_window
);
17847 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
17849 it
.first_visible_x
= 0;
17850 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
17854 /* This is a TTY frame, i.e. character hpos/vpos are used as
17856 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
17858 it
.first_visible_x
= 0;
17859 it
.last_visible_x
= FRAME_COLS (f
);
17861 #endif /* not USE_X_TOOLKIT */
17863 if (! mode_line_inverse_video
)
17864 /* Force the menu-bar to be displayed in the default face. */
17865 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
17867 /* Clear all rows of the menu bar. */
17868 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
17870 struct glyph_row
*row
= it
.glyph_row
+ i
;
17871 clear_glyph_row (row
);
17872 row
->enabled_p
= 1;
17873 row
->full_width_p
= 1;
17876 /* Display all items of the menu bar. */
17877 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
17878 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
17880 Lisp_Object string
;
17882 /* Stop at nil string. */
17883 string
= AREF (items
, i
+ 1);
17887 /* Remember where item was displayed. */
17888 ASET (items
, i
+ 3, make_number (it
.hpos
));
17890 /* Display the item, pad with one space. */
17891 if (it
.current_x
< it
.last_visible_x
)
17892 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
17893 SCHARS (string
) + 1, 0, 0, -1);
17896 /* Fill out the line with spaces. */
17897 if (it
.current_x
< it
.last_visible_x
)
17898 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
17900 /* Compute the total height of the lines. */
17901 compute_line_metrics (&it
);
17906 /***********************************************************************
17908 ***********************************************************************/
17910 /* Redisplay mode lines in the window tree whose root is WINDOW. If
17911 FORCE is non-zero, redisplay mode lines unconditionally.
17912 Otherwise, redisplay only mode lines that are garbaged. Value is
17913 the number of windows whose mode lines were redisplayed. */
17916 redisplay_mode_lines (window
, force
)
17917 Lisp_Object window
;
17922 while (!NILP (window
))
17924 struct window
*w
= XWINDOW (window
);
17926 if (WINDOWP (w
->hchild
))
17927 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
17928 else if (WINDOWP (w
->vchild
))
17929 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
17931 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
17932 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
17934 struct text_pos lpoint
;
17935 struct buffer
*old
= current_buffer
;
17937 /* Set the window's buffer for the mode line display. */
17938 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
17939 set_buffer_internal_1 (XBUFFER (w
->buffer
));
17941 /* Point refers normally to the selected window. For any
17942 other window, set up appropriate value. */
17943 if (!EQ (window
, selected_window
))
17945 struct text_pos pt
;
17947 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
17948 if (CHARPOS (pt
) < BEGV
)
17949 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
17950 else if (CHARPOS (pt
) > (ZV
- 1))
17951 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
17953 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
17956 /* Display mode lines. */
17957 clear_glyph_matrix (w
->desired_matrix
);
17958 if (display_mode_lines (w
))
17961 w
->must_be_updated_p
= 1;
17964 /* Restore old settings. */
17965 set_buffer_internal_1 (old
);
17966 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
17976 /* Display the mode and/or header line of window W. Value is the
17977 sum number of mode lines and header lines displayed. */
17980 display_mode_lines (w
)
17983 Lisp_Object old_selected_window
, old_selected_frame
;
17986 old_selected_frame
= selected_frame
;
17987 selected_frame
= w
->frame
;
17988 old_selected_window
= selected_window
;
17989 XSETWINDOW (selected_window
, w
);
17991 /* These will be set while the mode line specs are processed. */
17992 line_number_displayed
= 0;
17993 w
->column_number_displayed
= Qnil
;
17995 if (WINDOW_WANTS_MODELINE_P (w
))
17997 struct window
*sel_w
= XWINDOW (old_selected_window
);
17999 /* Select mode line face based on the real selected window. */
18000 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18001 current_buffer
->mode_line_format
);
18005 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18007 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18008 current_buffer
->header_line_format
);
18012 selected_frame
= old_selected_frame
;
18013 selected_window
= old_selected_window
;
18018 /* Display mode or header line of window W. FACE_ID specifies which
18019 line to display; it is either MODE_LINE_FACE_ID or
18020 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18021 display. Value is the pixel height of the mode/header line
18025 display_mode_line (w
, face_id
, format
)
18027 enum face_id face_id
;
18028 Lisp_Object format
;
18032 int count
= SPECPDL_INDEX ();
18034 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18035 /* Don't extend on a previously drawn mode-line.
18036 This may happen if called from pos_visible_p. */
18037 it
.glyph_row
->enabled_p
= 0;
18038 prepare_desired_row (it
.glyph_row
);
18040 it
.glyph_row
->mode_line_p
= 1;
18042 if (! mode_line_inverse_video
)
18043 /* Force the mode-line to be displayed in the default face. */
18044 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18046 record_unwind_protect (unwind_format_mode_line
,
18047 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18049 mode_line_target
= MODE_LINE_DISPLAY
;
18051 /* Temporarily make frame's keyboard the current kboard so that
18052 kboard-local variables in the mode_line_format will get the right
18054 push_kboard (FRAME_KBOARD (it
.f
));
18055 record_unwind_save_match_data ();
18056 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18059 unbind_to (count
, Qnil
);
18061 /* Fill up with spaces. */
18062 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18064 compute_line_metrics (&it
);
18065 it
.glyph_row
->full_width_p
= 1;
18066 it
.glyph_row
->continued_p
= 0;
18067 it
.glyph_row
->truncated_on_left_p
= 0;
18068 it
.glyph_row
->truncated_on_right_p
= 0;
18070 /* Make a 3D mode-line have a shadow at its right end. */
18071 face
= FACE_FROM_ID (it
.f
, face_id
);
18072 extend_face_to_end_of_line (&it
);
18073 if (face
->box
!= FACE_NO_BOX
)
18075 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18076 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18077 last
->right_box_line_p
= 1;
18080 return it
.glyph_row
->height
;
18083 /* Move element ELT in LIST to the front of LIST.
18084 Return the updated list. */
18087 move_elt_to_front (elt
, list
)
18088 Lisp_Object elt
, list
;
18090 register Lisp_Object tail
, prev
;
18091 register Lisp_Object tem
;
18095 while (CONSP (tail
))
18101 /* Splice out the link TAIL. */
18103 list
= XCDR (tail
);
18105 Fsetcdr (prev
, XCDR (tail
));
18107 /* Now make it the first. */
18108 Fsetcdr (tail
, list
);
18113 tail
= XCDR (tail
);
18117 /* Not found--return unchanged LIST. */
18121 /* Contribute ELT to the mode line for window IT->w. How it
18122 translates into text depends on its data type.
18124 IT describes the display environment in which we display, as usual.
18126 DEPTH is the depth in recursion. It is used to prevent
18127 infinite recursion here.
18129 FIELD_WIDTH is the number of characters the display of ELT should
18130 occupy in the mode line, and PRECISION is the maximum number of
18131 characters to display from ELT's representation. See
18132 display_string for details.
18134 Returns the hpos of the end of the text generated by ELT.
18136 PROPS is a property list to add to any string we encounter.
18138 If RISKY is nonzero, remove (disregard) any properties in any string
18139 we encounter, and ignore :eval and :propertize.
18141 The global variable `mode_line_target' determines whether the
18142 output is passed to `store_mode_line_noprop',
18143 `store_mode_line_string', or `display_string'. */
18146 display_mode_element (it
, depth
, field_width
, precision
, elt
, props
, risky
)
18149 int field_width
, precision
;
18150 Lisp_Object elt
, props
;
18153 int n
= 0, field
, prec
;
18158 elt
= build_string ("*too-deep*");
18162 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18166 /* A string: output it and check for %-constructs within it. */
18170 if (SCHARS (elt
) > 0
18171 && (!NILP (props
) || risky
))
18173 Lisp_Object oprops
, aelt
;
18174 oprops
= Ftext_properties_at (make_number (0), elt
);
18176 /* If the starting string's properties are not what
18177 we want, translate the string. Also, if the string
18178 is risky, do that anyway. */
18180 if (NILP (Fequal (props
, oprops
)) || risky
)
18182 /* If the starting string has properties,
18183 merge the specified ones onto the existing ones. */
18184 if (! NILP (oprops
) && !risky
)
18188 oprops
= Fcopy_sequence (oprops
);
18190 while (CONSP (tem
))
18192 oprops
= Fplist_put (oprops
, XCAR (tem
),
18193 XCAR (XCDR (tem
)));
18194 tem
= XCDR (XCDR (tem
));
18199 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18200 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18202 /* AELT is what we want. Move it to the front
18203 without consing. */
18205 mode_line_proptrans_alist
18206 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18212 /* If AELT has the wrong props, it is useless.
18213 so get rid of it. */
18215 mode_line_proptrans_alist
18216 = Fdelq (aelt
, mode_line_proptrans_alist
);
18218 elt
= Fcopy_sequence (elt
);
18219 Fset_text_properties (make_number (0), Flength (elt
),
18221 /* Add this item to mode_line_proptrans_alist. */
18222 mode_line_proptrans_alist
18223 = Fcons (Fcons (elt
, props
),
18224 mode_line_proptrans_alist
);
18225 /* Truncate mode_line_proptrans_alist
18226 to at most 50 elements. */
18227 tem
= Fnthcdr (make_number (50),
18228 mode_line_proptrans_alist
);
18230 XSETCDR (tem
, Qnil
);
18239 prec
= precision
- n
;
18240 switch (mode_line_target
)
18242 case MODE_LINE_NOPROP
:
18243 case MODE_LINE_TITLE
:
18244 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
18246 case MODE_LINE_STRING
:
18247 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18249 case MODE_LINE_DISPLAY
:
18250 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18251 0, prec
, 0, STRING_MULTIBYTE (elt
));
18258 /* Handle the non-literal case. */
18260 while ((precision
<= 0 || n
< precision
)
18261 && SREF (elt
, offset
) != 0
18262 && (mode_line_target
!= MODE_LINE_DISPLAY
18263 || it
->current_x
< it
->last_visible_x
))
18265 int last_offset
= offset
;
18267 /* Advance to end of string or next format specifier. */
18268 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18271 if (offset
- 1 != last_offset
)
18273 int nchars
, nbytes
;
18275 /* Output to end of string or up to '%'. Field width
18276 is length of string. Don't output more than
18277 PRECISION allows us. */
18280 prec
= c_string_width (SDATA (elt
) + last_offset
,
18281 offset
- last_offset
, precision
- n
,
18284 switch (mode_line_target
)
18286 case MODE_LINE_NOPROP
:
18287 case MODE_LINE_TITLE
:
18288 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
18290 case MODE_LINE_STRING
:
18292 int bytepos
= last_offset
;
18293 int charpos
= string_byte_to_char (elt
, bytepos
);
18294 int endpos
= (precision
<= 0
18295 ? string_byte_to_char (elt
, offset
)
18296 : charpos
+ nchars
);
18298 n
+= store_mode_line_string (NULL
,
18299 Fsubstring (elt
, make_number (charpos
),
18300 make_number (endpos
)),
18304 case MODE_LINE_DISPLAY
:
18306 int bytepos
= last_offset
;
18307 int charpos
= string_byte_to_char (elt
, bytepos
);
18309 if (precision
<= 0)
18310 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18311 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18313 STRING_MULTIBYTE (elt
));
18318 else /* c == '%' */
18320 int percent_position
= offset
;
18322 /* Get the specified minimum width. Zero means
18325 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18326 field
= field
* 10 + c
- '0';
18328 /* Don't pad beyond the total padding allowed. */
18329 if (field_width
- n
> 0 && field
> field_width
- n
)
18330 field
= field_width
- n
;
18332 /* Note that either PRECISION <= 0 or N < PRECISION. */
18333 prec
= precision
- n
;
18336 n
+= display_mode_element (it
, depth
, field
, prec
,
18337 Vglobal_mode_string
, props
,
18342 int bytepos
, charpos
;
18343 unsigned char *spec
;
18344 Lisp_Object string
;
18346 bytepos
= percent_position
;
18347 charpos
= (STRING_MULTIBYTE (elt
)
18348 ? string_byte_to_char (elt
, bytepos
)
18350 spec
= decode_mode_spec (it
->w
, c
, field
, prec
, &string
);
18351 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18353 switch (mode_line_target
)
18355 case MODE_LINE_NOPROP
:
18356 case MODE_LINE_TITLE
:
18357 n
+= store_mode_line_noprop (spec
, field
, prec
);
18359 case MODE_LINE_STRING
:
18361 int len
= strlen (spec
);
18362 Lisp_Object tem
= make_string (spec
, len
);
18363 props
= Ftext_properties_at (make_number (charpos
), elt
);
18364 /* Should only keep face property in props */
18365 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18368 case MODE_LINE_DISPLAY
:
18370 int nglyphs_before
, nwritten
;
18372 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18373 nwritten
= display_string (spec
, string
, elt
,
18378 /* Assign to the glyphs written above the
18379 string where the `%x' came from, position
18383 struct glyph
*glyph
18384 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18388 for (i
= 0; i
< nwritten
; ++i
)
18390 glyph
[i
].object
= elt
;
18391 glyph
[i
].charpos
= charpos
;
18408 /* A symbol: process the value of the symbol recursively
18409 as if it appeared here directly. Avoid error if symbol void.
18410 Special case: if value of symbol is a string, output the string
18413 register Lisp_Object tem
;
18415 /* If the variable is not marked as risky to set
18416 then its contents are risky to use. */
18417 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18420 tem
= Fboundp (elt
);
18423 tem
= Fsymbol_value (elt
);
18424 /* If value is a string, output that string literally:
18425 don't check for % within it. */
18429 if (!EQ (tem
, elt
))
18431 /* Give up right away for nil or t. */
18441 register Lisp_Object car
, tem
;
18443 /* A cons cell: five distinct cases.
18444 If first element is :eval or :propertize, do something special.
18445 If first element is a string or a cons, process all the elements
18446 and effectively concatenate them.
18447 If first element is a negative number, truncate displaying cdr to
18448 at most that many characters. If positive, pad (with spaces)
18449 to at least that many characters.
18450 If first element is a symbol, process the cadr or caddr recursively
18451 according to whether the symbol's value is non-nil or nil. */
18453 if (EQ (car
, QCeval
))
18455 /* An element of the form (:eval FORM) means evaluate FORM
18456 and use the result as mode line elements. */
18461 if (CONSP (XCDR (elt
)))
18464 spec
= safe_eval (XCAR (XCDR (elt
)));
18465 n
+= display_mode_element (it
, depth
, field_width
- n
,
18466 precision
- n
, spec
, props
,
18470 else if (EQ (car
, QCpropertize
))
18472 /* An element of the form (:propertize ELT PROPS...)
18473 means display ELT but applying properties PROPS. */
18478 if (CONSP (XCDR (elt
)))
18479 n
+= display_mode_element (it
, depth
, field_width
- n
,
18480 precision
- n
, XCAR (XCDR (elt
)),
18481 XCDR (XCDR (elt
)), risky
);
18483 else if (SYMBOLP (car
))
18485 tem
= Fboundp (car
);
18489 /* elt is now the cdr, and we know it is a cons cell.
18490 Use its car if CAR has a non-nil value. */
18493 tem
= Fsymbol_value (car
);
18500 /* Symbol's value is nil (or symbol is unbound)
18501 Get the cddr of the original list
18502 and if possible find the caddr and use that. */
18506 else if (!CONSP (elt
))
18511 else if (INTEGERP (car
))
18513 register int lim
= XINT (car
);
18517 /* Negative int means reduce maximum width. */
18518 if (precision
<= 0)
18521 precision
= min (precision
, -lim
);
18525 /* Padding specified. Don't let it be more than
18526 current maximum. */
18528 lim
= min (precision
, lim
);
18530 /* If that's more padding than already wanted, queue it.
18531 But don't reduce padding already specified even if
18532 that is beyond the current truncation point. */
18533 field_width
= max (lim
, field_width
);
18537 else if (STRINGP (car
) || CONSP (car
))
18539 Lisp_Object halftail
= elt
;
18543 && (precision
<= 0 || n
< precision
))
18545 n
+= display_mode_element (it
, depth
,
18546 /* Do padding only after the last
18547 element in the list. */
18548 (! CONSP (XCDR (elt
))
18551 precision
- n
, XCAR (elt
),
18555 if ((len
& 1) == 0)
18556 halftail
= XCDR (halftail
);
18557 /* Check for cycle. */
18558 if (EQ (halftail
, elt
))
18567 elt
= build_string ("*invalid*");
18571 /* Pad to FIELD_WIDTH. */
18572 if (field_width
> 0 && n
< field_width
)
18574 switch (mode_line_target
)
18576 case MODE_LINE_NOPROP
:
18577 case MODE_LINE_TITLE
:
18578 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18580 case MODE_LINE_STRING
:
18581 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18583 case MODE_LINE_DISPLAY
:
18584 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18593 /* Store a mode-line string element in mode_line_string_list.
18595 If STRING is non-null, display that C string. Otherwise, the Lisp
18596 string LISP_STRING is displayed.
18598 FIELD_WIDTH is the minimum number of output glyphs to produce.
18599 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18600 with spaces. FIELD_WIDTH <= 0 means don't pad.
18602 PRECISION is the maximum number of characters to output from
18603 STRING. PRECISION <= 0 means don't truncate the string.
18605 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18606 properties to the string.
18608 PROPS are the properties to add to the string.
18609 The mode_line_string_face face property is always added to the string.
18613 store_mode_line_string (string
, lisp_string
, copy_string
, field_width
, precision
, props
)
18615 Lisp_Object lisp_string
;
18624 if (string
!= NULL
)
18626 len
= strlen (string
);
18627 if (precision
> 0 && len
> precision
)
18629 lisp_string
= make_string (string
, len
);
18631 props
= mode_line_string_face_prop
;
18632 else if (!NILP (mode_line_string_face
))
18634 Lisp_Object face
= Fplist_get (props
, Qface
);
18635 props
= Fcopy_sequence (props
);
18637 face
= mode_line_string_face
;
18639 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18640 props
= Fplist_put (props
, Qface
, face
);
18642 Fadd_text_properties (make_number (0), make_number (len
),
18643 props
, lisp_string
);
18647 len
= XFASTINT (Flength (lisp_string
));
18648 if (precision
> 0 && len
> precision
)
18651 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
18654 if (!NILP (mode_line_string_face
))
18658 props
= Ftext_properties_at (make_number (0), lisp_string
);
18659 face
= Fplist_get (props
, Qface
);
18661 face
= mode_line_string_face
;
18663 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18664 props
= Fcons (Qface
, Fcons (face
, Qnil
));
18666 lisp_string
= Fcopy_sequence (lisp_string
);
18669 Fadd_text_properties (make_number (0), make_number (len
),
18670 props
, lisp_string
);
18675 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18679 if (field_width
> len
)
18681 field_width
-= len
;
18682 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
18684 Fadd_text_properties (make_number (0), make_number (field_width
),
18685 props
, lisp_string
);
18686 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18694 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
18696 doc
: /* Format a string out of a mode line format specification.
18697 First arg FORMAT specifies the mode line format (see `mode-line-format'
18698 for details) to use.
18700 Optional second arg FACE specifies the face property to put
18701 on all characters for which no face is specified.
18702 The value t means whatever face the window's mode line currently uses
18703 \(either `mode-line' or `mode-line-inactive', depending).
18704 A value of nil means the default is no face property.
18705 If FACE is an integer, the value string has no text properties.
18707 Optional third and fourth args WINDOW and BUFFER specify the window
18708 and buffer to use as the context for the formatting (defaults
18709 are the selected window and the window's buffer). */)
18710 (format
, face
, window
, buffer
)
18711 Lisp_Object format
, face
, window
, buffer
;
18716 struct buffer
*old_buffer
= NULL
;
18718 int no_props
= INTEGERP (face
);
18719 int count
= SPECPDL_INDEX ();
18721 int string_start
= 0;
18724 window
= selected_window
;
18725 CHECK_WINDOW (window
);
18726 w
= XWINDOW (window
);
18729 buffer
= w
->buffer
;
18730 CHECK_BUFFER (buffer
);
18732 /* Make formatting the modeline a non-op when noninteractive, otherwise
18733 there will be problems later caused by a partially initialized frame. */
18734 if (NILP (format
) || noninteractive
)
18735 return empty_unibyte_string
;
18743 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
18744 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0);
18748 face_id
= DEFAULT_FACE_ID
;
18750 if (XBUFFER (buffer
) != current_buffer
)
18751 old_buffer
= current_buffer
;
18753 /* Save things including mode_line_proptrans_alist,
18754 and set that to nil so that we don't alter the outer value. */
18755 record_unwind_protect (unwind_format_mode_line
,
18756 format_mode_line_unwind_data
18757 (old_buffer
, selected_window
, 1));
18758 mode_line_proptrans_alist
= Qnil
;
18760 Fselect_window (window
, Qt
);
18762 set_buffer_internal_1 (XBUFFER (buffer
));
18764 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18768 mode_line_target
= MODE_LINE_NOPROP
;
18769 mode_line_string_face_prop
= Qnil
;
18770 mode_line_string_list
= Qnil
;
18771 string_start
= MODE_LINE_NOPROP_LEN (0);
18775 mode_line_target
= MODE_LINE_STRING
;
18776 mode_line_string_list
= Qnil
;
18777 mode_line_string_face
= face
;
18778 mode_line_string_face_prop
18779 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
18782 push_kboard (FRAME_KBOARD (it
.f
));
18783 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18788 len
= MODE_LINE_NOPROP_LEN (string_start
);
18789 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
18793 mode_line_string_list
= Fnreverse (mode_line_string_list
);
18794 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
18795 empty_unibyte_string
);
18798 unbind_to (count
, Qnil
);
18802 /* Write a null-terminated, right justified decimal representation of
18803 the positive integer D to BUF using a minimal field width WIDTH. */
18806 pint2str (buf
, width
, d
)
18807 register char *buf
;
18808 register int width
;
18811 register char *p
= buf
;
18819 *p
++ = d
% 10 + '0';
18824 for (width
-= (int) (p
- buf
); width
> 0; --width
)
18835 /* Write a null-terminated, right justified decimal and "human
18836 readable" representation of the nonnegative integer D to BUF using
18837 a minimal field width WIDTH. D should be smaller than 999.5e24. */
18839 static const char power_letter
[] =
18853 pint2hrstr (buf
, width
, d
)
18858 /* We aim to represent the nonnegative integer D as
18859 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
18862 /* -1 means: do not use TENTHS. */
18866 /* Length of QUOTIENT.TENTHS as a string. */
18872 if (1000 <= quotient
)
18874 /* Scale to the appropriate EXPONENT. */
18877 remainder
= quotient
% 1000;
18881 while (1000 <= quotient
);
18883 /* Round to nearest and decide whether to use TENTHS or not. */
18886 tenths
= remainder
/ 100;
18887 if (50 <= remainder
% 100)
18894 if (quotient
== 10)
18902 if (500 <= remainder
)
18904 if (quotient
< 999)
18915 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
18916 if (tenths
== -1 && quotient
<= 99)
18923 p
= psuffix
= buf
+ max (width
, length
);
18925 /* Print EXPONENT. */
18927 *psuffix
++ = power_letter
[exponent
];
18930 /* Print TENTHS. */
18933 *--p
= '0' + tenths
;
18937 /* Print QUOTIENT. */
18940 int digit
= quotient
% 10;
18941 *--p
= '0' + digit
;
18943 while ((quotient
/= 10) != 0);
18945 /* Print leading spaces. */
18950 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
18951 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
18952 type of CODING_SYSTEM. Return updated pointer into BUF. */
18954 static unsigned char invalid_eol_type
[] = "(*invalid*)";
18957 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
18958 Lisp_Object coding_system
;
18959 register char *buf
;
18963 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
18964 const unsigned char *eol_str
;
18966 /* The EOL conversion we are using. */
18967 Lisp_Object eoltype
;
18969 val
= CODING_SYSTEM_SPEC (coding_system
);
18972 if (!VECTORP (val
)) /* Not yet decided. */
18977 eoltype
= eol_mnemonic_undecided
;
18978 /* Don't mention EOL conversion if it isn't decided. */
18983 Lisp_Object eolvalue
;
18985 attrs
= AREF (val
, 0);
18986 eolvalue
= AREF (val
, 2);
18989 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
18993 /* The EOL conversion that is normal on this system. */
18995 if (NILP (eolvalue
)) /* Not yet decided. */
18996 eoltype
= eol_mnemonic_undecided
;
18997 else if (VECTORP (eolvalue
)) /* Not yet decided. */
18998 eoltype
= eol_mnemonic_undecided
;
18999 else /* eolvalue is Qunix, Qdos, or Qmac. */
19000 eoltype
= (EQ (eolvalue
, Qunix
)
19001 ? eol_mnemonic_unix
19002 : (EQ (eolvalue
, Qdos
) == 1
19003 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19009 /* Mention the EOL conversion if it is not the usual one. */
19010 if (STRINGP (eoltype
))
19012 eol_str
= SDATA (eoltype
);
19013 eol_str_len
= SBYTES (eoltype
);
19015 else if (CHARACTERP (eoltype
))
19017 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19018 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
19023 eol_str
= invalid_eol_type
;
19024 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19026 bcopy (eol_str
, buf
, eol_str_len
);
19027 buf
+= eol_str_len
;
19033 /* Return a string for the output of a mode line %-spec for window W,
19034 generated by character C. PRECISION >= 0 means don't return a
19035 string longer than that value. FIELD_WIDTH > 0 means pad the
19036 string returned with spaces to that value. Return a Lisp string in
19037 *STRING if the resulting string is taken from that Lisp string.
19039 Note we operate on the current buffer for most purposes,
19040 the exception being w->base_line_pos. */
19042 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19045 decode_mode_spec (w
, c
, field_width
, precision
, string
)
19048 int field_width
, precision
;
19049 Lisp_Object
*string
;
19052 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19053 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19054 struct buffer
*b
= current_buffer
;
19062 if (!NILP (b
->read_only
))
19064 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19069 /* This differs from %* only for a modified read-only buffer. */
19070 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19072 if (!NILP (b
->read_only
))
19077 /* This differs from %* in ignoring read-only-ness. */
19078 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19090 if (command_loop_level
> 5)
19092 p
= decode_mode_spec_buf
;
19093 for (i
= 0; i
< command_loop_level
; i
++)
19096 return decode_mode_spec_buf
;
19104 if (command_loop_level
> 5)
19106 p
= decode_mode_spec_buf
;
19107 for (i
= 0; i
< command_loop_level
; i
++)
19110 return decode_mode_spec_buf
;
19117 /* Let lots_of_dashes be a string of infinite length. */
19118 if (mode_line_target
== MODE_LINE_NOPROP
||
19119 mode_line_target
== MODE_LINE_STRING
)
19121 if (field_width
<= 0
19122 || field_width
> sizeof (lots_of_dashes
))
19124 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19125 decode_mode_spec_buf
[i
] = '-';
19126 decode_mode_spec_buf
[i
] = '\0';
19127 return decode_mode_spec_buf
;
19130 return lots_of_dashes
;
19138 /* %c and %l are ignored in `frame-title-format'.
19139 (In redisplay_internal, the frame title is drawn _before_ the
19140 windows are updated, so the stuff which depends on actual
19141 window contents (such as %l) may fail to render properly, or
19142 even crash emacs.) */
19143 if (mode_line_target
== MODE_LINE_TITLE
)
19147 int col
= (int) current_column (); /* iftc */
19148 w
->column_number_displayed
= make_number (col
);
19149 pint2str (decode_mode_spec_buf
, field_width
, col
);
19150 return decode_mode_spec_buf
;
19154 #ifndef SYSTEM_MALLOC
19156 if (NILP (Vmemory_full
))
19159 return "!MEM FULL! ";
19166 /* %F displays the frame name. */
19167 if (!NILP (f
->title
))
19168 return (char *) SDATA (f
->title
);
19169 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19170 return (char *) SDATA (f
->name
);
19179 int size
= ZV
- BEGV
;
19180 pint2str (decode_mode_spec_buf
, field_width
, size
);
19181 return decode_mode_spec_buf
;
19186 int size
= ZV
- BEGV
;
19187 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19188 return decode_mode_spec_buf
;
19193 int startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19194 int topline
, nlines
, junk
, height
;
19196 /* %c and %l are ignored in `frame-title-format'. */
19197 if (mode_line_target
== MODE_LINE_TITLE
)
19200 startpos
= XMARKER (w
->start
)->charpos
;
19201 startpos_byte
= marker_byte_position (w
->start
);
19202 height
= WINDOW_TOTAL_LINES (w
);
19204 /* If we decided that this buffer isn't suitable for line numbers,
19205 don't forget that too fast. */
19206 if (EQ (w
->base_line_pos
, w
->buffer
))
19208 /* But do forget it, if the window shows a different buffer now. */
19209 else if (BUFFERP (w
->base_line_pos
))
19210 w
->base_line_pos
= Qnil
;
19212 /* If the buffer is very big, don't waste time. */
19213 if (INTEGERP (Vline_number_display_limit
)
19214 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19216 w
->base_line_pos
= Qnil
;
19217 w
->base_line_number
= Qnil
;
19221 if (INTEGERP (w
->base_line_number
)
19222 && INTEGERP (w
->base_line_pos
)
19223 && XFASTINT (w
->base_line_pos
) <= startpos
)
19225 line
= XFASTINT (w
->base_line_number
);
19226 linepos
= XFASTINT (w
->base_line_pos
);
19227 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19232 linepos
= BUF_BEGV (b
);
19233 linepos_byte
= BUF_BEGV_BYTE (b
);
19236 /* Count lines from base line to window start position. */
19237 nlines
= display_count_lines (linepos
, linepos_byte
,
19241 topline
= nlines
+ line
;
19243 /* Determine a new base line, if the old one is too close
19244 or too far away, or if we did not have one.
19245 "Too close" means it's plausible a scroll-down would
19246 go back past it. */
19247 if (startpos
== BUF_BEGV (b
))
19249 w
->base_line_number
= make_number (topline
);
19250 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19252 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19253 || linepos
== BUF_BEGV (b
))
19255 int limit
= BUF_BEGV (b
);
19256 int limit_byte
= BUF_BEGV_BYTE (b
);
19258 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
19260 if (startpos
- distance
> limit
)
19262 limit
= startpos
- distance
;
19263 limit_byte
= CHAR_TO_BYTE (limit
);
19266 nlines
= display_count_lines (startpos
, startpos_byte
,
19268 - (height
* 2 + 30),
19270 /* If we couldn't find the lines we wanted within
19271 line_number_display_limit_width chars per line,
19272 give up on line numbers for this window. */
19273 if (position
== limit_byte
&& limit
== startpos
- distance
)
19275 w
->base_line_pos
= w
->buffer
;
19276 w
->base_line_number
= Qnil
;
19280 w
->base_line_number
= make_number (topline
- nlines
);
19281 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19284 /* Now count lines from the start pos to point. */
19285 nlines
= display_count_lines (startpos
, startpos_byte
,
19286 PT_BYTE
, PT
, &junk
);
19288 /* Record that we did display the line number. */
19289 line_number_displayed
= 1;
19291 /* Make the string to show. */
19292 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19293 return decode_mode_spec_buf
;
19296 char* p
= decode_mode_spec_buf
;
19297 int pad
= field_width
- 2;
19303 return decode_mode_spec_buf
;
19309 obj
= b
->mode_name
;
19313 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19319 int pos
= marker_position (w
->start
);
19320 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
19322 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19324 if (pos
<= BUF_BEGV (b
))
19329 else if (pos
<= BUF_BEGV (b
))
19333 if (total
> 1000000)
19334 /* Do it differently for a large value, to avoid overflow. */
19335 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19337 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19338 /* We can't normally display a 3-digit number,
19339 so get us a 2-digit number that is close. */
19342 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
19343 return decode_mode_spec_buf
;
19347 /* Display percentage of size above the bottom of the screen. */
19350 int toppos
= marker_position (w
->start
);
19351 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19352 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
19354 if (botpos
>= BUF_ZV (b
))
19356 if (toppos
<= BUF_BEGV (b
))
19363 if (total
> 1000000)
19364 /* Do it differently for a large value, to avoid overflow. */
19365 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19367 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19368 /* We can't normally display a 3-digit number,
19369 so get us a 2-digit number that is close. */
19372 if (toppos
<= BUF_BEGV (b
))
19373 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
19375 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
19376 return decode_mode_spec_buf
;
19381 /* status of process */
19382 obj
= Fget_buffer_process (Fcurrent_buffer ());
19384 return "no process";
19385 #ifdef subprocesses
19386 obj
= Fsymbol_name (Fprocess_status (obj
));
19392 int count
= inhibit_garbage_collection ();
19393 Lisp_Object val
= call1 (intern ("file-remote-p"),
19394 current_buffer
->directory
);
19395 unbind_to (count
, Qnil
);
19403 case 't': /* indicate TEXT or BINARY */
19404 #ifdef MODE_LINE_BINARY_TEXT
19405 return MODE_LINE_BINARY_TEXT (b
);
19411 /* coding-system (not including end-of-line format) */
19413 /* coding-system (including end-of-line type) */
19415 int eol_flag
= (c
== 'Z');
19416 char *p
= decode_mode_spec_buf
;
19418 if (! FRAME_WINDOW_P (f
))
19420 /* No need to mention EOL here--the terminal never needs
19421 to do EOL conversion. */
19422 p
= decode_mode_spec_coding (CODING_ID_NAME
19423 (FRAME_KEYBOARD_CODING (f
)->id
),
19425 p
= decode_mode_spec_coding (CODING_ID_NAME
19426 (FRAME_TERMINAL_CODING (f
)->id
),
19429 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
19432 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19433 #ifdef subprocesses
19434 obj
= Fget_buffer_process (Fcurrent_buffer ());
19435 if (PROCESSP (obj
))
19437 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19439 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19442 #endif /* subprocesses */
19445 return decode_mode_spec_buf
;
19452 return (char *) SDATA (obj
);
19459 /* Count up to COUNT lines starting from START / START_BYTE.
19460 But don't go beyond LIMIT_BYTE.
19461 Return the number of lines thus found (always nonnegative).
19463 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19466 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
19467 int start
, start_byte
, limit_byte
, count
;
19470 register unsigned char *cursor
;
19471 unsigned char *base
;
19473 register int ceiling
;
19474 register unsigned char *ceiling_addr
;
19475 int orig_count
= count
;
19477 /* If we are not in selective display mode,
19478 check only for newlines. */
19479 int selective_display
= (!NILP (current_buffer
->selective_display
)
19480 && !INTEGERP (current_buffer
->selective_display
));
19484 while (start_byte
< limit_byte
)
19486 ceiling
= BUFFER_CEILING_OF (start_byte
);
19487 ceiling
= min (limit_byte
- 1, ceiling
);
19488 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19489 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19492 if (selective_display
)
19493 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19496 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19499 if (cursor
!= ceiling_addr
)
19503 start_byte
+= cursor
- base
+ 1;
19504 *byte_pos_ptr
= start_byte
;
19508 if (++cursor
== ceiling_addr
)
19514 start_byte
+= cursor
- base
;
19519 while (start_byte
> limit_byte
)
19521 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19522 ceiling
= max (limit_byte
, ceiling
);
19523 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19524 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19527 if (selective_display
)
19528 while (--cursor
!= ceiling_addr
19529 && *cursor
!= '\n' && *cursor
!= 015)
19532 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19535 if (cursor
!= ceiling_addr
)
19539 start_byte
+= cursor
- base
+ 1;
19540 *byte_pos_ptr
= start_byte
;
19541 /* When scanning backwards, we should
19542 not count the newline posterior to which we stop. */
19543 return - orig_count
- 1;
19549 /* Here we add 1 to compensate for the last decrement
19550 of CURSOR, which took it past the valid range. */
19551 start_byte
+= cursor
- base
+ 1;
19555 *byte_pos_ptr
= limit_byte
;
19558 return - orig_count
+ count
;
19559 return orig_count
- count
;
19565 /***********************************************************************
19567 ***********************************************************************/
19569 /* Display a NUL-terminated string, starting with index START.
19571 If STRING is non-null, display that C string. Otherwise, the Lisp
19572 string LISP_STRING is displayed. There's a case that STRING is
19573 non-null and LISP_STRING is not nil. It means STRING is a string
19574 data of LISP_STRING. In that case, we display LISP_STRING while
19575 ignoring its text properties.
19577 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19578 FACE_STRING. Display STRING or LISP_STRING with the face at
19579 FACE_STRING_POS in FACE_STRING:
19581 Display the string in the environment given by IT, but use the
19582 standard display table, temporarily.
19584 FIELD_WIDTH is the minimum number of output glyphs to produce.
19585 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19586 with spaces. If STRING has more characters, more than FIELD_WIDTH
19587 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19589 PRECISION is the maximum number of characters to output from
19590 STRING. PRECISION < 0 means don't truncate the string.
19592 This is roughly equivalent to printf format specifiers:
19594 FIELD_WIDTH PRECISION PRINTF
19595 ----------------------------------------
19601 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19602 display them, and < 0 means obey the current buffer's value of
19603 enable_multibyte_characters.
19605 Value is the number of columns displayed. */
19608 display_string (string
, lisp_string
, face_string
, face_string_pos
,
19609 start
, it
, field_width
, precision
, max_x
, multibyte
)
19610 unsigned char *string
;
19611 Lisp_Object lisp_string
;
19612 Lisp_Object face_string
;
19613 EMACS_INT face_string_pos
;
19616 int field_width
, precision
, max_x
;
19619 int hpos_at_start
= it
->hpos
;
19620 int saved_face_id
= it
->face_id
;
19621 struct glyph_row
*row
= it
->glyph_row
;
19623 /* Initialize the iterator IT for iteration over STRING beginning
19624 with index START. */
19625 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19626 precision
, field_width
, multibyte
);
19627 if (string
&& STRINGP (lisp_string
))
19628 /* LISP_STRING is the one returned by decode_mode_spec. We should
19629 ignore its text properties. */
19630 it
->stop_charpos
= -1;
19632 /* If displaying STRING, set up the face of the iterator
19633 from LISP_STRING, if that's given. */
19634 if (STRINGP (face_string
))
19640 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19641 0, it
->region_beg_charpos
,
19642 it
->region_end_charpos
,
19643 &endptr
, it
->base_face_id
, 0);
19644 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19645 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
19648 /* Set max_x to the maximum allowed X position. Don't let it go
19649 beyond the right edge of the window. */
19651 max_x
= it
->last_visible_x
;
19653 max_x
= min (max_x
, it
->last_visible_x
);
19655 /* Skip over display elements that are not visible. because IT->w is
19657 if (it
->current_x
< it
->first_visible_x
)
19658 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
19659 MOVE_TO_POS
| MOVE_TO_X
);
19661 row
->ascent
= it
->max_ascent
;
19662 row
->height
= it
->max_ascent
+ it
->max_descent
;
19663 row
->phys_ascent
= it
->max_phys_ascent
;
19664 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19665 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19667 /* This condition is for the case that we are called with current_x
19668 past last_visible_x. */
19669 while (it
->current_x
< max_x
)
19671 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
19673 /* Get the next display element. */
19674 if (!get_next_display_element (it
))
19677 /* Produce glyphs. */
19678 x_before
= it
->current_x
;
19679 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19680 PRODUCE_GLYPHS (it
);
19682 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
19685 while (i
< nglyphs
)
19687 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19689 if (it
->line_wrap
!= TRUNCATE
19690 && x
+ glyph
->pixel_width
> max_x
)
19692 /* End of continued line or max_x reached. */
19693 if (CHAR_GLYPH_PADDING_P (*glyph
))
19695 /* A wide character is unbreakable. */
19696 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19697 it
->current_x
= x_before
;
19701 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19706 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
19708 /* Glyph is at least partially visible. */
19710 if (x
< it
->first_visible_x
)
19711 it
->glyph_row
->x
= x
- it
->first_visible_x
;
19715 /* Glyph is off the left margin of the display area.
19716 Should not happen. */
19720 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19721 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19722 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19723 row
->phys_height
= max (row
->phys_height
,
19724 it
->max_phys_ascent
+ it
->max_phys_descent
);
19725 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19726 it
->max_extra_line_spacing
);
19727 x
+= glyph
->pixel_width
;
19731 /* Stop if max_x reached. */
19735 /* Stop at line ends. */
19736 if (ITERATOR_AT_END_OF_LINE_P (it
))
19738 it
->continuation_lines_width
= 0;
19742 set_iterator_to_next (it
, 1);
19744 /* Stop if truncating at the right edge. */
19745 if (it
->line_wrap
== TRUNCATE
19746 && it
->current_x
>= it
->last_visible_x
)
19748 /* Add truncation mark, but don't do it if the line is
19749 truncated at a padding space. */
19750 if (IT_CHARPOS (*it
) < it
->string_nchars
)
19752 if (!FRAME_WINDOW_P (it
->f
))
19756 if (it
->current_x
> it
->last_visible_x
)
19758 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19759 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19761 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19763 row
->used
[TEXT_AREA
] = i
;
19764 produce_special_glyphs (it
, IT_TRUNCATION
);
19767 produce_special_glyphs (it
, IT_TRUNCATION
);
19769 it
->glyph_row
->truncated_on_right_p
= 1;
19775 /* Maybe insert a truncation at the left. */
19776 if (it
->first_visible_x
19777 && IT_CHARPOS (*it
) > 0)
19779 if (!FRAME_WINDOW_P (it
->f
))
19780 insert_left_trunc_glyphs (it
);
19781 it
->glyph_row
->truncated_on_left_p
= 1;
19784 it
->face_id
= saved_face_id
;
19786 /* Value is number of columns displayed. */
19787 return it
->hpos
- hpos_at_start
;
19792 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
19793 appears as an element of LIST or as the car of an element of LIST.
19794 If PROPVAL is a list, compare each element against LIST in that
19795 way, and return 1/2 if any element of PROPVAL is found in LIST.
19796 Otherwise return 0. This function cannot quit.
19797 The return value is 2 if the text is invisible but with an ellipsis
19798 and 1 if it's invisible and without an ellipsis. */
19801 invisible_p (propval
, list
)
19802 register Lisp_Object propval
;
19805 register Lisp_Object tail
, proptail
;
19807 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19809 register Lisp_Object tem
;
19811 if (EQ (propval
, tem
))
19813 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
19814 return NILP (XCDR (tem
)) ? 1 : 2;
19817 if (CONSP (propval
))
19819 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
19821 Lisp_Object propelt
;
19822 propelt
= XCAR (proptail
);
19823 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19825 register Lisp_Object tem
;
19827 if (EQ (propelt
, tem
))
19829 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
19830 return NILP (XCDR (tem
)) ? 1 : 2;
19838 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
19839 doc
: /* Non-nil if the property makes the text invisible.
19840 POS-OR-PROP can be a marker or number, in which case it is taken to be
19841 a position in the current buffer and the value of the `invisible' property
19842 is checked; or it can be some other value, which is then presumed to be the
19843 value of the `invisible' property of the text of interest.
19844 The non-nil value returned can be t for truly invisible text or something
19845 else if the text is replaced by an ellipsis. */)
19847 Lisp_Object pos_or_prop
;
19850 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
19851 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
19853 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
19854 return (invis
== 0 ? Qnil
19856 : make_number (invis
));
19859 /* Calculate a width or height in pixels from a specification using
19860 the following elements:
19863 NUM - a (fractional) multiple of the default font width/height
19864 (NUM) - specifies exactly NUM pixels
19865 UNIT - a fixed number of pixels, see below.
19866 ELEMENT - size of a display element in pixels, see below.
19867 (NUM . SPEC) - equals NUM * SPEC
19868 (+ SPEC SPEC ...) - add pixel values
19869 (- SPEC SPEC ...) - subtract pixel values
19870 (- SPEC) - negate pixel value
19873 INT or FLOAT - a number constant
19874 SYMBOL - use symbol's (buffer local) variable binding.
19877 in - pixels per inch *)
19878 mm - pixels per 1/1000 meter *)
19879 cm - pixels per 1/100 meter *)
19880 width - width of current font in pixels.
19881 height - height of current font in pixels.
19883 *) using the ratio(s) defined in display-pixels-per-inch.
19887 left-fringe - left fringe width in pixels
19888 right-fringe - right fringe width in pixels
19890 left-margin - left margin width in pixels
19891 right-margin - right margin width in pixels
19893 scroll-bar - scroll-bar area width in pixels
19897 Pixels corresponding to 5 inches:
19900 Total width of non-text areas on left side of window (if scroll-bar is on left):
19901 '(space :width (+ left-fringe left-margin scroll-bar))
19903 Align to first text column (in header line):
19904 '(space :align-to 0)
19906 Align to middle of text area minus half the width of variable `my-image'
19907 containing a loaded image:
19908 '(space :align-to (0.5 . (- text my-image)))
19910 Width of left margin minus width of 1 character in the default font:
19911 '(space :width (- left-margin 1))
19913 Width of left margin minus width of 2 characters in the current font:
19914 '(space :width (- left-margin (2 . width)))
19916 Center 1 character over left-margin (in header line):
19917 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
19919 Different ways to express width of left fringe plus left margin minus one pixel:
19920 '(space :width (- (+ left-fringe left-margin) (1)))
19921 '(space :width (+ left-fringe left-margin (- (1))))
19922 '(space :width (+ left-fringe left-margin (-1)))
19926 #define NUMVAL(X) \
19927 ((INTEGERP (X) || FLOATP (X)) \
19932 calc_pixel_width_or_height (res
, it
, prop
, font
, width_p
, align_to
)
19937 int width_p
, *align_to
;
19941 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
19942 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
19945 return OK_PIXELS (0);
19947 xassert (FRAME_LIVE_P (it
->f
));
19949 if (SYMBOLP (prop
))
19951 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
19953 char *unit
= SDATA (SYMBOL_NAME (prop
));
19955 if (unit
[0] == 'i' && unit
[1] == 'n')
19957 else if (unit
[0] == 'm' && unit
[1] == 'm')
19959 else if (unit
[0] == 'c' && unit
[1] == 'm')
19966 #ifdef HAVE_WINDOW_SYSTEM
19967 if (FRAME_WINDOW_P (it
->f
)
19969 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
19970 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
19972 return OK_PIXELS (ppi
/ pixels
);
19975 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
19976 || (CONSP (Vdisplay_pixels_per_inch
)
19978 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
19979 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
19981 return OK_PIXELS (ppi
/ pixels
);
19987 #ifdef HAVE_WINDOW_SYSTEM
19988 if (EQ (prop
, Qheight
))
19989 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
19990 if (EQ (prop
, Qwidth
))
19991 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
19993 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
19994 return OK_PIXELS (1);
19997 if (EQ (prop
, Qtext
))
19998 return OK_PIXELS (width_p
19999 ? window_box_width (it
->w
, TEXT_AREA
)
20000 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20002 if (align_to
&& *align_to
< 0)
20005 if (EQ (prop
, Qleft
))
20006 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20007 if (EQ (prop
, Qright
))
20008 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20009 if (EQ (prop
, Qcenter
))
20010 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20011 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20012 if (EQ (prop
, Qleft_fringe
))
20013 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20014 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20015 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20016 if (EQ (prop
, Qright_fringe
))
20017 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20018 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20019 : window_box_right_offset (it
->w
, TEXT_AREA
));
20020 if (EQ (prop
, Qleft_margin
))
20021 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20022 if (EQ (prop
, Qright_margin
))
20023 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20024 if (EQ (prop
, Qscroll_bar
))
20025 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20027 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20028 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20029 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20034 if (EQ (prop
, Qleft_fringe
))
20035 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20036 if (EQ (prop
, Qright_fringe
))
20037 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20038 if (EQ (prop
, Qleft_margin
))
20039 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20040 if (EQ (prop
, Qright_margin
))
20041 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20042 if (EQ (prop
, Qscroll_bar
))
20043 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20046 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20049 if (INTEGERP (prop
) || FLOATP (prop
))
20051 int base_unit
= (width_p
20052 ? FRAME_COLUMN_WIDTH (it
->f
)
20053 : FRAME_LINE_HEIGHT (it
->f
));
20054 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20059 Lisp_Object car
= XCAR (prop
);
20060 Lisp_Object cdr
= XCDR (prop
);
20064 #ifdef HAVE_WINDOW_SYSTEM
20065 if (FRAME_WINDOW_P (it
->f
)
20066 && valid_image_p (prop
))
20068 int id
= lookup_image (it
->f
, prop
);
20069 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20071 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20074 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20080 while (CONSP (cdr
))
20082 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20083 font
, width_p
, align_to
))
20086 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20091 if (EQ (car
, Qminus
))
20093 return OK_PIXELS (pixels
);
20096 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20099 if (INTEGERP (car
) || FLOATP (car
))
20102 pixels
= XFLOATINT (car
);
20104 return OK_PIXELS (pixels
);
20105 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20106 font
, width_p
, align_to
))
20107 return OK_PIXELS (pixels
* fact
);
20118 /***********************************************************************
20120 ***********************************************************************/
20122 #ifdef HAVE_WINDOW_SYSTEM
20127 dump_glyph_string (s
)
20128 struct glyph_string
*s
;
20130 fprintf (stderr
, "glyph string\n");
20131 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20132 s
->x
, s
->y
, s
->width
, s
->height
);
20133 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20134 fprintf (stderr
, " hl = %d\n", s
->hl
);
20135 fprintf (stderr
, " left overhang = %d, right = %d\n",
20136 s
->left_overhang
, s
->right_overhang
);
20137 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20138 fprintf (stderr
, " extends to end of line = %d\n",
20139 s
->extends_to_end_of_line_p
);
20140 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20141 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20144 #endif /* GLYPH_DEBUG */
20146 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20147 of XChar2b structures for S; it can't be allocated in
20148 init_glyph_string because it must be allocated via `alloca'. W
20149 is the window on which S is drawn. ROW and AREA are the glyph row
20150 and area within the row from which S is constructed. START is the
20151 index of the first glyph structure covered by S. HL is a
20152 face-override for drawing S. */
20155 #define OPTIONAL_HDC(hdc) hdc,
20156 #define DECLARE_HDC(hdc) HDC hdc;
20157 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20158 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20161 #ifndef OPTIONAL_HDC
20162 #define OPTIONAL_HDC(hdc)
20163 #define DECLARE_HDC(hdc)
20164 #define ALLOCATE_HDC(hdc, f)
20165 #define RELEASE_HDC(hdc, f)
20169 init_glyph_string (s
, OPTIONAL_HDC (hdc
) char2b
, w
, row
, area
, start
, hl
)
20170 struct glyph_string
*s
;
20174 struct glyph_row
*row
;
20175 enum glyph_row_area area
;
20177 enum draw_glyphs_face hl
;
20179 bzero (s
, sizeof *s
);
20181 s
->f
= XFRAME (w
->frame
);
20185 s
->display
= FRAME_X_DISPLAY (s
->f
);
20186 s
->window
= FRAME_X_WINDOW (s
->f
);
20187 s
->char2b
= char2b
;
20191 s
->first_glyph
= row
->glyphs
[area
] + start
;
20192 s
->height
= row
->height
;
20193 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20194 s
->ybase
= s
->y
+ row
->ascent
;
20198 /* Append the list of glyph strings with head H and tail T to the list
20199 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20202 append_glyph_string_lists (head
, tail
, h
, t
)
20203 struct glyph_string
**head
, **tail
;
20204 struct glyph_string
*h
, *t
;
20218 /* Prepend the list of glyph strings with head H and tail T to the
20219 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20223 prepend_glyph_string_lists (head
, tail
, h
, t
)
20224 struct glyph_string
**head
, **tail
;
20225 struct glyph_string
*h
, *t
;
20239 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20240 Set *HEAD and *TAIL to the resulting list. */
20243 append_glyph_string (head
, tail
, s
)
20244 struct glyph_string
**head
, **tail
;
20245 struct glyph_string
*s
;
20247 s
->next
= s
->prev
= NULL
;
20248 append_glyph_string_lists (head
, tail
, s
, s
);
20252 /* Get face and two-byte form of character C in face FACE_ID on frame
20253 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
20254 means we want to display multibyte text. DISPLAY_P non-zero means
20255 make sure that X resources for the face returned are allocated.
20256 Value is a pointer to a realized face that is ready for display if
20257 DISPLAY_P is non-zero. */
20259 static INLINE
struct face
*
20260 get_char_face_and_encoding (f
, c
, face_id
, char2b
, multibyte_p
, display_p
)
20264 int multibyte_p
, display_p
;
20266 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20270 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20272 if (code
!= FONT_INVALID_CODE
)
20273 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20275 STORE_XCHAR2B (char2b
, 0, 0);
20278 /* Make sure X resources of the face are allocated. */
20279 #ifdef HAVE_X_WINDOWS
20283 xassert (face
!= NULL
);
20284 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20291 /* Get face and two-byte form of character glyph GLYPH on frame F.
20292 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20293 a pointer to a realized face that is ready for display. */
20295 static INLINE
struct face
*
20296 get_glyph_face_and_encoding (f
, glyph
, char2b
, two_byte_p
)
20298 struct glyph
*glyph
;
20304 xassert (glyph
->type
== CHAR_GLYPH
);
20305 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20312 unsigned code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20314 if (code
!= FONT_INVALID_CODE
)
20315 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20317 STORE_XCHAR2B (char2b
, 0, 0);
20320 /* Make sure X resources of the face are allocated. */
20321 xassert (face
!= NULL
);
20322 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20327 /* Fill glyph string S with composition components specified by S->cmp.
20329 BASE_FACE is the base face of the composition.
20330 S->cmp_from is the index of the first component for S.
20332 OVERLAPS non-zero means S should draw the foreground only, and use
20333 its physical height for clipping. See also draw_glyphs.
20335 Value is the index of a component not in S. */
20338 fill_composite_glyph_string (s
, base_face
, overlaps
)
20339 struct glyph_string
*s
;
20340 struct face
*base_face
;
20344 /* For all glyphs of this composition, starting at the offset
20345 S->cmp_from, until we reach the end of the definition or encounter a
20346 glyph that requires the different face, add it to S. */
20351 s
->for_overlaps
= overlaps
;
20354 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20356 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20360 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20363 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20364 s
->char2b
+ i
, 1, 1);
20370 s
->font
= s
->face
->font
;
20372 else if (s
->face
!= face
)
20380 /* All glyph strings for the same composition has the same width,
20381 i.e. the width set for the first component of the composition. */
20382 s
->width
= s
->first_glyph
->pixel_width
;
20384 /* If the specified font could not be loaded, use the frame's
20385 default font, but record the fact that we couldn't load it in
20386 the glyph string so that we can draw rectangles for the
20387 characters of the glyph string. */
20388 if (s
->font
== NULL
)
20390 s
->font_not_found_p
= 1;
20391 s
->font
= FRAME_FONT (s
->f
);
20394 /* Adjust base line for subscript/superscript text. */
20395 s
->ybase
+= s
->first_glyph
->voffset
;
20397 /* This glyph string must always be drawn with 16-bit functions. */
20404 fill_gstring_glyph_string (s
, face_id
, start
, end
, overlaps
)
20405 struct glyph_string
*s
;
20407 int start
, end
, overlaps
;
20409 struct glyph
*glyph
, *last
;
20410 Lisp_Object lgstring
;
20413 s
->for_overlaps
= overlaps
;
20414 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20415 last
= s
->row
->glyphs
[s
->area
] + end
;
20416 s
->cmp_id
= glyph
->u
.cmp
.id
;
20417 s
->cmp_from
= glyph
->u
.cmp
.from
;
20418 s
->cmp_to
= glyph
->u
.cmp
.to
+ 1;
20419 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20420 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20421 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20423 while (glyph
< last
20424 && glyph
->u
.cmp
.automatic
20425 && glyph
->u
.cmp
.id
== s
->cmp_id
20426 && s
->cmp_to
== glyph
->u
.cmp
.from
)
20427 s
->cmp_to
= (glyph
++)->u
.cmp
.to
+ 1;
20429 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20431 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20432 unsigned code
= LGLYPH_CODE (lglyph
);
20434 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20436 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20437 return glyph
- s
->row
->glyphs
[s
->area
];
20441 /* Fill glyph string S from a sequence of character glyphs.
20443 FACE_ID is the face id of the string. START is the index of the
20444 first glyph to consider, END is the index of the last + 1.
20445 OVERLAPS non-zero means S should draw the foreground only, and use
20446 its physical height for clipping. See also draw_glyphs.
20448 Value is the index of the first glyph not in S. */
20451 fill_glyph_string (s
, face_id
, start
, end
, overlaps
)
20452 struct glyph_string
*s
;
20454 int start
, end
, overlaps
;
20456 struct glyph
*glyph
, *last
;
20458 int glyph_not_available_p
;
20460 xassert (s
->f
== XFRAME (s
->w
->frame
));
20461 xassert (s
->nchars
== 0);
20462 xassert (start
>= 0 && end
> start
);
20464 s
->for_overlaps
= overlaps
;
20465 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20466 last
= s
->row
->glyphs
[s
->area
] + end
;
20467 voffset
= glyph
->voffset
;
20468 s
->padding_p
= glyph
->padding_p
;
20469 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20471 while (glyph
< last
20472 && glyph
->type
== CHAR_GLYPH
20473 && glyph
->voffset
== voffset
20474 /* Same face id implies same font, nowadays. */
20475 && glyph
->face_id
== face_id
20476 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20480 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20481 s
->char2b
+ s
->nchars
,
20483 s
->two_byte_p
= two_byte_p
;
20485 xassert (s
->nchars
<= end
- start
);
20486 s
->width
+= glyph
->pixel_width
;
20487 if (glyph
++->padding_p
!= s
->padding_p
)
20491 s
->font
= s
->face
->font
;
20493 /* If the specified font could not be loaded, use the frame's font,
20494 but record the fact that we couldn't load it in
20495 S->font_not_found_p so that we can draw rectangles for the
20496 characters of the glyph string. */
20497 if (s
->font
== NULL
|| glyph_not_available_p
)
20499 s
->font_not_found_p
= 1;
20500 s
->font
= FRAME_FONT (s
->f
);
20503 /* Adjust base line for subscript/superscript text. */
20504 s
->ybase
+= voffset
;
20506 xassert (s
->face
&& s
->face
->gc
);
20507 return glyph
- s
->row
->glyphs
[s
->area
];
20511 /* Fill glyph string S from image glyph S->first_glyph. */
20514 fill_image_glyph_string (s
)
20515 struct glyph_string
*s
;
20517 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20518 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20520 s
->slice
= s
->first_glyph
->slice
;
20521 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20522 s
->font
= s
->face
->font
;
20523 s
->width
= s
->first_glyph
->pixel_width
;
20525 /* Adjust base line for subscript/superscript text. */
20526 s
->ybase
+= s
->first_glyph
->voffset
;
20530 /* Fill glyph string S from a sequence of stretch glyphs.
20532 ROW is the glyph row in which the glyphs are found, AREA is the
20533 area within the row. START is the index of the first glyph to
20534 consider, END is the index of the last + 1.
20536 Value is the index of the first glyph not in S. */
20539 fill_stretch_glyph_string (s
, row
, area
, start
, end
)
20540 struct glyph_string
*s
;
20541 struct glyph_row
*row
;
20542 enum glyph_row_area area
;
20545 struct glyph
*glyph
, *last
;
20546 int voffset
, face_id
;
20548 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20550 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20551 last
= s
->row
->glyphs
[s
->area
] + end
;
20552 face_id
= glyph
->face_id
;
20553 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20554 s
->font
= s
->face
->font
;
20555 s
->width
= glyph
->pixel_width
;
20557 voffset
= glyph
->voffset
;
20561 && glyph
->type
== STRETCH_GLYPH
20562 && glyph
->voffset
== voffset
20563 && glyph
->face_id
== face_id
);
20565 s
->width
+= glyph
->pixel_width
;
20567 /* Adjust base line for subscript/superscript text. */
20568 s
->ybase
+= voffset
;
20570 /* The case that face->gc == 0 is handled when drawing the glyph
20571 string by calling PREPARE_FACE_FOR_DISPLAY. */
20573 return glyph
- s
->row
->glyphs
[s
->area
];
20576 static struct font_metrics
*
20577 get_per_char_metric (f
, font
, char2b
)
20582 static struct font_metrics metrics
;
20583 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20585 if (! font
|| code
== FONT_INVALID_CODE
)
20587 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20592 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20593 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20594 assumed to be zero. */
20597 x_get_glyph_overhangs (glyph
, f
, left
, right
)
20598 struct glyph
*glyph
;
20602 *left
= *right
= 0;
20604 if (glyph
->type
== CHAR_GLYPH
)
20608 struct font_metrics
*pcm
;
20610 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20611 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
20613 if (pcm
->rbearing
> pcm
->width
)
20614 *right
= pcm
->rbearing
- pcm
->width
;
20615 if (pcm
->lbearing
< 0)
20616 *left
= -pcm
->lbearing
;
20619 else if (glyph
->type
== COMPOSITE_GLYPH
)
20621 if (! glyph
->u
.cmp
.automatic
)
20623 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20625 if (cmp
->rbearing
> cmp
->pixel_width
)
20626 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20627 if (cmp
->lbearing
< 0)
20628 *left
= - cmp
->lbearing
;
20632 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
20633 struct font_metrics metrics
;
20635 composition_gstring_width (gstring
, glyph
->u
.cmp
.from
,
20636 glyph
->u
.cmp
.to
+ 1, &metrics
);
20637 if (metrics
.rbearing
> metrics
.width
)
20638 *right
= metrics
.rbearing
- metrics
.width
;
20639 if (metrics
.lbearing
< 0)
20640 *left
= - metrics
.lbearing
;
20646 /* Return the index of the first glyph preceding glyph string S that
20647 is overwritten by S because of S's left overhang. Value is -1
20648 if no glyphs are overwritten. */
20651 left_overwritten (s
)
20652 struct glyph_string
*s
;
20656 if (s
->left_overhang
)
20659 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20660 int first
= s
->first_glyph
- glyphs
;
20662 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
20663 x
-= glyphs
[i
].pixel_width
;
20674 /* Return the index of the first glyph preceding glyph string S that
20675 is overwriting S because of its right overhang. Value is -1 if no
20676 glyph in front of S overwrites S. */
20679 left_overwriting (s
)
20680 struct glyph_string
*s
;
20683 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20684 int first
= s
->first_glyph
- glyphs
;
20688 for (i
= first
- 1; i
>= 0; --i
)
20691 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20694 x
-= glyphs
[i
].pixel_width
;
20701 /* Return the index of the last glyph following glyph string S that is
20702 overwritten by S because of S's right overhang. Value is -1 if
20703 no such glyph is found. */
20706 right_overwritten (s
)
20707 struct glyph_string
*s
;
20711 if (s
->right_overhang
)
20714 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20715 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20716 int end
= s
->row
->used
[s
->area
];
20718 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
20719 x
+= glyphs
[i
].pixel_width
;
20728 /* Return the index of the last glyph following glyph string S that
20729 overwrites S because of its left overhang. Value is negative
20730 if no such glyph is found. */
20733 right_overwriting (s
)
20734 struct glyph_string
*s
;
20737 int end
= s
->row
->used
[s
->area
];
20738 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20739 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20743 for (i
= first
; i
< end
; ++i
)
20746 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20749 x
+= glyphs
[i
].pixel_width
;
20756 /* Set background width of glyph string S. START is the index of the
20757 first glyph following S. LAST_X is the right-most x-position + 1
20758 in the drawing area. */
20761 set_glyph_string_background_width (s
, start
, last_x
)
20762 struct glyph_string
*s
;
20766 /* If the face of this glyph string has to be drawn to the end of
20767 the drawing area, set S->extends_to_end_of_line_p. */
20769 if (start
== s
->row
->used
[s
->area
]
20770 && s
->area
== TEXT_AREA
20771 && ((s
->row
->fill_line_p
20772 && (s
->hl
== DRAW_NORMAL_TEXT
20773 || s
->hl
== DRAW_IMAGE_RAISED
20774 || s
->hl
== DRAW_IMAGE_SUNKEN
))
20775 || s
->hl
== DRAW_MOUSE_FACE
))
20776 s
->extends_to_end_of_line_p
= 1;
20778 /* If S extends its face to the end of the line, set its
20779 background_width to the distance to the right edge of the drawing
20781 if (s
->extends_to_end_of_line_p
)
20782 s
->background_width
= last_x
- s
->x
+ 1;
20784 s
->background_width
= s
->width
;
20788 /* Compute overhangs and x-positions for glyph string S and its
20789 predecessors, or successors. X is the starting x-position for S.
20790 BACKWARD_P non-zero means process predecessors. */
20793 compute_overhangs_and_x (s
, x
, backward_p
)
20794 struct glyph_string
*s
;
20802 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20803 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20813 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20814 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20824 /* The following macros are only called from draw_glyphs below.
20825 They reference the following parameters of that function directly:
20826 `w', `row', `area', and `overlap_p'
20827 as well as the following local variables:
20828 `s', `f', and `hdc' (in W32) */
20831 /* On W32, silently add local `hdc' variable to argument list of
20832 init_glyph_string. */
20833 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20834 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
20836 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20837 init_glyph_string (s, char2b, w, row, area, start, hl)
20840 /* Add a glyph string for a stretch glyph to the list of strings
20841 between HEAD and TAIL. START is the index of the stretch glyph in
20842 row area AREA of glyph row ROW. END is the index of the last glyph
20843 in that glyph row area. X is the current output position assigned
20844 to the new glyph string constructed. HL overrides that face of the
20845 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20846 is the right-most x-position of the drawing area. */
20848 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
20849 and below -- keep them on one line. */
20850 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20853 s = (struct glyph_string *) alloca (sizeof *s); \
20854 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
20855 START = fill_stretch_glyph_string (s, row, area, START, END); \
20856 append_glyph_string (&HEAD, &TAIL, s); \
20862 /* Add a glyph string for an image glyph to the list of strings
20863 between HEAD and TAIL. START is the index of the image glyph in
20864 row area AREA of glyph row ROW. END is the index of the last glyph
20865 in that glyph row area. X is the current output position assigned
20866 to the new glyph string constructed. HL overrides that face of the
20867 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20868 is the right-most x-position of the drawing area. */
20870 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20873 s = (struct glyph_string *) alloca (sizeof *s); \
20874 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
20875 fill_image_glyph_string (s); \
20876 append_glyph_string (&HEAD, &TAIL, s); \
20883 /* Add a glyph string for a sequence of character glyphs to the list
20884 of strings between HEAD and TAIL. START is the index of the first
20885 glyph in row area AREA of glyph row ROW that is part of the new
20886 glyph string. END is the index of the last glyph in that glyph row
20887 area. X is the current output position assigned to the new glyph
20888 string constructed. HL overrides that face of the glyph; e.g. it
20889 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
20890 right-most x-position of the drawing area. */
20892 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
20898 face_id = (row)->glyphs[area][START].face_id; \
20900 s = (struct glyph_string *) alloca (sizeof *s); \
20901 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
20902 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20903 append_glyph_string (&HEAD, &TAIL, s); \
20905 START = fill_glyph_string (s, face_id, START, END, overlaps); \
20910 /* Add a glyph string for a composite sequence to the list of strings
20911 between HEAD and TAIL. START is the index of the first glyph in
20912 row area AREA of glyph row ROW that is part of the new glyph
20913 string. END is the index of the last glyph in that glyph row area.
20914 X is the current output position assigned to the new glyph string
20915 constructed. HL overrides that face of the glyph; e.g. it is
20916 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
20917 x-position of the drawing area. */
20919 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20921 int face_id = (row)->glyphs[area][START].face_id; \
20922 struct face *base_face = FACE_FROM_ID (f, face_id); \
20923 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
20924 struct composition *cmp = composition_table[cmp_id]; \
20926 struct glyph_string *first_s; \
20929 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
20931 /* Make glyph_strings for each glyph sequence that is drawable by \
20932 the same face, and append them to HEAD/TAIL. */ \
20933 for (n = 0; n < cmp->glyph_len;) \
20935 s = (struct glyph_string *) alloca (sizeof *s); \
20936 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20937 append_glyph_string (&(HEAD), &(TAIL), s); \
20943 n = fill_composite_glyph_string (s, base_face, overlaps); \
20951 /* Add a glyph string for a glyph-string sequence to the list of strings
20952 between HEAD and TAIL. */
20954 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20958 Lisp_Object gstring; \
20960 face_id = (row)->glyphs[area][START].face_id; \
20961 gstring = (composition_gstring_from_id \
20962 ((row)->glyphs[area][START].u.cmp.id)); \
20963 s = (struct glyph_string *) alloca (sizeof *s); \
20964 char2b = (XChar2b *) alloca ((sizeof *char2b) \
20965 * LGSTRING_GLYPH_LEN (gstring)); \
20966 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20967 append_glyph_string (&(HEAD), &(TAIL), s); \
20969 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
20973 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
20974 of AREA of glyph row ROW on window W between indices START and END.
20975 HL overrides the face for drawing glyph strings, e.g. it is
20976 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
20977 x-positions of the drawing area.
20979 This is an ugly monster macro construct because we must use alloca
20980 to allocate glyph strings (because draw_glyphs can be called
20981 asynchronously). */
20983 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
20986 HEAD = TAIL = NULL; \
20987 while (START < END) \
20989 struct glyph *first_glyph = (row)->glyphs[area] + START; \
20990 switch (first_glyph->type) \
20993 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
20997 case COMPOSITE_GLYPH: \
20998 if (first_glyph->u.cmp.automatic) \
20999 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21002 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21006 case STRETCH_GLYPH: \
21007 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21011 case IMAGE_GLYPH: \
21012 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21022 set_glyph_string_background_width (s, START, LAST_X); \
21029 /* Draw glyphs between START and END in AREA of ROW on window W,
21030 starting at x-position X. X is relative to AREA in W. HL is a
21031 face-override with the following meaning:
21033 DRAW_NORMAL_TEXT draw normally
21034 DRAW_CURSOR draw in cursor face
21035 DRAW_MOUSE_FACE draw in mouse face.
21036 DRAW_INVERSE_VIDEO draw in mode line face
21037 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21038 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21040 If OVERLAPS is non-zero, draw only the foreground of characters and
21041 clip to the physical height of ROW. Non-zero value also defines
21042 the overlapping part to be drawn:
21044 OVERLAPS_PRED overlap with preceding rows
21045 OVERLAPS_SUCC overlap with succeeding rows
21046 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21047 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21049 Value is the x-position reached, relative to AREA of W. */
21052 draw_glyphs (w
, x
, row
, area
, start
, end
, hl
, overlaps
)
21055 struct glyph_row
*row
;
21056 enum glyph_row_area area
;
21057 EMACS_INT start
, end
;
21058 enum draw_glyphs_face hl
;
21061 struct glyph_string
*head
, *tail
;
21062 struct glyph_string
*s
;
21063 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21064 int i
, j
, x_reached
, last_x
, area_left
= 0;
21065 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21068 ALLOCATE_HDC (hdc
, f
);
21070 /* Let's rather be paranoid than getting a SEGV. */
21071 end
= min (end
, row
->used
[area
]);
21072 start
= max (0, start
);
21073 start
= min (end
, start
);
21075 /* Translate X to frame coordinates. Set last_x to the right
21076 end of the drawing area. */
21077 if (row
->full_width_p
)
21079 /* X is relative to the left edge of W, without scroll bars
21081 area_left
= WINDOW_LEFT_EDGE_X (w
);
21082 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21086 area_left
= window_box_left (w
, area
);
21087 last_x
= area_left
+ window_box_width (w
, area
);
21091 /* Build a doubly-linked list of glyph_string structures between
21092 head and tail from what we have to draw. Note that the macro
21093 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21094 the reason we use a separate variable `i'. */
21096 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21098 x_reached
= tail
->x
+ tail
->background_width
;
21102 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21103 the row, redraw some glyphs in front or following the glyph
21104 strings built above. */
21105 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21107 struct glyph_string
*h
, *t
;
21108 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
21109 int mouse_beg_col
, mouse_end_col
, check_mouse_face
= 0;
21112 /* If mouse highlighting is on, we may need to draw adjacent
21113 glyphs using mouse-face highlighting. */
21114 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21116 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21118 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
21119 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
21121 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21123 check_mouse_face
= 1;
21124 mouse_beg_col
= (row
== mouse_beg_row
)
21125 ? dpyinfo
->mouse_face_beg_col
: 0;
21126 mouse_end_col
= (row
== mouse_end_row
)
21127 ? dpyinfo
->mouse_face_end_col
21128 : row
->used
[TEXT_AREA
];
21132 /* Compute overhangs for all glyph strings. */
21133 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21134 for (s
= head
; s
; s
= s
->next
)
21135 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21137 /* Prepend glyph strings for glyphs in front of the first glyph
21138 string that are overwritten because of the first glyph
21139 string's left overhang. The background of all strings
21140 prepended must be drawn because the first glyph string
21142 i
= left_overwritten (head
);
21145 enum draw_glyphs_face overlap_hl
;
21147 /* If this row contains mouse highlighting, attempt to draw
21148 the overlapped glyphs with the correct highlight. This
21149 code fails if the overlap encompasses more than one glyph
21150 and mouse-highlight spans only some of these glyphs.
21151 However, making it work perfectly involves a lot more
21152 code, and I don't know if the pathological case occurs in
21153 practice, so we'll stick to this for now. --- cyd */
21154 if (check_mouse_face
21155 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21156 overlap_hl
= DRAW_MOUSE_FACE
;
21158 overlap_hl
= DRAW_NORMAL_TEXT
;
21161 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21162 overlap_hl
, dummy_x
, last_x
);
21164 compute_overhangs_and_x (t
, head
->x
, 1);
21165 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21169 /* Prepend glyph strings for glyphs in front of the first glyph
21170 string that overwrite that glyph string because of their
21171 right overhang. For these strings, only the foreground must
21172 be drawn, because it draws over the glyph string at `head'.
21173 The background must not be drawn because this would overwrite
21174 right overhangs of preceding glyphs for which no glyph
21176 i
= left_overwriting (head
);
21179 enum draw_glyphs_face overlap_hl
;
21181 if (check_mouse_face
21182 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21183 overlap_hl
= DRAW_MOUSE_FACE
;
21185 overlap_hl
= DRAW_NORMAL_TEXT
;
21188 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21189 overlap_hl
, dummy_x
, last_x
);
21190 for (s
= h
; s
; s
= s
->next
)
21191 s
->background_filled_p
= 1;
21192 compute_overhangs_and_x (t
, head
->x
, 1);
21193 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21196 /* Append glyphs strings for glyphs following the last glyph
21197 string tail that are overwritten by tail. The background of
21198 these strings has to be drawn because tail's foreground draws
21200 i
= right_overwritten (tail
);
21203 enum draw_glyphs_face overlap_hl
;
21205 if (check_mouse_face
21206 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21207 overlap_hl
= DRAW_MOUSE_FACE
;
21209 overlap_hl
= DRAW_NORMAL_TEXT
;
21211 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21212 overlap_hl
, x
, last_x
);
21213 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21214 we don't have `end = i;' here. */
21215 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21216 append_glyph_string_lists (&head
, &tail
, h
, t
);
21220 /* Append glyph strings for glyphs following the last glyph
21221 string tail that overwrite tail. The foreground of such
21222 glyphs has to be drawn because it writes into the background
21223 of tail. The background must not be drawn because it could
21224 paint over the foreground of following glyphs. */
21225 i
= right_overwriting (tail
);
21228 enum draw_glyphs_face overlap_hl
;
21229 if (check_mouse_face
21230 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21231 overlap_hl
= DRAW_MOUSE_FACE
;
21233 overlap_hl
= DRAW_NORMAL_TEXT
;
21236 i
++; /* We must include the Ith glyph. */
21237 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21238 overlap_hl
, x
, last_x
);
21239 for (s
= h
; s
; s
= s
->next
)
21240 s
->background_filled_p
= 1;
21241 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21242 append_glyph_string_lists (&head
, &tail
, h
, t
);
21244 if (clip_head
|| clip_tail
)
21245 for (s
= head
; s
; s
= s
->next
)
21247 s
->clip_head
= clip_head
;
21248 s
->clip_tail
= clip_tail
;
21252 /* Draw all strings. */
21253 for (s
= head
; s
; s
= s
->next
)
21254 FRAME_RIF (f
)->draw_glyph_string (s
);
21257 /* When focus a sole frame and move horizontally, this sets on_p to 0
21258 causing a failure to erase prev cursor position. */
21259 if (area
== TEXT_AREA
21260 && !row
->full_width_p
21261 /* When drawing overlapping rows, only the glyph strings'
21262 foreground is drawn, which doesn't erase a cursor
21266 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21267 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21268 : (tail
? tail
->x
+ tail
->background_width
: x
));
21272 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21273 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21277 /* Value is the x-position up to which drawn, relative to AREA of W.
21278 This doesn't include parts drawn because of overhangs. */
21279 if (row
->full_width_p
)
21280 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21282 x_reached
-= area_left
;
21284 RELEASE_HDC (hdc
, f
);
21289 /* Expand row matrix if too narrow. Don't expand if area
21292 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21294 if (!fonts_changed_p \
21295 && (it->glyph_row->glyphs[area] \
21296 < it->glyph_row->glyphs[area + 1])) \
21298 it->w->ncols_scale_factor++; \
21299 fonts_changed_p = 1; \
21303 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21304 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21310 struct glyph
*glyph
;
21311 enum glyph_row_area area
= it
->area
;
21313 xassert (it
->glyph_row
);
21314 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21316 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21317 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21319 /* If the glyph row is reversed, we need to prepend the glyph
21320 rather than append it. */
21321 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21325 /* Make room for the additional glyph. */
21326 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21328 glyph
= it
->glyph_row
->glyphs
[area
];
21330 glyph
->charpos
= CHARPOS (it
->position
);
21331 glyph
->object
= it
->object
;
21332 if (it
->pixel_width
> 0)
21334 glyph
->pixel_width
= it
->pixel_width
;
21335 glyph
->padding_p
= 0;
21339 /* Assure at least 1-pixel width. Otherwise, cursor can't
21340 be displayed correctly. */
21341 glyph
->pixel_width
= 1;
21342 glyph
->padding_p
= 1;
21344 glyph
->ascent
= it
->ascent
;
21345 glyph
->descent
= it
->descent
;
21346 glyph
->voffset
= it
->voffset
;
21347 glyph
->type
= CHAR_GLYPH
;
21348 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21349 glyph
->multibyte_p
= it
->multibyte_p
;
21350 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21351 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21352 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21353 || it
->phys_descent
> it
->descent
);
21354 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21355 glyph
->face_id
= it
->face_id
;
21356 glyph
->u
.ch
= it
->char_to_display
;
21357 glyph
->slice
= null_glyph_slice
;
21358 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21361 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21362 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21364 glyph
->bidi_type
= it
->bidi_it
.type
;
21368 glyph
->resolved_level
= 0;
21369 glyph
->bidi_type
= UNKNOWN_BT
;
21371 ++it
->glyph_row
->used
[area
];
21374 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21377 /* Store one glyph for the composition IT->cmp_it.id in
21378 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21382 append_composite_glyph (it
)
21385 struct glyph
*glyph
;
21386 enum glyph_row_area area
= it
->area
;
21388 xassert (it
->glyph_row
);
21390 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21391 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21393 glyph
->charpos
= CHARPOS (it
->position
);
21394 glyph
->object
= it
->object
;
21395 glyph
->pixel_width
= it
->pixel_width
;
21396 glyph
->ascent
= it
->ascent
;
21397 glyph
->descent
= it
->descent
;
21398 glyph
->voffset
= it
->voffset
;
21399 glyph
->type
= COMPOSITE_GLYPH
;
21400 if (it
->cmp_it
.ch
< 0)
21402 glyph
->u
.cmp
.automatic
= 0;
21403 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21407 glyph
->u
.cmp
.automatic
= 1;
21408 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21409 glyph
->u
.cmp
.from
= it
->cmp_it
.from
;
21410 glyph
->u
.cmp
.to
= it
->cmp_it
.to
- 1;
21412 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21413 glyph
->multibyte_p
= it
->multibyte_p
;
21414 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21415 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21416 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21417 || it
->phys_descent
> it
->descent
);
21418 glyph
->padding_p
= 0;
21419 glyph
->glyph_not_available_p
= 0;
21420 glyph
->face_id
= it
->face_id
;
21421 glyph
->slice
= null_glyph_slice
;
21422 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21425 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21426 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21428 glyph
->bidi_type
= it
->bidi_it
.type
;
21430 ++it
->glyph_row
->used
[area
];
21433 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21437 /* Change IT->ascent and IT->height according to the setting of
21441 take_vertical_position_into_account (it
)
21446 if (it
->voffset
< 0)
21447 /* Increase the ascent so that we can display the text higher
21449 it
->ascent
-= it
->voffset
;
21451 /* Increase the descent so that we can display the text lower
21453 it
->descent
+= it
->voffset
;
21458 /* Produce glyphs/get display metrics for the image IT is loaded with.
21459 See the description of struct display_iterator in dispextern.h for
21460 an overview of struct display_iterator. */
21463 produce_image_glyph (it
)
21468 int glyph_ascent
, crop
;
21469 struct glyph_slice slice
;
21471 xassert (it
->what
== IT_IMAGE
);
21473 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21475 /* Make sure X resources of the face is loaded. */
21476 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21478 if (it
->image_id
< 0)
21480 /* Fringe bitmap. */
21481 it
->ascent
= it
->phys_ascent
= 0;
21482 it
->descent
= it
->phys_descent
= 0;
21483 it
->pixel_width
= 0;
21488 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21490 /* Make sure X resources of the image is loaded. */
21491 prepare_image_for_display (it
->f
, img
);
21493 slice
.x
= slice
.y
= 0;
21494 slice
.width
= img
->width
;
21495 slice
.height
= img
->height
;
21497 if (INTEGERP (it
->slice
.x
))
21498 slice
.x
= XINT (it
->slice
.x
);
21499 else if (FLOATP (it
->slice
.x
))
21500 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21502 if (INTEGERP (it
->slice
.y
))
21503 slice
.y
= XINT (it
->slice
.y
);
21504 else if (FLOATP (it
->slice
.y
))
21505 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21507 if (INTEGERP (it
->slice
.width
))
21508 slice
.width
= XINT (it
->slice
.width
);
21509 else if (FLOATP (it
->slice
.width
))
21510 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21512 if (INTEGERP (it
->slice
.height
))
21513 slice
.height
= XINT (it
->slice
.height
);
21514 else if (FLOATP (it
->slice
.height
))
21515 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21517 if (slice
.x
>= img
->width
)
21518 slice
.x
= img
->width
;
21519 if (slice
.y
>= img
->height
)
21520 slice
.y
= img
->height
;
21521 if (slice
.x
+ slice
.width
>= img
->width
)
21522 slice
.width
= img
->width
- slice
.x
;
21523 if (slice
.y
+ slice
.height
> img
->height
)
21524 slice
.height
= img
->height
- slice
.y
;
21526 if (slice
.width
== 0 || slice
.height
== 0)
21529 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21531 it
->descent
= slice
.height
- glyph_ascent
;
21533 it
->descent
+= img
->vmargin
;
21534 if (slice
.y
+ slice
.height
== img
->height
)
21535 it
->descent
+= img
->vmargin
;
21536 it
->phys_descent
= it
->descent
;
21538 it
->pixel_width
= slice
.width
;
21540 it
->pixel_width
+= img
->hmargin
;
21541 if (slice
.x
+ slice
.width
== img
->width
)
21542 it
->pixel_width
+= img
->hmargin
;
21544 /* It's quite possible for images to have an ascent greater than
21545 their height, so don't get confused in that case. */
21546 if (it
->descent
< 0)
21551 if (face
->box
!= FACE_NO_BOX
)
21553 if (face
->box_line_width
> 0)
21556 it
->ascent
+= face
->box_line_width
;
21557 if (slice
.y
+ slice
.height
== img
->height
)
21558 it
->descent
+= face
->box_line_width
;
21561 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21562 it
->pixel_width
+= eabs (face
->box_line_width
);
21563 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21564 it
->pixel_width
+= eabs (face
->box_line_width
);
21567 take_vertical_position_into_account (it
);
21569 /* Automatically crop wide image glyphs at right edge so we can
21570 draw the cursor on same display row. */
21571 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21572 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21574 it
->pixel_width
-= crop
;
21575 slice
.width
-= crop
;
21580 struct glyph
*glyph
;
21581 enum glyph_row_area area
= it
->area
;
21583 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21584 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21586 glyph
->charpos
= CHARPOS (it
->position
);
21587 glyph
->object
= it
->object
;
21588 glyph
->pixel_width
= it
->pixel_width
;
21589 glyph
->ascent
= glyph_ascent
;
21590 glyph
->descent
= it
->descent
;
21591 glyph
->voffset
= it
->voffset
;
21592 glyph
->type
= IMAGE_GLYPH
;
21593 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21594 glyph
->multibyte_p
= it
->multibyte_p
;
21595 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21596 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21597 glyph
->overlaps_vertically_p
= 0;
21598 glyph
->padding_p
= 0;
21599 glyph
->glyph_not_available_p
= 0;
21600 glyph
->face_id
= it
->face_id
;
21601 glyph
->u
.img_id
= img
->id
;
21602 glyph
->slice
= slice
;
21603 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21606 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21607 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21609 glyph
->bidi_type
= it
->bidi_it
.type
;
21611 ++it
->glyph_row
->used
[area
];
21614 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21619 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
21620 of the glyph, WIDTH and HEIGHT are the width and height of the
21621 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
21624 append_stretch_glyph (it
, object
, width
, height
, ascent
)
21626 Lisp_Object object
;
21630 struct glyph
*glyph
;
21631 enum glyph_row_area area
= it
->area
;
21633 xassert (ascent
>= 0 && ascent
<= height
);
21635 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21636 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21638 glyph
->charpos
= CHARPOS (it
->position
);
21639 glyph
->object
= object
;
21640 glyph
->pixel_width
= width
;
21641 glyph
->ascent
= ascent
;
21642 glyph
->descent
= height
- ascent
;
21643 glyph
->voffset
= it
->voffset
;
21644 glyph
->type
= STRETCH_GLYPH
;
21645 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21646 glyph
->multibyte_p
= it
->multibyte_p
;
21647 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21648 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21649 glyph
->overlaps_vertically_p
= 0;
21650 glyph
->padding_p
= 0;
21651 glyph
->glyph_not_available_p
= 0;
21652 glyph
->face_id
= it
->face_id
;
21653 glyph
->u
.stretch
.ascent
= ascent
;
21654 glyph
->u
.stretch
.height
= height
;
21655 glyph
->slice
= null_glyph_slice
;
21656 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21659 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21660 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21662 glyph
->bidi_type
= it
->bidi_it
.type
;
21664 ++it
->glyph_row
->used
[area
];
21667 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21671 /* Produce a stretch glyph for iterator IT. IT->object is the value
21672 of the glyph property displayed. The value must be a list
21673 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
21676 1. `:width WIDTH' specifies that the space should be WIDTH *
21677 canonical char width wide. WIDTH may be an integer or floating
21680 2. `:relative-width FACTOR' specifies that the width of the stretch
21681 should be computed from the width of the first character having the
21682 `glyph' property, and should be FACTOR times that width.
21684 3. `:align-to HPOS' specifies that the space should be wide enough
21685 to reach HPOS, a value in canonical character units.
21687 Exactly one of the above pairs must be present.
21689 4. `:height HEIGHT' specifies that the height of the stretch produced
21690 should be HEIGHT, measured in canonical character units.
21692 5. `:relative-height FACTOR' specifies that the height of the
21693 stretch should be FACTOR times the height of the characters having
21694 the glyph property.
21696 Either none or exactly one of 4 or 5 must be present.
21698 6. `:ascent ASCENT' specifies that ASCENT percent of the height
21699 of the stretch should be used for the ascent of the stretch.
21700 ASCENT must be in the range 0 <= ASCENT <= 100. */
21703 produce_stretch_glyph (it
)
21706 /* (space :width WIDTH :height HEIGHT ...) */
21707 Lisp_Object prop
, plist
;
21708 int width
= 0, height
= 0, align_to
= -1;
21709 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
21712 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21713 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
21715 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21717 /* List should start with `space'. */
21718 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
21719 plist
= XCDR (it
->object
);
21721 /* Compute the width of the stretch. */
21722 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
21723 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
21725 /* Absolute width `:width WIDTH' specified and valid. */
21726 zero_width_ok_p
= 1;
21729 else if (prop
= Fplist_get (plist
, QCrelative_width
),
21732 /* Relative width `:relative-width FACTOR' specified and valid.
21733 Compute the width of the characters having the `glyph'
21736 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
21739 if (it
->multibyte_p
)
21741 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
21742 - IT_BYTEPOS (*it
));
21743 it2
.c
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
21746 it2
.c
= *p
, it2
.len
= 1;
21748 it2
.glyph_row
= NULL
;
21749 it2
.what
= IT_CHARACTER
;
21750 x_produce_glyphs (&it2
);
21751 width
= NUMVAL (prop
) * it2
.pixel_width
;
21753 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
21754 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
21756 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
21757 align_to
= (align_to
< 0
21759 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
21760 else if (align_to
< 0)
21761 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
21762 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
21763 zero_width_ok_p
= 1;
21766 /* Nothing specified -> width defaults to canonical char width. */
21767 width
= FRAME_COLUMN_WIDTH (it
->f
);
21769 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
21772 /* Compute height. */
21773 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
21774 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21777 zero_height_ok_p
= 1;
21779 else if (prop
= Fplist_get (plist
, QCrelative_height
),
21781 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
21783 height
= FONT_HEIGHT (font
);
21785 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
21788 /* Compute percentage of height used for ascent. If
21789 `:ascent ASCENT' is present and valid, use that. Otherwise,
21790 derive the ascent from the font in use. */
21791 if (prop
= Fplist_get (plist
, QCascent
),
21792 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
21793 ascent
= height
* NUMVAL (prop
) / 100.0;
21794 else if (!NILP (prop
)
21795 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21796 ascent
= min (max (0, (int)tem
), height
);
21798 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
21800 if (width
> 0 && it
->line_wrap
!= TRUNCATE
21801 && it
->current_x
+ width
> it
->last_visible_x
)
21802 width
= it
->last_visible_x
- it
->current_x
- 1;
21804 if (width
> 0 && height
> 0 && it
->glyph_row
)
21806 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
21807 if (!STRINGP (object
))
21808 object
= it
->w
->buffer
;
21809 append_stretch_glyph (it
, object
, width
, height
, ascent
);
21812 it
->pixel_width
= width
;
21813 it
->ascent
= it
->phys_ascent
= ascent
;
21814 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
21815 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
21817 take_vertical_position_into_account (it
);
21820 /* Calculate line-height and line-spacing properties.
21821 An integer value specifies explicit pixel value.
21822 A float value specifies relative value to current face height.
21823 A cons (float . face-name) specifies relative value to
21824 height of specified face font.
21826 Returns height in pixels, or nil. */
21830 calc_line_height_property (it
, val
, font
, boff
, override
)
21834 int boff
, override
;
21836 Lisp_Object face_name
= Qnil
;
21837 int ascent
, descent
, height
;
21839 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
21844 face_name
= XCAR (val
);
21846 if (!NUMBERP (val
))
21847 val
= make_number (1);
21848 if (NILP (face_name
))
21850 height
= it
->ascent
+ it
->descent
;
21855 if (NILP (face_name
))
21857 font
= FRAME_FONT (it
->f
);
21858 boff
= FRAME_BASELINE_OFFSET (it
->f
);
21860 else if (EQ (face_name
, Qt
))
21869 face_id
= lookup_named_face (it
->f
, face_name
, 0);
21871 return make_number (-1);
21873 face
= FACE_FROM_ID (it
->f
, face_id
);
21876 return make_number (-1);
21877 boff
= font
->baseline_offset
;
21878 if (font
->vertical_centering
)
21879 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21882 ascent
= FONT_BASE (font
) + boff
;
21883 descent
= FONT_DESCENT (font
) - boff
;
21887 it
->override_ascent
= ascent
;
21888 it
->override_descent
= descent
;
21889 it
->override_boff
= boff
;
21892 height
= ascent
+ descent
;
21896 height
= (int)(XFLOAT_DATA (val
) * height
);
21897 else if (INTEGERP (val
))
21898 height
*= XINT (val
);
21900 return make_number (height
);
21905 Produce glyphs/get display metrics for the display element IT is
21906 loaded with. See the description of struct it in dispextern.h
21907 for an overview of struct it. */
21910 x_produce_glyphs (it
)
21913 int extra_line_spacing
= it
->extra_line_spacing
;
21915 it
->glyph_not_available_p
= 0;
21917 if (it
->what
== IT_CHARACTER
)
21921 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21922 struct font_metrics
*pcm
;
21923 int font_not_found_p
;
21924 int boff
; /* baseline offset */
21925 /* We may change it->multibyte_p upon unibyte<->multibyte
21926 conversion. So, save the current value now and restore it
21929 Note: It seems that we don't have to record multibyte_p in
21930 struct glyph because the character code itself tells whether
21931 or not the character is multibyte. Thus, in the future, we
21932 must consider eliminating the field `multibyte_p' in the
21934 int saved_multibyte_p
= it
->multibyte_p
;
21936 /* Maybe translate single-byte characters to multibyte, or the
21938 it
->char_to_display
= it
->c
;
21939 if (!ASCII_BYTE_P (it
->c
)
21940 && ! it
->multibyte_p
)
21942 if (SINGLE_BYTE_CHAR_P (it
->c
)
21943 && unibyte_display_via_language_environment
)
21945 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
21947 /* get_next_display_element assures that this decoding
21949 it
->char_to_display
= DECODE_CHAR (unibyte
, it
->c
);
21950 it
->multibyte_p
= 1;
21951 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
,
21953 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21957 /* Get font to use. Encode IT->char_to_display. */
21958 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
21959 &char2b
, it
->multibyte_p
, 0);
21962 font_not_found_p
= font
== NULL
;
21963 if (font_not_found_p
)
21965 /* When no suitable font found, display an empty box based
21966 on the metrics of the font of the default face (or what
21968 struct face
*no_font_face
21969 = FACE_FROM_ID (it
->f
,
21970 NILP (Vface_remapping_alist
) ? DEFAULT_FACE_ID
21971 : lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
21972 font
= no_font_face
->font
;
21973 boff
= font
->baseline_offset
;
21977 boff
= font
->baseline_offset
;
21978 if (font
->vertical_centering
)
21979 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21982 if (it
->char_to_display
>= ' '
21983 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
21985 /* Either unibyte or ASCII. */
21990 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21992 if (it
->override_ascent
>= 0)
21994 it
->ascent
= it
->override_ascent
;
21995 it
->descent
= it
->override_descent
;
21996 boff
= it
->override_boff
;
22000 it
->ascent
= FONT_BASE (font
) + boff
;
22001 it
->descent
= FONT_DESCENT (font
) - boff
;
22006 it
->phys_ascent
= pcm
->ascent
+ boff
;
22007 it
->phys_descent
= pcm
->descent
- boff
;
22008 it
->pixel_width
= pcm
->width
;
22012 it
->glyph_not_available_p
= 1;
22013 it
->phys_ascent
= it
->ascent
;
22014 it
->phys_descent
= it
->descent
;
22015 it
->pixel_width
= FONT_WIDTH (font
);
22018 if (it
->constrain_row_ascent_descent_p
)
22020 if (it
->descent
> it
->max_descent
)
22022 it
->ascent
+= it
->descent
- it
->max_descent
;
22023 it
->descent
= it
->max_descent
;
22025 if (it
->ascent
> it
->max_ascent
)
22027 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22028 it
->ascent
= it
->max_ascent
;
22030 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22031 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22032 extra_line_spacing
= 0;
22035 /* If this is a space inside a region of text with
22036 `space-width' property, change its width. */
22037 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22039 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22041 /* If face has a box, add the box thickness to the character
22042 height. If character has a box line to the left and/or
22043 right, add the box line width to the character's width. */
22044 if (face
->box
!= FACE_NO_BOX
)
22046 int thick
= face
->box_line_width
;
22050 it
->ascent
+= thick
;
22051 it
->descent
+= thick
;
22056 if (it
->start_of_box_run_p
)
22057 it
->pixel_width
+= thick
;
22058 if (it
->end_of_box_run_p
)
22059 it
->pixel_width
+= thick
;
22062 /* If face has an overline, add the height of the overline
22063 (1 pixel) and a 1 pixel margin to the character height. */
22064 if (face
->overline_p
)
22065 it
->ascent
+= overline_margin
;
22067 if (it
->constrain_row_ascent_descent_p
)
22069 if (it
->ascent
> it
->max_ascent
)
22070 it
->ascent
= it
->max_ascent
;
22071 if (it
->descent
> it
->max_descent
)
22072 it
->descent
= it
->max_descent
;
22075 take_vertical_position_into_account (it
);
22077 /* If we have to actually produce glyphs, do it. */
22082 /* Translate a space with a `space-width' property
22083 into a stretch glyph. */
22084 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22085 / FONT_HEIGHT (font
));
22086 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22087 it
->ascent
+ it
->descent
, ascent
);
22092 /* If characters with lbearing or rbearing are displayed
22093 in this line, record that fact in a flag of the
22094 glyph row. This is used to optimize X output code. */
22095 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22096 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22098 if (! stretched_p
&& it
->pixel_width
== 0)
22099 /* We assure that all visible glyphs have at least 1-pixel
22101 it
->pixel_width
= 1;
22103 else if (it
->char_to_display
== '\n')
22105 /* A newline has no width, but we need the height of the
22106 line. But if previous part of the line sets a height,
22107 don't increase that height */
22109 Lisp_Object height
;
22110 Lisp_Object total_height
= Qnil
;
22112 it
->override_ascent
= -1;
22113 it
->pixel_width
= 0;
22116 height
= get_it_property(it
, Qline_height
);
22117 /* Split (line-height total-height) list */
22119 && CONSP (XCDR (height
))
22120 && NILP (XCDR (XCDR (height
))))
22122 total_height
= XCAR (XCDR (height
));
22123 height
= XCAR (height
);
22125 height
= calc_line_height_property(it
, height
, font
, boff
, 1);
22127 if (it
->override_ascent
>= 0)
22129 it
->ascent
= it
->override_ascent
;
22130 it
->descent
= it
->override_descent
;
22131 boff
= it
->override_boff
;
22135 it
->ascent
= FONT_BASE (font
) + boff
;
22136 it
->descent
= FONT_DESCENT (font
) - boff
;
22139 if (EQ (height
, Qt
))
22141 if (it
->descent
> it
->max_descent
)
22143 it
->ascent
+= it
->descent
- it
->max_descent
;
22144 it
->descent
= it
->max_descent
;
22146 if (it
->ascent
> it
->max_ascent
)
22148 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22149 it
->ascent
= it
->max_ascent
;
22151 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22152 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22153 it
->constrain_row_ascent_descent_p
= 1;
22154 extra_line_spacing
= 0;
22158 Lisp_Object spacing
;
22160 it
->phys_ascent
= it
->ascent
;
22161 it
->phys_descent
= it
->descent
;
22163 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22164 && face
->box
!= FACE_NO_BOX
22165 && face
->box_line_width
> 0)
22167 it
->ascent
+= face
->box_line_width
;
22168 it
->descent
+= face
->box_line_width
;
22171 && XINT (height
) > it
->ascent
+ it
->descent
)
22172 it
->ascent
= XINT (height
) - it
->descent
;
22174 if (!NILP (total_height
))
22175 spacing
= calc_line_height_property(it
, total_height
, font
, boff
, 0);
22178 spacing
= get_it_property(it
, Qline_spacing
);
22179 spacing
= calc_line_height_property(it
, spacing
, font
, boff
, 0);
22181 if (INTEGERP (spacing
))
22183 extra_line_spacing
= XINT (spacing
);
22184 if (!NILP (total_height
))
22185 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22189 else if (it
->char_to_display
== '\t')
22191 if (font
->space_width
> 0)
22193 int tab_width
= it
->tab_width
* font
->space_width
;
22194 int x
= it
->current_x
+ it
->continuation_lines_width
;
22195 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22197 /* If the distance from the current position to the next tab
22198 stop is less than a space character width, use the
22199 tab stop after that. */
22200 if (next_tab_x
- x
< font
->space_width
)
22201 next_tab_x
+= tab_width
;
22203 it
->pixel_width
= next_tab_x
- x
;
22205 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22206 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22210 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22211 it
->ascent
+ it
->descent
, it
->ascent
);
22216 it
->pixel_width
= 0;
22222 /* A multi-byte character. Assume that the display width of the
22223 character is the width of the character multiplied by the
22224 width of the font. */
22226 /* If we found a font, this font should give us the right
22227 metrics. If we didn't find a font, use the frame's
22228 default font and calculate the width of the character by
22229 multiplying the width of font by the width of the
22232 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22234 if (font_not_found_p
|| !pcm
)
22236 int char_width
= CHAR_WIDTH (it
->char_to_display
);
22238 if (char_width
== 0)
22239 /* This is a non spacing character. But, as we are
22240 going to display an empty box, the box must occupy
22241 at least one column. */
22243 it
->glyph_not_available_p
= 1;
22244 it
->pixel_width
= font
->space_width
* char_width
;
22245 it
->phys_ascent
= FONT_BASE (font
) + boff
;
22246 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22250 it
->pixel_width
= pcm
->width
;
22251 it
->phys_ascent
= pcm
->ascent
+ boff
;
22252 it
->phys_descent
= pcm
->descent
- boff
;
22254 && (pcm
->lbearing
< 0
22255 || pcm
->rbearing
> pcm
->width
))
22256 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22259 it
->ascent
= FONT_BASE (font
) + boff
;
22260 it
->descent
= FONT_DESCENT (font
) - boff
;
22261 if (face
->box
!= FACE_NO_BOX
)
22263 int thick
= face
->box_line_width
;
22267 it
->ascent
+= thick
;
22268 it
->descent
+= thick
;
22273 if (it
->start_of_box_run_p
)
22274 it
->pixel_width
+= thick
;
22275 if (it
->end_of_box_run_p
)
22276 it
->pixel_width
+= thick
;
22279 /* If face has an overline, add the height of the overline
22280 (1 pixel) and a 1 pixel margin to the character height. */
22281 if (face
->overline_p
)
22282 it
->ascent
+= overline_margin
;
22284 take_vertical_position_into_account (it
);
22286 if (it
->ascent
< 0)
22288 if (it
->descent
< 0)
22293 if (it
->pixel_width
== 0)
22294 /* We assure that all visible glyphs have at least 1-pixel
22296 it
->pixel_width
= 1;
22298 it
->multibyte_p
= saved_multibyte_p
;
22300 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22302 /* A static composition.
22304 Note: A composition is represented as one glyph in the
22305 glyph matrix. There are no padding glyphs.
22307 Important note: pixel_width, ascent, and descent are the
22308 values of what is drawn by draw_glyphs (i.e. the values of
22309 the overall glyphs composed). */
22310 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22311 int boff
; /* baseline offset */
22312 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22313 int glyph_len
= cmp
->glyph_len
;
22314 struct font
*font
= face
->font
;
22318 /* If we have not yet calculated pixel size data of glyphs of
22319 the composition for the current face font, calculate them
22320 now. Theoretically, we have to check all fonts for the
22321 glyphs, but that requires much time and memory space. So,
22322 here we check only the font of the first glyph. This may
22323 lead to incorrect display, but it's very rare, and C-l
22324 (recenter-top-bottom) can correct the display anyway. */
22325 if (! cmp
->font
|| cmp
->font
!= font
)
22327 /* Ascent and descent of the font of the first character
22328 of this composition (adjusted by baseline offset).
22329 Ascent and descent of overall glyphs should not be less
22330 than these, respectively. */
22331 int font_ascent
, font_descent
, font_height
;
22332 /* Bounding box of the overall glyphs. */
22333 int leftmost
, rightmost
, lowest
, highest
;
22334 int lbearing
, rbearing
;
22335 int i
, width
, ascent
, descent
;
22336 int left_padded
= 0, right_padded
= 0;
22339 struct font_metrics
*pcm
;
22340 int font_not_found_p
;
22343 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22344 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22346 if (glyph_len
< cmp
->glyph_len
)
22348 for (i
= 0; i
< glyph_len
; i
++)
22350 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22352 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22357 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22358 : IT_CHARPOS (*it
));
22359 /* If no suitable font is found, use the default font. */
22360 font_not_found_p
= font
== NULL
;
22361 if (font_not_found_p
)
22363 face
= face
->ascii_face
;
22366 boff
= font
->baseline_offset
;
22367 if (font
->vertical_centering
)
22368 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22369 font_ascent
= FONT_BASE (font
) + boff
;
22370 font_descent
= FONT_DESCENT (font
) - boff
;
22371 font_height
= FONT_HEIGHT (font
);
22373 cmp
->font
= (void *) font
;
22376 if (! font_not_found_p
)
22378 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22379 &char2b
, it
->multibyte_p
, 0);
22380 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22383 /* Initialize the bounding box. */
22386 width
= pcm
->width
;
22387 ascent
= pcm
->ascent
;
22388 descent
= pcm
->descent
;
22389 lbearing
= pcm
->lbearing
;
22390 rbearing
= pcm
->rbearing
;
22394 width
= FONT_WIDTH (font
);
22395 ascent
= FONT_BASE (font
);
22396 descent
= FONT_DESCENT (font
);
22403 lowest
= - descent
+ boff
;
22404 highest
= ascent
+ boff
;
22406 if (! font_not_found_p
22407 && font
->default_ascent
22408 && CHAR_TABLE_P (Vuse_default_ascent
)
22409 && !NILP (Faref (Vuse_default_ascent
,
22410 make_number (it
->char_to_display
))))
22411 highest
= font
->default_ascent
+ boff
;
22413 /* Draw the first glyph at the normal position. It may be
22414 shifted to right later if some other glyphs are drawn
22416 cmp
->offsets
[i
* 2] = 0;
22417 cmp
->offsets
[i
* 2 + 1] = boff
;
22418 cmp
->lbearing
= lbearing
;
22419 cmp
->rbearing
= rbearing
;
22421 /* Set cmp->offsets for the remaining glyphs. */
22422 for (i
++; i
< glyph_len
; i
++)
22424 int left
, right
, btm
, top
;
22425 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22427 struct face
*this_face
;
22432 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22433 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22434 font
= this_face
->font
;
22440 this_boff
= font
->baseline_offset
;
22441 if (font
->vertical_centering
)
22442 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22443 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22444 &char2b
, it
->multibyte_p
, 0);
22445 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22448 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22451 width
= pcm
->width
;
22452 ascent
= pcm
->ascent
;
22453 descent
= pcm
->descent
;
22454 lbearing
= pcm
->lbearing
;
22455 rbearing
= pcm
->rbearing
;
22456 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22458 /* Relative composition with or without
22459 alternate chars. */
22460 left
= (leftmost
+ rightmost
- width
) / 2;
22461 btm
= - descent
+ boff
;
22462 if (font
->relative_compose
22463 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22464 || NILP (Faref (Vignore_relative_composition
,
22465 make_number (ch
)))))
22468 if (- descent
>= font
->relative_compose
)
22469 /* One extra pixel between two glyphs. */
22471 else if (ascent
<= 0)
22472 /* One extra pixel between two glyphs. */
22473 btm
= lowest
- 1 - ascent
- descent
;
22478 /* A composition rule is specified by an integer
22479 value that encodes global and new reference
22480 points (GREF and NREF). GREF and NREF are
22481 specified by numbers as below:
22483 0---1---2 -- ascent
22487 9--10--11 -- center
22489 ---3---4---5--- baseline
22491 6---7---8 -- descent
22493 int rule
= COMPOSITION_RULE (cmp
, i
);
22494 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
22496 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
22497 grefx
= gref
% 3, nrefx
= nref
% 3;
22498 grefy
= gref
/ 3, nrefy
= nref
/ 3;
22500 xoff
= font_height
* (xoff
- 128) / 256;
22502 yoff
= font_height
* (yoff
- 128) / 256;
22505 + grefx
* (rightmost
- leftmost
) / 2
22506 - nrefx
* width
/ 2
22509 btm
= ((grefy
== 0 ? highest
22511 : grefy
== 2 ? lowest
22512 : (highest
+ lowest
) / 2)
22513 - (nrefy
== 0 ? ascent
+ descent
22514 : nrefy
== 1 ? descent
- boff
22516 : (ascent
+ descent
) / 2)
22520 cmp
->offsets
[i
* 2] = left
;
22521 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
22523 /* Update the bounding box of the overall glyphs. */
22526 right
= left
+ width
;
22527 if (left
< leftmost
)
22529 if (right
> rightmost
)
22532 top
= btm
+ descent
+ ascent
;
22538 if (cmp
->lbearing
> left
+ lbearing
)
22539 cmp
->lbearing
= left
+ lbearing
;
22540 if (cmp
->rbearing
< left
+ rbearing
)
22541 cmp
->rbearing
= left
+ rbearing
;
22545 /* If there are glyphs whose x-offsets are negative,
22546 shift all glyphs to the right and make all x-offsets
22550 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22551 cmp
->offsets
[i
* 2] -= leftmost
;
22552 rightmost
-= leftmost
;
22553 cmp
->lbearing
-= leftmost
;
22554 cmp
->rbearing
-= leftmost
;
22557 if (left_padded
&& cmp
->lbearing
< 0)
22559 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22560 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
22561 rightmost
-= cmp
->lbearing
;
22562 cmp
->rbearing
-= cmp
->lbearing
;
22565 if (right_padded
&& rightmost
< cmp
->rbearing
)
22567 rightmost
= cmp
->rbearing
;
22570 cmp
->pixel_width
= rightmost
;
22571 cmp
->ascent
= highest
;
22572 cmp
->descent
= - lowest
;
22573 if (cmp
->ascent
< font_ascent
)
22574 cmp
->ascent
= font_ascent
;
22575 if (cmp
->descent
< font_descent
)
22576 cmp
->descent
= font_descent
;
22580 && (cmp
->lbearing
< 0
22581 || cmp
->rbearing
> cmp
->pixel_width
))
22582 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22584 it
->pixel_width
= cmp
->pixel_width
;
22585 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
22586 it
->descent
= it
->phys_descent
= cmp
->descent
;
22587 if (face
->box
!= FACE_NO_BOX
)
22589 int thick
= face
->box_line_width
;
22593 it
->ascent
+= thick
;
22594 it
->descent
+= thick
;
22599 if (it
->start_of_box_run_p
)
22600 it
->pixel_width
+= thick
;
22601 if (it
->end_of_box_run_p
)
22602 it
->pixel_width
+= thick
;
22605 /* If face has an overline, add the height of the overline
22606 (1 pixel) and a 1 pixel margin to the character height. */
22607 if (face
->overline_p
)
22608 it
->ascent
+= overline_margin
;
22610 take_vertical_position_into_account (it
);
22611 if (it
->ascent
< 0)
22613 if (it
->descent
< 0)
22617 append_composite_glyph (it
);
22619 else if (it
->what
== IT_COMPOSITION
)
22621 /* A dynamic (automatic) composition. */
22622 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22623 Lisp_Object gstring
;
22624 struct font_metrics metrics
;
22626 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
22628 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
22631 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
22632 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22633 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
22634 it
->descent
= it
->phys_descent
= metrics
.descent
;
22635 if (face
->box
!= FACE_NO_BOX
)
22637 int thick
= face
->box_line_width
;
22641 it
->ascent
+= thick
;
22642 it
->descent
+= thick
;
22647 if (it
->start_of_box_run_p
)
22648 it
->pixel_width
+= thick
;
22649 if (it
->end_of_box_run_p
)
22650 it
->pixel_width
+= thick
;
22652 /* If face has an overline, add the height of the overline
22653 (1 pixel) and a 1 pixel margin to the character height. */
22654 if (face
->overline_p
)
22655 it
->ascent
+= overline_margin
;
22656 take_vertical_position_into_account (it
);
22657 if (it
->ascent
< 0)
22659 if (it
->descent
< 0)
22663 append_composite_glyph (it
);
22665 else if (it
->what
== IT_IMAGE
)
22666 produce_image_glyph (it
);
22667 else if (it
->what
== IT_STRETCH
)
22668 produce_stretch_glyph (it
);
22670 /* Accumulate dimensions. Note: can't assume that it->descent > 0
22671 because this isn't true for images with `:ascent 100'. */
22672 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
22673 if (it
->area
== TEXT_AREA
)
22674 it
->current_x
+= it
->pixel_width
;
22676 if (extra_line_spacing
> 0)
22678 it
->descent
+= extra_line_spacing
;
22679 if (extra_line_spacing
> it
->max_extra_line_spacing
)
22680 it
->max_extra_line_spacing
= extra_line_spacing
;
22683 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
22684 it
->max_descent
= max (it
->max_descent
, it
->descent
);
22685 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
22686 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
22690 Output LEN glyphs starting at START at the nominal cursor position.
22691 Advance the nominal cursor over the text. The global variable
22692 updated_window contains the window being updated, updated_row is
22693 the glyph row being updated, and updated_area is the area of that
22694 row being updated. */
22697 x_write_glyphs (start
, len
)
22698 struct glyph
*start
;
22703 xassert (updated_window
&& updated_row
);
22706 /* Write glyphs. */
22708 hpos
= start
- updated_row
->glyphs
[updated_area
];
22709 x
= draw_glyphs (updated_window
, output_cursor
.x
,
22710 updated_row
, updated_area
,
22712 DRAW_NORMAL_TEXT
, 0);
22714 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
22715 if (updated_area
== TEXT_AREA
22716 && updated_window
->phys_cursor_on_p
22717 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
22718 && updated_window
->phys_cursor
.hpos
>= hpos
22719 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
22720 updated_window
->phys_cursor_on_p
= 0;
22724 /* Advance the output cursor. */
22725 output_cursor
.hpos
+= len
;
22726 output_cursor
.x
= x
;
22731 Insert LEN glyphs from START at the nominal cursor position. */
22734 x_insert_glyphs (start
, len
)
22735 struct glyph
*start
;
22740 int line_height
, shift_by_width
, shifted_region_width
;
22741 struct glyph_row
*row
;
22742 struct glyph
*glyph
;
22743 int frame_x
, frame_y
;
22746 xassert (updated_window
&& updated_row
);
22748 w
= updated_window
;
22749 f
= XFRAME (WINDOW_FRAME (w
));
22751 /* Get the height of the line we are in. */
22753 line_height
= row
->height
;
22755 /* Get the width of the glyphs to insert. */
22756 shift_by_width
= 0;
22757 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
22758 shift_by_width
+= glyph
->pixel_width
;
22760 /* Get the width of the region to shift right. */
22761 shifted_region_width
= (window_box_width (w
, updated_area
)
22766 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
22767 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
22769 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
22770 line_height
, shift_by_width
);
22772 /* Write the glyphs. */
22773 hpos
= start
- row
->glyphs
[updated_area
];
22774 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
22776 DRAW_NORMAL_TEXT
, 0);
22778 /* Advance the output cursor. */
22779 output_cursor
.hpos
+= len
;
22780 output_cursor
.x
+= shift_by_width
;
22786 Erase the current text line from the nominal cursor position
22787 (inclusive) to pixel column TO_X (exclusive). The idea is that
22788 everything from TO_X onward is already erased.
22790 TO_X is a pixel position relative to updated_area of
22791 updated_window. TO_X == -1 means clear to the end of this area. */
22794 x_clear_end_of_line (to_x
)
22798 struct window
*w
= updated_window
;
22799 int max_x
, min_y
, max_y
;
22800 int from_x
, from_y
, to_y
;
22802 xassert (updated_window
&& updated_row
);
22803 f
= XFRAME (w
->frame
);
22805 if (updated_row
->full_width_p
)
22806 max_x
= WINDOW_TOTAL_WIDTH (w
);
22808 max_x
= window_box_width (w
, updated_area
);
22809 max_y
= window_text_bottom_y (w
);
22811 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
22812 of window. For TO_X > 0, truncate to end of drawing area. */
22818 to_x
= min (to_x
, max_x
);
22820 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
22822 /* Notice if the cursor will be cleared by this operation. */
22823 if (!updated_row
->full_width_p
)
22824 notice_overwritten_cursor (w
, updated_area
,
22825 output_cursor
.x
, -1,
22827 MATRIX_ROW_BOTTOM_Y (updated_row
));
22829 from_x
= output_cursor
.x
;
22831 /* Translate to frame coordinates. */
22832 if (updated_row
->full_width_p
)
22834 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
22835 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
22839 int area_left
= window_box_left (w
, updated_area
);
22840 from_x
+= area_left
;
22844 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
22845 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
22846 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
22848 /* Prevent inadvertently clearing to end of the X window. */
22849 if (to_x
> from_x
&& to_y
> from_y
)
22852 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
22853 to_x
- from_x
, to_y
- from_y
);
22858 #endif /* HAVE_WINDOW_SYSTEM */
22862 /***********************************************************************
22864 ***********************************************************************/
22866 /* Value is the internal representation of the specified cursor type
22867 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
22868 of the bar cursor. */
22870 static enum text_cursor_kinds
22871 get_specified_cursor_type (arg
, width
)
22875 enum text_cursor_kinds type
;
22880 if (EQ (arg
, Qbox
))
22881 return FILLED_BOX_CURSOR
;
22883 if (EQ (arg
, Qhollow
))
22884 return HOLLOW_BOX_CURSOR
;
22886 if (EQ (arg
, Qbar
))
22893 && EQ (XCAR (arg
), Qbar
)
22894 && INTEGERP (XCDR (arg
))
22895 && XINT (XCDR (arg
)) >= 0)
22897 *width
= XINT (XCDR (arg
));
22901 if (EQ (arg
, Qhbar
))
22904 return HBAR_CURSOR
;
22908 && EQ (XCAR (arg
), Qhbar
)
22909 && INTEGERP (XCDR (arg
))
22910 && XINT (XCDR (arg
)) >= 0)
22912 *width
= XINT (XCDR (arg
));
22913 return HBAR_CURSOR
;
22916 /* Treat anything unknown as "hollow box cursor".
22917 It was bad to signal an error; people have trouble fixing
22918 .Xdefaults with Emacs, when it has something bad in it. */
22919 type
= HOLLOW_BOX_CURSOR
;
22924 /* Set the default cursor types for specified frame. */
22926 set_frame_cursor_types (f
, arg
)
22933 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
22934 FRAME_CURSOR_WIDTH (f
) = width
;
22936 /* By default, set up the blink-off state depending on the on-state. */
22938 tem
= Fassoc (arg
, Vblink_cursor_alist
);
22941 FRAME_BLINK_OFF_CURSOR (f
)
22942 = get_specified_cursor_type (XCDR (tem
), &width
);
22943 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
22946 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
22950 /* Return the cursor we want to be displayed in window W. Return
22951 width of bar/hbar cursor through WIDTH arg. Return with
22952 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
22953 (i.e. if the `system caret' should track this cursor).
22955 In a mini-buffer window, we want the cursor only to appear if we
22956 are reading input from this window. For the selected window, we
22957 want the cursor type given by the frame parameter or buffer local
22958 setting of cursor-type. If explicitly marked off, draw no cursor.
22959 In all other cases, we want a hollow box cursor. */
22961 static enum text_cursor_kinds
22962 get_window_cursor_type (w
, glyph
, width
, active_cursor
)
22964 struct glyph
*glyph
;
22966 int *active_cursor
;
22968 struct frame
*f
= XFRAME (w
->frame
);
22969 struct buffer
*b
= XBUFFER (w
->buffer
);
22970 int cursor_type
= DEFAULT_CURSOR
;
22971 Lisp_Object alt_cursor
;
22972 int non_selected
= 0;
22974 *active_cursor
= 1;
22977 if (cursor_in_echo_area
22978 && FRAME_HAS_MINIBUF_P (f
)
22979 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
22981 if (w
== XWINDOW (echo_area_window
))
22983 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
22985 *width
= FRAME_CURSOR_WIDTH (f
);
22986 return FRAME_DESIRED_CURSOR (f
);
22989 return get_specified_cursor_type (b
->cursor_type
, width
);
22992 *active_cursor
= 0;
22996 /* Detect a nonselected window or nonselected frame. */
22997 else if (w
!= XWINDOW (f
->selected_window
)
22998 #ifdef HAVE_WINDOW_SYSTEM
22999 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
23003 *active_cursor
= 0;
23005 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23011 /* Never display a cursor in a window in which cursor-type is nil. */
23012 if (NILP (b
->cursor_type
))
23015 /* Get the normal cursor type for this window. */
23016 if (EQ (b
->cursor_type
, Qt
))
23018 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23019 *width
= FRAME_CURSOR_WIDTH (f
);
23022 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
23024 /* Use cursor-in-non-selected-windows instead
23025 for non-selected window or frame. */
23028 alt_cursor
= b
->cursor_in_non_selected_windows
;
23029 if (!EQ (Qt
, alt_cursor
))
23030 return get_specified_cursor_type (alt_cursor
, width
);
23031 /* t means modify the normal cursor type. */
23032 if (cursor_type
== FILLED_BOX_CURSOR
)
23033 cursor_type
= HOLLOW_BOX_CURSOR
;
23034 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23036 return cursor_type
;
23039 /* Use normal cursor if not blinked off. */
23040 if (!w
->cursor_off_p
)
23042 #ifdef HAVE_WINDOW_SYSTEM
23043 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23045 if (cursor_type
== FILLED_BOX_CURSOR
)
23047 /* Using a block cursor on large images can be very annoying.
23048 So use a hollow cursor for "large" images.
23049 If image is not transparent (no mask), also use hollow cursor. */
23050 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23051 if (img
!= NULL
&& IMAGEP (img
->spec
))
23053 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23054 where N = size of default frame font size.
23055 This should cover most of the "tiny" icons people may use. */
23057 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23058 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23059 cursor_type
= HOLLOW_BOX_CURSOR
;
23062 else if (cursor_type
!= NO_CURSOR
)
23064 /* Display current only supports BOX and HOLLOW cursors for images.
23065 So for now, unconditionally use a HOLLOW cursor when cursor is
23066 not a solid box cursor. */
23067 cursor_type
= HOLLOW_BOX_CURSOR
;
23071 return cursor_type
;
23074 /* Cursor is blinked off, so determine how to "toggle" it. */
23076 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23077 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
23078 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23080 /* Then see if frame has specified a specific blink off cursor type. */
23081 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23083 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23084 return FRAME_BLINK_OFF_CURSOR (f
);
23088 /* Some people liked having a permanently visible blinking cursor,
23089 while others had very strong opinions against it. So it was
23090 decided to remove it. KFS 2003-09-03 */
23092 /* Finally perform built-in cursor blinking:
23093 filled box <-> hollow box
23094 wide [h]bar <-> narrow [h]bar
23095 narrow [h]bar <-> no cursor
23096 other type <-> no cursor */
23098 if (cursor_type
== FILLED_BOX_CURSOR
)
23099 return HOLLOW_BOX_CURSOR
;
23101 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23104 return cursor_type
;
23112 #ifdef HAVE_WINDOW_SYSTEM
23114 /* Notice when the text cursor of window W has been completely
23115 overwritten by a drawing operation that outputs glyphs in AREA
23116 starting at X0 and ending at X1 in the line starting at Y0 and
23117 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23118 the rest of the line after X0 has been written. Y coordinates
23119 are window-relative. */
23122 notice_overwritten_cursor (w
, area
, x0
, x1
, y0
, y1
)
23124 enum glyph_row_area area
;
23125 int x0
, y0
, x1
, y1
;
23127 int cx0
, cx1
, cy0
, cy1
;
23128 struct glyph_row
*row
;
23130 if (!w
->phys_cursor_on_p
)
23132 if (area
!= TEXT_AREA
)
23135 if (w
->phys_cursor
.vpos
< 0
23136 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23137 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23138 !(row
->enabled_p
&& row
->displays_text_p
)))
23141 if (row
->cursor_in_fringe_p
)
23143 row
->cursor_in_fringe_p
= 0;
23144 draw_fringe_bitmap (w
, row
, 0);
23145 w
->phys_cursor_on_p
= 0;
23149 cx0
= w
->phys_cursor
.x
;
23150 cx1
= cx0
+ w
->phys_cursor_width
;
23151 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23154 /* The cursor image will be completely removed from the
23155 screen if the output area intersects the cursor area in
23156 y-direction. When we draw in [y0 y1[, and some part of
23157 the cursor is at y < y0, that part must have been drawn
23158 before. When scrolling, the cursor is erased before
23159 actually scrolling, so we don't come here. When not
23160 scrolling, the rows above the old cursor row must have
23161 changed, and in this case these rows must have written
23162 over the cursor image.
23164 Likewise if part of the cursor is below y1, with the
23165 exception of the cursor being in the first blank row at
23166 the buffer and window end because update_text_area
23167 doesn't draw that row. (Except when it does, but
23168 that's handled in update_text_area.) */
23170 cy0
= w
->phys_cursor
.y
;
23171 cy1
= cy0
+ w
->phys_cursor_height
;
23172 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23175 w
->phys_cursor_on_p
= 0;
23178 #endif /* HAVE_WINDOW_SYSTEM */
23181 /************************************************************************
23183 ************************************************************************/
23185 #ifdef HAVE_WINDOW_SYSTEM
23188 Fix the display of area AREA of overlapping row ROW in window W
23189 with respect to the overlapping part OVERLAPS. */
23192 x_fix_overlapping_area (w
, row
, area
, overlaps
)
23194 struct glyph_row
*row
;
23195 enum glyph_row_area area
;
23203 for (i
= 0; i
< row
->used
[area
];)
23205 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23207 int start
= i
, start_x
= x
;
23211 x
+= row
->glyphs
[area
][i
].pixel_width
;
23214 while (i
< row
->used
[area
]
23215 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23217 draw_glyphs (w
, start_x
, row
, area
,
23219 DRAW_NORMAL_TEXT
, overlaps
);
23223 x
+= row
->glyphs
[area
][i
].pixel_width
;
23233 Draw the cursor glyph of window W in glyph row ROW. See the
23234 comment of draw_glyphs for the meaning of HL. */
23237 draw_phys_cursor_glyph (w
, row
, hl
)
23239 struct glyph_row
*row
;
23240 enum draw_glyphs_face hl
;
23242 /* If cursor hpos is out of bounds, don't draw garbage. This can
23243 happen in mini-buffer windows when switching between echo area
23244 glyphs and mini-buffer. */
23245 if (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])
23247 int on_p
= w
->phys_cursor_on_p
;
23249 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23250 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23252 w
->phys_cursor_on_p
= on_p
;
23254 if (hl
== DRAW_CURSOR
)
23255 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23256 /* When we erase the cursor, and ROW is overlapped by other
23257 rows, make sure that these overlapping parts of other rows
23259 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23261 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23263 if (row
> w
->current_matrix
->rows
23264 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23265 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23266 OVERLAPS_ERASED_CURSOR
);
23268 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23269 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23270 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23271 OVERLAPS_ERASED_CURSOR
);
23278 Erase the image of a cursor of window W from the screen. */
23281 erase_phys_cursor (w
)
23284 struct frame
*f
= XFRAME (w
->frame
);
23285 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23286 int hpos
= w
->phys_cursor
.hpos
;
23287 int vpos
= w
->phys_cursor
.vpos
;
23288 int mouse_face_here_p
= 0;
23289 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23290 struct glyph_row
*cursor_row
;
23291 struct glyph
*cursor_glyph
;
23292 enum draw_glyphs_face hl
;
23294 /* No cursor displayed or row invalidated => nothing to do on the
23296 if (w
->phys_cursor_type
== NO_CURSOR
)
23297 goto mark_cursor_off
;
23299 /* VPOS >= active_glyphs->nrows means that window has been resized.
23300 Don't bother to erase the cursor. */
23301 if (vpos
>= active_glyphs
->nrows
)
23302 goto mark_cursor_off
;
23304 /* If row containing cursor is marked invalid, there is nothing we
23306 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23307 if (!cursor_row
->enabled_p
)
23308 goto mark_cursor_off
;
23310 /* If line spacing is > 0, old cursor may only be partially visible in
23311 window after split-window. So adjust visible height. */
23312 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23313 window_text_bottom_y (w
) - cursor_row
->y
);
23315 /* If row is completely invisible, don't attempt to delete a cursor which
23316 isn't there. This can happen if cursor is at top of a window, and
23317 we switch to a buffer with a header line in that window. */
23318 if (cursor_row
->visible_height
<= 0)
23319 goto mark_cursor_off
;
23321 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23322 if (cursor_row
->cursor_in_fringe_p
)
23324 cursor_row
->cursor_in_fringe_p
= 0;
23325 draw_fringe_bitmap (w
, cursor_row
, 0);
23326 goto mark_cursor_off
;
23329 /* This can happen when the new row is shorter than the old one.
23330 In this case, either draw_glyphs or clear_end_of_line
23331 should have cleared the cursor. Note that we wouldn't be
23332 able to erase the cursor in this case because we don't have a
23333 cursor glyph at hand. */
23334 if (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])
23335 goto mark_cursor_off
;
23337 /* If the cursor is in the mouse face area, redisplay that when
23338 we clear the cursor. */
23339 if (! NILP (dpyinfo
->mouse_face_window
)
23340 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
23341 && (vpos
> dpyinfo
->mouse_face_beg_row
23342 || (vpos
== dpyinfo
->mouse_face_beg_row
23343 && hpos
>= dpyinfo
->mouse_face_beg_col
))
23344 && (vpos
< dpyinfo
->mouse_face_end_row
23345 || (vpos
== dpyinfo
->mouse_face_end_row
23346 && hpos
< dpyinfo
->mouse_face_end_col
))
23347 /* Don't redraw the cursor's spot in mouse face if it is at the
23348 end of a line (on a newline). The cursor appears there, but
23349 mouse highlighting does not. */
23350 && cursor_row
->used
[TEXT_AREA
] > hpos
)
23351 mouse_face_here_p
= 1;
23353 /* Maybe clear the display under the cursor. */
23354 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23357 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23360 cursor_glyph
= get_phys_cursor_glyph (w
);
23361 if (cursor_glyph
== NULL
)
23362 goto mark_cursor_off
;
23364 width
= cursor_glyph
->pixel_width
;
23365 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23366 x
= w
->phys_cursor
.x
;
23368 width
-= left_x
- x
;
23369 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23370 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23371 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23374 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23377 /* Erase the cursor by redrawing the character underneath it. */
23378 if (mouse_face_here_p
)
23379 hl
= DRAW_MOUSE_FACE
;
23381 hl
= DRAW_NORMAL_TEXT
;
23382 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23385 w
->phys_cursor_on_p
= 0;
23386 w
->phys_cursor_type
= NO_CURSOR
;
23391 Display or clear cursor of window W. If ON is zero, clear the
23392 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23393 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23396 display_and_set_cursor (w
, on
, hpos
, vpos
, x
, y
)
23398 int on
, hpos
, vpos
, x
, y
;
23400 struct frame
*f
= XFRAME (w
->frame
);
23401 int new_cursor_type
;
23402 int new_cursor_width
;
23404 struct glyph_row
*glyph_row
;
23405 struct glyph
*glyph
;
23407 /* This is pointless on invisible frames, and dangerous on garbaged
23408 windows and frames; in the latter case, the frame or window may
23409 be in the midst of changing its size, and x and y may be off the
23411 if (! FRAME_VISIBLE_P (f
)
23412 || FRAME_GARBAGED_P (f
)
23413 || vpos
>= w
->current_matrix
->nrows
23414 || hpos
>= w
->current_matrix
->matrix_w
)
23417 /* If cursor is off and we want it off, return quickly. */
23418 if (!on
&& !w
->phys_cursor_on_p
)
23421 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23422 /* If cursor row is not enabled, we don't really know where to
23423 display the cursor. */
23424 if (!glyph_row
->enabled_p
)
23426 w
->phys_cursor_on_p
= 0;
23431 if (!glyph_row
->exact_window_width_line_p
23432 || hpos
< glyph_row
->used
[TEXT_AREA
])
23433 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23435 xassert (interrupt_input_blocked
);
23437 /* Set new_cursor_type to the cursor we want to be displayed. */
23438 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23439 &new_cursor_width
, &active_cursor
);
23441 /* If cursor is currently being shown and we don't want it to be or
23442 it is in the wrong place, or the cursor type is not what we want,
23444 if (w
->phys_cursor_on_p
23446 || w
->phys_cursor
.x
!= x
23447 || w
->phys_cursor
.y
!= y
23448 || new_cursor_type
!= w
->phys_cursor_type
23449 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23450 && new_cursor_width
!= w
->phys_cursor_width
)))
23451 erase_phys_cursor (w
);
23453 /* Don't check phys_cursor_on_p here because that flag is only set
23454 to zero in some cases where we know that the cursor has been
23455 completely erased, to avoid the extra work of erasing the cursor
23456 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23457 still not be visible, or it has only been partly erased. */
23460 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23461 w
->phys_cursor_height
= glyph_row
->height
;
23463 /* Set phys_cursor_.* before x_draw_.* is called because some
23464 of them may need the information. */
23465 w
->phys_cursor
.x
= x
;
23466 w
->phys_cursor
.y
= glyph_row
->y
;
23467 w
->phys_cursor
.hpos
= hpos
;
23468 w
->phys_cursor
.vpos
= vpos
;
23471 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23472 new_cursor_type
, new_cursor_width
,
23473 on
, active_cursor
);
23477 /* Switch the display of W's cursor on or off, according to the value
23481 update_window_cursor (w
, on
)
23485 /* Don't update cursor in windows whose frame is in the process
23486 of being deleted. */
23487 if (w
->current_matrix
)
23490 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23491 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23497 /* Call update_window_cursor with parameter ON_P on all leaf windows
23498 in the window tree rooted at W. */
23501 update_cursor_in_window_tree (w
, on_p
)
23507 if (!NILP (w
->hchild
))
23508 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23509 else if (!NILP (w
->vchild
))
23510 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23512 update_window_cursor (w
, on_p
);
23514 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
23520 Display the cursor on window W, or clear it, according to ON_P.
23521 Don't change the cursor's position. */
23524 x_update_cursor (f
, on_p
)
23528 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
23533 Clear the cursor of window W to background color, and mark the
23534 cursor as not shown. This is used when the text where the cursor
23535 is about to be rewritten. */
23541 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
23542 update_window_cursor (w
, 0);
23547 Display the active region described by mouse_face_* according to DRAW. */
23550 show_mouse_face (dpyinfo
, draw
)
23551 Display_Info
*dpyinfo
;
23552 enum draw_glyphs_face draw
;
23554 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
23555 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23557 if (/* If window is in the process of being destroyed, don't bother
23559 w
->current_matrix
!= NULL
23560 /* Don't update mouse highlight if hidden */
23561 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
23562 /* Recognize when we are called to operate on rows that don't exist
23563 anymore. This can happen when a window is split. */
23564 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
23566 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
23567 struct glyph_row
*row
, *first
, *last
;
23569 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
23570 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
23572 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
23574 int start_hpos
, end_hpos
, start_x
;
23576 /* For all but the first row, the highlight starts at column 0. */
23579 start_hpos
= dpyinfo
->mouse_face_beg_col
;
23580 start_x
= dpyinfo
->mouse_face_beg_x
;
23589 end_hpos
= dpyinfo
->mouse_face_end_col
;
23592 end_hpos
= row
->used
[TEXT_AREA
];
23593 if (draw
== DRAW_NORMAL_TEXT
)
23594 row
->fill_line_p
= 1; /* Clear to end of line */
23597 if (end_hpos
> start_hpos
)
23599 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
23600 start_hpos
, end_hpos
,
23604 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
23608 /* When we've written over the cursor, arrange for it to
23609 be displayed again. */
23610 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
23613 display_and_set_cursor (w
, 1,
23614 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23615 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23620 /* Change the mouse cursor. */
23621 if (draw
== DRAW_NORMAL_TEXT
&& !EQ (dpyinfo
->mouse_face_window
, f
->tool_bar_window
))
23622 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
23623 else if (draw
== DRAW_MOUSE_FACE
)
23624 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
23626 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
23630 Clear out the mouse-highlighted active region.
23631 Redraw it un-highlighted first. Value is non-zero if mouse
23632 face was actually drawn unhighlighted. */
23635 clear_mouse_face (dpyinfo
)
23636 Display_Info
*dpyinfo
;
23640 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
23642 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
23646 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
23647 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
23648 dpyinfo
->mouse_face_window
= Qnil
;
23649 dpyinfo
->mouse_face_overlay
= Qnil
;
23655 Non-zero if physical cursor of window W is within mouse face. */
23658 cursor_in_mouse_face_p (w
)
23661 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
23662 int in_mouse_face
= 0;
23664 if (WINDOWP (dpyinfo
->mouse_face_window
)
23665 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
23667 int hpos
= w
->phys_cursor
.hpos
;
23668 int vpos
= w
->phys_cursor
.vpos
;
23670 if (vpos
>= dpyinfo
->mouse_face_beg_row
23671 && vpos
<= dpyinfo
->mouse_face_end_row
23672 && (vpos
> dpyinfo
->mouse_face_beg_row
23673 || hpos
>= dpyinfo
->mouse_face_beg_col
)
23674 && (vpos
< dpyinfo
->mouse_face_end_row
23675 || hpos
< dpyinfo
->mouse_face_end_col
23676 || dpyinfo
->mouse_face_past_end
))
23680 return in_mouse_face
;
23686 /* This function sets the mouse_face_* elements of DPYINFO, assuming
23687 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
23688 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
23689 for the overlay or run of text properties specifying the mouse
23690 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
23691 before-string and after-string that must also be highlighted.
23692 DISPLAY_STRING, if non-nil, is a display string that may cover some
23693 or all of the highlighted text. */
23696 mouse_face_from_buffer_pos (Lisp_Object window
,
23697 Display_Info
*dpyinfo
,
23698 EMACS_INT mouse_charpos
,
23699 EMACS_INT start_charpos
,
23700 EMACS_INT end_charpos
,
23701 Lisp_Object before_string
,
23702 Lisp_Object after_string
,
23703 Lisp_Object display_string
)
23705 struct window
*w
= XWINDOW (window
);
23706 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23707 struct glyph_row
*row
;
23708 struct glyph
*glyph
, *end
;
23712 xassert (NILP (display_string
) || STRINGP (display_string
));
23713 xassert (NILP (before_string
) || STRINGP (before_string
));
23714 xassert (NILP (after_string
) || STRINGP (after_string
));
23716 /* Find the first highlighted glyph. */
23717 if (start_charpos
< MATRIX_ROW_START_CHARPOS (first
))
23719 dpyinfo
->mouse_face_beg_col
= 0;
23720 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
23721 dpyinfo
->mouse_face_beg_x
= first
->x
;
23722 dpyinfo
->mouse_face_beg_y
= first
->y
;
23726 row
= row_containing_pos (w
, start_charpos
, first
, NULL
, 0);
23728 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23730 /* If the before-string or display-string contains newlines,
23731 row_containing_pos skips to its last row. Move back. */
23732 if (!NILP (before_string
) || !NILP (display_string
))
23734 struct glyph_row
*prev
;
23735 while ((prev
= row
- 1, prev
>= first
)
23736 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
23737 && prev
->used
[TEXT_AREA
] > 0)
23739 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
23740 glyph
= beg
+ prev
->used
[TEXT_AREA
];
23741 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
23743 || !(EQ (glyph
->object
, before_string
)
23744 || EQ (glyph
->object
, display_string
)))
23750 glyph
= row
->glyphs
[TEXT_AREA
];
23751 end
= glyph
+ row
->used
[TEXT_AREA
];
23753 dpyinfo
->mouse_face_beg_y
= row
->y
;
23754 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
23756 /* Skip truncation glyphs at the start of the glyph row. */
23757 if (row
->displays_text_p
)
23759 && INTEGERP (glyph
->object
)
23760 && glyph
->charpos
< 0;
23762 x
+= glyph
->pixel_width
;
23764 /* Scan the glyph row, stopping before BEFORE_STRING or
23765 DISPLAY_STRING or START_CHARPOS. */
23767 && !INTEGERP (glyph
->object
)
23768 && !EQ (glyph
->object
, before_string
)
23769 && !EQ (glyph
->object
, display_string
)
23770 && !(BUFFERP (glyph
->object
)
23771 && glyph
->charpos
>= start_charpos
);
23773 x
+= glyph
->pixel_width
;
23775 dpyinfo
->mouse_face_beg_x
= x
;
23776 dpyinfo
->mouse_face_beg_col
= glyph
- row
->glyphs
[TEXT_AREA
];
23779 /* Find the last highlighted glyph. */
23780 row
= row_containing_pos (w
, end_charpos
, first
, NULL
, 0);
23783 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23784 dpyinfo
->mouse_face_past_end
= 1;
23786 else if (!NILP (after_string
))
23788 /* If the after-string has newlines, advance to its last row. */
23789 struct glyph_row
*next
;
23790 struct glyph_row
*last
23791 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23793 for (next
= row
+ 1;
23795 && next
->used
[TEXT_AREA
] > 0
23796 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
23801 glyph
= row
->glyphs
[TEXT_AREA
];
23802 end
= glyph
+ row
->used
[TEXT_AREA
];
23804 dpyinfo
->mouse_face_end_y
= row
->y
;
23805 dpyinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
23807 /* Skip truncation glyphs at the start of the row. */
23808 if (row
->displays_text_p
)
23810 && INTEGERP (glyph
->object
)
23811 && glyph
->charpos
< 0;
23813 x
+= glyph
->pixel_width
;
23815 /* Scan the glyph row, stopping at END_CHARPOS or when we encounter
23818 && !INTEGERP (glyph
->object
)
23819 && !EQ (glyph
->object
, after_string
)
23820 && !(BUFFERP (glyph
->object
) && glyph
->charpos
>= end_charpos
);
23822 x
+= glyph
->pixel_width
;
23824 /* If we found AFTER_STRING, consume it and stop. */
23825 if (EQ (glyph
->object
, after_string
))
23827 for (; EQ (glyph
->object
, after_string
) && glyph
< end
; ++glyph
)
23828 x
+= glyph
->pixel_width
;
23832 /* If there's no after-string, we must check if we overshot,
23833 which might be the case if we stopped after a string glyph.
23834 That glyph may belong to a before-string or display-string
23835 associated with the end position, which must not be
23837 Lisp_Object prev_object
;
23840 while (glyph
> row
->glyphs
[TEXT_AREA
])
23842 prev_object
= (glyph
- 1)->object
;
23843 if (!STRINGP (prev_object
) || EQ (prev_object
, display_string
))
23846 pos
= string_buffer_position (w
, prev_object
, end_charpos
);
23847 if (pos
&& pos
< end_charpos
)
23850 for (; glyph
> row
->glyphs
[TEXT_AREA
]
23851 && EQ ((glyph
- 1)->object
, prev_object
);
23853 x
-= (glyph
- 1)->pixel_width
;
23857 dpyinfo
->mouse_face_end_x
= x
;
23858 dpyinfo
->mouse_face_end_col
= glyph
- row
->glyphs
[TEXT_AREA
];
23859 dpyinfo
->mouse_face_window
= window
;
23860 dpyinfo
->mouse_face_face_id
23861 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
23863 !dpyinfo
->mouse_face_hidden
, -1);
23864 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23868 /* Find the position of the glyph for position POS in OBJECT in
23869 window W's current matrix, and return in *X, *Y the pixel
23870 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
23872 RIGHT_P non-zero means return the position of the right edge of the
23873 glyph, RIGHT_P zero means return the left edge position.
23875 If no glyph for POS exists in the matrix, return the position of
23876 the glyph with the next smaller position that is in the matrix, if
23877 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
23878 exists in the matrix, return the position of the glyph with the
23879 next larger position in OBJECT.
23881 Value is non-zero if a glyph was found. */
23884 fast_find_string_pos (w
, pos
, object
, hpos
, vpos
, x
, y
, right_p
)
23887 Lisp_Object object
;
23888 int *hpos
, *vpos
, *x
, *y
;
23891 int yb
= window_text_bottom_y (w
);
23892 struct glyph_row
*r
;
23893 struct glyph
*best_glyph
= NULL
;
23894 struct glyph_row
*best_row
= NULL
;
23897 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23898 r
->enabled_p
&& r
->y
< yb
;
23901 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
23902 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
23905 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
23906 if (EQ (g
->object
, object
))
23908 if (g
->charpos
== pos
)
23915 else if (best_glyph
== NULL
23916 || ((eabs (g
->charpos
- pos
)
23917 < eabs (best_glyph
->charpos
- pos
))
23920 : g
->charpos
> pos
)))
23934 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
23938 *x
+= best_glyph
->pixel_width
;
23943 *vpos
= best_row
- w
->current_matrix
->rows
;
23946 return best_glyph
!= NULL
;
23950 /* See if position X, Y is within a hot-spot of an image. */
23953 on_hot_spot_p (hot_spot
, x
, y
)
23954 Lisp_Object hot_spot
;
23957 if (!CONSP (hot_spot
))
23960 if (EQ (XCAR (hot_spot
), Qrect
))
23962 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
23963 Lisp_Object rect
= XCDR (hot_spot
);
23967 if (!CONSP (XCAR (rect
)))
23969 if (!CONSP (XCDR (rect
)))
23971 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
23973 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
23975 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
23977 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
23981 else if (EQ (XCAR (hot_spot
), Qcircle
))
23983 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
23984 Lisp_Object circ
= XCDR (hot_spot
);
23985 Lisp_Object lr
, lx0
, ly0
;
23987 && CONSP (XCAR (circ
))
23988 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
23989 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
23990 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
23992 double r
= XFLOATINT (lr
);
23993 double dx
= XINT (lx0
) - x
;
23994 double dy
= XINT (ly0
) - y
;
23995 return (dx
* dx
+ dy
* dy
<= r
* r
);
23998 else if (EQ (XCAR (hot_spot
), Qpoly
))
24000 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24001 if (VECTORP (XCDR (hot_spot
)))
24003 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24004 Lisp_Object
*poly
= v
->contents
;
24008 Lisp_Object lx
, ly
;
24011 /* Need an even number of coordinates, and at least 3 edges. */
24012 if (n
< 6 || n
& 1)
24015 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24016 If count is odd, we are inside polygon. Pixels on edges
24017 may or may not be included depending on actual geometry of the
24019 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24020 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24022 x0
= XINT (lx
), y0
= XINT (ly
);
24023 for (i
= 0; i
< n
; i
+= 2)
24025 int x1
= x0
, y1
= y0
;
24026 if ((lx
= poly
[i
], !INTEGERP (lx
))
24027 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24029 x0
= XINT (lx
), y0
= XINT (ly
);
24031 /* Does this segment cross the X line? */
24039 if (y
> y0
&& y
> y1
)
24041 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24051 find_hot_spot (map
, x
, y
)
24055 while (CONSP (map
))
24057 if (CONSP (XCAR (map
))
24058 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
24066 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
24068 doc
: /* Lookup in image map MAP coordinates X and Y.
24069 An image map is an alist where each element has the format (AREA ID PLIST).
24070 An AREA is specified as either a rectangle, a circle, or a polygon:
24071 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
24072 pixel coordinates of the upper left and bottom right corners.
24073 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
24074 and the radius of the circle; r may be a float or integer.
24075 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
24076 vector describes one corner in the polygon.
24077 Returns the alist element for the first matching AREA in MAP. */)
24088 return find_hot_spot (map
, XINT (x
), XINT (y
));
24092 /* Display frame CURSOR, optionally using shape defined by POINTER. */
24094 define_frame_cursor1 (f
, cursor
, pointer
)
24097 Lisp_Object pointer
;
24099 /* Do not change cursor shape while dragging mouse. */
24100 if (!NILP (do_mouse_tracking
))
24103 if (!NILP (pointer
))
24105 if (EQ (pointer
, Qarrow
))
24106 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24107 else if (EQ (pointer
, Qhand
))
24108 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
24109 else if (EQ (pointer
, Qtext
))
24110 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24111 else if (EQ (pointer
, intern ("hdrag")))
24112 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24113 #ifdef HAVE_X_WINDOWS
24114 else if (EQ (pointer
, intern ("vdrag")))
24115 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
24117 else if (EQ (pointer
, intern ("hourglass")))
24118 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
24119 else if (EQ (pointer
, Qmodeline
))
24120 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
24122 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24125 if (cursor
!= No_Cursor
)
24126 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
24129 /* Take proper action when mouse has moved to the mode or header line
24130 or marginal area AREA of window W, x-position X and y-position Y.
24131 X is relative to the start of the text display area of W, so the
24132 width of bitmap areas and scroll bars must be subtracted to get a
24133 position relative to the start of the mode line. */
24136 note_mode_line_or_margin_highlight (window
, x
, y
, area
)
24137 Lisp_Object window
;
24139 enum window_part area
;
24141 struct window
*w
= XWINDOW (window
);
24142 struct frame
*f
= XFRAME (w
->frame
);
24143 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24144 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24145 Lisp_Object pointer
= Qnil
;
24146 int charpos
, dx
, dy
, width
, height
;
24147 Lisp_Object string
, object
= Qnil
;
24148 Lisp_Object pos
, help
;
24150 Lisp_Object mouse_face
;
24151 int original_x_pixel
= x
;
24152 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
24153 struct glyph_row
*row
;
24155 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
24160 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
24161 &object
, &dx
, &dy
, &width
, &height
);
24163 row
= (area
== ON_MODE_LINE
24164 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
24165 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
24168 if (row
->mode_line_p
&& row
->enabled_p
)
24170 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
24171 end
= glyph
+ row
->used
[TEXT_AREA
];
24173 for (x0
= original_x_pixel
;
24174 glyph
< end
&& x0
>= glyph
->pixel_width
;
24176 x0
-= glyph
->pixel_width
;
24184 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
24185 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
24186 &object
, &dx
, &dy
, &width
, &height
);
24191 if (IMAGEP (object
))
24193 Lisp_Object image_map
, hotspot
;
24194 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
24196 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
24198 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24200 Lisp_Object area_id
, plist
;
24202 area_id
= XCAR (hotspot
);
24203 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24204 If so, we could look for mouse-enter, mouse-leave
24205 properties in PLIST (and do something...). */
24206 hotspot
= XCDR (hotspot
);
24207 if (CONSP (hotspot
)
24208 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24210 pointer
= Fplist_get (plist
, Qpointer
);
24211 if (NILP (pointer
))
24213 help
= Fplist_get (plist
, Qhelp_echo
);
24216 help_echo_string
= help
;
24217 /* Is this correct? ++kfs */
24218 XSETWINDOW (help_echo_window
, w
);
24219 help_echo_object
= w
->buffer
;
24220 help_echo_pos
= charpos
;
24224 if (NILP (pointer
))
24225 pointer
= Fplist_get (XCDR (object
), QCpointer
);
24228 if (STRINGP (string
))
24230 pos
= make_number (charpos
);
24231 /* If we're on a string with `help-echo' text property, arrange
24232 for the help to be displayed. This is done by setting the
24233 global variable help_echo_string to the help string. */
24236 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
24239 help_echo_string
= help
;
24240 XSETWINDOW (help_echo_window
, w
);
24241 help_echo_object
= string
;
24242 help_echo_pos
= charpos
;
24246 if (NILP (pointer
))
24247 pointer
= Fget_text_property (pos
, Qpointer
, string
);
24249 /* Change the mouse pointer according to what is under X/Y. */
24250 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
24253 map
= Fget_text_property (pos
, Qlocal_map
, string
);
24254 if (!KEYMAPP (map
))
24255 map
= Fget_text_property (pos
, Qkeymap
, string
);
24256 if (!KEYMAPP (map
))
24257 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
24260 /* Change the mouse face according to what is under X/Y. */
24261 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
24262 if (!NILP (mouse_face
)
24263 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
24268 struct glyph
* tmp_glyph
;
24272 int total_pixel_width
;
24277 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
24278 Qmouse_face
, string
, Qnil
);
24280 b
= make_number (0);
24282 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
24284 e
= make_number (SCHARS (string
));
24286 /* Calculate the position(glyph position: GPOS) of GLYPH in
24287 displayed string. GPOS is different from CHARPOS.
24289 CHARPOS is the position of glyph in internal string
24290 object. A mode line string format has structures which
24291 is converted to a flatten by emacs lisp interpreter.
24292 The internal string is an element of the structures.
24293 The displayed string is the flatten string. */
24295 if (glyph
> row_start_glyph
)
24297 tmp_glyph
= glyph
- 1;
24298 while (tmp_glyph
>= row_start_glyph
24299 && tmp_glyph
->charpos
>= XINT (b
)
24300 && EQ (tmp_glyph
->object
, glyph
->object
))
24307 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
24308 displayed string holding GLYPH.
24310 GSEQ_LENGTH is different from SCHARS (STRING).
24311 SCHARS (STRING) returns the length of the internal string. */
24312 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
24313 tmp_glyph
->charpos
< XINT (e
);
24314 tmp_glyph
++, gseq_length
++)
24316 if (!EQ (tmp_glyph
->object
, glyph
->object
))
24320 total_pixel_width
= 0;
24321 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
24322 total_pixel_width
+= tmp_glyph
->pixel_width
;
24324 /* Pre calculation of re-rendering position */
24326 hpos
= (area
== ON_MODE_LINE
24327 ? (w
->current_matrix
)->nrows
- 1
24330 /* If the re-rendering position is included in the last
24331 re-rendering area, we should do nothing. */
24332 if ( EQ (window
, dpyinfo
->mouse_face_window
)
24333 && dpyinfo
->mouse_face_beg_col
<= vpos
24334 && vpos
< dpyinfo
->mouse_face_end_col
24335 && dpyinfo
->mouse_face_beg_row
== hpos
)
24338 if (clear_mouse_face (dpyinfo
))
24339 cursor
= No_Cursor
;
24341 dpyinfo
->mouse_face_beg_col
= vpos
;
24342 dpyinfo
->mouse_face_beg_row
= hpos
;
24344 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
24345 dpyinfo
->mouse_face_beg_y
= 0;
24347 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
24348 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
24350 dpyinfo
->mouse_face_end_x
= 0;
24351 dpyinfo
->mouse_face_end_y
= 0;
24353 dpyinfo
->mouse_face_past_end
= 0;
24354 dpyinfo
->mouse_face_window
= window
;
24356 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
24359 glyph
->face_id
, 1);
24360 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24362 if (NILP (pointer
))
24365 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
24366 clear_mouse_face (dpyinfo
);
24368 define_frame_cursor1 (f
, cursor
, pointer
);
24373 Take proper action when the mouse has moved to position X, Y on
24374 frame F as regards highlighting characters that have mouse-face
24375 properties. Also de-highlighting chars where the mouse was before.
24376 X and Y can be negative or out of range. */
24379 note_mouse_highlight (f
, x
, y
)
24383 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24384 enum window_part part
;
24385 Lisp_Object window
;
24387 Cursor cursor
= No_Cursor
;
24388 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
24391 /* When a menu is active, don't highlight because this looks odd. */
24392 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
24393 if (popup_activated ())
24397 if (NILP (Vmouse_highlight
)
24398 || !f
->glyphs_initialized_p
24399 || f
->pointer_invisible
)
24402 dpyinfo
->mouse_face_mouse_x
= x
;
24403 dpyinfo
->mouse_face_mouse_y
= y
;
24404 dpyinfo
->mouse_face_mouse_frame
= f
;
24406 if (dpyinfo
->mouse_face_defer
)
24409 if (gc_in_progress
)
24411 dpyinfo
->mouse_face_deferred_gc
= 1;
24415 /* Which window is that in? */
24416 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
24418 /* If we were displaying active text in another window, clear that.
24419 Also clear if we move out of text area in same window. */
24420 if (! EQ (window
, dpyinfo
->mouse_face_window
)
24421 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
24422 && !NILP (dpyinfo
->mouse_face_window
)))
24423 clear_mouse_face (dpyinfo
);
24425 /* Not on a window -> return. */
24426 if (!WINDOWP (window
))
24429 /* Reset help_echo_string. It will get recomputed below. */
24430 help_echo_string
= Qnil
;
24432 /* Convert to window-relative pixel coordinates. */
24433 w
= XWINDOW (window
);
24434 frame_to_window_pixel_xy (w
, &x
, &y
);
24436 /* Handle tool-bar window differently since it doesn't display a
24438 if (EQ (window
, f
->tool_bar_window
))
24440 note_tool_bar_highlight (f
, x
, y
);
24444 /* Mouse is on the mode, header line or margin? */
24445 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
24446 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
24448 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
24452 if (part
== ON_VERTICAL_BORDER
)
24454 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24455 help_echo_string
= build_string ("drag-mouse-1: resize");
24457 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
24458 || part
== ON_SCROLL_BAR
)
24459 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24461 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24463 /* Are we in a window whose display is up to date?
24464 And verify the buffer's text has not changed. */
24465 b
= XBUFFER (w
->buffer
);
24466 if (part
== ON_TEXT
24467 && EQ (w
->window_end_valid
, w
->buffer
)
24468 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
24469 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
24471 int hpos
, vpos
, i
, dx
, dy
, area
;
24473 struct glyph
*glyph
;
24474 Lisp_Object object
;
24475 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
24476 Lisp_Object
*overlay_vec
= NULL
;
24478 struct buffer
*obuf
;
24479 int obegv
, ozv
, same_region
;
24481 /* Find the glyph under X/Y. */
24482 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
24484 /* Look for :pointer property on image. */
24485 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24487 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24488 if (img
!= NULL
&& IMAGEP (img
->spec
))
24490 Lisp_Object image_map
, hotspot
;
24491 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
24493 && (hotspot
= find_hot_spot (image_map
,
24494 glyph
->slice
.x
+ dx
,
24495 glyph
->slice
.y
+ dy
),
24497 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24499 Lisp_Object area_id
, plist
;
24501 area_id
= XCAR (hotspot
);
24502 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24503 If so, we could look for mouse-enter, mouse-leave
24504 properties in PLIST (and do something...). */
24505 hotspot
= XCDR (hotspot
);
24506 if (CONSP (hotspot
)
24507 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24509 pointer
= Fplist_get (plist
, Qpointer
);
24510 if (NILP (pointer
))
24512 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
24513 if (!NILP (help_echo_string
))
24515 help_echo_window
= window
;
24516 help_echo_object
= glyph
->object
;
24517 help_echo_pos
= glyph
->charpos
;
24521 if (NILP (pointer
))
24522 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
24526 /* Clear mouse face if X/Y not over text. */
24528 || area
!= TEXT_AREA
24529 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
24531 if (clear_mouse_face (dpyinfo
))
24532 cursor
= No_Cursor
;
24533 if (NILP (pointer
))
24535 if (area
!= TEXT_AREA
)
24536 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24538 pointer
= Vvoid_text_area_pointer
;
24543 pos
= glyph
->charpos
;
24544 object
= glyph
->object
;
24545 if (!STRINGP (object
) && !BUFFERP (object
))
24548 /* If we get an out-of-range value, return now; avoid an error. */
24549 if (BUFFERP (object
) && pos
> BUF_Z (b
))
24552 /* Make the window's buffer temporarily current for
24553 overlays_at and compute_char_face. */
24554 obuf
= current_buffer
;
24555 current_buffer
= b
;
24561 /* Is this char mouse-active or does it have help-echo? */
24562 position
= make_number (pos
);
24564 if (BUFFERP (object
))
24566 /* Put all the overlays we want in a vector in overlay_vec. */
24567 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
24568 /* Sort overlays into increasing priority order. */
24569 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
24574 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
24575 && vpos
>= dpyinfo
->mouse_face_beg_row
24576 && vpos
<= dpyinfo
->mouse_face_end_row
24577 && (vpos
> dpyinfo
->mouse_face_beg_row
24578 || hpos
>= dpyinfo
->mouse_face_beg_col
)
24579 && (vpos
< dpyinfo
->mouse_face_end_row
24580 || hpos
< dpyinfo
->mouse_face_end_col
24581 || dpyinfo
->mouse_face_past_end
));
24584 cursor
= No_Cursor
;
24586 /* Check mouse-face highlighting. */
24588 /* If there exists an overlay with mouse-face overlapping
24589 the one we are currently highlighting, we have to
24590 check if we enter the overlapping overlay, and then
24591 highlight only that. */
24592 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
24593 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
24595 /* Find the highest priority overlay with a mouse-face. */
24597 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
24599 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
24600 if (!NILP (mouse_face
))
24601 overlay
= overlay_vec
[i
];
24604 /* If we're highlighting the same overlay as before, there's
24605 no need to do that again. */
24606 if (!NILP (overlay
) && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
24607 goto check_help_echo
;
24608 dpyinfo
->mouse_face_overlay
= overlay
;
24610 /* Clear the display of the old active region, if any. */
24611 if (clear_mouse_face (dpyinfo
))
24612 cursor
= No_Cursor
;
24614 /* If no overlay applies, get a text property. */
24615 if (NILP (overlay
))
24616 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
24618 /* Next, compute the bounds of the mouse highlighting and
24620 if (!NILP (mouse_face
) && STRINGP (object
))
24622 /* The mouse-highlighting comes from a display string
24623 with a mouse-face. */
24627 b
= Fprevious_single_property_change
24628 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
24629 e
= Fnext_single_property_change
24630 (position
, Qmouse_face
, object
, Qnil
);
24632 b
= make_number (0);
24634 e
= make_number (SCHARS (object
) - 1);
24636 fast_find_string_pos (w
, XINT (b
), object
,
24637 &dpyinfo
->mouse_face_beg_col
,
24638 &dpyinfo
->mouse_face_beg_row
,
24639 &dpyinfo
->mouse_face_beg_x
,
24640 &dpyinfo
->mouse_face_beg_y
, 0);
24641 fast_find_string_pos (w
, XINT (e
), object
,
24642 &dpyinfo
->mouse_face_end_col
,
24643 &dpyinfo
->mouse_face_end_row
,
24644 &dpyinfo
->mouse_face_end_x
,
24645 &dpyinfo
->mouse_face_end_y
, 1);
24646 dpyinfo
->mouse_face_past_end
= 0;
24647 dpyinfo
->mouse_face_window
= window
;
24648 dpyinfo
->mouse_face_face_id
24649 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
24650 glyph
->face_id
, 1);
24651 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24652 cursor
= No_Cursor
;
24656 /* The mouse-highlighting, if any, comes from an overlay
24657 or text property in the buffer. */
24658 Lisp_Object buffer
, display_string
;
24660 if (STRINGP (object
))
24662 /* If we are on a display string with no mouse-face,
24663 check if the text under it has one. */
24664 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
24665 int start
= MATRIX_ROW_START_CHARPOS (r
);
24666 pos
= string_buffer_position (w
, object
, start
);
24669 mouse_face
= get_char_property_and_overlay
24670 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
24671 buffer
= w
->buffer
;
24672 display_string
= object
;
24678 display_string
= Qnil
;
24681 if (!NILP (mouse_face
))
24683 Lisp_Object before
, after
;
24684 Lisp_Object before_string
, after_string
;
24686 if (NILP (overlay
))
24688 /* Handle the text property case. */
24689 before
= Fprevious_single_property_change
24690 (make_number (pos
+ 1), Qmouse_face
, buffer
,
24691 Fmarker_position (w
->start
));
24692 after
= Fnext_single_property_change
24693 (make_number (pos
), Qmouse_face
, buffer
,
24694 make_number (BUF_Z (XBUFFER (buffer
))
24695 - XFASTINT (w
->window_end_pos
)));
24696 before_string
= after_string
= Qnil
;
24700 /* Handle the overlay case. */
24701 before
= Foverlay_start (overlay
);
24702 after
= Foverlay_end (overlay
);
24703 before_string
= Foverlay_get (overlay
, Qbefore_string
);
24704 after_string
= Foverlay_get (overlay
, Qafter_string
);
24706 if (!STRINGP (before_string
)) before_string
= Qnil
;
24707 if (!STRINGP (after_string
)) after_string
= Qnil
;
24710 mouse_face_from_buffer_pos (window
, dpyinfo
, pos
,
24713 before_string
, after_string
,
24715 cursor
= No_Cursor
;
24722 /* Look for a `help-echo' property. */
24723 if (NILP (help_echo_string
)) {
24724 Lisp_Object help
, overlay
;
24726 /* Check overlays first. */
24727 help
= overlay
= Qnil
;
24728 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
24730 overlay
= overlay_vec
[i
];
24731 help
= Foverlay_get (overlay
, Qhelp_echo
);
24736 help_echo_string
= help
;
24737 help_echo_window
= window
;
24738 help_echo_object
= overlay
;
24739 help_echo_pos
= pos
;
24743 Lisp_Object object
= glyph
->object
;
24744 int charpos
= glyph
->charpos
;
24746 /* Try text properties. */
24747 if (STRINGP (object
)
24749 && charpos
< SCHARS (object
))
24751 help
= Fget_text_property (make_number (charpos
),
24752 Qhelp_echo
, object
);
24755 /* If the string itself doesn't specify a help-echo,
24756 see if the buffer text ``under'' it does. */
24757 struct glyph_row
*r
24758 = MATRIX_ROW (w
->current_matrix
, vpos
);
24759 int start
= MATRIX_ROW_START_CHARPOS (r
);
24760 EMACS_INT pos
= string_buffer_position (w
, object
, start
);
24763 help
= Fget_char_property (make_number (pos
),
24764 Qhelp_echo
, w
->buffer
);
24768 object
= w
->buffer
;
24773 else if (BUFFERP (object
)
24776 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
24781 help_echo_string
= help
;
24782 help_echo_window
= window
;
24783 help_echo_object
= object
;
24784 help_echo_pos
= charpos
;
24789 /* Look for a `pointer' property. */
24790 if (NILP (pointer
))
24792 /* Check overlays first. */
24793 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
24794 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
24796 if (NILP (pointer
))
24798 Lisp_Object object
= glyph
->object
;
24799 int charpos
= glyph
->charpos
;
24801 /* Try text properties. */
24802 if (STRINGP (object
)
24804 && charpos
< SCHARS (object
))
24806 pointer
= Fget_text_property (make_number (charpos
),
24808 if (NILP (pointer
))
24810 /* If the string itself doesn't specify a pointer,
24811 see if the buffer text ``under'' it does. */
24812 struct glyph_row
*r
24813 = MATRIX_ROW (w
->current_matrix
, vpos
);
24814 int start
= MATRIX_ROW_START_CHARPOS (r
);
24815 EMACS_INT pos
= string_buffer_position (w
, object
,
24818 pointer
= Fget_char_property (make_number (pos
),
24819 Qpointer
, w
->buffer
);
24822 else if (BUFFERP (object
)
24825 pointer
= Fget_text_property (make_number (charpos
),
24832 current_buffer
= obuf
;
24837 define_frame_cursor1 (f
, cursor
, pointer
);
24842 Clear any mouse-face on window W. This function is part of the
24843 redisplay interface, and is called from try_window_id and similar
24844 functions to ensure the mouse-highlight is off. */
24847 x_clear_window_mouse_face (w
)
24850 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
24851 Lisp_Object window
;
24854 XSETWINDOW (window
, w
);
24855 if (EQ (window
, dpyinfo
->mouse_face_window
))
24856 clear_mouse_face (dpyinfo
);
24862 Just discard the mouse face information for frame F, if any.
24863 This is used when the size of F is changed. */
24866 cancel_mouse_face (f
)
24869 Lisp_Object window
;
24870 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24872 window
= dpyinfo
->mouse_face_window
;
24873 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
24875 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
24876 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
24877 dpyinfo
->mouse_face_window
= Qnil
;
24882 #endif /* HAVE_WINDOW_SYSTEM */
24885 /***********************************************************************
24887 ***********************************************************************/
24889 #ifdef HAVE_WINDOW_SYSTEM
24891 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
24892 which intersects rectangle R. R is in window-relative coordinates. */
24895 expose_area (w
, row
, r
, area
)
24897 struct glyph_row
*row
;
24899 enum glyph_row_area area
;
24901 struct glyph
*first
= row
->glyphs
[area
];
24902 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
24903 struct glyph
*last
;
24904 int first_x
, start_x
, x
;
24906 if (area
== TEXT_AREA
&& row
->fill_line_p
)
24907 /* If row extends face to end of line write the whole line. */
24908 draw_glyphs (w
, 0, row
, area
,
24909 0, row
->used
[area
],
24910 DRAW_NORMAL_TEXT
, 0);
24913 /* Set START_X to the window-relative start position for drawing glyphs of
24914 AREA. The first glyph of the text area can be partially visible.
24915 The first glyphs of other areas cannot. */
24916 start_x
= window_box_left_offset (w
, area
);
24918 if (area
== TEXT_AREA
)
24921 /* Find the first glyph that must be redrawn. */
24923 && x
+ first
->pixel_width
< r
->x
)
24925 x
+= first
->pixel_width
;
24929 /* Find the last one. */
24933 && x
< r
->x
+ r
->width
)
24935 x
+= last
->pixel_width
;
24941 draw_glyphs (w
, first_x
- start_x
, row
, area
,
24942 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
24943 DRAW_NORMAL_TEXT
, 0);
24948 /* Redraw the parts of the glyph row ROW on window W intersecting
24949 rectangle R. R is in window-relative coordinates. Value is
24950 non-zero if mouse-face was overwritten. */
24953 expose_line (w
, row
, r
)
24955 struct glyph_row
*row
;
24958 xassert (row
->enabled_p
);
24960 if (row
->mode_line_p
|| w
->pseudo_window_p
)
24961 draw_glyphs (w
, 0, row
, TEXT_AREA
,
24962 0, row
->used
[TEXT_AREA
],
24963 DRAW_NORMAL_TEXT
, 0);
24966 if (row
->used
[LEFT_MARGIN_AREA
])
24967 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
24968 if (row
->used
[TEXT_AREA
])
24969 expose_area (w
, row
, r
, TEXT_AREA
);
24970 if (row
->used
[RIGHT_MARGIN_AREA
])
24971 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
24972 draw_row_fringe_bitmaps (w
, row
);
24975 return row
->mouse_face_p
;
24979 /* Redraw those parts of glyphs rows during expose event handling that
24980 overlap other rows. Redrawing of an exposed line writes over parts
24981 of lines overlapping that exposed line; this function fixes that.
24983 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
24984 row in W's current matrix that is exposed and overlaps other rows.
24985 LAST_OVERLAPPING_ROW is the last such row. */
24988 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
, r
)
24990 struct glyph_row
*first_overlapping_row
;
24991 struct glyph_row
*last_overlapping_row
;
24994 struct glyph_row
*row
;
24996 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
24997 if (row
->overlapping_p
)
24999 xassert (row
->enabled_p
&& !row
->mode_line_p
);
25002 if (row
->used
[LEFT_MARGIN_AREA
])
25003 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
25005 if (row
->used
[TEXT_AREA
])
25006 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
25008 if (row
->used
[RIGHT_MARGIN_AREA
])
25009 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
25015 /* Return non-zero if W's cursor intersects rectangle R. */
25018 phys_cursor_in_rect_p (w
, r
)
25022 XRectangle cr
, result
;
25023 struct glyph
*cursor_glyph
;
25024 struct glyph_row
*row
;
25026 if (w
->phys_cursor
.vpos
>= 0
25027 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
25028 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
25030 && row
->cursor_in_fringe_p
)
25032 /* Cursor is in the fringe. */
25033 cr
.x
= window_box_right_offset (w
,
25034 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
25035 ? RIGHT_MARGIN_AREA
25038 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
25039 cr
.height
= row
->height
;
25040 return x_intersect_rectangles (&cr
, r
, &result
);
25043 cursor_glyph
= get_phys_cursor_glyph (w
);
25046 /* r is relative to W's box, but w->phys_cursor.x is relative
25047 to left edge of W's TEXT area. Adjust it. */
25048 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
25049 cr
.y
= w
->phys_cursor
.y
;
25050 cr
.width
= cursor_glyph
->pixel_width
;
25051 cr
.height
= w
->phys_cursor_height
;
25052 /* ++KFS: W32 version used W32-specific IntersectRect here, but
25053 I assume the effect is the same -- and this is portable. */
25054 return x_intersect_rectangles (&cr
, r
, &result
);
25056 /* If we don't understand the format, pretend we're not in the hot-spot. */
25062 Draw a vertical window border to the right of window W if W doesn't
25063 have vertical scroll bars. */
25066 x_draw_vertical_border (w
)
25069 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25071 /* We could do better, if we knew what type of scroll-bar the adjacent
25072 windows (on either side) have... But we don't :-(
25073 However, I think this works ok. ++KFS 2003-04-25 */
25075 /* Redraw borders between horizontally adjacent windows. Don't
25076 do it for frames with vertical scroll bars because either the
25077 right scroll bar of a window, or the left scroll bar of its
25078 neighbor will suffice as a border. */
25079 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
25082 if (!WINDOW_RIGHTMOST_P (w
)
25083 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
25085 int x0
, x1
, y0
, y1
;
25087 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25090 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25093 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
25095 else if (!WINDOW_LEFTMOST_P (w
)
25096 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
25098 int x0
, x1
, y0
, y1
;
25100 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25103 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25106 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
25111 /* Redraw the part of window W intersection rectangle FR. Pixel
25112 coordinates in FR are frame-relative. Call this function with
25113 input blocked. Value is non-zero if the exposure overwrites
25117 expose_window (w
, fr
)
25121 struct frame
*f
= XFRAME (w
->frame
);
25123 int mouse_face_overwritten_p
= 0;
25125 /* If window is not yet fully initialized, do nothing. This can
25126 happen when toolkit scroll bars are used and a window is split.
25127 Reconfiguring the scroll bar will generate an expose for a newly
25129 if (w
->current_matrix
== NULL
)
25132 /* When we're currently updating the window, display and current
25133 matrix usually don't agree. Arrange for a thorough display
25135 if (w
== updated_window
)
25137 SET_FRAME_GARBAGED (f
);
25141 /* Frame-relative pixel rectangle of W. */
25142 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
25143 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
25144 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
25145 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
25147 if (x_intersect_rectangles (fr
, &wr
, &r
))
25149 int yb
= window_text_bottom_y (w
);
25150 struct glyph_row
*row
;
25151 int cursor_cleared_p
;
25152 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
25154 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
25155 r
.x
, r
.y
, r
.width
, r
.height
));
25157 /* Convert to window coordinates. */
25158 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
25159 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
25161 /* Turn off the cursor. */
25162 if (!w
->pseudo_window_p
25163 && phys_cursor_in_rect_p (w
, &r
))
25165 x_clear_cursor (w
);
25166 cursor_cleared_p
= 1;
25169 cursor_cleared_p
= 0;
25171 /* Update lines intersecting rectangle R. */
25172 first_overlapping_row
= last_overlapping_row
= NULL
;
25173 for (row
= w
->current_matrix
->rows
;
25178 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
25180 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
25181 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
25182 || (r
.y
>= y0
&& r
.y
< y1
)
25183 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
25185 /* A header line may be overlapping, but there is no need
25186 to fix overlapping areas for them. KFS 2005-02-12 */
25187 if (row
->overlapping_p
&& !row
->mode_line_p
)
25189 if (first_overlapping_row
== NULL
)
25190 first_overlapping_row
= row
;
25191 last_overlapping_row
= row
;
25195 if (expose_line (w
, row
, &r
))
25196 mouse_face_overwritten_p
= 1;
25199 else if (row
->overlapping_p
)
25201 /* We must redraw a row overlapping the exposed area. */
25203 ? y0
+ row
->phys_height
> r
.y
25204 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
25206 if (first_overlapping_row
== NULL
)
25207 first_overlapping_row
= row
;
25208 last_overlapping_row
= row
;
25216 /* Display the mode line if there is one. */
25217 if (WINDOW_WANTS_MODELINE_P (w
)
25218 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
25220 && row
->y
< r
.y
+ r
.height
)
25222 if (expose_line (w
, row
, &r
))
25223 mouse_face_overwritten_p
= 1;
25226 if (!w
->pseudo_window_p
)
25228 /* Fix the display of overlapping rows. */
25229 if (first_overlapping_row
)
25230 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
25233 /* Draw border between windows. */
25234 x_draw_vertical_border (w
);
25236 /* Turn the cursor on again. */
25237 if (cursor_cleared_p
)
25238 update_window_cursor (w
, 1);
25242 return mouse_face_overwritten_p
;
25247 /* Redraw (parts) of all windows in the window tree rooted at W that
25248 intersect R. R contains frame pixel coordinates. Value is
25249 non-zero if the exposure overwrites mouse-face. */
25252 expose_window_tree (w
, r
)
25256 struct frame
*f
= XFRAME (w
->frame
);
25257 int mouse_face_overwritten_p
= 0;
25259 while (w
&& !FRAME_GARBAGED_P (f
))
25261 if (!NILP (w
->hchild
))
25262 mouse_face_overwritten_p
25263 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
25264 else if (!NILP (w
->vchild
))
25265 mouse_face_overwritten_p
25266 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
25268 mouse_face_overwritten_p
|= expose_window (w
, r
);
25270 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
25273 return mouse_face_overwritten_p
;
25278 Redisplay an exposed area of frame F. X and Y are the upper-left
25279 corner of the exposed rectangle. W and H are width and height of
25280 the exposed area. All are pixel values. W or H zero means redraw
25281 the entire frame. */
25284 expose_frame (f
, x
, y
, w
, h
)
25289 int mouse_face_overwritten_p
= 0;
25291 TRACE ((stderr
, "expose_frame "));
25293 /* No need to redraw if frame will be redrawn soon. */
25294 if (FRAME_GARBAGED_P (f
))
25296 TRACE ((stderr
, " garbaged\n"));
25300 /* If basic faces haven't been realized yet, there is no point in
25301 trying to redraw anything. This can happen when we get an expose
25302 event while Emacs is starting, e.g. by moving another window. */
25303 if (FRAME_FACE_CACHE (f
) == NULL
25304 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
25306 TRACE ((stderr
, " no faces\n"));
25310 if (w
== 0 || h
== 0)
25313 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
25314 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
25324 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
25325 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
25327 if (WINDOWP (f
->tool_bar_window
))
25328 mouse_face_overwritten_p
25329 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
25331 #ifdef HAVE_X_WINDOWS
25333 #ifndef USE_X_TOOLKIT
25334 if (WINDOWP (f
->menu_bar_window
))
25335 mouse_face_overwritten_p
25336 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
25337 #endif /* not USE_X_TOOLKIT */
25341 /* Some window managers support a focus-follows-mouse style with
25342 delayed raising of frames. Imagine a partially obscured frame,
25343 and moving the mouse into partially obscured mouse-face on that
25344 frame. The visible part of the mouse-face will be highlighted,
25345 then the WM raises the obscured frame. With at least one WM, KDE
25346 2.1, Emacs is not getting any event for the raising of the frame
25347 (even tried with SubstructureRedirectMask), only Expose events.
25348 These expose events will draw text normally, i.e. not
25349 highlighted. Which means we must redo the highlight here.
25350 Subsume it under ``we love X''. --gerd 2001-08-15 */
25351 /* Included in Windows version because Windows most likely does not
25352 do the right thing if any third party tool offers
25353 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
25354 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
25356 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25357 if (f
== dpyinfo
->mouse_face_mouse_frame
)
25359 int x
= dpyinfo
->mouse_face_mouse_x
;
25360 int y
= dpyinfo
->mouse_face_mouse_y
;
25361 clear_mouse_face (dpyinfo
);
25362 note_mouse_highlight (f
, x
, y
);
25369 Determine the intersection of two rectangles R1 and R2. Return
25370 the intersection in *RESULT. Value is non-zero if RESULT is not
25374 x_intersect_rectangles (r1
, r2
, result
)
25375 XRectangle
*r1
, *r2
, *result
;
25377 XRectangle
*left
, *right
;
25378 XRectangle
*upper
, *lower
;
25379 int intersection_p
= 0;
25381 /* Rearrange so that R1 is the left-most rectangle. */
25383 left
= r1
, right
= r2
;
25385 left
= r2
, right
= r1
;
25387 /* X0 of the intersection is right.x0, if this is inside R1,
25388 otherwise there is no intersection. */
25389 if (right
->x
<= left
->x
+ left
->width
)
25391 result
->x
= right
->x
;
25393 /* The right end of the intersection is the minimum of the
25394 the right ends of left and right. */
25395 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
25398 /* Same game for Y. */
25400 upper
= r1
, lower
= r2
;
25402 upper
= r2
, lower
= r1
;
25404 /* The upper end of the intersection is lower.y0, if this is inside
25405 of upper. Otherwise, there is no intersection. */
25406 if (lower
->y
<= upper
->y
+ upper
->height
)
25408 result
->y
= lower
->y
;
25410 /* The lower end of the intersection is the minimum of the lower
25411 ends of upper and lower. */
25412 result
->height
= (min (lower
->y
+ lower
->height
,
25413 upper
->y
+ upper
->height
)
25415 intersection_p
= 1;
25419 return intersection_p
;
25422 #endif /* HAVE_WINDOW_SYSTEM */
25425 /***********************************************************************
25427 ***********************************************************************/
25432 Vwith_echo_area_save_vector
= Qnil
;
25433 staticpro (&Vwith_echo_area_save_vector
);
25435 Vmessage_stack
= Qnil
;
25436 staticpro (&Vmessage_stack
);
25438 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
25439 staticpro (&Qinhibit_redisplay
);
25441 message_dolog_marker1
= Fmake_marker ();
25442 staticpro (&message_dolog_marker1
);
25443 message_dolog_marker2
= Fmake_marker ();
25444 staticpro (&message_dolog_marker2
);
25445 message_dolog_marker3
= Fmake_marker ();
25446 staticpro (&message_dolog_marker3
);
25449 defsubr (&Sdump_frame_glyph_matrix
);
25450 defsubr (&Sdump_glyph_matrix
);
25451 defsubr (&Sdump_glyph_row
);
25452 defsubr (&Sdump_tool_bar_row
);
25453 defsubr (&Strace_redisplay
);
25454 defsubr (&Strace_to_stderr
);
25456 #ifdef HAVE_WINDOW_SYSTEM
25457 defsubr (&Stool_bar_lines_needed
);
25458 defsubr (&Slookup_image_map
);
25460 defsubr (&Sformat_mode_line
);
25461 defsubr (&Sinvisible_p
);
25463 staticpro (&Qmenu_bar_update_hook
);
25464 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
25466 staticpro (&Qoverriding_terminal_local_map
);
25467 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
25469 staticpro (&Qoverriding_local_map
);
25470 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
25472 staticpro (&Qwindow_scroll_functions
);
25473 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
25475 staticpro (&Qwindow_text_change_functions
);
25476 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
25478 staticpro (&Qredisplay_end_trigger_functions
);
25479 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
25481 staticpro (&Qinhibit_point_motion_hooks
);
25482 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
25484 Qeval
= intern_c_string ("eval");
25485 staticpro (&Qeval
);
25487 QCdata
= intern_c_string (":data");
25488 staticpro (&QCdata
);
25489 Qdisplay
= intern_c_string ("display");
25490 staticpro (&Qdisplay
);
25491 Qspace_width
= intern_c_string ("space-width");
25492 staticpro (&Qspace_width
);
25493 Qraise
= intern_c_string ("raise");
25494 staticpro (&Qraise
);
25495 Qslice
= intern_c_string ("slice");
25496 staticpro (&Qslice
);
25497 Qspace
= intern_c_string ("space");
25498 staticpro (&Qspace
);
25499 Qmargin
= intern_c_string ("margin");
25500 staticpro (&Qmargin
);
25501 Qpointer
= intern_c_string ("pointer");
25502 staticpro (&Qpointer
);
25503 Qleft_margin
= intern_c_string ("left-margin");
25504 staticpro (&Qleft_margin
);
25505 Qright_margin
= intern_c_string ("right-margin");
25506 staticpro (&Qright_margin
);
25507 Qcenter
= intern_c_string ("center");
25508 staticpro (&Qcenter
);
25509 Qline_height
= intern_c_string ("line-height");
25510 staticpro (&Qline_height
);
25511 QCalign_to
= intern_c_string (":align-to");
25512 staticpro (&QCalign_to
);
25513 QCrelative_width
= intern_c_string (":relative-width");
25514 staticpro (&QCrelative_width
);
25515 QCrelative_height
= intern_c_string (":relative-height");
25516 staticpro (&QCrelative_height
);
25517 QCeval
= intern_c_string (":eval");
25518 staticpro (&QCeval
);
25519 QCpropertize
= intern_c_string (":propertize");
25520 staticpro (&QCpropertize
);
25521 QCfile
= intern_c_string (":file");
25522 staticpro (&QCfile
);
25523 Qfontified
= intern_c_string ("fontified");
25524 staticpro (&Qfontified
);
25525 Qfontification_functions
= intern_c_string ("fontification-functions");
25526 staticpro (&Qfontification_functions
);
25527 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
25528 staticpro (&Qtrailing_whitespace
);
25529 Qescape_glyph
= intern_c_string ("escape-glyph");
25530 staticpro (&Qescape_glyph
);
25531 Qnobreak_space
= intern_c_string ("nobreak-space");
25532 staticpro (&Qnobreak_space
);
25533 Qimage
= intern_c_string ("image");
25534 staticpro (&Qimage
);
25535 QCmap
= intern_c_string (":map");
25536 staticpro (&QCmap
);
25537 QCpointer
= intern_c_string (":pointer");
25538 staticpro (&QCpointer
);
25539 Qrect
= intern_c_string ("rect");
25540 staticpro (&Qrect
);
25541 Qcircle
= intern_c_string ("circle");
25542 staticpro (&Qcircle
);
25543 Qpoly
= intern_c_string ("poly");
25544 staticpro (&Qpoly
);
25545 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
25546 staticpro (&Qmessage_truncate_lines
);
25547 Qgrow_only
= intern_c_string ("grow-only");
25548 staticpro (&Qgrow_only
);
25549 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
25550 staticpro (&Qinhibit_menubar_update
);
25551 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
25552 staticpro (&Qinhibit_eval_during_redisplay
);
25553 Qposition
= intern_c_string ("position");
25554 staticpro (&Qposition
);
25555 Qbuffer_position
= intern_c_string ("buffer-position");
25556 staticpro (&Qbuffer_position
);
25557 Qobject
= intern_c_string ("object");
25558 staticpro (&Qobject
);
25559 Qbar
= intern_c_string ("bar");
25561 Qhbar
= intern_c_string ("hbar");
25562 staticpro (&Qhbar
);
25563 Qbox
= intern_c_string ("box");
25565 Qhollow
= intern_c_string ("hollow");
25566 staticpro (&Qhollow
);
25567 Qhand
= intern_c_string ("hand");
25568 staticpro (&Qhand
);
25569 Qarrow
= intern_c_string ("arrow");
25570 staticpro (&Qarrow
);
25571 Qtext
= intern_c_string ("text");
25572 staticpro (&Qtext
);
25573 Qrisky_local_variable
= intern_c_string ("risky-local-variable");
25574 staticpro (&Qrisky_local_variable
);
25575 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
25576 staticpro (&Qinhibit_free_realized_faces
);
25578 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
25579 Fcons (intern_c_string ("void-variable"), Qnil
)),
25581 staticpro (&list_of_error
);
25583 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
25584 staticpro (&Qlast_arrow_position
);
25585 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
25586 staticpro (&Qlast_arrow_string
);
25588 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
25589 staticpro (&Qoverlay_arrow_string
);
25590 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
25591 staticpro (&Qoverlay_arrow_bitmap
);
25593 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
25594 staticpro (&echo_buffer
[0]);
25595 staticpro (&echo_buffer
[1]);
25597 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
25598 staticpro (&echo_area_buffer
[0]);
25599 staticpro (&echo_area_buffer
[1]);
25601 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
25602 staticpro (&Vmessages_buffer_name
);
25604 mode_line_proptrans_alist
= Qnil
;
25605 staticpro (&mode_line_proptrans_alist
);
25606 mode_line_string_list
= Qnil
;
25607 staticpro (&mode_line_string_list
);
25608 mode_line_string_face
= Qnil
;
25609 staticpro (&mode_line_string_face
);
25610 mode_line_string_face_prop
= Qnil
;
25611 staticpro (&mode_line_string_face_prop
);
25612 Vmode_line_unwind_vector
= Qnil
;
25613 staticpro (&Vmode_line_unwind_vector
);
25615 help_echo_string
= Qnil
;
25616 staticpro (&help_echo_string
);
25617 help_echo_object
= Qnil
;
25618 staticpro (&help_echo_object
);
25619 help_echo_window
= Qnil
;
25620 staticpro (&help_echo_window
);
25621 previous_help_echo_string
= Qnil
;
25622 staticpro (&previous_help_echo_string
);
25623 help_echo_pos
= -1;
25625 Qright_to_left
= intern_c_string ("right-to-left");
25626 staticpro (&Qright_to_left
);
25627 Qleft_to_right
= intern_c_string ("left-to-right");
25628 staticpro (&Qleft_to_right
);
25630 #ifdef HAVE_WINDOW_SYSTEM
25631 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
25632 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
25633 For example, if a block cursor is over a tab, it will be drawn as
25634 wide as that tab on the display. */);
25635 x_stretch_cursor_p
= 0;
25638 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
25639 doc
: /* *Non-nil means highlight trailing whitespace.
25640 The face used for trailing whitespace is `trailing-whitespace'. */);
25641 Vshow_trailing_whitespace
= Qnil
;
25643 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
25644 doc
: /* *Control highlighting of nobreak space and soft hyphen.
25645 A value of t means highlight the character itself (for nobreak space,
25646 use face `nobreak-space').
25647 A value of nil means no highlighting.
25648 Other values mean display the escape glyph followed by an ordinary
25649 space or ordinary hyphen. */);
25650 Vnobreak_char_display
= Qt
;
25652 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
25653 doc
: /* *The pointer shape to show in void text areas.
25654 A value of nil means to show the text pointer. Other options are `arrow',
25655 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
25656 Vvoid_text_area_pointer
= Qarrow
;
25658 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
25659 doc
: /* Non-nil means don't actually do any redisplay.
25660 This is used for internal purposes. */);
25661 Vinhibit_redisplay
= Qnil
;
25663 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
25664 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
25665 Vglobal_mode_string
= Qnil
;
25667 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
25668 doc
: /* Marker for where to display an arrow on top of the buffer text.
25669 This must be the beginning of a line in order to work.
25670 See also `overlay-arrow-string'. */);
25671 Voverlay_arrow_position
= Qnil
;
25673 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
25674 doc
: /* String to display as an arrow in non-window frames.
25675 See also `overlay-arrow-position'. */);
25676 Voverlay_arrow_string
= make_pure_c_string ("=>");
25678 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
25679 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
25680 The symbols on this list are examined during redisplay to determine
25681 where to display overlay arrows. */);
25682 Voverlay_arrow_variable_list
25683 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
25685 DEFVAR_INT ("scroll-step", &scroll_step
,
25686 doc
: /* *The number of lines to try scrolling a window by when point moves out.
25687 If that fails to bring point back on frame, point is centered instead.
25688 If this is zero, point is always centered after it moves off frame.
25689 If you want scrolling to always be a line at a time, you should set
25690 `scroll-conservatively' to a large value rather than set this to 1. */);
25692 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
25693 doc
: /* *Scroll up to this many lines, to bring point back on screen.
25694 If point moves off-screen, redisplay will scroll by up to
25695 `scroll-conservatively' lines in order to bring point just barely
25696 onto the screen again. If that cannot be done, then redisplay
25697 recenters point as usual.
25699 A value of zero means always recenter point if it moves off screen. */);
25700 scroll_conservatively
= 0;
25702 DEFVAR_INT ("scroll-margin", &scroll_margin
,
25703 doc
: /* *Number of lines of margin at the top and bottom of a window.
25704 Recenter the window whenever point gets within this many lines
25705 of the top or bottom of the window. */);
25708 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
25709 doc
: /* Pixels per inch value for non-window system displays.
25710 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
25711 Vdisplay_pixels_per_inch
= make_float (72.0);
25714 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
25717 DEFVAR_LISP ("truncate-partial-width-windows",
25718 &Vtruncate_partial_width_windows
,
25719 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
25720 For an integer value, truncate lines in each window narrower than the
25721 full frame width, provided the window width is less than that integer;
25722 otherwise, respect the value of `truncate-lines'.
25724 For any other non-nil value, truncate lines in all windows that do
25725 not span the full frame width.
25727 A value of nil means to respect the value of `truncate-lines'.
25729 If `word-wrap' is enabled, you might want to reduce this. */);
25730 Vtruncate_partial_width_windows
= make_number (50);
25732 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
25733 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
25734 Any other value means to use the appropriate face, `mode-line',
25735 `header-line', or `menu' respectively. */);
25736 mode_line_inverse_video
= 1;
25738 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
25739 doc
: /* *Maximum buffer size for which line number should be displayed.
25740 If the buffer is bigger than this, the line number does not appear
25741 in the mode line. A value of nil means no limit. */);
25742 Vline_number_display_limit
= Qnil
;
25744 DEFVAR_INT ("line-number-display-limit-width",
25745 &line_number_display_limit_width
,
25746 doc
: /* *Maximum line width (in characters) for line number display.
25747 If the average length of the lines near point is bigger than this, then the
25748 line number may be omitted from the mode line. */);
25749 line_number_display_limit_width
= 200;
25751 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
25752 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
25753 highlight_nonselected_windows
= 0;
25755 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
25756 doc
: /* Non-nil if more than one frame is visible on this display.
25757 Minibuffer-only frames don't count, but iconified frames do.
25758 This variable is not guaranteed to be accurate except while processing
25759 `frame-title-format' and `icon-title-format'. */);
25761 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
25762 doc
: /* Template for displaying the title bar of visible frames.
25763 \(Assuming the window manager supports this feature.)
25765 This variable has the same structure as `mode-line-format', except that
25766 the %c and %l constructs are ignored. It is used only on frames for
25767 which no explicit name has been set \(see `modify-frame-parameters'). */);
25769 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
25770 doc
: /* Template for displaying the title bar of an iconified frame.
25771 \(Assuming the window manager supports this feature.)
25772 This variable has the same structure as `mode-line-format' (which see),
25773 and is used only on frames for which no explicit name has been set
25774 \(see `modify-frame-parameters'). */);
25776 = Vframe_title_format
25777 = pure_cons (intern_c_string ("multiple-frames"),
25778 pure_cons (make_pure_c_string ("%b"),
25779 pure_cons (pure_cons (empty_unibyte_string
,
25780 pure_cons (intern_c_string ("invocation-name"),
25781 pure_cons (make_pure_c_string ("@"),
25782 pure_cons (intern_c_string ("system-name"),
25786 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
25787 doc
: /* Maximum number of lines to keep in the message log buffer.
25788 If nil, disable message logging. If t, log messages but don't truncate
25789 the buffer when it becomes large. */);
25790 Vmessage_log_max
= make_number (100);
25792 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
25793 doc
: /* Functions called before redisplay, if window sizes have changed.
25794 The value should be a list of functions that take one argument.
25795 Just before redisplay, for each frame, if any of its windows have changed
25796 size since the last redisplay, or have been split or deleted,
25797 all the functions in the list are called, with the frame as argument. */);
25798 Vwindow_size_change_functions
= Qnil
;
25800 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
25801 doc
: /* List of functions to call before redisplaying a window with scrolling.
25802 Each function is called with two arguments, the window and its new
25803 display-start position. Note that these functions are also called by
25804 `set-window-buffer'. Also note that the value of `window-end' is not
25805 valid when these functions are called. */);
25806 Vwindow_scroll_functions
= Qnil
;
25808 DEFVAR_LISP ("window-text-change-functions",
25809 &Vwindow_text_change_functions
,
25810 doc
: /* Functions to call in redisplay when text in the window might change. */);
25811 Vwindow_text_change_functions
= Qnil
;
25813 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
25814 doc
: /* Functions called when redisplay of a window reaches the end trigger.
25815 Each function is called with two arguments, the window and the end trigger value.
25816 See `set-window-redisplay-end-trigger'. */);
25817 Vredisplay_end_trigger_functions
= Qnil
;
25819 DEFVAR_LISP ("mouse-autoselect-window", &Vmouse_autoselect_window
,
25820 doc
: /* *Non-nil means autoselect window with mouse pointer.
25821 If nil, do not autoselect windows.
25822 A positive number means delay autoselection by that many seconds: a
25823 window is autoselected only after the mouse has remained in that
25824 window for the duration of the delay.
25825 A negative number has a similar effect, but causes windows to be
25826 autoselected only after the mouse has stopped moving. \(Because of
25827 the way Emacs compares mouse events, you will occasionally wait twice
25828 that time before the window gets selected.\)
25829 Any other value means to autoselect window instantaneously when the
25830 mouse pointer enters it.
25832 Autoselection selects the minibuffer only if it is active, and never
25833 unselects the minibuffer if it is active.
25835 When customizing this variable make sure that the actual value of
25836 `focus-follows-mouse' matches the behavior of your window manager. */);
25837 Vmouse_autoselect_window
= Qnil
;
25839 DEFVAR_LISP ("auto-resize-tool-bars", &Vauto_resize_tool_bars
,
25840 doc
: /* *Non-nil means automatically resize tool-bars.
25841 This dynamically changes the tool-bar's height to the minimum height
25842 that is needed to make all tool-bar items visible.
25843 If value is `grow-only', the tool-bar's height is only increased
25844 automatically; to decrease the tool-bar height, use \\[recenter]. */);
25845 Vauto_resize_tool_bars
= Qt
;
25847 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
25848 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
25849 auto_raise_tool_bar_buttons_p
= 1;
25851 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
25852 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
25853 make_cursor_line_fully_visible_p
= 1;
25855 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
25856 doc
: /* *Border below tool-bar in pixels.
25857 If an integer, use it as the height of the border.
25858 If it is one of `internal-border-width' or `border-width', use the
25859 value of the corresponding frame parameter.
25860 Otherwise, no border is added below the tool-bar. */);
25861 Vtool_bar_border
= Qinternal_border_width
;
25863 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
25864 doc
: /* *Margin around tool-bar buttons in pixels.
25865 If an integer, use that for both horizontal and vertical margins.
25866 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
25867 HORZ specifying the horizontal margin, and VERT specifying the
25868 vertical margin. */);
25869 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
25871 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
25872 doc
: /* *Relief thickness of tool-bar buttons. */);
25873 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
25875 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
25876 doc
: /* List of functions to call to fontify regions of text.
25877 Each function is called with one argument POS. Functions must
25878 fontify a region starting at POS in the current buffer, and give
25879 fontified regions the property `fontified'. */);
25880 Vfontification_functions
= Qnil
;
25881 Fmake_variable_buffer_local (Qfontification_functions
);
25883 DEFVAR_BOOL ("unibyte-display-via-language-environment",
25884 &unibyte_display_via_language_environment
,
25885 doc
: /* *Non-nil means display unibyte text according to language environment.
25886 Specifically, this means that raw bytes in the range 160-255 decimal
25887 are displayed by converting them to the equivalent multibyte characters
25888 according to the current language environment. As a result, they are
25889 displayed according to the current fontset.
25891 Note that this variable affects only how these bytes are displayed,
25892 but does not change the fact they are interpreted as raw bytes. */);
25893 unibyte_display_via_language_environment
= 0;
25895 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
25896 doc
: /* *Maximum height for resizing mini-windows.
25897 If a float, it specifies a fraction of the mini-window frame's height.
25898 If an integer, it specifies a number of lines. */);
25899 Vmax_mini_window_height
= make_float (0.25);
25901 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
25902 doc
: /* *How to resize mini-windows.
25903 A value of nil means don't automatically resize mini-windows.
25904 A value of t means resize them to fit the text displayed in them.
25905 A value of `grow-only', the default, means let mini-windows grow
25906 only, until their display becomes empty, at which point the windows
25907 go back to their normal size. */);
25908 Vresize_mini_windows
= Qgrow_only
;
25910 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
25911 doc
: /* Alist specifying how to blink the cursor off.
25912 Each element has the form (ON-STATE . OFF-STATE). Whenever the
25913 `cursor-type' frame-parameter or variable equals ON-STATE,
25914 comparing using `equal', Emacs uses OFF-STATE to specify
25915 how to blink it off. ON-STATE and OFF-STATE are values for
25916 the `cursor-type' frame parameter.
25918 If a frame's ON-STATE has no entry in this list,
25919 the frame's other specifications determine how to blink the cursor off. */);
25920 Vblink_cursor_alist
= Qnil
;
25922 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
25923 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
25924 automatic_hscrolling_p
= 1;
25925 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
25926 staticpro (&Qauto_hscroll_mode
);
25928 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
25929 doc
: /* *How many columns away from the window edge point is allowed to get
25930 before automatic hscrolling will horizontally scroll the window. */);
25931 hscroll_margin
= 5;
25933 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
25934 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
25935 When point is less than `hscroll-margin' columns from the window
25936 edge, automatic hscrolling will scroll the window by the amount of columns
25937 determined by this variable. If its value is a positive integer, scroll that
25938 many columns. If it's a positive floating-point number, it specifies the
25939 fraction of the window's width to scroll. If it's nil or zero, point will be
25940 centered horizontally after the scroll. Any other value, including negative
25941 numbers, are treated as if the value were zero.
25943 Automatic hscrolling always moves point outside the scroll margin, so if
25944 point was more than scroll step columns inside the margin, the window will
25945 scroll more than the value given by the scroll step.
25947 Note that the lower bound for automatic hscrolling specified by `scroll-left'
25948 and `scroll-right' overrides this variable's effect. */);
25949 Vhscroll_step
= make_number (0);
25951 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
25952 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
25953 Bind this around calls to `message' to let it take effect. */);
25954 message_truncate_lines
= 0;
25956 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
25957 doc
: /* Normal hook run to update the menu bar definitions.
25958 Redisplay runs this hook before it redisplays the menu bar.
25959 This is used to update submenus such as Buffers,
25960 whose contents depend on various data. */);
25961 Vmenu_bar_update_hook
= Qnil
;
25963 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
25964 doc
: /* Frame for which we are updating a menu.
25965 The enable predicate for a menu binding should check this variable. */);
25966 Vmenu_updating_frame
= Qnil
;
25968 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
25969 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
25970 inhibit_menubar_update
= 0;
25972 DEFVAR_LISP ("wrap-prefix", &Vwrap_prefix
,
25973 doc
: /* Prefix prepended to all continuation lines at display time.
25974 The value may be a string, an image, or a stretch-glyph; it is
25975 interpreted in the same way as the value of a `display' text property.
25977 This variable is overridden by any `wrap-prefix' text or overlay
25980 To add a prefix to non-continuation lines, use `line-prefix'. */);
25981 Vwrap_prefix
= Qnil
;
25982 staticpro (&Qwrap_prefix
);
25983 Qwrap_prefix
= intern_c_string ("wrap-prefix");
25984 Fmake_variable_buffer_local (Qwrap_prefix
);
25986 DEFVAR_LISP ("line-prefix", &Vline_prefix
,
25987 doc
: /* Prefix prepended to all non-continuation lines at display time.
25988 The value may be a string, an image, or a stretch-glyph; it is
25989 interpreted in the same way as the value of a `display' text property.
25991 This variable is overridden by any `line-prefix' text or overlay
25994 To add a prefix to continuation lines, use `wrap-prefix'. */);
25995 Vline_prefix
= Qnil
;
25996 staticpro (&Qline_prefix
);
25997 Qline_prefix
= intern_c_string ("line-prefix");
25998 Fmake_variable_buffer_local (Qline_prefix
);
26000 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
26001 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
26002 inhibit_eval_during_redisplay
= 0;
26004 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
26005 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
26006 inhibit_free_realized_faces
= 0;
26009 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
26010 doc
: /* Inhibit try_window_id display optimization. */);
26011 inhibit_try_window_id
= 0;
26013 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
26014 doc
: /* Inhibit try_window_reusing display optimization. */);
26015 inhibit_try_window_reusing
= 0;
26017 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
26018 doc
: /* Inhibit try_cursor_movement display optimization. */);
26019 inhibit_try_cursor_movement
= 0;
26020 #endif /* GLYPH_DEBUG */
26022 DEFVAR_INT ("overline-margin", &overline_margin
,
26023 doc
: /* *Space between overline and text, in pixels.
26024 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
26025 margin to the caracter height. */);
26026 overline_margin
= 2;
26028 DEFVAR_INT ("underline-minimum-offset",
26029 &underline_minimum_offset
,
26030 doc
: /* Minimum distance between baseline and underline.
26031 This can improve legibility of underlined text at small font sizes,
26032 particularly when using variable `x-use-underline-position-properties'
26033 with fonts that specify an UNDERLINE_POSITION relatively close to the
26034 baseline. The default value is 1. */);
26035 underline_minimum_offset
= 1;
26037 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p
,
26038 doc
: /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
26039 display_hourglass_p
= 1;
26041 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay
,
26042 doc
: /* *Seconds to wait before displaying an hourglass pointer.
26043 Value must be an integer or float. */);
26044 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
26046 hourglass_atimer
= NULL
;
26047 hourglass_shown_p
= 0;
26051 /* Initialize this module when Emacs starts. */
26056 Lisp_Object root_window
;
26057 struct window
*mini_w
;
26059 current_header_line_height
= current_mode_line_height
= -1;
26061 CHARPOS (this_line_start_pos
) = 0;
26063 mini_w
= XWINDOW (minibuf_window
);
26064 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
26066 if (!noninteractive
)
26068 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
26071 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
26072 set_window_height (root_window
,
26073 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
26075 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
26076 set_window_height (minibuf_window
, 1, 0);
26078 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
26079 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
26081 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
26082 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
26083 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
26085 /* The default ellipsis glyphs `...'. */
26086 for (i
= 0; i
< 3; ++i
)
26087 default_invis_vector
[i
] = make_number ('.');
26091 /* Allocate the buffer for frame titles.
26092 Also used for `format-mode-line'. */
26094 mode_line_noprop_buf
= (char *) xmalloc (size
);
26095 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
26096 mode_line_noprop_ptr
= mode_line_noprop_buf
;
26097 mode_line_target
= MODE_LINE_DISPLAY
;
26100 help_echo_showing_p
= 0;
26103 /* Since w32 does not support atimers, it defines its own implementation of
26104 the following three functions in w32fns.c. */
26107 /* Platform-independent portion of hourglass implementation. */
26109 /* Return non-zero if houglass timer has been started or hourglass is shown. */
26111 hourglass_started ()
26113 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
26116 /* Cancel a currently active hourglass timer, and start a new one. */
26120 #if defined (HAVE_WINDOW_SYSTEM)
26122 int secs
, usecs
= 0;
26124 cancel_hourglass ();
26126 if (INTEGERP (Vhourglass_delay
)
26127 && XINT (Vhourglass_delay
) > 0)
26128 secs
= XFASTINT (Vhourglass_delay
);
26129 else if (FLOATP (Vhourglass_delay
)
26130 && XFLOAT_DATA (Vhourglass_delay
) > 0)
26133 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
26134 secs
= XFASTINT (tem
);
26135 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
26138 secs
= DEFAULT_HOURGLASS_DELAY
;
26140 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
26141 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
26142 show_hourglass
, NULL
);
26147 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
26150 cancel_hourglass ()
26152 #if defined (HAVE_WINDOW_SYSTEM)
26153 if (hourglass_atimer
)
26155 cancel_atimer (hourglass_atimer
);
26156 hourglass_atimer
= NULL
;
26159 if (hourglass_shown_p
)
26163 #endif /* ! WINDOWSNT */
26165 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
26166 (do not change this comment) */