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. CHARPOS should be
6574 the last previously processed stop_pos (or BEGV, if none were
6575 processed yet) whose position is less that IT's current
6579 handle_stop_backwards (it
, charpos
)
6583 EMACS_INT where_we_are
= IT_CHARPOS (*it
);
6584 struct display_pos save_current
= it
->current
;
6585 struct text_pos save_position
= it
->position
;
6586 struct text_pos pos1
;
6587 EMACS_INT next_stop
;
6589 /* Scan in strict logical order. */
6593 it
->prev_stop
= charpos
;
6594 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
6595 reseat_1 (it
, pos1
, 0);
6596 compute_stop_pos (it
);
6597 /* We must advance forward, right? */
6598 if (it
->stop_charpos
<= it
->prev_stop
)
6600 charpos
= it
->stop_charpos
;
6602 while (charpos
<= where_we_are
);
6604 next_stop
= it
->stop_charpos
;
6605 it
->stop_charpos
= it
->prev_stop
;
6607 it
->current
= save_current
;
6608 it
->position
= save_position
;
6610 it
->stop_charpos
= next_stop
;
6613 /* Load IT with the next display element from current_buffer. Value
6614 is zero if end of buffer reached. IT->stop_charpos is the next
6615 position at which to stop and check for text properties or buffer
6619 next_element_from_buffer (it
)
6624 xassert (IT_CHARPOS (*it
) >= BEGV
);
6626 /* With bidi reordering, the character to display might not be the
6627 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
6628 we were reseat()ed to a new buffer position, which is potentially
6629 a different paragraph. */
6630 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6632 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6633 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6634 /* If we are at the beginning of a line, we can produce the next
6635 element right away. */
6636 if (it
->bidi_it
.bytepos
== BEGV_BYTE
6637 /* FIXME: Should support all Unicode line separators. */
6638 || FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6639 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')
6641 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6642 bidi_get_next_char_visually (&it
->bidi_it
);
6646 int orig_bytepos
= IT_BYTEPOS (*it
);
6648 /* We need to prime the bidi iterator starting at the line's
6649 beginning, before we will be able to produce the next
6651 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
), -1);
6652 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
6653 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6654 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6655 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6658 /* Now return to buffer position where we were asked to
6659 get the next display element, and produce that. */
6660 bidi_get_next_char_visually (&it
->bidi_it
);
6662 while (it
->bidi_it
.bytepos
!= orig_bytepos
6663 && it
->bidi_it
.bytepos
< ZV_BYTE
);
6666 it
->bidi_it
.first_elt
= 0; /* paranoia: bidi.c does this */
6667 /* Adjust IT's position information to where we ended up. */
6668 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6669 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6670 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6673 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6675 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6677 int overlay_strings_follow_p
;
6679 /* End of the game, except when overlay strings follow that
6680 haven't been returned yet. */
6681 if (it
->overlay_strings_at_end_processed_p
)
6682 overlay_strings_follow_p
= 0;
6685 it
->overlay_strings_at_end_processed_p
= 1;
6686 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6689 if (overlay_strings_follow_p
)
6690 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6694 it
->position
= it
->current
.pos
;
6698 else if (!(!it
->bidi_p
6699 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6700 || IT_CHARPOS (*it
) == it
->stop_charpos
))
6702 /* With bidi non-linear iteration, we could find ourselves
6703 far beyond the last computed stop_charpos, with several
6704 other stop positions in between that we missed. Scan
6705 them all now, in buffer's logical order, until we find
6706 and handle the last stop_charpos that precedes our
6707 current position. */
6708 handle_stop_backwards (it
, it
->stop_charpos
);
6709 return GET_NEXT_DISPLAY_ELEMENT (it
);
6715 /* Take note of the stop position we just moved across,
6716 for when we will move back across it. */
6717 it
->prev_stop
= it
->stop_charpos
;
6718 /* If we are at base paragraph embedding level, take
6719 note of the last stop position seen at this
6721 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6722 it
->base_level_stop
= it
->stop_charpos
;
6725 return GET_NEXT_DISPLAY_ELEMENT (it
);
6729 /* We can sometimes back up for reasons that have nothing
6730 to do with bidi reordering. E.g., compositions. The
6731 code below is only needed when we are above the base
6732 embedding level, so test for that explicitly. */
6733 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6734 && IT_CHARPOS (*it
) < it
->prev_stop
)
6736 if (it
->base_level_stop
<= 0)
6737 it
->base_level_stop
= BEGV
;
6738 if (IT_CHARPOS (*it
) < it
->base_level_stop
)
6740 handle_stop_backwards (it
, it
->base_level_stop
);
6741 return GET_NEXT_DISPLAY_ELEMENT (it
);
6745 /* No face changes, overlays etc. in sight, so just return a
6746 character from current_buffer. */
6749 /* Maybe run the redisplay end trigger hook. Performance note:
6750 This doesn't seem to cost measurable time. */
6751 if (it
->redisplay_end_trigger_charpos
6753 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6754 run_redisplay_end_trigger_hook (it
);
6756 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6758 && next_element_from_composition (it
))
6763 /* Get the next character, maybe multibyte. */
6764 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6765 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6766 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
6768 it
->c
= *p
, it
->len
= 1;
6770 /* Record what we have and where it came from. */
6771 it
->what
= IT_CHARACTER
;
6772 it
->object
= it
->w
->buffer
;
6773 it
->position
= it
->current
.pos
;
6775 /* Normally we return the character found above, except when we
6776 really want to return an ellipsis for selective display. */
6781 /* A value of selective > 0 means hide lines indented more
6782 than that number of columns. */
6783 if (it
->selective
> 0
6784 && IT_CHARPOS (*it
) + 1 < ZV
6785 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6786 IT_BYTEPOS (*it
) + 1,
6787 (double) it
->selective
)) /* iftc */
6789 success_p
= next_element_from_ellipsis (it
);
6790 it
->dpvec_char_len
= -1;
6793 else if (it
->c
== '\r' && it
->selective
== -1)
6795 /* A value of selective == -1 means that everything from the
6796 CR to the end of the line is invisible, with maybe an
6797 ellipsis displayed for it. */
6798 success_p
= next_element_from_ellipsis (it
);
6799 it
->dpvec_char_len
= -1;
6804 /* Value is zero if end of buffer reached. */
6805 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6810 /* Run the redisplay end trigger hook for IT. */
6813 run_redisplay_end_trigger_hook (it
)
6816 Lisp_Object args
[3];
6818 /* IT->glyph_row should be non-null, i.e. we should be actually
6819 displaying something, or otherwise we should not run the hook. */
6820 xassert (it
->glyph_row
);
6822 /* Set up hook arguments. */
6823 args
[0] = Qredisplay_end_trigger_functions
;
6824 args
[1] = it
->window
;
6825 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6826 it
->redisplay_end_trigger_charpos
= 0;
6828 /* Since we are *trying* to run these functions, don't try to run
6829 them again, even if they get an error. */
6830 it
->w
->redisplay_end_trigger
= Qnil
;
6831 Frun_hook_with_args (3, args
);
6833 /* Notice if it changed the face of the character we are on. */
6834 handle_face_prop (it
);
6838 /* Deliver a composition display element. Unlike the other
6839 next_element_from_XXX, this function is not registered in the array
6840 get_next_element[]. It is called from next_element_from_buffer and
6841 next_element_from_string when necessary. */
6844 next_element_from_composition (it
)
6847 it
->what
= IT_COMPOSITION
;
6848 it
->len
= it
->cmp_it
.nbytes
;
6849 if (STRINGP (it
->string
))
6853 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6854 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6857 it
->position
= it
->current
.string_pos
;
6858 it
->object
= it
->string
;
6859 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6860 IT_STRING_BYTEPOS (*it
), it
->string
);
6866 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6867 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6870 it
->position
= it
->current
.pos
;
6871 it
->object
= it
->w
->buffer
;
6872 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6873 IT_BYTEPOS (*it
), Qnil
);
6880 /***********************************************************************
6881 Moving an iterator without producing glyphs
6882 ***********************************************************************/
6884 /* Check if iterator is at a position corresponding to a valid buffer
6885 position after some move_it_ call. */
6887 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6888 ((it)->method == GET_FROM_STRING \
6889 ? IT_STRING_CHARPOS (*it) == 0 \
6893 /* Move iterator IT to a specified buffer or X position within one
6894 line on the display without producing glyphs.
6896 OP should be a bit mask including some or all of these bits:
6897 MOVE_TO_X: Stop upon reaching x-position TO_X.
6898 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
6899 Regardless of OP's value, stop upon reaching the end of the display line.
6901 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6902 This means, in particular, that TO_X includes window's horizontal
6905 The return value has several possible values that
6906 say what condition caused the scan to stop:
6908 MOVE_POS_MATCH_OR_ZV
6909 - when TO_POS or ZV was reached.
6912 -when TO_X was reached before TO_POS or ZV were reached.
6915 - when we reached the end of the display area and the line must
6919 - when we reached the end of the display area and the line is
6923 - when we stopped at a line end, i.e. a newline or a CR and selective
6926 static enum move_it_result
6927 move_it_in_display_line_to (struct it
*it
,
6928 EMACS_INT to_charpos
, int to_x
,
6929 enum move_operation_enum op
)
6931 enum move_it_result result
= MOVE_UNDEFINED
;
6932 struct glyph_row
*saved_glyph_row
;
6933 struct it wrap_it
, atpos_it
, atx_it
;
6935 enum it_method prev_method
= it
->method
;
6936 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
6938 /* Don't produce glyphs in produce_glyphs. */
6939 saved_glyph_row
= it
->glyph_row
;
6940 it
->glyph_row
= NULL
;
6942 /* Use wrap_it to save a copy of IT wherever a word wrap could
6943 occur. Use atpos_it to save a copy of IT at the desired buffer
6944 position, if found, so that we can scan ahead and check if the
6945 word later overshoots the window edge. Use atx_it similarly, for
6951 #define BUFFER_POS_REACHED_P() \
6952 ((op & MOVE_TO_POS) != 0 \
6953 && BUFFERP (it->object) \
6954 && (IT_CHARPOS (*it) == to_charpos \
6955 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
6956 && (it->method == GET_FROM_BUFFER \
6957 || (it->method == GET_FROM_DISPLAY_VECTOR \
6958 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6960 /* If there's a line-/wrap-prefix, handle it. */
6961 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
6962 && it
->current_y
< it
->last_visible_y
)
6963 handle_line_prefix (it
);
6967 int x
, i
, ascent
= 0, descent
= 0;
6969 /* Utility macro to reset an iterator with x, ascent, and descent. */
6970 #define IT_RESET_X_ASCENT_DESCENT(IT) \
6971 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
6972 (IT)->max_descent = descent)
6974 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
6976 if ((op
& MOVE_TO_POS
) != 0
6977 && BUFFERP (it
->object
)
6978 && it
->method
== GET_FROM_BUFFER
6979 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
6981 && (prev_method
== GET_FROM_IMAGE
6982 || prev_method
== GET_FROM_STRETCH
)
6983 /* Passed TO_CHARPOS from left to right. */
6984 && ((prev_pos
< to_charpos
6985 && IT_CHARPOS (*it
) > to_charpos
)
6986 /* Passed TO_CHARPOS from right to left. */
6987 || (prev_pos
> to_charpos
6988 && IT_CHARPOS (*it
) < to_charpos
)))))
6990 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6992 result
= MOVE_POS_MATCH_OR_ZV
;
6995 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
6996 /* If wrap_it is valid, the current position might be in a
6997 word that is wrapped. So, save the iterator in
6998 atpos_it and continue to see if wrapping happens. */
7002 prev_method
= it
->method
;
7003 if (it
->method
== GET_FROM_BUFFER
)
7004 prev_pos
= IT_CHARPOS (*it
);
7005 /* Stop when ZV reached.
7006 We used to stop here when TO_CHARPOS reached as well, but that is
7007 too soon if this glyph does not fit on this line. So we handle it
7008 explicitly below. */
7009 if (!get_next_display_element (it
))
7011 result
= MOVE_POS_MATCH_OR_ZV
;
7015 if (it
->line_wrap
== TRUNCATE
)
7017 if (BUFFER_POS_REACHED_P ())
7019 result
= MOVE_POS_MATCH_OR_ZV
;
7025 if (it
->line_wrap
== WORD_WRAP
)
7027 if (IT_DISPLAYING_WHITESPACE (it
))
7031 /* We have reached a glyph that follows one or more
7032 whitespace characters. If the position is
7033 already found, we are done. */
7034 if (atpos_it
.sp
>= 0)
7037 result
= MOVE_POS_MATCH_OR_ZV
;
7043 result
= MOVE_X_REACHED
;
7046 /* Otherwise, we can wrap here. */
7053 /* Remember the line height for the current line, in case
7054 the next element doesn't fit on the line. */
7055 ascent
= it
->max_ascent
;
7056 descent
= it
->max_descent
;
7058 /* The call to produce_glyphs will get the metrics of the
7059 display element IT is loaded with. Record the x-position
7060 before this display element, in case it doesn't fit on the
7064 PRODUCE_GLYPHS (it
);
7066 if (it
->area
!= TEXT_AREA
)
7068 set_iterator_to_next (it
, 1);
7072 /* The number of glyphs we get back in IT->nglyphs will normally
7073 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7074 character on a terminal frame, or (iii) a line end. For the
7075 second case, IT->nglyphs - 1 padding glyphs will be present.
7076 (On X frames, there is only one glyph produced for a
7077 composite character.)
7079 The behavior implemented below means, for continuation lines,
7080 that as many spaces of a TAB as fit on the current line are
7081 displayed there. For terminal frames, as many glyphs of a
7082 multi-glyph character are displayed in the current line, too.
7083 This is what the old redisplay code did, and we keep it that
7084 way. Under X, the whole shape of a complex character must
7085 fit on the line or it will be completely displayed in the
7088 Note that both for tabs and padding glyphs, all glyphs have
7092 /* More than one glyph or glyph doesn't fit on line. All
7093 glyphs have the same width. */
7094 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7096 int x_before_this_char
= x
;
7097 int hpos_before_this_char
= it
->hpos
;
7099 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7101 new_x
= x
+ single_glyph_width
;
7103 /* We want to leave anything reaching TO_X to the caller. */
7104 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7106 if (BUFFER_POS_REACHED_P ())
7108 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7109 goto buffer_pos_reached
;
7110 if (atpos_it
.sp
< 0)
7113 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7118 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7121 result
= MOVE_X_REACHED
;
7127 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7132 if (/* Lines are continued. */
7133 it
->line_wrap
!= TRUNCATE
7134 && (/* And glyph doesn't fit on the line. */
7135 new_x
> it
->last_visible_x
7136 /* Or it fits exactly and we're on a window
7138 || (new_x
== it
->last_visible_x
7139 && FRAME_WINDOW_P (it
->f
))))
7141 if (/* IT->hpos == 0 means the very first glyph
7142 doesn't fit on the line, e.g. a wide image. */
7144 || (new_x
== it
->last_visible_x
7145 && FRAME_WINDOW_P (it
->f
)))
7148 it
->current_x
= new_x
;
7150 /* The character's last glyph just barely fits
7152 if (i
== it
->nglyphs
- 1)
7154 /* If this is the destination position,
7155 return a position *before* it in this row,
7156 now that we know it fits in this row. */
7157 if (BUFFER_POS_REACHED_P ())
7159 if (it
->line_wrap
!= WORD_WRAP
7162 it
->hpos
= hpos_before_this_char
;
7163 it
->current_x
= x_before_this_char
;
7164 result
= MOVE_POS_MATCH_OR_ZV
;
7167 if (it
->line_wrap
== WORD_WRAP
7171 atpos_it
.current_x
= x_before_this_char
;
7172 atpos_it
.hpos
= hpos_before_this_char
;
7176 set_iterator_to_next (it
, 1);
7177 /* On graphical terminals, newlines may
7178 "overflow" into the fringe if
7179 overflow-newline-into-fringe is non-nil.
7180 On text-only terminals, newlines may
7181 overflow into the last glyph on the
7183 if (!FRAME_WINDOW_P (it
->f
)
7184 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7186 if (!get_next_display_element (it
))
7188 result
= MOVE_POS_MATCH_OR_ZV
;
7191 if (BUFFER_POS_REACHED_P ())
7193 if (ITERATOR_AT_END_OF_LINE_P (it
))
7194 result
= MOVE_POS_MATCH_OR_ZV
;
7196 result
= MOVE_LINE_CONTINUED
;
7199 if (ITERATOR_AT_END_OF_LINE_P (it
))
7201 result
= MOVE_NEWLINE_OR_CR
;
7208 IT_RESET_X_ASCENT_DESCENT (it
);
7210 if (wrap_it
.sp
>= 0)
7217 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7219 result
= MOVE_LINE_CONTINUED
;
7223 if (BUFFER_POS_REACHED_P ())
7225 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7226 goto buffer_pos_reached
;
7227 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7230 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7234 if (new_x
> it
->first_visible_x
)
7236 /* Glyph is visible. Increment number of glyphs that
7237 would be displayed. */
7242 if (result
!= MOVE_UNDEFINED
)
7245 else if (BUFFER_POS_REACHED_P ())
7248 IT_RESET_X_ASCENT_DESCENT (it
);
7249 result
= MOVE_POS_MATCH_OR_ZV
;
7252 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7254 /* Stop when TO_X specified and reached. This check is
7255 necessary here because of lines consisting of a line end,
7256 only. The line end will not produce any glyphs and we
7257 would never get MOVE_X_REACHED. */
7258 xassert (it
->nglyphs
== 0);
7259 result
= MOVE_X_REACHED
;
7263 /* Is this a line end? If yes, we're done. */
7264 if (ITERATOR_AT_END_OF_LINE_P (it
))
7266 result
= MOVE_NEWLINE_OR_CR
;
7270 if (it
->method
== GET_FROM_BUFFER
)
7271 prev_pos
= IT_CHARPOS (*it
);
7272 /* The current display element has been consumed. Advance
7274 set_iterator_to_next (it
, 1);
7276 /* Stop if lines are truncated and IT's current x-position is
7277 past the right edge of the window now. */
7278 if (it
->line_wrap
== TRUNCATE
7279 && it
->current_x
>= it
->last_visible_x
)
7281 if (!FRAME_WINDOW_P (it
->f
)
7282 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7284 if (!get_next_display_element (it
)
7285 || BUFFER_POS_REACHED_P ())
7287 result
= MOVE_POS_MATCH_OR_ZV
;
7290 if (ITERATOR_AT_END_OF_LINE_P (it
))
7292 result
= MOVE_NEWLINE_OR_CR
;
7296 result
= MOVE_LINE_TRUNCATED
;
7299 #undef IT_RESET_X_ASCENT_DESCENT
7302 #undef BUFFER_POS_REACHED_P
7304 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7305 restore the saved iterator. */
7306 if (atpos_it
.sp
>= 0)
7308 else if (atx_it
.sp
>= 0)
7313 /* Restore the iterator settings altered at the beginning of this
7315 it
->glyph_row
= saved_glyph_row
;
7319 /* For external use. */
7321 move_it_in_display_line (struct it
*it
,
7322 EMACS_INT to_charpos
, int to_x
,
7323 enum move_operation_enum op
)
7325 if (it
->line_wrap
== WORD_WRAP
7326 && (op
& MOVE_TO_X
))
7328 struct it save_it
= *it
;
7329 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7330 /* When word-wrap is on, TO_X may lie past the end
7331 of a wrapped line. Then it->current is the
7332 character on the next line, so backtrack to the
7333 space before the wrap point. */
7334 if (skip
== MOVE_LINE_CONTINUED
)
7336 int prev_x
= max (it
->current_x
- 1, 0);
7338 move_it_in_display_line_to
7339 (it
, -1, prev_x
, MOVE_TO_X
);
7343 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7347 /* Move IT forward until it satisfies one or more of the criteria in
7348 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7350 OP is a bit-mask that specifies where to stop, and in particular,
7351 which of those four position arguments makes a difference. See the
7352 description of enum move_operation_enum.
7354 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7355 screen line, this function will set IT to the next position >
7359 move_it_to (it
, to_charpos
, to_x
, to_y
, to_vpos
, op
)
7361 int to_charpos
, to_x
, to_y
, to_vpos
;
7364 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7365 int line_height
, line_start_x
= 0, reached
= 0;
7369 if (op
& MOVE_TO_VPOS
)
7371 /* If no TO_CHARPOS and no TO_X specified, stop at the
7372 start of the line TO_VPOS. */
7373 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7375 if (it
->vpos
== to_vpos
)
7381 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7385 /* TO_VPOS >= 0 means stop at TO_X in the line at
7386 TO_VPOS, or at TO_POS, whichever comes first. */
7387 if (it
->vpos
== to_vpos
)
7393 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7395 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7400 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7402 /* We have reached TO_X but not in the line we want. */
7403 skip
= move_it_in_display_line_to (it
, to_charpos
,
7405 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7413 else if (op
& MOVE_TO_Y
)
7415 struct it it_backup
;
7417 if (it
->line_wrap
== WORD_WRAP
)
7420 /* TO_Y specified means stop at TO_X in the line containing
7421 TO_Y---or at TO_CHARPOS if this is reached first. The
7422 problem is that we can't really tell whether the line
7423 contains TO_Y before we have completely scanned it, and
7424 this may skip past TO_X. What we do is to first scan to
7427 If TO_X is not specified, use a TO_X of zero. The reason
7428 is to make the outcome of this function more predictable.
7429 If we didn't use TO_X == 0, we would stop at the end of
7430 the line which is probably not what a caller would expect
7432 skip
= move_it_in_display_line_to
7433 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7434 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7436 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7437 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7439 else if (skip
== MOVE_X_REACHED
)
7441 /* If TO_X was reached, we want to know whether TO_Y is
7442 in the line. We know this is the case if the already
7443 scanned glyphs make the line tall enough. Otherwise,
7444 we must check by scanning the rest of the line. */
7445 line_height
= it
->max_ascent
+ it
->max_descent
;
7446 if (to_y
>= it
->current_y
7447 && to_y
< it
->current_y
+ line_height
)
7453 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7454 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7456 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7457 line_height
= it
->max_ascent
+ it
->max_descent
;
7458 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7460 if (to_y
>= it
->current_y
7461 && to_y
< it
->current_y
+ line_height
)
7463 /* If TO_Y is in this line and TO_X was reached
7464 above, we scanned too far. We have to restore
7465 IT's settings to the ones before skipping. */
7472 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7478 /* Check whether TO_Y is in this line. */
7479 line_height
= it
->max_ascent
+ it
->max_descent
;
7480 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7482 if (to_y
>= it
->current_y
7483 && to_y
< it
->current_y
+ line_height
)
7485 /* When word-wrap is on, TO_X may lie past the end
7486 of a wrapped line. Then it->current is the
7487 character on the next line, so backtrack to the
7488 space before the wrap point. */
7489 if (skip
== MOVE_LINE_CONTINUED
7490 && it
->line_wrap
== WORD_WRAP
)
7492 int prev_x
= max (it
->current_x
- 1, 0);
7494 skip
= move_it_in_display_line_to
7495 (it
, -1, prev_x
, MOVE_TO_X
);
7504 else if (BUFFERP (it
->object
)
7505 && (it
->method
== GET_FROM_BUFFER
7506 || it
->method
== GET_FROM_STRETCH
)
7507 && IT_CHARPOS (*it
) >= to_charpos
)
7508 skip
= MOVE_POS_MATCH_OR_ZV
;
7510 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7514 case MOVE_POS_MATCH_OR_ZV
:
7518 case MOVE_NEWLINE_OR_CR
:
7519 set_iterator_to_next (it
, 1);
7520 it
->continuation_lines_width
= 0;
7523 case MOVE_LINE_TRUNCATED
:
7524 it
->continuation_lines_width
= 0;
7525 reseat_at_next_visible_line_start (it
, 0);
7526 if ((op
& MOVE_TO_POS
) != 0
7527 && IT_CHARPOS (*it
) > to_charpos
)
7534 case MOVE_LINE_CONTINUED
:
7535 /* For continued lines ending in a tab, some of the glyphs
7536 associated with the tab are displayed on the current
7537 line. Since it->current_x does not include these glyphs,
7538 we use it->last_visible_x instead. */
7541 it
->continuation_lines_width
+= it
->last_visible_x
;
7542 /* When moving by vpos, ensure that the iterator really
7543 advances to the next line (bug#847, bug#969). Fixme:
7544 do we need to do this in other circumstances? */
7545 if (it
->current_x
!= it
->last_visible_x
7546 && (op
& MOVE_TO_VPOS
)
7547 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7549 line_start_x
= it
->current_x
+ it
->pixel_width
7550 - it
->last_visible_x
;
7551 set_iterator_to_next (it
, 0);
7555 it
->continuation_lines_width
+= it
->current_x
;
7562 /* Reset/increment for the next run. */
7563 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7564 it
->current_x
= line_start_x
;
7567 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7569 last_height
= it
->max_ascent
+ it
->max_descent
;
7570 last_max_ascent
= it
->max_ascent
;
7571 it
->max_ascent
= it
->max_descent
= 0;
7576 /* On text terminals, we may stop at the end of a line in the middle
7577 of a multi-character glyph. If the glyph itself is continued,
7578 i.e. it is actually displayed on the next line, don't treat this
7579 stopping point as valid; move to the next line instead (unless
7580 that brings us offscreen). */
7581 if (!FRAME_WINDOW_P (it
->f
)
7583 && IT_CHARPOS (*it
) == to_charpos
7584 && it
->what
== IT_CHARACTER
7586 && it
->line_wrap
== WINDOW_WRAP
7587 && it
->current_x
== it
->last_visible_x
- 1
7590 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7592 it
->continuation_lines_width
+= it
->current_x
;
7593 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7594 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7596 last_height
= it
->max_ascent
+ it
->max_descent
;
7597 last_max_ascent
= it
->max_ascent
;
7600 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7604 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7606 If DY > 0, move IT backward at least that many pixels. DY = 0
7607 means move IT backward to the preceding line start or BEGV. This
7608 function may move over more than DY pixels if IT->current_y - DY
7609 ends up in the middle of a line; in this case IT->current_y will be
7610 set to the top of the line moved to. */
7613 move_it_vertically_backward (it
, dy
)
7624 start_pos
= IT_CHARPOS (*it
);
7626 /* Estimate how many newlines we must move back. */
7627 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7629 /* Set the iterator's position that many lines back. */
7630 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7631 back_to_previous_visible_line_start (it
);
7633 /* Reseat the iterator here. When moving backward, we don't want
7634 reseat to skip forward over invisible text, set up the iterator
7635 to deliver from overlay strings at the new position etc. So,
7636 use reseat_1 here. */
7637 reseat_1 (it
, it
->current
.pos
, 1);
7639 /* We are now surely at a line start. */
7640 it
->current_x
= it
->hpos
= 0;
7641 it
->continuation_lines_width
= 0;
7643 /* Move forward and see what y-distance we moved. First move to the
7644 start of the next line so that we get its height. We need this
7645 height to be able to tell whether we reached the specified
7648 it2
.max_ascent
= it2
.max_descent
= 0;
7651 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7652 MOVE_TO_POS
| MOVE_TO_VPOS
);
7654 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7655 xassert (IT_CHARPOS (*it
) >= BEGV
);
7658 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7659 xassert (IT_CHARPOS (*it
) >= BEGV
);
7660 /* H is the actual vertical distance from the position in *IT
7661 and the starting position. */
7662 h
= it2
.current_y
- it
->current_y
;
7663 /* NLINES is the distance in number of lines. */
7664 nlines
= it2
.vpos
- it
->vpos
;
7666 /* Correct IT's y and vpos position
7667 so that they are relative to the starting point. */
7673 /* DY == 0 means move to the start of the screen line. The
7674 value of nlines is > 0 if continuation lines were involved. */
7676 move_it_by_lines (it
, nlines
, 1);
7680 /* The y-position we try to reach, relative to *IT.
7681 Note that H has been subtracted in front of the if-statement. */
7682 int target_y
= it
->current_y
+ h
- dy
;
7683 int y0
= it3
.current_y
;
7684 int y1
= line_bottom_y (&it3
);
7685 int line_height
= y1
- y0
;
7687 /* If we did not reach target_y, try to move further backward if
7688 we can. If we moved too far backward, try to move forward. */
7689 if (target_y
< it
->current_y
7690 /* This is heuristic. In a window that's 3 lines high, with
7691 a line height of 13 pixels each, recentering with point
7692 on the bottom line will try to move -39/2 = 19 pixels
7693 backward. Try to avoid moving into the first line. */
7694 && (it
->current_y
- target_y
7695 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7696 && IT_CHARPOS (*it
) > BEGV
)
7698 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7699 target_y
- it
->current_y
));
7700 dy
= it
->current_y
- target_y
;
7701 goto move_further_back
;
7703 else if (target_y
>= it
->current_y
+ line_height
7704 && IT_CHARPOS (*it
) < ZV
)
7706 /* Should move forward by at least one line, maybe more.
7708 Note: Calling move_it_by_lines can be expensive on
7709 terminal frames, where compute_motion is used (via
7710 vmotion) to do the job, when there are very long lines
7711 and truncate-lines is nil. That's the reason for
7712 treating terminal frames specially here. */
7714 if (!FRAME_WINDOW_P (it
->f
))
7715 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7720 move_it_by_lines (it
, 1, 1);
7722 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7729 /* Move IT by a specified amount of pixel lines DY. DY negative means
7730 move backwards. DY = 0 means move to start of screen line. At the
7731 end, IT will be on the start of a screen line. */
7734 move_it_vertically (it
, dy
)
7739 move_it_vertically_backward (it
, -dy
);
7742 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7743 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7744 MOVE_TO_POS
| MOVE_TO_Y
);
7745 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7747 /* If buffer ends in ZV without a newline, move to the start of
7748 the line to satisfy the post-condition. */
7749 if (IT_CHARPOS (*it
) == ZV
7751 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7752 move_it_by_lines (it
, 0, 0);
7757 /* Move iterator IT past the end of the text line it is in. */
7760 move_it_past_eol (it
)
7763 enum move_it_result rc
;
7765 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7766 if (rc
== MOVE_NEWLINE_OR_CR
)
7767 set_iterator_to_next (it
, 0);
7771 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7772 negative means move up. DVPOS == 0 means move to the start of the
7773 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7774 NEED_Y_P is zero, IT->current_y will be left unchanged.
7776 Further optimization ideas: If we would know that IT->f doesn't use
7777 a face with proportional font, we could be faster for
7778 truncate-lines nil. */
7781 move_it_by_lines (it
, dvpos
, need_y_p
)
7783 int dvpos
, need_y_p
;
7785 struct position pos
;
7787 /* The commented-out optimization uses vmotion on terminals. This
7788 gives bad results, because elements like it->what, on which
7789 callers such as pos_visible_p rely, aren't updated. */
7790 /* if (!FRAME_WINDOW_P (it->f))
7792 struct text_pos textpos;
7794 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7795 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7796 reseat (it, textpos, 1);
7797 it->vpos += pos.vpos;
7798 it->current_y += pos.vpos;
7804 /* DVPOS == 0 means move to the start of the screen line. */
7805 move_it_vertically_backward (it
, 0);
7806 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7807 /* Let next call to line_bottom_y calculate real line height */
7812 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7813 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7814 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7819 int start_charpos
, i
;
7821 /* Start at the beginning of the screen line containing IT's
7822 position. This may actually move vertically backwards,
7823 in case of overlays, so adjust dvpos accordingly. */
7825 move_it_vertically_backward (it
, 0);
7828 /* Go back -DVPOS visible lines and reseat the iterator there. */
7829 start_charpos
= IT_CHARPOS (*it
);
7830 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7831 back_to_previous_visible_line_start (it
);
7832 reseat (it
, it
->current
.pos
, 1);
7834 /* Move further back if we end up in a string or an image. */
7835 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7837 /* First try to move to start of display line. */
7839 move_it_vertically_backward (it
, 0);
7841 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7843 /* If start of line is still in string or image,
7844 move further back. */
7845 back_to_previous_visible_line_start (it
);
7846 reseat (it
, it
->current
.pos
, 1);
7850 it
->current_x
= it
->hpos
= 0;
7852 /* Above call may have moved too far if continuation lines
7853 are involved. Scan forward and see if it did. */
7855 it2
.vpos
= it2
.current_y
= 0;
7856 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7857 it
->vpos
-= it2
.vpos
;
7858 it
->current_y
-= it2
.current_y
;
7859 it
->current_x
= it
->hpos
= 0;
7861 /* If we moved too far back, move IT some lines forward. */
7862 if (it2
.vpos
> -dvpos
)
7864 int delta
= it2
.vpos
+ dvpos
;
7866 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7867 /* Move back again if we got too far ahead. */
7868 if (IT_CHARPOS (*it
) >= start_charpos
)
7874 /* Return 1 if IT points into the middle of a display vector. */
7877 in_display_vector_p (it
)
7880 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7881 && it
->current
.dpvec_index
> 0
7882 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7886 /***********************************************************************
7888 ***********************************************************************/
7891 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7895 add_to_log (format
, arg1
, arg2
)
7897 Lisp_Object arg1
, arg2
;
7899 Lisp_Object args
[3];
7900 Lisp_Object msg
, fmt
;
7903 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7906 /* Do nothing if called asynchronously. Inserting text into
7907 a buffer may call after-change-functions and alike and
7908 that would means running Lisp asynchronously. */
7909 if (handling_signal
)
7913 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7915 args
[0] = fmt
= build_string (format
);
7918 msg
= Fformat (3, args
);
7920 len
= SBYTES (msg
) + 1;
7921 SAFE_ALLOCA (buffer
, char *, len
);
7922 bcopy (SDATA (msg
), buffer
, len
);
7924 message_dolog (buffer
, len
- 1, 1, 0);
7931 /* Output a newline in the *Messages* buffer if "needs" one. */
7934 message_log_maybe_newline ()
7936 if (message_log_need_newline
)
7937 message_dolog ("", 0, 1, 0);
7941 /* Add a string M of length NBYTES to the message log, optionally
7942 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7943 nonzero, means interpret the contents of M as multibyte. This
7944 function calls low-level routines in order to bypass text property
7945 hooks, etc. which might not be safe to run.
7947 This may GC (insert may run before/after change hooks),
7948 so the buffer M must NOT point to a Lisp string. */
7951 message_dolog (m
, nbytes
, nlflag
, multibyte
)
7953 int nbytes
, nlflag
, multibyte
;
7955 if (!NILP (Vmemory_full
))
7958 if (!NILP (Vmessage_log_max
))
7960 struct buffer
*oldbuf
;
7961 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7962 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7963 int point_at_end
= 0;
7965 Lisp_Object old_deactivate_mark
, tem
;
7966 struct gcpro gcpro1
;
7968 old_deactivate_mark
= Vdeactivate_mark
;
7969 oldbuf
= current_buffer
;
7970 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7971 current_buffer
->undo_list
= Qt
;
7973 oldpoint
= message_dolog_marker1
;
7974 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7975 oldbegv
= message_dolog_marker2
;
7976 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7977 oldzv
= message_dolog_marker3
;
7978 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7979 GCPRO1 (old_deactivate_mark
);
7987 BEGV_BYTE
= BEG_BYTE
;
7990 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7992 /* Insert the string--maybe converting multibyte to single byte
7993 or vice versa, so that all the text fits the buffer. */
7995 && NILP (current_buffer
->enable_multibyte_characters
))
7997 int i
, c
, char_bytes
;
7998 unsigned char work
[1];
8000 /* Convert a multibyte string to single-byte
8001 for the *Message* buffer. */
8002 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
8004 c
= string_char_and_length (m
+ i
, &char_bytes
);
8005 work
[0] = (ASCII_CHAR_P (c
)
8007 : multibyte_char_to_unibyte (c
, Qnil
));
8008 insert_1_both (work
, 1, 1, 1, 0, 0);
8011 else if (! multibyte
8012 && ! NILP (current_buffer
->enable_multibyte_characters
))
8014 int i
, c
, char_bytes
;
8015 unsigned char *msg
= (unsigned char *) m
;
8016 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8017 /* Convert a single-byte string to multibyte
8018 for the *Message* buffer. */
8019 for (i
= 0; i
< nbytes
; i
++)
8022 MAKE_CHAR_MULTIBYTE (c
);
8023 char_bytes
= CHAR_STRING (c
, str
);
8024 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
8028 insert_1 (m
, nbytes
, 1, 0, 0);
8032 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
8033 insert_1 ("\n", 1, 1, 0, 0);
8035 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8037 this_bol_byte
= PT_BYTE
;
8039 /* See if this line duplicates the previous one.
8040 If so, combine duplicates. */
8043 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8045 prev_bol_byte
= PT_BYTE
;
8047 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
8048 this_bol
, this_bol_byte
);
8051 del_range_both (prev_bol
, prev_bol_byte
,
8052 this_bol
, this_bol_byte
, 0);
8058 /* If you change this format, don't forget to also
8059 change message_log_check_duplicate. */
8060 sprintf (dupstr
, " [%d times]", dup
);
8061 duplen
= strlen (dupstr
);
8062 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8063 insert_1 (dupstr
, duplen
, 1, 0, 1);
8068 /* If we have more than the desired maximum number of lines
8069 in the *Messages* buffer now, delete the oldest ones.
8070 This is safe because we don't have undo in this buffer. */
8072 if (NATNUMP (Vmessage_log_max
))
8074 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8075 -XFASTINT (Vmessage_log_max
) - 1, 0);
8076 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8079 BEGV
= XMARKER (oldbegv
)->charpos
;
8080 BEGV_BYTE
= marker_byte_position (oldbegv
);
8089 ZV
= XMARKER (oldzv
)->charpos
;
8090 ZV_BYTE
= marker_byte_position (oldzv
);
8094 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8096 /* We can't do Fgoto_char (oldpoint) because it will run some
8098 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8099 XMARKER (oldpoint
)->bytepos
);
8102 unchain_marker (XMARKER (oldpoint
));
8103 unchain_marker (XMARKER (oldbegv
));
8104 unchain_marker (XMARKER (oldzv
));
8106 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8107 set_buffer_internal (oldbuf
);
8109 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8110 message_log_need_newline
= !nlflag
;
8111 Vdeactivate_mark
= old_deactivate_mark
;
8116 /* We are at the end of the buffer after just having inserted a newline.
8117 (Note: We depend on the fact we won't be crossing the gap.)
8118 Check to see if the most recent message looks a lot like the previous one.
8119 Return 0 if different, 1 if the new one should just replace it, or a
8120 value N > 1 if we should also append " [N times]". */
8123 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
8124 int prev_bol
, this_bol
;
8125 int prev_bol_byte
, this_bol_byte
;
8128 int len
= Z_BYTE
- 1 - this_bol_byte
;
8130 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8131 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8133 for (i
= 0; i
< len
; i
++)
8135 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8143 if (*p1
++ == ' ' && *p1
++ == '[')
8146 while (*p1
>= '0' && *p1
<= '9')
8147 n
= n
* 10 + *p1
++ - '0';
8148 if (strncmp (p1
, " times]\n", 8) == 0)
8155 /* Display an echo area message M with a specified length of NBYTES
8156 bytes. The string may include null characters. If M is 0, clear
8157 out any existing message, and let the mini-buffer text show
8160 This may GC, so the buffer M must NOT point to a Lisp string. */
8163 message2 (m
, nbytes
, multibyte
)
8168 /* First flush out any partial line written with print. */
8169 message_log_maybe_newline ();
8171 message_dolog (m
, nbytes
, 1, multibyte
);
8172 message2_nolog (m
, nbytes
, multibyte
);
8176 /* The non-logging counterpart of message2. */
8179 message2_nolog (m
, nbytes
, multibyte
)
8181 int nbytes
, multibyte
;
8183 struct frame
*sf
= SELECTED_FRAME ();
8184 message_enable_multibyte
= multibyte
;
8186 if (FRAME_INITIAL_P (sf
))
8188 if (noninteractive_need_newline
)
8189 putc ('\n', stderr
);
8190 noninteractive_need_newline
= 0;
8192 fwrite (m
, nbytes
, 1, stderr
);
8193 if (cursor_in_echo_area
== 0)
8194 fprintf (stderr
, "\n");
8197 /* A null message buffer means that the frame hasn't really been
8198 initialized yet. Error messages get reported properly by
8199 cmd_error, so this must be just an informative message; toss it. */
8200 else if (INTERACTIVE
8201 && sf
->glyphs_initialized_p
8202 && FRAME_MESSAGE_BUF (sf
))
8204 Lisp_Object mini_window
;
8207 /* Get the frame containing the mini-buffer
8208 that the selected frame is using. */
8209 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8210 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8212 FRAME_SAMPLE_VISIBILITY (f
);
8213 if (FRAME_VISIBLE_P (sf
)
8214 && ! FRAME_VISIBLE_P (f
))
8215 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8219 set_message (m
, Qnil
, nbytes
, multibyte
);
8220 if (minibuffer_auto_raise
)
8221 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8224 clear_message (1, 1);
8226 do_pending_window_change (0);
8227 echo_area_display (1);
8228 do_pending_window_change (0);
8229 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8230 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8235 /* Display an echo area message M with a specified length of NBYTES
8236 bytes. The string may include null characters. If M is not a
8237 string, clear out any existing message, and let the mini-buffer
8240 This function cancels echoing. */
8243 message3 (m
, nbytes
, multibyte
)
8248 struct gcpro gcpro1
;
8251 clear_message (1,1);
8254 /* First flush out any partial line written with print. */
8255 message_log_maybe_newline ();
8261 SAFE_ALLOCA (buffer
, char *, nbytes
);
8262 bcopy (SDATA (m
), buffer
, nbytes
);
8263 message_dolog (buffer
, nbytes
, 1, multibyte
);
8266 message3_nolog (m
, nbytes
, multibyte
);
8272 /* The non-logging version of message3.
8273 This does not cancel echoing, because it is used for echoing.
8274 Perhaps we need to make a separate function for echoing
8275 and make this cancel echoing. */
8278 message3_nolog (m
, nbytes
, multibyte
)
8280 int nbytes
, multibyte
;
8282 struct frame
*sf
= SELECTED_FRAME ();
8283 message_enable_multibyte
= multibyte
;
8285 if (FRAME_INITIAL_P (sf
))
8287 if (noninteractive_need_newline
)
8288 putc ('\n', stderr
);
8289 noninteractive_need_newline
= 0;
8291 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8292 if (cursor_in_echo_area
== 0)
8293 fprintf (stderr
, "\n");
8296 /* A null message buffer means that the frame hasn't really been
8297 initialized yet. Error messages get reported properly by
8298 cmd_error, so this must be just an informative message; toss it. */
8299 else if (INTERACTIVE
8300 && sf
->glyphs_initialized_p
8301 && FRAME_MESSAGE_BUF (sf
))
8303 Lisp_Object mini_window
;
8307 /* Get the frame containing the mini-buffer
8308 that the selected frame is using. */
8309 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8310 frame
= XWINDOW (mini_window
)->frame
;
8313 FRAME_SAMPLE_VISIBILITY (f
);
8314 if (FRAME_VISIBLE_P (sf
)
8315 && !FRAME_VISIBLE_P (f
))
8316 Fmake_frame_visible (frame
);
8318 if (STRINGP (m
) && SCHARS (m
) > 0)
8320 set_message (NULL
, m
, nbytes
, multibyte
);
8321 if (minibuffer_auto_raise
)
8322 Fraise_frame (frame
);
8323 /* Assume we are not echoing.
8324 (If we are, echo_now will override this.) */
8325 echo_message_buffer
= Qnil
;
8328 clear_message (1, 1);
8330 do_pending_window_change (0);
8331 echo_area_display (1);
8332 do_pending_window_change (0);
8333 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8334 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8339 /* Display a null-terminated echo area message M. If M is 0, clear
8340 out any existing message, and let the mini-buffer text show through.
8342 The buffer M must continue to exist until after the echo area gets
8343 cleared or some other message gets displayed there. Do not pass
8344 text that is stored in a Lisp string. Do not pass text in a buffer
8345 that was alloca'd. */
8351 message2 (m
, (m
? strlen (m
) : 0), 0);
8355 /* The non-logging counterpart of message1. */
8361 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8364 /* Display a message M which contains a single %s
8365 which gets replaced with STRING. */
8368 message_with_string (m
, string
, log
)
8373 CHECK_STRING (string
);
8379 if (noninteractive_need_newline
)
8380 putc ('\n', stderr
);
8381 noninteractive_need_newline
= 0;
8382 fprintf (stderr
, m
, SDATA (string
));
8383 if (!cursor_in_echo_area
)
8384 fprintf (stderr
, "\n");
8388 else if (INTERACTIVE
)
8390 /* The frame whose minibuffer we're going to display the message on.
8391 It may be larger than the selected frame, so we need
8392 to use its buffer, not the selected frame's buffer. */
8393 Lisp_Object mini_window
;
8394 struct frame
*f
, *sf
= SELECTED_FRAME ();
8396 /* Get the frame containing the minibuffer
8397 that the selected frame is using. */
8398 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8399 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8401 /* A null message buffer means that the frame hasn't really been
8402 initialized yet. Error messages get reported properly by
8403 cmd_error, so this must be just an informative message; toss it. */
8404 if (FRAME_MESSAGE_BUF (f
))
8406 Lisp_Object args
[2], message
;
8407 struct gcpro gcpro1
, gcpro2
;
8409 args
[0] = build_string (m
);
8410 args
[1] = message
= string
;
8411 GCPRO2 (args
[0], message
);
8414 message
= Fformat (2, args
);
8417 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8419 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8423 /* Print should start at the beginning of the message
8424 buffer next time. */
8425 message_buf_print
= 0;
8431 /* Dump an informative message to the minibuf. If M is 0, clear out
8432 any existing message, and let the mini-buffer text show through. */
8436 message (m
, a1
, a2
, a3
)
8438 EMACS_INT a1
, a2
, a3
;
8444 if (noninteractive_need_newline
)
8445 putc ('\n', stderr
);
8446 noninteractive_need_newline
= 0;
8447 fprintf (stderr
, m
, a1
, a2
, a3
);
8448 if (cursor_in_echo_area
== 0)
8449 fprintf (stderr
, "\n");
8453 else if (INTERACTIVE
)
8455 /* The frame whose mini-buffer we're going to display the message
8456 on. It may be larger than the selected frame, so we need to
8457 use its buffer, not the selected frame's buffer. */
8458 Lisp_Object mini_window
;
8459 struct frame
*f
, *sf
= SELECTED_FRAME ();
8461 /* Get the frame containing the mini-buffer
8462 that the selected frame is using. */
8463 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8464 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8466 /* A null message buffer means that the frame hasn't really been
8467 initialized yet. Error messages get reported properly by
8468 cmd_error, so this must be just an informative message; toss
8470 if (FRAME_MESSAGE_BUF (f
))
8481 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8482 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
8484 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8485 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3,
8487 #endif /* NO_ARG_ARRAY */
8489 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8494 /* Print should start at the beginning of the message
8495 buffer next time. */
8496 message_buf_print
= 0;
8502 /* The non-logging version of message. */
8505 message_nolog (m
, a1
, a2
, a3
)
8507 EMACS_INT a1
, a2
, a3
;
8509 Lisp_Object old_log_max
;
8510 old_log_max
= Vmessage_log_max
;
8511 Vmessage_log_max
= Qnil
;
8512 message (m
, a1
, a2
, a3
);
8513 Vmessage_log_max
= old_log_max
;
8517 /* Display the current message in the current mini-buffer. This is
8518 only called from error handlers in process.c, and is not time
8524 if (!NILP (echo_area_buffer
[0]))
8527 string
= Fcurrent_message ();
8528 message3 (string
, SBYTES (string
),
8529 !NILP (current_buffer
->enable_multibyte_characters
));
8534 /* Make sure echo area buffers in `echo_buffers' are live.
8535 If they aren't, make new ones. */
8538 ensure_echo_area_buffers ()
8542 for (i
= 0; i
< 2; ++i
)
8543 if (!BUFFERP (echo_buffer
[i
])
8544 || NILP (XBUFFER (echo_buffer
[i
])->name
))
8547 Lisp_Object old_buffer
;
8550 old_buffer
= echo_buffer
[i
];
8551 sprintf (name
, " *Echo Area %d*", i
);
8552 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8553 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
8554 /* to force word wrap in echo area -
8555 it was decided to postpone this*/
8556 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8558 for (j
= 0; j
< 2; ++j
)
8559 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8560 echo_area_buffer
[j
] = echo_buffer
[i
];
8565 /* Call FN with args A1..A4 with either the current or last displayed
8566 echo_area_buffer as current buffer.
8568 WHICH zero means use the current message buffer
8569 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8570 from echo_buffer[] and clear it.
8572 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8573 suitable buffer from echo_buffer[] and clear it.
8575 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8576 that the current message becomes the last displayed one, make
8577 choose a suitable buffer for echo_area_buffer[0], and clear it.
8579 Value is what FN returns. */
8582 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
)
8585 int (*fn
) P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
8591 int this_one
, the_other
, clear_buffer_p
, rc
;
8592 int count
= SPECPDL_INDEX ();
8594 /* If buffers aren't live, make new ones. */
8595 ensure_echo_area_buffers ();
8600 this_one
= 0, the_other
= 1;
8602 this_one
= 1, the_other
= 0;
8605 this_one
= 0, the_other
= 1;
8608 /* We need a fresh one in case the current echo buffer equals
8609 the one containing the last displayed echo area message. */
8610 if (!NILP (echo_area_buffer
[this_one
])
8611 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8612 echo_area_buffer
[this_one
] = Qnil
;
8615 /* Choose a suitable buffer from echo_buffer[] is we don't
8617 if (NILP (echo_area_buffer
[this_one
]))
8619 echo_area_buffer
[this_one
]
8620 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8621 ? echo_buffer
[the_other
]
8622 : echo_buffer
[this_one
]);
8626 buffer
= echo_area_buffer
[this_one
];
8628 /* Don't get confused by reusing the buffer used for echoing
8629 for a different purpose. */
8630 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8633 record_unwind_protect (unwind_with_echo_area_buffer
,
8634 with_echo_area_buffer_unwind_data (w
));
8636 /* Make the echo area buffer current. Note that for display
8637 purposes, it is not necessary that the displayed window's buffer
8638 == current_buffer, except for text property lookup. So, let's
8639 only set that buffer temporarily here without doing a full
8640 Fset_window_buffer. We must also change w->pointm, though,
8641 because otherwise an assertions in unshow_buffer fails, and Emacs
8643 set_buffer_internal_1 (XBUFFER (buffer
));
8647 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8650 current_buffer
->undo_list
= Qt
;
8651 current_buffer
->read_only
= Qnil
;
8652 specbind (Qinhibit_read_only
, Qt
);
8653 specbind (Qinhibit_modification_hooks
, Qt
);
8655 if (clear_buffer_p
&& Z
> BEG
)
8658 xassert (BEGV
>= BEG
);
8659 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8661 rc
= fn (a1
, a2
, a3
, a4
);
8663 xassert (BEGV
>= BEG
);
8664 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8666 unbind_to (count
, Qnil
);
8671 /* Save state that should be preserved around the call to the function
8672 FN called in with_echo_area_buffer. */
8675 with_echo_area_buffer_unwind_data (w
)
8679 Lisp_Object vector
, tmp
;
8681 /* Reduce consing by keeping one vector in
8682 Vwith_echo_area_save_vector. */
8683 vector
= Vwith_echo_area_save_vector
;
8684 Vwith_echo_area_save_vector
= Qnil
;
8687 vector
= Fmake_vector (make_number (7), Qnil
);
8689 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8690 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8691 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8695 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8696 ASET (vector
, i
, w
->buffer
); ++i
;
8697 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8698 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8703 for (; i
< end
; ++i
)
8704 ASET (vector
, i
, Qnil
);
8707 xassert (i
== ASIZE (vector
));
8712 /* Restore global state from VECTOR which was created by
8713 with_echo_area_buffer_unwind_data. */
8716 unwind_with_echo_area_buffer (vector
)
8719 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8720 Vdeactivate_mark
= AREF (vector
, 1);
8721 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8723 if (WINDOWP (AREF (vector
, 3)))
8726 Lisp_Object buffer
, charpos
, bytepos
;
8728 w
= XWINDOW (AREF (vector
, 3));
8729 buffer
= AREF (vector
, 4);
8730 charpos
= AREF (vector
, 5);
8731 bytepos
= AREF (vector
, 6);
8734 set_marker_both (w
->pointm
, buffer
,
8735 XFASTINT (charpos
), XFASTINT (bytepos
));
8738 Vwith_echo_area_save_vector
= vector
;
8743 /* Set up the echo area for use by print functions. MULTIBYTE_P
8744 non-zero means we will print multibyte. */
8747 setup_echo_area_for_printing (multibyte_p
)
8750 /* If we can't find an echo area any more, exit. */
8751 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8754 ensure_echo_area_buffers ();
8756 if (!message_buf_print
)
8758 /* A message has been output since the last time we printed.
8759 Choose a fresh echo area buffer. */
8760 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8761 echo_area_buffer
[0] = echo_buffer
[1];
8763 echo_area_buffer
[0] = echo_buffer
[0];
8765 /* Switch to that buffer and clear it. */
8766 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8767 current_buffer
->truncate_lines
= Qnil
;
8771 int count
= SPECPDL_INDEX ();
8772 specbind (Qinhibit_read_only
, Qt
);
8773 /* Note that undo recording is always disabled. */
8775 unbind_to (count
, Qnil
);
8777 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8779 /* Set up the buffer for the multibyteness we need. */
8781 != !NILP (current_buffer
->enable_multibyte_characters
))
8782 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8784 /* Raise the frame containing the echo area. */
8785 if (minibuffer_auto_raise
)
8787 struct frame
*sf
= SELECTED_FRAME ();
8788 Lisp_Object mini_window
;
8789 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8790 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8793 message_log_maybe_newline ();
8794 message_buf_print
= 1;
8798 if (NILP (echo_area_buffer
[0]))
8800 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8801 echo_area_buffer
[0] = echo_buffer
[1];
8803 echo_area_buffer
[0] = echo_buffer
[0];
8806 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8808 /* Someone switched buffers between print requests. */
8809 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8810 current_buffer
->truncate_lines
= Qnil
;
8816 /* Display an echo area message in window W. Value is non-zero if W's
8817 height is changed. If display_last_displayed_message_p is
8818 non-zero, display the message that was last displayed, otherwise
8819 display the current message. */
8822 display_echo_area (w
)
8825 int i
, no_message_p
, window_height_changed_p
, count
;
8827 /* Temporarily disable garbage collections while displaying the echo
8828 area. This is done because a GC can print a message itself.
8829 That message would modify the echo area buffer's contents while a
8830 redisplay of the buffer is going on, and seriously confuse
8832 count
= inhibit_garbage_collection ();
8834 /* If there is no message, we must call display_echo_area_1
8835 nevertheless because it resizes the window. But we will have to
8836 reset the echo_area_buffer in question to nil at the end because
8837 with_echo_area_buffer will sets it to an empty buffer. */
8838 i
= display_last_displayed_message_p
? 1 : 0;
8839 no_message_p
= NILP (echo_area_buffer
[i
]);
8841 window_height_changed_p
8842 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8843 display_echo_area_1
,
8844 (EMACS_INT
) w
, Qnil
, 0, 0);
8847 echo_area_buffer
[i
] = Qnil
;
8849 unbind_to (count
, Qnil
);
8850 return window_height_changed_p
;
8854 /* Helper for display_echo_area. Display the current buffer which
8855 contains the current echo area message in window W, a mini-window,
8856 a pointer to which is passed in A1. A2..A4 are currently not used.
8857 Change the height of W so that all of the message is displayed.
8858 Value is non-zero if height of W was changed. */
8861 display_echo_area_1 (a1
, a2
, a3
, a4
)
8866 struct window
*w
= (struct window
*) a1
;
8868 struct text_pos start
;
8869 int window_height_changed_p
= 0;
8871 /* Do this before displaying, so that we have a large enough glyph
8872 matrix for the display. If we can't get enough space for the
8873 whole text, display the last N lines. That works by setting w->start. */
8874 window_height_changed_p
= resize_mini_window (w
, 0);
8876 /* Use the starting position chosen by resize_mini_window. */
8877 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8880 clear_glyph_matrix (w
->desired_matrix
);
8881 XSETWINDOW (window
, w
);
8882 try_window (window
, start
, 0);
8884 return window_height_changed_p
;
8888 /* Resize the echo area window to exactly the size needed for the
8889 currently displayed message, if there is one. If a mini-buffer
8890 is active, don't shrink it. */
8893 resize_echo_area_exactly ()
8895 if (BUFFERP (echo_area_buffer
[0])
8896 && WINDOWP (echo_area_window
))
8898 struct window
*w
= XWINDOW (echo_area_window
);
8900 Lisp_Object resize_exactly
;
8902 if (minibuf_level
== 0)
8903 resize_exactly
= Qt
;
8905 resize_exactly
= Qnil
;
8907 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8908 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8911 ++windows_or_buffers_changed
;
8912 ++update_mode_lines
;
8913 redisplay_internal (0);
8919 /* Callback function for with_echo_area_buffer, when used from
8920 resize_echo_area_exactly. A1 contains a pointer to the window to
8921 resize, EXACTLY non-nil means resize the mini-window exactly to the
8922 size of the text displayed. A3 and A4 are not used. Value is what
8923 resize_mini_window returns. */
8926 resize_mini_window_1 (a1
, exactly
, a3
, a4
)
8928 Lisp_Object exactly
;
8931 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8935 /* Resize mini-window W to fit the size of its contents. EXACT_P
8936 means size the window exactly to the size needed. Otherwise, it's
8937 only enlarged until W's buffer is empty.
8939 Set W->start to the right place to begin display. If the whole
8940 contents fit, start at the beginning. Otherwise, start so as
8941 to make the end of the contents appear. This is particularly
8942 important for y-or-n-p, but seems desirable generally.
8944 Value is non-zero if the window height has been changed. */
8947 resize_mini_window (w
, exact_p
)
8951 struct frame
*f
= XFRAME (w
->frame
);
8952 int window_height_changed_p
= 0;
8954 xassert (MINI_WINDOW_P (w
));
8956 /* By default, start display at the beginning. */
8957 set_marker_both (w
->start
, w
->buffer
,
8958 BUF_BEGV (XBUFFER (w
->buffer
)),
8959 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8961 /* Don't resize windows while redisplaying a window; it would
8962 confuse redisplay functions when the size of the window they are
8963 displaying changes from under them. Such a resizing can happen,
8964 for instance, when which-func prints a long message while
8965 we are running fontification-functions. We're running these
8966 functions with safe_call which binds inhibit-redisplay to t. */
8967 if (!NILP (Vinhibit_redisplay
))
8970 /* Nil means don't try to resize. */
8971 if (NILP (Vresize_mini_windows
)
8972 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8975 if (!FRAME_MINIBUF_ONLY_P (f
))
8978 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8979 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8980 int height
, max_height
;
8981 int unit
= FRAME_LINE_HEIGHT (f
);
8982 struct text_pos start
;
8983 struct buffer
*old_current_buffer
= NULL
;
8985 if (current_buffer
!= XBUFFER (w
->buffer
))
8987 old_current_buffer
= current_buffer
;
8988 set_buffer_internal (XBUFFER (w
->buffer
));
8991 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8993 /* Compute the max. number of lines specified by the user. */
8994 if (FLOATP (Vmax_mini_window_height
))
8995 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8996 else if (INTEGERP (Vmax_mini_window_height
))
8997 max_height
= XINT (Vmax_mini_window_height
);
8999 max_height
= total_height
/ 4;
9001 /* Correct that max. height if it's bogus. */
9002 max_height
= max (1, max_height
);
9003 max_height
= min (total_height
, max_height
);
9005 /* Find out the height of the text in the window. */
9006 if (it
.line_wrap
== TRUNCATE
)
9011 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
9012 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
9013 height
= it
.current_y
+ last_height
;
9015 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9016 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
9017 height
= (height
+ unit
- 1) / unit
;
9020 /* Compute a suitable window start. */
9021 if (height
> max_height
)
9023 height
= max_height
;
9024 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9025 move_it_vertically_backward (&it
, (height
- 1) * unit
);
9026 start
= it
.current
.pos
;
9029 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
9030 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
9032 if (EQ (Vresize_mini_windows
, Qgrow_only
))
9034 /* Let it grow only, until we display an empty message, in which
9035 case the window shrinks again. */
9036 if (height
> WINDOW_TOTAL_LINES (w
))
9038 int old_height
= WINDOW_TOTAL_LINES (w
);
9039 freeze_window_starts (f
, 1);
9040 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9041 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9043 else if (height
< WINDOW_TOTAL_LINES (w
)
9044 && (exact_p
|| BEGV
== ZV
))
9046 int old_height
= WINDOW_TOTAL_LINES (w
);
9047 freeze_window_starts (f
, 0);
9048 shrink_mini_window (w
);
9049 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9054 /* Always resize to exact size needed. */
9055 if (height
> WINDOW_TOTAL_LINES (w
))
9057 int old_height
= WINDOW_TOTAL_LINES (w
);
9058 freeze_window_starts (f
, 1);
9059 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9060 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9062 else if (height
< WINDOW_TOTAL_LINES (w
))
9064 int old_height
= WINDOW_TOTAL_LINES (w
);
9065 freeze_window_starts (f
, 0);
9066 shrink_mini_window (w
);
9070 freeze_window_starts (f
, 1);
9071 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9074 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9078 if (old_current_buffer
)
9079 set_buffer_internal (old_current_buffer
);
9082 return window_height_changed_p
;
9086 /* Value is the current message, a string, or nil if there is no
9094 if (!BUFFERP (echo_area_buffer
[0]))
9098 with_echo_area_buffer (0, 0, current_message_1
,
9099 (EMACS_INT
) &msg
, Qnil
, 0, 0);
9101 echo_area_buffer
[0] = Qnil
;
9109 current_message_1 (a1
, a2
, a3
, a4
)
9114 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
9117 *msg
= make_buffer_string (BEG
, Z
, 1);
9124 /* Push the current message on Vmessage_stack for later restauration
9125 by restore_message. Value is non-zero if the current message isn't
9126 empty. This is a relatively infrequent operation, so it's not
9127 worth optimizing. */
9133 msg
= current_message ();
9134 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9135 return STRINGP (msg
);
9139 /* Restore message display from the top of Vmessage_stack. */
9146 xassert (CONSP (Vmessage_stack
));
9147 msg
= XCAR (Vmessage_stack
);
9149 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9151 message3_nolog (msg
, 0, 0);
9155 /* Handler for record_unwind_protect calling pop_message. */
9158 pop_message_unwind (dummy
)
9165 /* Pop the top-most entry off Vmessage_stack. */
9170 xassert (CONSP (Vmessage_stack
));
9171 Vmessage_stack
= XCDR (Vmessage_stack
);
9175 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9176 exits. If the stack is not empty, we have a missing pop_message
9180 check_message_stack ()
9182 if (!NILP (Vmessage_stack
))
9187 /* Truncate to NCHARS what will be displayed in the echo area the next
9188 time we display it---but don't redisplay it now. */
9191 truncate_echo_area (nchars
)
9195 echo_area_buffer
[0] = Qnil
;
9196 /* A null message buffer means that the frame hasn't really been
9197 initialized yet. Error messages get reported properly by
9198 cmd_error, so this must be just an informative message; toss it. */
9199 else if (!noninteractive
9201 && !NILP (echo_area_buffer
[0]))
9203 struct frame
*sf
= SELECTED_FRAME ();
9204 if (FRAME_MESSAGE_BUF (sf
))
9205 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9210 /* Helper function for truncate_echo_area. Truncate the current
9211 message to at most NCHARS characters. */
9214 truncate_message_1 (nchars
, a2
, a3
, a4
)
9219 if (BEG
+ nchars
< Z
)
9220 del_range (BEG
+ nchars
, Z
);
9222 echo_area_buffer
[0] = Qnil
;
9227 /* Set the current message to a substring of S or STRING.
9229 If STRING is a Lisp string, set the message to the first NBYTES
9230 bytes from STRING. NBYTES zero means use the whole string. If
9231 STRING is multibyte, the message will be displayed multibyte.
9233 If S is not null, set the message to the first LEN bytes of S. LEN
9234 zero means use the whole string. MULTIBYTE_P non-zero means S is
9235 multibyte. Display the message multibyte in that case.
9237 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9238 to t before calling set_message_1 (which calls insert).
9242 set_message (s
, string
, nbytes
, multibyte_p
)
9245 int nbytes
, multibyte_p
;
9247 message_enable_multibyte
9248 = ((s
&& multibyte_p
)
9249 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9251 with_echo_area_buffer (0, -1, set_message_1
,
9252 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
9253 message_buf_print
= 0;
9254 help_echo_showing_p
= 0;
9258 /* Helper function for set_message. Arguments have the same meaning
9259 as there, with A1 corresponding to S and A2 corresponding to STRING
9260 This function is called with the echo area buffer being
9264 set_message_1 (a1
, a2
, nbytes
, multibyte_p
)
9267 EMACS_INT nbytes
, multibyte_p
;
9269 const char *s
= (const char *) a1
;
9270 Lisp_Object string
= a2
;
9272 /* Change multibyteness of the echo buffer appropriately. */
9273 if (message_enable_multibyte
9274 != !NILP (current_buffer
->enable_multibyte_characters
))
9275 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9277 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
9279 /* Insert new message at BEG. */
9280 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9282 if (STRINGP (string
))
9287 nbytes
= SBYTES (string
);
9288 nchars
= string_byte_to_char (string
, nbytes
);
9290 /* This function takes care of single/multibyte conversion. We
9291 just have to ensure that the echo area buffer has the right
9292 setting of enable_multibyte_characters. */
9293 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9298 nbytes
= strlen (s
);
9300 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
9302 /* Convert from multi-byte to single-byte. */
9304 unsigned char work
[1];
9306 /* Convert a multibyte string to single-byte. */
9307 for (i
= 0; i
< nbytes
; i
+= n
)
9309 c
= string_char_and_length (s
+ i
, &n
);
9310 work
[0] = (ASCII_CHAR_P (c
)
9312 : multibyte_char_to_unibyte (c
, Qnil
));
9313 insert_1_both (work
, 1, 1, 1, 0, 0);
9316 else if (!multibyte_p
9317 && !NILP (current_buffer
->enable_multibyte_characters
))
9319 /* Convert from single-byte to multi-byte. */
9321 const unsigned char *msg
= (const unsigned char *) s
;
9322 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9324 /* Convert a single-byte string to multibyte. */
9325 for (i
= 0; i
< nbytes
; i
++)
9328 MAKE_CHAR_MULTIBYTE (c
);
9329 n
= CHAR_STRING (c
, str
);
9330 insert_1_both (str
, 1, n
, 1, 0, 0);
9334 insert_1 (s
, nbytes
, 1, 0, 0);
9341 /* Clear messages. CURRENT_P non-zero means clear the current
9342 message. LAST_DISPLAYED_P non-zero means clear the message
9346 clear_message (current_p
, last_displayed_p
)
9347 int current_p
, last_displayed_p
;
9351 echo_area_buffer
[0] = Qnil
;
9352 message_cleared_p
= 1;
9355 if (last_displayed_p
)
9356 echo_area_buffer
[1] = Qnil
;
9358 message_buf_print
= 0;
9361 /* Clear garbaged frames.
9363 This function is used where the old redisplay called
9364 redraw_garbaged_frames which in turn called redraw_frame which in
9365 turn called clear_frame. The call to clear_frame was a source of
9366 flickering. I believe a clear_frame is not necessary. It should
9367 suffice in the new redisplay to invalidate all current matrices,
9368 and ensure a complete redisplay of all windows. */
9371 clear_garbaged_frames ()
9375 Lisp_Object tail
, frame
;
9376 int changed_count
= 0;
9378 FOR_EACH_FRAME (tail
, frame
)
9380 struct frame
*f
= XFRAME (frame
);
9382 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9386 Fredraw_frame (frame
);
9387 f
->force_flush_display_p
= 1;
9389 clear_current_matrices (f
);
9398 ++windows_or_buffers_changed
;
9403 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9404 is non-zero update selected_frame. Value is non-zero if the
9405 mini-windows height has been changed. */
9408 echo_area_display (update_frame_p
)
9411 Lisp_Object mini_window
;
9414 int window_height_changed_p
= 0;
9415 struct frame
*sf
= SELECTED_FRAME ();
9417 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9418 w
= XWINDOW (mini_window
);
9419 f
= XFRAME (WINDOW_FRAME (w
));
9421 /* Don't display if frame is invisible or not yet initialized. */
9422 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9425 #ifdef HAVE_WINDOW_SYSTEM
9426 /* When Emacs starts, selected_frame may be the initial terminal
9427 frame. If we let this through, a message would be displayed on
9429 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9431 #endif /* HAVE_WINDOW_SYSTEM */
9433 /* Redraw garbaged frames. */
9435 clear_garbaged_frames ();
9437 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9439 echo_area_window
= mini_window
;
9440 window_height_changed_p
= display_echo_area (w
);
9441 w
->must_be_updated_p
= 1;
9443 /* Update the display, unless called from redisplay_internal.
9444 Also don't update the screen during redisplay itself. The
9445 update will happen at the end of redisplay, and an update
9446 here could cause confusion. */
9447 if (update_frame_p
&& !redisplaying_p
)
9451 /* If the display update has been interrupted by pending
9452 input, update mode lines in the frame. Due to the
9453 pending input, it might have been that redisplay hasn't
9454 been called, so that mode lines above the echo area are
9455 garbaged. This looks odd, so we prevent it here. */
9456 if (!display_completed
)
9457 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9459 if (window_height_changed_p
9460 /* Don't do this if Emacs is shutting down. Redisplay
9461 needs to run hooks. */
9462 && !NILP (Vrun_hooks
))
9464 /* Must update other windows. Likewise as in other
9465 cases, don't let this update be interrupted by
9467 int count
= SPECPDL_INDEX ();
9468 specbind (Qredisplay_dont_pause
, Qt
);
9469 windows_or_buffers_changed
= 1;
9470 redisplay_internal (0);
9471 unbind_to (count
, Qnil
);
9473 else if (FRAME_WINDOW_P (f
) && n
== 0)
9475 /* Window configuration is the same as before.
9476 Can do with a display update of the echo area,
9477 unless we displayed some mode lines. */
9478 update_single_window (w
, 1);
9479 FRAME_RIF (f
)->flush_display (f
);
9482 update_frame (f
, 1, 1);
9484 /* If cursor is in the echo area, make sure that the next
9485 redisplay displays the minibuffer, so that the cursor will
9486 be replaced with what the minibuffer wants. */
9487 if (cursor_in_echo_area
)
9488 ++windows_or_buffers_changed
;
9491 else if (!EQ (mini_window
, selected_window
))
9492 windows_or_buffers_changed
++;
9494 /* Last displayed message is now the current message. */
9495 echo_area_buffer
[1] = echo_area_buffer
[0];
9496 /* Inform read_char that we're not echoing. */
9497 echo_message_buffer
= Qnil
;
9499 /* Prevent redisplay optimization in redisplay_internal by resetting
9500 this_line_start_pos. This is done because the mini-buffer now
9501 displays the message instead of its buffer text. */
9502 if (EQ (mini_window
, selected_window
))
9503 CHARPOS (this_line_start_pos
) = 0;
9505 return window_height_changed_p
;
9510 /***********************************************************************
9511 Mode Lines and Frame Titles
9512 ***********************************************************************/
9514 /* A buffer for constructing non-propertized mode-line strings and
9515 frame titles in it; allocated from the heap in init_xdisp and
9516 resized as needed in store_mode_line_noprop_char. */
9518 static char *mode_line_noprop_buf
;
9520 /* The buffer's end, and a current output position in it. */
9522 static char *mode_line_noprop_buf_end
;
9523 static char *mode_line_noprop_ptr
;
9525 #define MODE_LINE_NOPROP_LEN(start) \
9526 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9529 MODE_LINE_DISPLAY
= 0,
9535 /* Alist that caches the results of :propertize.
9536 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9537 static Lisp_Object mode_line_proptrans_alist
;
9539 /* List of strings making up the mode-line. */
9540 static Lisp_Object mode_line_string_list
;
9542 /* Base face property when building propertized mode line string. */
9543 static Lisp_Object mode_line_string_face
;
9544 static Lisp_Object mode_line_string_face_prop
;
9547 /* Unwind data for mode line strings */
9549 static Lisp_Object Vmode_line_unwind_vector
;
9552 format_mode_line_unwind_data (struct buffer
*obuf
,
9556 Lisp_Object vector
, tmp
;
9558 /* Reduce consing by keeping one vector in
9559 Vwith_echo_area_save_vector. */
9560 vector
= Vmode_line_unwind_vector
;
9561 Vmode_line_unwind_vector
= Qnil
;
9564 vector
= Fmake_vector (make_number (8), Qnil
);
9566 ASET (vector
, 0, make_number (mode_line_target
));
9567 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9568 ASET (vector
, 2, mode_line_string_list
);
9569 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9570 ASET (vector
, 4, mode_line_string_face
);
9571 ASET (vector
, 5, mode_line_string_face_prop
);
9574 XSETBUFFER (tmp
, obuf
);
9577 ASET (vector
, 6, tmp
);
9578 ASET (vector
, 7, owin
);
9584 unwind_format_mode_line (vector
)
9587 mode_line_target
= XINT (AREF (vector
, 0));
9588 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9589 mode_line_string_list
= AREF (vector
, 2);
9590 if (! EQ (AREF (vector
, 3), Qt
))
9591 mode_line_proptrans_alist
= AREF (vector
, 3);
9592 mode_line_string_face
= AREF (vector
, 4);
9593 mode_line_string_face_prop
= AREF (vector
, 5);
9595 if (!NILP (AREF (vector
, 7)))
9596 /* Select window before buffer, since it may change the buffer. */
9597 Fselect_window (AREF (vector
, 7), Qt
);
9599 if (!NILP (AREF (vector
, 6)))
9601 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9602 ASET (vector
, 6, Qnil
);
9605 Vmode_line_unwind_vector
= vector
;
9610 /* Store a single character C for the frame title in mode_line_noprop_buf.
9611 Re-allocate mode_line_noprop_buf if necessary. */
9615 store_mode_line_noprop_char (char c
)
9617 store_mode_line_noprop_char (c
)
9621 /* If output position has reached the end of the allocated buffer,
9622 double the buffer's size. */
9623 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9625 int len
= MODE_LINE_NOPROP_LEN (0);
9626 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9627 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9628 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9629 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9632 *mode_line_noprop_ptr
++ = c
;
9636 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9637 mode_line_noprop_ptr. STR is the string to store. Do not copy
9638 characters that yield more columns than PRECISION; PRECISION <= 0
9639 means copy the whole string. Pad with spaces until FIELD_WIDTH
9640 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9641 pad. Called from display_mode_element when it is used to build a
9645 store_mode_line_noprop (str
, field_width
, precision
)
9646 const unsigned char *str
;
9647 int field_width
, precision
;
9652 /* Copy at most PRECISION chars from STR. */
9653 nbytes
= strlen (str
);
9654 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9656 store_mode_line_noprop_char (*str
++);
9658 /* Fill up with spaces until FIELD_WIDTH reached. */
9659 while (field_width
> 0
9662 store_mode_line_noprop_char (' ');
9669 /***********************************************************************
9671 ***********************************************************************/
9673 #ifdef HAVE_WINDOW_SYSTEM
9675 /* Set the title of FRAME, if it has changed. The title format is
9676 Vicon_title_format if FRAME is iconified, otherwise it is
9677 frame_title_format. */
9680 x_consider_frame_title (frame
)
9683 struct frame
*f
= XFRAME (frame
);
9685 if (FRAME_WINDOW_P (f
)
9686 || FRAME_MINIBUF_ONLY_P (f
)
9687 || f
->explicit_name
)
9689 /* Do we have more than one visible frame on this X display? */
9696 int count
= SPECPDL_INDEX ();
9698 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9700 Lisp_Object other_frame
= XCAR (tail
);
9701 struct frame
*tf
= XFRAME (other_frame
);
9704 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9705 && !FRAME_MINIBUF_ONLY_P (tf
)
9706 && !EQ (other_frame
, tip_frame
)
9707 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9711 /* Set global variable indicating that multiple frames exist. */
9712 multiple_frames
= CONSP (tail
);
9714 /* Switch to the buffer of selected window of the frame. Set up
9715 mode_line_target so that display_mode_element will output into
9716 mode_line_noprop_buf; then display the title. */
9717 record_unwind_protect (unwind_format_mode_line
,
9718 format_mode_line_unwind_data
9719 (current_buffer
, selected_window
, 0));
9721 Fselect_window (f
->selected_window
, Qt
);
9722 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9723 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9725 mode_line_target
= MODE_LINE_TITLE
;
9726 title_start
= MODE_LINE_NOPROP_LEN (0);
9727 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9728 NULL
, DEFAULT_FACE_ID
);
9729 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9730 len
= MODE_LINE_NOPROP_LEN (title_start
);
9731 title
= mode_line_noprop_buf
+ title_start
;
9732 unbind_to (count
, Qnil
);
9734 /* Set the title only if it's changed. This avoids consing in
9735 the common case where it hasn't. (If it turns out that we've
9736 already wasted too much time by walking through the list with
9737 display_mode_element, then we might need to optimize at a
9738 higher level than this.) */
9739 if (! STRINGP (f
->name
)
9740 || SBYTES (f
->name
) != len
9741 || bcmp (title
, SDATA (f
->name
), len
) != 0)
9742 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9746 #endif /* not HAVE_WINDOW_SYSTEM */
9751 /***********************************************************************
9753 ***********************************************************************/
9756 /* Prepare for redisplay by updating menu-bar item lists when
9757 appropriate. This can call eval. */
9760 prepare_menu_bars ()
9763 struct gcpro gcpro1
, gcpro2
;
9765 Lisp_Object tooltip_frame
;
9767 #ifdef HAVE_WINDOW_SYSTEM
9768 tooltip_frame
= tip_frame
;
9770 tooltip_frame
= Qnil
;
9773 /* Update all frame titles based on their buffer names, etc. We do
9774 this before the menu bars so that the buffer-menu will show the
9775 up-to-date frame titles. */
9776 #ifdef HAVE_WINDOW_SYSTEM
9777 if (windows_or_buffers_changed
|| update_mode_lines
)
9779 Lisp_Object tail
, frame
;
9781 FOR_EACH_FRAME (tail
, frame
)
9784 if (!EQ (frame
, tooltip_frame
)
9785 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9786 x_consider_frame_title (frame
);
9789 #endif /* HAVE_WINDOW_SYSTEM */
9791 /* Update the menu bar item lists, if appropriate. This has to be
9792 done before any actual redisplay or generation of display lines. */
9793 all_windows
= (update_mode_lines
9794 || buffer_shared
> 1
9795 || windows_or_buffers_changed
);
9798 Lisp_Object tail
, frame
;
9799 int count
= SPECPDL_INDEX ();
9800 /* 1 means that update_menu_bar has run its hooks
9801 so any further calls to update_menu_bar shouldn't do so again. */
9802 int menu_bar_hooks_run
= 0;
9804 record_unwind_save_match_data ();
9806 FOR_EACH_FRAME (tail
, frame
)
9810 /* Ignore tooltip frame. */
9811 if (EQ (frame
, tooltip_frame
))
9814 /* If a window on this frame changed size, report that to
9815 the user and clear the size-change flag. */
9816 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9818 Lisp_Object functions
;
9820 /* Clear flag first in case we get an error below. */
9821 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9822 functions
= Vwindow_size_change_functions
;
9823 GCPRO2 (tail
, functions
);
9825 while (CONSP (functions
))
9827 if (!EQ (XCAR (functions
), Qt
))
9828 call1 (XCAR (functions
), frame
);
9829 functions
= XCDR (functions
);
9835 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9836 #ifdef HAVE_WINDOW_SYSTEM
9837 update_tool_bar (f
, 0);
9840 if (windows_or_buffers_changed
)
9841 ns_set_doc_edited (f
, Fbuffer_modified_p
9842 (XWINDOW (f
->selected_window
)->buffer
));
9847 unbind_to (count
, Qnil
);
9851 struct frame
*sf
= SELECTED_FRAME ();
9852 update_menu_bar (sf
, 1, 0);
9853 #ifdef HAVE_WINDOW_SYSTEM
9854 update_tool_bar (sf
, 1);
9858 /* Motif needs this. See comment in xmenu.c. Turn it off when
9859 pending_menu_activation is not defined. */
9860 #ifdef USE_X_TOOLKIT
9861 pending_menu_activation
= 0;
9866 /* Update the menu bar item list for frame F. This has to be done
9867 before we start to fill in any display lines, because it can call
9870 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9872 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9873 already ran the menu bar hooks for this redisplay, so there
9874 is no need to run them again. The return value is the
9875 updated value of this flag, to pass to the next call. */
9878 update_menu_bar (f
, save_match_data
, hooks_run
)
9880 int save_match_data
;
9884 register struct window
*w
;
9886 /* If called recursively during a menu update, do nothing. This can
9887 happen when, for instance, an activate-menubar-hook causes a
9889 if (inhibit_menubar_update
)
9892 window
= FRAME_SELECTED_WINDOW (f
);
9893 w
= XWINDOW (window
);
9895 if (FRAME_WINDOW_P (f
)
9897 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9898 || defined (HAVE_NS) || defined (USE_GTK)
9899 FRAME_EXTERNAL_MENU_BAR (f
)
9901 FRAME_MENU_BAR_LINES (f
) > 0
9903 : FRAME_MENU_BAR_LINES (f
) > 0)
9905 /* If the user has switched buffers or windows, we need to
9906 recompute to reflect the new bindings. But we'll
9907 recompute when update_mode_lines is set too; that means
9908 that people can use force-mode-line-update to request
9909 that the menu bar be recomputed. The adverse effect on
9910 the rest of the redisplay algorithm is about the same as
9911 windows_or_buffers_changed anyway. */
9912 if (windows_or_buffers_changed
9913 /* This used to test w->update_mode_line, but we believe
9914 there is no need to recompute the menu in that case. */
9915 || update_mode_lines
9916 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9917 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9918 != !NILP (w
->last_had_star
))
9919 || ((!NILP (Vtransient_mark_mode
)
9920 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9921 != !NILP (w
->region_showing
)))
9923 struct buffer
*prev
= current_buffer
;
9924 int count
= SPECPDL_INDEX ();
9926 specbind (Qinhibit_menubar_update
, Qt
);
9928 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9929 if (save_match_data
)
9930 record_unwind_save_match_data ();
9931 if (NILP (Voverriding_local_map_menu_flag
))
9933 specbind (Qoverriding_terminal_local_map
, Qnil
);
9934 specbind (Qoverriding_local_map
, Qnil
);
9939 /* Run the Lucid hook. */
9940 safe_run_hooks (Qactivate_menubar_hook
);
9942 /* If it has changed current-menubar from previous value,
9943 really recompute the menu-bar from the value. */
9944 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9945 call0 (Qrecompute_lucid_menubar
);
9947 safe_run_hooks (Qmenu_bar_update_hook
);
9952 XSETFRAME (Vmenu_updating_frame
, f
);
9953 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9955 /* Redisplay the menu bar in case we changed it. */
9956 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9957 || defined (HAVE_NS) || defined (USE_GTK)
9958 if (FRAME_WINDOW_P (f
))
9960 #if defined (HAVE_NS)
9961 /* All frames on Mac OS share the same menubar. So only
9962 the selected frame should be allowed to set it. */
9963 if (f
== SELECTED_FRAME ())
9965 set_frame_menubar (f
, 0, 0);
9968 /* On a terminal screen, the menu bar is an ordinary screen
9969 line, and this makes it get updated. */
9970 w
->update_mode_line
= Qt
;
9971 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9972 /* In the non-toolkit version, the menu bar is an ordinary screen
9973 line, and this makes it get updated. */
9974 w
->update_mode_line
= Qt
;
9975 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9977 unbind_to (count
, Qnil
);
9978 set_buffer_internal_1 (prev
);
9987 /***********************************************************************
9989 ***********************************************************************/
9991 #ifdef HAVE_WINDOW_SYSTEM
9994 Nominal cursor position -- where to draw output.
9995 HPOS and VPOS are window relative glyph matrix coordinates.
9996 X and Y are window relative pixel coordinates. */
9998 struct cursor_pos output_cursor
;
10002 Set the global variable output_cursor to CURSOR. All cursor
10003 positions are relative to updated_window. */
10006 set_output_cursor (cursor
)
10007 struct cursor_pos
*cursor
;
10009 output_cursor
.hpos
= cursor
->hpos
;
10010 output_cursor
.vpos
= cursor
->vpos
;
10011 output_cursor
.x
= cursor
->x
;
10012 output_cursor
.y
= cursor
->y
;
10017 Set a nominal cursor position.
10019 HPOS and VPOS are column/row positions in a window glyph matrix. X
10020 and Y are window text area relative pixel positions.
10022 If this is done during an update, updated_window will contain the
10023 window that is being updated and the position is the future output
10024 cursor position for that window. If updated_window is null, use
10025 selected_window and display the cursor at the given position. */
10028 x_cursor_to (vpos
, hpos
, y
, x
)
10029 int vpos
, hpos
, y
, x
;
10033 /* If updated_window is not set, work on selected_window. */
10034 if (updated_window
)
10035 w
= updated_window
;
10037 w
= XWINDOW (selected_window
);
10039 /* Set the output cursor. */
10040 output_cursor
.hpos
= hpos
;
10041 output_cursor
.vpos
= vpos
;
10042 output_cursor
.x
= x
;
10043 output_cursor
.y
= y
;
10045 /* If not called as part of an update, really display the cursor.
10046 This will also set the cursor position of W. */
10047 if (updated_window
== NULL
)
10050 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
10051 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
10052 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
10057 #endif /* HAVE_WINDOW_SYSTEM */
10060 /***********************************************************************
10062 ***********************************************************************/
10064 #ifdef HAVE_WINDOW_SYSTEM
10066 /* Where the mouse was last time we reported a mouse event. */
10068 FRAME_PTR last_mouse_frame
;
10070 /* Tool-bar item index of the item on which a mouse button was pressed
10073 int last_tool_bar_item
;
10077 update_tool_bar_unwind (frame
)
10080 selected_frame
= frame
;
10084 /* Update the tool-bar item list for frame F. This has to be done
10085 before we start to fill in any display lines. Called from
10086 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
10087 and restore it here. */
10090 update_tool_bar (f
, save_match_data
)
10092 int save_match_data
;
10094 #if defined (USE_GTK) || defined (HAVE_NS)
10095 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10097 int do_update
= WINDOWP (f
->tool_bar_window
)
10098 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10103 Lisp_Object window
;
10106 window
= FRAME_SELECTED_WINDOW (f
);
10107 w
= XWINDOW (window
);
10109 /* If the user has switched buffers or windows, we need to
10110 recompute to reflect the new bindings. But we'll
10111 recompute when update_mode_lines is set too; that means
10112 that people can use force-mode-line-update to request
10113 that the menu bar be recomputed. The adverse effect on
10114 the rest of the redisplay algorithm is about the same as
10115 windows_or_buffers_changed anyway. */
10116 if (windows_or_buffers_changed
10117 || !NILP (w
->update_mode_line
)
10118 || update_mode_lines
10119 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10120 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10121 != !NILP (w
->last_had_star
))
10122 || ((!NILP (Vtransient_mark_mode
)
10123 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
10124 != !NILP (w
->region_showing
)))
10126 struct buffer
*prev
= current_buffer
;
10127 int count
= SPECPDL_INDEX ();
10128 Lisp_Object frame
, new_tool_bar
;
10129 int new_n_tool_bar
;
10130 struct gcpro gcpro1
;
10132 /* Set current_buffer to the buffer of the selected
10133 window of the frame, so that we get the right local
10135 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10137 /* Save match data, if we must. */
10138 if (save_match_data
)
10139 record_unwind_save_match_data ();
10141 /* Make sure that we don't accidentally use bogus keymaps. */
10142 if (NILP (Voverriding_local_map_menu_flag
))
10144 specbind (Qoverriding_terminal_local_map
, Qnil
);
10145 specbind (Qoverriding_local_map
, Qnil
);
10148 GCPRO1 (new_tool_bar
);
10150 /* We must temporarily set the selected frame to this frame
10151 before calling tool_bar_items, because the calculation of
10152 the tool-bar keymap uses the selected frame (see
10153 `tool-bar-make-keymap' in tool-bar.el). */
10154 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10155 XSETFRAME (frame
, f
);
10156 selected_frame
= frame
;
10158 /* Build desired tool-bar items from keymaps. */
10159 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10162 /* Redisplay the tool-bar if we changed it. */
10163 if (new_n_tool_bar
!= f
->n_tool_bar_items
10164 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10166 /* Redisplay that happens asynchronously due to an expose event
10167 may access f->tool_bar_items. Make sure we update both
10168 variables within BLOCK_INPUT so no such event interrupts. */
10170 f
->tool_bar_items
= new_tool_bar
;
10171 f
->n_tool_bar_items
= new_n_tool_bar
;
10172 w
->update_mode_line
= Qt
;
10178 unbind_to (count
, Qnil
);
10179 set_buffer_internal_1 (prev
);
10185 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10186 F's desired tool-bar contents. F->tool_bar_items must have
10187 been set up previously by calling prepare_menu_bars. */
10190 build_desired_tool_bar_string (f
)
10193 int i
, size
, size_needed
;
10194 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10195 Lisp_Object image
, plist
, props
;
10197 image
= plist
= props
= Qnil
;
10198 GCPRO3 (image
, plist
, props
);
10200 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10201 Otherwise, make a new string. */
10203 /* The size of the string we might be able to reuse. */
10204 size
= (STRINGP (f
->desired_tool_bar_string
)
10205 ? SCHARS (f
->desired_tool_bar_string
)
10208 /* We need one space in the string for each image. */
10209 size_needed
= f
->n_tool_bar_items
;
10211 /* Reuse f->desired_tool_bar_string, if possible. */
10212 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10213 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10214 make_number (' '));
10217 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10218 Fremove_text_properties (make_number (0), make_number (size
),
10219 props
, f
->desired_tool_bar_string
);
10222 /* Put a `display' property on the string for the images to display,
10223 put a `menu_item' property on tool-bar items with a value that
10224 is the index of the item in F's tool-bar item vector. */
10225 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10227 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10229 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10230 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10231 int hmargin
, vmargin
, relief
, idx
, end
;
10232 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
;
10234 /* If image is a vector, choose the image according to the
10236 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10237 if (VECTORP (image
))
10241 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10242 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10245 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10246 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10248 xassert (ASIZE (image
) >= idx
);
10249 image
= AREF (image
, idx
);
10254 /* Ignore invalid image specifications. */
10255 if (!valid_image_p (image
))
10258 /* Display the tool-bar button pressed, or depressed. */
10259 plist
= Fcopy_sequence (XCDR (image
));
10261 /* Compute margin and relief to draw. */
10262 relief
= (tool_bar_button_relief
>= 0
10263 ? tool_bar_button_relief
10264 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10265 hmargin
= vmargin
= relief
;
10267 if (INTEGERP (Vtool_bar_button_margin
)
10268 && XINT (Vtool_bar_button_margin
) > 0)
10270 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10271 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10273 else if (CONSP (Vtool_bar_button_margin
))
10275 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10276 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10277 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10279 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10280 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10281 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10284 if (auto_raise_tool_bar_buttons_p
)
10286 /* Add a `:relief' property to the image spec if the item is
10290 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10297 /* If image is selected, display it pressed, i.e. with a
10298 negative relief. If it's not selected, display it with a
10300 plist
= Fplist_put (plist
, QCrelief
,
10302 ? make_number (-relief
)
10303 : make_number (relief
)));
10308 /* Put a margin around the image. */
10309 if (hmargin
|| vmargin
)
10311 if (hmargin
== vmargin
)
10312 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10314 plist
= Fplist_put (plist
, QCmargin
,
10315 Fcons (make_number (hmargin
),
10316 make_number (vmargin
)));
10319 /* If button is not enabled, and we don't have special images
10320 for the disabled state, make the image appear disabled by
10321 applying an appropriate algorithm to it. */
10322 if (!enabled_p
&& idx
< 0)
10323 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10325 /* Put a `display' text property on the string for the image to
10326 display. Put a `menu-item' property on the string that gives
10327 the start of this item's properties in the tool-bar items
10329 image
= Fcons (Qimage
, plist
);
10330 props
= list4 (Qdisplay
, image
,
10331 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10333 /* Let the last image hide all remaining spaces in the tool bar
10334 string. The string can be longer than needed when we reuse a
10335 previous string. */
10336 if (i
+ 1 == f
->n_tool_bar_items
)
10337 end
= SCHARS (f
->desired_tool_bar_string
);
10340 Fadd_text_properties (make_number (i
), make_number (end
),
10341 props
, f
->desired_tool_bar_string
);
10349 /* Display one line of the tool-bar of frame IT->f.
10351 HEIGHT specifies the desired height of the tool-bar line.
10352 If the actual height of the glyph row is less than HEIGHT, the
10353 row's height is increased to HEIGHT, and the icons are centered
10354 vertically in the new height.
10356 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10357 count a final empty row in case the tool-bar width exactly matches
10362 display_tool_bar_line (it
, height
)
10366 struct glyph_row
*row
= it
->glyph_row
;
10367 int max_x
= it
->last_visible_x
;
10368 struct glyph
*last
;
10370 prepare_desired_row (row
);
10371 row
->y
= it
->current_y
;
10373 /* Note that this isn't made use of if the face hasn't a box,
10374 so there's no need to check the face here. */
10375 it
->start_of_box_run_p
= 1;
10377 while (it
->current_x
< max_x
)
10379 int x
, n_glyphs_before
, i
, nglyphs
;
10380 struct it it_before
;
10382 /* Get the next display element. */
10383 if (!get_next_display_element (it
))
10385 /* Don't count empty row if we are counting needed tool-bar lines. */
10386 if (height
< 0 && !it
->hpos
)
10391 /* Produce glyphs. */
10392 n_glyphs_before
= row
->used
[TEXT_AREA
];
10395 PRODUCE_GLYPHS (it
);
10397 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10399 x
= it_before
.current_x
;
10400 while (i
< nglyphs
)
10402 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10404 if (x
+ glyph
->pixel_width
> max_x
)
10406 /* Glyph doesn't fit on line. Backtrack. */
10407 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10409 /* If this is the only glyph on this line, it will never fit on the
10410 toolbar, so skip it. But ensure there is at least one glyph,
10411 so we don't accidentally disable the tool-bar. */
10412 if (n_glyphs_before
== 0
10413 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10419 x
+= glyph
->pixel_width
;
10423 /* Stop at line ends. */
10424 if (ITERATOR_AT_END_OF_LINE_P (it
))
10427 set_iterator_to_next (it
, 1);
10432 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10434 /* Use default face for the border below the tool bar.
10436 FIXME: When auto-resize-tool-bars is grow-only, there is
10437 no additional border below the possibly empty tool-bar lines.
10438 So to make the extra empty lines look "normal", we have to
10439 use the tool-bar face for the border too. */
10440 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10441 it
->face_id
= DEFAULT_FACE_ID
;
10443 extend_face_to_end_of_line (it
);
10444 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10445 last
->right_box_line_p
= 1;
10446 if (last
== row
->glyphs
[TEXT_AREA
])
10447 last
->left_box_line_p
= 1;
10449 /* Make line the desired height and center it vertically. */
10450 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10452 /* Don't add more than one line height. */
10453 height
%= FRAME_LINE_HEIGHT (it
->f
);
10454 it
->max_ascent
+= height
/ 2;
10455 it
->max_descent
+= (height
+ 1) / 2;
10458 compute_line_metrics (it
);
10460 /* If line is empty, make it occupy the rest of the tool-bar. */
10461 if (!row
->displays_text_p
)
10463 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10464 row
->visible_height
= row
->height
;
10465 row
->ascent
= row
->phys_ascent
= 0;
10466 row
->extra_line_spacing
= 0;
10469 row
->full_width_p
= 1;
10470 row
->continued_p
= 0;
10471 row
->truncated_on_left_p
= 0;
10472 row
->truncated_on_right_p
= 0;
10474 it
->current_x
= it
->hpos
= 0;
10475 it
->current_y
+= row
->height
;
10481 /* Max tool-bar height. */
10483 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10484 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10486 /* Value is the number of screen lines needed to make all tool-bar
10487 items of frame F visible. The number of actual rows needed is
10488 returned in *N_ROWS if non-NULL. */
10491 tool_bar_lines_needed (f
, n_rows
)
10495 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10497 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10498 the desired matrix, so use (unused) mode-line row as temporary row to
10499 avoid destroying the first tool-bar row. */
10500 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10502 /* Initialize an iterator for iteration over
10503 F->desired_tool_bar_string in the tool-bar window of frame F. */
10504 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10505 it
.first_visible_x
= 0;
10506 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10507 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10509 while (!ITERATOR_AT_END_P (&it
))
10511 clear_glyph_row (temp_row
);
10512 it
.glyph_row
= temp_row
;
10513 display_tool_bar_line (&it
, -1);
10515 clear_glyph_row (temp_row
);
10517 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10519 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10521 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10525 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10527 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10536 frame
= selected_frame
;
10538 CHECK_FRAME (frame
);
10539 f
= XFRAME (frame
);
10541 if (WINDOWP (f
->tool_bar_window
)
10542 || (w
= XWINDOW (f
->tool_bar_window
),
10543 WINDOW_TOTAL_LINES (w
) > 0))
10545 update_tool_bar (f
, 1);
10546 if (f
->n_tool_bar_items
)
10548 build_desired_tool_bar_string (f
);
10549 nlines
= tool_bar_lines_needed (f
, NULL
);
10553 return make_number (nlines
);
10557 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10558 height should be changed. */
10561 redisplay_tool_bar (f
)
10566 struct glyph_row
*row
;
10568 #if defined (USE_GTK) || defined (HAVE_NS)
10569 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10570 update_frame_tool_bar (f
);
10574 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10575 do anything. This means you must start with tool-bar-lines
10576 non-zero to get the auto-sizing effect. Or in other words, you
10577 can turn off tool-bars by specifying tool-bar-lines zero. */
10578 if (!WINDOWP (f
->tool_bar_window
)
10579 || (w
= XWINDOW (f
->tool_bar_window
),
10580 WINDOW_TOTAL_LINES (w
) == 0))
10583 /* Set up an iterator for the tool-bar window. */
10584 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10585 it
.first_visible_x
= 0;
10586 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10587 row
= it
.glyph_row
;
10589 /* Build a string that represents the contents of the tool-bar. */
10590 build_desired_tool_bar_string (f
);
10591 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10593 if (f
->n_tool_bar_rows
== 0)
10597 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10598 nlines
!= WINDOW_TOTAL_LINES (w
)))
10600 extern Lisp_Object Qtool_bar_lines
;
10602 int old_height
= WINDOW_TOTAL_LINES (w
);
10604 XSETFRAME (frame
, f
);
10605 Fmodify_frame_parameters (frame
,
10606 Fcons (Fcons (Qtool_bar_lines
,
10607 make_number (nlines
)),
10609 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10611 clear_glyph_matrix (w
->desired_matrix
);
10612 fonts_changed_p
= 1;
10618 /* Display as many lines as needed to display all tool-bar items. */
10620 if (f
->n_tool_bar_rows
> 0)
10622 int border
, rows
, height
, extra
;
10624 if (INTEGERP (Vtool_bar_border
))
10625 border
= XINT (Vtool_bar_border
);
10626 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10627 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10628 else if (EQ (Vtool_bar_border
, Qborder_width
))
10629 border
= f
->border_width
;
10635 rows
= f
->n_tool_bar_rows
;
10636 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10637 extra
= it
.last_visible_y
- border
- height
* rows
;
10639 while (it
.current_y
< it
.last_visible_y
)
10642 if (extra
> 0 && rows
-- > 0)
10644 h
= (extra
+ rows
- 1) / rows
;
10647 display_tool_bar_line (&it
, height
+ h
);
10652 while (it
.current_y
< it
.last_visible_y
)
10653 display_tool_bar_line (&it
, 0);
10656 /* It doesn't make much sense to try scrolling in the tool-bar
10657 window, so don't do it. */
10658 w
->desired_matrix
->no_scrolling_p
= 1;
10659 w
->must_be_updated_p
= 1;
10661 if (!NILP (Vauto_resize_tool_bars
))
10663 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10664 int change_height_p
= 0;
10666 /* If we couldn't display everything, change the tool-bar's
10667 height if there is room for more. */
10668 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10669 && it
.current_y
< max_tool_bar_height
)
10670 change_height_p
= 1;
10672 row
= it
.glyph_row
- 1;
10674 /* If there are blank lines at the end, except for a partially
10675 visible blank line at the end that is smaller than
10676 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10677 if (!row
->displays_text_p
10678 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10679 change_height_p
= 1;
10681 /* If row displays tool-bar items, but is partially visible,
10682 change the tool-bar's height. */
10683 if (row
->displays_text_p
10684 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10685 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10686 change_height_p
= 1;
10688 /* Resize windows as needed by changing the `tool-bar-lines'
10689 frame parameter. */
10690 if (change_height_p
)
10692 extern Lisp_Object Qtool_bar_lines
;
10694 int old_height
= WINDOW_TOTAL_LINES (w
);
10696 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10698 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10699 && !f
->minimize_tool_bar_window_p
)
10700 ? (nlines
> old_height
)
10701 : (nlines
!= old_height
));
10702 f
->minimize_tool_bar_window_p
= 0;
10704 if (change_height_p
)
10706 XSETFRAME (frame
, f
);
10707 Fmodify_frame_parameters (frame
,
10708 Fcons (Fcons (Qtool_bar_lines
,
10709 make_number (nlines
)),
10711 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10713 clear_glyph_matrix (w
->desired_matrix
);
10714 f
->n_tool_bar_rows
= nrows
;
10715 fonts_changed_p
= 1;
10722 f
->minimize_tool_bar_window_p
= 0;
10727 /* Get information about the tool-bar item which is displayed in GLYPH
10728 on frame F. Return in *PROP_IDX the index where tool-bar item
10729 properties start in F->tool_bar_items. Value is zero if
10730 GLYPH doesn't display a tool-bar item. */
10733 tool_bar_item_info (f
, glyph
, prop_idx
)
10735 struct glyph
*glyph
;
10742 /* This function can be called asynchronously, which means we must
10743 exclude any possibility that Fget_text_property signals an
10745 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10746 charpos
= max (0, charpos
);
10748 /* Get the text property `menu-item' at pos. The value of that
10749 property is the start index of this item's properties in
10750 F->tool_bar_items. */
10751 prop
= Fget_text_property (make_number (charpos
),
10752 Qmenu_item
, f
->current_tool_bar_string
);
10753 if (INTEGERP (prop
))
10755 *prop_idx
= XINT (prop
);
10765 /* Get information about the tool-bar item at position X/Y on frame F.
10766 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10767 the current matrix of the tool-bar window of F, or NULL if not
10768 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10769 item in F->tool_bar_items. Value is
10771 -1 if X/Y is not on a tool-bar item
10772 0 if X/Y is on the same item that was highlighted before.
10776 get_tool_bar_item (f
, x
, y
, glyph
, hpos
, vpos
, prop_idx
)
10779 struct glyph
**glyph
;
10780 int *hpos
, *vpos
, *prop_idx
;
10782 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10783 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10786 /* Find the glyph under X/Y. */
10787 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10788 if (*glyph
== NULL
)
10791 /* Get the start of this tool-bar item's properties in
10792 f->tool_bar_items. */
10793 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10796 /* Is mouse on the highlighted item? */
10797 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
10798 && *vpos
>= dpyinfo
->mouse_face_beg_row
10799 && *vpos
<= dpyinfo
->mouse_face_end_row
10800 && (*vpos
> dpyinfo
->mouse_face_beg_row
10801 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
10802 && (*vpos
< dpyinfo
->mouse_face_end_row
10803 || *hpos
< dpyinfo
->mouse_face_end_col
10804 || dpyinfo
->mouse_face_past_end
))
10812 Handle mouse button event on the tool-bar of frame F, at
10813 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10814 0 for button release. MODIFIERS is event modifiers for button
10818 handle_tool_bar_click (f
, x
, y
, down_p
, modifiers
)
10821 unsigned int modifiers
;
10823 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10824 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10825 int hpos
, vpos
, prop_idx
;
10826 struct glyph
*glyph
;
10827 Lisp_Object enabled_p
;
10829 /* If not on the highlighted tool-bar item, return. */
10830 frame_to_window_pixel_xy (w
, &x
, &y
);
10831 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10834 /* If item is disabled, do nothing. */
10835 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10836 if (NILP (enabled_p
))
10841 /* Show item in pressed state. */
10842 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
10843 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10844 last_tool_bar_item
= prop_idx
;
10848 Lisp_Object key
, frame
;
10849 struct input_event event
;
10850 EVENT_INIT (event
);
10852 /* Show item in released state. */
10853 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
10854 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10856 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10858 XSETFRAME (frame
, f
);
10859 event
.kind
= TOOL_BAR_EVENT
;
10860 event
.frame_or_window
= frame
;
10862 kbd_buffer_store_event (&event
);
10864 event
.kind
= TOOL_BAR_EVENT
;
10865 event
.frame_or_window
= frame
;
10867 event
.modifiers
= modifiers
;
10868 kbd_buffer_store_event (&event
);
10869 last_tool_bar_item
= -1;
10874 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10875 tool-bar window-relative coordinates X/Y. Called from
10876 note_mouse_highlight. */
10879 note_tool_bar_highlight (f
, x
, y
)
10883 Lisp_Object window
= f
->tool_bar_window
;
10884 struct window
*w
= XWINDOW (window
);
10885 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10887 struct glyph
*glyph
;
10888 struct glyph_row
*row
;
10890 Lisp_Object enabled_p
;
10892 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10893 int mouse_down_p
, rc
;
10895 /* Function note_mouse_highlight is called with negative x(y
10896 values when mouse moves outside of the frame. */
10897 if (x
<= 0 || y
<= 0)
10899 clear_mouse_face (dpyinfo
);
10903 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10906 /* Not on tool-bar item. */
10907 clear_mouse_face (dpyinfo
);
10911 /* On same tool-bar item as before. */
10912 goto set_help_echo
;
10914 clear_mouse_face (dpyinfo
);
10916 /* Mouse is down, but on different tool-bar item? */
10917 mouse_down_p
= (dpyinfo
->grabbed
10918 && f
== last_mouse_frame
10919 && FRAME_LIVE_P (f
));
10921 && last_tool_bar_item
!= prop_idx
)
10924 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10925 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10927 /* If tool-bar item is not enabled, don't highlight it. */
10928 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10929 if (!NILP (enabled_p
))
10931 /* Compute the x-position of the glyph. In front and past the
10932 image is a space. We include this in the highlighted area. */
10933 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10934 for (i
= x
= 0; i
< hpos
; ++i
)
10935 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10937 /* Record this as the current active region. */
10938 dpyinfo
->mouse_face_beg_col
= hpos
;
10939 dpyinfo
->mouse_face_beg_row
= vpos
;
10940 dpyinfo
->mouse_face_beg_x
= x
;
10941 dpyinfo
->mouse_face_beg_y
= row
->y
;
10942 dpyinfo
->mouse_face_past_end
= 0;
10944 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
10945 dpyinfo
->mouse_face_end_row
= vpos
;
10946 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10947 dpyinfo
->mouse_face_end_y
= row
->y
;
10948 dpyinfo
->mouse_face_window
= window
;
10949 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10951 /* Display it as active. */
10952 show_mouse_face (dpyinfo
, draw
);
10953 dpyinfo
->mouse_face_image_state
= draw
;
10958 /* Set help_echo_string to a help string to display for this tool-bar item.
10959 XTread_socket does the rest. */
10960 help_echo_object
= help_echo_window
= Qnil
;
10961 help_echo_pos
= -1;
10962 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10963 if (NILP (help_echo_string
))
10964 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10967 #endif /* HAVE_WINDOW_SYSTEM */
10971 /************************************************************************
10972 Horizontal scrolling
10973 ************************************************************************/
10975 static int hscroll_window_tree
P_ ((Lisp_Object
));
10976 static int hscroll_windows
P_ ((Lisp_Object
));
10978 /* For all leaf windows in the window tree rooted at WINDOW, set their
10979 hscroll value so that PT is (i) visible in the window, and (ii) so
10980 that it is not within a certain margin at the window's left and
10981 right border. Value is non-zero if any window's hscroll has been
10985 hscroll_window_tree (window
)
10986 Lisp_Object window
;
10988 int hscrolled_p
= 0;
10989 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10990 int hscroll_step_abs
= 0;
10991 double hscroll_step_rel
= 0;
10993 if (hscroll_relative_p
)
10995 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10996 if (hscroll_step_rel
< 0)
10998 hscroll_relative_p
= 0;
10999 hscroll_step_abs
= 0;
11002 else if (INTEGERP (Vhscroll_step
))
11004 hscroll_step_abs
= XINT (Vhscroll_step
);
11005 if (hscroll_step_abs
< 0)
11006 hscroll_step_abs
= 0;
11009 hscroll_step_abs
= 0;
11011 while (WINDOWP (window
))
11013 struct window
*w
= XWINDOW (window
);
11015 if (WINDOWP (w
->hchild
))
11016 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
11017 else if (WINDOWP (w
->vchild
))
11018 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
11019 else if (w
->cursor
.vpos
>= 0)
11022 int text_area_width
;
11023 struct glyph_row
*current_cursor_row
11024 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
11025 struct glyph_row
*desired_cursor_row
11026 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
11027 struct glyph_row
*cursor_row
11028 = (desired_cursor_row
->enabled_p
11029 ? desired_cursor_row
11030 : current_cursor_row
);
11032 text_area_width
= window_box_width (w
, TEXT_AREA
);
11034 /* Scroll when cursor is inside this scroll margin. */
11035 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
11037 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
11038 && ((XFASTINT (w
->hscroll
)
11039 && w
->cursor
.x
<= h_margin
)
11040 || (cursor_row
->enabled_p
11041 && cursor_row
->truncated_on_right_p
11042 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
11046 struct buffer
*saved_current_buffer
;
11050 /* Find point in a display of infinite width. */
11051 saved_current_buffer
= current_buffer
;
11052 current_buffer
= XBUFFER (w
->buffer
);
11054 if (w
== XWINDOW (selected_window
))
11055 pt
= BUF_PT (current_buffer
);
11058 pt
= marker_position (w
->pointm
);
11059 pt
= max (BEGV
, pt
);
11063 /* Move iterator to pt starting at cursor_row->start in
11064 a line with infinite width. */
11065 init_to_row_start (&it
, w
, cursor_row
);
11066 it
.last_visible_x
= INFINITY
;
11067 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11068 current_buffer
= saved_current_buffer
;
11070 /* Position cursor in window. */
11071 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11072 hscroll
= max (0, (it
.current_x
11073 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11074 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11075 : (text_area_width
/ 2))))
11076 / FRAME_COLUMN_WIDTH (it
.f
);
11077 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11079 if (hscroll_relative_p
)
11080 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11083 wanted_x
= text_area_width
11084 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11087 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11091 if (hscroll_relative_p
)
11092 wanted_x
= text_area_width
* hscroll_step_rel
11095 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11098 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11100 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11102 /* Don't call Fset_window_hscroll if value hasn't
11103 changed because it will prevent redisplay
11105 if (XFASTINT (w
->hscroll
) != hscroll
)
11107 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11108 w
->hscroll
= make_number (hscroll
);
11117 /* Value is non-zero if hscroll of any leaf window has been changed. */
11118 return hscrolled_p
;
11122 /* Set hscroll so that cursor is visible and not inside horizontal
11123 scroll margins for all windows in the tree rooted at WINDOW. See
11124 also hscroll_window_tree above. Value is non-zero if any window's
11125 hscroll has been changed. If it has, desired matrices on the frame
11126 of WINDOW are cleared. */
11129 hscroll_windows (window
)
11130 Lisp_Object window
;
11132 int hscrolled_p
= hscroll_window_tree (window
);
11134 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11135 return hscrolled_p
;
11140 /************************************************************************
11142 ************************************************************************/
11144 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11145 to a non-zero value. This is sometimes handy to have in a debugger
11150 /* First and last unchanged row for try_window_id. */
11152 int debug_first_unchanged_at_end_vpos
;
11153 int debug_last_unchanged_at_beg_vpos
;
11155 /* Delta vpos and y. */
11157 int debug_dvpos
, debug_dy
;
11159 /* Delta in characters and bytes for try_window_id. */
11161 int debug_delta
, debug_delta_bytes
;
11163 /* Values of window_end_pos and window_end_vpos at the end of
11166 EMACS_INT debug_end_pos
, debug_end_vpos
;
11168 /* Append a string to W->desired_matrix->method. FMT is a printf
11169 format string. A1...A9 are a supplement for a variable-length
11170 argument list. If trace_redisplay_p is non-zero also printf the
11171 resulting string to stderr. */
11174 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11177 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11180 char *method
= w
->desired_matrix
->method
;
11181 int len
= strlen (method
);
11182 int size
= sizeof w
->desired_matrix
->method
;
11183 int remaining
= size
- len
- 1;
11185 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11186 if (len
&& remaining
)
11189 --remaining
, ++len
;
11192 strncpy (method
+ len
, buffer
, remaining
);
11194 if (trace_redisplay_p
)
11195 fprintf (stderr
, "%p (%s): %s\n",
11197 ((BUFFERP (w
->buffer
)
11198 && STRINGP (XBUFFER (w
->buffer
)->name
))
11199 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
11204 #endif /* GLYPH_DEBUG */
11207 /* Value is non-zero if all changes in window W, which displays
11208 current_buffer, are in the text between START and END. START is a
11209 buffer position, END is given as a distance from Z. Used in
11210 redisplay_internal for display optimization. */
11213 text_outside_line_unchanged_p (w
, start
, end
)
11217 int unchanged_p
= 1;
11219 /* If text or overlays have changed, see where. */
11220 if (XFASTINT (w
->last_modified
) < MODIFF
11221 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11223 /* Gap in the line? */
11224 if (GPT
< start
|| Z
- GPT
< end
)
11227 /* Changes start in front of the line, or end after it? */
11229 && (BEG_UNCHANGED
< start
- 1
11230 || END_UNCHANGED
< end
))
11233 /* If selective display, can't optimize if changes start at the
11234 beginning of the line. */
11236 && INTEGERP (current_buffer
->selective_display
)
11237 && XINT (current_buffer
->selective_display
) > 0
11238 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11241 /* If there are overlays at the start or end of the line, these
11242 may have overlay strings with newlines in them. A change at
11243 START, for instance, may actually concern the display of such
11244 overlay strings as well, and they are displayed on different
11245 lines. So, quickly rule out this case. (For the future, it
11246 might be desirable to implement something more telling than
11247 just BEG/END_UNCHANGED.) */
11250 if (BEG
+ BEG_UNCHANGED
== start
11251 && overlay_touches_p (start
))
11253 if (END_UNCHANGED
== end
11254 && overlay_touches_p (Z
- end
))
11258 /* Under bidi reordering, adding or deleting a character in the
11259 beginning of a paragraph, before the first strong directional
11260 character, can change the base direction of the paragraph (unless
11261 the buffer specifies a fixed paragraph direction), which will
11262 require to redisplay the whole paragraph. It might be worthwhile
11263 to find the paragraph limits and widen the range of redisplayed
11264 lines to that, but for now just give up this optimization. */
11265 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
11266 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
11270 return unchanged_p
;
11274 /* Do a frame update, taking possible shortcuts into account. This is
11275 the main external entry point for redisplay.
11277 If the last redisplay displayed an echo area message and that message
11278 is no longer requested, we clear the echo area or bring back the
11279 mini-buffer if that is in use. */
11284 redisplay_internal (0);
11289 overlay_arrow_string_or_property (var
)
11294 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11297 return Voverlay_arrow_string
;
11300 /* Return 1 if there are any overlay-arrows in current_buffer. */
11302 overlay_arrow_in_current_buffer_p ()
11306 for (vlist
= Voverlay_arrow_variable_list
;
11308 vlist
= XCDR (vlist
))
11310 Lisp_Object var
= XCAR (vlist
);
11313 if (!SYMBOLP (var
))
11315 val
= find_symbol_value (var
);
11317 && current_buffer
== XMARKER (val
)->buffer
)
11324 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11328 overlay_arrows_changed_p ()
11332 for (vlist
= Voverlay_arrow_variable_list
;
11334 vlist
= XCDR (vlist
))
11336 Lisp_Object var
= XCAR (vlist
);
11337 Lisp_Object val
, pstr
;
11339 if (!SYMBOLP (var
))
11341 val
= find_symbol_value (var
);
11342 if (!MARKERP (val
))
11344 if (! EQ (COERCE_MARKER (val
),
11345 Fget (var
, Qlast_arrow_position
))
11346 || ! (pstr
= overlay_arrow_string_or_property (var
),
11347 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11353 /* Mark overlay arrows to be updated on next redisplay. */
11356 update_overlay_arrows (up_to_date
)
11361 for (vlist
= Voverlay_arrow_variable_list
;
11363 vlist
= XCDR (vlist
))
11365 Lisp_Object var
= XCAR (vlist
);
11367 if (!SYMBOLP (var
))
11370 if (up_to_date
> 0)
11372 Lisp_Object val
= find_symbol_value (var
);
11373 Fput (var
, Qlast_arrow_position
,
11374 COERCE_MARKER (val
));
11375 Fput (var
, Qlast_arrow_string
,
11376 overlay_arrow_string_or_property (var
));
11378 else if (up_to_date
< 0
11379 || !NILP (Fget (var
, Qlast_arrow_position
)))
11381 Fput (var
, Qlast_arrow_position
, Qt
);
11382 Fput (var
, Qlast_arrow_string
, Qt
);
11388 /* Return overlay arrow string to display at row.
11389 Return integer (bitmap number) for arrow bitmap in left fringe.
11390 Return nil if no overlay arrow. */
11393 overlay_arrow_at_row (it
, row
)
11395 struct glyph_row
*row
;
11399 for (vlist
= Voverlay_arrow_variable_list
;
11401 vlist
= XCDR (vlist
))
11403 Lisp_Object var
= XCAR (vlist
);
11406 if (!SYMBOLP (var
))
11409 val
= find_symbol_value (var
);
11412 && current_buffer
== XMARKER (val
)->buffer
11413 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11415 if (FRAME_WINDOW_P (it
->f
)
11416 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11418 #ifdef HAVE_WINDOW_SYSTEM
11419 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11422 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11423 return make_number (fringe_bitmap
);
11426 return make_number (-1); /* Use default arrow bitmap */
11428 return overlay_arrow_string_or_property (var
);
11435 /* Return 1 if point moved out of or into a composition. Otherwise
11436 return 0. PREV_BUF and PREV_PT are the last point buffer and
11437 position. BUF and PT are the current point buffer and position. */
11440 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
11441 struct buffer
*prev_buf
, *buf
;
11444 EMACS_INT start
, end
;
11446 Lisp_Object buffer
;
11448 XSETBUFFER (buffer
, buf
);
11449 /* Check a composition at the last point if point moved within the
11451 if (prev_buf
== buf
)
11454 /* Point didn't move. */
11457 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11458 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11459 && COMPOSITION_VALID_P (start
, end
, prop
)
11460 && start
< prev_pt
&& end
> prev_pt
)
11461 /* The last point was within the composition. Return 1 iff
11462 point moved out of the composition. */
11463 return (pt
<= start
|| pt
>= end
);
11466 /* Check a composition at the current point. */
11467 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11468 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11469 && COMPOSITION_VALID_P (start
, end
, prop
)
11470 && start
< pt
&& end
> pt
);
11474 /* Reconsider the setting of B->clip_changed which is displayed
11478 reconsider_clip_changes (w
, b
)
11482 if (b
->clip_changed
11483 && !NILP (w
->window_end_valid
)
11484 && w
->current_matrix
->buffer
== b
11485 && w
->current_matrix
->zv
== BUF_ZV (b
)
11486 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11487 b
->clip_changed
= 0;
11489 /* If display wasn't paused, and W is not a tool bar window, see if
11490 point has been moved into or out of a composition. In that case,
11491 we set b->clip_changed to 1 to force updating the screen. If
11492 b->clip_changed has already been set to 1, we can skip this
11494 if (!b
->clip_changed
11495 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11499 if (w
== XWINDOW (selected_window
))
11500 pt
= BUF_PT (current_buffer
);
11502 pt
= marker_position (w
->pointm
);
11504 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11505 || pt
!= XINT (w
->last_point
))
11506 && check_point_in_composition (w
->current_matrix
->buffer
,
11507 XINT (w
->last_point
),
11508 XBUFFER (w
->buffer
), pt
))
11509 b
->clip_changed
= 1;
11514 /* Select FRAME to forward the values of frame-local variables into C
11515 variables so that the redisplay routines can access those values
11519 select_frame_for_redisplay (frame
)
11522 Lisp_Object tail
, symbol
, val
;
11523 Lisp_Object old
= selected_frame
;
11524 struct Lisp_Symbol
*sym
;
11526 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11528 selected_frame
= frame
;
11532 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11533 if (CONSP (XCAR (tail
))
11534 && (symbol
= XCAR (XCAR (tail
)),
11536 && (sym
= indirect_variable (XSYMBOL (symbol
)),
11538 (BUFFER_LOCAL_VALUEP (val
)))
11539 && XBUFFER_LOCAL_VALUE (val
)->check_frame
)
11540 /* Use find_symbol_value rather than Fsymbol_value
11541 to avoid an error if it is void. */
11542 find_symbol_value (symbol
);
11543 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11547 #define STOP_POLLING \
11548 do { if (! polling_stopped_here) stop_polling (); \
11549 polling_stopped_here = 1; } while (0)
11551 #define RESUME_POLLING \
11552 do { if (polling_stopped_here) start_polling (); \
11553 polling_stopped_here = 0; } while (0)
11556 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11557 response to any user action; therefore, we should preserve the echo
11558 area. (Actually, our caller does that job.) Perhaps in the future
11559 avoid recentering windows if it is not necessary; currently that
11560 causes some problems. */
11563 redisplay_internal (preserve_echo_area
)
11564 int preserve_echo_area
;
11566 struct window
*w
= XWINDOW (selected_window
);
11569 int must_finish
= 0;
11570 struct text_pos tlbufpos
, tlendpos
;
11571 int number_of_visible_frames
;
11574 int polling_stopped_here
= 0;
11575 Lisp_Object old_frame
= selected_frame
;
11577 /* Non-zero means redisplay has to consider all windows on all
11578 frames. Zero means, only selected_window is considered. */
11579 int consider_all_windows_p
;
11581 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11583 /* No redisplay if running in batch mode or frame is not yet fully
11584 initialized, or redisplay is explicitly turned off by setting
11585 Vinhibit_redisplay. */
11586 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11587 || !NILP (Vinhibit_redisplay
))
11590 /* Don't examine these until after testing Vinhibit_redisplay.
11591 When Emacs is shutting down, perhaps because its connection to
11592 X has dropped, we should not look at them at all. */
11593 f
= XFRAME (w
->frame
);
11594 sf
= SELECTED_FRAME ();
11596 if (!f
->glyphs_initialized_p
)
11599 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11600 if (popup_activated ())
11604 /* I don't think this happens but let's be paranoid. */
11605 if (redisplaying_p
)
11608 /* Record a function that resets redisplaying_p to its old value
11609 when we leave this function. */
11610 count
= SPECPDL_INDEX ();
11611 record_unwind_protect (unwind_redisplay
,
11612 Fcons (make_number (redisplaying_p
), selected_frame
));
11614 specbind (Qinhibit_free_realized_faces
, Qnil
);
11617 Lisp_Object tail
, frame
;
11619 FOR_EACH_FRAME (tail
, frame
)
11621 struct frame
*f
= XFRAME (frame
);
11622 f
->already_hscrolled_p
= 0;
11627 if (!EQ (old_frame
, selected_frame
)
11628 && FRAME_LIVE_P (XFRAME (old_frame
)))
11629 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11630 selected_frame and selected_window to be temporarily out-of-sync so
11631 when we come back here via `goto retry', we need to resync because we
11632 may need to run Elisp code (via prepare_menu_bars). */
11633 select_frame_for_redisplay (old_frame
);
11636 reconsider_clip_changes (w
, current_buffer
);
11637 last_escape_glyph_frame
= NULL
;
11638 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11640 /* If new fonts have been loaded that make a glyph matrix adjustment
11641 necessary, do it. */
11642 if (fonts_changed_p
)
11644 adjust_glyphs (NULL
);
11645 ++windows_or_buffers_changed
;
11646 fonts_changed_p
= 0;
11649 /* If face_change_count is non-zero, init_iterator will free all
11650 realized faces, which includes the faces referenced from current
11651 matrices. So, we can't reuse current matrices in this case. */
11652 if (face_change_count
)
11653 ++windows_or_buffers_changed
;
11655 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11656 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11658 /* Since frames on a single ASCII terminal share the same
11659 display area, displaying a different frame means redisplay
11660 the whole thing. */
11661 windows_or_buffers_changed
++;
11662 SET_FRAME_GARBAGED (sf
);
11664 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11666 FRAME_TTY (sf
)->previous_frame
= sf
;
11669 /* Set the visible flags for all frames. Do this before checking
11670 for resized or garbaged frames; they want to know if their frames
11671 are visible. See the comment in frame.h for
11672 FRAME_SAMPLE_VISIBILITY. */
11674 Lisp_Object tail
, frame
;
11676 number_of_visible_frames
= 0;
11678 FOR_EACH_FRAME (tail
, frame
)
11680 struct frame
*f
= XFRAME (frame
);
11682 FRAME_SAMPLE_VISIBILITY (f
);
11683 if (FRAME_VISIBLE_P (f
))
11684 ++number_of_visible_frames
;
11685 clear_desired_matrices (f
);
11689 /* Notice any pending interrupt request to change frame size. */
11690 do_pending_window_change (1);
11692 /* Clear frames marked as garbaged. */
11693 if (frame_garbaged
)
11694 clear_garbaged_frames ();
11696 /* Build menubar and tool-bar items. */
11697 if (NILP (Vmemory_full
))
11698 prepare_menu_bars ();
11700 if (windows_or_buffers_changed
)
11701 update_mode_lines
++;
11703 /* Detect case that we need to write or remove a star in the mode line. */
11704 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11706 w
->update_mode_line
= Qt
;
11707 if (buffer_shared
> 1)
11708 update_mode_lines
++;
11711 /* Avoid invocation of point motion hooks by `current_column' below. */
11712 count1
= SPECPDL_INDEX ();
11713 specbind (Qinhibit_point_motion_hooks
, Qt
);
11715 /* If %c is in the mode line, update it if needed. */
11716 if (!NILP (w
->column_number_displayed
)
11717 /* This alternative quickly identifies a common case
11718 where no change is needed. */
11719 && !(PT
== XFASTINT (w
->last_point
)
11720 && XFASTINT (w
->last_modified
) >= MODIFF
11721 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11722 && (XFASTINT (w
->column_number_displayed
)
11723 != (int) current_column ())) /* iftc */
11724 w
->update_mode_line
= Qt
;
11726 unbind_to (count1
, Qnil
);
11728 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11730 /* The variable buffer_shared is set in redisplay_window and
11731 indicates that we redisplay a buffer in different windows. See
11733 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11734 || cursor_type_changed
);
11736 /* If specs for an arrow have changed, do thorough redisplay
11737 to ensure we remove any arrow that should no longer exist. */
11738 if (overlay_arrows_changed_p ())
11739 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11741 /* Normally the message* functions will have already displayed and
11742 updated the echo area, but the frame may have been trashed, or
11743 the update may have been preempted, so display the echo area
11744 again here. Checking message_cleared_p captures the case that
11745 the echo area should be cleared. */
11746 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11747 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11748 || (message_cleared_p
11749 && minibuf_level
== 0
11750 /* If the mini-window is currently selected, this means the
11751 echo-area doesn't show through. */
11752 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11754 int window_height_changed_p
= echo_area_display (0);
11757 /* If we don't display the current message, don't clear the
11758 message_cleared_p flag, because, if we did, we wouldn't clear
11759 the echo area in the next redisplay which doesn't preserve
11761 if (!display_last_displayed_message_p
)
11762 message_cleared_p
= 0;
11764 if (fonts_changed_p
)
11766 else if (window_height_changed_p
)
11768 consider_all_windows_p
= 1;
11769 ++update_mode_lines
;
11770 ++windows_or_buffers_changed
;
11772 /* If window configuration was changed, frames may have been
11773 marked garbaged. Clear them or we will experience
11774 surprises wrt scrolling. */
11775 if (frame_garbaged
)
11776 clear_garbaged_frames ();
11779 else if (EQ (selected_window
, minibuf_window
)
11780 && (current_buffer
->clip_changed
11781 || XFASTINT (w
->last_modified
) < MODIFF
11782 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11783 && resize_mini_window (w
, 0))
11785 /* Resized active mini-window to fit the size of what it is
11786 showing if its contents might have changed. */
11788 /* FIXME: this causes all frames to be updated, which seems unnecessary
11789 since only the current frame needs to be considered. This function needs
11790 to be rewritten with two variables, consider_all_windows and
11791 consider_all_frames. */
11792 consider_all_windows_p
= 1;
11793 ++windows_or_buffers_changed
;
11794 ++update_mode_lines
;
11796 /* If window configuration was changed, frames may have been
11797 marked garbaged. Clear them or we will experience
11798 surprises wrt scrolling. */
11799 if (frame_garbaged
)
11800 clear_garbaged_frames ();
11804 /* If showing the region, and mark has changed, we must redisplay
11805 the whole window. The assignment to this_line_start_pos prevents
11806 the optimization directly below this if-statement. */
11807 if (((!NILP (Vtransient_mark_mode
)
11808 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
11809 != !NILP (w
->region_showing
))
11810 || (!NILP (w
->region_showing
)
11811 && !EQ (w
->region_showing
,
11812 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
11813 CHARPOS (this_line_start_pos
) = 0;
11815 /* Optimize the case that only the line containing the cursor in the
11816 selected window has changed. Variables starting with this_ are
11817 set in display_line and record information about the line
11818 containing the cursor. */
11819 tlbufpos
= this_line_start_pos
;
11820 tlendpos
= this_line_end_pos
;
11821 if (!consider_all_windows_p
11822 && CHARPOS (tlbufpos
) > 0
11823 && NILP (w
->update_mode_line
)
11824 && !current_buffer
->clip_changed
11825 && !current_buffer
->prevent_redisplay_optimizations_p
11826 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11827 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11828 /* Make sure recorded data applies to current buffer, etc. */
11829 && this_line_buffer
== current_buffer
11830 && current_buffer
== XBUFFER (w
->buffer
)
11831 && NILP (w
->force_start
)
11832 && NILP (w
->optional_new_start
)
11833 /* Point must be on the line that we have info recorded about. */
11834 && PT
>= CHARPOS (tlbufpos
)
11835 && PT
<= Z
- CHARPOS (tlendpos
)
11836 /* All text outside that line, including its final newline,
11837 must be unchanged. */
11838 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11839 CHARPOS (tlendpos
)))
11841 if (CHARPOS (tlbufpos
) > BEGV
11842 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11843 && (CHARPOS (tlbufpos
) == ZV
11844 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11845 /* Former continuation line has disappeared by becoming empty. */
11847 else if (XFASTINT (w
->last_modified
) < MODIFF
11848 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11849 || MINI_WINDOW_P (w
))
11851 /* We have to handle the case of continuation around a
11852 wide-column character (see the comment in indent.c around
11855 For instance, in the following case:
11857 -------- Insert --------
11858 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11859 J_I_ ==> J_I_ `^^' are cursors.
11863 As we have to redraw the line above, we cannot use this
11867 int line_height_before
= this_line_pixel_height
;
11869 /* Note that start_display will handle the case that the
11870 line starting at tlbufpos is a continuation line. */
11871 start_display (&it
, w
, tlbufpos
);
11873 /* Implementation note: It this still necessary? */
11874 if (it
.current_x
!= this_line_start_x
)
11877 TRACE ((stderr
, "trying display optimization 1\n"));
11878 w
->cursor
.vpos
= -1;
11879 overlay_arrow_seen
= 0;
11880 it
.vpos
= this_line_vpos
;
11881 it
.current_y
= this_line_y
;
11882 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11883 display_line (&it
);
11885 /* If line contains point, is not continued,
11886 and ends at same distance from eob as before, we win. */
11887 if (w
->cursor
.vpos
>= 0
11888 /* Line is not continued, otherwise this_line_start_pos
11889 would have been set to 0 in display_line. */
11890 && CHARPOS (this_line_start_pos
)
11891 /* Line ends as before. */
11892 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11893 /* Line has same height as before. Otherwise other lines
11894 would have to be shifted up or down. */
11895 && this_line_pixel_height
== line_height_before
)
11897 /* If this is not the window's last line, we must adjust
11898 the charstarts of the lines below. */
11899 if (it
.current_y
< it
.last_visible_y
)
11901 struct glyph_row
*row
11902 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11903 int delta
, delta_bytes
;
11905 /* We used to distinguish between two cases here,
11906 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11907 when the line ends in a newline or the end of the
11908 buffer's accessible portion. But both cases did
11909 the same, so they were collapsed. */
11911 - CHARPOS (tlendpos
)
11912 - MATRIX_ROW_START_CHARPOS (row
));
11913 delta_bytes
= (Z_BYTE
11914 - BYTEPOS (tlendpos
)
11915 - MATRIX_ROW_START_BYTEPOS (row
));
11917 increment_matrix_positions (w
->current_matrix
,
11918 this_line_vpos
+ 1,
11919 w
->current_matrix
->nrows
,
11920 delta
, delta_bytes
);
11923 /* If this row displays text now but previously didn't,
11924 or vice versa, w->window_end_vpos may have to be
11926 if ((it
.glyph_row
- 1)->displays_text_p
)
11928 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11929 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11931 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11932 && this_line_vpos
> 0)
11933 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11934 w
->window_end_valid
= Qnil
;
11936 /* Update hint: No need to try to scroll in update_window. */
11937 w
->desired_matrix
->no_scrolling_p
= 1;
11940 *w
->desired_matrix
->method
= 0;
11941 debug_method_add (w
, "optimization 1");
11943 #ifdef HAVE_WINDOW_SYSTEM
11944 update_window_fringes (w
, 0);
11951 else if (/* Cursor position hasn't changed. */
11952 PT
== XFASTINT (w
->last_point
)
11953 /* Make sure the cursor was last displayed
11954 in this window. Otherwise we have to reposition it. */
11955 && 0 <= w
->cursor
.vpos
11956 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11960 do_pending_window_change (1);
11962 /* We used to always goto end_of_redisplay here, but this
11963 isn't enough if we have a blinking cursor. */
11964 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11965 goto end_of_redisplay
;
11969 /* If highlighting the region, or if the cursor is in the echo area,
11970 then we can't just move the cursor. */
11971 else if (! (!NILP (Vtransient_mark_mode
)
11972 && !NILP (current_buffer
->mark_active
))
11973 && (EQ (selected_window
, current_buffer
->last_selected_window
)
11974 || highlight_nonselected_windows
)
11975 && NILP (w
->region_showing
)
11976 && NILP (Vshow_trailing_whitespace
)
11977 && !cursor_in_echo_area
)
11980 struct glyph_row
*row
;
11982 /* Skip from tlbufpos to PT and see where it is. Note that
11983 PT may be in invisible text. If so, we will end at the
11984 next visible position. */
11985 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11986 NULL
, DEFAULT_FACE_ID
);
11987 it
.current_x
= this_line_start_x
;
11988 it
.current_y
= this_line_y
;
11989 it
.vpos
= this_line_vpos
;
11991 /* The call to move_it_to stops in front of PT, but
11992 moves over before-strings. */
11993 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11995 if (it
.vpos
== this_line_vpos
11996 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11999 xassert (this_line_vpos
== it
.vpos
);
12000 xassert (this_line_y
== it
.current_y
);
12001 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
12003 *w
->desired_matrix
->method
= 0;
12004 debug_method_add (w
, "optimization 3");
12013 /* Text changed drastically or point moved off of line. */
12014 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
12017 CHARPOS (this_line_start_pos
) = 0;
12018 consider_all_windows_p
|= buffer_shared
> 1;
12019 ++clear_face_cache_count
;
12020 #ifdef HAVE_WINDOW_SYSTEM
12021 ++clear_image_cache_count
;
12024 /* Build desired matrices, and update the display. If
12025 consider_all_windows_p is non-zero, do it for all windows on all
12026 frames. Otherwise do it for selected_window, only. */
12028 if (consider_all_windows_p
)
12030 Lisp_Object tail
, frame
;
12032 FOR_EACH_FRAME (tail
, frame
)
12033 XFRAME (frame
)->updated_p
= 0;
12035 /* Recompute # windows showing selected buffer. This will be
12036 incremented each time such a window is displayed. */
12039 FOR_EACH_FRAME (tail
, frame
)
12041 struct frame
*f
= XFRAME (frame
);
12043 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
12045 if (! EQ (frame
, selected_frame
))
12046 /* Select the frame, for the sake of frame-local
12048 select_frame_for_redisplay (frame
);
12050 /* Mark all the scroll bars to be removed; we'll redeem
12051 the ones we want when we redisplay their windows. */
12052 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
12053 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
12055 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12056 redisplay_windows (FRAME_ROOT_WINDOW (f
));
12058 /* The X error handler may have deleted that frame. */
12059 if (!FRAME_LIVE_P (f
))
12062 /* Any scroll bars which redisplay_windows should have
12063 nuked should now go away. */
12064 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
12065 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
12067 /* If fonts changed, display again. */
12068 /* ??? rms: I suspect it is a mistake to jump all the way
12069 back to retry here. It should just retry this frame. */
12070 if (fonts_changed_p
)
12073 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12075 /* See if we have to hscroll. */
12076 if (!f
->already_hscrolled_p
)
12078 f
->already_hscrolled_p
= 1;
12079 if (hscroll_windows (f
->root_window
))
12083 /* Prevent various kinds of signals during display
12084 update. stdio is not robust about handling
12085 signals, which can cause an apparent I/O
12087 if (interrupt_input
)
12088 unrequest_sigio ();
12091 /* Update the display. */
12092 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12093 pause
|= update_frame (f
, 0, 0);
12099 if (!EQ (old_frame
, selected_frame
)
12100 && FRAME_LIVE_P (XFRAME (old_frame
)))
12101 /* We played a bit fast-and-loose above and allowed selected_frame
12102 and selected_window to be temporarily out-of-sync but let's make
12103 sure this stays contained. */
12104 select_frame_for_redisplay (old_frame
);
12105 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12109 /* Do the mark_window_display_accurate after all windows have
12110 been redisplayed because this call resets flags in buffers
12111 which are needed for proper redisplay. */
12112 FOR_EACH_FRAME (tail
, frame
)
12114 struct frame
*f
= XFRAME (frame
);
12117 mark_window_display_accurate (f
->root_window
, 1);
12118 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12119 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12124 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12126 Lisp_Object mini_window
;
12127 struct frame
*mini_frame
;
12129 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12130 /* Use list_of_error, not Qerror, so that
12131 we catch only errors and don't run the debugger. */
12132 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12134 redisplay_window_error
);
12136 /* Compare desired and current matrices, perform output. */
12139 /* If fonts changed, display again. */
12140 if (fonts_changed_p
)
12143 /* Prevent various kinds of signals during display update.
12144 stdio is not robust about handling signals,
12145 which can cause an apparent I/O error. */
12146 if (interrupt_input
)
12147 unrequest_sigio ();
12150 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12152 if (hscroll_windows (selected_window
))
12155 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12156 pause
= update_frame (sf
, 0, 0);
12159 /* We may have called echo_area_display at the top of this
12160 function. If the echo area is on another frame, that may
12161 have put text on a frame other than the selected one, so the
12162 above call to update_frame would not have caught it. Catch
12164 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12165 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12167 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12169 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12170 pause
|= update_frame (mini_frame
, 0, 0);
12171 if (!pause
&& hscroll_windows (mini_window
))
12176 /* If display was paused because of pending input, make sure we do a
12177 thorough update the next time. */
12180 /* Prevent the optimization at the beginning of
12181 redisplay_internal that tries a single-line update of the
12182 line containing the cursor in the selected window. */
12183 CHARPOS (this_line_start_pos
) = 0;
12185 /* Let the overlay arrow be updated the next time. */
12186 update_overlay_arrows (0);
12188 /* If we pause after scrolling, some rows in the current
12189 matrices of some windows are not valid. */
12190 if (!WINDOW_FULL_WIDTH_P (w
)
12191 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12192 update_mode_lines
= 1;
12196 if (!consider_all_windows_p
)
12198 /* This has already been done above if
12199 consider_all_windows_p is set. */
12200 mark_window_display_accurate_1 (w
, 1);
12202 /* Say overlay arrows are up to date. */
12203 update_overlay_arrows (1);
12205 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12206 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12209 update_mode_lines
= 0;
12210 windows_or_buffers_changed
= 0;
12211 cursor_type_changed
= 0;
12214 /* Start SIGIO interrupts coming again. Having them off during the
12215 code above makes it less likely one will discard output, but not
12216 impossible, since there might be stuff in the system buffer here.
12217 But it is much hairier to try to do anything about that. */
12218 if (interrupt_input
)
12222 /* If a frame has become visible which was not before, redisplay
12223 again, so that we display it. Expose events for such a frame
12224 (which it gets when becoming visible) don't call the parts of
12225 redisplay constructing glyphs, so simply exposing a frame won't
12226 display anything in this case. So, we have to display these
12227 frames here explicitly. */
12230 Lisp_Object tail
, frame
;
12233 FOR_EACH_FRAME (tail
, frame
)
12235 int this_is_visible
= 0;
12237 if (XFRAME (frame
)->visible
)
12238 this_is_visible
= 1;
12239 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12240 if (XFRAME (frame
)->visible
)
12241 this_is_visible
= 1;
12243 if (this_is_visible
)
12247 if (new_count
!= number_of_visible_frames
)
12248 windows_or_buffers_changed
++;
12251 /* Change frame size now if a change is pending. */
12252 do_pending_window_change (1);
12254 /* If we just did a pending size change, or have additional
12255 visible frames, redisplay again. */
12256 if (windows_or_buffers_changed
&& !pause
)
12259 /* Clear the face cache eventually. */
12260 if (consider_all_windows_p
)
12262 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12264 clear_face_cache (0);
12265 clear_face_cache_count
= 0;
12267 #ifdef HAVE_WINDOW_SYSTEM
12268 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12270 clear_image_caches (Qnil
);
12271 clear_image_cache_count
= 0;
12273 #endif /* HAVE_WINDOW_SYSTEM */
12277 unbind_to (count
, Qnil
);
12282 /* Redisplay, but leave alone any recent echo area message unless
12283 another message has been requested in its place.
12285 This is useful in situations where you need to redisplay but no
12286 user action has occurred, making it inappropriate for the message
12287 area to be cleared. See tracking_off and
12288 wait_reading_process_output for examples of these situations.
12290 FROM_WHERE is an integer saying from where this function was
12291 called. This is useful for debugging. */
12294 redisplay_preserve_echo_area (from_where
)
12297 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12299 if (!NILP (echo_area_buffer
[1]))
12301 /* We have a previously displayed message, but no current
12302 message. Redisplay the previous message. */
12303 display_last_displayed_message_p
= 1;
12304 redisplay_internal (1);
12305 display_last_displayed_message_p
= 0;
12308 redisplay_internal (1);
12310 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12311 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12312 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12316 /* Function registered with record_unwind_protect in
12317 redisplay_internal. Reset redisplaying_p to the value it had
12318 before redisplay_internal was called, and clear
12319 prevent_freeing_realized_faces_p. It also selects the previously
12320 selected frame, unless it has been deleted (by an X connection
12321 failure during redisplay, for example). */
12324 unwind_redisplay (val
)
12327 Lisp_Object old_redisplaying_p
, old_frame
;
12329 old_redisplaying_p
= XCAR (val
);
12330 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12331 old_frame
= XCDR (val
);
12332 if (! EQ (old_frame
, selected_frame
)
12333 && FRAME_LIVE_P (XFRAME (old_frame
)))
12334 select_frame_for_redisplay (old_frame
);
12339 /* Mark the display of window W as accurate or inaccurate. If
12340 ACCURATE_P is non-zero mark display of W as accurate. If
12341 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12342 redisplay_internal is called. */
12345 mark_window_display_accurate_1 (w
, accurate_p
)
12349 if (BUFFERP (w
->buffer
))
12351 struct buffer
*b
= XBUFFER (w
->buffer
);
12354 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12355 w
->last_overlay_modified
12356 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12358 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12362 b
->clip_changed
= 0;
12363 b
->prevent_redisplay_optimizations_p
= 0;
12365 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12366 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12367 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12368 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12370 w
->current_matrix
->buffer
= b
;
12371 w
->current_matrix
->begv
= BUF_BEGV (b
);
12372 w
->current_matrix
->zv
= BUF_ZV (b
);
12374 w
->last_cursor
= w
->cursor
;
12375 w
->last_cursor_off_p
= w
->cursor_off_p
;
12377 if (w
== XWINDOW (selected_window
))
12378 w
->last_point
= make_number (BUF_PT (b
));
12380 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12386 w
->window_end_valid
= w
->buffer
;
12387 w
->update_mode_line
= Qnil
;
12392 /* Mark the display of windows in the window tree rooted at WINDOW as
12393 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12394 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12395 be redisplayed the next time redisplay_internal is called. */
12398 mark_window_display_accurate (window
, accurate_p
)
12399 Lisp_Object window
;
12404 for (; !NILP (window
); window
= w
->next
)
12406 w
= XWINDOW (window
);
12407 mark_window_display_accurate_1 (w
, accurate_p
);
12409 if (!NILP (w
->vchild
))
12410 mark_window_display_accurate (w
->vchild
, accurate_p
);
12411 if (!NILP (w
->hchild
))
12412 mark_window_display_accurate (w
->hchild
, accurate_p
);
12417 update_overlay_arrows (1);
12421 /* Force a thorough redisplay the next time by setting
12422 last_arrow_position and last_arrow_string to t, which is
12423 unequal to any useful value of Voverlay_arrow_... */
12424 update_overlay_arrows (-1);
12429 /* Return value in display table DP (Lisp_Char_Table *) for character
12430 C. Since a display table doesn't have any parent, we don't have to
12431 follow parent. Do not call this function directly but use the
12432 macro DISP_CHAR_VECTOR. */
12435 disp_char_vector (dp
, c
)
12436 struct Lisp_Char_Table
*dp
;
12441 if (ASCII_CHAR_P (c
))
12444 if (SUB_CHAR_TABLE_P (val
))
12445 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12451 XSETCHAR_TABLE (table
, dp
);
12452 val
= char_table_ref (table
, c
);
12461 /***********************************************************************
12463 ***********************************************************************/
12465 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12468 redisplay_windows (window
)
12469 Lisp_Object window
;
12471 while (!NILP (window
))
12473 struct window
*w
= XWINDOW (window
);
12475 if (!NILP (w
->hchild
))
12476 redisplay_windows (w
->hchild
);
12477 else if (!NILP (w
->vchild
))
12478 redisplay_windows (w
->vchild
);
12479 else if (!NILP (w
->buffer
))
12481 displayed_buffer
= XBUFFER (w
->buffer
);
12482 /* Use list_of_error, not Qerror, so that
12483 we catch only errors and don't run the debugger. */
12484 internal_condition_case_1 (redisplay_window_0
, window
,
12486 redisplay_window_error
);
12494 redisplay_window_error ()
12496 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12501 redisplay_window_0 (window
)
12502 Lisp_Object window
;
12504 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12505 redisplay_window (window
, 0);
12510 redisplay_window_1 (window
)
12511 Lisp_Object window
;
12513 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12514 redisplay_window (window
, 1);
12519 /* Increment GLYPH until it reaches END or CONDITION fails while
12520 adding (GLYPH)->pixel_width to X. */
12522 #define SKIP_GLYPHS(glyph, end, x, condition) \
12525 (x) += (glyph)->pixel_width; \
12528 while ((glyph) < (end) && (condition))
12531 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12532 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12533 which positions recorded in ROW differ from current buffer
12536 Return 0 if cursor is not on this row, 1 otherwise. */
12539 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
12541 struct glyph_row
*row
;
12542 struct glyph_matrix
*matrix
;
12543 int delta
, delta_bytes
, dy
, dvpos
;
12545 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12546 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12547 struct glyph
*cursor
= NULL
;
12548 /* The last known character position in row. */
12549 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12552 EMACS_INT pt_old
= PT
- delta
;
12553 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12554 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12555 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12556 /* Non-zero means we've found a match for cursor position, but that
12557 glyph has the avoid_cursor_p flag set. */
12558 int match_with_avoid_cursor
= 0;
12559 /* Non-zero means we've seen at least one glyph that came from a
12561 int string_seen
= 0;
12562 /* Largest buffer position seen so far during scan of glyph row. */
12563 EMACS_INT bpos_max
= last_pos
;
12564 /* Last buffer position covered by an overlay string with an integer
12565 `cursor' property. */
12566 EMACS_INT bpos_covered
= 0;
12568 /* Skip over glyphs not having an object at the start and the end of
12569 the row. These are special glyphs like truncation marks on
12570 terminal frames. */
12571 if (row
->displays_text_p
)
12573 if (!row
->reversed_p
)
12576 && INTEGERP (glyph
->object
)
12577 && glyph
->charpos
< 0)
12579 x
+= glyph
->pixel_width
;
12583 && INTEGERP ((end
- 1)->object
)
12584 /* CHARPOS is zero for blanks inserted by
12585 extend_face_to_end_of_line. */
12586 && (end
- 1)->charpos
<= 0)
12588 glyph_before
= glyph
- 1;
12595 /* If the glyph row is reversed, we need to process it from back
12596 to front, so swap the edge pointers. */
12598 glyph
+= row
->used
[TEXT_AREA
] - 1;
12599 /* Reverse the known positions in the row. */
12600 last_pos
= pos_after
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12601 pos_before
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12603 while (glyph
> end
+ 1
12604 && INTEGERP (glyph
->object
)
12605 && glyph
->charpos
< 0)
12608 x
-= glyph
->pixel_width
;
12610 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12612 /* By default, in reversed rows we put the cursor on the
12613 rightmost (first in the reading order) glyph. */
12614 for (g
= end
+ 1; g
< glyph
; g
++)
12615 x
+= g
->pixel_width
;
12618 && INTEGERP ((end
+ 1)->object
)
12619 && (end
+ 1)->charpos
<= 0)
12621 glyph_before
= glyph
+ 1;
12625 else if (row
->reversed_p
)
12627 /* In R2L rows that don't display text, put the cursor on the
12628 rightmost glyph. Case in point: an empty last line that is
12629 part of an R2L paragraph. */
12631 x
= -1; /* will be computed below, at lable compute_x */
12634 /* Step 1: Try to find the glyph whose character position
12635 corresponds to point. If that's not possible, find 2 glyphs
12636 whose character positions are the closest to point, one before
12637 point, the other after it. */
12638 if (!row
->reversed_p
)
12639 while (/* not marched to end of glyph row */
12641 /* glyph was not inserted by redisplay for internal purposes */
12642 && !INTEGERP (glyph
->object
))
12644 if (BUFFERP (glyph
->object
))
12646 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12648 if (glyph
->charpos
> bpos_max
)
12649 bpos_max
= glyph
->charpos
;
12650 if (!glyph
->avoid_cursor_p
)
12652 /* If we hit point, we've found the glyph on which to
12653 display the cursor. */
12656 match_with_avoid_cursor
= 0;
12659 /* See if we've found a better approximation to
12660 POS_BEFORE or to POS_AFTER. Note that we want the
12661 first (leftmost) glyph of all those that are the
12662 closest from below, and the last (rightmost) of all
12663 those from above. */
12664 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12666 pos_before
= glyph
->charpos
;
12667 glyph_before
= glyph
;
12669 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12671 pos_after
= glyph
->charpos
;
12672 glyph_after
= glyph
;
12675 else if (dpos
== 0)
12676 match_with_avoid_cursor
= 1;
12678 else if (STRINGP (glyph
->object
))
12680 Lisp_Object chprop
;
12681 int glyph_pos
= glyph
->charpos
;
12683 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12685 if (INTEGERP (chprop
))
12687 bpos_covered
= bpos_max
+ XINT (chprop
);
12688 /* If the `cursor' property covers buffer positions up
12689 to and including point, we should display cursor on
12690 this glyph. Note that overlays and text properties
12691 with string values stop bidi reordering, so every
12692 buffer position to the left of the string is always
12693 smaller than any position to the right of the
12694 string. Therefore, if a `cursor' property on one
12695 of the string's characters has an integer value, we
12696 will break out of the loop below _before_ we get to
12697 the position match above. IOW, integer values of
12698 the `cursor' property override the "exact match for
12699 point" strategy of positioning the cursor. */
12700 /* Implementation note: bpos_max == pt_old when, e.g.,
12701 we are in an empty line, where bpos_max is set to
12702 MATRIX_ROW_START_CHARPOS, see above. */
12703 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12712 x
+= glyph
->pixel_width
;
12715 else if (glyph
> end
) /* row is reversed */
12716 while (!INTEGERP (glyph
->object
))
12718 if (BUFFERP (glyph
->object
))
12720 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12722 if (glyph
->charpos
> bpos_max
)
12723 bpos_max
= glyph
->charpos
;
12724 if (!glyph
->avoid_cursor_p
)
12728 match_with_avoid_cursor
= 0;
12731 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12733 pos_before
= glyph
->charpos
;
12734 glyph_before
= glyph
;
12736 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12738 pos_after
= glyph
->charpos
;
12739 glyph_after
= glyph
;
12742 else if (dpos
== 0)
12743 match_with_avoid_cursor
= 1;
12745 else if (STRINGP (glyph
->object
))
12747 Lisp_Object chprop
;
12748 int glyph_pos
= glyph
->charpos
;
12750 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12752 if (INTEGERP (chprop
))
12754 bpos_covered
= bpos_max
+ XINT (chprop
);
12755 /* If the `cursor' property covers buffer positions up
12756 to and including point, we should display cursor on
12758 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12769 x
-= glyph
->pixel_width
;
12772 /* Step 2: If we didn't find an exact match for point, we need to
12773 look for a proper place to put the cursor among glyphs between
12774 GLYPH_BEFORE and GLYPH_AFTER. */
12775 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12776 && bpos_covered
< pt_old
)
12778 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12780 EMACS_INT ellipsis_pos
;
12782 /* Scan back over the ellipsis glyphs. */
12783 if (!row
->reversed_p
)
12785 ellipsis_pos
= (glyph
- 1)->charpos
;
12786 while (glyph
> row
->glyphs
[TEXT_AREA
]
12787 && (glyph
- 1)->charpos
== ellipsis_pos
)
12788 glyph
--, x
-= glyph
->pixel_width
;
12789 /* That loop always goes one position too far, including
12790 the glyph before the ellipsis. So scan forward over
12792 x
+= glyph
->pixel_width
;
12795 else /* row is reversed */
12797 ellipsis_pos
= (glyph
+ 1)->charpos
;
12798 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12799 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12800 glyph
++, x
+= glyph
->pixel_width
;
12801 x
-= glyph
->pixel_width
;
12805 else if (match_with_avoid_cursor
12806 /* zero-width characters produce no glyphs */
12807 || eabs (glyph_after
- glyph_before
) == 1)
12809 cursor
= glyph_after
;
12812 else if (string_seen
)
12814 int incr
= row
->reversed_p
? -1 : +1;
12816 /* Need to find the glyph that came out of a string which is
12817 present at point. That glyph is somewhere between
12818 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12819 positioned between POS_BEFORE and POS_AFTER in the
12821 struct glyph
*stop
= glyph_after
;
12822 EMACS_INT pos
= pos_before
;
12825 for (glyph
= glyph_before
+ incr
;
12826 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12829 /* Any glyphs that come from the buffer are here because
12830 of bidi reordering. Skip them, and only pay
12831 attention to glyphs that came from some string. */
12832 if (STRINGP (glyph
->object
))
12837 str
= glyph
->object
;
12838 tem
= string_buffer_position_lim (w
, str
, pos
, pos_after
, 0);
12839 if (tem
== 0 /* from overlay */
12842 /* If the string from which this glyph came is
12843 found in the buffer at point, then we've
12844 found the glyph we've been looking for. If
12845 it comes from an overlay (tem == 0), and it
12846 has the `cursor' property on one of its
12847 glyphs, record that glyph as a candidate for
12848 displaying the cursor. (As in the
12849 unidirectional version, we will display the
12850 cursor on the last candidate we find.) */
12851 if (tem
== 0 || tem
== pt_old
)
12853 /* The glyphs from this string could have
12854 been reordered. Find the one with the
12855 smallest string position. Or there could
12856 be a character in the string with the
12857 `cursor' property, which means display
12858 cursor on that character's glyph. */
12859 int strpos
= glyph
->charpos
;
12862 for (glyph
+= incr
;
12863 EQ (glyph
->object
, str
);
12867 int gpos
= glyph
->charpos
;
12869 cprop
= Fget_char_property (make_number (gpos
),
12877 if (glyph
->charpos
< strpos
)
12879 strpos
= glyph
->charpos
;
12888 pos
= tem
+ 1; /* don't find previous instances */
12890 /* This string is not what we want; skip all of the
12891 glyphs that came from it. */
12894 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12895 && EQ (glyph
->object
, str
));
12901 /* If we reached the end of the line, and END was from a string,
12902 the cursor is not on this line. */
12904 && STRINGP ((glyph
- incr
)->object
)
12905 && row
->continued_p
)
12911 if (cursor
!= NULL
)
12917 /* Need to compute x that corresponds to GLYPH. */
12918 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
12920 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
12922 x
+= g
->pixel_width
;
12926 /* ROW could be part of a continued line, which might have other
12927 rows whose start and end charpos occlude point. Only set
12928 w->cursor if we found a better approximation to the cursor
12929 position than we have from previously examined rows. */
12930 if (w
->cursor
.vpos
>= 0
12931 /* Make sure cursor.vpos specifies a row whose start and end
12932 charpos occlude point. This is because some callers of this
12933 function leave cursor.vpos at the row where the cursor was
12934 displayed during the last redisplay cycle. */
12935 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
12936 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
12939 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
12941 /* Keep the candidate whose buffer position is the closest to
12943 if (BUFFERP (g1
->object
)
12944 && (g1
->charpos
== pt_old
/* an exact match always wins */
12945 || (BUFFERP (glyph
->object
)
12946 && eabs (g1
->charpos
- pt_old
)
12947 < eabs (glyph
->charpos
- pt_old
))))
12949 /* If this candidate gives an exact match, use that. */
12950 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12951 /* Otherwise, keep the candidate that comes from a row
12952 spanning less buffer positions. This may win when one or
12953 both candidate positions are on glyphs that came from
12954 display strings, for which we cannot compare buffer
12956 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12957 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12958 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
12961 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12963 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12964 w
->cursor
.y
= row
->y
+ dy
;
12966 if (w
== XWINDOW (selected_window
))
12968 if (!row
->continued_p
12969 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12972 this_line_buffer
= XBUFFER (w
->buffer
);
12974 CHARPOS (this_line_start_pos
)
12975 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12976 BYTEPOS (this_line_start_pos
)
12977 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12979 CHARPOS (this_line_end_pos
)
12980 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12981 BYTEPOS (this_line_end_pos
)
12982 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12984 this_line_y
= w
->cursor
.y
;
12985 this_line_pixel_height
= row
->height
;
12986 this_line_vpos
= w
->cursor
.vpos
;
12987 this_line_start_x
= row
->x
;
12990 CHARPOS (this_line_start_pos
) = 0;
12997 /* Run window scroll functions, if any, for WINDOW with new window
12998 start STARTP. Sets the window start of WINDOW to that position.
13000 We assume that the window's buffer is really current. */
13002 static INLINE
struct text_pos
13003 run_window_scroll_functions (window
, startp
)
13004 Lisp_Object window
;
13005 struct text_pos startp
;
13007 struct window
*w
= XWINDOW (window
);
13008 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
13010 if (current_buffer
!= XBUFFER (w
->buffer
))
13013 if (!NILP (Vwindow_scroll_functions
))
13015 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
13016 make_number (CHARPOS (startp
)));
13017 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13018 /* In case the hook functions switch buffers. */
13019 if (current_buffer
!= XBUFFER (w
->buffer
))
13020 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13027 /* Make sure the line containing the cursor is fully visible.
13028 A value of 1 means there is nothing to be done.
13029 (Either the line is fully visible, or it cannot be made so,
13030 or we cannot tell.)
13032 If FORCE_P is non-zero, return 0 even if partial visible cursor row
13033 is higher than window.
13035 A value of 0 means the caller should do scrolling
13036 as if point had gone off the screen. */
13039 cursor_row_fully_visible_p (w
, force_p
, current_matrix_p
)
13042 int current_matrix_p
;
13044 struct glyph_matrix
*matrix
;
13045 struct glyph_row
*row
;
13048 if (!make_cursor_line_fully_visible_p
)
13051 /* It's not always possible to find the cursor, e.g, when a window
13052 is full of overlay strings. Don't do anything in that case. */
13053 if (w
->cursor
.vpos
< 0)
13056 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13057 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13059 /* If the cursor row is not partially visible, there's nothing to do. */
13060 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13063 /* If the row the cursor is in is taller than the window's height,
13064 it's not clear what to do, so do nothing. */
13065 window_height
= window_box_height (w
);
13066 if (row
->height
>= window_height
)
13068 if (!force_p
|| MINI_WINDOW_P (w
)
13069 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13076 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13077 non-zero means only WINDOW is redisplayed in redisplay_internal.
13078 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
13079 in redisplay_window to bring a partially visible line into view in
13080 the case that only the cursor has moved.
13082 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13083 last screen line's vertical height extends past the end of the screen.
13087 1 if scrolling succeeded
13089 0 if scrolling didn't find point.
13091 -1 if new fonts have been loaded so that we must interrupt
13092 redisplay, adjust glyph matrices, and try again. */
13098 SCROLLING_NEED_LARGER_MATRICES
13102 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
13103 scroll_step
, temp_scroll_step
, last_line_misfit
)
13104 Lisp_Object window
;
13105 int just_this_one_p
;
13106 EMACS_INT scroll_conservatively
, scroll_step
;
13107 int temp_scroll_step
;
13108 int last_line_misfit
;
13110 struct window
*w
= XWINDOW (window
);
13111 struct frame
*f
= XFRAME (w
->frame
);
13112 struct text_pos pos
, startp
;
13114 int this_scroll_margin
, scroll_max
, rc
, height
;
13115 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13116 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13117 Lisp_Object aggressive
;
13118 int scroll_limit
= INT_MAX
/ FRAME_LINE_HEIGHT (f
);
13121 debug_method_add (w
, "try_scrolling");
13124 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13126 /* Compute scroll margin height in pixels. We scroll when point is
13127 within this distance from the top or bottom of the window. */
13128 if (scroll_margin
> 0)
13129 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13130 * FRAME_LINE_HEIGHT (f
);
13132 this_scroll_margin
= 0;
13134 /* Force scroll_conservatively to have a reasonable value, to avoid
13135 overflow while computing how much to scroll. Note that the user
13136 can supply scroll-conservatively equal to `most-positive-fixnum',
13137 which can be larger than INT_MAX. */
13138 if (scroll_conservatively
> scroll_limit
)
13140 scroll_conservatively
= scroll_limit
;
13141 scroll_max
= INT_MAX
;
13143 else if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
13144 /* Compute how much we should try to scroll maximally to bring
13145 point into view. */
13146 scroll_max
= (max (scroll_step
,
13147 max (scroll_conservatively
, temp_scroll_step
))
13148 * FRAME_LINE_HEIGHT (f
));
13149 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
13150 || NUMBERP (current_buffer
->scroll_up_aggressively
))
13151 /* We're trying to scroll because of aggressive scrolling but no
13152 scroll_step is set. Choose an arbitrary one. */
13153 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13159 /* Decide whether to scroll down. */
13160 if (PT
> CHARPOS (startp
))
13162 int scroll_margin_y
;
13164 /* Compute the pixel ypos of the scroll margin, then move it to
13165 either that ypos or PT, whichever comes first. */
13166 start_display (&it
, w
, startp
);
13167 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13168 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13169 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13170 (MOVE_TO_POS
| MOVE_TO_Y
));
13172 if (PT
> CHARPOS (it
.current
.pos
))
13174 int y0
= line_bottom_y (&it
);
13176 /* Compute the distance from the scroll margin to PT
13177 (including the height of the cursor line). Moving the
13178 iterator unconditionally to PT can be slow if PT is far
13179 away, so stop 10 lines past the window bottom (is there a
13180 way to do the right thing quickly?). */
13181 move_it_to (&it
, PT
, -1,
13182 it
.last_visible_y
+ 10 * FRAME_LINE_HEIGHT (f
),
13183 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13184 dy
= line_bottom_y (&it
) - y0
;
13186 if (dy
> scroll_max
)
13187 return SCROLLING_FAILED
;
13195 /* Point is in or below the bottom scroll margin, so move the
13196 window start down. If scrolling conservatively, move it just
13197 enough down to make point visible. If scroll_step is set,
13198 move it down by scroll_step. */
13199 if (scroll_conservatively
)
13201 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13202 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
13203 else if (scroll_step
|| temp_scroll_step
)
13204 amount_to_scroll
= scroll_max
;
13207 aggressive
= current_buffer
->scroll_up_aggressively
;
13208 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13209 if (NUMBERP (aggressive
))
13211 double float_amount
= XFLOATINT (aggressive
) * height
;
13212 amount_to_scroll
= float_amount
;
13213 if (amount_to_scroll
== 0 && float_amount
> 0)
13214 amount_to_scroll
= 1;
13218 if (amount_to_scroll
<= 0)
13219 return SCROLLING_FAILED
;
13221 start_display (&it
, w
, startp
);
13222 move_it_vertically (&it
, amount_to_scroll
);
13224 /* If STARTP is unchanged, move it down another screen line. */
13225 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13226 move_it_by_lines (&it
, 1, 1);
13227 startp
= it
.current
.pos
;
13231 struct text_pos scroll_margin_pos
= startp
;
13233 /* See if point is inside the scroll margin at the top of the
13235 if (this_scroll_margin
)
13237 start_display (&it
, w
, startp
);
13238 move_it_vertically (&it
, this_scroll_margin
);
13239 scroll_margin_pos
= it
.current
.pos
;
13242 if (PT
< CHARPOS (scroll_margin_pos
))
13244 /* Point is in the scroll margin at the top of the window or
13245 above what is displayed in the window. */
13248 /* Compute the vertical distance from PT to the scroll
13249 margin position. Give up if distance is greater than
13251 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13252 start_display (&it
, w
, pos
);
13254 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13255 it
.last_visible_y
, -1,
13256 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13257 dy
= it
.current_y
- y0
;
13258 if (dy
> scroll_max
)
13259 return SCROLLING_FAILED
;
13261 /* Compute new window start. */
13262 start_display (&it
, w
, startp
);
13264 if (scroll_conservatively
)
13266 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
13267 else if (scroll_step
|| temp_scroll_step
)
13268 amount_to_scroll
= scroll_max
;
13271 aggressive
= current_buffer
->scroll_down_aggressively
;
13272 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13273 if (NUMBERP (aggressive
))
13275 double float_amount
= XFLOATINT (aggressive
) * height
;
13276 amount_to_scroll
= float_amount
;
13277 if (amount_to_scroll
== 0 && float_amount
> 0)
13278 amount_to_scroll
= 1;
13282 if (amount_to_scroll
<= 0)
13283 return SCROLLING_FAILED
;
13285 move_it_vertically_backward (&it
, amount_to_scroll
);
13286 startp
= it
.current
.pos
;
13290 /* Run window scroll functions. */
13291 startp
= run_window_scroll_functions (window
, startp
);
13293 /* Display the window. Give up if new fonts are loaded, or if point
13295 if (!try_window (window
, startp
, 0))
13296 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13297 else if (w
->cursor
.vpos
< 0)
13299 clear_glyph_matrix (w
->desired_matrix
);
13300 rc
= SCROLLING_FAILED
;
13304 /* Maybe forget recorded base line for line number display. */
13305 if (!just_this_one_p
13306 || current_buffer
->clip_changed
13307 || BEG_UNCHANGED
< CHARPOS (startp
))
13308 w
->base_line_number
= Qnil
;
13310 /* If cursor ends up on a partially visible line,
13311 treat that as being off the bottom of the screen. */
13312 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
13314 clear_glyph_matrix (w
->desired_matrix
);
13315 ++extra_scroll_margin_lines
;
13318 rc
= SCROLLING_SUCCESS
;
13325 /* Compute a suitable window start for window W if display of W starts
13326 on a continuation line. Value is non-zero if a new window start
13329 The new window start will be computed, based on W's width, starting
13330 from the start of the continued line. It is the start of the
13331 screen line with the minimum distance from the old start W->start. */
13334 compute_window_start_on_continuation_line (w
)
13337 struct text_pos pos
, start_pos
;
13338 int window_start_changed_p
= 0;
13340 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13342 /* If window start is on a continuation line... Window start may be
13343 < BEGV in case there's invisible text at the start of the
13344 buffer (M-x rmail, for example). */
13345 if (CHARPOS (start_pos
) > BEGV
13346 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13349 struct glyph_row
*row
;
13351 /* Handle the case that the window start is out of range. */
13352 if (CHARPOS (start_pos
) < BEGV
)
13353 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13354 else if (CHARPOS (start_pos
) > ZV
)
13355 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13357 /* Find the start of the continued line. This should be fast
13358 because scan_buffer is fast (newline cache). */
13359 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13360 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13361 row
, DEFAULT_FACE_ID
);
13362 reseat_at_previous_visible_line_start (&it
);
13364 /* If the line start is "too far" away from the window start,
13365 say it takes too much time to compute a new window start. */
13366 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13367 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13369 int min_distance
, distance
;
13371 /* Move forward by display lines to find the new window
13372 start. If window width was enlarged, the new start can
13373 be expected to be > the old start. If window width was
13374 decreased, the new window start will be < the old start.
13375 So, we're looking for the display line start with the
13376 minimum distance from the old window start. */
13377 pos
= it
.current
.pos
;
13378 min_distance
= INFINITY
;
13379 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13380 distance
< min_distance
)
13382 min_distance
= distance
;
13383 pos
= it
.current
.pos
;
13384 move_it_by_lines (&it
, 1, 0);
13387 /* Set the window start there. */
13388 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13389 window_start_changed_p
= 1;
13393 return window_start_changed_p
;
13397 /* Try cursor movement in case text has not changed in window WINDOW,
13398 with window start STARTP. Value is
13400 CURSOR_MOVEMENT_SUCCESS if successful
13402 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13404 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13405 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13406 we want to scroll as if scroll-step were set to 1. See the code.
13408 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13409 which case we have to abort this redisplay, and adjust matrices
13414 CURSOR_MOVEMENT_SUCCESS
,
13415 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13416 CURSOR_MOVEMENT_MUST_SCROLL
,
13417 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13421 try_cursor_movement (window
, startp
, scroll_step
)
13422 Lisp_Object window
;
13423 struct text_pos startp
;
13426 struct window
*w
= XWINDOW (window
);
13427 struct frame
*f
= XFRAME (w
->frame
);
13428 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13431 if (inhibit_try_cursor_movement
)
13435 /* Handle case where text has not changed, only point, and it has
13436 not moved off the frame. */
13437 if (/* Point may be in this window. */
13438 PT
>= CHARPOS (startp
)
13439 /* Selective display hasn't changed. */
13440 && !current_buffer
->clip_changed
13441 /* Function force-mode-line-update is used to force a thorough
13442 redisplay. It sets either windows_or_buffers_changed or
13443 update_mode_lines. So don't take a shortcut here for these
13445 && !update_mode_lines
13446 && !windows_or_buffers_changed
13447 && !cursor_type_changed
13448 /* Can't use this case if highlighting a region. When a
13449 region exists, cursor movement has to do more than just
13451 && !(!NILP (Vtransient_mark_mode
)
13452 && !NILP (current_buffer
->mark_active
))
13453 && NILP (w
->region_showing
)
13454 && NILP (Vshow_trailing_whitespace
)
13455 /* Right after splitting windows, last_point may be nil. */
13456 && INTEGERP (w
->last_point
)
13457 /* This code is not used for mini-buffer for the sake of the case
13458 of redisplaying to replace an echo area message; since in
13459 that case the mini-buffer contents per se are usually
13460 unchanged. This code is of no real use in the mini-buffer
13461 since the handling of this_line_start_pos, etc., in redisplay
13462 handles the same cases. */
13463 && !EQ (window
, minibuf_window
)
13464 /* When splitting windows or for new windows, it happens that
13465 redisplay is called with a nil window_end_vpos or one being
13466 larger than the window. This should really be fixed in
13467 window.c. I don't have this on my list, now, so we do
13468 approximately the same as the old redisplay code. --gerd. */
13469 && INTEGERP (w
->window_end_vpos
)
13470 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13471 && (FRAME_WINDOW_P (f
)
13472 || !overlay_arrow_in_current_buffer_p ()))
13474 int this_scroll_margin
, top_scroll_margin
;
13475 struct glyph_row
*row
= NULL
;
13478 debug_method_add (w
, "cursor movement");
13481 /* Scroll if point within this distance from the top or bottom
13482 of the window. This is a pixel value. */
13483 if (scroll_margin
> 0)
13485 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13486 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13489 this_scroll_margin
= 0;
13491 top_scroll_margin
= this_scroll_margin
;
13492 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13493 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13495 /* Start with the row the cursor was displayed during the last
13496 not paused redisplay. Give up if that row is not valid. */
13497 if (w
->last_cursor
.vpos
< 0
13498 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13499 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13502 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13503 if (row
->mode_line_p
)
13505 if (!row
->enabled_p
)
13506 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13507 /* If rows are bidi-reordered, back up until we find a row
13508 that does not belong to a continuation line. This is
13509 because we must consider all rows of a continued line as
13510 candidates for cursor positioning, since row start and
13511 end positions change non-linearly with vertical position
13513 /* FIXME: Revisit this when glyph ``spilling'' in
13514 continuation lines' rows is implemented for
13515 bidi-reordered rows. */
13516 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13518 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13520 xassert (row
->enabled_p
);
13522 /* If we hit the beginning of the displayed portion
13523 without finding the first row of a continued
13525 if (row
<= w
->current_matrix
->rows
)
13527 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13535 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13538 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13540 if (PT
> XFASTINT (w
->last_point
))
13542 /* Point has moved forward. */
13543 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13544 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13546 xassert (row
->enabled_p
);
13550 /* The end position of a row equals the start position
13551 of the next row. If PT is there, we would rather
13552 display it in the next line. */
13553 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13554 && MATRIX_ROW_END_CHARPOS (row
) == PT
13555 && !cursor_row_p (w
, row
))
13558 /* If within the scroll margin, scroll. Note that
13559 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13560 the next line would be drawn, and that
13561 this_scroll_margin can be zero. */
13562 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13563 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13564 /* Line is completely visible last line in window
13565 and PT is to be set in the next line. */
13566 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13567 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13568 && !row
->ends_at_zv_p
13569 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13572 else if (PT
< XFASTINT (w
->last_point
))
13574 /* Cursor has to be moved backward. Note that PT >=
13575 CHARPOS (startp) because of the outer if-statement. */
13576 while (!row
->mode_line_p
13577 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13578 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13579 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13580 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13581 row
> w
->current_matrix
->rows
13582 && (row
-1)->ends_in_newline_from_string_p
))))
13583 && (row
->y
> top_scroll_margin
13584 || CHARPOS (startp
) == BEGV
))
13586 xassert (row
->enabled_p
);
13590 /* Consider the following case: Window starts at BEGV,
13591 there is invisible, intangible text at BEGV, so that
13592 display starts at some point START > BEGV. It can
13593 happen that we are called with PT somewhere between
13594 BEGV and START. Try to handle that case. */
13595 if (row
< w
->current_matrix
->rows
13596 || row
->mode_line_p
)
13598 row
= w
->current_matrix
->rows
;
13599 if (row
->mode_line_p
)
13603 /* Due to newlines in overlay strings, we may have to
13604 skip forward over overlay strings. */
13605 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13606 && MATRIX_ROW_END_CHARPOS (row
) == PT
13607 && !cursor_row_p (w
, row
))
13610 /* If within the scroll margin, scroll. */
13611 if (row
->y
< top_scroll_margin
13612 && CHARPOS (startp
) != BEGV
)
13617 /* Cursor did not move. So don't scroll even if cursor line
13618 is partially visible, as it was so before. */
13619 rc
= CURSOR_MOVEMENT_SUCCESS
;
13622 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13623 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13625 /* if PT is not in the glyph row, give up. */
13626 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13628 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13629 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13630 && make_cursor_line_fully_visible_p
)
13632 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13633 && !row
->ends_at_zv_p
13634 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13635 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13636 else if (row
->height
> window_box_height (w
))
13638 /* If we end up in a partially visible line, let's
13639 make it fully visible, except when it's taller
13640 than the window, in which case we can't do much
13643 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13647 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13648 if (!cursor_row_fully_visible_p (w
, 0, 1))
13649 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13651 rc
= CURSOR_MOVEMENT_SUCCESS
;
13655 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13656 else if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13658 /* With bidi-reordered rows, there could be more than
13659 one candidate row whose start and end positions
13660 occlude point. We need to let set_cursor_from_row
13661 find the best candidate. */
13662 /* FIXME: Revisit this when glyph ``spilling'' in
13663 continuation lines' rows is implemented for
13664 bidi-reordered rows. */
13669 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13671 /* As soon as we've found the first suitable row
13672 whose ends_at_zv_p flag is set, we are done. */
13674 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13676 rc
= CURSOR_MOVEMENT_SUCCESS
;
13681 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13682 && MATRIX_ROW_START_CHARPOS (row
) <= PT
13683 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13684 && cursor_row_p (w
, row
));
13685 /* If we didn't find any candidate rows, or exited the
13686 loop before all the candidates were examined, signal
13687 to the caller that this method failed. */
13688 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13690 || (MATRIX_ROW_START_CHARPOS (row
) <= PT
13691 && PT
<= MATRIX_ROW_END_CHARPOS (row
))))
13692 rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13694 rc
= CURSOR_MOVEMENT_SUCCESS
;
13700 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13702 rc
= CURSOR_MOVEMENT_SUCCESS
;
13707 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13708 && MATRIX_ROW_START_CHARPOS (row
) == PT
13709 && cursor_row_p (w
, row
));
13718 set_vertical_scroll_bar (w
)
13721 int start
, end
, whole
;
13723 /* Calculate the start and end positions for the current window.
13724 At some point, it would be nice to choose between scrollbars
13725 which reflect the whole buffer size, with special markers
13726 indicating narrowing, and scrollbars which reflect only the
13729 Note that mini-buffers sometimes aren't displaying any text. */
13730 if (!MINI_WINDOW_P (w
)
13731 || (w
== XWINDOW (minibuf_window
)
13732 && NILP (echo_area_buffer
[0])))
13734 struct buffer
*buf
= XBUFFER (w
->buffer
);
13735 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13736 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13737 /* I don't think this is guaranteed to be right. For the
13738 moment, we'll pretend it is. */
13739 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13743 if (whole
< (end
- start
))
13744 whole
= end
- start
;
13747 start
= end
= whole
= 0;
13749 /* Indicate what this scroll bar ought to be displaying now. */
13750 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13751 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13752 (w
, end
- start
, whole
, start
);
13756 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13757 selected_window is redisplayed.
13759 We can return without actually redisplaying the window if
13760 fonts_changed_p is nonzero. In that case, redisplay_internal will
13764 redisplay_window (window
, just_this_one_p
)
13765 Lisp_Object window
;
13766 int just_this_one_p
;
13768 struct window
*w
= XWINDOW (window
);
13769 struct frame
*f
= XFRAME (w
->frame
);
13770 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13771 struct buffer
*old
= current_buffer
;
13772 struct text_pos lpoint
, opoint
, startp
;
13773 int update_mode_line
;
13776 /* Record it now because it's overwritten. */
13777 int current_matrix_up_to_date_p
= 0;
13778 int used_current_matrix_p
= 0;
13779 /* This is less strict than current_matrix_up_to_date_p.
13780 It indictes that the buffer contents and narrowing are unchanged. */
13781 int buffer_unchanged_p
= 0;
13782 int temp_scroll_step
= 0;
13783 int count
= SPECPDL_INDEX ();
13785 int centering_position
= -1;
13786 int last_line_misfit
= 0;
13787 int beg_unchanged
, end_unchanged
;
13789 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13792 /* W must be a leaf window here. */
13793 xassert (!NILP (w
->buffer
));
13795 *w
->desired_matrix
->method
= 0;
13799 reconsider_clip_changes (w
, buffer
);
13801 /* Has the mode line to be updated? */
13802 update_mode_line
= (!NILP (w
->update_mode_line
)
13803 || update_mode_lines
13804 || buffer
->clip_changed
13805 || buffer
->prevent_redisplay_optimizations_p
);
13807 if (MINI_WINDOW_P (w
))
13809 if (w
== XWINDOW (echo_area_window
)
13810 && !NILP (echo_area_buffer
[0]))
13812 if (update_mode_line
)
13813 /* We may have to update a tty frame's menu bar or a
13814 tool-bar. Example `M-x C-h C-h C-g'. */
13815 goto finish_menu_bars
;
13817 /* We've already displayed the echo area glyphs in this window. */
13818 goto finish_scroll_bars
;
13820 else if ((w
!= XWINDOW (minibuf_window
)
13821 || minibuf_level
== 0)
13822 /* When buffer is nonempty, redisplay window normally. */
13823 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13824 /* Quail displays non-mini buffers in minibuffer window.
13825 In that case, redisplay the window normally. */
13826 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13828 /* W is a mini-buffer window, but it's not active, so clear
13830 int yb
= window_text_bottom_y (w
);
13831 struct glyph_row
*row
;
13834 for (y
= 0, row
= w
->desired_matrix
->rows
;
13836 y
+= row
->height
, ++row
)
13837 blank_row (w
, row
, y
);
13838 goto finish_scroll_bars
;
13841 clear_glyph_matrix (w
->desired_matrix
);
13844 /* Otherwise set up data on this window; select its buffer and point
13846 /* Really select the buffer, for the sake of buffer-local
13848 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13850 current_matrix_up_to_date_p
13851 = (!NILP (w
->window_end_valid
)
13852 && !current_buffer
->clip_changed
13853 && !current_buffer
->prevent_redisplay_optimizations_p
13854 && XFASTINT (w
->last_modified
) >= MODIFF
13855 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13857 /* Run the window-bottom-change-functions
13858 if it is possible that the text on the screen has changed
13859 (either due to modification of the text, or any other reason). */
13860 if (!current_matrix_up_to_date_p
13861 && !NILP (Vwindow_text_change_functions
))
13863 safe_run_hooks (Qwindow_text_change_functions
);
13867 beg_unchanged
= BEG_UNCHANGED
;
13868 end_unchanged
= END_UNCHANGED
;
13870 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13872 specbind (Qinhibit_point_motion_hooks
, Qt
);
13875 = (!NILP (w
->window_end_valid
)
13876 && !current_buffer
->clip_changed
13877 && XFASTINT (w
->last_modified
) >= MODIFF
13878 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13880 /* When windows_or_buffers_changed is non-zero, we can't rely on
13881 the window end being valid, so set it to nil there. */
13882 if (windows_or_buffers_changed
)
13884 /* If window starts on a continuation line, maybe adjust the
13885 window start in case the window's width changed. */
13886 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13887 compute_window_start_on_continuation_line (w
);
13889 w
->window_end_valid
= Qnil
;
13892 /* Some sanity checks. */
13893 CHECK_WINDOW_END (w
);
13894 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13896 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13899 /* If %c is in mode line, update it if needed. */
13900 if (!NILP (w
->column_number_displayed
)
13901 /* This alternative quickly identifies a common case
13902 where no change is needed. */
13903 && !(PT
== XFASTINT (w
->last_point
)
13904 && XFASTINT (w
->last_modified
) >= MODIFF
13905 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13906 && (XFASTINT (w
->column_number_displayed
)
13907 != (int) current_column ())) /* iftc */
13908 update_mode_line
= 1;
13910 /* Count number of windows showing the selected buffer. An indirect
13911 buffer counts as its base buffer. */
13912 if (!just_this_one_p
)
13914 struct buffer
*current_base
, *window_base
;
13915 current_base
= current_buffer
;
13916 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13917 if (current_base
->base_buffer
)
13918 current_base
= current_base
->base_buffer
;
13919 if (window_base
->base_buffer
)
13920 window_base
= window_base
->base_buffer
;
13921 if (current_base
== window_base
)
13925 /* Point refers normally to the selected window. For any other
13926 window, set up appropriate value. */
13927 if (!EQ (window
, selected_window
))
13929 int new_pt
= XMARKER (w
->pointm
)->charpos
;
13930 int new_pt_byte
= marker_byte_position (w
->pointm
);
13934 new_pt_byte
= BEGV_BYTE
;
13935 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13937 else if (new_pt
> (ZV
- 1))
13940 new_pt_byte
= ZV_BYTE
;
13941 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13944 /* We don't use SET_PT so that the point-motion hooks don't run. */
13945 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13948 /* If any of the character widths specified in the display table
13949 have changed, invalidate the width run cache. It's true that
13950 this may be a bit late to catch such changes, but the rest of
13951 redisplay goes (non-fatally) haywire when the display table is
13952 changed, so why should we worry about doing any better? */
13953 if (current_buffer
->width_run_cache
)
13955 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13957 if (! disptab_matches_widthtab (disptab
,
13958 XVECTOR (current_buffer
->width_table
)))
13960 invalidate_region_cache (current_buffer
,
13961 current_buffer
->width_run_cache
,
13963 recompute_width_table (current_buffer
, disptab
);
13967 /* If window-start is screwed up, choose a new one. */
13968 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13971 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13973 /* If someone specified a new starting point but did not insist,
13974 check whether it can be used. */
13975 if (!NILP (w
->optional_new_start
)
13976 && CHARPOS (startp
) >= BEGV
13977 && CHARPOS (startp
) <= ZV
)
13979 w
->optional_new_start
= Qnil
;
13980 start_display (&it
, w
, startp
);
13981 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13982 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13983 if (IT_CHARPOS (it
) == PT
)
13984 w
->force_start
= Qt
;
13985 /* IT may overshoot PT if text at PT is invisible. */
13986 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13987 w
->force_start
= Qt
;
13992 /* Handle case where place to start displaying has been specified,
13993 unless the specified location is outside the accessible range. */
13994 if (!NILP (w
->force_start
)
13995 || w
->frozen_window_start_p
)
13997 /* We set this later on if we have to adjust point. */
14000 w
->force_start
= Qnil
;
14002 w
->window_end_valid
= Qnil
;
14004 /* Forget any recorded base line for line number display. */
14005 if (!buffer_unchanged_p
)
14006 w
->base_line_number
= Qnil
;
14008 /* Redisplay the mode line. Select the buffer properly for that.
14009 Also, run the hook window-scroll-functions
14010 because we have scrolled. */
14011 /* Note, we do this after clearing force_start because
14012 if there's an error, it is better to forget about force_start
14013 than to get into an infinite loop calling the hook functions
14014 and having them get more errors. */
14015 if (!update_mode_line
14016 || ! NILP (Vwindow_scroll_functions
))
14018 update_mode_line
= 1;
14019 w
->update_mode_line
= Qt
;
14020 startp
= run_window_scroll_functions (window
, startp
);
14023 w
->last_modified
= make_number (0);
14024 w
->last_overlay_modified
= make_number (0);
14025 if (CHARPOS (startp
) < BEGV
)
14026 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
14027 else if (CHARPOS (startp
) > ZV
)
14028 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
14030 /* Redisplay, then check if cursor has been set during the
14031 redisplay. Give up if new fonts were loaded. */
14032 /* We used to issue a CHECK_MARGINS argument to try_window here,
14033 but this causes scrolling to fail when point begins inside
14034 the scroll margin (bug#148) -- cyd */
14035 if (!try_window (window
, startp
, 0))
14037 w
->force_start
= Qt
;
14038 clear_glyph_matrix (w
->desired_matrix
);
14039 goto need_larger_matrices
;
14042 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
14044 /* If point does not appear, try to move point so it does
14045 appear. The desired matrix has been built above, so we
14046 can use it here. */
14047 new_vpos
= window_box_height (w
) / 2;
14050 if (!cursor_row_fully_visible_p (w
, 0, 0))
14052 /* Point does appear, but on a line partly visible at end of window.
14053 Move it back to a fully-visible line. */
14054 new_vpos
= window_box_height (w
);
14057 /* If we need to move point for either of the above reasons,
14058 now actually do it. */
14061 struct glyph_row
*row
;
14063 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14064 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14067 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14068 MATRIX_ROW_START_BYTEPOS (row
));
14070 if (w
!= XWINDOW (selected_window
))
14071 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14072 else if (current_buffer
== old
)
14073 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14075 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14077 /* If we are highlighting the region, then we just changed
14078 the region, so redisplay to show it. */
14079 if (!NILP (Vtransient_mark_mode
)
14080 && !NILP (current_buffer
->mark_active
))
14082 clear_glyph_matrix (w
->desired_matrix
);
14083 if (!try_window (window
, startp
, 0))
14084 goto need_larger_matrices
;
14089 debug_method_add (w
, "forced window start");
14094 /* Handle case where text has not changed, only point, and it has
14095 not moved off the frame, and we are not retrying after hscroll.
14096 (current_matrix_up_to_date_p is nonzero when retrying.) */
14097 if (current_matrix_up_to_date_p
14098 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14099 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14103 case CURSOR_MOVEMENT_SUCCESS
:
14104 used_current_matrix_p
= 1;
14107 case CURSOR_MOVEMENT_MUST_SCROLL
:
14108 goto try_to_scroll
;
14114 /* If current starting point was originally the beginning of a line
14115 but no longer is, find a new starting point. */
14116 else if (!NILP (w
->start_at_line_beg
)
14117 && !(CHARPOS (startp
) <= BEGV
14118 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14121 debug_method_add (w
, "recenter 1");
14126 /* Try scrolling with try_window_id. Value is > 0 if update has
14127 been done, it is -1 if we know that the same window start will
14128 not work. It is 0 if unsuccessful for some other reason. */
14129 else if ((tem
= try_window_id (w
)) != 0)
14132 debug_method_add (w
, "try_window_id %d", tem
);
14135 if (fonts_changed_p
)
14136 goto need_larger_matrices
;
14140 /* Otherwise try_window_id has returned -1 which means that we
14141 don't want the alternative below this comment to execute. */
14143 else if (CHARPOS (startp
) >= BEGV
14144 && CHARPOS (startp
) <= ZV
14145 && PT
>= CHARPOS (startp
)
14146 && (CHARPOS (startp
) < ZV
14147 /* Avoid starting at end of buffer. */
14148 || CHARPOS (startp
) == BEGV
14149 || (XFASTINT (w
->last_modified
) >= MODIFF
14150 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14153 /* If first window line is a continuation line, and window start
14154 is inside the modified region, but the first change is before
14155 current window start, we must select a new window start.
14157 However, if this is the result of a down-mouse event (e.g. by
14158 extending the mouse-drag-overlay), we don't want to select a
14159 new window start, since that would change the position under
14160 the mouse, resulting in an unwanted mouse-movement rather
14161 than a simple mouse-click. */
14162 if (NILP (w
->start_at_line_beg
)
14163 && NILP (do_mouse_tracking
)
14164 && CHARPOS (startp
) > BEGV
14165 && CHARPOS (startp
) > BEG
+ beg_unchanged
14166 && CHARPOS (startp
) <= Z
- end_unchanged
14167 /* Even if w->start_at_line_beg is nil, a new window may
14168 start at a line_beg, since that's how set_buffer_window
14169 sets it. So, we need to check the return value of
14170 compute_window_start_on_continuation_line. (See also
14172 && XMARKER (w
->start
)->buffer
== current_buffer
14173 && compute_window_start_on_continuation_line (w
))
14175 w
->force_start
= Qt
;
14176 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14181 debug_method_add (w
, "same window start");
14184 /* Try to redisplay starting at same place as before.
14185 If point has not moved off frame, accept the results. */
14186 if (!current_matrix_up_to_date_p
14187 /* Don't use try_window_reusing_current_matrix in this case
14188 because a window scroll function can have changed the
14190 || !NILP (Vwindow_scroll_functions
)
14191 || MINI_WINDOW_P (w
)
14192 || !(used_current_matrix_p
14193 = try_window_reusing_current_matrix (w
)))
14195 IF_DEBUG (debug_method_add (w
, "1"));
14196 if (try_window (window
, startp
, 1) < 0)
14197 /* -1 means we need to scroll.
14198 0 means we need new matrices, but fonts_changed_p
14199 is set in that case, so we will detect it below. */
14200 goto try_to_scroll
;
14203 if (fonts_changed_p
)
14204 goto need_larger_matrices
;
14206 if (w
->cursor
.vpos
>= 0)
14208 if (!just_this_one_p
14209 || current_buffer
->clip_changed
14210 || BEG_UNCHANGED
< CHARPOS (startp
))
14211 /* Forget any recorded base line for line number display. */
14212 w
->base_line_number
= Qnil
;
14214 if (!cursor_row_fully_visible_p (w
, 1, 0))
14216 clear_glyph_matrix (w
->desired_matrix
);
14217 last_line_misfit
= 1;
14219 /* Drop through and scroll. */
14224 clear_glyph_matrix (w
->desired_matrix
);
14229 w
->last_modified
= make_number (0);
14230 w
->last_overlay_modified
= make_number (0);
14232 /* Redisplay the mode line. Select the buffer properly for that. */
14233 if (!update_mode_line
)
14235 update_mode_line
= 1;
14236 w
->update_mode_line
= Qt
;
14239 /* Try to scroll by specified few lines. */
14240 if ((scroll_conservatively
14242 || temp_scroll_step
14243 || NUMBERP (current_buffer
->scroll_up_aggressively
)
14244 || NUMBERP (current_buffer
->scroll_down_aggressively
))
14245 && !current_buffer
->clip_changed
14246 && CHARPOS (startp
) >= BEGV
14247 && CHARPOS (startp
) <= ZV
)
14249 /* The function returns -1 if new fonts were loaded, 1 if
14250 successful, 0 if not successful. */
14251 int rc
= try_scrolling (window
, just_this_one_p
,
14252 scroll_conservatively
,
14254 temp_scroll_step
, last_line_misfit
);
14257 case SCROLLING_SUCCESS
:
14260 case SCROLLING_NEED_LARGER_MATRICES
:
14261 goto need_larger_matrices
;
14263 case SCROLLING_FAILED
:
14271 /* Finally, just choose place to start which centers point */
14274 if (centering_position
< 0)
14275 centering_position
= window_box_height (w
) / 2;
14278 debug_method_add (w
, "recenter");
14281 /* w->vscroll = 0; */
14283 /* Forget any previously recorded base line for line number display. */
14284 if (!buffer_unchanged_p
)
14285 w
->base_line_number
= Qnil
;
14287 /* Move backward half the height of the window. */
14288 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14289 it
.current_y
= it
.last_visible_y
;
14290 move_it_vertically_backward (&it
, centering_position
);
14291 xassert (IT_CHARPOS (it
) >= BEGV
);
14293 /* The function move_it_vertically_backward may move over more
14294 than the specified y-distance. If it->w is small, e.g. a
14295 mini-buffer window, we may end up in front of the window's
14296 display area. Start displaying at the start of the line
14297 containing PT in this case. */
14298 if (it
.current_y
<= 0)
14300 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14301 move_it_vertically_backward (&it
, 0);
14305 it
.current_x
= it
.hpos
= 0;
14307 /* Set startp here explicitly in case that helps avoid an infinite loop
14308 in case the window-scroll-functions functions get errors. */
14309 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14311 /* Run scroll hooks. */
14312 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14314 /* Redisplay the window. */
14315 if (!current_matrix_up_to_date_p
14316 || windows_or_buffers_changed
14317 || cursor_type_changed
14318 /* Don't use try_window_reusing_current_matrix in this case
14319 because it can have changed the buffer. */
14320 || !NILP (Vwindow_scroll_functions
)
14321 || !just_this_one_p
14322 || MINI_WINDOW_P (w
)
14323 || !(used_current_matrix_p
14324 = try_window_reusing_current_matrix (w
)))
14325 try_window (window
, startp
, 0);
14327 /* If new fonts have been loaded (due to fontsets), give up. We
14328 have to start a new redisplay since we need to re-adjust glyph
14330 if (fonts_changed_p
)
14331 goto need_larger_matrices
;
14333 /* If cursor did not appear assume that the middle of the window is
14334 in the first line of the window. Do it again with the next line.
14335 (Imagine a window of height 100, displaying two lines of height
14336 60. Moving back 50 from it->last_visible_y will end in the first
14338 if (w
->cursor
.vpos
< 0)
14340 if (!NILP (w
->window_end_valid
)
14341 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14343 clear_glyph_matrix (w
->desired_matrix
);
14344 move_it_by_lines (&it
, 1, 0);
14345 try_window (window
, it
.current
.pos
, 0);
14347 else if (PT
< IT_CHARPOS (it
))
14349 clear_glyph_matrix (w
->desired_matrix
);
14350 move_it_by_lines (&it
, -1, 0);
14351 try_window (window
, it
.current
.pos
, 0);
14355 /* Not much we can do about it. */
14359 /* Consider the following case: Window starts at BEGV, there is
14360 invisible, intangible text at BEGV, so that display starts at
14361 some point START > BEGV. It can happen that we are called with
14362 PT somewhere between BEGV and START. Try to handle that case. */
14363 if (w
->cursor
.vpos
< 0)
14365 struct glyph_row
*row
= w
->current_matrix
->rows
;
14366 if (row
->mode_line_p
)
14368 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14371 if (!cursor_row_fully_visible_p (w
, 0, 0))
14373 /* If vscroll is enabled, disable it and try again. */
14377 clear_glyph_matrix (w
->desired_matrix
);
14381 /* If centering point failed to make the whole line visible,
14382 put point at the top instead. That has to make the whole line
14383 visible, if it can be done. */
14384 if (centering_position
== 0)
14387 clear_glyph_matrix (w
->desired_matrix
);
14388 centering_position
= 0;
14394 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14395 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14396 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14399 /* Display the mode line, if we must. */
14400 if ((update_mode_line
14401 /* If window not full width, must redo its mode line
14402 if (a) the window to its side is being redone and
14403 (b) we do a frame-based redisplay. This is a consequence
14404 of how inverted lines are drawn in frame-based redisplay. */
14405 || (!just_this_one_p
14406 && !FRAME_WINDOW_P (f
)
14407 && !WINDOW_FULL_WIDTH_P (w
))
14408 /* Line number to display. */
14409 || INTEGERP (w
->base_line_pos
)
14410 /* Column number is displayed and different from the one displayed. */
14411 || (!NILP (w
->column_number_displayed
)
14412 && (XFASTINT (w
->column_number_displayed
)
14413 != (int) current_column ()))) /* iftc */
14414 /* This means that the window has a mode line. */
14415 && (WINDOW_WANTS_MODELINE_P (w
)
14416 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14418 display_mode_lines (w
);
14420 /* If mode line height has changed, arrange for a thorough
14421 immediate redisplay using the correct mode line height. */
14422 if (WINDOW_WANTS_MODELINE_P (w
)
14423 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14425 fonts_changed_p
= 1;
14426 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14427 = DESIRED_MODE_LINE_HEIGHT (w
);
14430 /* If header line height has changed, arrange for a thorough
14431 immediate redisplay using the correct header line height. */
14432 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14433 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14435 fonts_changed_p
= 1;
14436 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14437 = DESIRED_HEADER_LINE_HEIGHT (w
);
14440 if (fonts_changed_p
)
14441 goto need_larger_matrices
;
14444 if (!line_number_displayed
14445 && !BUFFERP (w
->base_line_pos
))
14447 w
->base_line_pos
= Qnil
;
14448 w
->base_line_number
= Qnil
;
14453 /* When we reach a frame's selected window, redo the frame's menu bar. */
14454 if (update_mode_line
14455 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14457 int redisplay_menu_p
= 0;
14458 int redisplay_tool_bar_p
= 0;
14460 if (FRAME_WINDOW_P (f
))
14462 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14463 || defined (HAVE_NS) || defined (USE_GTK)
14464 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14466 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14470 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14472 if (redisplay_menu_p
)
14473 display_menu_bar (w
);
14475 #ifdef HAVE_WINDOW_SYSTEM
14476 if (FRAME_WINDOW_P (f
))
14478 #if defined (USE_GTK) || defined (HAVE_NS)
14479 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
14481 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
14482 && (FRAME_TOOL_BAR_LINES (f
) > 0
14483 || !NILP (Vauto_resize_tool_bars
));
14486 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
14488 extern int ignore_mouse_drag_p
;
14489 ignore_mouse_drag_p
= 1;
14495 #ifdef HAVE_WINDOW_SYSTEM
14496 if (FRAME_WINDOW_P (f
)
14497 && update_window_fringes (w
, (just_this_one_p
14498 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14499 || w
->pseudo_window_p
)))
14503 if (draw_window_fringes (w
, 1))
14504 x_draw_vertical_border (w
);
14508 #endif /* HAVE_WINDOW_SYSTEM */
14510 /* We go to this label, with fonts_changed_p nonzero,
14511 if it is necessary to try again using larger glyph matrices.
14512 We have to redeem the scroll bar even in this case,
14513 because the loop in redisplay_internal expects that. */
14514 need_larger_matrices
:
14516 finish_scroll_bars
:
14518 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14520 /* Set the thumb's position and size. */
14521 set_vertical_scroll_bar (w
);
14523 /* Note that we actually used the scroll bar attached to this
14524 window, so it shouldn't be deleted at the end of redisplay. */
14525 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14526 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14529 /* Restore current_buffer and value of point in it. */
14530 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14531 set_buffer_internal_1 (old
);
14532 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14533 shorter. This can be caused by log truncation in *Messages*. */
14534 if (CHARPOS (lpoint
) <= ZV
)
14535 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14537 unbind_to (count
, Qnil
);
14541 /* Build the complete desired matrix of WINDOW with a window start
14542 buffer position POS.
14544 Value is 1 if successful. It is zero if fonts were loaded during
14545 redisplay which makes re-adjusting glyph matrices necessary, and -1
14546 if point would appear in the scroll margins.
14547 (We check that only if CHECK_MARGINS is nonzero. */
14550 try_window (window
, pos
, check_margins
)
14551 Lisp_Object window
;
14552 struct text_pos pos
;
14555 struct window
*w
= XWINDOW (window
);
14557 struct glyph_row
*last_text_row
= NULL
;
14558 struct frame
*f
= XFRAME (w
->frame
);
14560 /* Make POS the new window start. */
14561 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14563 /* Mark cursor position as unknown. No overlay arrow seen. */
14564 w
->cursor
.vpos
= -1;
14565 overlay_arrow_seen
= 0;
14567 /* Initialize iterator and info to start at POS. */
14568 start_display (&it
, w
, pos
);
14570 /* Display all lines of W. */
14571 while (it
.current_y
< it
.last_visible_y
)
14573 if (display_line (&it
))
14574 last_text_row
= it
.glyph_row
- 1;
14575 if (fonts_changed_p
)
14579 /* Don't let the cursor end in the scroll margins. */
14581 && !MINI_WINDOW_P (w
))
14583 int this_scroll_margin
;
14585 if (scroll_margin
> 0)
14587 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14588 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14591 this_scroll_margin
= 0;
14593 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14594 && w
->cursor
.y
< this_scroll_margin
14595 && CHARPOS (pos
) > BEGV
14596 && IT_CHARPOS (it
) < ZV
)
14597 /* rms: considering make_cursor_line_fully_visible_p here
14598 seems to give wrong results. We don't want to recenter
14599 when the last line is partly visible, we want to allow
14600 that case to be handled in the usual way. */
14601 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14603 w
->cursor
.vpos
= -1;
14604 clear_glyph_matrix (w
->desired_matrix
);
14609 /* If bottom moved off end of frame, change mode line percentage. */
14610 if (XFASTINT (w
->window_end_pos
) <= 0
14611 && Z
!= IT_CHARPOS (it
))
14612 w
->update_mode_line
= Qt
;
14614 /* Set window_end_pos to the offset of the last character displayed
14615 on the window from the end of current_buffer. Set
14616 window_end_vpos to its row number. */
14619 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14620 w
->window_end_bytepos
14621 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14623 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14625 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14626 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14627 ->displays_text_p
);
14631 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14632 w
->window_end_pos
= make_number (Z
- ZV
);
14633 w
->window_end_vpos
= make_number (0);
14636 /* But that is not valid info until redisplay finishes. */
14637 w
->window_end_valid
= Qnil
;
14643 /************************************************************************
14644 Window redisplay reusing current matrix when buffer has not changed
14645 ************************************************************************/
14647 /* Try redisplay of window W showing an unchanged buffer with a
14648 different window start than the last time it was displayed by
14649 reusing its current matrix. Value is non-zero if successful.
14650 W->start is the new window start. */
14653 try_window_reusing_current_matrix (w
)
14656 struct frame
*f
= XFRAME (w
->frame
);
14657 struct glyph_row
*row
, *bottom_row
;
14660 struct text_pos start
, new_start
;
14661 int nrows_scrolled
, i
;
14662 struct glyph_row
*last_text_row
;
14663 struct glyph_row
*last_reused_text_row
;
14664 struct glyph_row
*start_row
;
14665 int start_vpos
, min_y
, max_y
;
14668 if (inhibit_try_window_reusing
)
14672 if (/* This function doesn't handle terminal frames. */
14673 !FRAME_WINDOW_P (f
)
14674 /* Don't try to reuse the display if windows have been split
14676 || windows_or_buffers_changed
14677 || cursor_type_changed
)
14680 /* Can't do this if region may have changed. */
14681 if ((!NILP (Vtransient_mark_mode
)
14682 && !NILP (current_buffer
->mark_active
))
14683 || !NILP (w
->region_showing
)
14684 || !NILP (Vshow_trailing_whitespace
))
14687 /* If top-line visibility has changed, give up. */
14688 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14689 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14692 /* Give up if old or new display is scrolled vertically. We could
14693 make this function handle this, but right now it doesn't. */
14694 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14695 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14698 /* The variable new_start now holds the new window start. The old
14699 start `start' can be determined from the current matrix. */
14700 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14701 start
= start_row
->start
.pos
;
14702 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14704 /* Clear the desired matrix for the display below. */
14705 clear_glyph_matrix (w
->desired_matrix
);
14707 if (CHARPOS (new_start
) <= CHARPOS (start
))
14711 /* Don't use this method if the display starts with an ellipsis
14712 displayed for invisible text. It's not easy to handle that case
14713 below, and it's certainly not worth the effort since this is
14714 not a frequent case. */
14715 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14718 IF_DEBUG (debug_method_add (w
, "twu1"));
14720 /* Display up to a row that can be reused. The variable
14721 last_text_row is set to the last row displayed that displays
14722 text. Note that it.vpos == 0 if or if not there is a
14723 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14724 start_display (&it
, w
, new_start
);
14725 first_row_y
= it
.current_y
;
14726 w
->cursor
.vpos
= -1;
14727 last_text_row
= last_reused_text_row
= NULL
;
14729 while (it
.current_y
< it
.last_visible_y
14730 && !fonts_changed_p
)
14732 /* If we have reached into the characters in the START row,
14733 that means the line boundaries have changed. So we
14734 can't start copying with the row START. Maybe it will
14735 work to start copying with the following row. */
14736 while (IT_CHARPOS (it
) > CHARPOS (start
))
14738 /* Advance to the next row as the "start". */
14740 start
= start_row
->start
.pos
;
14741 /* If there are no more rows to try, or just one, give up. */
14742 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14743 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14744 || CHARPOS (start
) == ZV
)
14746 clear_glyph_matrix (w
->desired_matrix
);
14750 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14752 /* If we have reached alignment,
14753 we can copy the rest of the rows. */
14754 if (IT_CHARPOS (it
) == CHARPOS (start
))
14757 if (display_line (&it
))
14758 last_text_row
= it
.glyph_row
- 1;
14761 /* A value of current_y < last_visible_y means that we stopped
14762 at the previous window start, which in turn means that we
14763 have at least one reusable row. */
14764 if (it
.current_y
< it
.last_visible_y
)
14766 /* IT.vpos always starts from 0; it counts text lines. */
14767 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14769 /* Find PT if not already found in the lines displayed. */
14770 if (w
->cursor
.vpos
< 0)
14772 int dy
= it
.current_y
- start_row
->y
;
14774 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14775 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14777 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14778 dy
, nrows_scrolled
);
14781 clear_glyph_matrix (w
->desired_matrix
);
14786 /* Scroll the display. Do it before the current matrix is
14787 changed. The problem here is that update has not yet
14788 run, i.e. part of the current matrix is not up to date.
14789 scroll_run_hook will clear the cursor, and use the
14790 current matrix to get the height of the row the cursor is
14792 run
.current_y
= start_row
->y
;
14793 run
.desired_y
= it
.current_y
;
14794 run
.height
= it
.last_visible_y
- it
.current_y
;
14796 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14799 FRAME_RIF (f
)->update_window_begin_hook (w
);
14800 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14801 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14802 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14806 /* Shift current matrix down by nrows_scrolled lines. */
14807 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14808 rotate_matrix (w
->current_matrix
,
14810 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14813 /* Disable lines that must be updated. */
14814 for (i
= 0; i
< nrows_scrolled
; ++i
)
14815 (start_row
+ i
)->enabled_p
= 0;
14817 /* Re-compute Y positions. */
14818 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14819 max_y
= it
.last_visible_y
;
14820 for (row
= start_row
+ nrows_scrolled
;
14824 row
->y
= it
.current_y
;
14825 row
->visible_height
= row
->height
;
14827 if (row
->y
< min_y
)
14828 row
->visible_height
-= min_y
- row
->y
;
14829 if (row
->y
+ row
->height
> max_y
)
14830 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14831 row
->redraw_fringe_bitmaps_p
= 1;
14833 it
.current_y
+= row
->height
;
14835 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14836 last_reused_text_row
= row
;
14837 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14841 /* Disable lines in the current matrix which are now
14842 below the window. */
14843 for (++row
; row
< bottom_row
; ++row
)
14844 row
->enabled_p
= row
->mode_line_p
= 0;
14847 /* Update window_end_pos etc.; last_reused_text_row is the last
14848 reused row from the current matrix containing text, if any.
14849 The value of last_text_row is the last displayed line
14850 containing text. */
14851 if (last_reused_text_row
)
14853 w
->window_end_bytepos
14854 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14856 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14858 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14859 w
->current_matrix
));
14861 else if (last_text_row
)
14863 w
->window_end_bytepos
14864 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14866 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14868 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14872 /* This window must be completely empty. */
14873 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14874 w
->window_end_pos
= make_number (Z
- ZV
);
14875 w
->window_end_vpos
= make_number (0);
14877 w
->window_end_valid
= Qnil
;
14879 /* Update hint: don't try scrolling again in update_window. */
14880 w
->desired_matrix
->no_scrolling_p
= 1;
14883 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14887 else if (CHARPOS (new_start
) > CHARPOS (start
))
14889 struct glyph_row
*pt_row
, *row
;
14890 struct glyph_row
*first_reusable_row
;
14891 struct glyph_row
*first_row_to_display
;
14893 int yb
= window_text_bottom_y (w
);
14895 /* Find the row starting at new_start, if there is one. Don't
14896 reuse a partially visible line at the end. */
14897 first_reusable_row
= start_row
;
14898 while (first_reusable_row
->enabled_p
14899 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14900 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14901 < CHARPOS (new_start
)))
14902 ++first_reusable_row
;
14904 /* Give up if there is no row to reuse. */
14905 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14906 || !first_reusable_row
->enabled_p
14907 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14908 != CHARPOS (new_start
)))
14911 /* We can reuse fully visible rows beginning with
14912 first_reusable_row to the end of the window. Set
14913 first_row_to_display to the first row that cannot be reused.
14914 Set pt_row to the row containing point, if there is any. */
14916 for (first_row_to_display
= first_reusable_row
;
14917 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14918 ++first_row_to_display
)
14920 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14921 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14922 pt_row
= first_row_to_display
;
14925 /* Start displaying at the start of first_row_to_display. */
14926 xassert (first_row_to_display
->y
< yb
);
14927 init_to_row_start (&it
, w
, first_row_to_display
);
14929 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14931 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14933 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14934 + WINDOW_HEADER_LINE_HEIGHT (w
));
14936 /* Display lines beginning with first_row_to_display in the
14937 desired matrix. Set last_text_row to the last row displayed
14938 that displays text. */
14939 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14940 if (pt_row
== NULL
)
14941 w
->cursor
.vpos
= -1;
14942 last_text_row
= NULL
;
14943 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14944 if (display_line (&it
))
14945 last_text_row
= it
.glyph_row
- 1;
14947 /* If point is in a reused row, adjust y and vpos of the cursor
14951 w
->cursor
.vpos
-= nrows_scrolled
;
14952 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14955 /* Give up if point isn't in a row displayed or reused. (This
14956 also handles the case where w->cursor.vpos < nrows_scrolled
14957 after the calls to display_line, which can happen with scroll
14958 margins. See bug#1295.) */
14959 if (w
->cursor
.vpos
< 0)
14961 clear_glyph_matrix (w
->desired_matrix
);
14965 /* Scroll the display. */
14966 run
.current_y
= first_reusable_row
->y
;
14967 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14968 run
.height
= it
.last_visible_y
- run
.current_y
;
14969 dy
= run
.current_y
- run
.desired_y
;
14974 FRAME_RIF (f
)->update_window_begin_hook (w
);
14975 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14976 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14977 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14981 /* Adjust Y positions of reused rows. */
14982 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14983 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14984 max_y
= it
.last_visible_y
;
14985 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14988 row
->visible_height
= row
->height
;
14989 if (row
->y
< min_y
)
14990 row
->visible_height
-= min_y
- row
->y
;
14991 if (row
->y
+ row
->height
> max_y
)
14992 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14993 row
->redraw_fringe_bitmaps_p
= 1;
14996 /* Scroll the current matrix. */
14997 xassert (nrows_scrolled
> 0);
14998 rotate_matrix (w
->current_matrix
,
15000 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15003 /* Disable rows not reused. */
15004 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
15005 row
->enabled_p
= 0;
15007 /* Point may have moved to a different line, so we cannot assume that
15008 the previous cursor position is valid; locate the correct row. */
15011 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15012 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15016 w
->cursor
.y
= row
->y
;
15018 if (row
< bottom_row
)
15020 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15021 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15022 struct glyph
*orig_glyph
= glyph
;
15023 struct cursor_pos orig_cursor
= w
->cursor
;
15026 && (!BUFFERP (glyph
->object
)
15027 || glyph
->charpos
!= PT
);
15031 w
->cursor
.x
+= glyph
->pixel_width
;
15033 /* With bidi reordering, charpos changes non-linearly
15034 with hpos, so the right glyph could be to the
15036 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
15037 && (!BUFFERP (glyph
->object
) || glyph
->charpos
!= PT
))
15039 struct glyph
*start_glyph
= row
->glyphs
[TEXT_AREA
];
15041 glyph
= orig_glyph
- 1;
15042 orig_cursor
.hpos
--;
15043 orig_cursor
.x
-= glyph
->pixel_width
;
15044 for (; glyph
>= start_glyph
15045 && (!BUFFERP (glyph
->object
)
15046 || glyph
->charpos
!= PT
);
15050 w
->cursor
.x
-= glyph
->pixel_width
;
15052 if (BUFFERP (glyph
->object
) && glyph
->charpos
== PT
)
15053 w
->cursor
= orig_cursor
;
15058 /* Adjust window end. A null value of last_text_row means that
15059 the window end is in reused rows which in turn means that
15060 only its vpos can have changed. */
15063 w
->window_end_bytepos
15064 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15066 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15068 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15073 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15076 w
->window_end_valid
= Qnil
;
15077 w
->desired_matrix
->no_scrolling_p
= 1;
15080 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15090 /************************************************************************
15091 Window redisplay reusing current matrix when buffer has changed
15092 ************************************************************************/
15094 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
15095 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
15097 static struct glyph_row
*
15098 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
15099 struct glyph_row
*));
15102 /* Return the last row in MATRIX displaying text. If row START is
15103 non-null, start searching with that row. IT gives the dimensions
15104 of the display. Value is null if matrix is empty; otherwise it is
15105 a pointer to the row found. */
15107 static struct glyph_row
*
15108 find_last_row_displaying_text (matrix
, it
, start
)
15109 struct glyph_matrix
*matrix
;
15111 struct glyph_row
*start
;
15113 struct glyph_row
*row
, *row_found
;
15115 /* Set row_found to the last row in IT->w's current matrix
15116 displaying text. The loop looks funny but think of partially
15119 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15120 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15122 xassert (row
->enabled_p
);
15124 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15133 /* Return the last row in the current matrix of W that is not affected
15134 by changes at the start of current_buffer that occurred since W's
15135 current matrix was built. Value is null if no such row exists.
15137 BEG_UNCHANGED us the number of characters unchanged at the start of
15138 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15139 first changed character in current_buffer. Characters at positions <
15140 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15141 when the current matrix was built. */
15143 static struct glyph_row
*
15144 find_last_unchanged_at_beg_row (w
)
15147 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15148 struct glyph_row
*row
;
15149 struct glyph_row
*row_found
= NULL
;
15150 int yb
= window_text_bottom_y (w
);
15152 /* Find the last row displaying unchanged text. */
15153 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15154 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15155 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15158 if (/* If row ends before first_changed_pos, it is unchanged,
15159 except in some case. */
15160 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15161 /* When row ends in ZV and we write at ZV it is not
15163 && !row
->ends_at_zv_p
15164 /* When first_changed_pos is the end of a continued line,
15165 row is not unchanged because it may be no longer
15167 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15168 && (row
->continued_p
15169 || row
->exact_window_width_line_p
)))
15172 /* Stop if last visible row. */
15173 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15181 /* Find the first glyph row in the current matrix of W that is not
15182 affected by changes at the end of current_buffer since the
15183 time W's current matrix was built.
15185 Return in *DELTA the number of chars by which buffer positions in
15186 unchanged text at the end of current_buffer must be adjusted.
15188 Return in *DELTA_BYTES the corresponding number of bytes.
15190 Value is null if no such row exists, i.e. all rows are affected by
15193 static struct glyph_row
*
15194 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
15196 int *delta
, *delta_bytes
;
15198 struct glyph_row
*row
;
15199 struct glyph_row
*row_found
= NULL
;
15201 *delta
= *delta_bytes
= 0;
15203 /* Display must not have been paused, otherwise the current matrix
15204 is not up to date. */
15205 eassert (!NILP (w
->window_end_valid
));
15207 /* A value of window_end_pos >= END_UNCHANGED means that the window
15208 end is in the range of changed text. If so, there is no
15209 unchanged row at the end of W's current matrix. */
15210 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15213 /* Set row to the last row in W's current matrix displaying text. */
15214 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15216 /* If matrix is entirely empty, no unchanged row exists. */
15217 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15219 /* The value of row is the last glyph row in the matrix having a
15220 meaningful buffer position in it. The end position of row
15221 corresponds to window_end_pos. This allows us to translate
15222 buffer positions in the current matrix to current buffer
15223 positions for characters not in changed text. */
15224 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15225 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15226 int last_unchanged_pos
, last_unchanged_pos_old
;
15227 struct glyph_row
*first_text_row
15228 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15230 *delta
= Z
- Z_old
;
15231 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15233 /* Set last_unchanged_pos to the buffer position of the last
15234 character in the buffer that has not been changed. Z is the
15235 index + 1 of the last character in current_buffer, i.e. by
15236 subtracting END_UNCHANGED we get the index of the last
15237 unchanged character, and we have to add BEG to get its buffer
15239 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15240 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15242 /* Search backward from ROW for a row displaying a line that
15243 starts at a minimum position >= last_unchanged_pos_old. */
15244 for (; row
> first_text_row
; --row
)
15246 /* This used to abort, but it can happen.
15247 It is ok to just stop the search instead here. KFS. */
15248 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15251 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15256 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15262 /* Make sure that glyph rows in the current matrix of window W
15263 reference the same glyph memory as corresponding rows in the
15264 frame's frame matrix. This function is called after scrolling W's
15265 current matrix on a terminal frame in try_window_id and
15266 try_window_reusing_current_matrix. */
15269 sync_frame_with_window_matrix_rows (w
)
15272 struct frame
*f
= XFRAME (w
->frame
);
15273 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15275 /* Preconditions: W must be a leaf window and full-width. Its frame
15276 must have a frame matrix. */
15277 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15278 xassert (WINDOW_FULL_WIDTH_P (w
));
15279 xassert (!FRAME_WINDOW_P (f
));
15281 /* If W is a full-width window, glyph pointers in W's current matrix
15282 have, by definition, to be the same as glyph pointers in the
15283 corresponding frame matrix. Note that frame matrices have no
15284 marginal areas (see build_frame_matrix). */
15285 window_row
= w
->current_matrix
->rows
;
15286 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15287 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15288 while (window_row
< window_row_end
)
15290 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15291 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15293 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15294 frame_row
->glyphs
[TEXT_AREA
] = start
;
15295 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15296 frame_row
->glyphs
[LAST_AREA
] = end
;
15298 /* Disable frame rows whose corresponding window rows have
15299 been disabled in try_window_id. */
15300 if (!window_row
->enabled_p
)
15301 frame_row
->enabled_p
= 0;
15303 ++window_row
, ++frame_row
;
15308 /* Find the glyph row in window W containing CHARPOS. Consider all
15309 rows between START and END (not inclusive). END null means search
15310 all rows to the end of the display area of W. Value is the row
15311 containing CHARPOS or null. */
15314 row_containing_pos (w
, charpos
, start
, end
, dy
)
15317 struct glyph_row
*start
, *end
;
15320 struct glyph_row
*row
= start
;
15321 struct glyph_row
*best_row
= NULL
;
15322 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15325 /* If we happen to start on a header-line, skip that. */
15326 if (row
->mode_line_p
)
15329 if ((end
&& row
>= end
) || !row
->enabled_p
)
15332 last_y
= window_text_bottom_y (w
) - dy
;
15336 /* Give up if we have gone too far. */
15337 if (end
&& row
>= end
)
15339 /* This formerly returned if they were equal.
15340 I think that both quantities are of a "last plus one" type;
15341 if so, when they are equal, the row is within the screen. -- rms. */
15342 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15345 /* If it is in this row, return this row. */
15346 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15347 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15348 /* The end position of a row equals the start
15349 position of the next row. If CHARPOS is there, we
15350 would rather display it in the next line, except
15351 when this line ends in ZV. */
15352 && !row
->ends_at_zv_p
15353 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15354 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15358 if (NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
15360 /* In bidi-reordered rows, there could be several rows
15361 occluding point. We need to find the one which fits
15362 CHARPOS the best. */
15363 for (g
= row
->glyphs
[TEXT_AREA
];
15364 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15367 if (!STRINGP (g
->object
))
15369 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15371 mindif
= eabs (g
->charpos
- charpos
);
15384 /* Try to redisplay window W by reusing its existing display. W's
15385 current matrix must be up to date when this function is called,
15386 i.e. window_end_valid must not be nil.
15390 1 if display has been updated
15391 0 if otherwise unsuccessful
15392 -1 if redisplay with same window start is known not to succeed
15394 The following steps are performed:
15396 1. Find the last row in the current matrix of W that is not
15397 affected by changes at the start of current_buffer. If no such row
15400 2. Find the first row in W's current matrix that is not affected by
15401 changes at the end of current_buffer. Maybe there is no such row.
15403 3. Display lines beginning with the row + 1 found in step 1 to the
15404 row found in step 2 or, if step 2 didn't find a row, to the end of
15407 4. If cursor is not known to appear on the window, give up.
15409 5. If display stopped at the row found in step 2, scroll the
15410 display and current matrix as needed.
15412 6. Maybe display some lines at the end of W, if we must. This can
15413 happen under various circumstances, like a partially visible line
15414 becoming fully visible, or because newly displayed lines are displayed
15415 in smaller font sizes.
15417 7. Update W's window end information. */
15423 struct frame
*f
= XFRAME (w
->frame
);
15424 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15425 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15426 struct glyph_row
*last_unchanged_at_beg_row
;
15427 struct glyph_row
*first_unchanged_at_end_row
;
15428 struct glyph_row
*row
;
15429 struct glyph_row
*bottom_row
;
15432 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
15433 struct text_pos start_pos
;
15435 int first_unchanged_at_end_vpos
= 0;
15436 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15437 struct text_pos start
;
15438 int first_changed_charpos
, last_changed_charpos
;
15441 if (inhibit_try_window_id
)
15445 /* This is handy for debugging. */
15447 #define GIVE_UP(X) \
15449 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15453 #define GIVE_UP(X) return 0
15456 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15458 /* Don't use this for mini-windows because these can show
15459 messages and mini-buffers, and we don't handle that here. */
15460 if (MINI_WINDOW_P (w
))
15463 /* This flag is used to prevent redisplay optimizations. */
15464 if (windows_or_buffers_changed
|| cursor_type_changed
)
15467 /* Verify that narrowing has not changed.
15468 Also verify that we were not told to prevent redisplay optimizations.
15469 It would be nice to further
15470 reduce the number of cases where this prevents try_window_id. */
15471 if (current_buffer
->clip_changed
15472 || current_buffer
->prevent_redisplay_optimizations_p
)
15475 /* Window must either use window-based redisplay or be full width. */
15476 if (!FRAME_WINDOW_P (f
)
15477 && (!FRAME_LINE_INS_DEL_OK (f
)
15478 || !WINDOW_FULL_WIDTH_P (w
)))
15481 /* Give up if point is known NOT to appear in W. */
15482 if (PT
< CHARPOS (start
))
15485 /* Another way to prevent redisplay optimizations. */
15486 if (XFASTINT (w
->last_modified
) == 0)
15489 /* Verify that window is not hscrolled. */
15490 if (XFASTINT (w
->hscroll
) != 0)
15493 /* Verify that display wasn't paused. */
15494 if (NILP (w
->window_end_valid
))
15497 /* Can't use this if highlighting a region because a cursor movement
15498 will do more than just set the cursor. */
15499 if (!NILP (Vtransient_mark_mode
)
15500 && !NILP (current_buffer
->mark_active
))
15503 /* Likewise if highlighting trailing whitespace. */
15504 if (!NILP (Vshow_trailing_whitespace
))
15507 /* Likewise if showing a region. */
15508 if (!NILP (w
->region_showing
))
15511 /* Can't use this if overlay arrow position and/or string have
15513 if (overlay_arrows_changed_p ())
15516 /* When word-wrap is on, adding a space to the first word of a
15517 wrapped line can change the wrap position, altering the line
15518 above it. It might be worthwhile to handle this more
15519 intelligently, but for now just redisplay from scratch. */
15520 if (!NILP (XBUFFER (w
->buffer
)->word_wrap
))
15523 /* Under bidi reordering, adding or deleting a character in the
15524 beginning of a paragraph, before the first strong directional
15525 character, can change the base direction of the paragraph (unless
15526 the buffer specifies a fixed paragraph direction), which will
15527 require to redisplay the whole paragraph. It might be worthwhile
15528 to find the paragraph limits and widen the range of redisplayed
15529 lines to that, but for now just give up this optimization and
15530 redisplay from scratch. */
15531 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
15532 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
15535 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15536 only if buffer has really changed. The reason is that the gap is
15537 initially at Z for freshly visited files. The code below would
15538 set end_unchanged to 0 in that case. */
15539 if (MODIFF
> SAVE_MODIFF
15540 /* This seems to happen sometimes after saving a buffer. */
15541 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15543 if (GPT
- BEG
< BEG_UNCHANGED
)
15544 BEG_UNCHANGED
= GPT
- BEG
;
15545 if (Z
- GPT
< END_UNCHANGED
)
15546 END_UNCHANGED
= Z
- GPT
;
15549 /* The position of the first and last character that has been changed. */
15550 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15551 last_changed_charpos
= Z
- END_UNCHANGED
;
15553 /* If window starts after a line end, and the last change is in
15554 front of that newline, then changes don't affect the display.
15555 This case happens with stealth-fontification. Note that although
15556 the display is unchanged, glyph positions in the matrix have to
15557 be adjusted, of course. */
15558 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15559 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15560 && ((last_changed_charpos
< CHARPOS (start
)
15561 && CHARPOS (start
) == BEGV
)
15562 || (last_changed_charpos
< CHARPOS (start
) - 1
15563 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15565 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
15566 struct glyph_row
*r0
;
15568 /* Compute how many chars/bytes have been added to or removed
15569 from the buffer. */
15570 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15571 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15573 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15575 /* Give up if PT is not in the window. Note that it already has
15576 been checked at the start of try_window_id that PT is not in
15577 front of the window start. */
15578 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
15581 /* If window start is unchanged, we can reuse the whole matrix
15582 as is, after adjusting glyph positions. No need to compute
15583 the window end again, since its offset from Z hasn't changed. */
15584 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15585 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
15586 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
15587 /* PT must not be in a partially visible line. */
15588 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
15589 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15591 /* Adjust positions in the glyph matrix. */
15592 if (delta
|| delta_bytes
)
15594 struct glyph_row
*r1
15595 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15596 increment_matrix_positions (w
->current_matrix
,
15597 MATRIX_ROW_VPOS (r0
, current_matrix
),
15598 MATRIX_ROW_VPOS (r1
, current_matrix
),
15599 delta
, delta_bytes
);
15602 /* Set the cursor. */
15603 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15605 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15612 /* Handle the case that changes are all below what is displayed in
15613 the window, and that PT is in the window. This shortcut cannot
15614 be taken if ZV is visible in the window, and text has been added
15615 there that is visible in the window. */
15616 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15617 /* ZV is not visible in the window, or there are no
15618 changes at ZV, actually. */
15619 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15620 || first_changed_charpos
== last_changed_charpos
))
15622 struct glyph_row
*r0
;
15624 /* Give up if PT is not in the window. Note that it already has
15625 been checked at the start of try_window_id that PT is not in
15626 front of the window start. */
15627 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15630 /* If window start is unchanged, we can reuse the whole matrix
15631 as is, without changing glyph positions since no text has
15632 been added/removed in front of the window end. */
15633 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15634 if (TEXT_POS_EQUAL_P (start
, r0
->start
.pos
)
15635 /* PT must not be in a partially visible line. */
15636 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15637 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15639 /* We have to compute the window end anew since text
15640 can have been added/removed after it. */
15642 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15643 w
->window_end_bytepos
15644 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15646 /* Set the cursor. */
15647 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15649 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15656 /* Give up if window start is in the changed area.
15658 The condition used to read
15660 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15662 but why that was tested escapes me at the moment. */
15663 if (CHARPOS (start
) >= first_changed_charpos
15664 && CHARPOS (start
) <= last_changed_charpos
)
15667 /* Check that window start agrees with the start of the first glyph
15668 row in its current matrix. Check this after we know the window
15669 start is not in changed text, otherwise positions would not be
15671 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15672 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
15675 /* Give up if the window ends in strings. Overlay strings
15676 at the end are difficult to handle, so don't try. */
15677 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15678 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15681 /* Compute the position at which we have to start displaying new
15682 lines. Some of the lines at the top of the window might be
15683 reusable because they are not displaying changed text. Find the
15684 last row in W's current matrix not affected by changes at the
15685 start of current_buffer. Value is null if changes start in the
15686 first line of window. */
15687 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15688 if (last_unchanged_at_beg_row
)
15690 /* Avoid starting to display in the moddle of a character, a TAB
15691 for instance. This is easier than to set up the iterator
15692 exactly, and it's not a frequent case, so the additional
15693 effort wouldn't really pay off. */
15694 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15695 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15696 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15697 --last_unchanged_at_beg_row
;
15699 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15702 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15704 start_pos
= it
.current
.pos
;
15706 /* Start displaying new lines in the desired matrix at the same
15707 vpos we would use in the current matrix, i.e. below
15708 last_unchanged_at_beg_row. */
15709 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15711 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15712 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15714 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15718 /* There are no reusable lines at the start of the window.
15719 Start displaying in the first text line. */
15720 start_display (&it
, w
, start
);
15721 it
.vpos
= it
.first_vpos
;
15722 start_pos
= it
.current
.pos
;
15725 /* Find the first row that is not affected by changes at the end of
15726 the buffer. Value will be null if there is no unchanged row, in
15727 which case we must redisplay to the end of the window. delta
15728 will be set to the value by which buffer positions beginning with
15729 first_unchanged_at_end_row have to be adjusted due to text
15731 first_unchanged_at_end_row
15732 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15733 IF_DEBUG (debug_delta
= delta
);
15734 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15736 /* Set stop_pos to the buffer position up to which we will have to
15737 display new lines. If first_unchanged_at_end_row != NULL, this
15738 is the buffer position of the start of the line displayed in that
15739 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15740 that we don't stop at a buffer position. */
15742 if (first_unchanged_at_end_row
)
15744 xassert (last_unchanged_at_beg_row
== NULL
15745 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15747 /* If this is a continuation line, move forward to the next one
15748 that isn't. Changes in lines above affect this line.
15749 Caution: this may move first_unchanged_at_end_row to a row
15750 not displaying text. */
15751 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15752 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15753 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15754 < it
.last_visible_y
))
15755 ++first_unchanged_at_end_row
;
15757 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15758 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15759 >= it
.last_visible_y
))
15760 first_unchanged_at_end_row
= NULL
;
15763 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15765 first_unchanged_at_end_vpos
15766 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15767 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15770 else if (last_unchanged_at_beg_row
== NULL
)
15776 /* Either there is no unchanged row at the end, or the one we have
15777 now displays text. This is a necessary condition for the window
15778 end pos calculation at the end of this function. */
15779 xassert (first_unchanged_at_end_row
== NULL
15780 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15782 debug_last_unchanged_at_beg_vpos
15783 = (last_unchanged_at_beg_row
15784 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15786 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15788 #endif /* GLYPH_DEBUG != 0 */
15791 /* Display new lines. Set last_text_row to the last new line
15792 displayed which has text on it, i.e. might end up as being the
15793 line where the window_end_vpos is. */
15794 w
->cursor
.vpos
= -1;
15795 last_text_row
= NULL
;
15796 overlay_arrow_seen
= 0;
15797 while (it
.current_y
< it
.last_visible_y
15798 && !fonts_changed_p
15799 && (first_unchanged_at_end_row
== NULL
15800 || IT_CHARPOS (it
) < stop_pos
))
15802 if (display_line (&it
))
15803 last_text_row
= it
.glyph_row
- 1;
15806 if (fonts_changed_p
)
15810 /* Compute differences in buffer positions, y-positions etc. for
15811 lines reused at the bottom of the window. Compute what we can
15813 if (first_unchanged_at_end_row
15814 /* No lines reused because we displayed everything up to the
15815 bottom of the window. */
15816 && it
.current_y
< it
.last_visible_y
)
15819 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15821 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15822 run
.current_y
= first_unchanged_at_end_row
->y
;
15823 run
.desired_y
= run
.current_y
+ dy
;
15824 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15828 delta
= delta_bytes
= dvpos
= dy
15829 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15830 first_unchanged_at_end_row
= NULL
;
15832 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15835 /* Find the cursor if not already found. We have to decide whether
15836 PT will appear on this window (it sometimes doesn't, but this is
15837 not a very frequent case.) This decision has to be made before
15838 the current matrix is altered. A value of cursor.vpos < 0 means
15839 that PT is either in one of the lines beginning at
15840 first_unchanged_at_end_row or below the window. Don't care for
15841 lines that might be displayed later at the window end; as
15842 mentioned, this is not a frequent case. */
15843 if (w
->cursor
.vpos
< 0)
15845 /* Cursor in unchanged rows at the top? */
15846 if (PT
< CHARPOS (start_pos
)
15847 && last_unchanged_at_beg_row
)
15849 row
= row_containing_pos (w
, PT
,
15850 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15851 last_unchanged_at_beg_row
+ 1, 0);
15853 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15856 /* Start from first_unchanged_at_end_row looking for PT. */
15857 else if (first_unchanged_at_end_row
)
15859 row
= row_containing_pos (w
, PT
- delta
,
15860 first_unchanged_at_end_row
, NULL
, 0);
15862 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15863 delta_bytes
, dy
, dvpos
);
15866 /* Give up if cursor was not found. */
15867 if (w
->cursor
.vpos
< 0)
15869 clear_glyph_matrix (w
->desired_matrix
);
15874 /* Don't let the cursor end in the scroll margins. */
15876 int this_scroll_margin
, cursor_height
;
15878 this_scroll_margin
= max (0, scroll_margin
);
15879 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15880 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15881 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15883 if ((w
->cursor
.y
< this_scroll_margin
15884 && CHARPOS (start
) > BEGV
)
15885 /* Old redisplay didn't take scroll margin into account at the bottom,
15886 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15887 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15888 ? cursor_height
+ this_scroll_margin
15889 : 1)) > it
.last_visible_y
)
15891 w
->cursor
.vpos
= -1;
15892 clear_glyph_matrix (w
->desired_matrix
);
15897 /* Scroll the display. Do it before changing the current matrix so
15898 that xterm.c doesn't get confused about where the cursor glyph is
15900 if (dy
&& run
.height
)
15904 if (FRAME_WINDOW_P (f
))
15906 FRAME_RIF (f
)->update_window_begin_hook (w
);
15907 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15908 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15909 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15913 /* Terminal frame. In this case, dvpos gives the number of
15914 lines to scroll by; dvpos < 0 means scroll up. */
15915 int first_unchanged_at_end_vpos
15916 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15917 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
15918 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15919 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15920 + window_internal_height (w
));
15922 /* Perform the operation on the screen. */
15925 /* Scroll last_unchanged_at_beg_row to the end of the
15926 window down dvpos lines. */
15927 set_terminal_window (f
, end
);
15929 /* On dumb terminals delete dvpos lines at the end
15930 before inserting dvpos empty lines. */
15931 if (!FRAME_SCROLL_REGION_OK (f
))
15932 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15934 /* Insert dvpos empty lines in front of
15935 last_unchanged_at_beg_row. */
15936 ins_del_lines (f
, from
, dvpos
);
15938 else if (dvpos
< 0)
15940 /* Scroll up last_unchanged_at_beg_vpos to the end of
15941 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15942 set_terminal_window (f
, end
);
15944 /* Delete dvpos lines in front of
15945 last_unchanged_at_beg_vpos. ins_del_lines will set
15946 the cursor to the given vpos and emit |dvpos| delete
15948 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15950 /* On a dumb terminal insert dvpos empty lines at the
15952 if (!FRAME_SCROLL_REGION_OK (f
))
15953 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15956 set_terminal_window (f
, 0);
15962 /* Shift reused rows of the current matrix to the right position.
15963 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15965 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15966 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15969 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15970 bottom_vpos
, dvpos
);
15971 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15974 else if (dvpos
> 0)
15976 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15977 bottom_vpos
, dvpos
);
15978 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15979 first_unchanged_at_end_vpos
+ dvpos
, 0);
15982 /* For frame-based redisplay, make sure that current frame and window
15983 matrix are in sync with respect to glyph memory. */
15984 if (!FRAME_WINDOW_P (f
))
15985 sync_frame_with_window_matrix_rows (w
);
15987 /* Adjust buffer positions in reused rows. */
15988 if (delta
|| delta_bytes
)
15989 increment_matrix_positions (current_matrix
,
15990 first_unchanged_at_end_vpos
+ dvpos
,
15991 bottom_vpos
, delta
, delta_bytes
);
15993 /* Adjust Y positions. */
15995 shift_glyph_matrix (w
, current_matrix
,
15996 first_unchanged_at_end_vpos
+ dvpos
,
15999 if (first_unchanged_at_end_row
)
16001 first_unchanged_at_end_row
+= dvpos
;
16002 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
16003 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
16004 first_unchanged_at_end_row
= NULL
;
16007 /* If scrolling up, there may be some lines to display at the end of
16009 last_text_row_at_end
= NULL
;
16012 /* Scrolling up can leave for example a partially visible line
16013 at the end of the window to be redisplayed. */
16014 /* Set last_row to the glyph row in the current matrix where the
16015 window end line is found. It has been moved up or down in
16016 the matrix by dvpos. */
16017 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
16018 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
16020 /* If last_row is the window end line, it should display text. */
16021 xassert (last_row
->displays_text_p
);
16023 /* If window end line was partially visible before, begin
16024 displaying at that line. Otherwise begin displaying with the
16025 line following it. */
16026 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16028 init_to_row_start (&it
, w
, last_row
);
16029 it
.vpos
= last_vpos
;
16030 it
.current_y
= last_row
->y
;
16034 init_to_row_end (&it
, w
, last_row
);
16035 it
.vpos
= 1 + last_vpos
;
16036 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16040 /* We may start in a continuation line. If so, we have to
16041 get the right continuation_lines_width and current_x. */
16042 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16043 it
.hpos
= it
.current_x
= 0;
16045 /* Display the rest of the lines at the window end. */
16046 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16047 while (it
.current_y
< it
.last_visible_y
16048 && !fonts_changed_p
)
16050 /* Is it always sure that the display agrees with lines in
16051 the current matrix? I don't think so, so we mark rows
16052 displayed invalid in the current matrix by setting their
16053 enabled_p flag to zero. */
16054 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16055 if (display_line (&it
))
16056 last_text_row_at_end
= it
.glyph_row
- 1;
16060 /* Update window_end_pos and window_end_vpos. */
16061 if (first_unchanged_at_end_row
16062 && !last_text_row_at_end
)
16064 /* Window end line if one of the preserved rows from the current
16065 matrix. Set row to the last row displaying text in current
16066 matrix starting at first_unchanged_at_end_row, after
16068 xassert (first_unchanged_at_end_row
->displays_text_p
);
16069 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16070 first_unchanged_at_end_row
);
16071 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16073 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16074 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16076 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16077 xassert (w
->window_end_bytepos
>= 0);
16078 IF_DEBUG (debug_method_add (w
, "A"));
16080 else if (last_text_row_at_end
)
16083 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16084 w
->window_end_bytepos
16085 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16087 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16088 xassert (w
->window_end_bytepos
>= 0);
16089 IF_DEBUG (debug_method_add (w
, "B"));
16091 else if (last_text_row
)
16093 /* We have displayed either to the end of the window or at the
16094 end of the window, i.e. the last row with text is to be found
16095 in the desired matrix. */
16097 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16098 w
->window_end_bytepos
16099 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16101 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16102 xassert (w
->window_end_bytepos
>= 0);
16104 else if (first_unchanged_at_end_row
== NULL
16105 && last_text_row
== NULL
16106 && last_text_row_at_end
== NULL
)
16108 /* Displayed to end of window, but no line containing text was
16109 displayed. Lines were deleted at the end of the window. */
16110 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16111 int vpos
= XFASTINT (w
->window_end_vpos
);
16112 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16113 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16116 row
== NULL
&& vpos
>= first_vpos
;
16117 --vpos
, --current_row
, --desired_row
)
16119 if (desired_row
->enabled_p
)
16121 if (desired_row
->displays_text_p
)
16124 else if (current_row
->displays_text_p
)
16128 xassert (row
!= NULL
);
16129 w
->window_end_vpos
= make_number (vpos
+ 1);
16130 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16131 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16132 xassert (w
->window_end_bytepos
>= 0);
16133 IF_DEBUG (debug_method_add (w
, "C"));
16138 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16139 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16141 /* Record that display has not been completed. */
16142 w
->window_end_valid
= Qnil
;
16143 w
->desired_matrix
->no_scrolling_p
= 1;
16151 /***********************************************************************
16152 More debugging support
16153 ***********************************************************************/
16157 void dump_glyph_row
P_ ((struct glyph_row
*, int, int));
16158 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
16159 void dump_glyph
P_ ((struct glyph_row
*, struct glyph
*, int));
16162 /* Dump the contents of glyph matrix MATRIX on stderr.
16164 GLYPHS 0 means don't show glyph contents.
16165 GLYPHS 1 means show glyphs in short form
16166 GLYPHS > 1 means show glyphs in long form. */
16169 dump_glyph_matrix (matrix
, glyphs
)
16170 struct glyph_matrix
*matrix
;
16174 for (i
= 0; i
< matrix
->nrows
; ++i
)
16175 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16179 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16180 the glyph row and area where the glyph comes from. */
16183 dump_glyph (row
, glyph
, area
)
16184 struct glyph_row
*row
;
16185 struct glyph
*glyph
;
16188 if (glyph
->type
== CHAR_GLYPH
)
16191 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16192 glyph
- row
->glyphs
[TEXT_AREA
],
16195 (BUFFERP (glyph
->object
)
16197 : (STRINGP (glyph
->object
)
16200 glyph
->pixel_width
,
16202 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16206 glyph
->left_box_line_p
,
16207 glyph
->right_box_line_p
);
16209 else if (glyph
->type
== STRETCH_GLYPH
)
16212 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16213 glyph
- row
->glyphs
[TEXT_AREA
],
16216 (BUFFERP (glyph
->object
)
16218 : (STRINGP (glyph
->object
)
16221 glyph
->pixel_width
,
16225 glyph
->left_box_line_p
,
16226 glyph
->right_box_line_p
);
16228 else if (glyph
->type
== IMAGE_GLYPH
)
16231 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16232 glyph
- row
->glyphs
[TEXT_AREA
],
16235 (BUFFERP (glyph
->object
)
16237 : (STRINGP (glyph
->object
)
16240 glyph
->pixel_width
,
16244 glyph
->left_box_line_p
,
16245 glyph
->right_box_line_p
);
16247 else if (glyph
->type
== COMPOSITE_GLYPH
)
16250 " %5d %4c %6d %c %3d 0x%05x",
16251 glyph
- row
->glyphs
[TEXT_AREA
],
16254 (BUFFERP (glyph
->object
)
16256 : (STRINGP (glyph
->object
)
16259 glyph
->pixel_width
,
16261 if (glyph
->u
.cmp
.automatic
)
16264 glyph
->u
.cmp
.from
, glyph
->u
.cmp
.to
);
16265 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16267 glyph
->left_box_line_p
,
16268 glyph
->right_box_line_p
);
16273 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16274 GLYPHS 0 means don't show glyph contents.
16275 GLYPHS 1 means show glyphs in short form
16276 GLYPHS > 1 means show glyphs in long form. */
16279 dump_glyph_row (row
, vpos
, glyphs
)
16280 struct glyph_row
*row
;
16285 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16286 fprintf (stderr
, "======================================================================\n");
16288 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16289 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16291 MATRIX_ROW_START_CHARPOS (row
),
16292 MATRIX_ROW_END_CHARPOS (row
),
16293 row
->used
[TEXT_AREA
],
16294 row
->contains_overlapping_glyphs_p
,
16296 row
->truncated_on_left_p
,
16297 row
->truncated_on_right_p
,
16299 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16300 row
->displays_text_p
,
16303 row
->ends_in_middle_of_char_p
,
16304 row
->starts_in_middle_of_char_p
,
16310 row
->visible_height
,
16313 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16314 row
->end
.overlay_string_index
,
16315 row
->continuation_lines_width
);
16316 fprintf (stderr
, "%9d %5d\n",
16317 CHARPOS (row
->start
.string_pos
),
16318 CHARPOS (row
->end
.string_pos
));
16319 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16320 row
->end
.dpvec_index
);
16327 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16329 struct glyph
*glyph
= row
->glyphs
[area
];
16330 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16332 /* Glyph for a line end in text. */
16333 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16336 if (glyph
< glyph_end
)
16337 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16339 for (; glyph
< glyph_end
; ++glyph
)
16340 dump_glyph (row
, glyph
, area
);
16343 else if (glyphs
== 1)
16347 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16349 char *s
= (char *) alloca (row
->used
[area
] + 1);
16352 for (i
= 0; i
< row
->used
[area
]; ++i
)
16354 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16355 if (glyph
->type
== CHAR_GLYPH
16356 && glyph
->u
.ch
< 0x80
16357 && glyph
->u
.ch
>= ' ')
16358 s
[i
] = glyph
->u
.ch
;
16364 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16370 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16371 Sdump_glyph_matrix
, 0, 1, "p",
16372 doc
: /* Dump the current matrix of the selected window to stderr.
16373 Shows contents of glyph row structures. With non-nil
16374 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16375 glyphs in short form, otherwise show glyphs in long form. */)
16377 Lisp_Object glyphs
;
16379 struct window
*w
= XWINDOW (selected_window
);
16380 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16382 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16383 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16384 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16385 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16386 fprintf (stderr
, "=============================================\n");
16387 dump_glyph_matrix (w
->current_matrix
,
16388 NILP (glyphs
) ? 0 : XINT (glyphs
));
16393 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16394 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16397 struct frame
*f
= XFRAME (selected_frame
);
16398 dump_glyph_matrix (f
->current_matrix
, 1);
16403 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16404 doc
: /* Dump glyph row ROW to stderr.
16405 GLYPH 0 means don't dump glyphs.
16406 GLYPH 1 means dump glyphs in short form.
16407 GLYPH > 1 or omitted means dump glyphs in long form. */)
16409 Lisp_Object row
, glyphs
;
16411 struct glyph_matrix
*matrix
;
16414 CHECK_NUMBER (row
);
16415 matrix
= XWINDOW (selected_window
)->current_matrix
;
16417 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16418 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16420 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16425 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16426 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16427 GLYPH 0 means don't dump glyphs.
16428 GLYPH 1 means dump glyphs in short form.
16429 GLYPH > 1 or omitted means dump glyphs in long form. */)
16431 Lisp_Object row
, glyphs
;
16433 struct frame
*sf
= SELECTED_FRAME ();
16434 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16437 CHECK_NUMBER (row
);
16439 if (vpos
>= 0 && vpos
< m
->nrows
)
16440 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16441 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16446 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16447 doc
: /* Toggle tracing of redisplay.
16448 With ARG, turn tracing on if and only if ARG is positive. */)
16453 trace_redisplay_p
= !trace_redisplay_p
;
16456 arg
= Fprefix_numeric_value (arg
);
16457 trace_redisplay_p
= XINT (arg
) > 0;
16464 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16465 doc
: /* Like `format', but print result to stderr.
16466 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16471 Lisp_Object s
= Fformat (nargs
, args
);
16472 fprintf (stderr
, "%s", SDATA (s
));
16476 #endif /* GLYPH_DEBUG */
16480 /***********************************************************************
16481 Building Desired Matrix Rows
16482 ***********************************************************************/
16484 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16485 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16487 static struct glyph_row
*
16488 get_overlay_arrow_glyph_row (w
, overlay_arrow_string
)
16490 Lisp_Object overlay_arrow_string
;
16492 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16493 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16494 struct buffer
*old
= current_buffer
;
16495 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16496 int arrow_len
= SCHARS (overlay_arrow_string
);
16497 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16498 const unsigned char *p
;
16501 int n_glyphs_before
;
16503 set_buffer_temp (buffer
);
16504 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16505 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16506 SET_TEXT_POS (it
.position
, 0, 0);
16508 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
16510 while (p
< arrow_end
)
16512 Lisp_Object face
, ilisp
;
16514 /* Get the next character. */
16516 it
.c
= string_char_and_length (p
, &it
.len
);
16518 it
.c
= *p
, it
.len
= 1;
16521 /* Get its face. */
16522 ilisp
= make_number (p
- arrow_string
);
16523 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16524 it
.face_id
= compute_char_face (f
, it
.c
, face
);
16526 /* Compute its width, get its glyphs. */
16527 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16528 SET_TEXT_POS (it
.position
, -1, -1);
16529 PRODUCE_GLYPHS (&it
);
16531 /* If this character doesn't fit any more in the line, we have
16532 to remove some glyphs. */
16533 if (it
.current_x
> it
.last_visible_x
)
16535 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16540 set_buffer_temp (old
);
16541 return it
.glyph_row
;
16545 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16546 glyphs are only inserted for terminal frames since we can't really
16547 win with truncation glyphs when partially visible glyphs are
16548 involved. Which glyphs to insert is determined by
16549 produce_special_glyphs. */
16552 insert_left_trunc_glyphs (it
)
16555 struct it truncate_it
;
16556 struct glyph
*from
, *end
, *to
, *toend
;
16558 xassert (!FRAME_WINDOW_P (it
->f
));
16560 /* Get the truncation glyphs. */
16562 truncate_it
.current_x
= 0;
16563 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16564 truncate_it
.glyph_row
= &scratch_glyph_row
;
16565 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16566 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16567 truncate_it
.object
= make_number (0);
16568 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16570 /* Overwrite glyphs from IT with truncation glyphs. */
16571 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16572 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16573 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16574 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16579 /* There may be padding glyphs left over. Overwrite them too. */
16580 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16582 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16588 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16592 /* Compute the pixel height and width of IT->glyph_row.
16594 Most of the time, ascent and height of a display line will be equal
16595 to the max_ascent and max_height values of the display iterator
16596 structure. This is not the case if
16598 1. We hit ZV without displaying anything. In this case, max_ascent
16599 and max_height will be zero.
16601 2. We have some glyphs that don't contribute to the line height.
16602 (The glyph row flag contributes_to_line_height_p is for future
16603 pixmap extensions).
16605 The first case is easily covered by using default values because in
16606 these cases, the line height does not really matter, except that it
16607 must not be zero. */
16610 compute_line_metrics (it
)
16613 struct glyph_row
*row
= it
->glyph_row
;
16616 if (FRAME_WINDOW_P (it
->f
))
16618 int i
, min_y
, max_y
;
16620 /* The line may consist of one space only, that was added to
16621 place the cursor on it. If so, the row's height hasn't been
16623 if (row
->height
== 0)
16625 if (it
->max_ascent
+ it
->max_descent
== 0)
16626 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16627 row
->ascent
= it
->max_ascent
;
16628 row
->height
= it
->max_ascent
+ it
->max_descent
;
16629 row
->phys_ascent
= it
->max_phys_ascent
;
16630 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16631 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16634 /* Compute the width of this line. */
16635 row
->pixel_width
= row
->x
;
16636 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16637 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16639 xassert (row
->pixel_width
>= 0);
16640 xassert (row
->ascent
>= 0 && row
->height
> 0);
16642 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16643 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16645 /* If first line's physical ascent is larger than its logical
16646 ascent, use the physical ascent, and make the row taller.
16647 This makes accented characters fully visible. */
16648 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16649 && row
->phys_ascent
> row
->ascent
)
16651 row
->height
+= row
->phys_ascent
- row
->ascent
;
16652 row
->ascent
= row
->phys_ascent
;
16655 /* Compute how much of the line is visible. */
16656 row
->visible_height
= row
->height
;
16658 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16659 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16661 if (row
->y
< min_y
)
16662 row
->visible_height
-= min_y
- row
->y
;
16663 if (row
->y
+ row
->height
> max_y
)
16664 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16668 row
->pixel_width
= row
->used
[TEXT_AREA
];
16669 if (row
->continued_p
)
16670 row
->pixel_width
-= it
->continuation_pixel_width
;
16671 else if (row
->truncated_on_right_p
)
16672 row
->pixel_width
-= it
->truncation_pixel_width
;
16673 row
->ascent
= row
->phys_ascent
= 0;
16674 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16675 row
->extra_line_spacing
= 0;
16678 /* Compute a hash code for this row. */
16680 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16681 for (i
= 0; i
< row
->used
[area
]; ++i
)
16682 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16683 + row
->glyphs
[area
][i
].u
.val
16684 + row
->glyphs
[area
][i
].face_id
16685 + row
->glyphs
[area
][i
].padding_p
16686 + (row
->glyphs
[area
][i
].type
<< 2));
16688 it
->max_ascent
= it
->max_descent
= 0;
16689 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16693 /* Append one space to the glyph row of iterator IT if doing a
16694 window-based redisplay. The space has the same face as
16695 IT->face_id. Value is non-zero if a space was added.
16697 This function is called to make sure that there is always one glyph
16698 at the end of a glyph row that the cursor can be set on under
16699 window-systems. (If there weren't such a glyph we would not know
16700 how wide and tall a box cursor should be displayed).
16702 At the same time this space let's a nicely handle clearing to the
16703 end of the line if the row ends in italic text. */
16706 append_space_for_newline (it
, default_face_p
)
16708 int default_face_p
;
16710 if (FRAME_WINDOW_P (it
->f
))
16712 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16714 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16715 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16717 /* Save some values that must not be changed.
16718 Must save IT->c and IT->len because otherwise
16719 ITERATOR_AT_END_P wouldn't work anymore after
16720 append_space_for_newline has been called. */
16721 enum display_element_type saved_what
= it
->what
;
16722 int saved_c
= it
->c
, saved_len
= it
->len
;
16723 int saved_x
= it
->current_x
;
16724 int saved_face_id
= it
->face_id
;
16725 struct text_pos saved_pos
;
16726 Lisp_Object saved_object
;
16729 saved_object
= it
->object
;
16730 saved_pos
= it
->position
;
16732 it
->what
= IT_CHARACTER
;
16733 bzero (&it
->position
, sizeof it
->position
);
16734 it
->object
= make_number (0);
16738 if (default_face_p
)
16739 it
->face_id
= DEFAULT_FACE_ID
;
16740 else if (it
->face_before_selective_p
)
16741 it
->face_id
= it
->saved_face_id
;
16742 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16743 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16745 PRODUCE_GLYPHS (it
);
16747 it
->override_ascent
= -1;
16748 it
->constrain_row_ascent_descent_p
= 0;
16749 it
->current_x
= saved_x
;
16750 it
->object
= saved_object
;
16751 it
->position
= saved_pos
;
16752 it
->what
= saved_what
;
16753 it
->face_id
= saved_face_id
;
16754 it
->len
= saved_len
;
16764 /* Extend the face of the last glyph in the text area of IT->glyph_row
16765 to the end of the display line. Called from display_line.
16766 If the glyph row is empty, add a space glyph to it so that we
16767 know the face to draw. Set the glyph row flag fill_line_p. */
16770 extend_face_to_end_of_line (it
)
16774 struct frame
*f
= it
->f
;
16776 /* If line is already filled, do nothing. */
16777 if (it
->current_x
>= it
->last_visible_x
)
16780 /* Face extension extends the background and box of IT->face_id
16781 to the end of the line. If the background equals the background
16782 of the frame, we don't have to do anything. */
16783 if (it
->face_before_selective_p
)
16784 face
= FACE_FROM_ID (it
->f
, it
->saved_face_id
);
16786 face
= FACE_FROM_ID (f
, it
->face_id
);
16788 if (FRAME_WINDOW_P (f
)
16789 && it
->glyph_row
->displays_text_p
16790 && face
->box
== FACE_NO_BOX
16791 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16795 /* Set the glyph row flag indicating that the face of the last glyph
16796 in the text area has to be drawn to the end of the text area. */
16797 it
->glyph_row
->fill_line_p
= 1;
16799 /* If current character of IT is not ASCII, make sure we have the
16800 ASCII face. This will be automatically undone the next time
16801 get_next_display_element returns a multibyte character. Note
16802 that the character will always be single byte in unibyte
16804 if (!ASCII_CHAR_P (it
->c
))
16806 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16809 if (FRAME_WINDOW_P (f
))
16811 /* If the row is empty, add a space with the current face of IT,
16812 so that we know which face to draw. */
16813 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16815 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16816 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16817 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16822 /* Save some values that must not be changed. */
16823 int saved_x
= it
->current_x
;
16824 struct text_pos saved_pos
;
16825 Lisp_Object saved_object
;
16826 enum display_element_type saved_what
= it
->what
;
16827 int saved_face_id
= it
->face_id
;
16829 saved_object
= it
->object
;
16830 saved_pos
= it
->position
;
16832 it
->what
= IT_CHARACTER
;
16833 bzero (&it
->position
, sizeof it
->position
);
16834 it
->object
= make_number (0);
16837 it
->face_id
= face
->id
;
16839 PRODUCE_GLYPHS (it
);
16841 while (it
->current_x
<= it
->last_visible_x
)
16842 PRODUCE_GLYPHS (it
);
16844 /* Don't count these blanks really. It would let us insert a left
16845 truncation glyph below and make us set the cursor on them, maybe. */
16846 it
->current_x
= saved_x
;
16847 it
->object
= saved_object
;
16848 it
->position
= saved_pos
;
16849 it
->what
= saved_what
;
16850 it
->face_id
= saved_face_id
;
16855 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16856 trailing whitespace. */
16859 trailing_whitespace_p (charpos
)
16862 int bytepos
= CHAR_TO_BYTE (charpos
);
16865 while (bytepos
< ZV_BYTE
16866 && (c
= FETCH_CHAR (bytepos
),
16867 c
== ' ' || c
== '\t'))
16870 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16872 if (bytepos
!= PT_BYTE
)
16879 /* Highlight trailing whitespace, if any, in ROW. */
16882 highlight_trailing_whitespace (f
, row
)
16884 struct glyph_row
*row
;
16886 int used
= row
->used
[TEXT_AREA
];
16890 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16891 struct glyph
*glyph
= start
+ used
- 1;
16893 if (row
->reversed_p
)
16895 /* Right-to-left rows need to be processed in the opposite
16896 direction, so swap the edge pointers. */
16898 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
16901 /* Skip over glyphs inserted to display the cursor at the
16902 end of a line, for extending the face of the last glyph
16903 to the end of the line on terminals, and for truncation
16904 and continuation glyphs. */
16905 if (!row
->reversed_p
)
16907 while (glyph
>= start
16908 && glyph
->type
== CHAR_GLYPH
16909 && INTEGERP (glyph
->object
))
16914 while (glyph
<= start
16915 && glyph
->type
== CHAR_GLYPH
16916 && INTEGERP (glyph
->object
))
16920 /* If last glyph is a space or stretch, and it's trailing
16921 whitespace, set the face of all trailing whitespace glyphs in
16922 IT->glyph_row to `trailing-whitespace'. */
16923 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
16924 && BUFFERP (glyph
->object
)
16925 && (glyph
->type
== STRETCH_GLYPH
16926 || (glyph
->type
== CHAR_GLYPH
16927 && glyph
->u
.ch
== ' '))
16928 && trailing_whitespace_p (glyph
->charpos
))
16930 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
16934 if (!row
->reversed_p
)
16936 while (glyph
>= start
16937 && BUFFERP (glyph
->object
)
16938 && (glyph
->type
== STRETCH_GLYPH
16939 || (glyph
->type
== CHAR_GLYPH
16940 && glyph
->u
.ch
== ' ')))
16941 (glyph
--)->face_id
= face_id
;
16945 while (glyph
<= start
16946 && BUFFERP (glyph
->object
)
16947 && (glyph
->type
== STRETCH_GLYPH
16948 || (glyph
->type
== CHAR_GLYPH
16949 && glyph
->u
.ch
== ' ')))
16950 (glyph
++)->face_id
= face_id
;
16957 /* Value is non-zero if glyph row ROW in window W should be
16958 used to hold the cursor. */
16961 cursor_row_p (w
, row
)
16963 struct glyph_row
*row
;
16965 int cursor_row_p
= 1;
16967 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
16969 /* Suppose the row ends on a string.
16970 Unless the row is continued, that means it ends on a newline
16971 in the string. If it's anything other than a display string
16972 (e.g. a before-string from an overlay), we don't want the
16973 cursor there. (This heuristic seems to give the optimal
16974 behavior for the various types of multi-line strings.) */
16975 if (CHARPOS (row
->end
.string_pos
) >= 0)
16977 if (row
->continued_p
)
16981 /* Check for `display' property. */
16982 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
16983 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
16984 struct glyph
*glyph
;
16987 for (glyph
= end
; glyph
>= beg
; --glyph
)
16988 if (STRINGP (glyph
->object
))
16991 = Fget_char_property (make_number (PT
),
16995 && display_prop_string_p (prop
, glyph
->object
));
17000 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17002 /* If the row ends in middle of a real character,
17003 and the line is continued, we want the cursor here.
17004 That's because MATRIX_ROW_END_CHARPOS would equal
17005 PT if PT is before the character. */
17006 if (!row
->ends_in_ellipsis_p
)
17007 cursor_row_p
= row
->continued_p
;
17009 /* If the row ends in an ellipsis, then
17010 MATRIX_ROW_END_CHARPOS will equal point after the invisible text.
17011 We want that position to be displayed after the ellipsis. */
17014 /* If the row ends at ZV, display the cursor at the end of that
17015 row instead of at the start of the row below. */
17016 else if (row
->ends_at_zv_p
)
17022 return cursor_row_p
;
17027 /* Push the display property PROP so that it will be rendered at the
17028 current position in IT. Return 1 if PROP was successfully pushed,
17032 push_display_prop (struct it
*it
, Lisp_Object prop
)
17036 if (STRINGP (prop
))
17038 if (SCHARS (prop
) == 0)
17045 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17046 it
->current
.overlay_string_index
= -1;
17047 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17048 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17049 it
->method
= GET_FROM_STRING
;
17050 it
->stop_charpos
= 0;
17052 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17054 it
->method
= GET_FROM_STRETCH
;
17057 #ifdef HAVE_WINDOW_SYSTEM
17058 else if (IMAGEP (prop
))
17060 it
->what
= IT_IMAGE
;
17061 it
->image_id
= lookup_image (it
->f
, prop
);
17062 it
->method
= GET_FROM_IMAGE
;
17064 #endif /* HAVE_WINDOW_SYSTEM */
17067 pop_it (it
); /* bogus display property, give up */
17074 /* Return the character-property PROP at the current position in IT. */
17077 get_it_property (it
, prop
)
17081 Lisp_Object position
;
17083 if (STRINGP (it
->object
))
17084 position
= make_number (IT_STRING_CHARPOS (*it
));
17085 else if (BUFFERP (it
->object
))
17086 position
= make_number (IT_CHARPOS (*it
));
17090 return Fget_char_property (position
, prop
, it
->object
);
17093 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17096 handle_line_prefix (struct it
*it
)
17098 Lisp_Object prefix
;
17099 if (it
->continuation_lines_width
> 0)
17101 prefix
= get_it_property (it
, Qwrap_prefix
);
17103 prefix
= Vwrap_prefix
;
17107 prefix
= get_it_property (it
, Qline_prefix
);
17109 prefix
= Vline_prefix
;
17111 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17113 /* If the prefix is wider than the window, and we try to wrap
17114 it, it would acquire its own wrap prefix, and so on till the
17115 iterator stack overflows. So, don't wrap the prefix. */
17116 it
->line_wrap
= TRUNCATE
;
17117 it
->avoid_cursor_p
= 1;
17123 /* Construct the glyph row IT->glyph_row in the desired matrix of
17124 IT->w from text at the current position of IT. See dispextern.h
17125 for an overview of struct it. Value is non-zero if
17126 IT->glyph_row displays text, as opposed to a line displaying ZV
17133 struct glyph_row
*row
= it
->glyph_row
;
17134 Lisp_Object overlay_arrow_string
;
17136 int may_wrap
= 0, wrap_x
;
17137 int wrap_row_used
= -1, wrap_row_ascent
, wrap_row_height
;
17138 int wrap_row_phys_ascent
, wrap_row_phys_height
;
17139 int wrap_row_extra_line_spacing
;
17140 struct display_pos row_end
;
17143 /* We always start displaying at hpos zero even if hscrolled. */
17144 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17146 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17147 >= it
->w
->desired_matrix
->nrows
)
17149 it
->w
->nrows_scale_factor
++;
17150 fonts_changed_p
= 1;
17154 /* Is IT->w showing the region? */
17155 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17157 /* Clear the result glyph row and enable it. */
17158 prepare_desired_row (row
);
17160 row
->y
= it
->current_y
;
17161 row
->start
= it
->start
;
17162 row
->continuation_lines_width
= it
->continuation_lines_width
;
17163 row
->displays_text_p
= 1;
17164 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17165 it
->starts_in_middle_of_char_p
= 0;
17167 /* Arrange the overlays nicely for our purposes. Usually, we call
17168 display_line on only one line at a time, in which case this
17169 can't really hurt too much, or we call it on lines which appear
17170 one after another in the buffer, in which case all calls to
17171 recenter_overlay_lists but the first will be pretty cheap. */
17172 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17174 /* Move over display elements that are not visible because we are
17175 hscrolled. This may stop at an x-position < IT->first_visible_x
17176 if the first glyph is partially visible or if we hit a line end. */
17177 if (it
->current_x
< it
->first_visible_x
)
17179 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17180 MOVE_TO_POS
| MOVE_TO_X
);
17184 /* We only do this when not calling `move_it_in_display_line_to'
17185 above, because move_it_in_display_line_to calls
17186 handle_line_prefix itself. */
17187 handle_line_prefix (it
);
17190 /* Get the initial row height. This is either the height of the
17191 text hscrolled, if there is any, or zero. */
17192 row
->ascent
= it
->max_ascent
;
17193 row
->height
= it
->max_ascent
+ it
->max_descent
;
17194 row
->phys_ascent
= it
->max_phys_ascent
;
17195 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17196 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17198 /* Loop generating characters. The loop is left with IT on the next
17199 character to display. */
17202 int n_glyphs_before
, hpos_before
, x_before
;
17204 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17206 /* Retrieve the next thing to display. Value is zero if end of
17208 if (!get_next_display_element (it
))
17210 /* Maybe add a space at the end of this line that is used to
17211 display the cursor there under X. Set the charpos of the
17212 first glyph of blank lines not corresponding to any text
17214 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17215 row
->exact_window_width_line_p
= 1;
17216 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17217 || row
->used
[TEXT_AREA
] == 0)
17219 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17220 row
->displays_text_p
= 0;
17222 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
17223 && (!MINI_WINDOW_P (it
->w
)
17224 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17225 row
->indicate_empty_line_p
= 1;
17228 it
->continuation_lines_width
= 0;
17229 row
->ends_at_zv_p
= 1;
17230 /* A row that displays right-to-left text must always have
17231 its last face extended all the way to the end of line,
17232 even if this row ends in ZV. */
17233 if (row
->reversed_p
)
17234 extend_face_to_end_of_line (it
);
17238 /* Now, get the metrics of what we want to display. This also
17239 generates glyphs in `row' (which is IT->glyph_row). */
17240 n_glyphs_before
= row
->used
[TEXT_AREA
];
17243 /* Remember the line height so far in case the next element doesn't
17244 fit on the line. */
17245 if (it
->line_wrap
!= TRUNCATE
)
17247 ascent
= it
->max_ascent
;
17248 descent
= it
->max_descent
;
17249 phys_ascent
= it
->max_phys_ascent
;
17250 phys_descent
= it
->max_phys_descent
;
17252 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17254 if (IT_DISPLAYING_WHITESPACE (it
))
17260 wrap_row_used
= row
->used
[TEXT_AREA
];
17261 wrap_row_ascent
= row
->ascent
;
17262 wrap_row_height
= row
->height
;
17263 wrap_row_phys_ascent
= row
->phys_ascent
;
17264 wrap_row_phys_height
= row
->phys_height
;
17265 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17271 PRODUCE_GLYPHS (it
);
17273 /* If this display element was in marginal areas, continue with
17275 if (it
->area
!= TEXT_AREA
)
17277 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17278 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17279 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17280 row
->phys_height
= max (row
->phys_height
,
17281 it
->max_phys_ascent
+ it
->max_phys_descent
);
17282 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17283 it
->max_extra_line_spacing
);
17284 set_iterator_to_next (it
, 1);
17288 /* Does the display element fit on the line? If we truncate
17289 lines, we should draw past the right edge of the window. If
17290 we don't truncate, we want to stop so that we can display the
17291 continuation glyph before the right margin. If lines are
17292 continued, there are two possible strategies for characters
17293 resulting in more than 1 glyph (e.g. tabs): Display as many
17294 glyphs as possible in this line and leave the rest for the
17295 continuation line, or display the whole element in the next
17296 line. Original redisplay did the former, so we do it also. */
17297 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17298 hpos_before
= it
->hpos
;
17301 if (/* Not a newline. */
17303 /* Glyphs produced fit entirely in the line. */
17304 && it
->current_x
< it
->last_visible_x
)
17306 it
->hpos
+= nglyphs
;
17307 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17308 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17309 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17310 row
->phys_height
= max (row
->phys_height
,
17311 it
->max_phys_ascent
+ it
->max_phys_descent
);
17312 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17313 it
->max_extra_line_spacing
);
17314 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17315 row
->x
= x
- it
->first_visible_x
;
17320 struct glyph
*glyph
;
17322 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17324 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17325 new_x
= x
+ glyph
->pixel_width
;
17327 if (/* Lines are continued. */
17328 it
->line_wrap
!= TRUNCATE
17329 && (/* Glyph doesn't fit on the line. */
17330 new_x
> it
->last_visible_x
17331 /* Or it fits exactly on a window system frame. */
17332 || (new_x
== it
->last_visible_x
17333 && FRAME_WINDOW_P (it
->f
))))
17335 /* End of a continued line. */
17338 || (new_x
== it
->last_visible_x
17339 && FRAME_WINDOW_P (it
->f
)))
17341 /* Current glyph is the only one on the line or
17342 fits exactly on the line. We must continue
17343 the line because we can't draw the cursor
17344 after the glyph. */
17345 row
->continued_p
= 1;
17346 it
->current_x
= new_x
;
17347 it
->continuation_lines_width
+= new_x
;
17349 if (i
== nglyphs
- 1)
17351 /* If line-wrap is on, check if a previous
17352 wrap point was found. */
17353 if (wrap_row_used
> 0
17354 /* Even if there is a previous wrap
17355 point, continue the line here as
17356 usual, if (i) the previous character
17357 was a space or tab AND (ii) the
17358 current character is not. */
17360 || IT_DISPLAYING_WHITESPACE (it
)))
17363 set_iterator_to_next (it
, 1);
17364 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17366 if (!get_next_display_element (it
))
17368 row
->exact_window_width_line_p
= 1;
17369 it
->continuation_lines_width
= 0;
17370 row
->continued_p
= 0;
17371 row
->ends_at_zv_p
= 1;
17373 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17375 row
->continued_p
= 0;
17376 row
->exact_window_width_line_p
= 1;
17381 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17382 && !FRAME_WINDOW_P (it
->f
))
17384 /* A padding glyph that doesn't fit on this line.
17385 This means the whole character doesn't fit
17387 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17389 /* Fill the rest of the row with continuation
17390 glyphs like in 20.x. */
17391 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17392 < row
->glyphs
[1 + TEXT_AREA
])
17393 produce_special_glyphs (it
, IT_CONTINUATION
);
17395 row
->continued_p
= 1;
17396 it
->current_x
= x_before
;
17397 it
->continuation_lines_width
+= x_before
;
17399 /* Restore the height to what it was before the
17400 element not fitting on the line. */
17401 it
->max_ascent
= ascent
;
17402 it
->max_descent
= descent
;
17403 it
->max_phys_ascent
= phys_ascent
;
17404 it
->max_phys_descent
= phys_descent
;
17406 else if (wrap_row_used
> 0)
17410 it
->continuation_lines_width
+= wrap_x
;
17411 row
->used
[TEXT_AREA
] = wrap_row_used
;
17412 row
->ascent
= wrap_row_ascent
;
17413 row
->height
= wrap_row_height
;
17414 row
->phys_ascent
= wrap_row_phys_ascent
;
17415 row
->phys_height
= wrap_row_phys_height
;
17416 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17417 row
->continued_p
= 1;
17418 row
->ends_at_zv_p
= 0;
17419 row
->exact_window_width_line_p
= 0;
17420 it
->continuation_lines_width
+= x
;
17422 /* Make sure that a non-default face is extended
17423 up to the right margin of the window. */
17424 extend_face_to_end_of_line (it
);
17426 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17428 /* A TAB that extends past the right edge of the
17429 window. This produces a single glyph on
17430 window system frames. We leave the glyph in
17431 this row and let it fill the row, but don't
17432 consume the TAB. */
17433 it
->continuation_lines_width
+= it
->last_visible_x
;
17434 row
->ends_in_middle_of_char_p
= 1;
17435 row
->continued_p
= 1;
17436 glyph
->pixel_width
= it
->last_visible_x
- x
;
17437 it
->starts_in_middle_of_char_p
= 1;
17441 /* Something other than a TAB that draws past
17442 the right edge of the window. Restore
17443 positions to values before the element. */
17444 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17446 /* Display continuation glyphs. */
17447 if (!FRAME_WINDOW_P (it
->f
))
17448 produce_special_glyphs (it
, IT_CONTINUATION
);
17449 row
->continued_p
= 1;
17451 it
->current_x
= x_before
;
17452 it
->continuation_lines_width
+= x
;
17453 extend_face_to_end_of_line (it
);
17455 if (nglyphs
> 1 && i
> 0)
17457 row
->ends_in_middle_of_char_p
= 1;
17458 it
->starts_in_middle_of_char_p
= 1;
17461 /* Restore the height to what it was before the
17462 element not fitting on the line. */
17463 it
->max_ascent
= ascent
;
17464 it
->max_descent
= descent
;
17465 it
->max_phys_ascent
= phys_ascent
;
17466 it
->max_phys_descent
= phys_descent
;
17471 else if (new_x
> it
->first_visible_x
)
17473 /* Increment number of glyphs actually displayed. */
17476 if (x
< it
->first_visible_x
)
17477 /* Glyph is partially visible, i.e. row starts at
17478 negative X position. */
17479 row
->x
= x
- it
->first_visible_x
;
17483 /* Glyph is completely off the left margin of the
17484 window. This should not happen because of the
17485 move_it_in_display_line at the start of this
17486 function, unless the text display area of the
17487 window is empty. */
17488 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17492 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17493 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17494 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17495 row
->phys_height
= max (row
->phys_height
,
17496 it
->max_phys_ascent
+ it
->max_phys_descent
);
17497 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17498 it
->max_extra_line_spacing
);
17500 /* End of this display line if row is continued. */
17501 if (row
->continued_p
|| row
->ends_at_zv_p
)
17506 /* Is this a line end? If yes, we're also done, after making
17507 sure that a non-default face is extended up to the right
17508 margin of the window. */
17509 if (ITERATOR_AT_END_OF_LINE_P (it
))
17511 int used_before
= row
->used
[TEXT_AREA
];
17513 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17515 /* Add a space at the end of the line that is used to
17516 display the cursor there. */
17517 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17518 append_space_for_newline (it
, 0);
17520 /* Extend the face to the end of the line. */
17521 extend_face_to_end_of_line (it
);
17523 /* Make sure we have the position. */
17524 if (used_before
== 0)
17525 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17527 /* Consume the line end. This skips over invisible lines. */
17528 set_iterator_to_next (it
, 1);
17529 it
->continuation_lines_width
= 0;
17533 /* Proceed with next display element. Note that this skips
17534 over lines invisible because of selective display. */
17535 set_iterator_to_next (it
, 1);
17537 /* If we truncate lines, we are done when the last displayed
17538 glyphs reach past the right margin of the window. */
17539 if (it
->line_wrap
== TRUNCATE
17540 && (FRAME_WINDOW_P (it
->f
)
17541 ? (it
->current_x
>= it
->last_visible_x
)
17542 : (it
->current_x
> it
->last_visible_x
)))
17544 /* Maybe add truncation glyphs. */
17545 if (!FRAME_WINDOW_P (it
->f
))
17549 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17550 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17553 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17555 row
->used
[TEXT_AREA
] = i
;
17556 produce_special_glyphs (it
, IT_TRUNCATION
);
17559 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17561 /* Don't truncate if we can overflow newline into fringe. */
17562 if (!get_next_display_element (it
))
17564 it
->continuation_lines_width
= 0;
17565 row
->ends_at_zv_p
= 1;
17566 row
->exact_window_width_line_p
= 1;
17569 if (ITERATOR_AT_END_OF_LINE_P (it
))
17571 row
->exact_window_width_line_p
= 1;
17572 goto at_end_of_line
;
17576 row
->truncated_on_right_p
= 1;
17577 it
->continuation_lines_width
= 0;
17578 reseat_at_next_visible_line_start (it
, 0);
17579 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
17580 it
->hpos
= hpos_before
;
17581 it
->current_x
= x_before
;
17586 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17587 at the left window margin. */
17588 if (it
->first_visible_x
17589 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
17591 if (!FRAME_WINDOW_P (it
->f
))
17592 insert_left_trunc_glyphs (it
);
17593 row
->truncated_on_left_p
= 1;
17596 /* If the start of this line is the overlay arrow-position, then
17597 mark this glyph row as the one containing the overlay arrow.
17598 This is clearly a mess with variable size fonts. It would be
17599 better to let it be displayed like cursors under X. */
17600 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
17601 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
17602 !NILP (overlay_arrow_string
)))
17604 /* Overlay arrow in window redisplay is a fringe bitmap. */
17605 if (STRINGP (overlay_arrow_string
))
17607 struct glyph_row
*arrow_row
17608 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
17609 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
17610 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
17611 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
17612 struct glyph
*p2
, *end
;
17614 /* Copy the arrow glyphs. */
17615 while (glyph
< arrow_end
)
17618 /* Throw away padding glyphs. */
17620 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17621 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
17627 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
17632 xassert (INTEGERP (overlay_arrow_string
));
17633 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
17635 overlay_arrow_seen
= 1;
17638 /* Compute pixel dimensions of this line. */
17639 compute_line_metrics (it
);
17641 /* Remember the position at which this line ends. */
17642 row
->end
= row_end
= it
->current
;
17645 /* ROW->start and ROW->end must be the smallest and largest
17646 buffer positions in ROW. But if ROW was bidi-reordered,
17647 these two positions can be anywhere in the row, so we must
17648 rescan all of the ROW's glyphs to find them. */
17649 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17650 lines' rows is implemented for bidi-reordered rows. */
17651 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
17654 struct text_pos tpos
;
17656 for (g
= row
->glyphs
[TEXT_AREA
];
17657 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17660 if (BUFFERP (g
->object
))
17662 if (g
->charpos
> 0 && g
->charpos
< min_pos
)
17663 min_pos
= g
->charpos
;
17664 if (g
->charpos
> max_pos
)
17665 max_pos
= g
->charpos
;
17668 /* Empty lines have a valid buffer position at their first
17669 glyph, but that glyph's OBJECT is zero, as if it didn't come
17670 from a buffer. If we didn't find any valid buffer positions
17671 in this row, maybe we have such an empty line. */
17672 if (min_pos
== ZV
+ 1 && row
->used
[TEXT_AREA
])
17674 for (g
= row
->glyphs
[TEXT_AREA
];
17675 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17678 if (INTEGERP (g
->object
))
17680 if (g
->charpos
> 0 && g
->charpos
< min_pos
)
17681 min_pos
= g
->charpos
;
17682 if (g
->charpos
> max_pos
)
17683 max_pos
= g
->charpos
;
17689 if (min_pos
!= row
->start
.pos
.charpos
)
17691 row
->start
.pos
.charpos
= min_pos
;
17692 row
->start
.pos
.bytepos
= CHAR_TO_BYTE (min_pos
);
17697 /* For ROW->end, we need the position that is _after_ max_pos,
17698 in the logical order, unless we are at ZV. */
17699 if (row
->ends_at_zv_p
)
17701 row_end
= row
->end
= it
->current
;
17702 if (!row
->used
[TEXT_AREA
])
17704 row
->start
.pos
.charpos
= row_end
.pos
.charpos
;
17705 row
->start
.pos
.bytepos
= row_end
.pos
.bytepos
;
17708 else if (row
->used
[TEXT_AREA
] && max_pos
)
17710 SET_TEXT_POS (tpos
, max_pos
+ 1, CHAR_TO_BYTE (max_pos
+ 1));
17711 row_end
= it
->current
;
17712 row_end
.pos
= tpos
;
17713 /* If the character at max_pos+1 is a newline, skip that as
17714 well. Note that this may skip some invisible text. */
17715 if (FETCH_CHAR (tpos
.bytepos
) == '\n'
17716 || (FETCH_CHAR (tpos
.bytepos
) == '\r' && it
->selective
))
17720 reseat_1 (it
, tpos
, 0);
17721 set_iterator_to_next (it
, 1);
17722 /* Record the position after the newline of a continued
17723 row. We will need that to set ROW->end of the last
17724 row produced for a continued line. */
17725 if (row
->continued_p
)
17727 save_it
.eol_pos
.charpos
= IT_CHARPOS (*it
);
17728 save_it
.eol_pos
.bytepos
= IT_BYTEPOS (*it
);
17732 row_end
= it
->current
;
17733 save_it
.eol_pos
.charpos
= save_it
.eol_pos
.bytepos
= 0;
17737 else if (!row
->continued_p
17738 && row
->continuation_lines_width
17739 && it
->eol_pos
.charpos
> 0)
17741 /* Last row of a continued line. Use the position
17742 recorded in ROW->eol_pos, to the effect that the
17743 newline belongs to this row, not to the row which
17744 displays the character with the largest buffer
17746 row_end
.pos
= it
->eol_pos
;
17747 it
->eol_pos
.charpos
= it
->eol_pos
.bytepos
= 0;
17749 row
->end
= row_end
;
17753 /* Record whether this row ends inside an ellipsis. */
17754 row
->ends_in_ellipsis_p
17755 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17756 && it
->ellipsis_p
);
17758 /* Save fringe bitmaps in this row. */
17759 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17760 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17761 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17762 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17764 it
->left_user_fringe_bitmap
= 0;
17765 it
->left_user_fringe_face_id
= 0;
17766 it
->right_user_fringe_bitmap
= 0;
17767 it
->right_user_fringe_face_id
= 0;
17769 /* Maybe set the cursor. */
17770 cvpos
= it
->w
->cursor
.vpos
;
17772 /* In bidi-reordered rows, keep checking for proper cursor
17773 position even if one has been found already, because buffer
17774 positions in such rows change non-linearly with ROW->VPOS,
17775 when a line is continued. One exception: when we are at ZV,
17776 display cursor on the first suitable glyph row, since all
17777 the empty rows after that also have their position set to ZV. */
17778 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17779 lines' rows is implemented for bidi-reordered rows. */
17781 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
17782 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17783 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17784 && cursor_row_p (it
->w
, row
))
17785 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17787 /* Highlight trailing whitespace. */
17788 if (!NILP (Vshow_trailing_whitespace
))
17789 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17791 /* Prepare for the next line. This line starts horizontally at (X
17792 HPOS) = (0 0). Vertical positions are incremented. As a
17793 convenience for the caller, IT->glyph_row is set to the next
17795 it
->current_x
= it
->hpos
= 0;
17796 it
->current_y
+= row
->height
;
17799 /* The next row should use same value of the reversed_p flag as this
17800 one. set_iterator_to_next decides when it's a new paragraph, and
17801 PRODUCE_GLYPHS recomputes the value of the flag accordingly. */
17802 it
->glyph_row
->reversed_p
= row
->reversed_p
;
17803 it
->start
= row_end
;
17804 return row
->displays_text_p
;
17809 /***********************************************************************
17811 ***********************************************************************/
17813 /* Redisplay the menu bar in the frame for window W.
17815 The menu bar of X frames that don't have X toolkit support is
17816 displayed in a special window W->frame->menu_bar_window.
17818 The menu bar of terminal frames is treated specially as far as
17819 glyph matrices are concerned. Menu bar lines are not part of
17820 windows, so the update is done directly on the frame matrix rows
17821 for the menu bar. */
17824 display_menu_bar (w
)
17827 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17832 /* Don't do all this for graphical frames. */
17834 if (FRAME_W32_P (f
))
17837 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
17843 if (FRAME_NS_P (f
))
17845 #endif /* HAVE_NS */
17847 #ifdef USE_X_TOOLKIT
17848 xassert (!FRAME_WINDOW_P (f
));
17849 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
17850 it
.first_visible_x
= 0;
17851 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
17852 #else /* not USE_X_TOOLKIT */
17853 if (FRAME_WINDOW_P (f
))
17855 /* Menu bar lines are displayed in the desired matrix of the
17856 dummy window menu_bar_window. */
17857 struct window
*menu_w
;
17858 xassert (WINDOWP (f
->menu_bar_window
));
17859 menu_w
= XWINDOW (f
->menu_bar_window
);
17860 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
17862 it
.first_visible_x
= 0;
17863 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
17867 /* This is a TTY frame, i.e. character hpos/vpos are used as
17869 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
17871 it
.first_visible_x
= 0;
17872 it
.last_visible_x
= FRAME_COLS (f
);
17874 #endif /* not USE_X_TOOLKIT */
17876 if (! mode_line_inverse_video
)
17877 /* Force the menu-bar to be displayed in the default face. */
17878 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
17880 /* Clear all rows of the menu bar. */
17881 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
17883 struct glyph_row
*row
= it
.glyph_row
+ i
;
17884 clear_glyph_row (row
);
17885 row
->enabled_p
= 1;
17886 row
->full_width_p
= 1;
17889 /* Display all items of the menu bar. */
17890 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
17891 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
17893 Lisp_Object string
;
17895 /* Stop at nil string. */
17896 string
= AREF (items
, i
+ 1);
17900 /* Remember where item was displayed. */
17901 ASET (items
, i
+ 3, make_number (it
.hpos
));
17903 /* Display the item, pad with one space. */
17904 if (it
.current_x
< it
.last_visible_x
)
17905 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
17906 SCHARS (string
) + 1, 0, 0, -1);
17909 /* Fill out the line with spaces. */
17910 if (it
.current_x
< it
.last_visible_x
)
17911 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
17913 /* Compute the total height of the lines. */
17914 compute_line_metrics (&it
);
17919 /***********************************************************************
17921 ***********************************************************************/
17923 /* Redisplay mode lines in the window tree whose root is WINDOW. If
17924 FORCE is non-zero, redisplay mode lines unconditionally.
17925 Otherwise, redisplay only mode lines that are garbaged. Value is
17926 the number of windows whose mode lines were redisplayed. */
17929 redisplay_mode_lines (window
, force
)
17930 Lisp_Object window
;
17935 while (!NILP (window
))
17937 struct window
*w
= XWINDOW (window
);
17939 if (WINDOWP (w
->hchild
))
17940 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
17941 else if (WINDOWP (w
->vchild
))
17942 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
17944 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
17945 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
17947 struct text_pos lpoint
;
17948 struct buffer
*old
= current_buffer
;
17950 /* Set the window's buffer for the mode line display. */
17951 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
17952 set_buffer_internal_1 (XBUFFER (w
->buffer
));
17954 /* Point refers normally to the selected window. For any
17955 other window, set up appropriate value. */
17956 if (!EQ (window
, selected_window
))
17958 struct text_pos pt
;
17960 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
17961 if (CHARPOS (pt
) < BEGV
)
17962 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
17963 else if (CHARPOS (pt
) > (ZV
- 1))
17964 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
17966 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
17969 /* Display mode lines. */
17970 clear_glyph_matrix (w
->desired_matrix
);
17971 if (display_mode_lines (w
))
17974 w
->must_be_updated_p
= 1;
17977 /* Restore old settings. */
17978 set_buffer_internal_1 (old
);
17979 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
17989 /* Display the mode and/or header line of window W. Value is the
17990 sum number of mode lines and header lines displayed. */
17993 display_mode_lines (w
)
17996 Lisp_Object old_selected_window
, old_selected_frame
;
17999 old_selected_frame
= selected_frame
;
18000 selected_frame
= w
->frame
;
18001 old_selected_window
= selected_window
;
18002 XSETWINDOW (selected_window
, w
);
18004 /* These will be set while the mode line specs are processed. */
18005 line_number_displayed
= 0;
18006 w
->column_number_displayed
= Qnil
;
18008 if (WINDOW_WANTS_MODELINE_P (w
))
18010 struct window
*sel_w
= XWINDOW (old_selected_window
);
18012 /* Select mode line face based on the real selected window. */
18013 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18014 current_buffer
->mode_line_format
);
18018 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18020 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18021 current_buffer
->header_line_format
);
18025 selected_frame
= old_selected_frame
;
18026 selected_window
= old_selected_window
;
18031 /* Display mode or header line of window W. FACE_ID specifies which
18032 line to display; it is either MODE_LINE_FACE_ID or
18033 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18034 display. Value is the pixel height of the mode/header line
18038 display_mode_line (w
, face_id
, format
)
18040 enum face_id face_id
;
18041 Lisp_Object format
;
18045 int count
= SPECPDL_INDEX ();
18047 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18048 /* Don't extend on a previously drawn mode-line.
18049 This may happen if called from pos_visible_p. */
18050 it
.glyph_row
->enabled_p
= 0;
18051 prepare_desired_row (it
.glyph_row
);
18053 it
.glyph_row
->mode_line_p
= 1;
18055 if (! mode_line_inverse_video
)
18056 /* Force the mode-line to be displayed in the default face. */
18057 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18059 record_unwind_protect (unwind_format_mode_line
,
18060 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18062 mode_line_target
= MODE_LINE_DISPLAY
;
18064 /* Temporarily make frame's keyboard the current kboard so that
18065 kboard-local variables in the mode_line_format will get the right
18067 push_kboard (FRAME_KBOARD (it
.f
));
18068 record_unwind_save_match_data ();
18069 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18072 unbind_to (count
, Qnil
);
18074 /* Fill up with spaces. */
18075 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18077 compute_line_metrics (&it
);
18078 it
.glyph_row
->full_width_p
= 1;
18079 it
.glyph_row
->continued_p
= 0;
18080 it
.glyph_row
->truncated_on_left_p
= 0;
18081 it
.glyph_row
->truncated_on_right_p
= 0;
18083 /* Make a 3D mode-line have a shadow at its right end. */
18084 face
= FACE_FROM_ID (it
.f
, face_id
);
18085 extend_face_to_end_of_line (&it
);
18086 if (face
->box
!= FACE_NO_BOX
)
18088 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18089 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18090 last
->right_box_line_p
= 1;
18093 return it
.glyph_row
->height
;
18096 /* Move element ELT in LIST to the front of LIST.
18097 Return the updated list. */
18100 move_elt_to_front (elt
, list
)
18101 Lisp_Object elt
, list
;
18103 register Lisp_Object tail
, prev
;
18104 register Lisp_Object tem
;
18108 while (CONSP (tail
))
18114 /* Splice out the link TAIL. */
18116 list
= XCDR (tail
);
18118 Fsetcdr (prev
, XCDR (tail
));
18120 /* Now make it the first. */
18121 Fsetcdr (tail
, list
);
18126 tail
= XCDR (tail
);
18130 /* Not found--return unchanged LIST. */
18134 /* Contribute ELT to the mode line for window IT->w. How it
18135 translates into text depends on its data type.
18137 IT describes the display environment in which we display, as usual.
18139 DEPTH is the depth in recursion. It is used to prevent
18140 infinite recursion here.
18142 FIELD_WIDTH is the number of characters the display of ELT should
18143 occupy in the mode line, and PRECISION is the maximum number of
18144 characters to display from ELT's representation. See
18145 display_string for details.
18147 Returns the hpos of the end of the text generated by ELT.
18149 PROPS is a property list to add to any string we encounter.
18151 If RISKY is nonzero, remove (disregard) any properties in any string
18152 we encounter, and ignore :eval and :propertize.
18154 The global variable `mode_line_target' determines whether the
18155 output is passed to `store_mode_line_noprop',
18156 `store_mode_line_string', or `display_string'. */
18159 display_mode_element (it
, depth
, field_width
, precision
, elt
, props
, risky
)
18162 int field_width
, precision
;
18163 Lisp_Object elt
, props
;
18166 int n
= 0, field
, prec
;
18171 elt
= build_string ("*too-deep*");
18175 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18179 /* A string: output it and check for %-constructs within it. */
18183 if (SCHARS (elt
) > 0
18184 && (!NILP (props
) || risky
))
18186 Lisp_Object oprops
, aelt
;
18187 oprops
= Ftext_properties_at (make_number (0), elt
);
18189 /* If the starting string's properties are not what
18190 we want, translate the string. Also, if the string
18191 is risky, do that anyway. */
18193 if (NILP (Fequal (props
, oprops
)) || risky
)
18195 /* If the starting string has properties,
18196 merge the specified ones onto the existing ones. */
18197 if (! NILP (oprops
) && !risky
)
18201 oprops
= Fcopy_sequence (oprops
);
18203 while (CONSP (tem
))
18205 oprops
= Fplist_put (oprops
, XCAR (tem
),
18206 XCAR (XCDR (tem
)));
18207 tem
= XCDR (XCDR (tem
));
18212 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18213 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18215 /* AELT is what we want. Move it to the front
18216 without consing. */
18218 mode_line_proptrans_alist
18219 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18225 /* If AELT has the wrong props, it is useless.
18226 so get rid of it. */
18228 mode_line_proptrans_alist
18229 = Fdelq (aelt
, mode_line_proptrans_alist
);
18231 elt
= Fcopy_sequence (elt
);
18232 Fset_text_properties (make_number (0), Flength (elt
),
18234 /* Add this item to mode_line_proptrans_alist. */
18235 mode_line_proptrans_alist
18236 = Fcons (Fcons (elt
, props
),
18237 mode_line_proptrans_alist
);
18238 /* Truncate mode_line_proptrans_alist
18239 to at most 50 elements. */
18240 tem
= Fnthcdr (make_number (50),
18241 mode_line_proptrans_alist
);
18243 XSETCDR (tem
, Qnil
);
18252 prec
= precision
- n
;
18253 switch (mode_line_target
)
18255 case MODE_LINE_NOPROP
:
18256 case MODE_LINE_TITLE
:
18257 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
18259 case MODE_LINE_STRING
:
18260 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18262 case MODE_LINE_DISPLAY
:
18263 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18264 0, prec
, 0, STRING_MULTIBYTE (elt
));
18271 /* Handle the non-literal case. */
18273 while ((precision
<= 0 || n
< precision
)
18274 && SREF (elt
, offset
) != 0
18275 && (mode_line_target
!= MODE_LINE_DISPLAY
18276 || it
->current_x
< it
->last_visible_x
))
18278 int last_offset
= offset
;
18280 /* Advance to end of string or next format specifier. */
18281 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18284 if (offset
- 1 != last_offset
)
18286 int nchars
, nbytes
;
18288 /* Output to end of string or up to '%'. Field width
18289 is length of string. Don't output more than
18290 PRECISION allows us. */
18293 prec
= c_string_width (SDATA (elt
) + last_offset
,
18294 offset
- last_offset
, precision
- n
,
18297 switch (mode_line_target
)
18299 case MODE_LINE_NOPROP
:
18300 case MODE_LINE_TITLE
:
18301 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
18303 case MODE_LINE_STRING
:
18305 int bytepos
= last_offset
;
18306 int charpos
= string_byte_to_char (elt
, bytepos
);
18307 int endpos
= (precision
<= 0
18308 ? string_byte_to_char (elt
, offset
)
18309 : charpos
+ nchars
);
18311 n
+= store_mode_line_string (NULL
,
18312 Fsubstring (elt
, make_number (charpos
),
18313 make_number (endpos
)),
18317 case MODE_LINE_DISPLAY
:
18319 int bytepos
= last_offset
;
18320 int charpos
= string_byte_to_char (elt
, bytepos
);
18322 if (precision
<= 0)
18323 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18324 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18326 STRING_MULTIBYTE (elt
));
18331 else /* c == '%' */
18333 int percent_position
= offset
;
18335 /* Get the specified minimum width. Zero means
18338 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18339 field
= field
* 10 + c
- '0';
18341 /* Don't pad beyond the total padding allowed. */
18342 if (field_width
- n
> 0 && field
> field_width
- n
)
18343 field
= field_width
- n
;
18345 /* Note that either PRECISION <= 0 or N < PRECISION. */
18346 prec
= precision
- n
;
18349 n
+= display_mode_element (it
, depth
, field
, prec
,
18350 Vglobal_mode_string
, props
,
18355 int bytepos
, charpos
;
18356 unsigned char *spec
;
18357 Lisp_Object string
;
18359 bytepos
= percent_position
;
18360 charpos
= (STRING_MULTIBYTE (elt
)
18361 ? string_byte_to_char (elt
, bytepos
)
18363 spec
= decode_mode_spec (it
->w
, c
, field
, prec
, &string
);
18364 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18366 switch (mode_line_target
)
18368 case MODE_LINE_NOPROP
:
18369 case MODE_LINE_TITLE
:
18370 n
+= store_mode_line_noprop (spec
, field
, prec
);
18372 case MODE_LINE_STRING
:
18374 int len
= strlen (spec
);
18375 Lisp_Object tem
= make_string (spec
, len
);
18376 props
= Ftext_properties_at (make_number (charpos
), elt
);
18377 /* Should only keep face property in props */
18378 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18381 case MODE_LINE_DISPLAY
:
18383 int nglyphs_before
, nwritten
;
18385 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18386 nwritten
= display_string (spec
, string
, elt
,
18391 /* Assign to the glyphs written above the
18392 string where the `%x' came from, position
18396 struct glyph
*glyph
18397 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18401 for (i
= 0; i
< nwritten
; ++i
)
18403 glyph
[i
].object
= elt
;
18404 glyph
[i
].charpos
= charpos
;
18421 /* A symbol: process the value of the symbol recursively
18422 as if it appeared here directly. Avoid error if symbol void.
18423 Special case: if value of symbol is a string, output the string
18426 register Lisp_Object tem
;
18428 /* If the variable is not marked as risky to set
18429 then its contents are risky to use. */
18430 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18433 tem
= Fboundp (elt
);
18436 tem
= Fsymbol_value (elt
);
18437 /* If value is a string, output that string literally:
18438 don't check for % within it. */
18442 if (!EQ (tem
, elt
))
18444 /* Give up right away for nil or t. */
18454 register Lisp_Object car
, tem
;
18456 /* A cons cell: five distinct cases.
18457 If first element is :eval or :propertize, do something special.
18458 If first element is a string or a cons, process all the elements
18459 and effectively concatenate them.
18460 If first element is a negative number, truncate displaying cdr to
18461 at most that many characters. If positive, pad (with spaces)
18462 to at least that many characters.
18463 If first element is a symbol, process the cadr or caddr recursively
18464 according to whether the symbol's value is non-nil or nil. */
18466 if (EQ (car
, QCeval
))
18468 /* An element of the form (:eval FORM) means evaluate FORM
18469 and use the result as mode line elements. */
18474 if (CONSP (XCDR (elt
)))
18477 spec
= safe_eval (XCAR (XCDR (elt
)));
18478 n
+= display_mode_element (it
, depth
, field_width
- n
,
18479 precision
- n
, spec
, props
,
18483 else if (EQ (car
, QCpropertize
))
18485 /* An element of the form (:propertize ELT PROPS...)
18486 means display ELT but applying properties PROPS. */
18491 if (CONSP (XCDR (elt
)))
18492 n
+= display_mode_element (it
, depth
, field_width
- n
,
18493 precision
- n
, XCAR (XCDR (elt
)),
18494 XCDR (XCDR (elt
)), risky
);
18496 else if (SYMBOLP (car
))
18498 tem
= Fboundp (car
);
18502 /* elt is now the cdr, and we know it is a cons cell.
18503 Use its car if CAR has a non-nil value. */
18506 tem
= Fsymbol_value (car
);
18513 /* Symbol's value is nil (or symbol is unbound)
18514 Get the cddr of the original list
18515 and if possible find the caddr and use that. */
18519 else if (!CONSP (elt
))
18524 else if (INTEGERP (car
))
18526 register int lim
= XINT (car
);
18530 /* Negative int means reduce maximum width. */
18531 if (precision
<= 0)
18534 precision
= min (precision
, -lim
);
18538 /* Padding specified. Don't let it be more than
18539 current maximum. */
18541 lim
= min (precision
, lim
);
18543 /* If that's more padding than already wanted, queue it.
18544 But don't reduce padding already specified even if
18545 that is beyond the current truncation point. */
18546 field_width
= max (lim
, field_width
);
18550 else if (STRINGP (car
) || CONSP (car
))
18552 Lisp_Object halftail
= elt
;
18556 && (precision
<= 0 || n
< precision
))
18558 n
+= display_mode_element (it
, depth
,
18559 /* Do padding only after the last
18560 element in the list. */
18561 (! CONSP (XCDR (elt
))
18564 precision
- n
, XCAR (elt
),
18568 if ((len
& 1) == 0)
18569 halftail
= XCDR (halftail
);
18570 /* Check for cycle. */
18571 if (EQ (halftail
, elt
))
18580 elt
= build_string ("*invalid*");
18584 /* Pad to FIELD_WIDTH. */
18585 if (field_width
> 0 && n
< field_width
)
18587 switch (mode_line_target
)
18589 case MODE_LINE_NOPROP
:
18590 case MODE_LINE_TITLE
:
18591 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18593 case MODE_LINE_STRING
:
18594 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18596 case MODE_LINE_DISPLAY
:
18597 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18606 /* Store a mode-line string element in mode_line_string_list.
18608 If STRING is non-null, display that C string. Otherwise, the Lisp
18609 string LISP_STRING is displayed.
18611 FIELD_WIDTH is the minimum number of output glyphs to produce.
18612 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18613 with spaces. FIELD_WIDTH <= 0 means don't pad.
18615 PRECISION is the maximum number of characters to output from
18616 STRING. PRECISION <= 0 means don't truncate the string.
18618 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18619 properties to the string.
18621 PROPS are the properties to add to the string.
18622 The mode_line_string_face face property is always added to the string.
18626 store_mode_line_string (string
, lisp_string
, copy_string
, field_width
, precision
, props
)
18628 Lisp_Object lisp_string
;
18637 if (string
!= NULL
)
18639 len
= strlen (string
);
18640 if (precision
> 0 && len
> precision
)
18642 lisp_string
= make_string (string
, len
);
18644 props
= mode_line_string_face_prop
;
18645 else if (!NILP (mode_line_string_face
))
18647 Lisp_Object face
= Fplist_get (props
, Qface
);
18648 props
= Fcopy_sequence (props
);
18650 face
= mode_line_string_face
;
18652 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18653 props
= Fplist_put (props
, Qface
, face
);
18655 Fadd_text_properties (make_number (0), make_number (len
),
18656 props
, lisp_string
);
18660 len
= XFASTINT (Flength (lisp_string
));
18661 if (precision
> 0 && len
> precision
)
18664 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
18667 if (!NILP (mode_line_string_face
))
18671 props
= Ftext_properties_at (make_number (0), lisp_string
);
18672 face
= Fplist_get (props
, Qface
);
18674 face
= mode_line_string_face
;
18676 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18677 props
= Fcons (Qface
, Fcons (face
, Qnil
));
18679 lisp_string
= Fcopy_sequence (lisp_string
);
18682 Fadd_text_properties (make_number (0), make_number (len
),
18683 props
, lisp_string
);
18688 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18692 if (field_width
> len
)
18694 field_width
-= len
;
18695 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
18697 Fadd_text_properties (make_number (0), make_number (field_width
),
18698 props
, lisp_string
);
18699 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18707 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
18709 doc
: /* Format a string out of a mode line format specification.
18710 First arg FORMAT specifies the mode line format (see `mode-line-format'
18711 for details) to use.
18713 Optional second arg FACE specifies the face property to put
18714 on all characters for which no face is specified.
18715 The value t means whatever face the window's mode line currently uses
18716 \(either `mode-line' or `mode-line-inactive', depending).
18717 A value of nil means the default is no face property.
18718 If FACE is an integer, the value string has no text properties.
18720 Optional third and fourth args WINDOW and BUFFER specify the window
18721 and buffer to use as the context for the formatting (defaults
18722 are the selected window and the window's buffer). */)
18723 (format
, face
, window
, buffer
)
18724 Lisp_Object format
, face
, window
, buffer
;
18729 struct buffer
*old_buffer
= NULL
;
18731 int no_props
= INTEGERP (face
);
18732 int count
= SPECPDL_INDEX ();
18734 int string_start
= 0;
18737 window
= selected_window
;
18738 CHECK_WINDOW (window
);
18739 w
= XWINDOW (window
);
18742 buffer
= w
->buffer
;
18743 CHECK_BUFFER (buffer
);
18745 /* Make formatting the modeline a non-op when noninteractive, otherwise
18746 there will be problems later caused by a partially initialized frame. */
18747 if (NILP (format
) || noninteractive
)
18748 return empty_unibyte_string
;
18756 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
18757 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0);
18761 face_id
= DEFAULT_FACE_ID
;
18763 if (XBUFFER (buffer
) != current_buffer
)
18764 old_buffer
= current_buffer
;
18766 /* Save things including mode_line_proptrans_alist,
18767 and set that to nil so that we don't alter the outer value. */
18768 record_unwind_protect (unwind_format_mode_line
,
18769 format_mode_line_unwind_data
18770 (old_buffer
, selected_window
, 1));
18771 mode_line_proptrans_alist
= Qnil
;
18773 Fselect_window (window
, Qt
);
18775 set_buffer_internal_1 (XBUFFER (buffer
));
18777 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18781 mode_line_target
= MODE_LINE_NOPROP
;
18782 mode_line_string_face_prop
= Qnil
;
18783 mode_line_string_list
= Qnil
;
18784 string_start
= MODE_LINE_NOPROP_LEN (0);
18788 mode_line_target
= MODE_LINE_STRING
;
18789 mode_line_string_list
= Qnil
;
18790 mode_line_string_face
= face
;
18791 mode_line_string_face_prop
18792 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
18795 push_kboard (FRAME_KBOARD (it
.f
));
18796 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18801 len
= MODE_LINE_NOPROP_LEN (string_start
);
18802 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
18806 mode_line_string_list
= Fnreverse (mode_line_string_list
);
18807 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
18808 empty_unibyte_string
);
18811 unbind_to (count
, Qnil
);
18815 /* Write a null-terminated, right justified decimal representation of
18816 the positive integer D to BUF using a minimal field width WIDTH. */
18819 pint2str (buf
, width
, d
)
18820 register char *buf
;
18821 register int width
;
18824 register char *p
= buf
;
18832 *p
++ = d
% 10 + '0';
18837 for (width
-= (int) (p
- buf
); width
> 0; --width
)
18848 /* Write a null-terminated, right justified decimal and "human
18849 readable" representation of the nonnegative integer D to BUF using
18850 a minimal field width WIDTH. D should be smaller than 999.5e24. */
18852 static const char power_letter
[] =
18866 pint2hrstr (buf
, width
, d
)
18871 /* We aim to represent the nonnegative integer D as
18872 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
18875 /* -1 means: do not use TENTHS. */
18879 /* Length of QUOTIENT.TENTHS as a string. */
18885 if (1000 <= quotient
)
18887 /* Scale to the appropriate EXPONENT. */
18890 remainder
= quotient
% 1000;
18894 while (1000 <= quotient
);
18896 /* Round to nearest and decide whether to use TENTHS or not. */
18899 tenths
= remainder
/ 100;
18900 if (50 <= remainder
% 100)
18907 if (quotient
== 10)
18915 if (500 <= remainder
)
18917 if (quotient
< 999)
18928 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
18929 if (tenths
== -1 && quotient
<= 99)
18936 p
= psuffix
= buf
+ max (width
, length
);
18938 /* Print EXPONENT. */
18940 *psuffix
++ = power_letter
[exponent
];
18943 /* Print TENTHS. */
18946 *--p
= '0' + tenths
;
18950 /* Print QUOTIENT. */
18953 int digit
= quotient
% 10;
18954 *--p
= '0' + digit
;
18956 while ((quotient
/= 10) != 0);
18958 /* Print leading spaces. */
18963 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
18964 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
18965 type of CODING_SYSTEM. Return updated pointer into BUF. */
18967 static unsigned char invalid_eol_type
[] = "(*invalid*)";
18970 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
18971 Lisp_Object coding_system
;
18972 register char *buf
;
18976 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
18977 const unsigned char *eol_str
;
18979 /* The EOL conversion we are using. */
18980 Lisp_Object eoltype
;
18982 val
= CODING_SYSTEM_SPEC (coding_system
);
18985 if (!VECTORP (val
)) /* Not yet decided. */
18990 eoltype
= eol_mnemonic_undecided
;
18991 /* Don't mention EOL conversion if it isn't decided. */
18996 Lisp_Object eolvalue
;
18998 attrs
= AREF (val
, 0);
18999 eolvalue
= AREF (val
, 2);
19002 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19006 /* The EOL conversion that is normal on this system. */
19008 if (NILP (eolvalue
)) /* Not yet decided. */
19009 eoltype
= eol_mnemonic_undecided
;
19010 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19011 eoltype
= eol_mnemonic_undecided
;
19012 else /* eolvalue is Qunix, Qdos, or Qmac. */
19013 eoltype
= (EQ (eolvalue
, Qunix
)
19014 ? eol_mnemonic_unix
19015 : (EQ (eolvalue
, Qdos
) == 1
19016 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19022 /* Mention the EOL conversion if it is not the usual one. */
19023 if (STRINGP (eoltype
))
19025 eol_str
= SDATA (eoltype
);
19026 eol_str_len
= SBYTES (eoltype
);
19028 else if (CHARACTERP (eoltype
))
19030 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19031 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
19036 eol_str
= invalid_eol_type
;
19037 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19039 bcopy (eol_str
, buf
, eol_str_len
);
19040 buf
+= eol_str_len
;
19046 /* Return a string for the output of a mode line %-spec for window W,
19047 generated by character C. PRECISION >= 0 means don't return a
19048 string longer than that value. FIELD_WIDTH > 0 means pad the
19049 string returned with spaces to that value. Return a Lisp string in
19050 *STRING if the resulting string is taken from that Lisp string.
19052 Note we operate on the current buffer for most purposes,
19053 the exception being w->base_line_pos. */
19055 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19058 decode_mode_spec (w
, c
, field_width
, precision
, string
)
19061 int field_width
, precision
;
19062 Lisp_Object
*string
;
19065 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19066 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19067 struct buffer
*b
= current_buffer
;
19075 if (!NILP (b
->read_only
))
19077 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19082 /* This differs from %* only for a modified read-only buffer. */
19083 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19085 if (!NILP (b
->read_only
))
19090 /* This differs from %* in ignoring read-only-ness. */
19091 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19103 if (command_loop_level
> 5)
19105 p
= decode_mode_spec_buf
;
19106 for (i
= 0; i
< command_loop_level
; i
++)
19109 return decode_mode_spec_buf
;
19117 if (command_loop_level
> 5)
19119 p
= decode_mode_spec_buf
;
19120 for (i
= 0; i
< command_loop_level
; i
++)
19123 return decode_mode_spec_buf
;
19130 /* Let lots_of_dashes be a string of infinite length. */
19131 if (mode_line_target
== MODE_LINE_NOPROP
||
19132 mode_line_target
== MODE_LINE_STRING
)
19134 if (field_width
<= 0
19135 || field_width
> sizeof (lots_of_dashes
))
19137 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19138 decode_mode_spec_buf
[i
] = '-';
19139 decode_mode_spec_buf
[i
] = '\0';
19140 return decode_mode_spec_buf
;
19143 return lots_of_dashes
;
19151 /* %c and %l are ignored in `frame-title-format'.
19152 (In redisplay_internal, the frame title is drawn _before_ the
19153 windows are updated, so the stuff which depends on actual
19154 window contents (such as %l) may fail to render properly, or
19155 even crash emacs.) */
19156 if (mode_line_target
== MODE_LINE_TITLE
)
19160 int col
= (int) current_column (); /* iftc */
19161 w
->column_number_displayed
= make_number (col
);
19162 pint2str (decode_mode_spec_buf
, field_width
, col
);
19163 return decode_mode_spec_buf
;
19167 #ifndef SYSTEM_MALLOC
19169 if (NILP (Vmemory_full
))
19172 return "!MEM FULL! ";
19179 /* %F displays the frame name. */
19180 if (!NILP (f
->title
))
19181 return (char *) SDATA (f
->title
);
19182 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19183 return (char *) SDATA (f
->name
);
19192 int size
= ZV
- BEGV
;
19193 pint2str (decode_mode_spec_buf
, field_width
, size
);
19194 return decode_mode_spec_buf
;
19199 int size
= ZV
- BEGV
;
19200 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19201 return decode_mode_spec_buf
;
19206 int startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19207 int topline
, nlines
, junk
, height
;
19209 /* %c and %l are ignored in `frame-title-format'. */
19210 if (mode_line_target
== MODE_LINE_TITLE
)
19213 startpos
= XMARKER (w
->start
)->charpos
;
19214 startpos_byte
= marker_byte_position (w
->start
);
19215 height
= WINDOW_TOTAL_LINES (w
);
19217 /* If we decided that this buffer isn't suitable for line numbers,
19218 don't forget that too fast. */
19219 if (EQ (w
->base_line_pos
, w
->buffer
))
19221 /* But do forget it, if the window shows a different buffer now. */
19222 else if (BUFFERP (w
->base_line_pos
))
19223 w
->base_line_pos
= Qnil
;
19225 /* If the buffer is very big, don't waste time. */
19226 if (INTEGERP (Vline_number_display_limit
)
19227 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19229 w
->base_line_pos
= Qnil
;
19230 w
->base_line_number
= Qnil
;
19234 if (INTEGERP (w
->base_line_number
)
19235 && INTEGERP (w
->base_line_pos
)
19236 && XFASTINT (w
->base_line_pos
) <= startpos
)
19238 line
= XFASTINT (w
->base_line_number
);
19239 linepos
= XFASTINT (w
->base_line_pos
);
19240 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19245 linepos
= BUF_BEGV (b
);
19246 linepos_byte
= BUF_BEGV_BYTE (b
);
19249 /* Count lines from base line to window start position. */
19250 nlines
= display_count_lines (linepos
, linepos_byte
,
19254 topline
= nlines
+ line
;
19256 /* Determine a new base line, if the old one is too close
19257 or too far away, or if we did not have one.
19258 "Too close" means it's plausible a scroll-down would
19259 go back past it. */
19260 if (startpos
== BUF_BEGV (b
))
19262 w
->base_line_number
= make_number (topline
);
19263 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19265 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19266 || linepos
== BUF_BEGV (b
))
19268 int limit
= BUF_BEGV (b
);
19269 int limit_byte
= BUF_BEGV_BYTE (b
);
19271 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
19273 if (startpos
- distance
> limit
)
19275 limit
= startpos
- distance
;
19276 limit_byte
= CHAR_TO_BYTE (limit
);
19279 nlines
= display_count_lines (startpos
, startpos_byte
,
19281 - (height
* 2 + 30),
19283 /* If we couldn't find the lines we wanted within
19284 line_number_display_limit_width chars per line,
19285 give up on line numbers for this window. */
19286 if (position
== limit_byte
&& limit
== startpos
- distance
)
19288 w
->base_line_pos
= w
->buffer
;
19289 w
->base_line_number
= Qnil
;
19293 w
->base_line_number
= make_number (topline
- nlines
);
19294 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19297 /* Now count lines from the start pos to point. */
19298 nlines
= display_count_lines (startpos
, startpos_byte
,
19299 PT_BYTE
, PT
, &junk
);
19301 /* Record that we did display the line number. */
19302 line_number_displayed
= 1;
19304 /* Make the string to show. */
19305 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19306 return decode_mode_spec_buf
;
19309 char* p
= decode_mode_spec_buf
;
19310 int pad
= field_width
- 2;
19316 return decode_mode_spec_buf
;
19322 obj
= b
->mode_name
;
19326 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19332 int pos
= marker_position (w
->start
);
19333 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
19335 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19337 if (pos
<= BUF_BEGV (b
))
19342 else if (pos
<= BUF_BEGV (b
))
19346 if (total
> 1000000)
19347 /* Do it differently for a large value, to avoid overflow. */
19348 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19350 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19351 /* We can't normally display a 3-digit number,
19352 so get us a 2-digit number that is close. */
19355 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
19356 return decode_mode_spec_buf
;
19360 /* Display percentage of size above the bottom of the screen. */
19363 int toppos
= marker_position (w
->start
);
19364 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19365 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
19367 if (botpos
>= BUF_ZV (b
))
19369 if (toppos
<= BUF_BEGV (b
))
19376 if (total
> 1000000)
19377 /* Do it differently for a large value, to avoid overflow. */
19378 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19380 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19381 /* We can't normally display a 3-digit number,
19382 so get us a 2-digit number that is close. */
19385 if (toppos
<= BUF_BEGV (b
))
19386 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
19388 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
19389 return decode_mode_spec_buf
;
19394 /* status of process */
19395 obj
= Fget_buffer_process (Fcurrent_buffer ());
19397 return "no process";
19398 #ifdef subprocesses
19399 obj
= Fsymbol_name (Fprocess_status (obj
));
19405 int count
= inhibit_garbage_collection ();
19406 Lisp_Object val
= call1 (intern ("file-remote-p"),
19407 current_buffer
->directory
);
19408 unbind_to (count
, Qnil
);
19416 case 't': /* indicate TEXT or BINARY */
19417 #ifdef MODE_LINE_BINARY_TEXT
19418 return MODE_LINE_BINARY_TEXT (b
);
19424 /* coding-system (not including end-of-line format) */
19426 /* coding-system (including end-of-line type) */
19428 int eol_flag
= (c
== 'Z');
19429 char *p
= decode_mode_spec_buf
;
19431 if (! FRAME_WINDOW_P (f
))
19433 /* No need to mention EOL here--the terminal never needs
19434 to do EOL conversion. */
19435 p
= decode_mode_spec_coding (CODING_ID_NAME
19436 (FRAME_KEYBOARD_CODING (f
)->id
),
19438 p
= decode_mode_spec_coding (CODING_ID_NAME
19439 (FRAME_TERMINAL_CODING (f
)->id
),
19442 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
19445 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19446 #ifdef subprocesses
19447 obj
= Fget_buffer_process (Fcurrent_buffer ());
19448 if (PROCESSP (obj
))
19450 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19452 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19455 #endif /* subprocesses */
19458 return decode_mode_spec_buf
;
19465 return (char *) SDATA (obj
);
19472 /* Count up to COUNT lines starting from START / START_BYTE.
19473 But don't go beyond LIMIT_BYTE.
19474 Return the number of lines thus found (always nonnegative).
19476 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19479 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
19480 int start
, start_byte
, limit_byte
, count
;
19483 register unsigned char *cursor
;
19484 unsigned char *base
;
19486 register int ceiling
;
19487 register unsigned char *ceiling_addr
;
19488 int orig_count
= count
;
19490 /* If we are not in selective display mode,
19491 check only for newlines. */
19492 int selective_display
= (!NILP (current_buffer
->selective_display
)
19493 && !INTEGERP (current_buffer
->selective_display
));
19497 while (start_byte
< limit_byte
)
19499 ceiling
= BUFFER_CEILING_OF (start_byte
);
19500 ceiling
= min (limit_byte
- 1, ceiling
);
19501 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19502 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19505 if (selective_display
)
19506 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19509 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19512 if (cursor
!= ceiling_addr
)
19516 start_byte
+= cursor
- base
+ 1;
19517 *byte_pos_ptr
= start_byte
;
19521 if (++cursor
== ceiling_addr
)
19527 start_byte
+= cursor
- base
;
19532 while (start_byte
> limit_byte
)
19534 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19535 ceiling
= max (limit_byte
, ceiling
);
19536 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19537 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19540 if (selective_display
)
19541 while (--cursor
!= ceiling_addr
19542 && *cursor
!= '\n' && *cursor
!= 015)
19545 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19548 if (cursor
!= ceiling_addr
)
19552 start_byte
+= cursor
- base
+ 1;
19553 *byte_pos_ptr
= start_byte
;
19554 /* When scanning backwards, we should
19555 not count the newline posterior to which we stop. */
19556 return - orig_count
- 1;
19562 /* Here we add 1 to compensate for the last decrement
19563 of CURSOR, which took it past the valid range. */
19564 start_byte
+= cursor
- base
+ 1;
19568 *byte_pos_ptr
= limit_byte
;
19571 return - orig_count
+ count
;
19572 return orig_count
- count
;
19578 /***********************************************************************
19580 ***********************************************************************/
19582 /* Display a NUL-terminated string, starting with index START.
19584 If STRING is non-null, display that C string. Otherwise, the Lisp
19585 string LISP_STRING is displayed. There's a case that STRING is
19586 non-null and LISP_STRING is not nil. It means STRING is a string
19587 data of LISP_STRING. In that case, we display LISP_STRING while
19588 ignoring its text properties.
19590 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19591 FACE_STRING. Display STRING or LISP_STRING with the face at
19592 FACE_STRING_POS in FACE_STRING:
19594 Display the string in the environment given by IT, but use the
19595 standard display table, temporarily.
19597 FIELD_WIDTH is the minimum number of output glyphs to produce.
19598 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19599 with spaces. If STRING has more characters, more than FIELD_WIDTH
19600 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19602 PRECISION is the maximum number of characters to output from
19603 STRING. PRECISION < 0 means don't truncate the string.
19605 This is roughly equivalent to printf format specifiers:
19607 FIELD_WIDTH PRECISION PRINTF
19608 ----------------------------------------
19614 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19615 display them, and < 0 means obey the current buffer's value of
19616 enable_multibyte_characters.
19618 Value is the number of columns displayed. */
19621 display_string (string
, lisp_string
, face_string
, face_string_pos
,
19622 start
, it
, field_width
, precision
, max_x
, multibyte
)
19623 unsigned char *string
;
19624 Lisp_Object lisp_string
;
19625 Lisp_Object face_string
;
19626 EMACS_INT face_string_pos
;
19629 int field_width
, precision
, max_x
;
19632 int hpos_at_start
= it
->hpos
;
19633 int saved_face_id
= it
->face_id
;
19634 struct glyph_row
*row
= it
->glyph_row
;
19636 /* Initialize the iterator IT for iteration over STRING beginning
19637 with index START. */
19638 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19639 precision
, field_width
, multibyte
);
19640 if (string
&& STRINGP (lisp_string
))
19641 /* LISP_STRING is the one returned by decode_mode_spec. We should
19642 ignore its text properties. */
19643 it
->stop_charpos
= -1;
19645 /* If displaying STRING, set up the face of the iterator
19646 from LISP_STRING, if that's given. */
19647 if (STRINGP (face_string
))
19653 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19654 0, it
->region_beg_charpos
,
19655 it
->region_end_charpos
,
19656 &endptr
, it
->base_face_id
, 0);
19657 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19658 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
19661 /* Set max_x to the maximum allowed X position. Don't let it go
19662 beyond the right edge of the window. */
19664 max_x
= it
->last_visible_x
;
19666 max_x
= min (max_x
, it
->last_visible_x
);
19668 /* Skip over display elements that are not visible. because IT->w is
19670 if (it
->current_x
< it
->first_visible_x
)
19671 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
19672 MOVE_TO_POS
| MOVE_TO_X
);
19674 row
->ascent
= it
->max_ascent
;
19675 row
->height
= it
->max_ascent
+ it
->max_descent
;
19676 row
->phys_ascent
= it
->max_phys_ascent
;
19677 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19678 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19680 /* This condition is for the case that we are called with current_x
19681 past last_visible_x. */
19682 while (it
->current_x
< max_x
)
19684 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
19686 /* Get the next display element. */
19687 if (!get_next_display_element (it
))
19690 /* Produce glyphs. */
19691 x_before
= it
->current_x
;
19692 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19693 PRODUCE_GLYPHS (it
);
19695 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
19698 while (i
< nglyphs
)
19700 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19702 if (it
->line_wrap
!= TRUNCATE
19703 && x
+ glyph
->pixel_width
> max_x
)
19705 /* End of continued line or max_x reached. */
19706 if (CHAR_GLYPH_PADDING_P (*glyph
))
19708 /* A wide character is unbreakable. */
19709 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19710 it
->current_x
= x_before
;
19714 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19719 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
19721 /* Glyph is at least partially visible. */
19723 if (x
< it
->first_visible_x
)
19724 it
->glyph_row
->x
= x
- it
->first_visible_x
;
19728 /* Glyph is off the left margin of the display area.
19729 Should not happen. */
19733 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19734 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19735 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19736 row
->phys_height
= max (row
->phys_height
,
19737 it
->max_phys_ascent
+ it
->max_phys_descent
);
19738 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19739 it
->max_extra_line_spacing
);
19740 x
+= glyph
->pixel_width
;
19744 /* Stop if max_x reached. */
19748 /* Stop at line ends. */
19749 if (ITERATOR_AT_END_OF_LINE_P (it
))
19751 it
->continuation_lines_width
= 0;
19755 set_iterator_to_next (it
, 1);
19757 /* Stop if truncating at the right edge. */
19758 if (it
->line_wrap
== TRUNCATE
19759 && it
->current_x
>= it
->last_visible_x
)
19761 /* Add truncation mark, but don't do it if the line is
19762 truncated at a padding space. */
19763 if (IT_CHARPOS (*it
) < it
->string_nchars
)
19765 if (!FRAME_WINDOW_P (it
->f
))
19769 if (it
->current_x
> it
->last_visible_x
)
19771 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19772 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19774 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19776 row
->used
[TEXT_AREA
] = i
;
19777 produce_special_glyphs (it
, IT_TRUNCATION
);
19780 produce_special_glyphs (it
, IT_TRUNCATION
);
19782 it
->glyph_row
->truncated_on_right_p
= 1;
19788 /* Maybe insert a truncation at the left. */
19789 if (it
->first_visible_x
19790 && IT_CHARPOS (*it
) > 0)
19792 if (!FRAME_WINDOW_P (it
->f
))
19793 insert_left_trunc_glyphs (it
);
19794 it
->glyph_row
->truncated_on_left_p
= 1;
19797 it
->face_id
= saved_face_id
;
19799 /* Value is number of columns displayed. */
19800 return it
->hpos
- hpos_at_start
;
19805 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
19806 appears as an element of LIST or as the car of an element of LIST.
19807 If PROPVAL is a list, compare each element against LIST in that
19808 way, and return 1/2 if any element of PROPVAL is found in LIST.
19809 Otherwise return 0. This function cannot quit.
19810 The return value is 2 if the text is invisible but with an ellipsis
19811 and 1 if it's invisible and without an ellipsis. */
19814 invisible_p (propval
, list
)
19815 register Lisp_Object propval
;
19818 register Lisp_Object tail
, proptail
;
19820 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19822 register Lisp_Object tem
;
19824 if (EQ (propval
, tem
))
19826 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
19827 return NILP (XCDR (tem
)) ? 1 : 2;
19830 if (CONSP (propval
))
19832 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
19834 Lisp_Object propelt
;
19835 propelt
= XCAR (proptail
);
19836 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19838 register Lisp_Object tem
;
19840 if (EQ (propelt
, tem
))
19842 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
19843 return NILP (XCDR (tem
)) ? 1 : 2;
19851 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
19852 doc
: /* Non-nil if the property makes the text invisible.
19853 POS-OR-PROP can be a marker or number, in which case it is taken to be
19854 a position in the current buffer and the value of the `invisible' property
19855 is checked; or it can be some other value, which is then presumed to be the
19856 value of the `invisible' property of the text of interest.
19857 The non-nil value returned can be t for truly invisible text or something
19858 else if the text is replaced by an ellipsis. */)
19860 Lisp_Object pos_or_prop
;
19863 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
19864 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
19866 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
19867 return (invis
== 0 ? Qnil
19869 : make_number (invis
));
19872 /* Calculate a width or height in pixels from a specification using
19873 the following elements:
19876 NUM - a (fractional) multiple of the default font width/height
19877 (NUM) - specifies exactly NUM pixels
19878 UNIT - a fixed number of pixels, see below.
19879 ELEMENT - size of a display element in pixels, see below.
19880 (NUM . SPEC) - equals NUM * SPEC
19881 (+ SPEC SPEC ...) - add pixel values
19882 (- SPEC SPEC ...) - subtract pixel values
19883 (- SPEC) - negate pixel value
19886 INT or FLOAT - a number constant
19887 SYMBOL - use symbol's (buffer local) variable binding.
19890 in - pixels per inch *)
19891 mm - pixels per 1/1000 meter *)
19892 cm - pixels per 1/100 meter *)
19893 width - width of current font in pixels.
19894 height - height of current font in pixels.
19896 *) using the ratio(s) defined in display-pixels-per-inch.
19900 left-fringe - left fringe width in pixels
19901 right-fringe - right fringe width in pixels
19903 left-margin - left margin width in pixels
19904 right-margin - right margin width in pixels
19906 scroll-bar - scroll-bar area width in pixels
19910 Pixels corresponding to 5 inches:
19913 Total width of non-text areas on left side of window (if scroll-bar is on left):
19914 '(space :width (+ left-fringe left-margin scroll-bar))
19916 Align to first text column (in header line):
19917 '(space :align-to 0)
19919 Align to middle of text area minus half the width of variable `my-image'
19920 containing a loaded image:
19921 '(space :align-to (0.5 . (- text my-image)))
19923 Width of left margin minus width of 1 character in the default font:
19924 '(space :width (- left-margin 1))
19926 Width of left margin minus width of 2 characters in the current font:
19927 '(space :width (- left-margin (2 . width)))
19929 Center 1 character over left-margin (in header line):
19930 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
19932 Different ways to express width of left fringe plus left margin minus one pixel:
19933 '(space :width (- (+ left-fringe left-margin) (1)))
19934 '(space :width (+ left-fringe left-margin (- (1))))
19935 '(space :width (+ left-fringe left-margin (-1)))
19939 #define NUMVAL(X) \
19940 ((INTEGERP (X) || FLOATP (X)) \
19945 calc_pixel_width_or_height (res
, it
, prop
, font
, width_p
, align_to
)
19950 int width_p
, *align_to
;
19954 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
19955 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
19958 return OK_PIXELS (0);
19960 xassert (FRAME_LIVE_P (it
->f
));
19962 if (SYMBOLP (prop
))
19964 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
19966 char *unit
= SDATA (SYMBOL_NAME (prop
));
19968 if (unit
[0] == 'i' && unit
[1] == 'n')
19970 else if (unit
[0] == 'm' && unit
[1] == 'm')
19972 else if (unit
[0] == 'c' && unit
[1] == 'm')
19979 #ifdef HAVE_WINDOW_SYSTEM
19980 if (FRAME_WINDOW_P (it
->f
)
19982 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
19983 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
19985 return OK_PIXELS (ppi
/ pixels
);
19988 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
19989 || (CONSP (Vdisplay_pixels_per_inch
)
19991 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
19992 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
19994 return OK_PIXELS (ppi
/ pixels
);
20000 #ifdef HAVE_WINDOW_SYSTEM
20001 if (EQ (prop
, Qheight
))
20002 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20003 if (EQ (prop
, Qwidth
))
20004 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20006 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20007 return OK_PIXELS (1);
20010 if (EQ (prop
, Qtext
))
20011 return OK_PIXELS (width_p
20012 ? window_box_width (it
->w
, TEXT_AREA
)
20013 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20015 if (align_to
&& *align_to
< 0)
20018 if (EQ (prop
, Qleft
))
20019 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20020 if (EQ (prop
, Qright
))
20021 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20022 if (EQ (prop
, Qcenter
))
20023 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20024 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20025 if (EQ (prop
, Qleft_fringe
))
20026 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20027 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20028 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20029 if (EQ (prop
, Qright_fringe
))
20030 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20031 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20032 : window_box_right_offset (it
->w
, TEXT_AREA
));
20033 if (EQ (prop
, Qleft_margin
))
20034 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20035 if (EQ (prop
, Qright_margin
))
20036 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20037 if (EQ (prop
, Qscroll_bar
))
20038 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20040 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20041 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20042 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20047 if (EQ (prop
, Qleft_fringe
))
20048 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20049 if (EQ (prop
, Qright_fringe
))
20050 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20051 if (EQ (prop
, Qleft_margin
))
20052 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20053 if (EQ (prop
, Qright_margin
))
20054 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20055 if (EQ (prop
, Qscroll_bar
))
20056 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20059 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20062 if (INTEGERP (prop
) || FLOATP (prop
))
20064 int base_unit
= (width_p
20065 ? FRAME_COLUMN_WIDTH (it
->f
)
20066 : FRAME_LINE_HEIGHT (it
->f
));
20067 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20072 Lisp_Object car
= XCAR (prop
);
20073 Lisp_Object cdr
= XCDR (prop
);
20077 #ifdef HAVE_WINDOW_SYSTEM
20078 if (FRAME_WINDOW_P (it
->f
)
20079 && valid_image_p (prop
))
20081 int id
= lookup_image (it
->f
, prop
);
20082 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20084 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20087 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20093 while (CONSP (cdr
))
20095 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20096 font
, width_p
, align_to
))
20099 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20104 if (EQ (car
, Qminus
))
20106 return OK_PIXELS (pixels
);
20109 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20112 if (INTEGERP (car
) || FLOATP (car
))
20115 pixels
= XFLOATINT (car
);
20117 return OK_PIXELS (pixels
);
20118 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20119 font
, width_p
, align_to
))
20120 return OK_PIXELS (pixels
* fact
);
20131 /***********************************************************************
20133 ***********************************************************************/
20135 #ifdef HAVE_WINDOW_SYSTEM
20140 dump_glyph_string (s
)
20141 struct glyph_string
*s
;
20143 fprintf (stderr
, "glyph string\n");
20144 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20145 s
->x
, s
->y
, s
->width
, s
->height
);
20146 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20147 fprintf (stderr
, " hl = %d\n", s
->hl
);
20148 fprintf (stderr
, " left overhang = %d, right = %d\n",
20149 s
->left_overhang
, s
->right_overhang
);
20150 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20151 fprintf (stderr
, " extends to end of line = %d\n",
20152 s
->extends_to_end_of_line_p
);
20153 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20154 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20157 #endif /* GLYPH_DEBUG */
20159 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20160 of XChar2b structures for S; it can't be allocated in
20161 init_glyph_string because it must be allocated via `alloca'. W
20162 is the window on which S is drawn. ROW and AREA are the glyph row
20163 and area within the row from which S is constructed. START is the
20164 index of the first glyph structure covered by S. HL is a
20165 face-override for drawing S. */
20168 #define OPTIONAL_HDC(hdc) hdc,
20169 #define DECLARE_HDC(hdc) HDC hdc;
20170 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20171 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20174 #ifndef OPTIONAL_HDC
20175 #define OPTIONAL_HDC(hdc)
20176 #define DECLARE_HDC(hdc)
20177 #define ALLOCATE_HDC(hdc, f)
20178 #define RELEASE_HDC(hdc, f)
20182 init_glyph_string (s
, OPTIONAL_HDC (hdc
) char2b
, w
, row
, area
, start
, hl
)
20183 struct glyph_string
*s
;
20187 struct glyph_row
*row
;
20188 enum glyph_row_area area
;
20190 enum draw_glyphs_face hl
;
20192 bzero (s
, sizeof *s
);
20194 s
->f
= XFRAME (w
->frame
);
20198 s
->display
= FRAME_X_DISPLAY (s
->f
);
20199 s
->window
= FRAME_X_WINDOW (s
->f
);
20200 s
->char2b
= char2b
;
20204 s
->first_glyph
= row
->glyphs
[area
] + start
;
20205 s
->height
= row
->height
;
20206 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20207 s
->ybase
= s
->y
+ row
->ascent
;
20211 /* Append the list of glyph strings with head H and tail T to the list
20212 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20215 append_glyph_string_lists (head
, tail
, h
, t
)
20216 struct glyph_string
**head
, **tail
;
20217 struct glyph_string
*h
, *t
;
20231 /* Prepend the list of glyph strings with head H and tail T to the
20232 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20236 prepend_glyph_string_lists (head
, tail
, h
, t
)
20237 struct glyph_string
**head
, **tail
;
20238 struct glyph_string
*h
, *t
;
20252 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20253 Set *HEAD and *TAIL to the resulting list. */
20256 append_glyph_string (head
, tail
, s
)
20257 struct glyph_string
**head
, **tail
;
20258 struct glyph_string
*s
;
20260 s
->next
= s
->prev
= NULL
;
20261 append_glyph_string_lists (head
, tail
, s
, s
);
20265 /* Get face and two-byte form of character C in face FACE_ID on frame
20266 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
20267 means we want to display multibyte text. DISPLAY_P non-zero means
20268 make sure that X resources for the face returned are allocated.
20269 Value is a pointer to a realized face that is ready for display if
20270 DISPLAY_P is non-zero. */
20272 static INLINE
struct face
*
20273 get_char_face_and_encoding (f
, c
, face_id
, char2b
, multibyte_p
, display_p
)
20277 int multibyte_p
, display_p
;
20279 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20283 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20285 if (code
!= FONT_INVALID_CODE
)
20286 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20288 STORE_XCHAR2B (char2b
, 0, 0);
20291 /* Make sure X resources of the face are allocated. */
20292 #ifdef HAVE_X_WINDOWS
20296 xassert (face
!= NULL
);
20297 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20304 /* Get face and two-byte form of character glyph GLYPH on frame F.
20305 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20306 a pointer to a realized face that is ready for display. */
20308 static INLINE
struct face
*
20309 get_glyph_face_and_encoding (f
, glyph
, char2b
, two_byte_p
)
20311 struct glyph
*glyph
;
20317 xassert (glyph
->type
== CHAR_GLYPH
);
20318 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20325 unsigned code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20327 if (code
!= FONT_INVALID_CODE
)
20328 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20330 STORE_XCHAR2B (char2b
, 0, 0);
20333 /* Make sure X resources of the face are allocated. */
20334 xassert (face
!= NULL
);
20335 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20340 /* Fill glyph string S with composition components specified by S->cmp.
20342 BASE_FACE is the base face of the composition.
20343 S->cmp_from is the index of the first component for S.
20345 OVERLAPS non-zero means S should draw the foreground only, and use
20346 its physical height for clipping. See also draw_glyphs.
20348 Value is the index of a component not in S. */
20351 fill_composite_glyph_string (s
, base_face
, overlaps
)
20352 struct glyph_string
*s
;
20353 struct face
*base_face
;
20357 /* For all glyphs of this composition, starting at the offset
20358 S->cmp_from, until we reach the end of the definition or encounter a
20359 glyph that requires the different face, add it to S. */
20364 s
->for_overlaps
= overlaps
;
20367 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20369 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20373 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20376 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20377 s
->char2b
+ i
, 1, 1);
20383 s
->font
= s
->face
->font
;
20385 else if (s
->face
!= face
)
20393 /* All glyph strings for the same composition has the same width,
20394 i.e. the width set for the first component of the composition. */
20395 s
->width
= s
->first_glyph
->pixel_width
;
20397 /* If the specified font could not be loaded, use the frame's
20398 default font, but record the fact that we couldn't load it in
20399 the glyph string so that we can draw rectangles for the
20400 characters of the glyph string. */
20401 if (s
->font
== NULL
)
20403 s
->font_not_found_p
= 1;
20404 s
->font
= FRAME_FONT (s
->f
);
20407 /* Adjust base line for subscript/superscript text. */
20408 s
->ybase
+= s
->first_glyph
->voffset
;
20410 /* This glyph string must always be drawn with 16-bit functions. */
20417 fill_gstring_glyph_string (s
, face_id
, start
, end
, overlaps
)
20418 struct glyph_string
*s
;
20420 int start
, end
, overlaps
;
20422 struct glyph
*glyph
, *last
;
20423 Lisp_Object lgstring
;
20426 s
->for_overlaps
= overlaps
;
20427 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20428 last
= s
->row
->glyphs
[s
->area
] + end
;
20429 s
->cmp_id
= glyph
->u
.cmp
.id
;
20430 s
->cmp_from
= glyph
->u
.cmp
.from
;
20431 s
->cmp_to
= glyph
->u
.cmp
.to
+ 1;
20432 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20433 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20434 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20436 while (glyph
< last
20437 && glyph
->u
.cmp
.automatic
20438 && glyph
->u
.cmp
.id
== s
->cmp_id
20439 && s
->cmp_to
== glyph
->u
.cmp
.from
)
20440 s
->cmp_to
= (glyph
++)->u
.cmp
.to
+ 1;
20442 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20444 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20445 unsigned code
= LGLYPH_CODE (lglyph
);
20447 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20449 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20450 return glyph
- s
->row
->glyphs
[s
->area
];
20454 /* Fill glyph string S from a sequence of character glyphs.
20456 FACE_ID is the face id of the string. START is the index of the
20457 first glyph to consider, END is the index of the last + 1.
20458 OVERLAPS non-zero means S should draw the foreground only, and use
20459 its physical height for clipping. See also draw_glyphs.
20461 Value is the index of the first glyph not in S. */
20464 fill_glyph_string (s
, face_id
, start
, end
, overlaps
)
20465 struct glyph_string
*s
;
20467 int start
, end
, overlaps
;
20469 struct glyph
*glyph
, *last
;
20471 int glyph_not_available_p
;
20473 xassert (s
->f
== XFRAME (s
->w
->frame
));
20474 xassert (s
->nchars
== 0);
20475 xassert (start
>= 0 && end
> start
);
20477 s
->for_overlaps
= overlaps
;
20478 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20479 last
= s
->row
->glyphs
[s
->area
] + end
;
20480 voffset
= glyph
->voffset
;
20481 s
->padding_p
= glyph
->padding_p
;
20482 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20484 while (glyph
< last
20485 && glyph
->type
== CHAR_GLYPH
20486 && glyph
->voffset
== voffset
20487 /* Same face id implies same font, nowadays. */
20488 && glyph
->face_id
== face_id
20489 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20493 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20494 s
->char2b
+ s
->nchars
,
20496 s
->two_byte_p
= two_byte_p
;
20498 xassert (s
->nchars
<= end
- start
);
20499 s
->width
+= glyph
->pixel_width
;
20500 if (glyph
++->padding_p
!= s
->padding_p
)
20504 s
->font
= s
->face
->font
;
20506 /* If the specified font could not be loaded, use the frame's font,
20507 but record the fact that we couldn't load it in
20508 S->font_not_found_p so that we can draw rectangles for the
20509 characters of the glyph string. */
20510 if (s
->font
== NULL
|| glyph_not_available_p
)
20512 s
->font_not_found_p
= 1;
20513 s
->font
= FRAME_FONT (s
->f
);
20516 /* Adjust base line for subscript/superscript text. */
20517 s
->ybase
+= voffset
;
20519 xassert (s
->face
&& s
->face
->gc
);
20520 return glyph
- s
->row
->glyphs
[s
->area
];
20524 /* Fill glyph string S from image glyph S->first_glyph. */
20527 fill_image_glyph_string (s
)
20528 struct glyph_string
*s
;
20530 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20531 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20533 s
->slice
= s
->first_glyph
->slice
;
20534 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20535 s
->font
= s
->face
->font
;
20536 s
->width
= s
->first_glyph
->pixel_width
;
20538 /* Adjust base line for subscript/superscript text. */
20539 s
->ybase
+= s
->first_glyph
->voffset
;
20543 /* Fill glyph string S from a sequence of stretch glyphs.
20545 ROW is the glyph row in which the glyphs are found, AREA is the
20546 area within the row. START is the index of the first glyph to
20547 consider, END is the index of the last + 1.
20549 Value is the index of the first glyph not in S. */
20552 fill_stretch_glyph_string (s
, row
, area
, start
, end
)
20553 struct glyph_string
*s
;
20554 struct glyph_row
*row
;
20555 enum glyph_row_area area
;
20558 struct glyph
*glyph
, *last
;
20559 int voffset
, face_id
;
20561 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20563 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20564 last
= s
->row
->glyphs
[s
->area
] + end
;
20565 face_id
= glyph
->face_id
;
20566 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20567 s
->font
= s
->face
->font
;
20568 s
->width
= glyph
->pixel_width
;
20570 voffset
= glyph
->voffset
;
20574 && glyph
->type
== STRETCH_GLYPH
20575 && glyph
->voffset
== voffset
20576 && glyph
->face_id
== face_id
);
20578 s
->width
+= glyph
->pixel_width
;
20580 /* Adjust base line for subscript/superscript text. */
20581 s
->ybase
+= voffset
;
20583 /* The case that face->gc == 0 is handled when drawing the glyph
20584 string by calling PREPARE_FACE_FOR_DISPLAY. */
20586 return glyph
- s
->row
->glyphs
[s
->area
];
20589 static struct font_metrics
*
20590 get_per_char_metric (f
, font
, char2b
)
20595 static struct font_metrics metrics
;
20596 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20598 if (! font
|| code
== FONT_INVALID_CODE
)
20600 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20605 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20606 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20607 assumed to be zero. */
20610 x_get_glyph_overhangs (glyph
, f
, left
, right
)
20611 struct glyph
*glyph
;
20615 *left
= *right
= 0;
20617 if (glyph
->type
== CHAR_GLYPH
)
20621 struct font_metrics
*pcm
;
20623 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20624 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
20626 if (pcm
->rbearing
> pcm
->width
)
20627 *right
= pcm
->rbearing
- pcm
->width
;
20628 if (pcm
->lbearing
< 0)
20629 *left
= -pcm
->lbearing
;
20632 else if (glyph
->type
== COMPOSITE_GLYPH
)
20634 if (! glyph
->u
.cmp
.automatic
)
20636 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20638 if (cmp
->rbearing
> cmp
->pixel_width
)
20639 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20640 if (cmp
->lbearing
< 0)
20641 *left
= - cmp
->lbearing
;
20645 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
20646 struct font_metrics metrics
;
20648 composition_gstring_width (gstring
, glyph
->u
.cmp
.from
,
20649 glyph
->u
.cmp
.to
+ 1, &metrics
);
20650 if (metrics
.rbearing
> metrics
.width
)
20651 *right
= metrics
.rbearing
- metrics
.width
;
20652 if (metrics
.lbearing
< 0)
20653 *left
= - metrics
.lbearing
;
20659 /* Return the index of the first glyph preceding glyph string S that
20660 is overwritten by S because of S's left overhang. Value is -1
20661 if no glyphs are overwritten. */
20664 left_overwritten (s
)
20665 struct glyph_string
*s
;
20669 if (s
->left_overhang
)
20672 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20673 int first
= s
->first_glyph
- glyphs
;
20675 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
20676 x
-= glyphs
[i
].pixel_width
;
20687 /* Return the index of the first glyph preceding glyph string S that
20688 is overwriting S because of its right overhang. Value is -1 if no
20689 glyph in front of S overwrites S. */
20692 left_overwriting (s
)
20693 struct glyph_string
*s
;
20696 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20697 int first
= s
->first_glyph
- glyphs
;
20701 for (i
= first
- 1; i
>= 0; --i
)
20704 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20707 x
-= glyphs
[i
].pixel_width
;
20714 /* Return the index of the last glyph following glyph string S that is
20715 overwritten by S because of S's right overhang. Value is -1 if
20716 no such glyph is found. */
20719 right_overwritten (s
)
20720 struct glyph_string
*s
;
20724 if (s
->right_overhang
)
20727 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20728 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20729 int end
= s
->row
->used
[s
->area
];
20731 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
20732 x
+= glyphs
[i
].pixel_width
;
20741 /* Return the index of the last glyph following glyph string S that
20742 overwrites S because of its left overhang. Value is negative
20743 if no such glyph is found. */
20746 right_overwriting (s
)
20747 struct glyph_string
*s
;
20750 int end
= s
->row
->used
[s
->area
];
20751 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20752 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20756 for (i
= first
; i
< end
; ++i
)
20759 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20762 x
+= glyphs
[i
].pixel_width
;
20769 /* Set background width of glyph string S. START is the index of the
20770 first glyph following S. LAST_X is the right-most x-position + 1
20771 in the drawing area. */
20774 set_glyph_string_background_width (s
, start
, last_x
)
20775 struct glyph_string
*s
;
20779 /* If the face of this glyph string has to be drawn to the end of
20780 the drawing area, set S->extends_to_end_of_line_p. */
20782 if (start
== s
->row
->used
[s
->area
]
20783 && s
->area
== TEXT_AREA
20784 && ((s
->row
->fill_line_p
20785 && (s
->hl
== DRAW_NORMAL_TEXT
20786 || s
->hl
== DRAW_IMAGE_RAISED
20787 || s
->hl
== DRAW_IMAGE_SUNKEN
))
20788 || s
->hl
== DRAW_MOUSE_FACE
))
20789 s
->extends_to_end_of_line_p
= 1;
20791 /* If S extends its face to the end of the line, set its
20792 background_width to the distance to the right edge of the drawing
20794 if (s
->extends_to_end_of_line_p
)
20795 s
->background_width
= last_x
- s
->x
+ 1;
20797 s
->background_width
= s
->width
;
20801 /* Compute overhangs and x-positions for glyph string S and its
20802 predecessors, or successors. X is the starting x-position for S.
20803 BACKWARD_P non-zero means process predecessors. */
20806 compute_overhangs_and_x (s
, x
, backward_p
)
20807 struct glyph_string
*s
;
20815 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20816 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20826 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20827 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20837 /* The following macros are only called from draw_glyphs below.
20838 They reference the following parameters of that function directly:
20839 `w', `row', `area', and `overlap_p'
20840 as well as the following local variables:
20841 `s', `f', and `hdc' (in W32) */
20844 /* On W32, silently add local `hdc' variable to argument list of
20845 init_glyph_string. */
20846 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20847 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
20849 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20850 init_glyph_string (s, char2b, w, row, area, start, hl)
20853 /* Add a glyph string for a stretch glyph to the list of strings
20854 between HEAD and TAIL. START is the index of the stretch glyph in
20855 row area AREA of glyph row ROW. END is the index of the last glyph
20856 in that glyph row area. X is the current output position assigned
20857 to the new glyph string constructed. HL overrides that face of the
20858 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20859 is the right-most x-position of the drawing area. */
20861 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
20862 and below -- keep them on one line. */
20863 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20866 s = (struct glyph_string *) alloca (sizeof *s); \
20867 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
20868 START = fill_stretch_glyph_string (s, row, area, START, END); \
20869 append_glyph_string (&HEAD, &TAIL, s); \
20875 /* Add a glyph string for an image glyph to the list of strings
20876 between HEAD and TAIL. START is the index of the image glyph in
20877 row area AREA of glyph row ROW. END is the index of the last glyph
20878 in that glyph row area. X is the current output position assigned
20879 to the new glyph string constructed. HL overrides that face of the
20880 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20881 is the right-most x-position of the drawing area. */
20883 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20886 s = (struct glyph_string *) alloca (sizeof *s); \
20887 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
20888 fill_image_glyph_string (s); \
20889 append_glyph_string (&HEAD, &TAIL, s); \
20896 /* Add a glyph string for a sequence of character glyphs to the list
20897 of strings between HEAD and TAIL. START is the index of the first
20898 glyph in row area AREA of glyph row ROW that is part of the new
20899 glyph string. END is the index of the last glyph in that glyph row
20900 area. X is the current output position assigned to the new glyph
20901 string constructed. HL overrides that face of the glyph; e.g. it
20902 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
20903 right-most x-position of the drawing area. */
20905 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
20911 face_id = (row)->glyphs[area][START].face_id; \
20913 s = (struct glyph_string *) alloca (sizeof *s); \
20914 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
20915 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20916 append_glyph_string (&HEAD, &TAIL, s); \
20918 START = fill_glyph_string (s, face_id, START, END, overlaps); \
20923 /* Add a glyph string for a composite sequence to the list of strings
20924 between HEAD and TAIL. START is the index of the first glyph in
20925 row area AREA of glyph row ROW that is part of the new glyph
20926 string. END is the index of the last glyph in that glyph row area.
20927 X is the current output position assigned to the new glyph string
20928 constructed. HL overrides that face of the glyph; e.g. it is
20929 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
20930 x-position of the drawing area. */
20932 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20934 int face_id = (row)->glyphs[area][START].face_id; \
20935 struct face *base_face = FACE_FROM_ID (f, face_id); \
20936 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
20937 struct composition *cmp = composition_table[cmp_id]; \
20939 struct glyph_string *first_s; \
20942 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
20944 /* Make glyph_strings for each glyph sequence that is drawable by \
20945 the same face, and append them to HEAD/TAIL. */ \
20946 for (n = 0; n < cmp->glyph_len;) \
20948 s = (struct glyph_string *) alloca (sizeof *s); \
20949 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20950 append_glyph_string (&(HEAD), &(TAIL), s); \
20956 n = fill_composite_glyph_string (s, base_face, overlaps); \
20964 /* Add a glyph string for a glyph-string sequence to the list of strings
20965 between HEAD and TAIL. */
20967 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20971 Lisp_Object gstring; \
20973 face_id = (row)->glyphs[area][START].face_id; \
20974 gstring = (composition_gstring_from_id \
20975 ((row)->glyphs[area][START].u.cmp.id)); \
20976 s = (struct glyph_string *) alloca (sizeof *s); \
20977 char2b = (XChar2b *) alloca ((sizeof *char2b) \
20978 * LGSTRING_GLYPH_LEN (gstring)); \
20979 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20980 append_glyph_string (&(HEAD), &(TAIL), s); \
20982 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
20986 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
20987 of AREA of glyph row ROW on window W between indices START and END.
20988 HL overrides the face for drawing glyph strings, e.g. it is
20989 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
20990 x-positions of the drawing area.
20992 This is an ugly monster macro construct because we must use alloca
20993 to allocate glyph strings (because draw_glyphs can be called
20994 asynchronously). */
20996 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
20999 HEAD = TAIL = NULL; \
21000 while (START < END) \
21002 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21003 switch (first_glyph->type) \
21006 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21010 case COMPOSITE_GLYPH: \
21011 if (first_glyph->u.cmp.automatic) \
21012 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21015 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21019 case STRETCH_GLYPH: \
21020 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21024 case IMAGE_GLYPH: \
21025 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21035 set_glyph_string_background_width (s, START, LAST_X); \
21042 /* Draw glyphs between START and END in AREA of ROW on window W,
21043 starting at x-position X. X is relative to AREA in W. HL is a
21044 face-override with the following meaning:
21046 DRAW_NORMAL_TEXT draw normally
21047 DRAW_CURSOR draw in cursor face
21048 DRAW_MOUSE_FACE draw in mouse face.
21049 DRAW_INVERSE_VIDEO draw in mode line face
21050 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21051 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21053 If OVERLAPS is non-zero, draw only the foreground of characters and
21054 clip to the physical height of ROW. Non-zero value also defines
21055 the overlapping part to be drawn:
21057 OVERLAPS_PRED overlap with preceding rows
21058 OVERLAPS_SUCC overlap with succeeding rows
21059 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21060 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21062 Value is the x-position reached, relative to AREA of W. */
21065 draw_glyphs (w
, x
, row
, area
, start
, end
, hl
, overlaps
)
21068 struct glyph_row
*row
;
21069 enum glyph_row_area area
;
21070 EMACS_INT start
, end
;
21071 enum draw_glyphs_face hl
;
21074 struct glyph_string
*head
, *tail
;
21075 struct glyph_string
*s
;
21076 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21077 int i
, j
, x_reached
, last_x
, area_left
= 0;
21078 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21081 ALLOCATE_HDC (hdc
, f
);
21083 /* Let's rather be paranoid than getting a SEGV. */
21084 end
= min (end
, row
->used
[area
]);
21085 start
= max (0, start
);
21086 start
= min (end
, start
);
21088 /* Translate X to frame coordinates. Set last_x to the right
21089 end of the drawing area. */
21090 if (row
->full_width_p
)
21092 /* X is relative to the left edge of W, without scroll bars
21094 area_left
= WINDOW_LEFT_EDGE_X (w
);
21095 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21099 area_left
= window_box_left (w
, area
);
21100 last_x
= area_left
+ window_box_width (w
, area
);
21104 /* Build a doubly-linked list of glyph_string structures between
21105 head and tail from what we have to draw. Note that the macro
21106 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21107 the reason we use a separate variable `i'. */
21109 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21111 x_reached
= tail
->x
+ tail
->background_width
;
21115 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21116 the row, redraw some glyphs in front or following the glyph
21117 strings built above. */
21118 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21120 struct glyph_string
*h
, *t
;
21121 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
21122 int mouse_beg_col
, mouse_end_col
, check_mouse_face
= 0;
21125 /* If mouse highlighting is on, we may need to draw adjacent
21126 glyphs using mouse-face highlighting. */
21127 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21129 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21131 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
21132 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
21134 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21136 check_mouse_face
= 1;
21137 mouse_beg_col
= (row
== mouse_beg_row
)
21138 ? dpyinfo
->mouse_face_beg_col
: 0;
21139 mouse_end_col
= (row
== mouse_end_row
)
21140 ? dpyinfo
->mouse_face_end_col
21141 : row
->used
[TEXT_AREA
];
21145 /* Compute overhangs for all glyph strings. */
21146 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21147 for (s
= head
; s
; s
= s
->next
)
21148 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21150 /* Prepend glyph strings for glyphs in front of the first glyph
21151 string that are overwritten because of the first glyph
21152 string's left overhang. The background of all strings
21153 prepended must be drawn because the first glyph string
21155 i
= left_overwritten (head
);
21158 enum draw_glyphs_face overlap_hl
;
21160 /* If this row contains mouse highlighting, attempt to draw
21161 the overlapped glyphs with the correct highlight. This
21162 code fails if the overlap encompasses more than one glyph
21163 and mouse-highlight spans only some of these glyphs.
21164 However, making it work perfectly involves a lot more
21165 code, and I don't know if the pathological case occurs in
21166 practice, so we'll stick to this for now. --- cyd */
21167 if (check_mouse_face
21168 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21169 overlap_hl
= DRAW_MOUSE_FACE
;
21171 overlap_hl
= DRAW_NORMAL_TEXT
;
21174 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21175 overlap_hl
, dummy_x
, last_x
);
21177 compute_overhangs_and_x (t
, head
->x
, 1);
21178 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21182 /* Prepend glyph strings for glyphs in front of the first glyph
21183 string that overwrite that glyph string because of their
21184 right overhang. For these strings, only the foreground must
21185 be drawn, because it draws over the glyph string at `head'.
21186 The background must not be drawn because this would overwrite
21187 right overhangs of preceding glyphs for which no glyph
21189 i
= left_overwriting (head
);
21192 enum draw_glyphs_face overlap_hl
;
21194 if (check_mouse_face
21195 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21196 overlap_hl
= DRAW_MOUSE_FACE
;
21198 overlap_hl
= DRAW_NORMAL_TEXT
;
21201 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21202 overlap_hl
, dummy_x
, last_x
);
21203 for (s
= h
; s
; s
= s
->next
)
21204 s
->background_filled_p
= 1;
21205 compute_overhangs_and_x (t
, head
->x
, 1);
21206 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21209 /* Append glyphs strings for glyphs following the last glyph
21210 string tail that are overwritten by tail. The background of
21211 these strings has to be drawn because tail's foreground draws
21213 i
= right_overwritten (tail
);
21216 enum draw_glyphs_face overlap_hl
;
21218 if (check_mouse_face
21219 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21220 overlap_hl
= DRAW_MOUSE_FACE
;
21222 overlap_hl
= DRAW_NORMAL_TEXT
;
21224 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21225 overlap_hl
, x
, last_x
);
21226 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21227 we don't have `end = i;' here. */
21228 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21229 append_glyph_string_lists (&head
, &tail
, h
, t
);
21233 /* Append glyph strings for glyphs following the last glyph
21234 string tail that overwrite tail. The foreground of such
21235 glyphs has to be drawn because it writes into the background
21236 of tail. The background must not be drawn because it could
21237 paint over the foreground of following glyphs. */
21238 i
= right_overwriting (tail
);
21241 enum draw_glyphs_face overlap_hl
;
21242 if (check_mouse_face
21243 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21244 overlap_hl
= DRAW_MOUSE_FACE
;
21246 overlap_hl
= DRAW_NORMAL_TEXT
;
21249 i
++; /* We must include the Ith glyph. */
21250 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21251 overlap_hl
, x
, last_x
);
21252 for (s
= h
; s
; s
= s
->next
)
21253 s
->background_filled_p
= 1;
21254 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21255 append_glyph_string_lists (&head
, &tail
, h
, t
);
21257 if (clip_head
|| clip_tail
)
21258 for (s
= head
; s
; s
= s
->next
)
21260 s
->clip_head
= clip_head
;
21261 s
->clip_tail
= clip_tail
;
21265 /* Draw all strings. */
21266 for (s
= head
; s
; s
= s
->next
)
21267 FRAME_RIF (f
)->draw_glyph_string (s
);
21270 /* When focus a sole frame and move horizontally, this sets on_p to 0
21271 causing a failure to erase prev cursor position. */
21272 if (area
== TEXT_AREA
21273 && !row
->full_width_p
21274 /* When drawing overlapping rows, only the glyph strings'
21275 foreground is drawn, which doesn't erase a cursor
21279 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21280 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21281 : (tail
? tail
->x
+ tail
->background_width
: x
));
21285 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21286 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21290 /* Value is the x-position up to which drawn, relative to AREA of W.
21291 This doesn't include parts drawn because of overhangs. */
21292 if (row
->full_width_p
)
21293 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21295 x_reached
-= area_left
;
21297 RELEASE_HDC (hdc
, f
);
21302 /* Expand row matrix if too narrow. Don't expand if area
21305 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21307 if (!fonts_changed_p \
21308 && (it->glyph_row->glyphs[area] \
21309 < it->glyph_row->glyphs[area + 1])) \
21311 it->w->ncols_scale_factor++; \
21312 fonts_changed_p = 1; \
21316 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21317 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21323 struct glyph
*glyph
;
21324 enum glyph_row_area area
= it
->area
;
21326 xassert (it
->glyph_row
);
21327 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21329 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21330 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21332 /* If the glyph row is reversed, we need to prepend the glyph
21333 rather than append it. */
21334 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21338 /* Make room for the additional glyph. */
21339 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21341 glyph
= it
->glyph_row
->glyphs
[area
];
21343 glyph
->charpos
= CHARPOS (it
->position
);
21344 glyph
->object
= it
->object
;
21345 if (it
->pixel_width
> 0)
21347 glyph
->pixel_width
= it
->pixel_width
;
21348 glyph
->padding_p
= 0;
21352 /* Assure at least 1-pixel width. Otherwise, cursor can't
21353 be displayed correctly. */
21354 glyph
->pixel_width
= 1;
21355 glyph
->padding_p
= 1;
21357 glyph
->ascent
= it
->ascent
;
21358 glyph
->descent
= it
->descent
;
21359 glyph
->voffset
= it
->voffset
;
21360 glyph
->type
= CHAR_GLYPH
;
21361 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21362 glyph
->multibyte_p
= it
->multibyte_p
;
21363 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21364 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21365 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21366 || it
->phys_descent
> it
->descent
);
21367 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21368 glyph
->face_id
= it
->face_id
;
21369 glyph
->u
.ch
= it
->char_to_display
;
21370 glyph
->slice
= null_glyph_slice
;
21371 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21374 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21375 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21377 glyph
->bidi_type
= it
->bidi_it
.type
;
21381 glyph
->resolved_level
= 0;
21382 glyph
->bidi_type
= UNKNOWN_BT
;
21384 ++it
->glyph_row
->used
[area
];
21387 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21390 /* Store one glyph for the composition IT->cmp_it.id in
21391 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21395 append_composite_glyph (it
)
21398 struct glyph
*glyph
;
21399 enum glyph_row_area area
= it
->area
;
21401 xassert (it
->glyph_row
);
21403 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21404 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21406 glyph
->charpos
= CHARPOS (it
->position
);
21407 glyph
->object
= it
->object
;
21408 glyph
->pixel_width
= it
->pixel_width
;
21409 glyph
->ascent
= it
->ascent
;
21410 glyph
->descent
= it
->descent
;
21411 glyph
->voffset
= it
->voffset
;
21412 glyph
->type
= COMPOSITE_GLYPH
;
21413 if (it
->cmp_it
.ch
< 0)
21415 glyph
->u
.cmp
.automatic
= 0;
21416 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21420 glyph
->u
.cmp
.automatic
= 1;
21421 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21422 glyph
->u
.cmp
.from
= it
->cmp_it
.from
;
21423 glyph
->u
.cmp
.to
= it
->cmp_it
.to
- 1;
21425 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21426 glyph
->multibyte_p
= it
->multibyte_p
;
21427 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21428 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21429 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21430 || it
->phys_descent
> it
->descent
);
21431 glyph
->padding_p
= 0;
21432 glyph
->glyph_not_available_p
= 0;
21433 glyph
->face_id
= it
->face_id
;
21434 glyph
->slice
= null_glyph_slice
;
21435 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21438 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21439 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21441 glyph
->bidi_type
= it
->bidi_it
.type
;
21443 ++it
->glyph_row
->used
[area
];
21446 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21450 /* Change IT->ascent and IT->height according to the setting of
21454 take_vertical_position_into_account (it
)
21459 if (it
->voffset
< 0)
21460 /* Increase the ascent so that we can display the text higher
21462 it
->ascent
-= it
->voffset
;
21464 /* Increase the descent so that we can display the text lower
21466 it
->descent
+= it
->voffset
;
21471 /* Produce glyphs/get display metrics for the image IT is loaded with.
21472 See the description of struct display_iterator in dispextern.h for
21473 an overview of struct display_iterator. */
21476 produce_image_glyph (it
)
21481 int glyph_ascent
, crop
;
21482 struct glyph_slice slice
;
21484 xassert (it
->what
== IT_IMAGE
);
21486 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21488 /* Make sure X resources of the face is loaded. */
21489 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21491 if (it
->image_id
< 0)
21493 /* Fringe bitmap. */
21494 it
->ascent
= it
->phys_ascent
= 0;
21495 it
->descent
= it
->phys_descent
= 0;
21496 it
->pixel_width
= 0;
21501 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21503 /* Make sure X resources of the image is loaded. */
21504 prepare_image_for_display (it
->f
, img
);
21506 slice
.x
= slice
.y
= 0;
21507 slice
.width
= img
->width
;
21508 slice
.height
= img
->height
;
21510 if (INTEGERP (it
->slice
.x
))
21511 slice
.x
= XINT (it
->slice
.x
);
21512 else if (FLOATP (it
->slice
.x
))
21513 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21515 if (INTEGERP (it
->slice
.y
))
21516 slice
.y
= XINT (it
->slice
.y
);
21517 else if (FLOATP (it
->slice
.y
))
21518 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21520 if (INTEGERP (it
->slice
.width
))
21521 slice
.width
= XINT (it
->slice
.width
);
21522 else if (FLOATP (it
->slice
.width
))
21523 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21525 if (INTEGERP (it
->slice
.height
))
21526 slice
.height
= XINT (it
->slice
.height
);
21527 else if (FLOATP (it
->slice
.height
))
21528 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21530 if (slice
.x
>= img
->width
)
21531 slice
.x
= img
->width
;
21532 if (slice
.y
>= img
->height
)
21533 slice
.y
= img
->height
;
21534 if (slice
.x
+ slice
.width
>= img
->width
)
21535 slice
.width
= img
->width
- slice
.x
;
21536 if (slice
.y
+ slice
.height
> img
->height
)
21537 slice
.height
= img
->height
- slice
.y
;
21539 if (slice
.width
== 0 || slice
.height
== 0)
21542 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21544 it
->descent
= slice
.height
- glyph_ascent
;
21546 it
->descent
+= img
->vmargin
;
21547 if (slice
.y
+ slice
.height
== img
->height
)
21548 it
->descent
+= img
->vmargin
;
21549 it
->phys_descent
= it
->descent
;
21551 it
->pixel_width
= slice
.width
;
21553 it
->pixel_width
+= img
->hmargin
;
21554 if (slice
.x
+ slice
.width
== img
->width
)
21555 it
->pixel_width
+= img
->hmargin
;
21557 /* It's quite possible for images to have an ascent greater than
21558 their height, so don't get confused in that case. */
21559 if (it
->descent
< 0)
21564 if (face
->box
!= FACE_NO_BOX
)
21566 if (face
->box_line_width
> 0)
21569 it
->ascent
+= face
->box_line_width
;
21570 if (slice
.y
+ slice
.height
== img
->height
)
21571 it
->descent
+= face
->box_line_width
;
21574 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21575 it
->pixel_width
+= eabs (face
->box_line_width
);
21576 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21577 it
->pixel_width
+= eabs (face
->box_line_width
);
21580 take_vertical_position_into_account (it
);
21582 /* Automatically crop wide image glyphs at right edge so we can
21583 draw the cursor on same display row. */
21584 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21585 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21587 it
->pixel_width
-= crop
;
21588 slice
.width
-= crop
;
21593 struct glyph
*glyph
;
21594 enum glyph_row_area area
= it
->area
;
21596 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21597 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21599 glyph
->charpos
= CHARPOS (it
->position
);
21600 glyph
->object
= it
->object
;
21601 glyph
->pixel_width
= it
->pixel_width
;
21602 glyph
->ascent
= glyph_ascent
;
21603 glyph
->descent
= it
->descent
;
21604 glyph
->voffset
= it
->voffset
;
21605 glyph
->type
= IMAGE_GLYPH
;
21606 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21607 glyph
->multibyte_p
= it
->multibyte_p
;
21608 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21609 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21610 glyph
->overlaps_vertically_p
= 0;
21611 glyph
->padding_p
= 0;
21612 glyph
->glyph_not_available_p
= 0;
21613 glyph
->face_id
= it
->face_id
;
21614 glyph
->u
.img_id
= img
->id
;
21615 glyph
->slice
= slice
;
21616 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21619 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21620 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21622 glyph
->bidi_type
= it
->bidi_it
.type
;
21624 ++it
->glyph_row
->used
[area
];
21627 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21632 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
21633 of the glyph, WIDTH and HEIGHT are the width and height of the
21634 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
21637 append_stretch_glyph (it
, object
, width
, height
, ascent
)
21639 Lisp_Object object
;
21643 struct glyph
*glyph
;
21644 enum glyph_row_area area
= it
->area
;
21646 xassert (ascent
>= 0 && ascent
<= height
);
21648 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21649 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21651 glyph
->charpos
= CHARPOS (it
->position
);
21652 glyph
->object
= object
;
21653 glyph
->pixel_width
= width
;
21654 glyph
->ascent
= ascent
;
21655 glyph
->descent
= height
- ascent
;
21656 glyph
->voffset
= it
->voffset
;
21657 glyph
->type
= STRETCH_GLYPH
;
21658 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21659 glyph
->multibyte_p
= it
->multibyte_p
;
21660 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21661 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21662 glyph
->overlaps_vertically_p
= 0;
21663 glyph
->padding_p
= 0;
21664 glyph
->glyph_not_available_p
= 0;
21665 glyph
->face_id
= it
->face_id
;
21666 glyph
->u
.stretch
.ascent
= ascent
;
21667 glyph
->u
.stretch
.height
= height
;
21668 glyph
->slice
= null_glyph_slice
;
21669 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21672 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21673 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21675 glyph
->bidi_type
= it
->bidi_it
.type
;
21677 ++it
->glyph_row
->used
[area
];
21680 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21684 /* Produce a stretch glyph for iterator IT. IT->object is the value
21685 of the glyph property displayed. The value must be a list
21686 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
21689 1. `:width WIDTH' specifies that the space should be WIDTH *
21690 canonical char width wide. WIDTH may be an integer or floating
21693 2. `:relative-width FACTOR' specifies that the width of the stretch
21694 should be computed from the width of the first character having the
21695 `glyph' property, and should be FACTOR times that width.
21697 3. `:align-to HPOS' specifies that the space should be wide enough
21698 to reach HPOS, a value in canonical character units.
21700 Exactly one of the above pairs must be present.
21702 4. `:height HEIGHT' specifies that the height of the stretch produced
21703 should be HEIGHT, measured in canonical character units.
21705 5. `:relative-height FACTOR' specifies that the height of the
21706 stretch should be FACTOR times the height of the characters having
21707 the glyph property.
21709 Either none or exactly one of 4 or 5 must be present.
21711 6. `:ascent ASCENT' specifies that ASCENT percent of the height
21712 of the stretch should be used for the ascent of the stretch.
21713 ASCENT must be in the range 0 <= ASCENT <= 100. */
21716 produce_stretch_glyph (it
)
21719 /* (space :width WIDTH :height HEIGHT ...) */
21720 Lisp_Object prop
, plist
;
21721 int width
= 0, height
= 0, align_to
= -1;
21722 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
21725 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21726 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
21728 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21730 /* List should start with `space'. */
21731 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
21732 plist
= XCDR (it
->object
);
21734 /* Compute the width of the stretch. */
21735 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
21736 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
21738 /* Absolute width `:width WIDTH' specified and valid. */
21739 zero_width_ok_p
= 1;
21742 else if (prop
= Fplist_get (plist
, QCrelative_width
),
21745 /* Relative width `:relative-width FACTOR' specified and valid.
21746 Compute the width of the characters having the `glyph'
21749 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
21752 if (it
->multibyte_p
)
21754 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
21755 - IT_BYTEPOS (*it
));
21756 it2
.c
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
21759 it2
.c
= *p
, it2
.len
= 1;
21761 it2
.glyph_row
= NULL
;
21762 it2
.what
= IT_CHARACTER
;
21763 x_produce_glyphs (&it2
);
21764 width
= NUMVAL (prop
) * it2
.pixel_width
;
21766 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
21767 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
21769 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
21770 align_to
= (align_to
< 0
21772 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
21773 else if (align_to
< 0)
21774 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
21775 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
21776 zero_width_ok_p
= 1;
21779 /* Nothing specified -> width defaults to canonical char width. */
21780 width
= FRAME_COLUMN_WIDTH (it
->f
);
21782 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
21785 /* Compute height. */
21786 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
21787 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21790 zero_height_ok_p
= 1;
21792 else if (prop
= Fplist_get (plist
, QCrelative_height
),
21794 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
21796 height
= FONT_HEIGHT (font
);
21798 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
21801 /* Compute percentage of height used for ascent. If
21802 `:ascent ASCENT' is present and valid, use that. Otherwise,
21803 derive the ascent from the font in use. */
21804 if (prop
= Fplist_get (plist
, QCascent
),
21805 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
21806 ascent
= height
* NUMVAL (prop
) / 100.0;
21807 else if (!NILP (prop
)
21808 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21809 ascent
= min (max (0, (int)tem
), height
);
21811 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
21813 if (width
> 0 && it
->line_wrap
!= TRUNCATE
21814 && it
->current_x
+ width
> it
->last_visible_x
)
21815 width
= it
->last_visible_x
- it
->current_x
- 1;
21817 if (width
> 0 && height
> 0 && it
->glyph_row
)
21819 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
21820 if (!STRINGP (object
))
21821 object
= it
->w
->buffer
;
21822 append_stretch_glyph (it
, object
, width
, height
, ascent
);
21825 it
->pixel_width
= width
;
21826 it
->ascent
= it
->phys_ascent
= ascent
;
21827 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
21828 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
21830 take_vertical_position_into_account (it
);
21833 /* Calculate line-height and line-spacing properties.
21834 An integer value specifies explicit pixel value.
21835 A float value specifies relative value to current face height.
21836 A cons (float . face-name) specifies relative value to
21837 height of specified face font.
21839 Returns height in pixels, or nil. */
21843 calc_line_height_property (it
, val
, font
, boff
, override
)
21847 int boff
, override
;
21849 Lisp_Object face_name
= Qnil
;
21850 int ascent
, descent
, height
;
21852 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
21857 face_name
= XCAR (val
);
21859 if (!NUMBERP (val
))
21860 val
= make_number (1);
21861 if (NILP (face_name
))
21863 height
= it
->ascent
+ it
->descent
;
21868 if (NILP (face_name
))
21870 font
= FRAME_FONT (it
->f
);
21871 boff
= FRAME_BASELINE_OFFSET (it
->f
);
21873 else if (EQ (face_name
, Qt
))
21882 face_id
= lookup_named_face (it
->f
, face_name
, 0);
21884 return make_number (-1);
21886 face
= FACE_FROM_ID (it
->f
, face_id
);
21889 return make_number (-1);
21890 boff
= font
->baseline_offset
;
21891 if (font
->vertical_centering
)
21892 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21895 ascent
= FONT_BASE (font
) + boff
;
21896 descent
= FONT_DESCENT (font
) - boff
;
21900 it
->override_ascent
= ascent
;
21901 it
->override_descent
= descent
;
21902 it
->override_boff
= boff
;
21905 height
= ascent
+ descent
;
21909 height
= (int)(XFLOAT_DATA (val
) * height
);
21910 else if (INTEGERP (val
))
21911 height
*= XINT (val
);
21913 return make_number (height
);
21918 Produce glyphs/get display metrics for the display element IT is
21919 loaded with. See the description of struct it in dispextern.h
21920 for an overview of struct it. */
21923 x_produce_glyphs (it
)
21926 int extra_line_spacing
= it
->extra_line_spacing
;
21928 it
->glyph_not_available_p
= 0;
21930 if (it
->what
== IT_CHARACTER
)
21934 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21935 struct font_metrics
*pcm
;
21936 int font_not_found_p
;
21937 int boff
; /* baseline offset */
21938 /* We may change it->multibyte_p upon unibyte<->multibyte
21939 conversion. So, save the current value now and restore it
21942 Note: It seems that we don't have to record multibyte_p in
21943 struct glyph because the character code itself tells whether
21944 or not the character is multibyte. Thus, in the future, we
21945 must consider eliminating the field `multibyte_p' in the
21947 int saved_multibyte_p
= it
->multibyte_p
;
21949 /* Maybe translate single-byte characters to multibyte, or the
21951 it
->char_to_display
= it
->c
;
21952 if (!ASCII_BYTE_P (it
->c
)
21953 && ! it
->multibyte_p
)
21955 if (SINGLE_BYTE_CHAR_P (it
->c
)
21956 && unibyte_display_via_language_environment
)
21958 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
21960 /* get_next_display_element assures that this decoding
21962 it
->char_to_display
= DECODE_CHAR (unibyte
, it
->c
);
21963 it
->multibyte_p
= 1;
21964 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
,
21966 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21970 /* Get font to use. Encode IT->char_to_display. */
21971 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
21972 &char2b
, it
->multibyte_p
, 0);
21975 font_not_found_p
= font
== NULL
;
21976 if (font_not_found_p
)
21978 /* When no suitable font found, display an empty box based
21979 on the metrics of the font of the default face (or what
21981 struct face
*no_font_face
21982 = FACE_FROM_ID (it
->f
,
21983 NILP (Vface_remapping_alist
) ? DEFAULT_FACE_ID
21984 : lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
21985 font
= no_font_face
->font
;
21986 boff
= font
->baseline_offset
;
21990 boff
= font
->baseline_offset
;
21991 if (font
->vertical_centering
)
21992 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21995 if (it
->char_to_display
>= ' '
21996 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
21998 /* Either unibyte or ASCII. */
22003 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22005 if (it
->override_ascent
>= 0)
22007 it
->ascent
= it
->override_ascent
;
22008 it
->descent
= it
->override_descent
;
22009 boff
= it
->override_boff
;
22013 it
->ascent
= FONT_BASE (font
) + boff
;
22014 it
->descent
= FONT_DESCENT (font
) - boff
;
22019 it
->phys_ascent
= pcm
->ascent
+ boff
;
22020 it
->phys_descent
= pcm
->descent
- boff
;
22021 it
->pixel_width
= pcm
->width
;
22025 it
->glyph_not_available_p
= 1;
22026 it
->phys_ascent
= it
->ascent
;
22027 it
->phys_descent
= it
->descent
;
22028 it
->pixel_width
= FONT_WIDTH (font
);
22031 if (it
->constrain_row_ascent_descent_p
)
22033 if (it
->descent
> it
->max_descent
)
22035 it
->ascent
+= it
->descent
- it
->max_descent
;
22036 it
->descent
= it
->max_descent
;
22038 if (it
->ascent
> it
->max_ascent
)
22040 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22041 it
->ascent
= it
->max_ascent
;
22043 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22044 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22045 extra_line_spacing
= 0;
22048 /* If this is a space inside a region of text with
22049 `space-width' property, change its width. */
22050 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22052 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22054 /* If face has a box, add the box thickness to the character
22055 height. If character has a box line to the left and/or
22056 right, add the box line width to the character's width. */
22057 if (face
->box
!= FACE_NO_BOX
)
22059 int thick
= face
->box_line_width
;
22063 it
->ascent
+= thick
;
22064 it
->descent
+= thick
;
22069 if (it
->start_of_box_run_p
)
22070 it
->pixel_width
+= thick
;
22071 if (it
->end_of_box_run_p
)
22072 it
->pixel_width
+= thick
;
22075 /* If face has an overline, add the height of the overline
22076 (1 pixel) and a 1 pixel margin to the character height. */
22077 if (face
->overline_p
)
22078 it
->ascent
+= overline_margin
;
22080 if (it
->constrain_row_ascent_descent_p
)
22082 if (it
->ascent
> it
->max_ascent
)
22083 it
->ascent
= it
->max_ascent
;
22084 if (it
->descent
> it
->max_descent
)
22085 it
->descent
= it
->max_descent
;
22088 take_vertical_position_into_account (it
);
22090 /* If we have to actually produce glyphs, do it. */
22095 /* Translate a space with a `space-width' property
22096 into a stretch glyph. */
22097 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22098 / FONT_HEIGHT (font
));
22099 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22100 it
->ascent
+ it
->descent
, ascent
);
22105 /* If characters with lbearing or rbearing are displayed
22106 in this line, record that fact in a flag of the
22107 glyph row. This is used to optimize X output code. */
22108 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22109 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22111 if (! stretched_p
&& it
->pixel_width
== 0)
22112 /* We assure that all visible glyphs have at least 1-pixel
22114 it
->pixel_width
= 1;
22116 else if (it
->char_to_display
== '\n')
22118 /* A newline has no width, but we need the height of the
22119 line. But if previous part of the line sets a height,
22120 don't increase that height */
22122 Lisp_Object height
;
22123 Lisp_Object total_height
= Qnil
;
22125 it
->override_ascent
= -1;
22126 it
->pixel_width
= 0;
22129 height
= get_it_property(it
, Qline_height
);
22130 /* Split (line-height total-height) list */
22132 && CONSP (XCDR (height
))
22133 && NILP (XCDR (XCDR (height
))))
22135 total_height
= XCAR (XCDR (height
));
22136 height
= XCAR (height
);
22138 height
= calc_line_height_property(it
, height
, font
, boff
, 1);
22140 if (it
->override_ascent
>= 0)
22142 it
->ascent
= it
->override_ascent
;
22143 it
->descent
= it
->override_descent
;
22144 boff
= it
->override_boff
;
22148 it
->ascent
= FONT_BASE (font
) + boff
;
22149 it
->descent
= FONT_DESCENT (font
) - boff
;
22152 if (EQ (height
, Qt
))
22154 if (it
->descent
> it
->max_descent
)
22156 it
->ascent
+= it
->descent
- it
->max_descent
;
22157 it
->descent
= it
->max_descent
;
22159 if (it
->ascent
> it
->max_ascent
)
22161 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22162 it
->ascent
= it
->max_ascent
;
22164 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22165 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22166 it
->constrain_row_ascent_descent_p
= 1;
22167 extra_line_spacing
= 0;
22171 Lisp_Object spacing
;
22173 it
->phys_ascent
= it
->ascent
;
22174 it
->phys_descent
= it
->descent
;
22176 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22177 && face
->box
!= FACE_NO_BOX
22178 && face
->box_line_width
> 0)
22180 it
->ascent
+= face
->box_line_width
;
22181 it
->descent
+= face
->box_line_width
;
22184 && XINT (height
) > it
->ascent
+ it
->descent
)
22185 it
->ascent
= XINT (height
) - it
->descent
;
22187 if (!NILP (total_height
))
22188 spacing
= calc_line_height_property(it
, total_height
, font
, boff
, 0);
22191 spacing
= get_it_property(it
, Qline_spacing
);
22192 spacing
= calc_line_height_property(it
, spacing
, font
, boff
, 0);
22194 if (INTEGERP (spacing
))
22196 extra_line_spacing
= XINT (spacing
);
22197 if (!NILP (total_height
))
22198 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22202 else if (it
->char_to_display
== '\t')
22204 if (font
->space_width
> 0)
22206 int tab_width
= it
->tab_width
* font
->space_width
;
22207 int x
= it
->current_x
+ it
->continuation_lines_width
;
22208 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22210 /* If the distance from the current position to the next tab
22211 stop is less than a space character width, use the
22212 tab stop after that. */
22213 if (next_tab_x
- x
< font
->space_width
)
22214 next_tab_x
+= tab_width
;
22216 it
->pixel_width
= next_tab_x
- x
;
22218 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22219 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22223 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22224 it
->ascent
+ it
->descent
, it
->ascent
);
22229 it
->pixel_width
= 0;
22235 /* A multi-byte character. Assume that the display width of the
22236 character is the width of the character multiplied by the
22237 width of the font. */
22239 /* If we found a font, this font should give us the right
22240 metrics. If we didn't find a font, use the frame's
22241 default font and calculate the width of the character by
22242 multiplying the width of font by the width of the
22245 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22247 if (font_not_found_p
|| !pcm
)
22249 int char_width
= CHAR_WIDTH (it
->char_to_display
);
22251 if (char_width
== 0)
22252 /* This is a non spacing character. But, as we are
22253 going to display an empty box, the box must occupy
22254 at least one column. */
22256 it
->glyph_not_available_p
= 1;
22257 it
->pixel_width
= font
->space_width
* char_width
;
22258 it
->phys_ascent
= FONT_BASE (font
) + boff
;
22259 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22263 it
->pixel_width
= pcm
->width
;
22264 it
->phys_ascent
= pcm
->ascent
+ boff
;
22265 it
->phys_descent
= pcm
->descent
- boff
;
22267 && (pcm
->lbearing
< 0
22268 || pcm
->rbearing
> pcm
->width
))
22269 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22272 it
->ascent
= FONT_BASE (font
) + boff
;
22273 it
->descent
= FONT_DESCENT (font
) - boff
;
22274 if (face
->box
!= FACE_NO_BOX
)
22276 int thick
= face
->box_line_width
;
22280 it
->ascent
+= thick
;
22281 it
->descent
+= thick
;
22286 if (it
->start_of_box_run_p
)
22287 it
->pixel_width
+= thick
;
22288 if (it
->end_of_box_run_p
)
22289 it
->pixel_width
+= thick
;
22292 /* If face has an overline, add the height of the overline
22293 (1 pixel) and a 1 pixel margin to the character height. */
22294 if (face
->overline_p
)
22295 it
->ascent
+= overline_margin
;
22297 take_vertical_position_into_account (it
);
22299 if (it
->ascent
< 0)
22301 if (it
->descent
< 0)
22306 if (it
->pixel_width
== 0)
22307 /* We assure that all visible glyphs have at least 1-pixel
22309 it
->pixel_width
= 1;
22311 it
->multibyte_p
= saved_multibyte_p
;
22313 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22315 /* A static composition.
22317 Note: A composition is represented as one glyph in the
22318 glyph matrix. There are no padding glyphs.
22320 Important note: pixel_width, ascent, and descent are the
22321 values of what is drawn by draw_glyphs (i.e. the values of
22322 the overall glyphs composed). */
22323 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22324 int boff
; /* baseline offset */
22325 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22326 int glyph_len
= cmp
->glyph_len
;
22327 struct font
*font
= face
->font
;
22331 /* If we have not yet calculated pixel size data of glyphs of
22332 the composition for the current face font, calculate them
22333 now. Theoretically, we have to check all fonts for the
22334 glyphs, but that requires much time and memory space. So,
22335 here we check only the font of the first glyph. This may
22336 lead to incorrect display, but it's very rare, and C-l
22337 (recenter-top-bottom) can correct the display anyway. */
22338 if (! cmp
->font
|| cmp
->font
!= font
)
22340 /* Ascent and descent of the font of the first character
22341 of this composition (adjusted by baseline offset).
22342 Ascent and descent of overall glyphs should not be less
22343 than these, respectively. */
22344 int font_ascent
, font_descent
, font_height
;
22345 /* Bounding box of the overall glyphs. */
22346 int leftmost
, rightmost
, lowest
, highest
;
22347 int lbearing
, rbearing
;
22348 int i
, width
, ascent
, descent
;
22349 int left_padded
= 0, right_padded
= 0;
22352 struct font_metrics
*pcm
;
22353 int font_not_found_p
;
22356 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22357 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22359 if (glyph_len
< cmp
->glyph_len
)
22361 for (i
= 0; i
< glyph_len
; i
++)
22363 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22365 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22370 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22371 : IT_CHARPOS (*it
));
22372 /* If no suitable font is found, use the default font. */
22373 font_not_found_p
= font
== NULL
;
22374 if (font_not_found_p
)
22376 face
= face
->ascii_face
;
22379 boff
= font
->baseline_offset
;
22380 if (font
->vertical_centering
)
22381 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22382 font_ascent
= FONT_BASE (font
) + boff
;
22383 font_descent
= FONT_DESCENT (font
) - boff
;
22384 font_height
= FONT_HEIGHT (font
);
22386 cmp
->font
= (void *) font
;
22389 if (! font_not_found_p
)
22391 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22392 &char2b
, it
->multibyte_p
, 0);
22393 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22396 /* Initialize the bounding box. */
22399 width
= pcm
->width
;
22400 ascent
= pcm
->ascent
;
22401 descent
= pcm
->descent
;
22402 lbearing
= pcm
->lbearing
;
22403 rbearing
= pcm
->rbearing
;
22407 width
= FONT_WIDTH (font
);
22408 ascent
= FONT_BASE (font
);
22409 descent
= FONT_DESCENT (font
);
22416 lowest
= - descent
+ boff
;
22417 highest
= ascent
+ boff
;
22419 if (! font_not_found_p
22420 && font
->default_ascent
22421 && CHAR_TABLE_P (Vuse_default_ascent
)
22422 && !NILP (Faref (Vuse_default_ascent
,
22423 make_number (it
->char_to_display
))))
22424 highest
= font
->default_ascent
+ boff
;
22426 /* Draw the first glyph at the normal position. It may be
22427 shifted to right later if some other glyphs are drawn
22429 cmp
->offsets
[i
* 2] = 0;
22430 cmp
->offsets
[i
* 2 + 1] = boff
;
22431 cmp
->lbearing
= lbearing
;
22432 cmp
->rbearing
= rbearing
;
22434 /* Set cmp->offsets for the remaining glyphs. */
22435 for (i
++; i
< glyph_len
; i
++)
22437 int left
, right
, btm
, top
;
22438 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22440 struct face
*this_face
;
22445 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22446 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22447 font
= this_face
->font
;
22453 this_boff
= font
->baseline_offset
;
22454 if (font
->vertical_centering
)
22455 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22456 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22457 &char2b
, it
->multibyte_p
, 0);
22458 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22461 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22464 width
= pcm
->width
;
22465 ascent
= pcm
->ascent
;
22466 descent
= pcm
->descent
;
22467 lbearing
= pcm
->lbearing
;
22468 rbearing
= pcm
->rbearing
;
22469 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22471 /* Relative composition with or without
22472 alternate chars. */
22473 left
= (leftmost
+ rightmost
- width
) / 2;
22474 btm
= - descent
+ boff
;
22475 if (font
->relative_compose
22476 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22477 || NILP (Faref (Vignore_relative_composition
,
22478 make_number (ch
)))))
22481 if (- descent
>= font
->relative_compose
)
22482 /* One extra pixel between two glyphs. */
22484 else if (ascent
<= 0)
22485 /* One extra pixel between two glyphs. */
22486 btm
= lowest
- 1 - ascent
- descent
;
22491 /* A composition rule is specified by an integer
22492 value that encodes global and new reference
22493 points (GREF and NREF). GREF and NREF are
22494 specified by numbers as below:
22496 0---1---2 -- ascent
22500 9--10--11 -- center
22502 ---3---4---5--- baseline
22504 6---7---8 -- descent
22506 int rule
= COMPOSITION_RULE (cmp
, i
);
22507 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
22509 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
22510 grefx
= gref
% 3, nrefx
= nref
% 3;
22511 grefy
= gref
/ 3, nrefy
= nref
/ 3;
22513 xoff
= font_height
* (xoff
- 128) / 256;
22515 yoff
= font_height
* (yoff
- 128) / 256;
22518 + grefx
* (rightmost
- leftmost
) / 2
22519 - nrefx
* width
/ 2
22522 btm
= ((grefy
== 0 ? highest
22524 : grefy
== 2 ? lowest
22525 : (highest
+ lowest
) / 2)
22526 - (nrefy
== 0 ? ascent
+ descent
22527 : nrefy
== 1 ? descent
- boff
22529 : (ascent
+ descent
) / 2)
22533 cmp
->offsets
[i
* 2] = left
;
22534 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
22536 /* Update the bounding box of the overall glyphs. */
22539 right
= left
+ width
;
22540 if (left
< leftmost
)
22542 if (right
> rightmost
)
22545 top
= btm
+ descent
+ ascent
;
22551 if (cmp
->lbearing
> left
+ lbearing
)
22552 cmp
->lbearing
= left
+ lbearing
;
22553 if (cmp
->rbearing
< left
+ rbearing
)
22554 cmp
->rbearing
= left
+ rbearing
;
22558 /* If there are glyphs whose x-offsets are negative,
22559 shift all glyphs to the right and make all x-offsets
22563 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22564 cmp
->offsets
[i
* 2] -= leftmost
;
22565 rightmost
-= leftmost
;
22566 cmp
->lbearing
-= leftmost
;
22567 cmp
->rbearing
-= leftmost
;
22570 if (left_padded
&& cmp
->lbearing
< 0)
22572 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22573 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
22574 rightmost
-= cmp
->lbearing
;
22575 cmp
->rbearing
-= cmp
->lbearing
;
22578 if (right_padded
&& rightmost
< cmp
->rbearing
)
22580 rightmost
= cmp
->rbearing
;
22583 cmp
->pixel_width
= rightmost
;
22584 cmp
->ascent
= highest
;
22585 cmp
->descent
= - lowest
;
22586 if (cmp
->ascent
< font_ascent
)
22587 cmp
->ascent
= font_ascent
;
22588 if (cmp
->descent
< font_descent
)
22589 cmp
->descent
= font_descent
;
22593 && (cmp
->lbearing
< 0
22594 || cmp
->rbearing
> cmp
->pixel_width
))
22595 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22597 it
->pixel_width
= cmp
->pixel_width
;
22598 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
22599 it
->descent
= it
->phys_descent
= cmp
->descent
;
22600 if (face
->box
!= FACE_NO_BOX
)
22602 int thick
= face
->box_line_width
;
22606 it
->ascent
+= thick
;
22607 it
->descent
+= thick
;
22612 if (it
->start_of_box_run_p
)
22613 it
->pixel_width
+= thick
;
22614 if (it
->end_of_box_run_p
)
22615 it
->pixel_width
+= thick
;
22618 /* If face has an overline, add the height of the overline
22619 (1 pixel) and a 1 pixel margin to the character height. */
22620 if (face
->overline_p
)
22621 it
->ascent
+= overline_margin
;
22623 take_vertical_position_into_account (it
);
22624 if (it
->ascent
< 0)
22626 if (it
->descent
< 0)
22630 append_composite_glyph (it
);
22632 else if (it
->what
== IT_COMPOSITION
)
22634 /* A dynamic (automatic) composition. */
22635 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22636 Lisp_Object gstring
;
22637 struct font_metrics metrics
;
22639 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
22641 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
22644 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
22645 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22646 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
22647 it
->descent
= it
->phys_descent
= metrics
.descent
;
22648 if (face
->box
!= FACE_NO_BOX
)
22650 int thick
= face
->box_line_width
;
22654 it
->ascent
+= thick
;
22655 it
->descent
+= thick
;
22660 if (it
->start_of_box_run_p
)
22661 it
->pixel_width
+= thick
;
22662 if (it
->end_of_box_run_p
)
22663 it
->pixel_width
+= thick
;
22665 /* If face has an overline, add the height of the overline
22666 (1 pixel) and a 1 pixel margin to the character height. */
22667 if (face
->overline_p
)
22668 it
->ascent
+= overline_margin
;
22669 take_vertical_position_into_account (it
);
22670 if (it
->ascent
< 0)
22672 if (it
->descent
< 0)
22676 append_composite_glyph (it
);
22678 else if (it
->what
== IT_IMAGE
)
22679 produce_image_glyph (it
);
22680 else if (it
->what
== IT_STRETCH
)
22681 produce_stretch_glyph (it
);
22683 /* Accumulate dimensions. Note: can't assume that it->descent > 0
22684 because this isn't true for images with `:ascent 100'. */
22685 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
22686 if (it
->area
== TEXT_AREA
)
22687 it
->current_x
+= it
->pixel_width
;
22689 if (extra_line_spacing
> 0)
22691 it
->descent
+= extra_line_spacing
;
22692 if (extra_line_spacing
> it
->max_extra_line_spacing
)
22693 it
->max_extra_line_spacing
= extra_line_spacing
;
22696 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
22697 it
->max_descent
= max (it
->max_descent
, it
->descent
);
22698 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
22699 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
22703 Output LEN glyphs starting at START at the nominal cursor position.
22704 Advance the nominal cursor over the text. The global variable
22705 updated_window contains the window being updated, updated_row is
22706 the glyph row being updated, and updated_area is the area of that
22707 row being updated. */
22710 x_write_glyphs (start
, len
)
22711 struct glyph
*start
;
22716 xassert (updated_window
&& updated_row
);
22719 /* Write glyphs. */
22721 hpos
= start
- updated_row
->glyphs
[updated_area
];
22722 x
= draw_glyphs (updated_window
, output_cursor
.x
,
22723 updated_row
, updated_area
,
22725 DRAW_NORMAL_TEXT
, 0);
22727 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
22728 if (updated_area
== TEXT_AREA
22729 && updated_window
->phys_cursor_on_p
22730 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
22731 && updated_window
->phys_cursor
.hpos
>= hpos
22732 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
22733 updated_window
->phys_cursor_on_p
= 0;
22737 /* Advance the output cursor. */
22738 output_cursor
.hpos
+= len
;
22739 output_cursor
.x
= x
;
22744 Insert LEN glyphs from START at the nominal cursor position. */
22747 x_insert_glyphs (start
, len
)
22748 struct glyph
*start
;
22753 int line_height
, shift_by_width
, shifted_region_width
;
22754 struct glyph_row
*row
;
22755 struct glyph
*glyph
;
22756 int frame_x
, frame_y
;
22759 xassert (updated_window
&& updated_row
);
22761 w
= updated_window
;
22762 f
= XFRAME (WINDOW_FRAME (w
));
22764 /* Get the height of the line we are in. */
22766 line_height
= row
->height
;
22768 /* Get the width of the glyphs to insert. */
22769 shift_by_width
= 0;
22770 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
22771 shift_by_width
+= glyph
->pixel_width
;
22773 /* Get the width of the region to shift right. */
22774 shifted_region_width
= (window_box_width (w
, updated_area
)
22779 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
22780 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
22782 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
22783 line_height
, shift_by_width
);
22785 /* Write the glyphs. */
22786 hpos
= start
- row
->glyphs
[updated_area
];
22787 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
22789 DRAW_NORMAL_TEXT
, 0);
22791 /* Advance the output cursor. */
22792 output_cursor
.hpos
+= len
;
22793 output_cursor
.x
+= shift_by_width
;
22799 Erase the current text line from the nominal cursor position
22800 (inclusive) to pixel column TO_X (exclusive). The idea is that
22801 everything from TO_X onward is already erased.
22803 TO_X is a pixel position relative to updated_area of
22804 updated_window. TO_X == -1 means clear to the end of this area. */
22807 x_clear_end_of_line (to_x
)
22811 struct window
*w
= updated_window
;
22812 int max_x
, min_y
, max_y
;
22813 int from_x
, from_y
, to_y
;
22815 xassert (updated_window
&& updated_row
);
22816 f
= XFRAME (w
->frame
);
22818 if (updated_row
->full_width_p
)
22819 max_x
= WINDOW_TOTAL_WIDTH (w
);
22821 max_x
= window_box_width (w
, updated_area
);
22822 max_y
= window_text_bottom_y (w
);
22824 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
22825 of window. For TO_X > 0, truncate to end of drawing area. */
22831 to_x
= min (to_x
, max_x
);
22833 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
22835 /* Notice if the cursor will be cleared by this operation. */
22836 if (!updated_row
->full_width_p
)
22837 notice_overwritten_cursor (w
, updated_area
,
22838 output_cursor
.x
, -1,
22840 MATRIX_ROW_BOTTOM_Y (updated_row
));
22842 from_x
= output_cursor
.x
;
22844 /* Translate to frame coordinates. */
22845 if (updated_row
->full_width_p
)
22847 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
22848 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
22852 int area_left
= window_box_left (w
, updated_area
);
22853 from_x
+= area_left
;
22857 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
22858 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
22859 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
22861 /* Prevent inadvertently clearing to end of the X window. */
22862 if (to_x
> from_x
&& to_y
> from_y
)
22865 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
22866 to_x
- from_x
, to_y
- from_y
);
22871 #endif /* HAVE_WINDOW_SYSTEM */
22875 /***********************************************************************
22877 ***********************************************************************/
22879 /* Value is the internal representation of the specified cursor type
22880 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
22881 of the bar cursor. */
22883 static enum text_cursor_kinds
22884 get_specified_cursor_type (arg
, width
)
22888 enum text_cursor_kinds type
;
22893 if (EQ (arg
, Qbox
))
22894 return FILLED_BOX_CURSOR
;
22896 if (EQ (arg
, Qhollow
))
22897 return HOLLOW_BOX_CURSOR
;
22899 if (EQ (arg
, Qbar
))
22906 && EQ (XCAR (arg
), Qbar
)
22907 && INTEGERP (XCDR (arg
))
22908 && XINT (XCDR (arg
)) >= 0)
22910 *width
= XINT (XCDR (arg
));
22914 if (EQ (arg
, Qhbar
))
22917 return HBAR_CURSOR
;
22921 && EQ (XCAR (arg
), Qhbar
)
22922 && INTEGERP (XCDR (arg
))
22923 && XINT (XCDR (arg
)) >= 0)
22925 *width
= XINT (XCDR (arg
));
22926 return HBAR_CURSOR
;
22929 /* Treat anything unknown as "hollow box cursor".
22930 It was bad to signal an error; people have trouble fixing
22931 .Xdefaults with Emacs, when it has something bad in it. */
22932 type
= HOLLOW_BOX_CURSOR
;
22937 /* Set the default cursor types for specified frame. */
22939 set_frame_cursor_types (f
, arg
)
22946 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
22947 FRAME_CURSOR_WIDTH (f
) = width
;
22949 /* By default, set up the blink-off state depending on the on-state. */
22951 tem
= Fassoc (arg
, Vblink_cursor_alist
);
22954 FRAME_BLINK_OFF_CURSOR (f
)
22955 = get_specified_cursor_type (XCDR (tem
), &width
);
22956 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
22959 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
22963 /* Return the cursor we want to be displayed in window W. Return
22964 width of bar/hbar cursor through WIDTH arg. Return with
22965 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
22966 (i.e. if the `system caret' should track this cursor).
22968 In a mini-buffer window, we want the cursor only to appear if we
22969 are reading input from this window. For the selected window, we
22970 want the cursor type given by the frame parameter or buffer local
22971 setting of cursor-type. If explicitly marked off, draw no cursor.
22972 In all other cases, we want a hollow box cursor. */
22974 static enum text_cursor_kinds
22975 get_window_cursor_type (w
, glyph
, width
, active_cursor
)
22977 struct glyph
*glyph
;
22979 int *active_cursor
;
22981 struct frame
*f
= XFRAME (w
->frame
);
22982 struct buffer
*b
= XBUFFER (w
->buffer
);
22983 int cursor_type
= DEFAULT_CURSOR
;
22984 Lisp_Object alt_cursor
;
22985 int non_selected
= 0;
22987 *active_cursor
= 1;
22990 if (cursor_in_echo_area
22991 && FRAME_HAS_MINIBUF_P (f
)
22992 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
22994 if (w
== XWINDOW (echo_area_window
))
22996 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
22998 *width
= FRAME_CURSOR_WIDTH (f
);
22999 return FRAME_DESIRED_CURSOR (f
);
23002 return get_specified_cursor_type (b
->cursor_type
, width
);
23005 *active_cursor
= 0;
23009 /* Detect a nonselected window or nonselected frame. */
23010 else if (w
!= XWINDOW (f
->selected_window
)
23011 #ifdef HAVE_WINDOW_SYSTEM
23012 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
23016 *active_cursor
= 0;
23018 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23024 /* Never display a cursor in a window in which cursor-type is nil. */
23025 if (NILP (b
->cursor_type
))
23028 /* Get the normal cursor type for this window. */
23029 if (EQ (b
->cursor_type
, Qt
))
23031 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23032 *width
= FRAME_CURSOR_WIDTH (f
);
23035 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
23037 /* Use cursor-in-non-selected-windows instead
23038 for non-selected window or frame. */
23041 alt_cursor
= b
->cursor_in_non_selected_windows
;
23042 if (!EQ (Qt
, alt_cursor
))
23043 return get_specified_cursor_type (alt_cursor
, width
);
23044 /* t means modify the normal cursor type. */
23045 if (cursor_type
== FILLED_BOX_CURSOR
)
23046 cursor_type
= HOLLOW_BOX_CURSOR
;
23047 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23049 return cursor_type
;
23052 /* Use normal cursor if not blinked off. */
23053 if (!w
->cursor_off_p
)
23055 #ifdef HAVE_WINDOW_SYSTEM
23056 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23058 if (cursor_type
== FILLED_BOX_CURSOR
)
23060 /* Using a block cursor on large images can be very annoying.
23061 So use a hollow cursor for "large" images.
23062 If image is not transparent (no mask), also use hollow cursor. */
23063 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23064 if (img
!= NULL
&& IMAGEP (img
->spec
))
23066 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23067 where N = size of default frame font size.
23068 This should cover most of the "tiny" icons people may use. */
23070 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23071 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23072 cursor_type
= HOLLOW_BOX_CURSOR
;
23075 else if (cursor_type
!= NO_CURSOR
)
23077 /* Display current only supports BOX and HOLLOW cursors for images.
23078 So for now, unconditionally use a HOLLOW cursor when cursor is
23079 not a solid box cursor. */
23080 cursor_type
= HOLLOW_BOX_CURSOR
;
23084 return cursor_type
;
23087 /* Cursor is blinked off, so determine how to "toggle" it. */
23089 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23090 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
23091 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23093 /* Then see if frame has specified a specific blink off cursor type. */
23094 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23096 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23097 return FRAME_BLINK_OFF_CURSOR (f
);
23101 /* Some people liked having a permanently visible blinking cursor,
23102 while others had very strong opinions against it. So it was
23103 decided to remove it. KFS 2003-09-03 */
23105 /* Finally perform built-in cursor blinking:
23106 filled box <-> hollow box
23107 wide [h]bar <-> narrow [h]bar
23108 narrow [h]bar <-> no cursor
23109 other type <-> no cursor */
23111 if (cursor_type
== FILLED_BOX_CURSOR
)
23112 return HOLLOW_BOX_CURSOR
;
23114 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23117 return cursor_type
;
23125 #ifdef HAVE_WINDOW_SYSTEM
23127 /* Notice when the text cursor of window W has been completely
23128 overwritten by a drawing operation that outputs glyphs in AREA
23129 starting at X0 and ending at X1 in the line starting at Y0 and
23130 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23131 the rest of the line after X0 has been written. Y coordinates
23132 are window-relative. */
23135 notice_overwritten_cursor (w
, area
, x0
, x1
, y0
, y1
)
23137 enum glyph_row_area area
;
23138 int x0
, y0
, x1
, y1
;
23140 int cx0
, cx1
, cy0
, cy1
;
23141 struct glyph_row
*row
;
23143 if (!w
->phys_cursor_on_p
)
23145 if (area
!= TEXT_AREA
)
23148 if (w
->phys_cursor
.vpos
< 0
23149 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23150 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23151 !(row
->enabled_p
&& row
->displays_text_p
)))
23154 if (row
->cursor_in_fringe_p
)
23156 row
->cursor_in_fringe_p
= 0;
23157 draw_fringe_bitmap (w
, row
, 0);
23158 w
->phys_cursor_on_p
= 0;
23162 cx0
= w
->phys_cursor
.x
;
23163 cx1
= cx0
+ w
->phys_cursor_width
;
23164 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23167 /* The cursor image will be completely removed from the
23168 screen if the output area intersects the cursor area in
23169 y-direction. When we draw in [y0 y1[, and some part of
23170 the cursor is at y < y0, that part must have been drawn
23171 before. When scrolling, the cursor is erased before
23172 actually scrolling, so we don't come here. When not
23173 scrolling, the rows above the old cursor row must have
23174 changed, and in this case these rows must have written
23175 over the cursor image.
23177 Likewise if part of the cursor is below y1, with the
23178 exception of the cursor being in the first blank row at
23179 the buffer and window end because update_text_area
23180 doesn't draw that row. (Except when it does, but
23181 that's handled in update_text_area.) */
23183 cy0
= w
->phys_cursor
.y
;
23184 cy1
= cy0
+ w
->phys_cursor_height
;
23185 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23188 w
->phys_cursor_on_p
= 0;
23191 #endif /* HAVE_WINDOW_SYSTEM */
23194 /************************************************************************
23196 ************************************************************************/
23198 #ifdef HAVE_WINDOW_SYSTEM
23201 Fix the display of area AREA of overlapping row ROW in window W
23202 with respect to the overlapping part OVERLAPS. */
23205 x_fix_overlapping_area (w
, row
, area
, overlaps
)
23207 struct glyph_row
*row
;
23208 enum glyph_row_area area
;
23216 for (i
= 0; i
< row
->used
[area
];)
23218 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23220 int start
= i
, start_x
= x
;
23224 x
+= row
->glyphs
[area
][i
].pixel_width
;
23227 while (i
< row
->used
[area
]
23228 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23230 draw_glyphs (w
, start_x
, row
, area
,
23232 DRAW_NORMAL_TEXT
, overlaps
);
23236 x
+= row
->glyphs
[area
][i
].pixel_width
;
23246 Draw the cursor glyph of window W in glyph row ROW. See the
23247 comment of draw_glyphs for the meaning of HL. */
23250 draw_phys_cursor_glyph (w
, row
, hl
)
23252 struct glyph_row
*row
;
23253 enum draw_glyphs_face hl
;
23255 /* If cursor hpos is out of bounds, don't draw garbage. This can
23256 happen in mini-buffer windows when switching between echo area
23257 glyphs and mini-buffer. */
23258 if (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])
23260 int on_p
= w
->phys_cursor_on_p
;
23262 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23263 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23265 w
->phys_cursor_on_p
= on_p
;
23267 if (hl
== DRAW_CURSOR
)
23268 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23269 /* When we erase the cursor, and ROW is overlapped by other
23270 rows, make sure that these overlapping parts of other rows
23272 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23274 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23276 if (row
> w
->current_matrix
->rows
23277 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23278 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23279 OVERLAPS_ERASED_CURSOR
);
23281 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23282 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23283 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23284 OVERLAPS_ERASED_CURSOR
);
23291 Erase the image of a cursor of window W from the screen. */
23294 erase_phys_cursor (w
)
23297 struct frame
*f
= XFRAME (w
->frame
);
23298 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23299 int hpos
= w
->phys_cursor
.hpos
;
23300 int vpos
= w
->phys_cursor
.vpos
;
23301 int mouse_face_here_p
= 0;
23302 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23303 struct glyph_row
*cursor_row
;
23304 struct glyph
*cursor_glyph
;
23305 enum draw_glyphs_face hl
;
23307 /* No cursor displayed or row invalidated => nothing to do on the
23309 if (w
->phys_cursor_type
== NO_CURSOR
)
23310 goto mark_cursor_off
;
23312 /* VPOS >= active_glyphs->nrows means that window has been resized.
23313 Don't bother to erase the cursor. */
23314 if (vpos
>= active_glyphs
->nrows
)
23315 goto mark_cursor_off
;
23317 /* If row containing cursor is marked invalid, there is nothing we
23319 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23320 if (!cursor_row
->enabled_p
)
23321 goto mark_cursor_off
;
23323 /* If line spacing is > 0, old cursor may only be partially visible in
23324 window after split-window. So adjust visible height. */
23325 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23326 window_text_bottom_y (w
) - cursor_row
->y
);
23328 /* If row is completely invisible, don't attempt to delete a cursor which
23329 isn't there. This can happen if cursor is at top of a window, and
23330 we switch to a buffer with a header line in that window. */
23331 if (cursor_row
->visible_height
<= 0)
23332 goto mark_cursor_off
;
23334 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23335 if (cursor_row
->cursor_in_fringe_p
)
23337 cursor_row
->cursor_in_fringe_p
= 0;
23338 draw_fringe_bitmap (w
, cursor_row
, 0);
23339 goto mark_cursor_off
;
23342 /* This can happen when the new row is shorter than the old one.
23343 In this case, either draw_glyphs or clear_end_of_line
23344 should have cleared the cursor. Note that we wouldn't be
23345 able to erase the cursor in this case because we don't have a
23346 cursor glyph at hand. */
23347 if (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])
23348 goto mark_cursor_off
;
23350 /* If the cursor is in the mouse face area, redisplay that when
23351 we clear the cursor. */
23352 if (! NILP (dpyinfo
->mouse_face_window
)
23353 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
23354 && (vpos
> dpyinfo
->mouse_face_beg_row
23355 || (vpos
== dpyinfo
->mouse_face_beg_row
23356 && hpos
>= dpyinfo
->mouse_face_beg_col
))
23357 && (vpos
< dpyinfo
->mouse_face_end_row
23358 || (vpos
== dpyinfo
->mouse_face_end_row
23359 && hpos
< dpyinfo
->mouse_face_end_col
))
23360 /* Don't redraw the cursor's spot in mouse face if it is at the
23361 end of a line (on a newline). The cursor appears there, but
23362 mouse highlighting does not. */
23363 && cursor_row
->used
[TEXT_AREA
] > hpos
)
23364 mouse_face_here_p
= 1;
23366 /* Maybe clear the display under the cursor. */
23367 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23370 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23373 cursor_glyph
= get_phys_cursor_glyph (w
);
23374 if (cursor_glyph
== NULL
)
23375 goto mark_cursor_off
;
23377 width
= cursor_glyph
->pixel_width
;
23378 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23379 x
= w
->phys_cursor
.x
;
23381 width
-= left_x
- x
;
23382 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23383 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23384 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23387 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23390 /* Erase the cursor by redrawing the character underneath it. */
23391 if (mouse_face_here_p
)
23392 hl
= DRAW_MOUSE_FACE
;
23394 hl
= DRAW_NORMAL_TEXT
;
23395 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23398 w
->phys_cursor_on_p
= 0;
23399 w
->phys_cursor_type
= NO_CURSOR
;
23404 Display or clear cursor of window W. If ON is zero, clear the
23405 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23406 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23409 display_and_set_cursor (w
, on
, hpos
, vpos
, x
, y
)
23411 int on
, hpos
, vpos
, x
, y
;
23413 struct frame
*f
= XFRAME (w
->frame
);
23414 int new_cursor_type
;
23415 int new_cursor_width
;
23417 struct glyph_row
*glyph_row
;
23418 struct glyph
*glyph
;
23420 /* This is pointless on invisible frames, and dangerous on garbaged
23421 windows and frames; in the latter case, the frame or window may
23422 be in the midst of changing its size, and x and y may be off the
23424 if (! FRAME_VISIBLE_P (f
)
23425 || FRAME_GARBAGED_P (f
)
23426 || vpos
>= w
->current_matrix
->nrows
23427 || hpos
>= w
->current_matrix
->matrix_w
)
23430 /* If cursor is off and we want it off, return quickly. */
23431 if (!on
&& !w
->phys_cursor_on_p
)
23434 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23435 /* If cursor row is not enabled, we don't really know where to
23436 display the cursor. */
23437 if (!glyph_row
->enabled_p
)
23439 w
->phys_cursor_on_p
= 0;
23444 if (!glyph_row
->exact_window_width_line_p
23445 || hpos
< glyph_row
->used
[TEXT_AREA
])
23446 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23448 xassert (interrupt_input_blocked
);
23450 /* Set new_cursor_type to the cursor we want to be displayed. */
23451 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23452 &new_cursor_width
, &active_cursor
);
23454 /* If cursor is currently being shown and we don't want it to be or
23455 it is in the wrong place, or the cursor type is not what we want,
23457 if (w
->phys_cursor_on_p
23459 || w
->phys_cursor
.x
!= x
23460 || w
->phys_cursor
.y
!= y
23461 || new_cursor_type
!= w
->phys_cursor_type
23462 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23463 && new_cursor_width
!= w
->phys_cursor_width
)))
23464 erase_phys_cursor (w
);
23466 /* Don't check phys_cursor_on_p here because that flag is only set
23467 to zero in some cases where we know that the cursor has been
23468 completely erased, to avoid the extra work of erasing the cursor
23469 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23470 still not be visible, or it has only been partly erased. */
23473 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23474 w
->phys_cursor_height
= glyph_row
->height
;
23476 /* Set phys_cursor_.* before x_draw_.* is called because some
23477 of them may need the information. */
23478 w
->phys_cursor
.x
= x
;
23479 w
->phys_cursor
.y
= glyph_row
->y
;
23480 w
->phys_cursor
.hpos
= hpos
;
23481 w
->phys_cursor
.vpos
= vpos
;
23484 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23485 new_cursor_type
, new_cursor_width
,
23486 on
, active_cursor
);
23490 /* Switch the display of W's cursor on or off, according to the value
23494 update_window_cursor (w
, on
)
23498 /* Don't update cursor in windows whose frame is in the process
23499 of being deleted. */
23500 if (w
->current_matrix
)
23503 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23504 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23510 /* Call update_window_cursor with parameter ON_P on all leaf windows
23511 in the window tree rooted at W. */
23514 update_cursor_in_window_tree (w
, on_p
)
23520 if (!NILP (w
->hchild
))
23521 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23522 else if (!NILP (w
->vchild
))
23523 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23525 update_window_cursor (w
, on_p
);
23527 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
23533 Display the cursor on window W, or clear it, according to ON_P.
23534 Don't change the cursor's position. */
23537 x_update_cursor (f
, on_p
)
23541 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
23546 Clear the cursor of window W to background color, and mark the
23547 cursor as not shown. This is used when the text where the cursor
23548 is about to be rewritten. */
23554 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
23555 update_window_cursor (w
, 0);
23560 Display the active region described by mouse_face_* according to DRAW. */
23563 show_mouse_face (dpyinfo
, draw
)
23564 Display_Info
*dpyinfo
;
23565 enum draw_glyphs_face draw
;
23567 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
23568 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23570 if (/* If window is in the process of being destroyed, don't bother
23572 w
->current_matrix
!= NULL
23573 /* Don't update mouse highlight if hidden */
23574 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
23575 /* Recognize when we are called to operate on rows that don't exist
23576 anymore. This can happen when a window is split. */
23577 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
23579 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
23580 struct glyph_row
*row
, *first
, *last
;
23582 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
23583 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
23585 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
23587 int start_hpos
, end_hpos
, start_x
;
23589 /* For all but the first row, the highlight starts at column 0. */
23592 start_hpos
= dpyinfo
->mouse_face_beg_col
;
23593 start_x
= dpyinfo
->mouse_face_beg_x
;
23602 end_hpos
= dpyinfo
->mouse_face_end_col
;
23605 end_hpos
= row
->used
[TEXT_AREA
];
23606 if (draw
== DRAW_NORMAL_TEXT
)
23607 row
->fill_line_p
= 1; /* Clear to end of line */
23610 if (end_hpos
> start_hpos
)
23612 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
23613 start_hpos
, end_hpos
,
23617 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
23621 /* When we've written over the cursor, arrange for it to
23622 be displayed again. */
23623 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
23626 display_and_set_cursor (w
, 1,
23627 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23628 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23633 /* Change the mouse cursor. */
23634 if (draw
== DRAW_NORMAL_TEXT
&& !EQ (dpyinfo
->mouse_face_window
, f
->tool_bar_window
))
23635 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
23636 else if (draw
== DRAW_MOUSE_FACE
)
23637 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
23639 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
23643 Clear out the mouse-highlighted active region.
23644 Redraw it un-highlighted first. Value is non-zero if mouse
23645 face was actually drawn unhighlighted. */
23648 clear_mouse_face (dpyinfo
)
23649 Display_Info
*dpyinfo
;
23653 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
23655 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
23659 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
23660 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
23661 dpyinfo
->mouse_face_window
= Qnil
;
23662 dpyinfo
->mouse_face_overlay
= Qnil
;
23668 Non-zero if physical cursor of window W is within mouse face. */
23671 cursor_in_mouse_face_p (w
)
23674 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
23675 int in_mouse_face
= 0;
23677 if (WINDOWP (dpyinfo
->mouse_face_window
)
23678 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
23680 int hpos
= w
->phys_cursor
.hpos
;
23681 int vpos
= w
->phys_cursor
.vpos
;
23683 if (vpos
>= dpyinfo
->mouse_face_beg_row
23684 && vpos
<= dpyinfo
->mouse_face_end_row
23685 && (vpos
> dpyinfo
->mouse_face_beg_row
23686 || hpos
>= dpyinfo
->mouse_face_beg_col
)
23687 && (vpos
< dpyinfo
->mouse_face_end_row
23688 || hpos
< dpyinfo
->mouse_face_end_col
23689 || dpyinfo
->mouse_face_past_end
))
23693 return in_mouse_face
;
23699 /* This function sets the mouse_face_* elements of DPYINFO, assuming
23700 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
23701 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
23702 for the overlay or run of text properties specifying the mouse
23703 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
23704 before-string and after-string that must also be highlighted.
23705 DISPLAY_STRING, if non-nil, is a display string that may cover some
23706 or all of the highlighted text. */
23709 mouse_face_from_buffer_pos (Lisp_Object window
,
23710 Display_Info
*dpyinfo
,
23711 EMACS_INT mouse_charpos
,
23712 EMACS_INT start_charpos
,
23713 EMACS_INT end_charpos
,
23714 Lisp_Object before_string
,
23715 Lisp_Object after_string
,
23716 Lisp_Object display_string
)
23718 struct window
*w
= XWINDOW (window
);
23719 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23720 struct glyph_row
*row
;
23721 struct glyph
*glyph
, *end
;
23725 xassert (NILP (display_string
) || STRINGP (display_string
));
23726 xassert (NILP (before_string
) || STRINGP (before_string
));
23727 xassert (NILP (after_string
) || STRINGP (after_string
));
23729 /* Find the first highlighted glyph. */
23730 if (start_charpos
< MATRIX_ROW_START_CHARPOS (first
))
23732 dpyinfo
->mouse_face_beg_col
= 0;
23733 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
23734 dpyinfo
->mouse_face_beg_x
= first
->x
;
23735 dpyinfo
->mouse_face_beg_y
= first
->y
;
23739 row
= row_containing_pos (w
, start_charpos
, first
, NULL
, 0);
23741 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23743 /* If the before-string or display-string contains newlines,
23744 row_containing_pos skips to its last row. Move back. */
23745 if (!NILP (before_string
) || !NILP (display_string
))
23747 struct glyph_row
*prev
;
23748 while ((prev
= row
- 1, prev
>= first
)
23749 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
23750 && prev
->used
[TEXT_AREA
] > 0)
23752 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
23753 glyph
= beg
+ prev
->used
[TEXT_AREA
];
23754 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
23756 || !(EQ (glyph
->object
, before_string
)
23757 || EQ (glyph
->object
, display_string
)))
23763 glyph
= row
->glyphs
[TEXT_AREA
];
23764 end
= glyph
+ row
->used
[TEXT_AREA
];
23766 dpyinfo
->mouse_face_beg_y
= row
->y
;
23767 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
23769 /* Skip truncation glyphs at the start of the glyph row. */
23770 if (row
->displays_text_p
)
23772 && INTEGERP (glyph
->object
)
23773 && glyph
->charpos
< 0;
23775 x
+= glyph
->pixel_width
;
23777 /* Scan the glyph row, stopping before BEFORE_STRING or
23778 DISPLAY_STRING or START_CHARPOS. */
23780 && !INTEGERP (glyph
->object
)
23781 && !EQ (glyph
->object
, before_string
)
23782 && !EQ (glyph
->object
, display_string
)
23783 && !(BUFFERP (glyph
->object
)
23784 && glyph
->charpos
>= start_charpos
);
23786 x
+= glyph
->pixel_width
;
23788 dpyinfo
->mouse_face_beg_x
= x
;
23789 dpyinfo
->mouse_face_beg_col
= glyph
- row
->glyphs
[TEXT_AREA
];
23792 /* Find the last highlighted glyph. */
23793 row
= row_containing_pos (w
, end_charpos
, first
, NULL
, 0);
23796 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23797 dpyinfo
->mouse_face_past_end
= 1;
23799 else if (!NILP (after_string
))
23801 /* If the after-string has newlines, advance to its last row. */
23802 struct glyph_row
*next
;
23803 struct glyph_row
*last
23804 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23806 for (next
= row
+ 1;
23808 && next
->used
[TEXT_AREA
] > 0
23809 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
23814 glyph
= row
->glyphs
[TEXT_AREA
];
23815 end
= glyph
+ row
->used
[TEXT_AREA
];
23817 dpyinfo
->mouse_face_end_y
= row
->y
;
23818 dpyinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
23820 /* Skip truncation glyphs at the start of the row. */
23821 if (row
->displays_text_p
)
23823 && INTEGERP (glyph
->object
)
23824 && glyph
->charpos
< 0;
23826 x
+= glyph
->pixel_width
;
23828 /* Scan the glyph row, stopping at END_CHARPOS or when we encounter
23831 && !INTEGERP (glyph
->object
)
23832 && !EQ (glyph
->object
, after_string
)
23833 && !(BUFFERP (glyph
->object
) && glyph
->charpos
>= end_charpos
);
23835 x
+= glyph
->pixel_width
;
23837 /* If we found AFTER_STRING, consume it and stop. */
23838 if (EQ (glyph
->object
, after_string
))
23840 for (; EQ (glyph
->object
, after_string
) && glyph
< end
; ++glyph
)
23841 x
+= glyph
->pixel_width
;
23845 /* If there's no after-string, we must check if we overshot,
23846 which might be the case if we stopped after a string glyph.
23847 That glyph may belong to a before-string or display-string
23848 associated with the end position, which must not be
23850 Lisp_Object prev_object
;
23853 while (glyph
> row
->glyphs
[TEXT_AREA
])
23855 prev_object
= (glyph
- 1)->object
;
23856 if (!STRINGP (prev_object
) || EQ (prev_object
, display_string
))
23859 pos
= string_buffer_position (w
, prev_object
, end_charpos
);
23860 if (pos
&& pos
< end_charpos
)
23863 for (; glyph
> row
->glyphs
[TEXT_AREA
]
23864 && EQ ((glyph
- 1)->object
, prev_object
);
23866 x
-= (glyph
- 1)->pixel_width
;
23870 dpyinfo
->mouse_face_end_x
= x
;
23871 dpyinfo
->mouse_face_end_col
= glyph
- row
->glyphs
[TEXT_AREA
];
23872 dpyinfo
->mouse_face_window
= window
;
23873 dpyinfo
->mouse_face_face_id
23874 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
23876 !dpyinfo
->mouse_face_hidden
, -1);
23877 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23881 /* Find the position of the glyph for position POS in OBJECT in
23882 window W's current matrix, and return in *X, *Y the pixel
23883 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
23885 RIGHT_P non-zero means return the position of the right edge of the
23886 glyph, RIGHT_P zero means return the left edge position.
23888 If no glyph for POS exists in the matrix, return the position of
23889 the glyph with the next smaller position that is in the matrix, if
23890 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
23891 exists in the matrix, return the position of the glyph with the
23892 next larger position in OBJECT.
23894 Value is non-zero if a glyph was found. */
23897 fast_find_string_pos (w
, pos
, object
, hpos
, vpos
, x
, y
, right_p
)
23900 Lisp_Object object
;
23901 int *hpos
, *vpos
, *x
, *y
;
23904 int yb
= window_text_bottom_y (w
);
23905 struct glyph_row
*r
;
23906 struct glyph
*best_glyph
= NULL
;
23907 struct glyph_row
*best_row
= NULL
;
23910 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23911 r
->enabled_p
&& r
->y
< yb
;
23914 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
23915 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
23918 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
23919 if (EQ (g
->object
, object
))
23921 if (g
->charpos
== pos
)
23928 else if (best_glyph
== NULL
23929 || ((eabs (g
->charpos
- pos
)
23930 < eabs (best_glyph
->charpos
- pos
))
23933 : g
->charpos
> pos
)))
23947 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
23951 *x
+= best_glyph
->pixel_width
;
23956 *vpos
= best_row
- w
->current_matrix
->rows
;
23959 return best_glyph
!= NULL
;
23963 /* See if position X, Y is within a hot-spot of an image. */
23966 on_hot_spot_p (hot_spot
, x
, y
)
23967 Lisp_Object hot_spot
;
23970 if (!CONSP (hot_spot
))
23973 if (EQ (XCAR (hot_spot
), Qrect
))
23975 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
23976 Lisp_Object rect
= XCDR (hot_spot
);
23980 if (!CONSP (XCAR (rect
)))
23982 if (!CONSP (XCDR (rect
)))
23984 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
23986 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
23988 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
23990 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
23994 else if (EQ (XCAR (hot_spot
), Qcircle
))
23996 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
23997 Lisp_Object circ
= XCDR (hot_spot
);
23998 Lisp_Object lr
, lx0
, ly0
;
24000 && CONSP (XCAR (circ
))
24001 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24002 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24003 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24005 double r
= XFLOATINT (lr
);
24006 double dx
= XINT (lx0
) - x
;
24007 double dy
= XINT (ly0
) - y
;
24008 return (dx
* dx
+ dy
* dy
<= r
* r
);
24011 else if (EQ (XCAR (hot_spot
), Qpoly
))
24013 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24014 if (VECTORP (XCDR (hot_spot
)))
24016 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24017 Lisp_Object
*poly
= v
->contents
;
24021 Lisp_Object lx
, ly
;
24024 /* Need an even number of coordinates, and at least 3 edges. */
24025 if (n
< 6 || n
& 1)
24028 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24029 If count is odd, we are inside polygon. Pixels on edges
24030 may or may not be included depending on actual geometry of the
24032 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24033 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24035 x0
= XINT (lx
), y0
= XINT (ly
);
24036 for (i
= 0; i
< n
; i
+= 2)
24038 int x1
= x0
, y1
= y0
;
24039 if ((lx
= poly
[i
], !INTEGERP (lx
))
24040 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24042 x0
= XINT (lx
), y0
= XINT (ly
);
24044 /* Does this segment cross the X line? */
24052 if (y
> y0
&& y
> y1
)
24054 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24064 find_hot_spot (map
, x
, y
)
24068 while (CONSP (map
))
24070 if (CONSP (XCAR (map
))
24071 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
24079 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
24081 doc
: /* Lookup in image map MAP coordinates X and Y.
24082 An image map is an alist where each element has the format (AREA ID PLIST).
24083 An AREA is specified as either a rectangle, a circle, or a polygon:
24084 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
24085 pixel coordinates of the upper left and bottom right corners.
24086 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
24087 and the radius of the circle; r may be a float or integer.
24088 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
24089 vector describes one corner in the polygon.
24090 Returns the alist element for the first matching AREA in MAP. */)
24101 return find_hot_spot (map
, XINT (x
), XINT (y
));
24105 /* Display frame CURSOR, optionally using shape defined by POINTER. */
24107 define_frame_cursor1 (f
, cursor
, pointer
)
24110 Lisp_Object pointer
;
24112 /* Do not change cursor shape while dragging mouse. */
24113 if (!NILP (do_mouse_tracking
))
24116 if (!NILP (pointer
))
24118 if (EQ (pointer
, Qarrow
))
24119 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24120 else if (EQ (pointer
, Qhand
))
24121 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
24122 else if (EQ (pointer
, Qtext
))
24123 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24124 else if (EQ (pointer
, intern ("hdrag")))
24125 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24126 #ifdef HAVE_X_WINDOWS
24127 else if (EQ (pointer
, intern ("vdrag")))
24128 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
24130 else if (EQ (pointer
, intern ("hourglass")))
24131 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
24132 else if (EQ (pointer
, Qmodeline
))
24133 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
24135 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24138 if (cursor
!= No_Cursor
)
24139 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
24142 /* Take proper action when mouse has moved to the mode or header line
24143 or marginal area AREA of window W, x-position X and y-position Y.
24144 X is relative to the start of the text display area of W, so the
24145 width of bitmap areas and scroll bars must be subtracted to get a
24146 position relative to the start of the mode line. */
24149 note_mode_line_or_margin_highlight (window
, x
, y
, area
)
24150 Lisp_Object window
;
24152 enum window_part area
;
24154 struct window
*w
= XWINDOW (window
);
24155 struct frame
*f
= XFRAME (w
->frame
);
24156 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24157 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24158 Lisp_Object pointer
= Qnil
;
24159 int charpos
, dx
, dy
, width
, height
;
24160 Lisp_Object string
, object
= Qnil
;
24161 Lisp_Object pos
, help
;
24163 Lisp_Object mouse_face
;
24164 int original_x_pixel
= x
;
24165 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
24166 struct glyph_row
*row
;
24168 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
24173 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
24174 &object
, &dx
, &dy
, &width
, &height
);
24176 row
= (area
== ON_MODE_LINE
24177 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
24178 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
24181 if (row
->mode_line_p
&& row
->enabled_p
)
24183 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
24184 end
= glyph
+ row
->used
[TEXT_AREA
];
24186 for (x0
= original_x_pixel
;
24187 glyph
< end
&& x0
>= glyph
->pixel_width
;
24189 x0
-= glyph
->pixel_width
;
24197 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
24198 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
24199 &object
, &dx
, &dy
, &width
, &height
);
24204 if (IMAGEP (object
))
24206 Lisp_Object image_map
, hotspot
;
24207 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
24209 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
24211 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24213 Lisp_Object area_id
, plist
;
24215 area_id
= XCAR (hotspot
);
24216 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24217 If so, we could look for mouse-enter, mouse-leave
24218 properties in PLIST (and do something...). */
24219 hotspot
= XCDR (hotspot
);
24220 if (CONSP (hotspot
)
24221 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24223 pointer
= Fplist_get (plist
, Qpointer
);
24224 if (NILP (pointer
))
24226 help
= Fplist_get (plist
, Qhelp_echo
);
24229 help_echo_string
= help
;
24230 /* Is this correct? ++kfs */
24231 XSETWINDOW (help_echo_window
, w
);
24232 help_echo_object
= w
->buffer
;
24233 help_echo_pos
= charpos
;
24237 if (NILP (pointer
))
24238 pointer
= Fplist_get (XCDR (object
), QCpointer
);
24241 if (STRINGP (string
))
24243 pos
= make_number (charpos
);
24244 /* If we're on a string with `help-echo' text property, arrange
24245 for the help to be displayed. This is done by setting the
24246 global variable help_echo_string to the help string. */
24249 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
24252 help_echo_string
= help
;
24253 XSETWINDOW (help_echo_window
, w
);
24254 help_echo_object
= string
;
24255 help_echo_pos
= charpos
;
24259 if (NILP (pointer
))
24260 pointer
= Fget_text_property (pos
, Qpointer
, string
);
24262 /* Change the mouse pointer according to what is under X/Y. */
24263 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
24266 map
= Fget_text_property (pos
, Qlocal_map
, string
);
24267 if (!KEYMAPP (map
))
24268 map
= Fget_text_property (pos
, Qkeymap
, string
);
24269 if (!KEYMAPP (map
))
24270 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
24273 /* Change the mouse face according to what is under X/Y. */
24274 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
24275 if (!NILP (mouse_face
)
24276 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
24281 struct glyph
* tmp_glyph
;
24285 int total_pixel_width
;
24290 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
24291 Qmouse_face
, string
, Qnil
);
24293 b
= make_number (0);
24295 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
24297 e
= make_number (SCHARS (string
));
24299 /* Calculate the position(glyph position: GPOS) of GLYPH in
24300 displayed string. GPOS is different from CHARPOS.
24302 CHARPOS is the position of glyph in internal string
24303 object. A mode line string format has structures which
24304 is converted to a flatten by emacs lisp interpreter.
24305 The internal string is an element of the structures.
24306 The displayed string is the flatten string. */
24308 if (glyph
> row_start_glyph
)
24310 tmp_glyph
= glyph
- 1;
24311 while (tmp_glyph
>= row_start_glyph
24312 && tmp_glyph
->charpos
>= XINT (b
)
24313 && EQ (tmp_glyph
->object
, glyph
->object
))
24320 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
24321 displayed string holding GLYPH.
24323 GSEQ_LENGTH is different from SCHARS (STRING).
24324 SCHARS (STRING) returns the length of the internal string. */
24325 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
24326 tmp_glyph
->charpos
< XINT (e
);
24327 tmp_glyph
++, gseq_length
++)
24329 if (!EQ (tmp_glyph
->object
, glyph
->object
))
24333 total_pixel_width
= 0;
24334 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
24335 total_pixel_width
+= tmp_glyph
->pixel_width
;
24337 /* Pre calculation of re-rendering position */
24339 hpos
= (area
== ON_MODE_LINE
24340 ? (w
->current_matrix
)->nrows
- 1
24343 /* If the re-rendering position is included in the last
24344 re-rendering area, we should do nothing. */
24345 if ( EQ (window
, dpyinfo
->mouse_face_window
)
24346 && dpyinfo
->mouse_face_beg_col
<= vpos
24347 && vpos
< dpyinfo
->mouse_face_end_col
24348 && dpyinfo
->mouse_face_beg_row
== hpos
)
24351 if (clear_mouse_face (dpyinfo
))
24352 cursor
= No_Cursor
;
24354 dpyinfo
->mouse_face_beg_col
= vpos
;
24355 dpyinfo
->mouse_face_beg_row
= hpos
;
24357 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
24358 dpyinfo
->mouse_face_beg_y
= 0;
24360 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
24361 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
24363 dpyinfo
->mouse_face_end_x
= 0;
24364 dpyinfo
->mouse_face_end_y
= 0;
24366 dpyinfo
->mouse_face_past_end
= 0;
24367 dpyinfo
->mouse_face_window
= window
;
24369 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
24372 glyph
->face_id
, 1);
24373 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24375 if (NILP (pointer
))
24378 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
24379 clear_mouse_face (dpyinfo
);
24381 define_frame_cursor1 (f
, cursor
, pointer
);
24386 Take proper action when the mouse has moved to position X, Y on
24387 frame F as regards highlighting characters that have mouse-face
24388 properties. Also de-highlighting chars where the mouse was before.
24389 X and Y can be negative or out of range. */
24392 note_mouse_highlight (f
, x
, y
)
24396 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24397 enum window_part part
;
24398 Lisp_Object window
;
24400 Cursor cursor
= No_Cursor
;
24401 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
24404 /* When a menu is active, don't highlight because this looks odd. */
24405 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
24406 if (popup_activated ())
24410 if (NILP (Vmouse_highlight
)
24411 || !f
->glyphs_initialized_p
24412 || f
->pointer_invisible
)
24415 dpyinfo
->mouse_face_mouse_x
= x
;
24416 dpyinfo
->mouse_face_mouse_y
= y
;
24417 dpyinfo
->mouse_face_mouse_frame
= f
;
24419 if (dpyinfo
->mouse_face_defer
)
24422 if (gc_in_progress
)
24424 dpyinfo
->mouse_face_deferred_gc
= 1;
24428 /* Which window is that in? */
24429 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
24431 /* If we were displaying active text in another window, clear that.
24432 Also clear if we move out of text area in same window. */
24433 if (! EQ (window
, dpyinfo
->mouse_face_window
)
24434 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
24435 && !NILP (dpyinfo
->mouse_face_window
)))
24436 clear_mouse_face (dpyinfo
);
24438 /* Not on a window -> return. */
24439 if (!WINDOWP (window
))
24442 /* Reset help_echo_string. It will get recomputed below. */
24443 help_echo_string
= Qnil
;
24445 /* Convert to window-relative pixel coordinates. */
24446 w
= XWINDOW (window
);
24447 frame_to_window_pixel_xy (w
, &x
, &y
);
24449 /* Handle tool-bar window differently since it doesn't display a
24451 if (EQ (window
, f
->tool_bar_window
))
24453 note_tool_bar_highlight (f
, x
, y
);
24457 /* Mouse is on the mode, header line or margin? */
24458 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
24459 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
24461 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
24465 if (part
== ON_VERTICAL_BORDER
)
24467 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24468 help_echo_string
= build_string ("drag-mouse-1: resize");
24470 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
24471 || part
== ON_SCROLL_BAR
)
24472 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24474 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24476 /* Are we in a window whose display is up to date?
24477 And verify the buffer's text has not changed. */
24478 b
= XBUFFER (w
->buffer
);
24479 if (part
== ON_TEXT
24480 && EQ (w
->window_end_valid
, w
->buffer
)
24481 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
24482 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
24484 int hpos
, vpos
, i
, dx
, dy
, area
;
24486 struct glyph
*glyph
;
24487 Lisp_Object object
;
24488 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
24489 Lisp_Object
*overlay_vec
= NULL
;
24491 struct buffer
*obuf
;
24492 int obegv
, ozv
, same_region
;
24494 /* Find the glyph under X/Y. */
24495 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
24497 /* Look for :pointer property on image. */
24498 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24500 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24501 if (img
!= NULL
&& IMAGEP (img
->spec
))
24503 Lisp_Object image_map
, hotspot
;
24504 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
24506 && (hotspot
= find_hot_spot (image_map
,
24507 glyph
->slice
.x
+ dx
,
24508 glyph
->slice
.y
+ dy
),
24510 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24512 Lisp_Object area_id
, plist
;
24514 area_id
= XCAR (hotspot
);
24515 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24516 If so, we could look for mouse-enter, mouse-leave
24517 properties in PLIST (and do something...). */
24518 hotspot
= XCDR (hotspot
);
24519 if (CONSP (hotspot
)
24520 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24522 pointer
= Fplist_get (plist
, Qpointer
);
24523 if (NILP (pointer
))
24525 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
24526 if (!NILP (help_echo_string
))
24528 help_echo_window
= window
;
24529 help_echo_object
= glyph
->object
;
24530 help_echo_pos
= glyph
->charpos
;
24534 if (NILP (pointer
))
24535 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
24539 /* Clear mouse face if X/Y not over text. */
24541 || area
!= TEXT_AREA
24542 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
24544 if (clear_mouse_face (dpyinfo
))
24545 cursor
= No_Cursor
;
24546 if (NILP (pointer
))
24548 if (area
!= TEXT_AREA
)
24549 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24551 pointer
= Vvoid_text_area_pointer
;
24556 pos
= glyph
->charpos
;
24557 object
= glyph
->object
;
24558 if (!STRINGP (object
) && !BUFFERP (object
))
24561 /* If we get an out-of-range value, return now; avoid an error. */
24562 if (BUFFERP (object
) && pos
> BUF_Z (b
))
24565 /* Make the window's buffer temporarily current for
24566 overlays_at and compute_char_face. */
24567 obuf
= current_buffer
;
24568 current_buffer
= b
;
24574 /* Is this char mouse-active or does it have help-echo? */
24575 position
= make_number (pos
);
24577 if (BUFFERP (object
))
24579 /* Put all the overlays we want in a vector in overlay_vec. */
24580 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
24581 /* Sort overlays into increasing priority order. */
24582 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
24587 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
24588 && vpos
>= dpyinfo
->mouse_face_beg_row
24589 && vpos
<= dpyinfo
->mouse_face_end_row
24590 && (vpos
> dpyinfo
->mouse_face_beg_row
24591 || hpos
>= dpyinfo
->mouse_face_beg_col
)
24592 && (vpos
< dpyinfo
->mouse_face_end_row
24593 || hpos
< dpyinfo
->mouse_face_end_col
24594 || dpyinfo
->mouse_face_past_end
));
24597 cursor
= No_Cursor
;
24599 /* Check mouse-face highlighting. */
24601 /* If there exists an overlay with mouse-face overlapping
24602 the one we are currently highlighting, we have to
24603 check if we enter the overlapping overlay, and then
24604 highlight only that. */
24605 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
24606 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
24608 /* Find the highest priority overlay with a mouse-face. */
24610 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
24612 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
24613 if (!NILP (mouse_face
))
24614 overlay
= overlay_vec
[i
];
24617 /* If we're highlighting the same overlay as before, there's
24618 no need to do that again. */
24619 if (!NILP (overlay
) && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
24620 goto check_help_echo
;
24621 dpyinfo
->mouse_face_overlay
= overlay
;
24623 /* Clear the display of the old active region, if any. */
24624 if (clear_mouse_face (dpyinfo
))
24625 cursor
= No_Cursor
;
24627 /* If no overlay applies, get a text property. */
24628 if (NILP (overlay
))
24629 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
24631 /* Next, compute the bounds of the mouse highlighting and
24633 if (!NILP (mouse_face
) && STRINGP (object
))
24635 /* The mouse-highlighting comes from a display string
24636 with a mouse-face. */
24640 b
= Fprevious_single_property_change
24641 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
24642 e
= Fnext_single_property_change
24643 (position
, Qmouse_face
, object
, Qnil
);
24645 b
= make_number (0);
24647 e
= make_number (SCHARS (object
) - 1);
24649 fast_find_string_pos (w
, XINT (b
), object
,
24650 &dpyinfo
->mouse_face_beg_col
,
24651 &dpyinfo
->mouse_face_beg_row
,
24652 &dpyinfo
->mouse_face_beg_x
,
24653 &dpyinfo
->mouse_face_beg_y
, 0);
24654 fast_find_string_pos (w
, XINT (e
), object
,
24655 &dpyinfo
->mouse_face_end_col
,
24656 &dpyinfo
->mouse_face_end_row
,
24657 &dpyinfo
->mouse_face_end_x
,
24658 &dpyinfo
->mouse_face_end_y
, 1);
24659 dpyinfo
->mouse_face_past_end
= 0;
24660 dpyinfo
->mouse_face_window
= window
;
24661 dpyinfo
->mouse_face_face_id
24662 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
24663 glyph
->face_id
, 1);
24664 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24665 cursor
= No_Cursor
;
24669 /* The mouse-highlighting, if any, comes from an overlay
24670 or text property in the buffer. */
24671 Lisp_Object buffer
, display_string
;
24673 if (STRINGP (object
))
24675 /* If we are on a display string with no mouse-face,
24676 check if the text under it has one. */
24677 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
24678 int start
= MATRIX_ROW_START_CHARPOS (r
);
24679 pos
= string_buffer_position (w
, object
, start
);
24682 mouse_face
= get_char_property_and_overlay
24683 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
24684 buffer
= w
->buffer
;
24685 display_string
= object
;
24691 display_string
= Qnil
;
24694 if (!NILP (mouse_face
))
24696 Lisp_Object before
, after
;
24697 Lisp_Object before_string
, after_string
;
24699 if (NILP (overlay
))
24701 /* Handle the text property case. */
24702 before
= Fprevious_single_property_change
24703 (make_number (pos
+ 1), Qmouse_face
, buffer
,
24704 Fmarker_position (w
->start
));
24705 after
= Fnext_single_property_change
24706 (make_number (pos
), Qmouse_face
, buffer
,
24707 make_number (BUF_Z (XBUFFER (buffer
))
24708 - XFASTINT (w
->window_end_pos
)));
24709 before_string
= after_string
= Qnil
;
24713 /* Handle the overlay case. */
24714 before
= Foverlay_start (overlay
);
24715 after
= Foverlay_end (overlay
);
24716 before_string
= Foverlay_get (overlay
, Qbefore_string
);
24717 after_string
= Foverlay_get (overlay
, Qafter_string
);
24719 if (!STRINGP (before_string
)) before_string
= Qnil
;
24720 if (!STRINGP (after_string
)) after_string
= Qnil
;
24723 mouse_face_from_buffer_pos (window
, dpyinfo
, pos
,
24726 before_string
, after_string
,
24728 cursor
= No_Cursor
;
24735 /* Look for a `help-echo' property. */
24736 if (NILP (help_echo_string
)) {
24737 Lisp_Object help
, overlay
;
24739 /* Check overlays first. */
24740 help
= overlay
= Qnil
;
24741 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
24743 overlay
= overlay_vec
[i
];
24744 help
= Foverlay_get (overlay
, Qhelp_echo
);
24749 help_echo_string
= help
;
24750 help_echo_window
= window
;
24751 help_echo_object
= overlay
;
24752 help_echo_pos
= pos
;
24756 Lisp_Object object
= glyph
->object
;
24757 int charpos
= glyph
->charpos
;
24759 /* Try text properties. */
24760 if (STRINGP (object
)
24762 && charpos
< SCHARS (object
))
24764 help
= Fget_text_property (make_number (charpos
),
24765 Qhelp_echo
, object
);
24768 /* If the string itself doesn't specify a help-echo,
24769 see if the buffer text ``under'' it does. */
24770 struct glyph_row
*r
24771 = MATRIX_ROW (w
->current_matrix
, vpos
);
24772 int start
= MATRIX_ROW_START_CHARPOS (r
);
24773 EMACS_INT pos
= string_buffer_position (w
, object
, start
);
24776 help
= Fget_char_property (make_number (pos
),
24777 Qhelp_echo
, w
->buffer
);
24781 object
= w
->buffer
;
24786 else if (BUFFERP (object
)
24789 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
24794 help_echo_string
= help
;
24795 help_echo_window
= window
;
24796 help_echo_object
= object
;
24797 help_echo_pos
= charpos
;
24802 /* Look for a `pointer' property. */
24803 if (NILP (pointer
))
24805 /* Check overlays first. */
24806 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
24807 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
24809 if (NILP (pointer
))
24811 Lisp_Object object
= glyph
->object
;
24812 int charpos
= glyph
->charpos
;
24814 /* Try text properties. */
24815 if (STRINGP (object
)
24817 && charpos
< SCHARS (object
))
24819 pointer
= Fget_text_property (make_number (charpos
),
24821 if (NILP (pointer
))
24823 /* If the string itself doesn't specify a pointer,
24824 see if the buffer text ``under'' it does. */
24825 struct glyph_row
*r
24826 = MATRIX_ROW (w
->current_matrix
, vpos
);
24827 int start
= MATRIX_ROW_START_CHARPOS (r
);
24828 EMACS_INT pos
= string_buffer_position (w
, object
,
24831 pointer
= Fget_char_property (make_number (pos
),
24832 Qpointer
, w
->buffer
);
24835 else if (BUFFERP (object
)
24838 pointer
= Fget_text_property (make_number (charpos
),
24845 current_buffer
= obuf
;
24850 define_frame_cursor1 (f
, cursor
, pointer
);
24855 Clear any mouse-face on window W. This function is part of the
24856 redisplay interface, and is called from try_window_id and similar
24857 functions to ensure the mouse-highlight is off. */
24860 x_clear_window_mouse_face (w
)
24863 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
24864 Lisp_Object window
;
24867 XSETWINDOW (window
, w
);
24868 if (EQ (window
, dpyinfo
->mouse_face_window
))
24869 clear_mouse_face (dpyinfo
);
24875 Just discard the mouse face information for frame F, if any.
24876 This is used when the size of F is changed. */
24879 cancel_mouse_face (f
)
24882 Lisp_Object window
;
24883 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24885 window
= dpyinfo
->mouse_face_window
;
24886 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
24888 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
24889 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
24890 dpyinfo
->mouse_face_window
= Qnil
;
24895 #endif /* HAVE_WINDOW_SYSTEM */
24898 /***********************************************************************
24900 ***********************************************************************/
24902 #ifdef HAVE_WINDOW_SYSTEM
24904 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
24905 which intersects rectangle R. R is in window-relative coordinates. */
24908 expose_area (w
, row
, r
, area
)
24910 struct glyph_row
*row
;
24912 enum glyph_row_area area
;
24914 struct glyph
*first
= row
->glyphs
[area
];
24915 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
24916 struct glyph
*last
;
24917 int first_x
, start_x
, x
;
24919 if (area
== TEXT_AREA
&& row
->fill_line_p
)
24920 /* If row extends face to end of line write the whole line. */
24921 draw_glyphs (w
, 0, row
, area
,
24922 0, row
->used
[area
],
24923 DRAW_NORMAL_TEXT
, 0);
24926 /* Set START_X to the window-relative start position for drawing glyphs of
24927 AREA. The first glyph of the text area can be partially visible.
24928 The first glyphs of other areas cannot. */
24929 start_x
= window_box_left_offset (w
, area
);
24931 if (area
== TEXT_AREA
)
24934 /* Find the first glyph that must be redrawn. */
24936 && x
+ first
->pixel_width
< r
->x
)
24938 x
+= first
->pixel_width
;
24942 /* Find the last one. */
24946 && x
< r
->x
+ r
->width
)
24948 x
+= last
->pixel_width
;
24954 draw_glyphs (w
, first_x
- start_x
, row
, area
,
24955 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
24956 DRAW_NORMAL_TEXT
, 0);
24961 /* Redraw the parts of the glyph row ROW on window W intersecting
24962 rectangle R. R is in window-relative coordinates. Value is
24963 non-zero if mouse-face was overwritten. */
24966 expose_line (w
, row
, r
)
24968 struct glyph_row
*row
;
24971 xassert (row
->enabled_p
);
24973 if (row
->mode_line_p
|| w
->pseudo_window_p
)
24974 draw_glyphs (w
, 0, row
, TEXT_AREA
,
24975 0, row
->used
[TEXT_AREA
],
24976 DRAW_NORMAL_TEXT
, 0);
24979 if (row
->used
[LEFT_MARGIN_AREA
])
24980 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
24981 if (row
->used
[TEXT_AREA
])
24982 expose_area (w
, row
, r
, TEXT_AREA
);
24983 if (row
->used
[RIGHT_MARGIN_AREA
])
24984 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
24985 draw_row_fringe_bitmaps (w
, row
);
24988 return row
->mouse_face_p
;
24992 /* Redraw those parts of glyphs rows during expose event handling that
24993 overlap other rows. Redrawing of an exposed line writes over parts
24994 of lines overlapping that exposed line; this function fixes that.
24996 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
24997 row in W's current matrix that is exposed and overlaps other rows.
24998 LAST_OVERLAPPING_ROW is the last such row. */
25001 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
, r
)
25003 struct glyph_row
*first_overlapping_row
;
25004 struct glyph_row
*last_overlapping_row
;
25007 struct glyph_row
*row
;
25009 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
25010 if (row
->overlapping_p
)
25012 xassert (row
->enabled_p
&& !row
->mode_line_p
);
25015 if (row
->used
[LEFT_MARGIN_AREA
])
25016 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
25018 if (row
->used
[TEXT_AREA
])
25019 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
25021 if (row
->used
[RIGHT_MARGIN_AREA
])
25022 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
25028 /* Return non-zero if W's cursor intersects rectangle R. */
25031 phys_cursor_in_rect_p (w
, r
)
25035 XRectangle cr
, result
;
25036 struct glyph
*cursor_glyph
;
25037 struct glyph_row
*row
;
25039 if (w
->phys_cursor
.vpos
>= 0
25040 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
25041 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
25043 && row
->cursor_in_fringe_p
)
25045 /* Cursor is in the fringe. */
25046 cr
.x
= window_box_right_offset (w
,
25047 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
25048 ? RIGHT_MARGIN_AREA
25051 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
25052 cr
.height
= row
->height
;
25053 return x_intersect_rectangles (&cr
, r
, &result
);
25056 cursor_glyph
= get_phys_cursor_glyph (w
);
25059 /* r is relative to W's box, but w->phys_cursor.x is relative
25060 to left edge of W's TEXT area. Adjust it. */
25061 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
25062 cr
.y
= w
->phys_cursor
.y
;
25063 cr
.width
= cursor_glyph
->pixel_width
;
25064 cr
.height
= w
->phys_cursor_height
;
25065 /* ++KFS: W32 version used W32-specific IntersectRect here, but
25066 I assume the effect is the same -- and this is portable. */
25067 return x_intersect_rectangles (&cr
, r
, &result
);
25069 /* If we don't understand the format, pretend we're not in the hot-spot. */
25075 Draw a vertical window border to the right of window W if W doesn't
25076 have vertical scroll bars. */
25079 x_draw_vertical_border (w
)
25082 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25084 /* We could do better, if we knew what type of scroll-bar the adjacent
25085 windows (on either side) have... But we don't :-(
25086 However, I think this works ok. ++KFS 2003-04-25 */
25088 /* Redraw borders between horizontally adjacent windows. Don't
25089 do it for frames with vertical scroll bars because either the
25090 right scroll bar of a window, or the left scroll bar of its
25091 neighbor will suffice as a border. */
25092 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
25095 if (!WINDOW_RIGHTMOST_P (w
)
25096 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (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
, x1
, y0
, y1
);
25108 else if (!WINDOW_LEFTMOST_P (w
)
25109 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
25111 int x0
, x1
, y0
, y1
;
25113 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25116 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25119 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
25124 /* Redraw the part of window W intersection rectangle FR. Pixel
25125 coordinates in FR are frame-relative. Call this function with
25126 input blocked. Value is non-zero if the exposure overwrites
25130 expose_window (w
, fr
)
25134 struct frame
*f
= XFRAME (w
->frame
);
25136 int mouse_face_overwritten_p
= 0;
25138 /* If window is not yet fully initialized, do nothing. This can
25139 happen when toolkit scroll bars are used and a window is split.
25140 Reconfiguring the scroll bar will generate an expose for a newly
25142 if (w
->current_matrix
== NULL
)
25145 /* When we're currently updating the window, display and current
25146 matrix usually don't agree. Arrange for a thorough display
25148 if (w
== updated_window
)
25150 SET_FRAME_GARBAGED (f
);
25154 /* Frame-relative pixel rectangle of W. */
25155 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
25156 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
25157 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
25158 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
25160 if (x_intersect_rectangles (fr
, &wr
, &r
))
25162 int yb
= window_text_bottom_y (w
);
25163 struct glyph_row
*row
;
25164 int cursor_cleared_p
;
25165 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
25167 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
25168 r
.x
, r
.y
, r
.width
, r
.height
));
25170 /* Convert to window coordinates. */
25171 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
25172 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
25174 /* Turn off the cursor. */
25175 if (!w
->pseudo_window_p
25176 && phys_cursor_in_rect_p (w
, &r
))
25178 x_clear_cursor (w
);
25179 cursor_cleared_p
= 1;
25182 cursor_cleared_p
= 0;
25184 /* Update lines intersecting rectangle R. */
25185 first_overlapping_row
= last_overlapping_row
= NULL
;
25186 for (row
= w
->current_matrix
->rows
;
25191 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
25193 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
25194 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
25195 || (r
.y
>= y0
&& r
.y
< y1
)
25196 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
25198 /* A header line may be overlapping, but there is no need
25199 to fix overlapping areas for them. KFS 2005-02-12 */
25200 if (row
->overlapping_p
&& !row
->mode_line_p
)
25202 if (first_overlapping_row
== NULL
)
25203 first_overlapping_row
= row
;
25204 last_overlapping_row
= row
;
25208 if (expose_line (w
, row
, &r
))
25209 mouse_face_overwritten_p
= 1;
25212 else if (row
->overlapping_p
)
25214 /* We must redraw a row overlapping the exposed area. */
25216 ? y0
+ row
->phys_height
> r
.y
25217 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
25219 if (first_overlapping_row
== NULL
)
25220 first_overlapping_row
= row
;
25221 last_overlapping_row
= row
;
25229 /* Display the mode line if there is one. */
25230 if (WINDOW_WANTS_MODELINE_P (w
)
25231 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
25233 && row
->y
< r
.y
+ r
.height
)
25235 if (expose_line (w
, row
, &r
))
25236 mouse_face_overwritten_p
= 1;
25239 if (!w
->pseudo_window_p
)
25241 /* Fix the display of overlapping rows. */
25242 if (first_overlapping_row
)
25243 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
25246 /* Draw border between windows. */
25247 x_draw_vertical_border (w
);
25249 /* Turn the cursor on again. */
25250 if (cursor_cleared_p
)
25251 update_window_cursor (w
, 1);
25255 return mouse_face_overwritten_p
;
25260 /* Redraw (parts) of all windows in the window tree rooted at W that
25261 intersect R. R contains frame pixel coordinates. Value is
25262 non-zero if the exposure overwrites mouse-face. */
25265 expose_window_tree (w
, r
)
25269 struct frame
*f
= XFRAME (w
->frame
);
25270 int mouse_face_overwritten_p
= 0;
25272 while (w
&& !FRAME_GARBAGED_P (f
))
25274 if (!NILP (w
->hchild
))
25275 mouse_face_overwritten_p
25276 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
25277 else if (!NILP (w
->vchild
))
25278 mouse_face_overwritten_p
25279 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
25281 mouse_face_overwritten_p
|= expose_window (w
, r
);
25283 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
25286 return mouse_face_overwritten_p
;
25291 Redisplay an exposed area of frame F. X and Y are the upper-left
25292 corner of the exposed rectangle. W and H are width and height of
25293 the exposed area. All are pixel values. W or H zero means redraw
25294 the entire frame. */
25297 expose_frame (f
, x
, y
, w
, h
)
25302 int mouse_face_overwritten_p
= 0;
25304 TRACE ((stderr
, "expose_frame "));
25306 /* No need to redraw if frame will be redrawn soon. */
25307 if (FRAME_GARBAGED_P (f
))
25309 TRACE ((stderr
, " garbaged\n"));
25313 /* If basic faces haven't been realized yet, there is no point in
25314 trying to redraw anything. This can happen when we get an expose
25315 event while Emacs is starting, e.g. by moving another window. */
25316 if (FRAME_FACE_CACHE (f
) == NULL
25317 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
25319 TRACE ((stderr
, " no faces\n"));
25323 if (w
== 0 || h
== 0)
25326 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
25327 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
25337 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
25338 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
25340 if (WINDOWP (f
->tool_bar_window
))
25341 mouse_face_overwritten_p
25342 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
25344 #ifdef HAVE_X_WINDOWS
25346 #ifndef USE_X_TOOLKIT
25347 if (WINDOWP (f
->menu_bar_window
))
25348 mouse_face_overwritten_p
25349 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
25350 #endif /* not USE_X_TOOLKIT */
25354 /* Some window managers support a focus-follows-mouse style with
25355 delayed raising of frames. Imagine a partially obscured frame,
25356 and moving the mouse into partially obscured mouse-face on that
25357 frame. The visible part of the mouse-face will be highlighted,
25358 then the WM raises the obscured frame. With at least one WM, KDE
25359 2.1, Emacs is not getting any event for the raising of the frame
25360 (even tried with SubstructureRedirectMask), only Expose events.
25361 These expose events will draw text normally, i.e. not
25362 highlighted. Which means we must redo the highlight here.
25363 Subsume it under ``we love X''. --gerd 2001-08-15 */
25364 /* Included in Windows version because Windows most likely does not
25365 do the right thing if any third party tool offers
25366 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
25367 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
25369 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25370 if (f
== dpyinfo
->mouse_face_mouse_frame
)
25372 int x
= dpyinfo
->mouse_face_mouse_x
;
25373 int y
= dpyinfo
->mouse_face_mouse_y
;
25374 clear_mouse_face (dpyinfo
);
25375 note_mouse_highlight (f
, x
, y
);
25382 Determine the intersection of two rectangles R1 and R2. Return
25383 the intersection in *RESULT. Value is non-zero if RESULT is not
25387 x_intersect_rectangles (r1
, r2
, result
)
25388 XRectangle
*r1
, *r2
, *result
;
25390 XRectangle
*left
, *right
;
25391 XRectangle
*upper
, *lower
;
25392 int intersection_p
= 0;
25394 /* Rearrange so that R1 is the left-most rectangle. */
25396 left
= r1
, right
= r2
;
25398 left
= r2
, right
= r1
;
25400 /* X0 of the intersection is right.x0, if this is inside R1,
25401 otherwise there is no intersection. */
25402 if (right
->x
<= left
->x
+ left
->width
)
25404 result
->x
= right
->x
;
25406 /* The right end of the intersection is the minimum of the
25407 the right ends of left and right. */
25408 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
25411 /* Same game for Y. */
25413 upper
= r1
, lower
= r2
;
25415 upper
= r2
, lower
= r1
;
25417 /* The upper end of the intersection is lower.y0, if this is inside
25418 of upper. Otherwise, there is no intersection. */
25419 if (lower
->y
<= upper
->y
+ upper
->height
)
25421 result
->y
= lower
->y
;
25423 /* The lower end of the intersection is the minimum of the lower
25424 ends of upper and lower. */
25425 result
->height
= (min (lower
->y
+ lower
->height
,
25426 upper
->y
+ upper
->height
)
25428 intersection_p
= 1;
25432 return intersection_p
;
25435 #endif /* HAVE_WINDOW_SYSTEM */
25438 /***********************************************************************
25440 ***********************************************************************/
25445 Vwith_echo_area_save_vector
= Qnil
;
25446 staticpro (&Vwith_echo_area_save_vector
);
25448 Vmessage_stack
= Qnil
;
25449 staticpro (&Vmessage_stack
);
25451 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
25452 staticpro (&Qinhibit_redisplay
);
25454 message_dolog_marker1
= Fmake_marker ();
25455 staticpro (&message_dolog_marker1
);
25456 message_dolog_marker2
= Fmake_marker ();
25457 staticpro (&message_dolog_marker2
);
25458 message_dolog_marker3
= Fmake_marker ();
25459 staticpro (&message_dolog_marker3
);
25462 defsubr (&Sdump_frame_glyph_matrix
);
25463 defsubr (&Sdump_glyph_matrix
);
25464 defsubr (&Sdump_glyph_row
);
25465 defsubr (&Sdump_tool_bar_row
);
25466 defsubr (&Strace_redisplay
);
25467 defsubr (&Strace_to_stderr
);
25469 #ifdef HAVE_WINDOW_SYSTEM
25470 defsubr (&Stool_bar_lines_needed
);
25471 defsubr (&Slookup_image_map
);
25473 defsubr (&Sformat_mode_line
);
25474 defsubr (&Sinvisible_p
);
25476 staticpro (&Qmenu_bar_update_hook
);
25477 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
25479 staticpro (&Qoverriding_terminal_local_map
);
25480 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
25482 staticpro (&Qoverriding_local_map
);
25483 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
25485 staticpro (&Qwindow_scroll_functions
);
25486 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
25488 staticpro (&Qwindow_text_change_functions
);
25489 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
25491 staticpro (&Qredisplay_end_trigger_functions
);
25492 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
25494 staticpro (&Qinhibit_point_motion_hooks
);
25495 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
25497 Qeval
= intern_c_string ("eval");
25498 staticpro (&Qeval
);
25500 QCdata
= intern_c_string (":data");
25501 staticpro (&QCdata
);
25502 Qdisplay
= intern_c_string ("display");
25503 staticpro (&Qdisplay
);
25504 Qspace_width
= intern_c_string ("space-width");
25505 staticpro (&Qspace_width
);
25506 Qraise
= intern_c_string ("raise");
25507 staticpro (&Qraise
);
25508 Qslice
= intern_c_string ("slice");
25509 staticpro (&Qslice
);
25510 Qspace
= intern_c_string ("space");
25511 staticpro (&Qspace
);
25512 Qmargin
= intern_c_string ("margin");
25513 staticpro (&Qmargin
);
25514 Qpointer
= intern_c_string ("pointer");
25515 staticpro (&Qpointer
);
25516 Qleft_margin
= intern_c_string ("left-margin");
25517 staticpro (&Qleft_margin
);
25518 Qright_margin
= intern_c_string ("right-margin");
25519 staticpro (&Qright_margin
);
25520 Qcenter
= intern_c_string ("center");
25521 staticpro (&Qcenter
);
25522 Qline_height
= intern_c_string ("line-height");
25523 staticpro (&Qline_height
);
25524 QCalign_to
= intern_c_string (":align-to");
25525 staticpro (&QCalign_to
);
25526 QCrelative_width
= intern_c_string (":relative-width");
25527 staticpro (&QCrelative_width
);
25528 QCrelative_height
= intern_c_string (":relative-height");
25529 staticpro (&QCrelative_height
);
25530 QCeval
= intern_c_string (":eval");
25531 staticpro (&QCeval
);
25532 QCpropertize
= intern_c_string (":propertize");
25533 staticpro (&QCpropertize
);
25534 QCfile
= intern_c_string (":file");
25535 staticpro (&QCfile
);
25536 Qfontified
= intern_c_string ("fontified");
25537 staticpro (&Qfontified
);
25538 Qfontification_functions
= intern_c_string ("fontification-functions");
25539 staticpro (&Qfontification_functions
);
25540 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
25541 staticpro (&Qtrailing_whitespace
);
25542 Qescape_glyph
= intern_c_string ("escape-glyph");
25543 staticpro (&Qescape_glyph
);
25544 Qnobreak_space
= intern_c_string ("nobreak-space");
25545 staticpro (&Qnobreak_space
);
25546 Qimage
= intern_c_string ("image");
25547 staticpro (&Qimage
);
25548 QCmap
= intern_c_string (":map");
25549 staticpro (&QCmap
);
25550 QCpointer
= intern_c_string (":pointer");
25551 staticpro (&QCpointer
);
25552 Qrect
= intern_c_string ("rect");
25553 staticpro (&Qrect
);
25554 Qcircle
= intern_c_string ("circle");
25555 staticpro (&Qcircle
);
25556 Qpoly
= intern_c_string ("poly");
25557 staticpro (&Qpoly
);
25558 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
25559 staticpro (&Qmessage_truncate_lines
);
25560 Qgrow_only
= intern_c_string ("grow-only");
25561 staticpro (&Qgrow_only
);
25562 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
25563 staticpro (&Qinhibit_menubar_update
);
25564 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
25565 staticpro (&Qinhibit_eval_during_redisplay
);
25566 Qposition
= intern_c_string ("position");
25567 staticpro (&Qposition
);
25568 Qbuffer_position
= intern_c_string ("buffer-position");
25569 staticpro (&Qbuffer_position
);
25570 Qobject
= intern_c_string ("object");
25571 staticpro (&Qobject
);
25572 Qbar
= intern_c_string ("bar");
25574 Qhbar
= intern_c_string ("hbar");
25575 staticpro (&Qhbar
);
25576 Qbox
= intern_c_string ("box");
25578 Qhollow
= intern_c_string ("hollow");
25579 staticpro (&Qhollow
);
25580 Qhand
= intern_c_string ("hand");
25581 staticpro (&Qhand
);
25582 Qarrow
= intern_c_string ("arrow");
25583 staticpro (&Qarrow
);
25584 Qtext
= intern_c_string ("text");
25585 staticpro (&Qtext
);
25586 Qrisky_local_variable
= intern_c_string ("risky-local-variable");
25587 staticpro (&Qrisky_local_variable
);
25588 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
25589 staticpro (&Qinhibit_free_realized_faces
);
25591 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
25592 Fcons (intern_c_string ("void-variable"), Qnil
)),
25594 staticpro (&list_of_error
);
25596 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
25597 staticpro (&Qlast_arrow_position
);
25598 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
25599 staticpro (&Qlast_arrow_string
);
25601 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
25602 staticpro (&Qoverlay_arrow_string
);
25603 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
25604 staticpro (&Qoverlay_arrow_bitmap
);
25606 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
25607 staticpro (&echo_buffer
[0]);
25608 staticpro (&echo_buffer
[1]);
25610 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
25611 staticpro (&echo_area_buffer
[0]);
25612 staticpro (&echo_area_buffer
[1]);
25614 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
25615 staticpro (&Vmessages_buffer_name
);
25617 mode_line_proptrans_alist
= Qnil
;
25618 staticpro (&mode_line_proptrans_alist
);
25619 mode_line_string_list
= Qnil
;
25620 staticpro (&mode_line_string_list
);
25621 mode_line_string_face
= Qnil
;
25622 staticpro (&mode_line_string_face
);
25623 mode_line_string_face_prop
= Qnil
;
25624 staticpro (&mode_line_string_face_prop
);
25625 Vmode_line_unwind_vector
= Qnil
;
25626 staticpro (&Vmode_line_unwind_vector
);
25628 help_echo_string
= Qnil
;
25629 staticpro (&help_echo_string
);
25630 help_echo_object
= Qnil
;
25631 staticpro (&help_echo_object
);
25632 help_echo_window
= Qnil
;
25633 staticpro (&help_echo_window
);
25634 previous_help_echo_string
= Qnil
;
25635 staticpro (&previous_help_echo_string
);
25636 help_echo_pos
= -1;
25638 Qright_to_left
= intern_c_string ("right-to-left");
25639 staticpro (&Qright_to_left
);
25640 Qleft_to_right
= intern_c_string ("left-to-right");
25641 staticpro (&Qleft_to_right
);
25643 #ifdef HAVE_WINDOW_SYSTEM
25644 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
25645 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
25646 For example, if a block cursor is over a tab, it will be drawn as
25647 wide as that tab on the display. */);
25648 x_stretch_cursor_p
= 0;
25651 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
25652 doc
: /* *Non-nil means highlight trailing whitespace.
25653 The face used for trailing whitespace is `trailing-whitespace'. */);
25654 Vshow_trailing_whitespace
= Qnil
;
25656 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
25657 doc
: /* *Control highlighting of nobreak space and soft hyphen.
25658 A value of t means highlight the character itself (for nobreak space,
25659 use face `nobreak-space').
25660 A value of nil means no highlighting.
25661 Other values mean display the escape glyph followed by an ordinary
25662 space or ordinary hyphen. */);
25663 Vnobreak_char_display
= Qt
;
25665 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
25666 doc
: /* *The pointer shape to show in void text areas.
25667 A value of nil means to show the text pointer. Other options are `arrow',
25668 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
25669 Vvoid_text_area_pointer
= Qarrow
;
25671 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
25672 doc
: /* Non-nil means don't actually do any redisplay.
25673 This is used for internal purposes. */);
25674 Vinhibit_redisplay
= Qnil
;
25676 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
25677 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
25678 Vglobal_mode_string
= Qnil
;
25680 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
25681 doc
: /* Marker for where to display an arrow on top of the buffer text.
25682 This must be the beginning of a line in order to work.
25683 See also `overlay-arrow-string'. */);
25684 Voverlay_arrow_position
= Qnil
;
25686 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
25687 doc
: /* String to display as an arrow in non-window frames.
25688 See also `overlay-arrow-position'. */);
25689 Voverlay_arrow_string
= make_pure_c_string ("=>");
25691 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
25692 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
25693 The symbols on this list are examined during redisplay to determine
25694 where to display overlay arrows. */);
25695 Voverlay_arrow_variable_list
25696 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
25698 DEFVAR_INT ("scroll-step", &scroll_step
,
25699 doc
: /* *The number of lines to try scrolling a window by when point moves out.
25700 If that fails to bring point back on frame, point is centered instead.
25701 If this is zero, point is always centered after it moves off frame.
25702 If you want scrolling to always be a line at a time, you should set
25703 `scroll-conservatively' to a large value rather than set this to 1. */);
25705 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
25706 doc
: /* *Scroll up to this many lines, to bring point back on screen.
25707 If point moves off-screen, redisplay will scroll by up to
25708 `scroll-conservatively' lines in order to bring point just barely
25709 onto the screen again. If that cannot be done, then redisplay
25710 recenters point as usual.
25712 A value of zero means always recenter point if it moves off screen. */);
25713 scroll_conservatively
= 0;
25715 DEFVAR_INT ("scroll-margin", &scroll_margin
,
25716 doc
: /* *Number of lines of margin at the top and bottom of a window.
25717 Recenter the window whenever point gets within this many lines
25718 of the top or bottom of the window. */);
25721 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
25722 doc
: /* Pixels per inch value for non-window system displays.
25723 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
25724 Vdisplay_pixels_per_inch
= make_float (72.0);
25727 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
25730 DEFVAR_LISP ("truncate-partial-width-windows",
25731 &Vtruncate_partial_width_windows
,
25732 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
25733 For an integer value, truncate lines in each window narrower than the
25734 full frame width, provided the window width is less than that integer;
25735 otherwise, respect the value of `truncate-lines'.
25737 For any other non-nil value, truncate lines in all windows that do
25738 not span the full frame width.
25740 A value of nil means to respect the value of `truncate-lines'.
25742 If `word-wrap' is enabled, you might want to reduce this. */);
25743 Vtruncate_partial_width_windows
= make_number (50);
25745 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
25746 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
25747 Any other value means to use the appropriate face, `mode-line',
25748 `header-line', or `menu' respectively. */);
25749 mode_line_inverse_video
= 1;
25751 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
25752 doc
: /* *Maximum buffer size for which line number should be displayed.
25753 If the buffer is bigger than this, the line number does not appear
25754 in the mode line. A value of nil means no limit. */);
25755 Vline_number_display_limit
= Qnil
;
25757 DEFVAR_INT ("line-number-display-limit-width",
25758 &line_number_display_limit_width
,
25759 doc
: /* *Maximum line width (in characters) for line number display.
25760 If the average length of the lines near point is bigger than this, then the
25761 line number may be omitted from the mode line. */);
25762 line_number_display_limit_width
= 200;
25764 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
25765 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
25766 highlight_nonselected_windows
= 0;
25768 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
25769 doc
: /* Non-nil if more than one frame is visible on this display.
25770 Minibuffer-only frames don't count, but iconified frames do.
25771 This variable is not guaranteed to be accurate except while processing
25772 `frame-title-format' and `icon-title-format'. */);
25774 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
25775 doc
: /* Template for displaying the title bar of visible frames.
25776 \(Assuming the window manager supports this feature.)
25778 This variable has the same structure as `mode-line-format', except that
25779 the %c and %l constructs are ignored. It is used only on frames for
25780 which no explicit name has been set \(see `modify-frame-parameters'). */);
25782 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
25783 doc
: /* Template for displaying the title bar of an iconified frame.
25784 \(Assuming the window manager supports this feature.)
25785 This variable has the same structure as `mode-line-format' (which see),
25786 and is used only on frames for which no explicit name has been set
25787 \(see `modify-frame-parameters'). */);
25789 = Vframe_title_format
25790 = pure_cons (intern_c_string ("multiple-frames"),
25791 pure_cons (make_pure_c_string ("%b"),
25792 pure_cons (pure_cons (empty_unibyte_string
,
25793 pure_cons (intern_c_string ("invocation-name"),
25794 pure_cons (make_pure_c_string ("@"),
25795 pure_cons (intern_c_string ("system-name"),
25799 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
25800 doc
: /* Maximum number of lines to keep in the message log buffer.
25801 If nil, disable message logging. If t, log messages but don't truncate
25802 the buffer when it becomes large. */);
25803 Vmessage_log_max
= make_number (100);
25805 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
25806 doc
: /* Functions called before redisplay, if window sizes have changed.
25807 The value should be a list of functions that take one argument.
25808 Just before redisplay, for each frame, if any of its windows have changed
25809 size since the last redisplay, or have been split or deleted,
25810 all the functions in the list are called, with the frame as argument. */);
25811 Vwindow_size_change_functions
= Qnil
;
25813 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
25814 doc
: /* List of functions to call before redisplaying a window with scrolling.
25815 Each function is called with two arguments, the window and its new
25816 display-start position. Note that these functions are also called by
25817 `set-window-buffer'. Also note that the value of `window-end' is not
25818 valid when these functions are called. */);
25819 Vwindow_scroll_functions
= Qnil
;
25821 DEFVAR_LISP ("window-text-change-functions",
25822 &Vwindow_text_change_functions
,
25823 doc
: /* Functions to call in redisplay when text in the window might change. */);
25824 Vwindow_text_change_functions
= Qnil
;
25826 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
25827 doc
: /* Functions called when redisplay of a window reaches the end trigger.
25828 Each function is called with two arguments, the window and the end trigger value.
25829 See `set-window-redisplay-end-trigger'. */);
25830 Vredisplay_end_trigger_functions
= Qnil
;
25832 DEFVAR_LISP ("mouse-autoselect-window", &Vmouse_autoselect_window
,
25833 doc
: /* *Non-nil means autoselect window with mouse pointer.
25834 If nil, do not autoselect windows.
25835 A positive number means delay autoselection by that many seconds: a
25836 window is autoselected only after the mouse has remained in that
25837 window for the duration of the delay.
25838 A negative number has a similar effect, but causes windows to be
25839 autoselected only after the mouse has stopped moving. \(Because of
25840 the way Emacs compares mouse events, you will occasionally wait twice
25841 that time before the window gets selected.\)
25842 Any other value means to autoselect window instantaneously when the
25843 mouse pointer enters it.
25845 Autoselection selects the minibuffer only if it is active, and never
25846 unselects the minibuffer if it is active.
25848 When customizing this variable make sure that the actual value of
25849 `focus-follows-mouse' matches the behavior of your window manager. */);
25850 Vmouse_autoselect_window
= Qnil
;
25852 DEFVAR_LISP ("auto-resize-tool-bars", &Vauto_resize_tool_bars
,
25853 doc
: /* *Non-nil means automatically resize tool-bars.
25854 This dynamically changes the tool-bar's height to the minimum height
25855 that is needed to make all tool-bar items visible.
25856 If value is `grow-only', the tool-bar's height is only increased
25857 automatically; to decrease the tool-bar height, use \\[recenter]. */);
25858 Vauto_resize_tool_bars
= Qt
;
25860 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
25861 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
25862 auto_raise_tool_bar_buttons_p
= 1;
25864 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
25865 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
25866 make_cursor_line_fully_visible_p
= 1;
25868 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
25869 doc
: /* *Border below tool-bar in pixels.
25870 If an integer, use it as the height of the border.
25871 If it is one of `internal-border-width' or `border-width', use the
25872 value of the corresponding frame parameter.
25873 Otherwise, no border is added below the tool-bar. */);
25874 Vtool_bar_border
= Qinternal_border_width
;
25876 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
25877 doc
: /* *Margin around tool-bar buttons in pixels.
25878 If an integer, use that for both horizontal and vertical margins.
25879 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
25880 HORZ specifying the horizontal margin, and VERT specifying the
25881 vertical margin. */);
25882 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
25884 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
25885 doc
: /* *Relief thickness of tool-bar buttons. */);
25886 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
25888 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
25889 doc
: /* List of functions to call to fontify regions of text.
25890 Each function is called with one argument POS. Functions must
25891 fontify a region starting at POS in the current buffer, and give
25892 fontified regions the property `fontified'. */);
25893 Vfontification_functions
= Qnil
;
25894 Fmake_variable_buffer_local (Qfontification_functions
);
25896 DEFVAR_BOOL ("unibyte-display-via-language-environment",
25897 &unibyte_display_via_language_environment
,
25898 doc
: /* *Non-nil means display unibyte text according to language environment.
25899 Specifically, this means that raw bytes in the range 160-255 decimal
25900 are displayed by converting them to the equivalent multibyte characters
25901 according to the current language environment. As a result, they are
25902 displayed according to the current fontset.
25904 Note that this variable affects only how these bytes are displayed,
25905 but does not change the fact they are interpreted as raw bytes. */);
25906 unibyte_display_via_language_environment
= 0;
25908 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
25909 doc
: /* *Maximum height for resizing mini-windows.
25910 If a float, it specifies a fraction of the mini-window frame's height.
25911 If an integer, it specifies a number of lines. */);
25912 Vmax_mini_window_height
= make_float (0.25);
25914 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
25915 doc
: /* *How to resize mini-windows.
25916 A value of nil means don't automatically resize mini-windows.
25917 A value of t means resize them to fit the text displayed in them.
25918 A value of `grow-only', the default, means let mini-windows grow
25919 only, until their display becomes empty, at which point the windows
25920 go back to their normal size. */);
25921 Vresize_mini_windows
= Qgrow_only
;
25923 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
25924 doc
: /* Alist specifying how to blink the cursor off.
25925 Each element has the form (ON-STATE . OFF-STATE). Whenever the
25926 `cursor-type' frame-parameter or variable equals ON-STATE,
25927 comparing using `equal', Emacs uses OFF-STATE to specify
25928 how to blink it off. ON-STATE and OFF-STATE are values for
25929 the `cursor-type' frame parameter.
25931 If a frame's ON-STATE has no entry in this list,
25932 the frame's other specifications determine how to blink the cursor off. */);
25933 Vblink_cursor_alist
= Qnil
;
25935 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
25936 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
25937 automatic_hscrolling_p
= 1;
25938 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
25939 staticpro (&Qauto_hscroll_mode
);
25941 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
25942 doc
: /* *How many columns away from the window edge point is allowed to get
25943 before automatic hscrolling will horizontally scroll the window. */);
25944 hscroll_margin
= 5;
25946 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
25947 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
25948 When point is less than `hscroll-margin' columns from the window
25949 edge, automatic hscrolling will scroll the window by the amount of columns
25950 determined by this variable. If its value is a positive integer, scroll that
25951 many columns. If it's a positive floating-point number, it specifies the
25952 fraction of the window's width to scroll. If it's nil or zero, point will be
25953 centered horizontally after the scroll. Any other value, including negative
25954 numbers, are treated as if the value were zero.
25956 Automatic hscrolling always moves point outside the scroll margin, so if
25957 point was more than scroll step columns inside the margin, the window will
25958 scroll more than the value given by the scroll step.
25960 Note that the lower bound for automatic hscrolling specified by `scroll-left'
25961 and `scroll-right' overrides this variable's effect. */);
25962 Vhscroll_step
= make_number (0);
25964 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
25965 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
25966 Bind this around calls to `message' to let it take effect. */);
25967 message_truncate_lines
= 0;
25969 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
25970 doc
: /* Normal hook run to update the menu bar definitions.
25971 Redisplay runs this hook before it redisplays the menu bar.
25972 This is used to update submenus such as Buffers,
25973 whose contents depend on various data. */);
25974 Vmenu_bar_update_hook
= Qnil
;
25976 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
25977 doc
: /* Frame for which we are updating a menu.
25978 The enable predicate for a menu binding should check this variable. */);
25979 Vmenu_updating_frame
= Qnil
;
25981 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
25982 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
25983 inhibit_menubar_update
= 0;
25985 DEFVAR_LISP ("wrap-prefix", &Vwrap_prefix
,
25986 doc
: /* Prefix prepended to all continuation lines at display time.
25987 The value may be a string, an image, or a stretch-glyph; it is
25988 interpreted in the same way as the value of a `display' text property.
25990 This variable is overridden by any `wrap-prefix' text or overlay
25993 To add a prefix to non-continuation lines, use `line-prefix'. */);
25994 Vwrap_prefix
= Qnil
;
25995 staticpro (&Qwrap_prefix
);
25996 Qwrap_prefix
= intern_c_string ("wrap-prefix");
25997 Fmake_variable_buffer_local (Qwrap_prefix
);
25999 DEFVAR_LISP ("line-prefix", &Vline_prefix
,
26000 doc
: /* Prefix prepended to all non-continuation lines at display time.
26001 The value may be a string, an image, or a stretch-glyph; it is
26002 interpreted in the same way as the value of a `display' text property.
26004 This variable is overridden by any `line-prefix' text or overlay
26007 To add a prefix to continuation lines, use `wrap-prefix'. */);
26008 Vline_prefix
= Qnil
;
26009 staticpro (&Qline_prefix
);
26010 Qline_prefix
= intern_c_string ("line-prefix");
26011 Fmake_variable_buffer_local (Qline_prefix
);
26013 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
26014 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
26015 inhibit_eval_during_redisplay
= 0;
26017 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
26018 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
26019 inhibit_free_realized_faces
= 0;
26022 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
26023 doc
: /* Inhibit try_window_id display optimization. */);
26024 inhibit_try_window_id
= 0;
26026 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
26027 doc
: /* Inhibit try_window_reusing display optimization. */);
26028 inhibit_try_window_reusing
= 0;
26030 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
26031 doc
: /* Inhibit try_cursor_movement display optimization. */);
26032 inhibit_try_cursor_movement
= 0;
26033 #endif /* GLYPH_DEBUG */
26035 DEFVAR_INT ("overline-margin", &overline_margin
,
26036 doc
: /* *Space between overline and text, in pixels.
26037 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
26038 margin to the caracter height. */);
26039 overline_margin
= 2;
26041 DEFVAR_INT ("underline-minimum-offset",
26042 &underline_minimum_offset
,
26043 doc
: /* Minimum distance between baseline and underline.
26044 This can improve legibility of underlined text at small font sizes,
26045 particularly when using variable `x-use-underline-position-properties'
26046 with fonts that specify an UNDERLINE_POSITION relatively close to the
26047 baseline. The default value is 1. */);
26048 underline_minimum_offset
= 1;
26050 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p
,
26051 doc
: /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
26052 display_hourglass_p
= 1;
26054 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay
,
26055 doc
: /* *Seconds to wait before displaying an hourglass pointer.
26056 Value must be an integer or float. */);
26057 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
26059 hourglass_atimer
= NULL
;
26060 hourglass_shown_p
= 0;
26064 /* Initialize this module when Emacs starts. */
26069 Lisp_Object root_window
;
26070 struct window
*mini_w
;
26072 current_header_line_height
= current_mode_line_height
= -1;
26074 CHARPOS (this_line_start_pos
) = 0;
26076 mini_w
= XWINDOW (minibuf_window
);
26077 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
26079 if (!noninteractive
)
26081 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
26084 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
26085 set_window_height (root_window
,
26086 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
26088 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
26089 set_window_height (minibuf_window
, 1, 0);
26091 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
26092 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
26094 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
26095 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
26096 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
26098 /* The default ellipsis glyphs `...'. */
26099 for (i
= 0; i
< 3; ++i
)
26100 default_invis_vector
[i
] = make_number ('.');
26104 /* Allocate the buffer for frame titles.
26105 Also used for `format-mode-line'. */
26107 mode_line_noprop_buf
= (char *) xmalloc (size
);
26108 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
26109 mode_line_noprop_ptr
= mode_line_noprop_buf
;
26110 mode_line_target
= MODE_LINE_DISPLAY
;
26113 help_echo_showing_p
= 0;
26116 /* Since w32 does not support atimers, it defines its own implementation of
26117 the following three functions in w32fns.c. */
26120 /* Platform-independent portion of hourglass implementation. */
26122 /* Return non-zero if houglass timer has been started or hourglass is shown. */
26124 hourglass_started ()
26126 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
26129 /* Cancel a currently active hourglass timer, and start a new one. */
26133 #if defined (HAVE_WINDOW_SYSTEM)
26135 int secs
, usecs
= 0;
26137 cancel_hourglass ();
26139 if (INTEGERP (Vhourglass_delay
)
26140 && XINT (Vhourglass_delay
) > 0)
26141 secs
= XFASTINT (Vhourglass_delay
);
26142 else if (FLOATP (Vhourglass_delay
)
26143 && XFLOAT_DATA (Vhourglass_delay
) > 0)
26146 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
26147 secs
= XFASTINT (tem
);
26148 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
26151 secs
= DEFAULT_HOURGLASS_DELAY
;
26153 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
26154 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
26155 show_hourglass
, NULL
);
26160 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
26163 cancel_hourglass ()
26165 #if defined (HAVE_WINDOW_SYSTEM)
26166 if (hourglass_atimer
)
26168 cancel_atimer (hourglass_atimer
);
26169 hourglass_atimer
= NULL
;
26172 if (hourglass_shown_p
)
26176 #endif /* ! WINDOWSNT */
26178 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
26179 (do not change this comment) */