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 /* A glyph beyond the edge of TEXT_AREA which we should never
12558 struct glyph
*glyphs_end
= end
;
12559 /* Non-zero means we've found a match for cursor position, but that
12560 glyph has the avoid_cursor_p flag set. */
12561 int match_with_avoid_cursor
= 0;
12562 /* Non-zero means we've seen at least one glyph that came from a
12564 int string_seen
= 0;
12565 /* Largest buffer position seen so far during scan of glyph row. */
12566 EMACS_INT bpos_max
= last_pos
;
12567 /* Last buffer position covered by an overlay string with an integer
12568 `cursor' property. */
12569 EMACS_INT bpos_covered
= 0;
12571 /* Skip over glyphs not having an object at the start and the end of
12572 the row. These are special glyphs like truncation marks on
12573 terminal frames. */
12574 if (row
->displays_text_p
)
12576 if (!row
->reversed_p
)
12579 && INTEGERP (glyph
->object
)
12580 && glyph
->charpos
< 0)
12582 x
+= glyph
->pixel_width
;
12586 && INTEGERP ((end
- 1)->object
)
12587 /* CHARPOS is zero for blanks inserted by
12588 extend_face_to_end_of_line. */
12589 && (end
- 1)->charpos
<= 0)
12591 glyph_before
= glyph
- 1;
12598 /* If the glyph row is reversed, we need to process it from back
12599 to front, so swap the edge pointers. */
12600 glyphs_end
= end
= glyph
- 1;
12601 glyph
+= row
->used
[TEXT_AREA
] - 1;
12602 /* Reverse the known positions in the row. */
12603 last_pos
= pos_after
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12604 pos_before
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12606 while (glyph
> end
+ 1
12607 && INTEGERP (glyph
->object
)
12608 && glyph
->charpos
< 0)
12611 x
-= glyph
->pixel_width
;
12613 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12615 /* By default, in reversed rows we put the cursor on the
12616 rightmost (first in the reading order) glyph. */
12617 for (g
= end
+ 1; g
< glyph
; g
++)
12618 x
+= g
->pixel_width
;
12621 && INTEGERP ((end
+ 1)->object
)
12622 && (end
+ 1)->charpos
<= 0)
12624 glyph_before
= glyph
+ 1;
12628 else if (row
->reversed_p
)
12630 /* In R2L rows that don't display text, put the cursor on the
12631 rightmost glyph. Case in point: an empty last line that is
12632 part of an R2L paragraph. */
12634 x
= -1; /* will be computed below, at lable compute_x */
12637 /* Step 1: Try to find the glyph whose character position
12638 corresponds to point. If that's not possible, find 2 glyphs
12639 whose character positions are the closest to point, one before
12640 point, the other after it. */
12641 if (!row
->reversed_p
)
12642 while (/* not marched to end of glyph row */
12644 /* glyph was not inserted by redisplay for internal purposes */
12645 && !INTEGERP (glyph
->object
))
12647 if (BUFFERP (glyph
->object
))
12649 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12651 if (glyph
->charpos
> bpos_max
)
12652 bpos_max
= glyph
->charpos
;
12653 if (!glyph
->avoid_cursor_p
)
12655 /* If we hit point, we've found the glyph on which to
12656 display the cursor. */
12659 match_with_avoid_cursor
= 0;
12662 /* See if we've found a better approximation to
12663 POS_BEFORE or to POS_AFTER. Note that we want the
12664 first (leftmost) glyph of all those that are the
12665 closest from below, and the last (rightmost) of all
12666 those from above. */
12667 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12669 pos_before
= glyph
->charpos
;
12670 glyph_before
= glyph
;
12672 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12674 pos_after
= glyph
->charpos
;
12675 glyph_after
= glyph
;
12678 else if (dpos
== 0)
12679 match_with_avoid_cursor
= 1;
12681 else if (STRINGP (glyph
->object
))
12683 Lisp_Object chprop
;
12684 int glyph_pos
= glyph
->charpos
;
12686 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12688 if (INTEGERP (chprop
))
12690 bpos_covered
= bpos_max
+ XINT (chprop
);
12691 /* If the `cursor' property covers buffer positions up
12692 to and including point, we should display cursor on
12693 this glyph. Note that overlays and text properties
12694 with string values stop bidi reordering, so every
12695 buffer position to the left of the string is always
12696 smaller than any position to the right of the
12697 string. Therefore, if a `cursor' property on one
12698 of the string's characters has an integer value, we
12699 will break out of the loop below _before_ we get to
12700 the position match above. IOW, integer values of
12701 the `cursor' property override the "exact match for
12702 point" strategy of positioning the cursor. */
12703 /* Implementation note: bpos_max == pt_old when, e.g.,
12704 we are in an empty line, where bpos_max is set to
12705 MATRIX_ROW_START_CHARPOS, see above. */
12706 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12715 x
+= glyph
->pixel_width
;
12718 else if (glyph
> end
) /* row is reversed */
12719 while (!INTEGERP (glyph
->object
))
12721 if (BUFFERP (glyph
->object
))
12723 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12725 if (glyph
->charpos
> bpos_max
)
12726 bpos_max
= glyph
->charpos
;
12727 if (!glyph
->avoid_cursor_p
)
12731 match_with_avoid_cursor
= 0;
12734 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12736 pos_before
= glyph
->charpos
;
12737 glyph_before
= glyph
;
12739 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12741 pos_after
= glyph
->charpos
;
12742 glyph_after
= glyph
;
12745 else if (dpos
== 0)
12746 match_with_avoid_cursor
= 1;
12748 else if (STRINGP (glyph
->object
))
12750 Lisp_Object chprop
;
12751 int glyph_pos
= glyph
->charpos
;
12753 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12755 if (INTEGERP (chprop
))
12757 bpos_covered
= bpos_max
+ XINT (chprop
);
12758 /* If the `cursor' property covers buffer positions up
12759 to and including point, we should display cursor on
12761 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12772 x
-= glyph
->pixel_width
;
12775 /* Step 2: If we didn't find an exact match for point, we need to
12776 look for a proper place to put the cursor among glyphs between
12777 GLYPH_BEFORE and GLYPH_AFTER. */
12778 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12779 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12780 && bpos_covered
< pt_old
)
12782 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12784 EMACS_INT ellipsis_pos
;
12786 /* Scan back over the ellipsis glyphs. */
12787 if (!row
->reversed_p
)
12789 ellipsis_pos
= (glyph
- 1)->charpos
;
12790 while (glyph
> row
->glyphs
[TEXT_AREA
]
12791 && (glyph
- 1)->charpos
== ellipsis_pos
)
12792 glyph
--, x
-= glyph
->pixel_width
;
12793 /* That loop always goes one position too far, including
12794 the glyph before the ellipsis. So scan forward over
12796 x
+= glyph
->pixel_width
;
12799 else /* row is reversed */
12801 ellipsis_pos
= (glyph
+ 1)->charpos
;
12802 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12803 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12804 glyph
++, x
+= glyph
->pixel_width
;
12805 x
-= glyph
->pixel_width
;
12809 else if (match_with_avoid_cursor
12810 /* zero-width characters produce no glyphs */
12811 || eabs (glyph_after
- glyph_before
) == 1)
12813 cursor
= glyph_after
;
12816 else if (string_seen
)
12818 int incr
= row
->reversed_p
? -1 : +1;
12820 /* Need to find the glyph that came out of a string which is
12821 present at point. That glyph is somewhere between
12822 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12823 positioned between POS_BEFORE and POS_AFTER in the
12825 struct glyph
*stop
= glyph_after
;
12826 EMACS_INT pos
= pos_before
;
12829 for (glyph
= glyph_before
+ incr
;
12830 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12833 /* Any glyphs that come from the buffer are here because
12834 of bidi reordering. Skip them, and only pay
12835 attention to glyphs that came from some string. */
12836 if (STRINGP (glyph
->object
))
12841 str
= glyph
->object
;
12842 tem
= string_buffer_position_lim (w
, str
, pos
, pos_after
, 0);
12843 if (tem
== 0 /* from overlay */
12846 /* If the string from which this glyph came is
12847 found in the buffer at point, then we've
12848 found the glyph we've been looking for. If
12849 it comes from an overlay (tem == 0), and it
12850 has the `cursor' property on one of its
12851 glyphs, record that glyph as a candidate for
12852 displaying the cursor. (As in the
12853 unidirectional version, we will display the
12854 cursor on the last candidate we find.) */
12855 if (tem
== 0 || tem
== pt_old
)
12857 /* The glyphs from this string could have
12858 been reordered. Find the one with the
12859 smallest string position. Or there could
12860 be a character in the string with the
12861 `cursor' property, which means display
12862 cursor on that character's glyph. */
12863 int strpos
= glyph
->charpos
;
12866 for (glyph
+= incr
;
12867 EQ (glyph
->object
, str
);
12871 int gpos
= glyph
->charpos
;
12873 cprop
= Fget_char_property (make_number (gpos
),
12881 if (glyph
->charpos
< strpos
)
12883 strpos
= glyph
->charpos
;
12892 pos
= tem
+ 1; /* don't find previous instances */
12894 /* This string is not what we want; skip all of the
12895 glyphs that came from it. */
12898 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12899 && EQ (glyph
->object
, str
));
12905 /* If we reached the end of the line, and END was from a string,
12906 the cursor is not on this line. */
12908 && STRINGP ((glyph
- incr
)->object
)
12909 && row
->continued_p
)
12915 if (cursor
!= NULL
)
12921 /* Need to compute x that corresponds to GLYPH. */
12922 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
12924 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
12926 x
+= g
->pixel_width
;
12930 /* ROW could be part of a continued line, which might have other
12931 rows whose start and end charpos occlude point. Only set
12932 w->cursor if we found a better approximation to the cursor
12933 position than we have from previously examined rows. */
12934 if (w
->cursor
.vpos
>= 0
12935 /* Make sure cursor.vpos specifies a row whose start and end
12936 charpos occlude point. This is because some callers of this
12937 function leave cursor.vpos at the row where the cursor was
12938 displayed during the last redisplay cycle. */
12939 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
12940 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
12943 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
12945 /* Don't consider glyphs that are outside TEXT_AREA. */
12946 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
12948 /* Keep the candidate whose buffer position is the closest to
12950 if (/* previous candidate is a glyph in TEXT_AREA of that row */
12951 w
->cursor
.hpos
>= 0
12952 && w
->cursor
.hpos
< MATRIX_ROW_USED(matrix
, w
->cursor
.vpos
)
12953 && BUFFERP (g1
->object
)
12954 && (g1
->charpos
== pt_old
/* an exact match always wins */
12955 || (BUFFERP (glyph
->object
)
12956 && eabs (g1
->charpos
- pt_old
)
12957 < eabs (glyph
->charpos
- pt_old
))))
12959 /* If this candidate gives an exact match, use that. */
12960 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12961 /* Otherwise, keep the candidate that comes from a row
12962 spanning less buffer positions. This may win when one or
12963 both candidate positions are on glyphs that came from
12964 display strings, for which we cannot compare buffer
12966 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12967 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12968 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
12971 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12973 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12974 w
->cursor
.y
= row
->y
+ dy
;
12976 if (w
== XWINDOW (selected_window
))
12978 if (!row
->continued_p
12979 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12982 this_line_buffer
= XBUFFER (w
->buffer
);
12984 CHARPOS (this_line_start_pos
)
12985 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12986 BYTEPOS (this_line_start_pos
)
12987 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12989 CHARPOS (this_line_end_pos
)
12990 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12991 BYTEPOS (this_line_end_pos
)
12992 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12994 this_line_y
= w
->cursor
.y
;
12995 this_line_pixel_height
= row
->height
;
12996 this_line_vpos
= w
->cursor
.vpos
;
12997 this_line_start_x
= row
->x
;
13000 CHARPOS (this_line_start_pos
) = 0;
13007 /* Run window scroll functions, if any, for WINDOW with new window
13008 start STARTP. Sets the window start of WINDOW to that position.
13010 We assume that the window's buffer is really current. */
13012 static INLINE
struct text_pos
13013 run_window_scroll_functions (window
, startp
)
13014 Lisp_Object window
;
13015 struct text_pos startp
;
13017 struct window
*w
= XWINDOW (window
);
13018 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
13020 if (current_buffer
!= XBUFFER (w
->buffer
))
13023 if (!NILP (Vwindow_scroll_functions
))
13025 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
13026 make_number (CHARPOS (startp
)));
13027 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13028 /* In case the hook functions switch buffers. */
13029 if (current_buffer
!= XBUFFER (w
->buffer
))
13030 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13037 /* Make sure the line containing the cursor is fully visible.
13038 A value of 1 means there is nothing to be done.
13039 (Either the line is fully visible, or it cannot be made so,
13040 or we cannot tell.)
13042 If FORCE_P is non-zero, return 0 even if partial visible cursor row
13043 is higher than window.
13045 A value of 0 means the caller should do scrolling
13046 as if point had gone off the screen. */
13049 cursor_row_fully_visible_p (w
, force_p
, current_matrix_p
)
13052 int current_matrix_p
;
13054 struct glyph_matrix
*matrix
;
13055 struct glyph_row
*row
;
13058 if (!make_cursor_line_fully_visible_p
)
13061 /* It's not always possible to find the cursor, e.g, when a window
13062 is full of overlay strings. Don't do anything in that case. */
13063 if (w
->cursor
.vpos
< 0)
13066 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13067 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13069 /* If the cursor row is not partially visible, there's nothing to do. */
13070 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13073 /* If the row the cursor is in is taller than the window's height,
13074 it's not clear what to do, so do nothing. */
13075 window_height
= window_box_height (w
);
13076 if (row
->height
>= window_height
)
13078 if (!force_p
|| MINI_WINDOW_P (w
)
13079 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13086 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13087 non-zero means only WINDOW is redisplayed in redisplay_internal.
13088 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
13089 in redisplay_window to bring a partially visible line into view in
13090 the case that only the cursor has moved.
13092 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13093 last screen line's vertical height extends past the end of the screen.
13097 1 if scrolling succeeded
13099 0 if scrolling didn't find point.
13101 -1 if new fonts have been loaded so that we must interrupt
13102 redisplay, adjust glyph matrices, and try again. */
13108 SCROLLING_NEED_LARGER_MATRICES
13112 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
13113 scroll_step
, temp_scroll_step
, last_line_misfit
)
13114 Lisp_Object window
;
13115 int just_this_one_p
;
13116 EMACS_INT scroll_conservatively
, scroll_step
;
13117 int temp_scroll_step
;
13118 int last_line_misfit
;
13120 struct window
*w
= XWINDOW (window
);
13121 struct frame
*f
= XFRAME (w
->frame
);
13122 struct text_pos pos
, startp
;
13124 int this_scroll_margin
, scroll_max
, rc
, height
;
13125 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13126 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13127 Lisp_Object aggressive
;
13128 int scroll_limit
= INT_MAX
/ FRAME_LINE_HEIGHT (f
);
13131 debug_method_add (w
, "try_scrolling");
13134 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13136 /* Compute scroll margin height in pixels. We scroll when point is
13137 within this distance from the top or bottom of the window. */
13138 if (scroll_margin
> 0)
13139 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13140 * FRAME_LINE_HEIGHT (f
);
13142 this_scroll_margin
= 0;
13144 /* Force scroll_conservatively to have a reasonable value, to avoid
13145 overflow while computing how much to scroll. Note that the user
13146 can supply scroll-conservatively equal to `most-positive-fixnum',
13147 which can be larger than INT_MAX. */
13148 if (scroll_conservatively
> scroll_limit
)
13150 scroll_conservatively
= scroll_limit
;
13151 scroll_max
= INT_MAX
;
13153 else if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
13154 /* Compute how much we should try to scroll maximally to bring
13155 point into view. */
13156 scroll_max
= (max (scroll_step
,
13157 max (scroll_conservatively
, temp_scroll_step
))
13158 * FRAME_LINE_HEIGHT (f
));
13159 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
13160 || NUMBERP (current_buffer
->scroll_up_aggressively
))
13161 /* We're trying to scroll because of aggressive scrolling but no
13162 scroll_step is set. Choose an arbitrary one. */
13163 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13169 /* Decide whether to scroll down. */
13170 if (PT
> CHARPOS (startp
))
13172 int scroll_margin_y
;
13174 /* Compute the pixel ypos of the scroll margin, then move it to
13175 either that ypos or PT, whichever comes first. */
13176 start_display (&it
, w
, startp
);
13177 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13178 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13179 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13180 (MOVE_TO_POS
| MOVE_TO_Y
));
13182 if (PT
> CHARPOS (it
.current
.pos
))
13184 int y0
= line_bottom_y (&it
);
13186 /* Compute the distance from the scroll margin to PT
13187 (including the height of the cursor line). Moving the
13188 iterator unconditionally to PT can be slow if PT is far
13189 away, so stop 10 lines past the window bottom (is there a
13190 way to do the right thing quickly?). */
13191 move_it_to (&it
, PT
, -1,
13192 it
.last_visible_y
+ 10 * FRAME_LINE_HEIGHT (f
),
13193 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13194 dy
= line_bottom_y (&it
) - y0
;
13196 if (dy
> scroll_max
)
13197 return SCROLLING_FAILED
;
13205 /* Point is in or below the bottom scroll margin, so move the
13206 window start down. If scrolling conservatively, move it just
13207 enough down to make point visible. If scroll_step is set,
13208 move it down by scroll_step. */
13209 if (scroll_conservatively
)
13211 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13212 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
13213 else if (scroll_step
|| temp_scroll_step
)
13214 amount_to_scroll
= scroll_max
;
13217 aggressive
= current_buffer
->scroll_up_aggressively
;
13218 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13219 if (NUMBERP (aggressive
))
13221 double float_amount
= XFLOATINT (aggressive
) * height
;
13222 amount_to_scroll
= float_amount
;
13223 if (amount_to_scroll
== 0 && float_amount
> 0)
13224 amount_to_scroll
= 1;
13228 if (amount_to_scroll
<= 0)
13229 return SCROLLING_FAILED
;
13231 start_display (&it
, w
, startp
);
13232 move_it_vertically (&it
, amount_to_scroll
);
13234 /* If STARTP is unchanged, move it down another screen line. */
13235 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13236 move_it_by_lines (&it
, 1, 1);
13237 startp
= it
.current
.pos
;
13241 struct text_pos scroll_margin_pos
= startp
;
13243 /* See if point is inside the scroll margin at the top of the
13245 if (this_scroll_margin
)
13247 start_display (&it
, w
, startp
);
13248 move_it_vertically (&it
, this_scroll_margin
);
13249 scroll_margin_pos
= it
.current
.pos
;
13252 if (PT
< CHARPOS (scroll_margin_pos
))
13254 /* Point is in the scroll margin at the top of the window or
13255 above what is displayed in the window. */
13258 /* Compute the vertical distance from PT to the scroll
13259 margin position. Give up if distance is greater than
13261 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13262 start_display (&it
, w
, pos
);
13264 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13265 it
.last_visible_y
, -1,
13266 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13267 dy
= it
.current_y
- y0
;
13268 if (dy
> scroll_max
)
13269 return SCROLLING_FAILED
;
13271 /* Compute new window start. */
13272 start_display (&it
, w
, startp
);
13274 if (scroll_conservatively
)
13276 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
13277 else if (scroll_step
|| temp_scroll_step
)
13278 amount_to_scroll
= scroll_max
;
13281 aggressive
= current_buffer
->scroll_down_aggressively
;
13282 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13283 if (NUMBERP (aggressive
))
13285 double float_amount
= XFLOATINT (aggressive
) * height
;
13286 amount_to_scroll
= float_amount
;
13287 if (amount_to_scroll
== 0 && float_amount
> 0)
13288 amount_to_scroll
= 1;
13292 if (amount_to_scroll
<= 0)
13293 return SCROLLING_FAILED
;
13295 move_it_vertically_backward (&it
, amount_to_scroll
);
13296 startp
= it
.current
.pos
;
13300 /* Run window scroll functions. */
13301 startp
= run_window_scroll_functions (window
, startp
);
13303 /* Display the window. Give up if new fonts are loaded, or if point
13305 if (!try_window (window
, startp
, 0))
13306 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13307 else if (w
->cursor
.vpos
< 0)
13309 clear_glyph_matrix (w
->desired_matrix
);
13310 rc
= SCROLLING_FAILED
;
13314 /* Maybe forget recorded base line for line number display. */
13315 if (!just_this_one_p
13316 || current_buffer
->clip_changed
13317 || BEG_UNCHANGED
< CHARPOS (startp
))
13318 w
->base_line_number
= Qnil
;
13320 /* If cursor ends up on a partially visible line,
13321 treat that as being off the bottom of the screen. */
13322 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
13324 clear_glyph_matrix (w
->desired_matrix
);
13325 ++extra_scroll_margin_lines
;
13328 rc
= SCROLLING_SUCCESS
;
13335 /* Compute a suitable window start for window W if display of W starts
13336 on a continuation line. Value is non-zero if a new window start
13339 The new window start will be computed, based on W's width, starting
13340 from the start of the continued line. It is the start of the
13341 screen line with the minimum distance from the old start W->start. */
13344 compute_window_start_on_continuation_line (w
)
13347 struct text_pos pos
, start_pos
;
13348 int window_start_changed_p
= 0;
13350 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13352 /* If window start is on a continuation line... Window start may be
13353 < BEGV in case there's invisible text at the start of the
13354 buffer (M-x rmail, for example). */
13355 if (CHARPOS (start_pos
) > BEGV
13356 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13359 struct glyph_row
*row
;
13361 /* Handle the case that the window start is out of range. */
13362 if (CHARPOS (start_pos
) < BEGV
)
13363 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13364 else if (CHARPOS (start_pos
) > ZV
)
13365 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13367 /* Find the start of the continued line. This should be fast
13368 because scan_buffer is fast (newline cache). */
13369 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13370 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13371 row
, DEFAULT_FACE_ID
);
13372 reseat_at_previous_visible_line_start (&it
);
13374 /* If the line start is "too far" away from the window start,
13375 say it takes too much time to compute a new window start. */
13376 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13377 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13379 int min_distance
, distance
;
13381 /* Move forward by display lines to find the new window
13382 start. If window width was enlarged, the new start can
13383 be expected to be > the old start. If window width was
13384 decreased, the new window start will be < the old start.
13385 So, we're looking for the display line start with the
13386 minimum distance from the old window start. */
13387 pos
= it
.current
.pos
;
13388 min_distance
= INFINITY
;
13389 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13390 distance
< min_distance
)
13392 min_distance
= distance
;
13393 pos
= it
.current
.pos
;
13394 move_it_by_lines (&it
, 1, 0);
13397 /* Set the window start there. */
13398 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13399 window_start_changed_p
= 1;
13403 return window_start_changed_p
;
13407 /* Try cursor movement in case text has not changed in window WINDOW,
13408 with window start STARTP. Value is
13410 CURSOR_MOVEMENT_SUCCESS if successful
13412 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13414 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13415 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13416 we want to scroll as if scroll-step were set to 1. See the code.
13418 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13419 which case we have to abort this redisplay, and adjust matrices
13424 CURSOR_MOVEMENT_SUCCESS
,
13425 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13426 CURSOR_MOVEMENT_MUST_SCROLL
,
13427 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13431 try_cursor_movement (window
, startp
, scroll_step
)
13432 Lisp_Object window
;
13433 struct text_pos startp
;
13436 struct window
*w
= XWINDOW (window
);
13437 struct frame
*f
= XFRAME (w
->frame
);
13438 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13441 if (inhibit_try_cursor_movement
)
13445 /* Handle case where text has not changed, only point, and it has
13446 not moved off the frame. */
13447 if (/* Point may be in this window. */
13448 PT
>= CHARPOS (startp
)
13449 /* Selective display hasn't changed. */
13450 && !current_buffer
->clip_changed
13451 /* Function force-mode-line-update is used to force a thorough
13452 redisplay. It sets either windows_or_buffers_changed or
13453 update_mode_lines. So don't take a shortcut here for these
13455 && !update_mode_lines
13456 && !windows_or_buffers_changed
13457 && !cursor_type_changed
13458 /* Can't use this case if highlighting a region. When a
13459 region exists, cursor movement has to do more than just
13461 && !(!NILP (Vtransient_mark_mode
)
13462 && !NILP (current_buffer
->mark_active
))
13463 && NILP (w
->region_showing
)
13464 && NILP (Vshow_trailing_whitespace
)
13465 /* Right after splitting windows, last_point may be nil. */
13466 && INTEGERP (w
->last_point
)
13467 /* This code is not used for mini-buffer for the sake of the case
13468 of redisplaying to replace an echo area message; since in
13469 that case the mini-buffer contents per se are usually
13470 unchanged. This code is of no real use in the mini-buffer
13471 since the handling of this_line_start_pos, etc., in redisplay
13472 handles the same cases. */
13473 && !EQ (window
, minibuf_window
)
13474 /* When splitting windows or for new windows, it happens that
13475 redisplay is called with a nil window_end_vpos or one being
13476 larger than the window. This should really be fixed in
13477 window.c. I don't have this on my list, now, so we do
13478 approximately the same as the old redisplay code. --gerd. */
13479 && INTEGERP (w
->window_end_vpos
)
13480 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13481 && (FRAME_WINDOW_P (f
)
13482 || !overlay_arrow_in_current_buffer_p ()))
13484 int this_scroll_margin
, top_scroll_margin
;
13485 struct glyph_row
*row
= NULL
;
13488 debug_method_add (w
, "cursor movement");
13491 /* Scroll if point within this distance from the top or bottom
13492 of the window. This is a pixel value. */
13493 if (scroll_margin
> 0)
13495 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13496 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13499 this_scroll_margin
= 0;
13501 top_scroll_margin
= this_scroll_margin
;
13502 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13503 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13505 /* Start with the row the cursor was displayed during the last
13506 not paused redisplay. Give up if that row is not valid. */
13507 if (w
->last_cursor
.vpos
< 0
13508 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13509 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13512 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13513 if (row
->mode_line_p
)
13515 if (!row
->enabled_p
)
13516 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13517 /* If rows are bidi-reordered, back up until we find a row
13518 that does not belong to a continuation line. This is
13519 because we must consider all rows of a continued line as
13520 candidates for cursor positioning, since row start and
13521 end positions change non-linearly with vertical position
13523 /* FIXME: Revisit this when glyph ``spilling'' in
13524 continuation lines' rows is implemented for
13525 bidi-reordered rows. */
13526 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13528 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13530 xassert (row
->enabled_p
);
13532 /* If we hit the beginning of the displayed portion
13533 without finding the first row of a continued
13535 if (row
<= w
->current_matrix
->rows
)
13537 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13545 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13548 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13550 if (PT
> XFASTINT (w
->last_point
))
13552 /* Point has moved forward. */
13553 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13554 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13556 xassert (row
->enabled_p
);
13560 /* The end position of a row equals the start position
13561 of the next row. If PT is there, we would rather
13562 display it in the next line. */
13563 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13564 && MATRIX_ROW_END_CHARPOS (row
) == PT
13565 && !cursor_row_p (w
, row
))
13568 /* If within the scroll margin, scroll. Note that
13569 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13570 the next line would be drawn, and that
13571 this_scroll_margin can be zero. */
13572 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13573 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13574 /* Line is completely visible last line in window
13575 and PT is to be set in the next line. */
13576 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13577 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13578 && !row
->ends_at_zv_p
13579 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13582 else if (PT
< XFASTINT (w
->last_point
))
13584 /* Cursor has to be moved backward. Note that PT >=
13585 CHARPOS (startp) because of the outer if-statement. */
13586 while (!row
->mode_line_p
13587 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13588 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13589 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13590 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13591 row
> w
->current_matrix
->rows
13592 && (row
-1)->ends_in_newline_from_string_p
))))
13593 && (row
->y
> top_scroll_margin
13594 || CHARPOS (startp
) == BEGV
))
13596 xassert (row
->enabled_p
);
13600 /* Consider the following case: Window starts at BEGV,
13601 there is invisible, intangible text at BEGV, so that
13602 display starts at some point START > BEGV. It can
13603 happen that we are called with PT somewhere between
13604 BEGV and START. Try to handle that case. */
13605 if (row
< w
->current_matrix
->rows
13606 || row
->mode_line_p
)
13608 row
= w
->current_matrix
->rows
;
13609 if (row
->mode_line_p
)
13613 /* Due to newlines in overlay strings, we may have to
13614 skip forward over overlay strings. */
13615 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13616 && MATRIX_ROW_END_CHARPOS (row
) == PT
13617 && !cursor_row_p (w
, row
))
13620 /* If within the scroll margin, scroll. */
13621 if (row
->y
< top_scroll_margin
13622 && CHARPOS (startp
) != BEGV
)
13627 /* Cursor did not move. So don't scroll even if cursor line
13628 is partially visible, as it was so before. */
13629 rc
= CURSOR_MOVEMENT_SUCCESS
;
13632 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13633 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13635 /* if PT is not in the glyph row, give up. */
13636 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13638 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13639 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13640 && make_cursor_line_fully_visible_p
)
13642 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13643 && !row
->ends_at_zv_p
13644 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13645 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13646 else if (row
->height
> window_box_height (w
))
13648 /* If we end up in a partially visible line, let's
13649 make it fully visible, except when it's taller
13650 than the window, in which case we can't do much
13653 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13657 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13658 if (!cursor_row_fully_visible_p (w
, 0, 1))
13659 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13661 rc
= CURSOR_MOVEMENT_SUCCESS
;
13665 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13666 else if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13668 /* With bidi-reordered rows, there could be more than
13669 one candidate row whose start and end positions
13670 occlude point. We need to let set_cursor_from_row
13671 find the best candidate. */
13672 /* FIXME: Revisit this when glyph ``spilling'' in
13673 continuation lines' rows is implemented for
13674 bidi-reordered rows. */
13679 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13681 /* As soon as we've found the first suitable row
13682 whose ends_at_zv_p flag is set, we are done. */
13684 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13686 rc
= CURSOR_MOVEMENT_SUCCESS
;
13691 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13692 && MATRIX_ROW_START_CHARPOS (row
) <= PT
13693 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13694 && cursor_row_p (w
, row
));
13695 /* If we didn't find any candidate rows, or exited the
13696 loop before all the candidates were examined, signal
13697 to the caller that this method failed. */
13698 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13700 || (MATRIX_ROW_START_CHARPOS (row
) <= PT
13701 && PT
<= MATRIX_ROW_END_CHARPOS (row
))))
13702 rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13704 rc
= CURSOR_MOVEMENT_SUCCESS
;
13710 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13712 rc
= CURSOR_MOVEMENT_SUCCESS
;
13717 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13718 && MATRIX_ROW_START_CHARPOS (row
) == PT
13719 && cursor_row_p (w
, row
));
13728 set_vertical_scroll_bar (w
)
13731 int start
, end
, whole
;
13733 /* Calculate the start and end positions for the current window.
13734 At some point, it would be nice to choose between scrollbars
13735 which reflect the whole buffer size, with special markers
13736 indicating narrowing, and scrollbars which reflect only the
13739 Note that mini-buffers sometimes aren't displaying any text. */
13740 if (!MINI_WINDOW_P (w
)
13741 || (w
== XWINDOW (minibuf_window
)
13742 && NILP (echo_area_buffer
[0])))
13744 struct buffer
*buf
= XBUFFER (w
->buffer
);
13745 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13746 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13747 /* I don't think this is guaranteed to be right. For the
13748 moment, we'll pretend it is. */
13749 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13753 if (whole
< (end
- start
))
13754 whole
= end
- start
;
13757 start
= end
= whole
= 0;
13759 /* Indicate what this scroll bar ought to be displaying now. */
13760 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13761 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13762 (w
, end
- start
, whole
, start
);
13766 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13767 selected_window is redisplayed.
13769 We can return without actually redisplaying the window if
13770 fonts_changed_p is nonzero. In that case, redisplay_internal will
13774 redisplay_window (window
, just_this_one_p
)
13775 Lisp_Object window
;
13776 int just_this_one_p
;
13778 struct window
*w
= XWINDOW (window
);
13779 struct frame
*f
= XFRAME (w
->frame
);
13780 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13781 struct buffer
*old
= current_buffer
;
13782 struct text_pos lpoint
, opoint
, startp
;
13783 int update_mode_line
;
13786 /* Record it now because it's overwritten. */
13787 int current_matrix_up_to_date_p
= 0;
13788 int used_current_matrix_p
= 0;
13789 /* This is less strict than current_matrix_up_to_date_p.
13790 It indictes that the buffer contents and narrowing are unchanged. */
13791 int buffer_unchanged_p
= 0;
13792 int temp_scroll_step
= 0;
13793 int count
= SPECPDL_INDEX ();
13795 int centering_position
= -1;
13796 int last_line_misfit
= 0;
13797 int beg_unchanged
, end_unchanged
;
13799 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13802 /* W must be a leaf window here. */
13803 xassert (!NILP (w
->buffer
));
13805 *w
->desired_matrix
->method
= 0;
13809 reconsider_clip_changes (w
, buffer
);
13811 /* Has the mode line to be updated? */
13812 update_mode_line
= (!NILP (w
->update_mode_line
)
13813 || update_mode_lines
13814 || buffer
->clip_changed
13815 || buffer
->prevent_redisplay_optimizations_p
);
13817 if (MINI_WINDOW_P (w
))
13819 if (w
== XWINDOW (echo_area_window
)
13820 && !NILP (echo_area_buffer
[0]))
13822 if (update_mode_line
)
13823 /* We may have to update a tty frame's menu bar or a
13824 tool-bar. Example `M-x C-h C-h C-g'. */
13825 goto finish_menu_bars
;
13827 /* We've already displayed the echo area glyphs in this window. */
13828 goto finish_scroll_bars
;
13830 else if ((w
!= XWINDOW (minibuf_window
)
13831 || minibuf_level
== 0)
13832 /* When buffer is nonempty, redisplay window normally. */
13833 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13834 /* Quail displays non-mini buffers in minibuffer window.
13835 In that case, redisplay the window normally. */
13836 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13838 /* W is a mini-buffer window, but it's not active, so clear
13840 int yb
= window_text_bottom_y (w
);
13841 struct glyph_row
*row
;
13844 for (y
= 0, row
= w
->desired_matrix
->rows
;
13846 y
+= row
->height
, ++row
)
13847 blank_row (w
, row
, y
);
13848 goto finish_scroll_bars
;
13851 clear_glyph_matrix (w
->desired_matrix
);
13854 /* Otherwise set up data on this window; select its buffer and point
13856 /* Really select the buffer, for the sake of buffer-local
13858 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13860 current_matrix_up_to_date_p
13861 = (!NILP (w
->window_end_valid
)
13862 && !current_buffer
->clip_changed
13863 && !current_buffer
->prevent_redisplay_optimizations_p
13864 && XFASTINT (w
->last_modified
) >= MODIFF
13865 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13867 /* Run the window-bottom-change-functions
13868 if it is possible that the text on the screen has changed
13869 (either due to modification of the text, or any other reason). */
13870 if (!current_matrix_up_to_date_p
13871 && !NILP (Vwindow_text_change_functions
))
13873 safe_run_hooks (Qwindow_text_change_functions
);
13877 beg_unchanged
= BEG_UNCHANGED
;
13878 end_unchanged
= END_UNCHANGED
;
13880 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13882 specbind (Qinhibit_point_motion_hooks
, Qt
);
13885 = (!NILP (w
->window_end_valid
)
13886 && !current_buffer
->clip_changed
13887 && XFASTINT (w
->last_modified
) >= MODIFF
13888 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13890 /* When windows_or_buffers_changed is non-zero, we can't rely on
13891 the window end being valid, so set it to nil there. */
13892 if (windows_or_buffers_changed
)
13894 /* If window starts on a continuation line, maybe adjust the
13895 window start in case the window's width changed. */
13896 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13897 compute_window_start_on_continuation_line (w
);
13899 w
->window_end_valid
= Qnil
;
13902 /* Some sanity checks. */
13903 CHECK_WINDOW_END (w
);
13904 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13906 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13909 /* If %c is in mode line, update it if needed. */
13910 if (!NILP (w
->column_number_displayed
)
13911 /* This alternative quickly identifies a common case
13912 where no change is needed. */
13913 && !(PT
== XFASTINT (w
->last_point
)
13914 && XFASTINT (w
->last_modified
) >= MODIFF
13915 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13916 && (XFASTINT (w
->column_number_displayed
)
13917 != (int) current_column ())) /* iftc */
13918 update_mode_line
= 1;
13920 /* Count number of windows showing the selected buffer. An indirect
13921 buffer counts as its base buffer. */
13922 if (!just_this_one_p
)
13924 struct buffer
*current_base
, *window_base
;
13925 current_base
= current_buffer
;
13926 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13927 if (current_base
->base_buffer
)
13928 current_base
= current_base
->base_buffer
;
13929 if (window_base
->base_buffer
)
13930 window_base
= window_base
->base_buffer
;
13931 if (current_base
== window_base
)
13935 /* Point refers normally to the selected window. For any other
13936 window, set up appropriate value. */
13937 if (!EQ (window
, selected_window
))
13939 int new_pt
= XMARKER (w
->pointm
)->charpos
;
13940 int new_pt_byte
= marker_byte_position (w
->pointm
);
13944 new_pt_byte
= BEGV_BYTE
;
13945 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13947 else if (new_pt
> (ZV
- 1))
13950 new_pt_byte
= ZV_BYTE
;
13951 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13954 /* We don't use SET_PT so that the point-motion hooks don't run. */
13955 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13958 /* If any of the character widths specified in the display table
13959 have changed, invalidate the width run cache. It's true that
13960 this may be a bit late to catch such changes, but the rest of
13961 redisplay goes (non-fatally) haywire when the display table is
13962 changed, so why should we worry about doing any better? */
13963 if (current_buffer
->width_run_cache
)
13965 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13967 if (! disptab_matches_widthtab (disptab
,
13968 XVECTOR (current_buffer
->width_table
)))
13970 invalidate_region_cache (current_buffer
,
13971 current_buffer
->width_run_cache
,
13973 recompute_width_table (current_buffer
, disptab
);
13977 /* If window-start is screwed up, choose a new one. */
13978 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13981 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13983 /* If someone specified a new starting point but did not insist,
13984 check whether it can be used. */
13985 if (!NILP (w
->optional_new_start
)
13986 && CHARPOS (startp
) >= BEGV
13987 && CHARPOS (startp
) <= ZV
)
13989 w
->optional_new_start
= Qnil
;
13990 start_display (&it
, w
, startp
);
13991 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13992 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13993 if (IT_CHARPOS (it
) == PT
)
13994 w
->force_start
= Qt
;
13995 /* IT may overshoot PT if text at PT is invisible. */
13996 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13997 w
->force_start
= Qt
;
14002 /* Handle case where place to start displaying has been specified,
14003 unless the specified location is outside the accessible range. */
14004 if (!NILP (w
->force_start
)
14005 || w
->frozen_window_start_p
)
14007 /* We set this later on if we have to adjust point. */
14010 w
->force_start
= Qnil
;
14012 w
->window_end_valid
= Qnil
;
14014 /* Forget any recorded base line for line number display. */
14015 if (!buffer_unchanged_p
)
14016 w
->base_line_number
= Qnil
;
14018 /* Redisplay the mode line. Select the buffer properly for that.
14019 Also, run the hook window-scroll-functions
14020 because we have scrolled. */
14021 /* Note, we do this after clearing force_start because
14022 if there's an error, it is better to forget about force_start
14023 than to get into an infinite loop calling the hook functions
14024 and having them get more errors. */
14025 if (!update_mode_line
14026 || ! NILP (Vwindow_scroll_functions
))
14028 update_mode_line
= 1;
14029 w
->update_mode_line
= Qt
;
14030 startp
= run_window_scroll_functions (window
, startp
);
14033 w
->last_modified
= make_number (0);
14034 w
->last_overlay_modified
= make_number (0);
14035 if (CHARPOS (startp
) < BEGV
)
14036 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
14037 else if (CHARPOS (startp
) > ZV
)
14038 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
14040 /* Redisplay, then check if cursor has been set during the
14041 redisplay. Give up if new fonts were loaded. */
14042 /* We used to issue a CHECK_MARGINS argument to try_window here,
14043 but this causes scrolling to fail when point begins inside
14044 the scroll margin (bug#148) -- cyd */
14045 if (!try_window (window
, startp
, 0))
14047 w
->force_start
= Qt
;
14048 clear_glyph_matrix (w
->desired_matrix
);
14049 goto need_larger_matrices
;
14052 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
14054 /* If point does not appear, try to move point so it does
14055 appear. The desired matrix has been built above, so we
14056 can use it here. */
14057 new_vpos
= window_box_height (w
) / 2;
14060 if (!cursor_row_fully_visible_p (w
, 0, 0))
14062 /* Point does appear, but on a line partly visible at end of window.
14063 Move it back to a fully-visible line. */
14064 new_vpos
= window_box_height (w
);
14067 /* If we need to move point for either of the above reasons,
14068 now actually do it. */
14071 struct glyph_row
*row
;
14073 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14074 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14077 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14078 MATRIX_ROW_START_BYTEPOS (row
));
14080 if (w
!= XWINDOW (selected_window
))
14081 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14082 else if (current_buffer
== old
)
14083 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14085 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14087 /* If we are highlighting the region, then we just changed
14088 the region, so redisplay to show it. */
14089 if (!NILP (Vtransient_mark_mode
)
14090 && !NILP (current_buffer
->mark_active
))
14092 clear_glyph_matrix (w
->desired_matrix
);
14093 if (!try_window (window
, startp
, 0))
14094 goto need_larger_matrices
;
14099 debug_method_add (w
, "forced window start");
14104 /* Handle case where text has not changed, only point, and it has
14105 not moved off the frame, and we are not retrying after hscroll.
14106 (current_matrix_up_to_date_p is nonzero when retrying.) */
14107 if (current_matrix_up_to_date_p
14108 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14109 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14113 case CURSOR_MOVEMENT_SUCCESS
:
14114 used_current_matrix_p
= 1;
14117 case CURSOR_MOVEMENT_MUST_SCROLL
:
14118 goto try_to_scroll
;
14124 /* If current starting point was originally the beginning of a line
14125 but no longer is, find a new starting point. */
14126 else if (!NILP (w
->start_at_line_beg
)
14127 && !(CHARPOS (startp
) <= BEGV
14128 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14131 debug_method_add (w
, "recenter 1");
14136 /* Try scrolling with try_window_id. Value is > 0 if update has
14137 been done, it is -1 if we know that the same window start will
14138 not work. It is 0 if unsuccessful for some other reason. */
14139 else if ((tem
= try_window_id (w
)) != 0)
14142 debug_method_add (w
, "try_window_id %d", tem
);
14145 if (fonts_changed_p
)
14146 goto need_larger_matrices
;
14150 /* Otherwise try_window_id has returned -1 which means that we
14151 don't want the alternative below this comment to execute. */
14153 else if (CHARPOS (startp
) >= BEGV
14154 && CHARPOS (startp
) <= ZV
14155 && PT
>= CHARPOS (startp
)
14156 && (CHARPOS (startp
) < ZV
14157 /* Avoid starting at end of buffer. */
14158 || CHARPOS (startp
) == BEGV
14159 || (XFASTINT (w
->last_modified
) >= MODIFF
14160 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14163 /* If first window line is a continuation line, and window start
14164 is inside the modified region, but the first change is before
14165 current window start, we must select a new window start.
14167 However, if this is the result of a down-mouse event (e.g. by
14168 extending the mouse-drag-overlay), we don't want to select a
14169 new window start, since that would change the position under
14170 the mouse, resulting in an unwanted mouse-movement rather
14171 than a simple mouse-click. */
14172 if (NILP (w
->start_at_line_beg
)
14173 && NILP (do_mouse_tracking
)
14174 && CHARPOS (startp
) > BEGV
14175 && CHARPOS (startp
) > BEG
+ beg_unchanged
14176 && CHARPOS (startp
) <= Z
- end_unchanged
14177 /* Even if w->start_at_line_beg is nil, a new window may
14178 start at a line_beg, since that's how set_buffer_window
14179 sets it. So, we need to check the return value of
14180 compute_window_start_on_continuation_line. (See also
14182 && XMARKER (w
->start
)->buffer
== current_buffer
14183 && compute_window_start_on_continuation_line (w
))
14185 w
->force_start
= Qt
;
14186 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14191 debug_method_add (w
, "same window start");
14194 /* Try to redisplay starting at same place as before.
14195 If point has not moved off frame, accept the results. */
14196 if (!current_matrix_up_to_date_p
14197 /* Don't use try_window_reusing_current_matrix in this case
14198 because a window scroll function can have changed the
14200 || !NILP (Vwindow_scroll_functions
)
14201 || MINI_WINDOW_P (w
)
14202 || !(used_current_matrix_p
14203 = try_window_reusing_current_matrix (w
)))
14205 IF_DEBUG (debug_method_add (w
, "1"));
14206 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14207 /* -1 means we need to scroll.
14208 0 means we need new matrices, but fonts_changed_p
14209 is set in that case, so we will detect it below. */
14210 goto try_to_scroll
;
14213 if (fonts_changed_p
)
14214 goto need_larger_matrices
;
14216 if (w
->cursor
.vpos
>= 0)
14218 if (!just_this_one_p
14219 || current_buffer
->clip_changed
14220 || BEG_UNCHANGED
< CHARPOS (startp
))
14221 /* Forget any recorded base line for line number display. */
14222 w
->base_line_number
= Qnil
;
14224 if (!cursor_row_fully_visible_p (w
, 1, 0))
14226 clear_glyph_matrix (w
->desired_matrix
);
14227 last_line_misfit
= 1;
14229 /* Drop through and scroll. */
14234 clear_glyph_matrix (w
->desired_matrix
);
14239 w
->last_modified
= make_number (0);
14240 w
->last_overlay_modified
= make_number (0);
14242 /* Redisplay the mode line. Select the buffer properly for that. */
14243 if (!update_mode_line
)
14245 update_mode_line
= 1;
14246 w
->update_mode_line
= Qt
;
14249 /* Try to scroll by specified few lines. */
14250 if ((scroll_conservatively
14252 || temp_scroll_step
14253 || NUMBERP (current_buffer
->scroll_up_aggressively
)
14254 || NUMBERP (current_buffer
->scroll_down_aggressively
))
14255 && !current_buffer
->clip_changed
14256 && CHARPOS (startp
) >= BEGV
14257 && CHARPOS (startp
) <= ZV
)
14259 /* The function returns -1 if new fonts were loaded, 1 if
14260 successful, 0 if not successful. */
14261 int rc
= try_scrolling (window
, just_this_one_p
,
14262 scroll_conservatively
,
14264 temp_scroll_step
, last_line_misfit
);
14267 case SCROLLING_SUCCESS
:
14270 case SCROLLING_NEED_LARGER_MATRICES
:
14271 goto need_larger_matrices
;
14273 case SCROLLING_FAILED
:
14281 /* Finally, just choose place to start which centers point */
14284 if (centering_position
< 0)
14285 centering_position
= window_box_height (w
) / 2;
14288 debug_method_add (w
, "recenter");
14291 /* w->vscroll = 0; */
14293 /* Forget any previously recorded base line for line number display. */
14294 if (!buffer_unchanged_p
)
14295 w
->base_line_number
= Qnil
;
14297 /* Move backward half the height of the window. */
14298 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14299 it
.current_y
= it
.last_visible_y
;
14300 move_it_vertically_backward (&it
, centering_position
);
14301 xassert (IT_CHARPOS (it
) >= BEGV
);
14303 /* The function move_it_vertically_backward may move over more
14304 than the specified y-distance. If it->w is small, e.g. a
14305 mini-buffer window, we may end up in front of the window's
14306 display area. Start displaying at the start of the line
14307 containing PT in this case. */
14308 if (it
.current_y
<= 0)
14310 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14311 move_it_vertically_backward (&it
, 0);
14315 it
.current_x
= it
.hpos
= 0;
14317 /* Set startp here explicitly in case that helps avoid an infinite loop
14318 in case the window-scroll-functions functions get errors. */
14319 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14321 /* Run scroll hooks. */
14322 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14324 /* Redisplay the window. */
14325 if (!current_matrix_up_to_date_p
14326 || windows_or_buffers_changed
14327 || cursor_type_changed
14328 /* Don't use try_window_reusing_current_matrix in this case
14329 because it can have changed the buffer. */
14330 || !NILP (Vwindow_scroll_functions
)
14331 || !just_this_one_p
14332 || MINI_WINDOW_P (w
)
14333 || !(used_current_matrix_p
14334 = try_window_reusing_current_matrix (w
)))
14335 try_window (window
, startp
, 0);
14337 /* If new fonts have been loaded (due to fontsets), give up. We
14338 have to start a new redisplay since we need to re-adjust glyph
14340 if (fonts_changed_p
)
14341 goto need_larger_matrices
;
14343 /* If cursor did not appear assume that the middle of the window is
14344 in the first line of the window. Do it again with the next line.
14345 (Imagine a window of height 100, displaying two lines of height
14346 60. Moving back 50 from it->last_visible_y will end in the first
14348 if (w
->cursor
.vpos
< 0)
14350 if (!NILP (w
->window_end_valid
)
14351 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14353 clear_glyph_matrix (w
->desired_matrix
);
14354 move_it_by_lines (&it
, 1, 0);
14355 try_window (window
, it
.current
.pos
, 0);
14357 else if (PT
< IT_CHARPOS (it
))
14359 clear_glyph_matrix (w
->desired_matrix
);
14360 move_it_by_lines (&it
, -1, 0);
14361 try_window (window
, it
.current
.pos
, 0);
14365 /* Not much we can do about it. */
14369 /* Consider the following case: Window starts at BEGV, there is
14370 invisible, intangible text at BEGV, so that display starts at
14371 some point START > BEGV. It can happen that we are called with
14372 PT somewhere between BEGV and START. Try to handle that case. */
14373 if (w
->cursor
.vpos
< 0)
14375 struct glyph_row
*row
= w
->current_matrix
->rows
;
14376 if (row
->mode_line_p
)
14378 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14381 if (!cursor_row_fully_visible_p (w
, 0, 0))
14383 /* If vscroll is enabled, disable it and try again. */
14387 clear_glyph_matrix (w
->desired_matrix
);
14391 /* If centering point failed to make the whole line visible,
14392 put point at the top instead. That has to make the whole line
14393 visible, if it can be done. */
14394 if (centering_position
== 0)
14397 clear_glyph_matrix (w
->desired_matrix
);
14398 centering_position
= 0;
14404 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14405 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14406 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14409 /* Display the mode line, if we must. */
14410 if ((update_mode_line
14411 /* If window not full width, must redo its mode line
14412 if (a) the window to its side is being redone and
14413 (b) we do a frame-based redisplay. This is a consequence
14414 of how inverted lines are drawn in frame-based redisplay. */
14415 || (!just_this_one_p
14416 && !FRAME_WINDOW_P (f
)
14417 && !WINDOW_FULL_WIDTH_P (w
))
14418 /* Line number to display. */
14419 || INTEGERP (w
->base_line_pos
)
14420 /* Column number is displayed and different from the one displayed. */
14421 || (!NILP (w
->column_number_displayed
)
14422 && (XFASTINT (w
->column_number_displayed
)
14423 != (int) current_column ()))) /* iftc */
14424 /* This means that the window has a mode line. */
14425 && (WINDOW_WANTS_MODELINE_P (w
)
14426 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14428 display_mode_lines (w
);
14430 /* If mode line height has changed, arrange for a thorough
14431 immediate redisplay using the correct mode line height. */
14432 if (WINDOW_WANTS_MODELINE_P (w
)
14433 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14435 fonts_changed_p
= 1;
14436 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14437 = DESIRED_MODE_LINE_HEIGHT (w
);
14440 /* If header line height has changed, arrange for a thorough
14441 immediate redisplay using the correct header line height. */
14442 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14443 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14445 fonts_changed_p
= 1;
14446 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14447 = DESIRED_HEADER_LINE_HEIGHT (w
);
14450 if (fonts_changed_p
)
14451 goto need_larger_matrices
;
14454 if (!line_number_displayed
14455 && !BUFFERP (w
->base_line_pos
))
14457 w
->base_line_pos
= Qnil
;
14458 w
->base_line_number
= Qnil
;
14463 /* When we reach a frame's selected window, redo the frame's menu bar. */
14464 if (update_mode_line
14465 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14467 int redisplay_menu_p
= 0;
14468 int redisplay_tool_bar_p
= 0;
14470 if (FRAME_WINDOW_P (f
))
14472 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14473 || defined (HAVE_NS) || defined (USE_GTK)
14474 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14476 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14480 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14482 if (redisplay_menu_p
)
14483 display_menu_bar (w
);
14485 #ifdef HAVE_WINDOW_SYSTEM
14486 if (FRAME_WINDOW_P (f
))
14488 #if defined (USE_GTK) || defined (HAVE_NS)
14489 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
14491 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
14492 && (FRAME_TOOL_BAR_LINES (f
) > 0
14493 || !NILP (Vauto_resize_tool_bars
));
14496 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
14498 extern int ignore_mouse_drag_p
;
14499 ignore_mouse_drag_p
= 1;
14505 #ifdef HAVE_WINDOW_SYSTEM
14506 if (FRAME_WINDOW_P (f
)
14507 && update_window_fringes (w
, (just_this_one_p
14508 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14509 || w
->pseudo_window_p
)))
14513 if (draw_window_fringes (w
, 1))
14514 x_draw_vertical_border (w
);
14518 #endif /* HAVE_WINDOW_SYSTEM */
14520 /* We go to this label, with fonts_changed_p nonzero,
14521 if it is necessary to try again using larger glyph matrices.
14522 We have to redeem the scroll bar even in this case,
14523 because the loop in redisplay_internal expects that. */
14524 need_larger_matrices
:
14526 finish_scroll_bars
:
14528 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14530 /* Set the thumb's position and size. */
14531 set_vertical_scroll_bar (w
);
14533 /* Note that we actually used the scroll bar attached to this
14534 window, so it shouldn't be deleted at the end of redisplay. */
14535 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14536 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14539 /* Restore current_buffer and value of point in it. */
14540 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14541 set_buffer_internal_1 (old
);
14542 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14543 shorter. This can be caused by log truncation in *Messages*. */
14544 if (CHARPOS (lpoint
) <= ZV
)
14545 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14547 unbind_to (count
, Qnil
);
14551 /* Build the complete desired matrix of WINDOW with a window start
14552 buffer position POS.
14554 Value is 1 if successful. It is zero if fonts were loaded during
14555 redisplay which makes re-adjusting glyph matrices necessary, and -1
14556 if point would appear in the scroll margins.
14557 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
14558 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
14562 try_window (window
, pos
, flags
)
14563 Lisp_Object window
;
14564 struct text_pos pos
;
14567 struct window
*w
= XWINDOW (window
);
14569 struct glyph_row
*last_text_row
= NULL
;
14570 struct frame
*f
= XFRAME (w
->frame
);
14572 /* Make POS the new window start. */
14573 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14575 /* Mark cursor position as unknown. No overlay arrow seen. */
14576 w
->cursor
.vpos
= -1;
14577 overlay_arrow_seen
= 0;
14579 /* Initialize iterator and info to start at POS. */
14580 start_display (&it
, w
, pos
);
14582 /* Display all lines of W. */
14583 while (it
.current_y
< it
.last_visible_y
)
14585 if (display_line (&it
))
14586 last_text_row
= it
.glyph_row
- 1;
14587 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
14591 /* Don't let the cursor end in the scroll margins. */
14592 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
14593 && !MINI_WINDOW_P (w
))
14595 int this_scroll_margin
;
14597 if (scroll_margin
> 0)
14599 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14600 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14603 this_scroll_margin
= 0;
14605 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14606 && w
->cursor
.y
< this_scroll_margin
14607 && CHARPOS (pos
) > BEGV
14608 && IT_CHARPOS (it
) < ZV
)
14609 /* rms: considering make_cursor_line_fully_visible_p here
14610 seems to give wrong results. We don't want to recenter
14611 when the last line is partly visible, we want to allow
14612 that case to be handled in the usual way. */
14613 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14615 w
->cursor
.vpos
= -1;
14616 clear_glyph_matrix (w
->desired_matrix
);
14621 /* If bottom moved off end of frame, change mode line percentage. */
14622 if (XFASTINT (w
->window_end_pos
) <= 0
14623 && Z
!= IT_CHARPOS (it
))
14624 w
->update_mode_line
= Qt
;
14626 /* Set window_end_pos to the offset of the last character displayed
14627 on the window from the end of current_buffer. Set
14628 window_end_vpos to its row number. */
14631 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14632 w
->window_end_bytepos
14633 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14635 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14637 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14638 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14639 ->displays_text_p
);
14643 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14644 w
->window_end_pos
= make_number (Z
- ZV
);
14645 w
->window_end_vpos
= make_number (0);
14648 /* But that is not valid info until redisplay finishes. */
14649 w
->window_end_valid
= Qnil
;
14655 /************************************************************************
14656 Window redisplay reusing current matrix when buffer has not changed
14657 ************************************************************************/
14659 /* Try redisplay of window W showing an unchanged buffer with a
14660 different window start than the last time it was displayed by
14661 reusing its current matrix. Value is non-zero if successful.
14662 W->start is the new window start. */
14665 try_window_reusing_current_matrix (w
)
14668 struct frame
*f
= XFRAME (w
->frame
);
14669 struct glyph_row
*row
, *bottom_row
;
14672 struct text_pos start
, new_start
;
14673 int nrows_scrolled
, i
;
14674 struct glyph_row
*last_text_row
;
14675 struct glyph_row
*last_reused_text_row
;
14676 struct glyph_row
*start_row
;
14677 int start_vpos
, min_y
, max_y
;
14680 if (inhibit_try_window_reusing
)
14684 if (/* This function doesn't handle terminal frames. */
14685 !FRAME_WINDOW_P (f
)
14686 /* Don't try to reuse the display if windows have been split
14688 || windows_or_buffers_changed
14689 || cursor_type_changed
)
14692 /* Can't do this if region may have changed. */
14693 if ((!NILP (Vtransient_mark_mode
)
14694 && !NILP (current_buffer
->mark_active
))
14695 || !NILP (w
->region_showing
)
14696 || !NILP (Vshow_trailing_whitespace
))
14699 /* If top-line visibility has changed, give up. */
14700 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14701 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14704 /* Give up if old or new display is scrolled vertically. We could
14705 make this function handle this, but right now it doesn't. */
14706 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14707 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14710 /* The variable new_start now holds the new window start. The old
14711 start `start' can be determined from the current matrix. */
14712 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14713 start
= start_row
->start
.pos
;
14714 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14716 /* Clear the desired matrix for the display below. */
14717 clear_glyph_matrix (w
->desired_matrix
);
14719 if (CHARPOS (new_start
) <= CHARPOS (start
))
14723 /* Don't use this method if the display starts with an ellipsis
14724 displayed for invisible text. It's not easy to handle that case
14725 below, and it's certainly not worth the effort since this is
14726 not a frequent case. */
14727 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14730 IF_DEBUG (debug_method_add (w
, "twu1"));
14732 /* Display up to a row that can be reused. The variable
14733 last_text_row is set to the last row displayed that displays
14734 text. Note that it.vpos == 0 if or if not there is a
14735 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14736 start_display (&it
, w
, new_start
);
14737 first_row_y
= it
.current_y
;
14738 w
->cursor
.vpos
= -1;
14739 last_text_row
= last_reused_text_row
= NULL
;
14741 while (it
.current_y
< it
.last_visible_y
14742 && !fonts_changed_p
)
14744 /* If we have reached into the characters in the START row,
14745 that means the line boundaries have changed. So we
14746 can't start copying with the row START. Maybe it will
14747 work to start copying with the following row. */
14748 while (IT_CHARPOS (it
) > CHARPOS (start
))
14750 /* Advance to the next row as the "start". */
14752 start
= start_row
->start
.pos
;
14753 /* If there are no more rows to try, or just one, give up. */
14754 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14755 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14756 || CHARPOS (start
) == ZV
)
14758 clear_glyph_matrix (w
->desired_matrix
);
14762 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14764 /* If we have reached alignment,
14765 we can copy the rest of the rows. */
14766 if (IT_CHARPOS (it
) == CHARPOS (start
))
14769 if (display_line (&it
))
14770 last_text_row
= it
.glyph_row
- 1;
14773 /* A value of current_y < last_visible_y means that we stopped
14774 at the previous window start, which in turn means that we
14775 have at least one reusable row. */
14776 if (it
.current_y
< it
.last_visible_y
)
14778 /* IT.vpos always starts from 0; it counts text lines. */
14779 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14781 /* Find PT if not already found in the lines displayed. */
14782 if (w
->cursor
.vpos
< 0)
14784 int dy
= it
.current_y
- start_row
->y
;
14786 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14787 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14789 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14790 dy
, nrows_scrolled
);
14793 clear_glyph_matrix (w
->desired_matrix
);
14798 /* Scroll the display. Do it before the current matrix is
14799 changed. The problem here is that update has not yet
14800 run, i.e. part of the current matrix is not up to date.
14801 scroll_run_hook will clear the cursor, and use the
14802 current matrix to get the height of the row the cursor is
14804 run
.current_y
= start_row
->y
;
14805 run
.desired_y
= it
.current_y
;
14806 run
.height
= it
.last_visible_y
- it
.current_y
;
14808 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14811 FRAME_RIF (f
)->update_window_begin_hook (w
);
14812 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14813 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14814 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14818 /* Shift current matrix down by nrows_scrolled lines. */
14819 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14820 rotate_matrix (w
->current_matrix
,
14822 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14825 /* Disable lines that must be updated. */
14826 for (i
= 0; i
< nrows_scrolled
; ++i
)
14827 (start_row
+ i
)->enabled_p
= 0;
14829 /* Re-compute Y positions. */
14830 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14831 max_y
= it
.last_visible_y
;
14832 for (row
= start_row
+ nrows_scrolled
;
14836 row
->y
= it
.current_y
;
14837 row
->visible_height
= row
->height
;
14839 if (row
->y
< min_y
)
14840 row
->visible_height
-= min_y
- row
->y
;
14841 if (row
->y
+ row
->height
> max_y
)
14842 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14843 row
->redraw_fringe_bitmaps_p
= 1;
14845 it
.current_y
+= row
->height
;
14847 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14848 last_reused_text_row
= row
;
14849 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14853 /* Disable lines in the current matrix which are now
14854 below the window. */
14855 for (++row
; row
< bottom_row
; ++row
)
14856 row
->enabled_p
= row
->mode_line_p
= 0;
14859 /* Update window_end_pos etc.; last_reused_text_row is the last
14860 reused row from the current matrix containing text, if any.
14861 The value of last_text_row is the last displayed line
14862 containing text. */
14863 if (last_reused_text_row
)
14865 w
->window_end_bytepos
14866 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14868 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14870 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14871 w
->current_matrix
));
14873 else if (last_text_row
)
14875 w
->window_end_bytepos
14876 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14878 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14880 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14884 /* This window must be completely empty. */
14885 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14886 w
->window_end_pos
= make_number (Z
- ZV
);
14887 w
->window_end_vpos
= make_number (0);
14889 w
->window_end_valid
= Qnil
;
14891 /* Update hint: don't try scrolling again in update_window. */
14892 w
->desired_matrix
->no_scrolling_p
= 1;
14895 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14899 else if (CHARPOS (new_start
) > CHARPOS (start
))
14901 struct glyph_row
*pt_row
, *row
;
14902 struct glyph_row
*first_reusable_row
;
14903 struct glyph_row
*first_row_to_display
;
14905 int yb
= window_text_bottom_y (w
);
14907 /* Find the row starting at new_start, if there is one. Don't
14908 reuse a partially visible line at the end. */
14909 first_reusable_row
= start_row
;
14910 while (first_reusable_row
->enabled_p
14911 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14912 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14913 < CHARPOS (new_start
)))
14914 ++first_reusable_row
;
14916 /* Give up if there is no row to reuse. */
14917 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14918 || !first_reusable_row
->enabled_p
14919 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14920 != CHARPOS (new_start
)))
14923 /* We can reuse fully visible rows beginning with
14924 first_reusable_row to the end of the window. Set
14925 first_row_to_display to the first row that cannot be reused.
14926 Set pt_row to the row containing point, if there is any. */
14928 for (first_row_to_display
= first_reusable_row
;
14929 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14930 ++first_row_to_display
)
14932 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14933 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14934 pt_row
= first_row_to_display
;
14937 /* Start displaying at the start of first_row_to_display. */
14938 xassert (first_row_to_display
->y
< yb
);
14939 init_to_row_start (&it
, w
, first_row_to_display
);
14941 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14943 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14945 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14946 + WINDOW_HEADER_LINE_HEIGHT (w
));
14948 /* Display lines beginning with first_row_to_display in the
14949 desired matrix. Set last_text_row to the last row displayed
14950 that displays text. */
14951 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14952 if (pt_row
== NULL
)
14953 w
->cursor
.vpos
= -1;
14954 last_text_row
= NULL
;
14955 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14956 if (display_line (&it
))
14957 last_text_row
= it
.glyph_row
- 1;
14959 /* If point is in a reused row, adjust y and vpos of the cursor
14963 w
->cursor
.vpos
-= nrows_scrolled
;
14964 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14967 /* Give up if point isn't in a row displayed or reused. (This
14968 also handles the case where w->cursor.vpos < nrows_scrolled
14969 after the calls to display_line, which can happen with scroll
14970 margins. See bug#1295.) */
14971 if (w
->cursor
.vpos
< 0)
14973 clear_glyph_matrix (w
->desired_matrix
);
14977 /* Scroll the display. */
14978 run
.current_y
= first_reusable_row
->y
;
14979 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14980 run
.height
= it
.last_visible_y
- run
.current_y
;
14981 dy
= run
.current_y
- run
.desired_y
;
14986 FRAME_RIF (f
)->update_window_begin_hook (w
);
14987 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14988 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14989 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14993 /* Adjust Y positions of reused rows. */
14994 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14995 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14996 max_y
= it
.last_visible_y
;
14997 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
15000 row
->visible_height
= row
->height
;
15001 if (row
->y
< min_y
)
15002 row
->visible_height
-= min_y
- row
->y
;
15003 if (row
->y
+ row
->height
> max_y
)
15004 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15005 row
->redraw_fringe_bitmaps_p
= 1;
15008 /* Scroll the current matrix. */
15009 xassert (nrows_scrolled
> 0);
15010 rotate_matrix (w
->current_matrix
,
15012 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15015 /* Disable rows not reused. */
15016 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
15017 row
->enabled_p
= 0;
15019 /* Point may have moved to a different line, so we cannot assume that
15020 the previous cursor position is valid; locate the correct row. */
15023 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15024 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15028 w
->cursor
.y
= row
->y
;
15030 if (row
< bottom_row
)
15032 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15033 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15034 struct glyph
*orig_glyph
= glyph
;
15035 struct cursor_pos orig_cursor
= w
->cursor
;
15038 && (!BUFFERP (glyph
->object
)
15039 || glyph
->charpos
!= PT
);
15043 w
->cursor
.x
+= glyph
->pixel_width
;
15045 /* With bidi reordering, charpos changes non-linearly
15046 with hpos, so the right glyph could be to the
15048 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
15049 && (!BUFFERP (glyph
->object
) || glyph
->charpos
!= PT
))
15051 struct glyph
*start_glyph
= row
->glyphs
[TEXT_AREA
];
15053 glyph
= orig_glyph
- 1;
15054 orig_cursor
.hpos
--;
15055 orig_cursor
.x
-= glyph
->pixel_width
;
15056 for (; glyph
>= start_glyph
15057 && (!BUFFERP (glyph
->object
)
15058 || glyph
->charpos
!= PT
);
15062 w
->cursor
.x
-= glyph
->pixel_width
;
15064 if (BUFFERP (glyph
->object
) && glyph
->charpos
== PT
)
15065 w
->cursor
= orig_cursor
;
15070 /* Adjust window end. A null value of last_text_row means that
15071 the window end is in reused rows which in turn means that
15072 only its vpos can have changed. */
15075 w
->window_end_bytepos
15076 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15078 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15080 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15085 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15088 w
->window_end_valid
= Qnil
;
15089 w
->desired_matrix
->no_scrolling_p
= 1;
15092 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15102 /************************************************************************
15103 Window redisplay reusing current matrix when buffer has changed
15104 ************************************************************************/
15106 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
15107 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
15109 static struct glyph_row
*
15110 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
15111 struct glyph_row
*));
15114 /* Return the last row in MATRIX displaying text. If row START is
15115 non-null, start searching with that row. IT gives the dimensions
15116 of the display. Value is null if matrix is empty; otherwise it is
15117 a pointer to the row found. */
15119 static struct glyph_row
*
15120 find_last_row_displaying_text (matrix
, it
, start
)
15121 struct glyph_matrix
*matrix
;
15123 struct glyph_row
*start
;
15125 struct glyph_row
*row
, *row_found
;
15127 /* Set row_found to the last row in IT->w's current matrix
15128 displaying text. The loop looks funny but think of partially
15131 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15132 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15134 xassert (row
->enabled_p
);
15136 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15145 /* Return the last row in the current matrix of W that is not affected
15146 by changes at the start of current_buffer that occurred since W's
15147 current matrix was built. Value is null if no such row exists.
15149 BEG_UNCHANGED us the number of characters unchanged at the start of
15150 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15151 first changed character in current_buffer. Characters at positions <
15152 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15153 when the current matrix was built. */
15155 static struct glyph_row
*
15156 find_last_unchanged_at_beg_row (w
)
15159 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15160 struct glyph_row
*row
;
15161 struct glyph_row
*row_found
= NULL
;
15162 int yb
= window_text_bottom_y (w
);
15164 /* Find the last row displaying unchanged text. */
15165 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15166 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15167 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15170 if (/* If row ends before first_changed_pos, it is unchanged,
15171 except in some case. */
15172 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15173 /* When row ends in ZV and we write at ZV it is not
15175 && !row
->ends_at_zv_p
15176 /* When first_changed_pos is the end of a continued line,
15177 row is not unchanged because it may be no longer
15179 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15180 && (row
->continued_p
15181 || row
->exact_window_width_line_p
)))
15184 /* Stop if last visible row. */
15185 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15193 /* Find the first glyph row in the current matrix of W that is not
15194 affected by changes at the end of current_buffer since the
15195 time W's current matrix was built.
15197 Return in *DELTA the number of chars by which buffer positions in
15198 unchanged text at the end of current_buffer must be adjusted.
15200 Return in *DELTA_BYTES the corresponding number of bytes.
15202 Value is null if no such row exists, i.e. all rows are affected by
15205 static struct glyph_row
*
15206 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
15208 int *delta
, *delta_bytes
;
15210 struct glyph_row
*row
;
15211 struct glyph_row
*row_found
= NULL
;
15213 *delta
= *delta_bytes
= 0;
15215 /* Display must not have been paused, otherwise the current matrix
15216 is not up to date. */
15217 eassert (!NILP (w
->window_end_valid
));
15219 /* A value of window_end_pos >= END_UNCHANGED means that the window
15220 end is in the range of changed text. If so, there is no
15221 unchanged row at the end of W's current matrix. */
15222 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15225 /* Set row to the last row in W's current matrix displaying text. */
15226 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15228 /* If matrix is entirely empty, no unchanged row exists. */
15229 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15231 /* The value of row is the last glyph row in the matrix having a
15232 meaningful buffer position in it. The end position of row
15233 corresponds to window_end_pos. This allows us to translate
15234 buffer positions in the current matrix to current buffer
15235 positions for characters not in changed text. */
15236 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15237 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15238 int last_unchanged_pos
, last_unchanged_pos_old
;
15239 struct glyph_row
*first_text_row
15240 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15242 *delta
= Z
- Z_old
;
15243 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15245 /* Set last_unchanged_pos to the buffer position of the last
15246 character in the buffer that has not been changed. Z is the
15247 index + 1 of the last character in current_buffer, i.e. by
15248 subtracting END_UNCHANGED we get the index of the last
15249 unchanged character, and we have to add BEG to get its buffer
15251 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15252 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15254 /* Search backward from ROW for a row displaying a line that
15255 starts at a minimum position >= last_unchanged_pos_old. */
15256 for (; row
> first_text_row
; --row
)
15258 /* This used to abort, but it can happen.
15259 It is ok to just stop the search instead here. KFS. */
15260 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15263 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15268 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15274 /* Make sure that glyph rows in the current matrix of window W
15275 reference the same glyph memory as corresponding rows in the
15276 frame's frame matrix. This function is called after scrolling W's
15277 current matrix on a terminal frame in try_window_id and
15278 try_window_reusing_current_matrix. */
15281 sync_frame_with_window_matrix_rows (w
)
15284 struct frame
*f
= XFRAME (w
->frame
);
15285 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15287 /* Preconditions: W must be a leaf window and full-width. Its frame
15288 must have a frame matrix. */
15289 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15290 xassert (WINDOW_FULL_WIDTH_P (w
));
15291 xassert (!FRAME_WINDOW_P (f
));
15293 /* If W is a full-width window, glyph pointers in W's current matrix
15294 have, by definition, to be the same as glyph pointers in the
15295 corresponding frame matrix. Note that frame matrices have no
15296 marginal areas (see build_frame_matrix). */
15297 window_row
= w
->current_matrix
->rows
;
15298 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15299 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15300 while (window_row
< window_row_end
)
15302 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15303 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15305 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15306 frame_row
->glyphs
[TEXT_AREA
] = start
;
15307 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15308 frame_row
->glyphs
[LAST_AREA
] = end
;
15310 /* Disable frame rows whose corresponding window rows have
15311 been disabled in try_window_id. */
15312 if (!window_row
->enabled_p
)
15313 frame_row
->enabled_p
= 0;
15315 ++window_row
, ++frame_row
;
15320 /* Find the glyph row in window W containing CHARPOS. Consider all
15321 rows between START and END (not inclusive). END null means search
15322 all rows to the end of the display area of W. Value is the row
15323 containing CHARPOS or null. */
15326 row_containing_pos (w
, charpos
, start
, end
, dy
)
15329 struct glyph_row
*start
, *end
;
15332 struct glyph_row
*row
= start
;
15333 struct glyph_row
*best_row
= NULL
;
15334 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15337 /* If we happen to start on a header-line, skip that. */
15338 if (row
->mode_line_p
)
15341 if ((end
&& row
>= end
) || !row
->enabled_p
)
15344 last_y
= window_text_bottom_y (w
) - dy
;
15348 /* Give up if we have gone too far. */
15349 if (end
&& row
>= end
)
15351 /* This formerly returned if they were equal.
15352 I think that both quantities are of a "last plus one" type;
15353 if so, when they are equal, the row is within the screen. -- rms. */
15354 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15357 /* If it is in this row, return this row. */
15358 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15359 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15360 /* The end position of a row equals the start
15361 position of the next row. If CHARPOS is there, we
15362 would rather display it in the next line, except
15363 when this line ends in ZV. */
15364 && !row
->ends_at_zv_p
15365 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15366 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15370 if (NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
15372 /* In bidi-reordered rows, there could be several rows
15373 occluding point. We need to find the one which fits
15374 CHARPOS the best. */
15375 for (g
= row
->glyphs
[TEXT_AREA
];
15376 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15379 if (!STRINGP (g
->object
))
15381 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15383 mindif
= eabs (g
->charpos
- charpos
);
15396 /* Try to redisplay window W by reusing its existing display. W's
15397 current matrix must be up to date when this function is called,
15398 i.e. window_end_valid must not be nil.
15402 1 if display has been updated
15403 0 if otherwise unsuccessful
15404 -1 if redisplay with same window start is known not to succeed
15406 The following steps are performed:
15408 1. Find the last row in the current matrix of W that is not
15409 affected by changes at the start of current_buffer. If no such row
15412 2. Find the first row in W's current matrix that is not affected by
15413 changes at the end of current_buffer. Maybe there is no such row.
15415 3. Display lines beginning with the row + 1 found in step 1 to the
15416 row found in step 2 or, if step 2 didn't find a row, to the end of
15419 4. If cursor is not known to appear on the window, give up.
15421 5. If display stopped at the row found in step 2, scroll the
15422 display and current matrix as needed.
15424 6. Maybe display some lines at the end of W, if we must. This can
15425 happen under various circumstances, like a partially visible line
15426 becoming fully visible, or because newly displayed lines are displayed
15427 in smaller font sizes.
15429 7. Update W's window end information. */
15435 struct frame
*f
= XFRAME (w
->frame
);
15436 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15437 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15438 struct glyph_row
*last_unchanged_at_beg_row
;
15439 struct glyph_row
*first_unchanged_at_end_row
;
15440 struct glyph_row
*row
;
15441 struct glyph_row
*bottom_row
;
15444 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
15445 struct text_pos start_pos
;
15447 int first_unchanged_at_end_vpos
= 0;
15448 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15449 struct text_pos start
;
15450 int first_changed_charpos
, last_changed_charpos
;
15453 if (inhibit_try_window_id
)
15457 /* This is handy for debugging. */
15459 #define GIVE_UP(X) \
15461 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15465 #define GIVE_UP(X) return 0
15468 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15470 /* Don't use this for mini-windows because these can show
15471 messages and mini-buffers, and we don't handle that here. */
15472 if (MINI_WINDOW_P (w
))
15475 /* This flag is used to prevent redisplay optimizations. */
15476 if (windows_or_buffers_changed
|| cursor_type_changed
)
15479 /* Verify that narrowing has not changed.
15480 Also verify that we were not told to prevent redisplay optimizations.
15481 It would be nice to further
15482 reduce the number of cases where this prevents try_window_id. */
15483 if (current_buffer
->clip_changed
15484 || current_buffer
->prevent_redisplay_optimizations_p
)
15487 /* Window must either use window-based redisplay or be full width. */
15488 if (!FRAME_WINDOW_P (f
)
15489 && (!FRAME_LINE_INS_DEL_OK (f
)
15490 || !WINDOW_FULL_WIDTH_P (w
)))
15493 /* Give up if point is known NOT to appear in W. */
15494 if (PT
< CHARPOS (start
))
15497 /* Another way to prevent redisplay optimizations. */
15498 if (XFASTINT (w
->last_modified
) == 0)
15501 /* Verify that window is not hscrolled. */
15502 if (XFASTINT (w
->hscroll
) != 0)
15505 /* Verify that display wasn't paused. */
15506 if (NILP (w
->window_end_valid
))
15509 /* Can't use this if highlighting a region because a cursor movement
15510 will do more than just set the cursor. */
15511 if (!NILP (Vtransient_mark_mode
)
15512 && !NILP (current_buffer
->mark_active
))
15515 /* Likewise if highlighting trailing whitespace. */
15516 if (!NILP (Vshow_trailing_whitespace
))
15519 /* Likewise if showing a region. */
15520 if (!NILP (w
->region_showing
))
15523 /* Can't use this if overlay arrow position and/or string have
15525 if (overlay_arrows_changed_p ())
15528 /* When word-wrap is on, adding a space to the first word of a
15529 wrapped line can change the wrap position, altering the line
15530 above it. It might be worthwhile to handle this more
15531 intelligently, but for now just redisplay from scratch. */
15532 if (!NILP (XBUFFER (w
->buffer
)->word_wrap
))
15535 /* Under bidi reordering, adding or deleting a character in the
15536 beginning of a paragraph, before the first strong directional
15537 character, can change the base direction of the paragraph (unless
15538 the buffer specifies a fixed paragraph direction), which will
15539 require to redisplay the whole paragraph. It might be worthwhile
15540 to find the paragraph limits and widen the range of redisplayed
15541 lines to that, but for now just give up this optimization and
15542 redisplay from scratch. */
15543 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
15544 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
15547 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15548 only if buffer has really changed. The reason is that the gap is
15549 initially at Z for freshly visited files. The code below would
15550 set end_unchanged to 0 in that case. */
15551 if (MODIFF
> SAVE_MODIFF
15552 /* This seems to happen sometimes after saving a buffer. */
15553 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15555 if (GPT
- BEG
< BEG_UNCHANGED
)
15556 BEG_UNCHANGED
= GPT
- BEG
;
15557 if (Z
- GPT
< END_UNCHANGED
)
15558 END_UNCHANGED
= Z
- GPT
;
15561 /* The position of the first and last character that has been changed. */
15562 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15563 last_changed_charpos
= Z
- END_UNCHANGED
;
15565 /* If window starts after a line end, and the last change is in
15566 front of that newline, then changes don't affect the display.
15567 This case happens with stealth-fontification. Note that although
15568 the display is unchanged, glyph positions in the matrix have to
15569 be adjusted, of course. */
15570 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15571 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15572 && ((last_changed_charpos
< CHARPOS (start
)
15573 && CHARPOS (start
) == BEGV
)
15574 || (last_changed_charpos
< CHARPOS (start
) - 1
15575 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15577 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
15578 struct glyph_row
*r0
;
15580 /* Compute how many chars/bytes have been added to or removed
15581 from the buffer. */
15582 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15583 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15585 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15587 /* Give up if PT is not in the window. Note that it already has
15588 been checked at the start of try_window_id that PT is not in
15589 front of the window start. */
15590 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
15593 /* If window start is unchanged, we can reuse the whole matrix
15594 as is, after adjusting glyph positions. No need to compute
15595 the window end again, since its offset from Z hasn't changed. */
15596 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15597 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
15598 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
15599 /* PT must not be in a partially visible line. */
15600 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
15601 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15603 /* Adjust positions in the glyph matrix. */
15604 if (delta
|| delta_bytes
)
15606 struct glyph_row
*r1
15607 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15608 increment_matrix_positions (w
->current_matrix
,
15609 MATRIX_ROW_VPOS (r0
, current_matrix
),
15610 MATRIX_ROW_VPOS (r1
, current_matrix
),
15611 delta
, delta_bytes
);
15614 /* Set the cursor. */
15615 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15617 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15624 /* Handle the case that changes are all below what is displayed in
15625 the window, and that PT is in the window. This shortcut cannot
15626 be taken if ZV is visible in the window, and text has been added
15627 there that is visible in the window. */
15628 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15629 /* ZV is not visible in the window, or there are no
15630 changes at ZV, actually. */
15631 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15632 || first_changed_charpos
== last_changed_charpos
))
15634 struct glyph_row
*r0
;
15636 /* Give up if PT is not in the window. Note that it already has
15637 been checked at the start of try_window_id that PT is not in
15638 front of the window start. */
15639 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15642 /* If window start is unchanged, we can reuse the whole matrix
15643 as is, without changing glyph positions since no text has
15644 been added/removed in front of the window end. */
15645 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15646 if (TEXT_POS_EQUAL_P (start
, r0
->start
.pos
)
15647 /* PT must not be in a partially visible line. */
15648 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15649 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15651 /* We have to compute the window end anew since text
15652 can have been added/removed after it. */
15654 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15655 w
->window_end_bytepos
15656 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15658 /* Set the cursor. */
15659 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15661 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15668 /* Give up if window start is in the changed area.
15670 The condition used to read
15672 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15674 but why that was tested escapes me at the moment. */
15675 if (CHARPOS (start
) >= first_changed_charpos
15676 && CHARPOS (start
) <= last_changed_charpos
)
15679 /* Check that window start agrees with the start of the first glyph
15680 row in its current matrix. Check this after we know the window
15681 start is not in changed text, otherwise positions would not be
15683 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15684 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
15687 /* Give up if the window ends in strings. Overlay strings
15688 at the end are difficult to handle, so don't try. */
15689 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15690 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15693 /* Compute the position at which we have to start displaying new
15694 lines. Some of the lines at the top of the window might be
15695 reusable because they are not displaying changed text. Find the
15696 last row in W's current matrix not affected by changes at the
15697 start of current_buffer. Value is null if changes start in the
15698 first line of window. */
15699 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15700 if (last_unchanged_at_beg_row
)
15702 /* Avoid starting to display in the moddle of a character, a TAB
15703 for instance. This is easier than to set up the iterator
15704 exactly, and it's not a frequent case, so the additional
15705 effort wouldn't really pay off. */
15706 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15707 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15708 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15709 --last_unchanged_at_beg_row
;
15711 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15714 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15716 start_pos
= it
.current
.pos
;
15718 /* Start displaying new lines in the desired matrix at the same
15719 vpos we would use in the current matrix, i.e. below
15720 last_unchanged_at_beg_row. */
15721 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15723 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15724 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15726 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15730 /* There are no reusable lines at the start of the window.
15731 Start displaying in the first text line. */
15732 start_display (&it
, w
, start
);
15733 it
.vpos
= it
.first_vpos
;
15734 start_pos
= it
.current
.pos
;
15737 /* Find the first row that is not affected by changes at the end of
15738 the buffer. Value will be null if there is no unchanged row, in
15739 which case we must redisplay to the end of the window. delta
15740 will be set to the value by which buffer positions beginning with
15741 first_unchanged_at_end_row have to be adjusted due to text
15743 first_unchanged_at_end_row
15744 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15745 IF_DEBUG (debug_delta
= delta
);
15746 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15748 /* Set stop_pos to the buffer position up to which we will have to
15749 display new lines. If first_unchanged_at_end_row != NULL, this
15750 is the buffer position of the start of the line displayed in that
15751 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15752 that we don't stop at a buffer position. */
15754 if (first_unchanged_at_end_row
)
15756 xassert (last_unchanged_at_beg_row
== NULL
15757 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15759 /* If this is a continuation line, move forward to the next one
15760 that isn't. Changes in lines above affect this line.
15761 Caution: this may move first_unchanged_at_end_row to a row
15762 not displaying text. */
15763 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15764 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15765 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15766 < it
.last_visible_y
))
15767 ++first_unchanged_at_end_row
;
15769 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15770 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15771 >= it
.last_visible_y
))
15772 first_unchanged_at_end_row
= NULL
;
15775 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15777 first_unchanged_at_end_vpos
15778 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15779 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15782 else if (last_unchanged_at_beg_row
== NULL
)
15788 /* Either there is no unchanged row at the end, or the one we have
15789 now displays text. This is a necessary condition for the window
15790 end pos calculation at the end of this function. */
15791 xassert (first_unchanged_at_end_row
== NULL
15792 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15794 debug_last_unchanged_at_beg_vpos
15795 = (last_unchanged_at_beg_row
15796 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15798 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15800 #endif /* GLYPH_DEBUG != 0 */
15803 /* Display new lines. Set last_text_row to the last new line
15804 displayed which has text on it, i.e. might end up as being the
15805 line where the window_end_vpos is. */
15806 w
->cursor
.vpos
= -1;
15807 last_text_row
= NULL
;
15808 overlay_arrow_seen
= 0;
15809 while (it
.current_y
< it
.last_visible_y
15810 && !fonts_changed_p
15811 && (first_unchanged_at_end_row
== NULL
15812 || IT_CHARPOS (it
) < stop_pos
))
15814 if (display_line (&it
))
15815 last_text_row
= it
.glyph_row
- 1;
15818 if (fonts_changed_p
)
15822 /* Compute differences in buffer positions, y-positions etc. for
15823 lines reused at the bottom of the window. Compute what we can
15825 if (first_unchanged_at_end_row
15826 /* No lines reused because we displayed everything up to the
15827 bottom of the window. */
15828 && it
.current_y
< it
.last_visible_y
)
15831 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15833 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15834 run
.current_y
= first_unchanged_at_end_row
->y
;
15835 run
.desired_y
= run
.current_y
+ dy
;
15836 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15840 delta
= delta_bytes
= dvpos
= dy
15841 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15842 first_unchanged_at_end_row
= NULL
;
15844 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15847 /* Find the cursor if not already found. We have to decide whether
15848 PT will appear on this window (it sometimes doesn't, but this is
15849 not a very frequent case.) This decision has to be made before
15850 the current matrix is altered. A value of cursor.vpos < 0 means
15851 that PT is either in one of the lines beginning at
15852 first_unchanged_at_end_row or below the window. Don't care for
15853 lines that might be displayed later at the window end; as
15854 mentioned, this is not a frequent case. */
15855 if (w
->cursor
.vpos
< 0)
15857 /* Cursor in unchanged rows at the top? */
15858 if (PT
< CHARPOS (start_pos
)
15859 && last_unchanged_at_beg_row
)
15861 row
= row_containing_pos (w
, PT
,
15862 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15863 last_unchanged_at_beg_row
+ 1, 0);
15865 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15868 /* Start from first_unchanged_at_end_row looking for PT. */
15869 else if (first_unchanged_at_end_row
)
15871 row
= row_containing_pos (w
, PT
- delta
,
15872 first_unchanged_at_end_row
, NULL
, 0);
15874 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15875 delta_bytes
, dy
, dvpos
);
15878 /* Give up if cursor was not found. */
15879 if (w
->cursor
.vpos
< 0)
15881 clear_glyph_matrix (w
->desired_matrix
);
15886 /* Don't let the cursor end in the scroll margins. */
15888 int this_scroll_margin
, cursor_height
;
15890 this_scroll_margin
= max (0, scroll_margin
);
15891 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15892 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15893 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15895 if ((w
->cursor
.y
< this_scroll_margin
15896 && CHARPOS (start
) > BEGV
)
15897 /* Old redisplay didn't take scroll margin into account at the bottom,
15898 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15899 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15900 ? cursor_height
+ this_scroll_margin
15901 : 1)) > it
.last_visible_y
)
15903 w
->cursor
.vpos
= -1;
15904 clear_glyph_matrix (w
->desired_matrix
);
15909 /* Scroll the display. Do it before changing the current matrix so
15910 that xterm.c doesn't get confused about where the cursor glyph is
15912 if (dy
&& run
.height
)
15916 if (FRAME_WINDOW_P (f
))
15918 FRAME_RIF (f
)->update_window_begin_hook (w
);
15919 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15920 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15921 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15925 /* Terminal frame. In this case, dvpos gives the number of
15926 lines to scroll by; dvpos < 0 means scroll up. */
15927 int first_unchanged_at_end_vpos
15928 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15929 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
15930 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15931 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15932 + window_internal_height (w
));
15934 /* Perform the operation on the screen. */
15937 /* Scroll last_unchanged_at_beg_row to the end of the
15938 window down dvpos lines. */
15939 set_terminal_window (f
, end
);
15941 /* On dumb terminals delete dvpos lines at the end
15942 before inserting dvpos empty lines. */
15943 if (!FRAME_SCROLL_REGION_OK (f
))
15944 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15946 /* Insert dvpos empty lines in front of
15947 last_unchanged_at_beg_row. */
15948 ins_del_lines (f
, from
, dvpos
);
15950 else if (dvpos
< 0)
15952 /* Scroll up last_unchanged_at_beg_vpos to the end of
15953 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15954 set_terminal_window (f
, end
);
15956 /* Delete dvpos lines in front of
15957 last_unchanged_at_beg_vpos. ins_del_lines will set
15958 the cursor to the given vpos and emit |dvpos| delete
15960 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15962 /* On a dumb terminal insert dvpos empty lines at the
15964 if (!FRAME_SCROLL_REGION_OK (f
))
15965 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15968 set_terminal_window (f
, 0);
15974 /* Shift reused rows of the current matrix to the right position.
15975 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15977 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15978 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15981 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15982 bottom_vpos
, dvpos
);
15983 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15986 else if (dvpos
> 0)
15988 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15989 bottom_vpos
, dvpos
);
15990 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15991 first_unchanged_at_end_vpos
+ dvpos
, 0);
15994 /* For frame-based redisplay, make sure that current frame and window
15995 matrix are in sync with respect to glyph memory. */
15996 if (!FRAME_WINDOW_P (f
))
15997 sync_frame_with_window_matrix_rows (w
);
15999 /* Adjust buffer positions in reused rows. */
16000 if (delta
|| delta_bytes
)
16001 increment_matrix_positions (current_matrix
,
16002 first_unchanged_at_end_vpos
+ dvpos
,
16003 bottom_vpos
, delta
, delta_bytes
);
16005 /* Adjust Y positions. */
16007 shift_glyph_matrix (w
, current_matrix
,
16008 first_unchanged_at_end_vpos
+ dvpos
,
16011 if (first_unchanged_at_end_row
)
16013 first_unchanged_at_end_row
+= dvpos
;
16014 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
16015 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
16016 first_unchanged_at_end_row
= NULL
;
16019 /* If scrolling up, there may be some lines to display at the end of
16021 last_text_row_at_end
= NULL
;
16024 /* Scrolling up can leave for example a partially visible line
16025 at the end of the window to be redisplayed. */
16026 /* Set last_row to the glyph row in the current matrix where the
16027 window end line is found. It has been moved up or down in
16028 the matrix by dvpos. */
16029 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
16030 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
16032 /* If last_row is the window end line, it should display text. */
16033 xassert (last_row
->displays_text_p
);
16035 /* If window end line was partially visible before, begin
16036 displaying at that line. Otherwise begin displaying with the
16037 line following it. */
16038 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16040 init_to_row_start (&it
, w
, last_row
);
16041 it
.vpos
= last_vpos
;
16042 it
.current_y
= last_row
->y
;
16046 init_to_row_end (&it
, w
, last_row
);
16047 it
.vpos
= 1 + last_vpos
;
16048 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16052 /* We may start in a continuation line. If so, we have to
16053 get the right continuation_lines_width and current_x. */
16054 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16055 it
.hpos
= it
.current_x
= 0;
16057 /* Display the rest of the lines at the window end. */
16058 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16059 while (it
.current_y
< it
.last_visible_y
16060 && !fonts_changed_p
)
16062 /* Is it always sure that the display agrees with lines in
16063 the current matrix? I don't think so, so we mark rows
16064 displayed invalid in the current matrix by setting their
16065 enabled_p flag to zero. */
16066 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16067 if (display_line (&it
))
16068 last_text_row_at_end
= it
.glyph_row
- 1;
16072 /* Update window_end_pos and window_end_vpos. */
16073 if (first_unchanged_at_end_row
16074 && !last_text_row_at_end
)
16076 /* Window end line if one of the preserved rows from the current
16077 matrix. Set row to the last row displaying text in current
16078 matrix starting at first_unchanged_at_end_row, after
16080 xassert (first_unchanged_at_end_row
->displays_text_p
);
16081 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16082 first_unchanged_at_end_row
);
16083 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16085 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16086 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16088 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16089 xassert (w
->window_end_bytepos
>= 0);
16090 IF_DEBUG (debug_method_add (w
, "A"));
16092 else if (last_text_row_at_end
)
16095 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16096 w
->window_end_bytepos
16097 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16099 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16100 xassert (w
->window_end_bytepos
>= 0);
16101 IF_DEBUG (debug_method_add (w
, "B"));
16103 else if (last_text_row
)
16105 /* We have displayed either to the end of the window or at the
16106 end of the window, i.e. the last row with text is to be found
16107 in the desired matrix. */
16109 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16110 w
->window_end_bytepos
16111 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16113 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16114 xassert (w
->window_end_bytepos
>= 0);
16116 else if (first_unchanged_at_end_row
== NULL
16117 && last_text_row
== NULL
16118 && last_text_row_at_end
== NULL
)
16120 /* Displayed to end of window, but no line containing text was
16121 displayed. Lines were deleted at the end of the window. */
16122 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16123 int vpos
= XFASTINT (w
->window_end_vpos
);
16124 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16125 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16128 row
== NULL
&& vpos
>= first_vpos
;
16129 --vpos
, --current_row
, --desired_row
)
16131 if (desired_row
->enabled_p
)
16133 if (desired_row
->displays_text_p
)
16136 else if (current_row
->displays_text_p
)
16140 xassert (row
!= NULL
);
16141 w
->window_end_vpos
= make_number (vpos
+ 1);
16142 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16143 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16144 xassert (w
->window_end_bytepos
>= 0);
16145 IF_DEBUG (debug_method_add (w
, "C"));
16150 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16151 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16153 /* Record that display has not been completed. */
16154 w
->window_end_valid
= Qnil
;
16155 w
->desired_matrix
->no_scrolling_p
= 1;
16163 /***********************************************************************
16164 More debugging support
16165 ***********************************************************************/
16169 void dump_glyph_row
P_ ((struct glyph_row
*, int, int));
16170 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
16171 void dump_glyph
P_ ((struct glyph_row
*, struct glyph
*, int));
16174 /* Dump the contents of glyph matrix MATRIX on stderr.
16176 GLYPHS 0 means don't show glyph contents.
16177 GLYPHS 1 means show glyphs in short form
16178 GLYPHS > 1 means show glyphs in long form. */
16181 dump_glyph_matrix (matrix
, glyphs
)
16182 struct glyph_matrix
*matrix
;
16186 for (i
= 0; i
< matrix
->nrows
; ++i
)
16187 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16191 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16192 the glyph row and area where the glyph comes from. */
16195 dump_glyph (row
, glyph
, area
)
16196 struct glyph_row
*row
;
16197 struct glyph
*glyph
;
16200 if (glyph
->type
== CHAR_GLYPH
)
16203 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16204 glyph
- row
->glyphs
[TEXT_AREA
],
16207 (BUFFERP (glyph
->object
)
16209 : (STRINGP (glyph
->object
)
16212 glyph
->pixel_width
,
16214 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16218 glyph
->left_box_line_p
,
16219 glyph
->right_box_line_p
);
16221 else if (glyph
->type
== STRETCH_GLYPH
)
16224 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16225 glyph
- row
->glyphs
[TEXT_AREA
],
16228 (BUFFERP (glyph
->object
)
16230 : (STRINGP (glyph
->object
)
16233 glyph
->pixel_width
,
16237 glyph
->left_box_line_p
,
16238 glyph
->right_box_line_p
);
16240 else if (glyph
->type
== IMAGE_GLYPH
)
16243 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16244 glyph
- row
->glyphs
[TEXT_AREA
],
16247 (BUFFERP (glyph
->object
)
16249 : (STRINGP (glyph
->object
)
16252 glyph
->pixel_width
,
16256 glyph
->left_box_line_p
,
16257 glyph
->right_box_line_p
);
16259 else if (glyph
->type
== COMPOSITE_GLYPH
)
16262 " %5d %4c %6d %c %3d 0x%05x",
16263 glyph
- row
->glyphs
[TEXT_AREA
],
16266 (BUFFERP (glyph
->object
)
16268 : (STRINGP (glyph
->object
)
16271 glyph
->pixel_width
,
16273 if (glyph
->u
.cmp
.automatic
)
16276 glyph
->u
.cmp
.from
, glyph
->u
.cmp
.to
);
16277 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16279 glyph
->left_box_line_p
,
16280 glyph
->right_box_line_p
);
16285 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16286 GLYPHS 0 means don't show glyph contents.
16287 GLYPHS 1 means show glyphs in short form
16288 GLYPHS > 1 means show glyphs in long form. */
16291 dump_glyph_row (row
, vpos
, glyphs
)
16292 struct glyph_row
*row
;
16297 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16298 fprintf (stderr
, "======================================================================\n");
16300 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16301 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16303 MATRIX_ROW_START_CHARPOS (row
),
16304 MATRIX_ROW_END_CHARPOS (row
),
16305 row
->used
[TEXT_AREA
],
16306 row
->contains_overlapping_glyphs_p
,
16308 row
->truncated_on_left_p
,
16309 row
->truncated_on_right_p
,
16311 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16312 row
->displays_text_p
,
16315 row
->ends_in_middle_of_char_p
,
16316 row
->starts_in_middle_of_char_p
,
16322 row
->visible_height
,
16325 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16326 row
->end
.overlay_string_index
,
16327 row
->continuation_lines_width
);
16328 fprintf (stderr
, "%9d %5d\n",
16329 CHARPOS (row
->start
.string_pos
),
16330 CHARPOS (row
->end
.string_pos
));
16331 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16332 row
->end
.dpvec_index
);
16339 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16341 struct glyph
*glyph
= row
->glyphs
[area
];
16342 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16344 /* Glyph for a line end in text. */
16345 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16348 if (glyph
< glyph_end
)
16349 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16351 for (; glyph
< glyph_end
; ++glyph
)
16352 dump_glyph (row
, glyph
, area
);
16355 else if (glyphs
== 1)
16359 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16361 char *s
= (char *) alloca (row
->used
[area
] + 1);
16364 for (i
= 0; i
< row
->used
[area
]; ++i
)
16366 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16367 if (glyph
->type
== CHAR_GLYPH
16368 && glyph
->u
.ch
< 0x80
16369 && glyph
->u
.ch
>= ' ')
16370 s
[i
] = glyph
->u
.ch
;
16376 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16382 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16383 Sdump_glyph_matrix
, 0, 1, "p",
16384 doc
: /* Dump the current matrix of the selected window to stderr.
16385 Shows contents of glyph row structures. With non-nil
16386 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16387 glyphs in short form, otherwise show glyphs in long form. */)
16389 Lisp_Object glyphs
;
16391 struct window
*w
= XWINDOW (selected_window
);
16392 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16394 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16395 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16396 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16397 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16398 fprintf (stderr
, "=============================================\n");
16399 dump_glyph_matrix (w
->current_matrix
,
16400 NILP (glyphs
) ? 0 : XINT (glyphs
));
16405 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16406 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16409 struct frame
*f
= XFRAME (selected_frame
);
16410 dump_glyph_matrix (f
->current_matrix
, 1);
16415 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16416 doc
: /* Dump glyph row ROW to stderr.
16417 GLYPH 0 means don't dump glyphs.
16418 GLYPH 1 means dump glyphs in short form.
16419 GLYPH > 1 or omitted means dump glyphs in long form. */)
16421 Lisp_Object row
, glyphs
;
16423 struct glyph_matrix
*matrix
;
16426 CHECK_NUMBER (row
);
16427 matrix
= XWINDOW (selected_window
)->current_matrix
;
16429 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16430 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16432 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16437 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16438 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16439 GLYPH 0 means don't dump glyphs.
16440 GLYPH 1 means dump glyphs in short form.
16441 GLYPH > 1 or omitted means dump glyphs in long form. */)
16443 Lisp_Object row
, glyphs
;
16445 struct frame
*sf
= SELECTED_FRAME ();
16446 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16449 CHECK_NUMBER (row
);
16451 if (vpos
>= 0 && vpos
< m
->nrows
)
16452 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16453 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16458 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16459 doc
: /* Toggle tracing of redisplay.
16460 With ARG, turn tracing on if and only if ARG is positive. */)
16465 trace_redisplay_p
= !trace_redisplay_p
;
16468 arg
= Fprefix_numeric_value (arg
);
16469 trace_redisplay_p
= XINT (arg
) > 0;
16476 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16477 doc
: /* Like `format', but print result to stderr.
16478 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16483 Lisp_Object s
= Fformat (nargs
, args
);
16484 fprintf (stderr
, "%s", SDATA (s
));
16488 #endif /* GLYPH_DEBUG */
16492 /***********************************************************************
16493 Building Desired Matrix Rows
16494 ***********************************************************************/
16496 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16497 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16499 static struct glyph_row
*
16500 get_overlay_arrow_glyph_row (w
, overlay_arrow_string
)
16502 Lisp_Object overlay_arrow_string
;
16504 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16505 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16506 struct buffer
*old
= current_buffer
;
16507 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16508 int arrow_len
= SCHARS (overlay_arrow_string
);
16509 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16510 const unsigned char *p
;
16513 int n_glyphs_before
;
16515 set_buffer_temp (buffer
);
16516 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16517 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16518 SET_TEXT_POS (it
.position
, 0, 0);
16520 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
16522 while (p
< arrow_end
)
16524 Lisp_Object face
, ilisp
;
16526 /* Get the next character. */
16528 it
.c
= string_char_and_length (p
, &it
.len
);
16530 it
.c
= *p
, it
.len
= 1;
16533 /* Get its face. */
16534 ilisp
= make_number (p
- arrow_string
);
16535 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16536 it
.face_id
= compute_char_face (f
, it
.c
, face
);
16538 /* Compute its width, get its glyphs. */
16539 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16540 SET_TEXT_POS (it
.position
, -1, -1);
16541 PRODUCE_GLYPHS (&it
);
16543 /* If this character doesn't fit any more in the line, we have
16544 to remove some glyphs. */
16545 if (it
.current_x
> it
.last_visible_x
)
16547 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16552 set_buffer_temp (old
);
16553 return it
.glyph_row
;
16557 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16558 glyphs are only inserted for terminal frames since we can't really
16559 win with truncation glyphs when partially visible glyphs are
16560 involved. Which glyphs to insert is determined by
16561 produce_special_glyphs. */
16564 insert_left_trunc_glyphs (it
)
16567 struct it truncate_it
;
16568 struct glyph
*from
, *end
, *to
, *toend
;
16570 xassert (!FRAME_WINDOW_P (it
->f
));
16572 /* Get the truncation glyphs. */
16574 truncate_it
.current_x
= 0;
16575 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16576 truncate_it
.glyph_row
= &scratch_glyph_row
;
16577 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16578 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16579 truncate_it
.object
= make_number (0);
16580 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16582 /* Overwrite glyphs from IT with truncation glyphs. */
16583 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16584 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16585 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16586 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16591 /* There may be padding glyphs left over. Overwrite them too. */
16592 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16594 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16600 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16604 /* Compute the pixel height and width of IT->glyph_row.
16606 Most of the time, ascent and height of a display line will be equal
16607 to the max_ascent and max_height values of the display iterator
16608 structure. This is not the case if
16610 1. We hit ZV without displaying anything. In this case, max_ascent
16611 and max_height will be zero.
16613 2. We have some glyphs that don't contribute to the line height.
16614 (The glyph row flag contributes_to_line_height_p is for future
16615 pixmap extensions).
16617 The first case is easily covered by using default values because in
16618 these cases, the line height does not really matter, except that it
16619 must not be zero. */
16622 compute_line_metrics (it
)
16625 struct glyph_row
*row
= it
->glyph_row
;
16628 if (FRAME_WINDOW_P (it
->f
))
16630 int i
, min_y
, max_y
;
16632 /* The line may consist of one space only, that was added to
16633 place the cursor on it. If so, the row's height hasn't been
16635 if (row
->height
== 0)
16637 if (it
->max_ascent
+ it
->max_descent
== 0)
16638 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16639 row
->ascent
= it
->max_ascent
;
16640 row
->height
= it
->max_ascent
+ it
->max_descent
;
16641 row
->phys_ascent
= it
->max_phys_ascent
;
16642 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16643 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16646 /* Compute the width of this line. */
16647 row
->pixel_width
= row
->x
;
16648 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16649 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16651 xassert (row
->pixel_width
>= 0);
16652 xassert (row
->ascent
>= 0 && row
->height
> 0);
16654 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16655 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16657 /* If first line's physical ascent is larger than its logical
16658 ascent, use the physical ascent, and make the row taller.
16659 This makes accented characters fully visible. */
16660 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16661 && row
->phys_ascent
> row
->ascent
)
16663 row
->height
+= row
->phys_ascent
- row
->ascent
;
16664 row
->ascent
= row
->phys_ascent
;
16667 /* Compute how much of the line is visible. */
16668 row
->visible_height
= row
->height
;
16670 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16671 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16673 if (row
->y
< min_y
)
16674 row
->visible_height
-= min_y
- row
->y
;
16675 if (row
->y
+ row
->height
> max_y
)
16676 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16680 row
->pixel_width
= row
->used
[TEXT_AREA
];
16681 if (row
->continued_p
)
16682 row
->pixel_width
-= it
->continuation_pixel_width
;
16683 else if (row
->truncated_on_right_p
)
16684 row
->pixel_width
-= it
->truncation_pixel_width
;
16685 row
->ascent
= row
->phys_ascent
= 0;
16686 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16687 row
->extra_line_spacing
= 0;
16690 /* Compute a hash code for this row. */
16692 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16693 for (i
= 0; i
< row
->used
[area
]; ++i
)
16694 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16695 + row
->glyphs
[area
][i
].u
.val
16696 + row
->glyphs
[area
][i
].face_id
16697 + row
->glyphs
[area
][i
].padding_p
16698 + (row
->glyphs
[area
][i
].type
<< 2));
16700 it
->max_ascent
= it
->max_descent
= 0;
16701 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16705 /* Append one space to the glyph row of iterator IT if doing a
16706 window-based redisplay. The space has the same face as
16707 IT->face_id. Value is non-zero if a space was added.
16709 This function is called to make sure that there is always one glyph
16710 at the end of a glyph row that the cursor can be set on under
16711 window-systems. (If there weren't such a glyph we would not know
16712 how wide and tall a box cursor should be displayed).
16714 At the same time this space let's a nicely handle clearing to the
16715 end of the line if the row ends in italic text. */
16718 append_space_for_newline (it
, default_face_p
)
16720 int default_face_p
;
16722 if (FRAME_WINDOW_P (it
->f
))
16724 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16726 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16727 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16729 /* Save some values that must not be changed.
16730 Must save IT->c and IT->len because otherwise
16731 ITERATOR_AT_END_P wouldn't work anymore after
16732 append_space_for_newline has been called. */
16733 enum display_element_type saved_what
= it
->what
;
16734 int saved_c
= it
->c
, saved_len
= it
->len
;
16735 int saved_x
= it
->current_x
;
16736 int saved_face_id
= it
->face_id
;
16737 struct text_pos saved_pos
;
16738 Lisp_Object saved_object
;
16741 saved_object
= it
->object
;
16742 saved_pos
= it
->position
;
16744 it
->what
= IT_CHARACTER
;
16745 bzero (&it
->position
, sizeof it
->position
);
16746 it
->object
= make_number (0);
16750 if (default_face_p
)
16751 it
->face_id
= DEFAULT_FACE_ID
;
16752 else if (it
->face_before_selective_p
)
16753 it
->face_id
= it
->saved_face_id
;
16754 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16755 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16757 PRODUCE_GLYPHS (it
);
16759 it
->override_ascent
= -1;
16760 it
->constrain_row_ascent_descent_p
= 0;
16761 it
->current_x
= saved_x
;
16762 it
->object
= saved_object
;
16763 it
->position
= saved_pos
;
16764 it
->what
= saved_what
;
16765 it
->face_id
= saved_face_id
;
16766 it
->len
= saved_len
;
16776 /* Extend the face of the last glyph in the text area of IT->glyph_row
16777 to the end of the display line. Called from display_line.
16778 If the glyph row is empty, add a space glyph to it so that we
16779 know the face to draw. Set the glyph row flag fill_line_p. */
16782 extend_face_to_end_of_line (it
)
16786 struct frame
*f
= it
->f
;
16788 /* If line is already filled, do nothing. */
16789 if (it
->current_x
>= it
->last_visible_x
)
16792 /* Face extension extends the background and box of IT->face_id
16793 to the end of the line. If the background equals the background
16794 of the frame, we don't have to do anything. */
16795 if (it
->face_before_selective_p
)
16796 face
= FACE_FROM_ID (it
->f
, it
->saved_face_id
);
16798 face
= FACE_FROM_ID (f
, it
->face_id
);
16800 if (FRAME_WINDOW_P (f
)
16801 && it
->glyph_row
->displays_text_p
16802 && face
->box
== FACE_NO_BOX
16803 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16807 /* Set the glyph row flag indicating that the face of the last glyph
16808 in the text area has to be drawn to the end of the text area. */
16809 it
->glyph_row
->fill_line_p
= 1;
16811 /* If current character of IT is not ASCII, make sure we have the
16812 ASCII face. This will be automatically undone the next time
16813 get_next_display_element returns a multibyte character. Note
16814 that the character will always be single byte in unibyte
16816 if (!ASCII_CHAR_P (it
->c
))
16818 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16821 if (FRAME_WINDOW_P (f
))
16823 /* If the row is empty, add a space with the current face of IT,
16824 so that we know which face to draw. */
16825 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16827 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16828 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16829 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16834 /* Save some values that must not be changed. */
16835 int saved_x
= it
->current_x
;
16836 struct text_pos saved_pos
;
16837 Lisp_Object saved_object
;
16838 enum display_element_type saved_what
= it
->what
;
16839 int saved_face_id
= it
->face_id
;
16841 saved_object
= it
->object
;
16842 saved_pos
= it
->position
;
16844 it
->what
= IT_CHARACTER
;
16845 bzero (&it
->position
, sizeof it
->position
);
16846 it
->object
= make_number (0);
16849 it
->face_id
= face
->id
;
16851 PRODUCE_GLYPHS (it
);
16853 while (it
->current_x
<= it
->last_visible_x
)
16854 PRODUCE_GLYPHS (it
);
16856 /* Don't count these blanks really. It would let us insert a left
16857 truncation glyph below and make us set the cursor on them, maybe. */
16858 it
->current_x
= saved_x
;
16859 it
->object
= saved_object
;
16860 it
->position
= saved_pos
;
16861 it
->what
= saved_what
;
16862 it
->face_id
= saved_face_id
;
16867 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16868 trailing whitespace. */
16871 trailing_whitespace_p (charpos
)
16874 int bytepos
= CHAR_TO_BYTE (charpos
);
16877 while (bytepos
< ZV_BYTE
16878 && (c
= FETCH_CHAR (bytepos
),
16879 c
== ' ' || c
== '\t'))
16882 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16884 if (bytepos
!= PT_BYTE
)
16891 /* Highlight trailing whitespace, if any, in ROW. */
16894 highlight_trailing_whitespace (f
, row
)
16896 struct glyph_row
*row
;
16898 int used
= row
->used
[TEXT_AREA
];
16902 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16903 struct glyph
*glyph
= start
+ used
- 1;
16905 if (row
->reversed_p
)
16907 /* Right-to-left rows need to be processed in the opposite
16908 direction, so swap the edge pointers. */
16910 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
16913 /* Skip over glyphs inserted to display the cursor at the
16914 end of a line, for extending the face of the last glyph
16915 to the end of the line on terminals, and for truncation
16916 and continuation glyphs. */
16917 if (!row
->reversed_p
)
16919 while (glyph
>= start
16920 && glyph
->type
== CHAR_GLYPH
16921 && INTEGERP (glyph
->object
))
16926 while (glyph
<= start
16927 && glyph
->type
== CHAR_GLYPH
16928 && INTEGERP (glyph
->object
))
16932 /* If last glyph is a space or stretch, and it's trailing
16933 whitespace, set the face of all trailing whitespace glyphs in
16934 IT->glyph_row to `trailing-whitespace'. */
16935 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
16936 && BUFFERP (glyph
->object
)
16937 && (glyph
->type
== STRETCH_GLYPH
16938 || (glyph
->type
== CHAR_GLYPH
16939 && glyph
->u
.ch
== ' '))
16940 && trailing_whitespace_p (glyph
->charpos
))
16942 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
16946 if (!row
->reversed_p
)
16948 while (glyph
>= start
16949 && BUFFERP (glyph
->object
)
16950 && (glyph
->type
== STRETCH_GLYPH
16951 || (glyph
->type
== CHAR_GLYPH
16952 && glyph
->u
.ch
== ' ')))
16953 (glyph
--)->face_id
= face_id
;
16957 while (glyph
<= start
16958 && BUFFERP (glyph
->object
)
16959 && (glyph
->type
== STRETCH_GLYPH
16960 || (glyph
->type
== CHAR_GLYPH
16961 && glyph
->u
.ch
== ' ')))
16962 (glyph
++)->face_id
= face_id
;
16969 /* Value is non-zero if glyph row ROW in window W should be
16970 used to hold the cursor. */
16973 cursor_row_p (w
, row
)
16975 struct glyph_row
*row
;
16977 int cursor_row_p
= 1;
16979 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
16981 /* Suppose the row ends on a string.
16982 Unless the row is continued, that means it ends on a newline
16983 in the string. If it's anything other than a display string
16984 (e.g. a before-string from an overlay), we don't want the
16985 cursor there. (This heuristic seems to give the optimal
16986 behavior for the various types of multi-line strings.) */
16987 if (CHARPOS (row
->end
.string_pos
) >= 0)
16989 if (row
->continued_p
)
16993 /* Check for `display' property. */
16994 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
16995 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
16996 struct glyph
*glyph
;
16999 for (glyph
= end
; glyph
>= beg
; --glyph
)
17000 if (STRINGP (glyph
->object
))
17003 = Fget_char_property (make_number (PT
),
17007 && display_prop_string_p (prop
, glyph
->object
));
17012 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17014 /* If the row ends in middle of a real character,
17015 and the line is continued, we want the cursor here.
17016 That's because MATRIX_ROW_END_CHARPOS would equal
17017 PT if PT is before the character. */
17018 if (!row
->ends_in_ellipsis_p
)
17019 cursor_row_p
= row
->continued_p
;
17021 /* If the row ends in an ellipsis, then
17022 MATRIX_ROW_END_CHARPOS will equal point after the invisible text.
17023 We want that position to be displayed after the ellipsis. */
17026 /* If the row ends at ZV, display the cursor at the end of that
17027 row instead of at the start of the row below. */
17028 else if (row
->ends_at_zv_p
)
17034 return cursor_row_p
;
17039 /* Push the display property PROP so that it will be rendered at the
17040 current position in IT. Return 1 if PROP was successfully pushed,
17044 push_display_prop (struct it
*it
, Lisp_Object prop
)
17048 if (STRINGP (prop
))
17050 if (SCHARS (prop
) == 0)
17057 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17058 it
->current
.overlay_string_index
= -1;
17059 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17060 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17061 it
->method
= GET_FROM_STRING
;
17062 it
->stop_charpos
= 0;
17064 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17066 it
->method
= GET_FROM_STRETCH
;
17069 #ifdef HAVE_WINDOW_SYSTEM
17070 else if (IMAGEP (prop
))
17072 it
->what
= IT_IMAGE
;
17073 it
->image_id
= lookup_image (it
->f
, prop
);
17074 it
->method
= GET_FROM_IMAGE
;
17076 #endif /* HAVE_WINDOW_SYSTEM */
17079 pop_it (it
); /* bogus display property, give up */
17086 /* Return the character-property PROP at the current position in IT. */
17089 get_it_property (it
, prop
)
17093 Lisp_Object position
;
17095 if (STRINGP (it
->object
))
17096 position
= make_number (IT_STRING_CHARPOS (*it
));
17097 else if (BUFFERP (it
->object
))
17098 position
= make_number (IT_CHARPOS (*it
));
17102 return Fget_char_property (position
, prop
, it
->object
);
17105 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17108 handle_line_prefix (struct it
*it
)
17110 Lisp_Object prefix
;
17111 if (it
->continuation_lines_width
> 0)
17113 prefix
= get_it_property (it
, Qwrap_prefix
);
17115 prefix
= Vwrap_prefix
;
17119 prefix
= get_it_property (it
, Qline_prefix
);
17121 prefix
= Vline_prefix
;
17123 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17125 /* If the prefix is wider than the window, and we try to wrap
17126 it, it would acquire its own wrap prefix, and so on till the
17127 iterator stack overflows. So, don't wrap the prefix. */
17128 it
->line_wrap
= TRUNCATE
;
17129 it
->avoid_cursor_p
= 1;
17135 /* Construct the glyph row IT->glyph_row in the desired matrix of
17136 IT->w from text at the current position of IT. See dispextern.h
17137 for an overview of struct it. Value is non-zero if
17138 IT->glyph_row displays text, as opposed to a line displaying ZV
17145 struct glyph_row
*row
= it
->glyph_row
;
17146 Lisp_Object overlay_arrow_string
;
17148 int may_wrap
= 0, wrap_x
;
17149 int wrap_row_used
= -1, wrap_row_ascent
, wrap_row_height
;
17150 int wrap_row_phys_ascent
, wrap_row_phys_height
;
17151 int wrap_row_extra_line_spacing
;
17152 struct display_pos row_end
;
17155 /* We always start displaying at hpos zero even if hscrolled. */
17156 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17158 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17159 >= it
->w
->desired_matrix
->nrows
)
17161 it
->w
->nrows_scale_factor
++;
17162 fonts_changed_p
= 1;
17166 /* Is IT->w showing the region? */
17167 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17169 /* Clear the result glyph row and enable it. */
17170 prepare_desired_row (row
);
17172 row
->y
= it
->current_y
;
17173 row
->start
= it
->start
;
17174 row
->continuation_lines_width
= it
->continuation_lines_width
;
17175 row
->displays_text_p
= 1;
17176 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17177 it
->starts_in_middle_of_char_p
= 0;
17179 /* Arrange the overlays nicely for our purposes. Usually, we call
17180 display_line on only one line at a time, in which case this
17181 can't really hurt too much, or we call it on lines which appear
17182 one after another in the buffer, in which case all calls to
17183 recenter_overlay_lists but the first will be pretty cheap. */
17184 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17186 /* Move over display elements that are not visible because we are
17187 hscrolled. This may stop at an x-position < IT->first_visible_x
17188 if the first glyph is partially visible or if we hit a line end. */
17189 if (it
->current_x
< it
->first_visible_x
)
17191 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17192 MOVE_TO_POS
| MOVE_TO_X
);
17196 /* We only do this when not calling `move_it_in_display_line_to'
17197 above, because move_it_in_display_line_to calls
17198 handle_line_prefix itself. */
17199 handle_line_prefix (it
);
17202 /* Get the initial row height. This is either the height of the
17203 text hscrolled, if there is any, or zero. */
17204 row
->ascent
= it
->max_ascent
;
17205 row
->height
= it
->max_ascent
+ it
->max_descent
;
17206 row
->phys_ascent
= it
->max_phys_ascent
;
17207 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17208 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17210 /* Loop generating characters. The loop is left with IT on the next
17211 character to display. */
17214 int n_glyphs_before
, hpos_before
, x_before
;
17216 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17218 /* Retrieve the next thing to display. Value is zero if end of
17220 if (!get_next_display_element (it
))
17222 /* Maybe add a space at the end of this line that is used to
17223 display the cursor there under X. Set the charpos of the
17224 first glyph of blank lines not corresponding to any text
17226 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17227 row
->exact_window_width_line_p
= 1;
17228 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17229 || row
->used
[TEXT_AREA
] == 0)
17231 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17232 row
->displays_text_p
= 0;
17234 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
17235 && (!MINI_WINDOW_P (it
->w
)
17236 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17237 row
->indicate_empty_line_p
= 1;
17240 it
->continuation_lines_width
= 0;
17241 row
->ends_at_zv_p
= 1;
17242 /* A row that displays right-to-left text must always have
17243 its last face extended all the way to the end of line,
17244 even if this row ends in ZV. */
17245 if (row
->reversed_p
)
17246 extend_face_to_end_of_line (it
);
17250 /* Now, get the metrics of what we want to display. This also
17251 generates glyphs in `row' (which is IT->glyph_row). */
17252 n_glyphs_before
= row
->used
[TEXT_AREA
];
17255 /* Remember the line height so far in case the next element doesn't
17256 fit on the line. */
17257 if (it
->line_wrap
!= TRUNCATE
)
17259 ascent
= it
->max_ascent
;
17260 descent
= it
->max_descent
;
17261 phys_ascent
= it
->max_phys_ascent
;
17262 phys_descent
= it
->max_phys_descent
;
17264 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17266 if (IT_DISPLAYING_WHITESPACE (it
))
17272 wrap_row_used
= row
->used
[TEXT_AREA
];
17273 wrap_row_ascent
= row
->ascent
;
17274 wrap_row_height
= row
->height
;
17275 wrap_row_phys_ascent
= row
->phys_ascent
;
17276 wrap_row_phys_height
= row
->phys_height
;
17277 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17283 PRODUCE_GLYPHS (it
);
17285 /* If this display element was in marginal areas, continue with
17287 if (it
->area
!= TEXT_AREA
)
17289 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17290 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17291 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17292 row
->phys_height
= max (row
->phys_height
,
17293 it
->max_phys_ascent
+ it
->max_phys_descent
);
17294 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17295 it
->max_extra_line_spacing
);
17296 set_iterator_to_next (it
, 1);
17300 /* Does the display element fit on the line? If we truncate
17301 lines, we should draw past the right edge of the window. If
17302 we don't truncate, we want to stop so that we can display the
17303 continuation glyph before the right margin. If lines are
17304 continued, there are two possible strategies for characters
17305 resulting in more than 1 glyph (e.g. tabs): Display as many
17306 glyphs as possible in this line and leave the rest for the
17307 continuation line, or display the whole element in the next
17308 line. Original redisplay did the former, so we do it also. */
17309 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17310 hpos_before
= it
->hpos
;
17313 if (/* Not a newline. */
17315 /* Glyphs produced fit entirely in the line. */
17316 && it
->current_x
< it
->last_visible_x
)
17318 it
->hpos
+= nglyphs
;
17319 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17320 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17321 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17322 row
->phys_height
= max (row
->phys_height
,
17323 it
->max_phys_ascent
+ it
->max_phys_descent
);
17324 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17325 it
->max_extra_line_spacing
);
17326 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17327 row
->x
= x
- it
->first_visible_x
;
17332 struct glyph
*glyph
;
17334 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17336 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17337 new_x
= x
+ glyph
->pixel_width
;
17339 if (/* Lines are continued. */
17340 it
->line_wrap
!= TRUNCATE
17341 && (/* Glyph doesn't fit on the line. */
17342 new_x
> it
->last_visible_x
17343 /* Or it fits exactly on a window system frame. */
17344 || (new_x
== it
->last_visible_x
17345 && FRAME_WINDOW_P (it
->f
))))
17347 /* End of a continued line. */
17350 || (new_x
== it
->last_visible_x
17351 && FRAME_WINDOW_P (it
->f
)))
17353 /* Current glyph is the only one on the line or
17354 fits exactly on the line. We must continue
17355 the line because we can't draw the cursor
17356 after the glyph. */
17357 row
->continued_p
= 1;
17358 it
->current_x
= new_x
;
17359 it
->continuation_lines_width
+= new_x
;
17361 if (i
== nglyphs
- 1)
17363 /* If line-wrap is on, check if a previous
17364 wrap point was found. */
17365 if (wrap_row_used
> 0
17366 /* Even if there is a previous wrap
17367 point, continue the line here as
17368 usual, if (i) the previous character
17369 was a space or tab AND (ii) the
17370 current character is not. */
17372 || IT_DISPLAYING_WHITESPACE (it
)))
17375 set_iterator_to_next (it
, 1);
17376 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17378 if (!get_next_display_element (it
))
17380 row
->exact_window_width_line_p
= 1;
17381 it
->continuation_lines_width
= 0;
17382 row
->continued_p
= 0;
17383 row
->ends_at_zv_p
= 1;
17385 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17387 row
->continued_p
= 0;
17388 row
->exact_window_width_line_p
= 1;
17393 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17394 && !FRAME_WINDOW_P (it
->f
))
17396 /* A padding glyph that doesn't fit on this line.
17397 This means the whole character doesn't fit
17399 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17401 /* Fill the rest of the row with continuation
17402 glyphs like in 20.x. */
17403 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17404 < row
->glyphs
[1 + TEXT_AREA
])
17405 produce_special_glyphs (it
, IT_CONTINUATION
);
17407 row
->continued_p
= 1;
17408 it
->current_x
= x_before
;
17409 it
->continuation_lines_width
+= x_before
;
17411 /* Restore the height to what it was before the
17412 element not fitting on the line. */
17413 it
->max_ascent
= ascent
;
17414 it
->max_descent
= descent
;
17415 it
->max_phys_ascent
= phys_ascent
;
17416 it
->max_phys_descent
= phys_descent
;
17418 else if (wrap_row_used
> 0)
17422 it
->continuation_lines_width
+= wrap_x
;
17423 row
->used
[TEXT_AREA
] = wrap_row_used
;
17424 row
->ascent
= wrap_row_ascent
;
17425 row
->height
= wrap_row_height
;
17426 row
->phys_ascent
= wrap_row_phys_ascent
;
17427 row
->phys_height
= wrap_row_phys_height
;
17428 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17429 row
->continued_p
= 1;
17430 row
->ends_at_zv_p
= 0;
17431 row
->exact_window_width_line_p
= 0;
17432 it
->continuation_lines_width
+= x
;
17434 /* Make sure that a non-default face is extended
17435 up to the right margin of the window. */
17436 extend_face_to_end_of_line (it
);
17438 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17440 /* A TAB that extends past the right edge of the
17441 window. This produces a single glyph on
17442 window system frames. We leave the glyph in
17443 this row and let it fill the row, but don't
17444 consume the TAB. */
17445 it
->continuation_lines_width
+= it
->last_visible_x
;
17446 row
->ends_in_middle_of_char_p
= 1;
17447 row
->continued_p
= 1;
17448 glyph
->pixel_width
= it
->last_visible_x
- x
;
17449 it
->starts_in_middle_of_char_p
= 1;
17453 /* Something other than a TAB that draws past
17454 the right edge of the window. Restore
17455 positions to values before the element. */
17456 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17458 /* Display continuation glyphs. */
17459 if (!FRAME_WINDOW_P (it
->f
))
17460 produce_special_glyphs (it
, IT_CONTINUATION
);
17461 row
->continued_p
= 1;
17463 it
->current_x
= x_before
;
17464 it
->continuation_lines_width
+= x
;
17465 extend_face_to_end_of_line (it
);
17467 if (nglyphs
> 1 && i
> 0)
17469 row
->ends_in_middle_of_char_p
= 1;
17470 it
->starts_in_middle_of_char_p
= 1;
17473 /* Restore the height to what it was before the
17474 element not fitting on the line. */
17475 it
->max_ascent
= ascent
;
17476 it
->max_descent
= descent
;
17477 it
->max_phys_ascent
= phys_ascent
;
17478 it
->max_phys_descent
= phys_descent
;
17483 else if (new_x
> it
->first_visible_x
)
17485 /* Increment number of glyphs actually displayed. */
17488 if (x
< it
->first_visible_x
)
17489 /* Glyph is partially visible, i.e. row starts at
17490 negative X position. */
17491 row
->x
= x
- it
->first_visible_x
;
17495 /* Glyph is completely off the left margin of the
17496 window. This should not happen because of the
17497 move_it_in_display_line at the start of this
17498 function, unless the text display area of the
17499 window is empty. */
17500 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17504 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17505 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17506 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17507 row
->phys_height
= max (row
->phys_height
,
17508 it
->max_phys_ascent
+ it
->max_phys_descent
);
17509 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17510 it
->max_extra_line_spacing
);
17512 /* End of this display line if row is continued. */
17513 if (row
->continued_p
|| row
->ends_at_zv_p
)
17518 /* Is this a line end? If yes, we're also done, after making
17519 sure that a non-default face is extended up to the right
17520 margin of the window. */
17521 if (ITERATOR_AT_END_OF_LINE_P (it
))
17523 int used_before
= row
->used
[TEXT_AREA
];
17525 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17527 /* Add a space at the end of the line that is used to
17528 display the cursor there. */
17529 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17530 append_space_for_newline (it
, 0);
17532 /* Extend the face to the end of the line. */
17533 extend_face_to_end_of_line (it
);
17535 /* Make sure we have the position. */
17536 if (used_before
== 0)
17537 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17539 /* Consume the line end. This skips over invisible lines. */
17540 set_iterator_to_next (it
, 1);
17541 it
->continuation_lines_width
= 0;
17545 /* Proceed with next display element. Note that this skips
17546 over lines invisible because of selective display. */
17547 set_iterator_to_next (it
, 1);
17549 /* If we truncate lines, we are done when the last displayed
17550 glyphs reach past the right margin of the window. */
17551 if (it
->line_wrap
== TRUNCATE
17552 && (FRAME_WINDOW_P (it
->f
)
17553 ? (it
->current_x
>= it
->last_visible_x
)
17554 : (it
->current_x
> it
->last_visible_x
)))
17556 /* Maybe add truncation glyphs. */
17557 if (!FRAME_WINDOW_P (it
->f
))
17561 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17562 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17565 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17567 row
->used
[TEXT_AREA
] = i
;
17568 produce_special_glyphs (it
, IT_TRUNCATION
);
17571 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17573 /* Don't truncate if we can overflow newline into fringe. */
17574 if (!get_next_display_element (it
))
17576 it
->continuation_lines_width
= 0;
17577 row
->ends_at_zv_p
= 1;
17578 row
->exact_window_width_line_p
= 1;
17581 if (ITERATOR_AT_END_OF_LINE_P (it
))
17583 row
->exact_window_width_line_p
= 1;
17584 goto at_end_of_line
;
17588 row
->truncated_on_right_p
= 1;
17589 it
->continuation_lines_width
= 0;
17590 reseat_at_next_visible_line_start (it
, 0);
17591 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
17592 it
->hpos
= hpos_before
;
17593 it
->current_x
= x_before
;
17598 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17599 at the left window margin. */
17600 if (it
->first_visible_x
17601 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
17603 if (!FRAME_WINDOW_P (it
->f
))
17604 insert_left_trunc_glyphs (it
);
17605 row
->truncated_on_left_p
= 1;
17608 /* If the start of this line is the overlay arrow-position, then
17609 mark this glyph row as the one containing the overlay arrow.
17610 This is clearly a mess with variable size fonts. It would be
17611 better to let it be displayed like cursors under X. */
17612 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
17613 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
17614 !NILP (overlay_arrow_string
)))
17616 /* Overlay arrow in window redisplay is a fringe bitmap. */
17617 if (STRINGP (overlay_arrow_string
))
17619 struct glyph_row
*arrow_row
17620 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
17621 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
17622 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
17623 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
17624 struct glyph
*p2
, *end
;
17626 /* Copy the arrow glyphs. */
17627 while (glyph
< arrow_end
)
17630 /* Throw away padding glyphs. */
17632 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17633 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
17639 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
17644 xassert (INTEGERP (overlay_arrow_string
));
17645 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
17647 overlay_arrow_seen
= 1;
17650 /* Compute pixel dimensions of this line. */
17651 compute_line_metrics (it
);
17653 /* Remember the position at which this line ends. */
17654 row
->end
= row_end
= it
->current
;
17657 /* ROW->start and ROW->end must be the smallest and largest
17658 buffer positions in ROW. But if ROW was bidi-reordered,
17659 these two positions can be anywhere in the row, so we must
17660 rescan all of the ROW's glyphs to find them. */
17661 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17662 lines' rows is implemented for bidi-reordered rows. */
17663 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
17666 struct text_pos tpos
;
17668 for (g
= row
->glyphs
[TEXT_AREA
];
17669 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17672 if (BUFFERP (g
->object
))
17674 if (g
->charpos
> 0 && g
->charpos
< min_pos
)
17675 min_pos
= g
->charpos
;
17676 if (g
->charpos
> max_pos
)
17677 max_pos
= g
->charpos
;
17680 /* Empty lines have a valid buffer position at their first
17681 glyph, but that glyph's OBJECT is zero, as if it didn't come
17682 from a buffer. If we didn't find any valid buffer positions
17683 in this row, maybe we have such an empty line. */
17684 if (min_pos
== ZV
+ 1 && row
->used
[TEXT_AREA
])
17686 for (g
= row
->glyphs
[TEXT_AREA
];
17687 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17690 if (INTEGERP (g
->object
))
17692 if (g
->charpos
> 0 && g
->charpos
< min_pos
)
17693 min_pos
= g
->charpos
;
17694 if (g
->charpos
> max_pos
)
17695 max_pos
= g
->charpos
;
17701 if (min_pos
!= row
->start
.pos
.charpos
)
17703 row
->start
.pos
.charpos
= min_pos
;
17704 row
->start
.pos
.bytepos
= CHAR_TO_BYTE (min_pos
);
17709 /* For ROW->end, we need the position that is _after_ max_pos,
17710 in the logical order, unless we are at ZV. */
17711 if (row
->ends_at_zv_p
)
17713 row_end
= row
->end
= it
->current
;
17714 if (!row
->used
[TEXT_AREA
])
17716 row
->start
.pos
.charpos
= row_end
.pos
.charpos
;
17717 row
->start
.pos
.bytepos
= row_end
.pos
.bytepos
;
17720 else if (row
->used
[TEXT_AREA
] && max_pos
)
17722 SET_TEXT_POS (tpos
, max_pos
+ 1, CHAR_TO_BYTE (max_pos
+ 1));
17723 row_end
= it
->current
;
17724 row_end
.pos
= tpos
;
17725 /* If the character at max_pos+1 is a newline, skip that as
17726 well. Note that this may skip some invisible text. */
17727 if (FETCH_CHAR (tpos
.bytepos
) == '\n'
17728 || (FETCH_CHAR (tpos
.bytepos
) == '\r' && it
->selective
))
17732 reseat_1 (it
, tpos
, 0);
17733 set_iterator_to_next (it
, 1);
17734 /* Record the position after the newline of a continued
17735 row. We will need that to set ROW->end of the last
17736 row produced for a continued line. */
17737 if (row
->continued_p
)
17739 save_it
.eol_pos
.charpos
= IT_CHARPOS (*it
);
17740 save_it
.eol_pos
.bytepos
= IT_BYTEPOS (*it
);
17744 row_end
= it
->current
;
17745 save_it
.eol_pos
.charpos
= save_it
.eol_pos
.bytepos
= 0;
17749 else if (!row
->continued_p
17750 && row
->continuation_lines_width
17751 && it
->eol_pos
.charpos
> 0)
17753 /* Last row of a continued line. Use the position
17754 recorded in ROW->eol_pos, to the effect that the
17755 newline belongs to this row, not to the row which
17756 displays the character with the largest buffer
17758 row_end
.pos
= it
->eol_pos
;
17759 it
->eol_pos
.charpos
= it
->eol_pos
.bytepos
= 0;
17761 row
->end
= row_end
;
17765 /* Record whether this row ends inside an ellipsis. */
17766 row
->ends_in_ellipsis_p
17767 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17768 && it
->ellipsis_p
);
17770 /* Save fringe bitmaps in this row. */
17771 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17772 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17773 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17774 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17776 it
->left_user_fringe_bitmap
= 0;
17777 it
->left_user_fringe_face_id
= 0;
17778 it
->right_user_fringe_bitmap
= 0;
17779 it
->right_user_fringe_face_id
= 0;
17781 /* Maybe set the cursor. */
17782 cvpos
= it
->w
->cursor
.vpos
;
17784 /* In bidi-reordered rows, keep checking for proper cursor
17785 position even if one has been found already, because buffer
17786 positions in such rows change non-linearly with ROW->VPOS,
17787 when a line is continued. One exception: when we are at ZV,
17788 display cursor on the first suitable glyph row, since all
17789 the empty rows after that also have their position set to ZV. */
17790 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17791 lines' rows is implemented for bidi-reordered rows. */
17793 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
17794 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17795 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17796 && cursor_row_p (it
->w
, row
))
17797 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17799 /* Highlight trailing whitespace. */
17800 if (!NILP (Vshow_trailing_whitespace
))
17801 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17803 /* Prepare for the next line. This line starts horizontally at (X
17804 HPOS) = (0 0). Vertical positions are incremented. As a
17805 convenience for the caller, IT->glyph_row is set to the next
17807 it
->current_x
= it
->hpos
= 0;
17808 it
->current_y
+= row
->height
;
17811 /* The next row should use same value of the reversed_p flag as this
17812 one. set_iterator_to_next decides when it's a new paragraph, and
17813 PRODUCE_GLYPHS recomputes the value of the flag accordingly. */
17814 it
->glyph_row
->reversed_p
= row
->reversed_p
;
17815 it
->start
= row_end
;
17816 return row
->displays_text_p
;
17821 /***********************************************************************
17823 ***********************************************************************/
17825 /* Redisplay the menu bar in the frame for window W.
17827 The menu bar of X frames that don't have X toolkit support is
17828 displayed in a special window W->frame->menu_bar_window.
17830 The menu bar of terminal frames is treated specially as far as
17831 glyph matrices are concerned. Menu bar lines are not part of
17832 windows, so the update is done directly on the frame matrix rows
17833 for the menu bar. */
17836 display_menu_bar (w
)
17839 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17844 /* Don't do all this for graphical frames. */
17846 if (FRAME_W32_P (f
))
17849 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
17855 if (FRAME_NS_P (f
))
17857 #endif /* HAVE_NS */
17859 #ifdef USE_X_TOOLKIT
17860 xassert (!FRAME_WINDOW_P (f
));
17861 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
17862 it
.first_visible_x
= 0;
17863 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
17864 #else /* not USE_X_TOOLKIT */
17865 if (FRAME_WINDOW_P (f
))
17867 /* Menu bar lines are displayed in the desired matrix of the
17868 dummy window menu_bar_window. */
17869 struct window
*menu_w
;
17870 xassert (WINDOWP (f
->menu_bar_window
));
17871 menu_w
= XWINDOW (f
->menu_bar_window
);
17872 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
17874 it
.first_visible_x
= 0;
17875 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
17879 /* This is a TTY frame, i.e. character hpos/vpos are used as
17881 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
17883 it
.first_visible_x
= 0;
17884 it
.last_visible_x
= FRAME_COLS (f
);
17886 #endif /* not USE_X_TOOLKIT */
17888 if (! mode_line_inverse_video
)
17889 /* Force the menu-bar to be displayed in the default face. */
17890 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
17892 /* Clear all rows of the menu bar. */
17893 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
17895 struct glyph_row
*row
= it
.glyph_row
+ i
;
17896 clear_glyph_row (row
);
17897 row
->enabled_p
= 1;
17898 row
->full_width_p
= 1;
17901 /* Display all items of the menu bar. */
17902 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
17903 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
17905 Lisp_Object string
;
17907 /* Stop at nil string. */
17908 string
= AREF (items
, i
+ 1);
17912 /* Remember where item was displayed. */
17913 ASET (items
, i
+ 3, make_number (it
.hpos
));
17915 /* Display the item, pad with one space. */
17916 if (it
.current_x
< it
.last_visible_x
)
17917 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
17918 SCHARS (string
) + 1, 0, 0, -1);
17921 /* Fill out the line with spaces. */
17922 if (it
.current_x
< it
.last_visible_x
)
17923 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
17925 /* Compute the total height of the lines. */
17926 compute_line_metrics (&it
);
17931 /***********************************************************************
17933 ***********************************************************************/
17935 /* Redisplay mode lines in the window tree whose root is WINDOW. If
17936 FORCE is non-zero, redisplay mode lines unconditionally.
17937 Otherwise, redisplay only mode lines that are garbaged. Value is
17938 the number of windows whose mode lines were redisplayed. */
17941 redisplay_mode_lines (window
, force
)
17942 Lisp_Object window
;
17947 while (!NILP (window
))
17949 struct window
*w
= XWINDOW (window
);
17951 if (WINDOWP (w
->hchild
))
17952 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
17953 else if (WINDOWP (w
->vchild
))
17954 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
17956 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
17957 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
17959 struct text_pos lpoint
;
17960 struct buffer
*old
= current_buffer
;
17962 /* Set the window's buffer for the mode line display. */
17963 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
17964 set_buffer_internal_1 (XBUFFER (w
->buffer
));
17966 /* Point refers normally to the selected window. For any
17967 other window, set up appropriate value. */
17968 if (!EQ (window
, selected_window
))
17970 struct text_pos pt
;
17972 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
17973 if (CHARPOS (pt
) < BEGV
)
17974 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
17975 else if (CHARPOS (pt
) > (ZV
- 1))
17976 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
17978 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
17981 /* Display mode lines. */
17982 clear_glyph_matrix (w
->desired_matrix
);
17983 if (display_mode_lines (w
))
17986 w
->must_be_updated_p
= 1;
17989 /* Restore old settings. */
17990 set_buffer_internal_1 (old
);
17991 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18001 /* Display the mode and/or header line of window W. Value is the
18002 sum number of mode lines and header lines displayed. */
18005 display_mode_lines (w
)
18008 Lisp_Object old_selected_window
, old_selected_frame
;
18011 old_selected_frame
= selected_frame
;
18012 selected_frame
= w
->frame
;
18013 old_selected_window
= selected_window
;
18014 XSETWINDOW (selected_window
, w
);
18016 /* These will be set while the mode line specs are processed. */
18017 line_number_displayed
= 0;
18018 w
->column_number_displayed
= Qnil
;
18020 if (WINDOW_WANTS_MODELINE_P (w
))
18022 struct window
*sel_w
= XWINDOW (old_selected_window
);
18024 /* Select mode line face based on the real selected window. */
18025 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18026 current_buffer
->mode_line_format
);
18030 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18032 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18033 current_buffer
->header_line_format
);
18037 selected_frame
= old_selected_frame
;
18038 selected_window
= old_selected_window
;
18043 /* Display mode or header line of window W. FACE_ID specifies which
18044 line to display; it is either MODE_LINE_FACE_ID or
18045 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18046 display. Value is the pixel height of the mode/header line
18050 display_mode_line (w
, face_id
, format
)
18052 enum face_id face_id
;
18053 Lisp_Object format
;
18057 int count
= SPECPDL_INDEX ();
18059 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18060 /* Don't extend on a previously drawn mode-line.
18061 This may happen if called from pos_visible_p. */
18062 it
.glyph_row
->enabled_p
= 0;
18063 prepare_desired_row (it
.glyph_row
);
18065 it
.glyph_row
->mode_line_p
= 1;
18067 if (! mode_line_inverse_video
)
18068 /* Force the mode-line to be displayed in the default face. */
18069 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18071 record_unwind_protect (unwind_format_mode_line
,
18072 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18074 mode_line_target
= MODE_LINE_DISPLAY
;
18076 /* Temporarily make frame's keyboard the current kboard so that
18077 kboard-local variables in the mode_line_format will get the right
18079 push_kboard (FRAME_KBOARD (it
.f
));
18080 record_unwind_save_match_data ();
18081 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18084 unbind_to (count
, Qnil
);
18086 /* Fill up with spaces. */
18087 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18089 compute_line_metrics (&it
);
18090 it
.glyph_row
->full_width_p
= 1;
18091 it
.glyph_row
->continued_p
= 0;
18092 it
.glyph_row
->truncated_on_left_p
= 0;
18093 it
.glyph_row
->truncated_on_right_p
= 0;
18095 /* Make a 3D mode-line have a shadow at its right end. */
18096 face
= FACE_FROM_ID (it
.f
, face_id
);
18097 extend_face_to_end_of_line (&it
);
18098 if (face
->box
!= FACE_NO_BOX
)
18100 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18101 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18102 last
->right_box_line_p
= 1;
18105 return it
.glyph_row
->height
;
18108 /* Move element ELT in LIST to the front of LIST.
18109 Return the updated list. */
18112 move_elt_to_front (elt
, list
)
18113 Lisp_Object elt
, list
;
18115 register Lisp_Object tail
, prev
;
18116 register Lisp_Object tem
;
18120 while (CONSP (tail
))
18126 /* Splice out the link TAIL. */
18128 list
= XCDR (tail
);
18130 Fsetcdr (prev
, XCDR (tail
));
18132 /* Now make it the first. */
18133 Fsetcdr (tail
, list
);
18138 tail
= XCDR (tail
);
18142 /* Not found--return unchanged LIST. */
18146 /* Contribute ELT to the mode line for window IT->w. How it
18147 translates into text depends on its data type.
18149 IT describes the display environment in which we display, as usual.
18151 DEPTH is the depth in recursion. It is used to prevent
18152 infinite recursion here.
18154 FIELD_WIDTH is the number of characters the display of ELT should
18155 occupy in the mode line, and PRECISION is the maximum number of
18156 characters to display from ELT's representation. See
18157 display_string for details.
18159 Returns the hpos of the end of the text generated by ELT.
18161 PROPS is a property list to add to any string we encounter.
18163 If RISKY is nonzero, remove (disregard) any properties in any string
18164 we encounter, and ignore :eval and :propertize.
18166 The global variable `mode_line_target' determines whether the
18167 output is passed to `store_mode_line_noprop',
18168 `store_mode_line_string', or `display_string'. */
18171 display_mode_element (it
, depth
, field_width
, precision
, elt
, props
, risky
)
18174 int field_width
, precision
;
18175 Lisp_Object elt
, props
;
18178 int n
= 0, field
, prec
;
18183 elt
= build_string ("*too-deep*");
18187 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18191 /* A string: output it and check for %-constructs within it. */
18195 if (SCHARS (elt
) > 0
18196 && (!NILP (props
) || risky
))
18198 Lisp_Object oprops
, aelt
;
18199 oprops
= Ftext_properties_at (make_number (0), elt
);
18201 /* If the starting string's properties are not what
18202 we want, translate the string. Also, if the string
18203 is risky, do that anyway. */
18205 if (NILP (Fequal (props
, oprops
)) || risky
)
18207 /* If the starting string has properties,
18208 merge the specified ones onto the existing ones. */
18209 if (! NILP (oprops
) && !risky
)
18213 oprops
= Fcopy_sequence (oprops
);
18215 while (CONSP (tem
))
18217 oprops
= Fplist_put (oprops
, XCAR (tem
),
18218 XCAR (XCDR (tem
)));
18219 tem
= XCDR (XCDR (tem
));
18224 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18225 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18227 /* AELT is what we want. Move it to the front
18228 without consing. */
18230 mode_line_proptrans_alist
18231 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18237 /* If AELT has the wrong props, it is useless.
18238 so get rid of it. */
18240 mode_line_proptrans_alist
18241 = Fdelq (aelt
, mode_line_proptrans_alist
);
18243 elt
= Fcopy_sequence (elt
);
18244 Fset_text_properties (make_number (0), Flength (elt
),
18246 /* Add this item to mode_line_proptrans_alist. */
18247 mode_line_proptrans_alist
18248 = Fcons (Fcons (elt
, props
),
18249 mode_line_proptrans_alist
);
18250 /* Truncate mode_line_proptrans_alist
18251 to at most 50 elements. */
18252 tem
= Fnthcdr (make_number (50),
18253 mode_line_proptrans_alist
);
18255 XSETCDR (tem
, Qnil
);
18264 prec
= precision
- n
;
18265 switch (mode_line_target
)
18267 case MODE_LINE_NOPROP
:
18268 case MODE_LINE_TITLE
:
18269 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
18271 case MODE_LINE_STRING
:
18272 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18274 case MODE_LINE_DISPLAY
:
18275 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18276 0, prec
, 0, STRING_MULTIBYTE (elt
));
18283 /* Handle the non-literal case. */
18285 while ((precision
<= 0 || n
< precision
)
18286 && SREF (elt
, offset
) != 0
18287 && (mode_line_target
!= MODE_LINE_DISPLAY
18288 || it
->current_x
< it
->last_visible_x
))
18290 int last_offset
= offset
;
18292 /* Advance to end of string or next format specifier. */
18293 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18296 if (offset
- 1 != last_offset
)
18298 int nchars
, nbytes
;
18300 /* Output to end of string or up to '%'. Field width
18301 is length of string. Don't output more than
18302 PRECISION allows us. */
18305 prec
= c_string_width (SDATA (elt
) + last_offset
,
18306 offset
- last_offset
, precision
- n
,
18309 switch (mode_line_target
)
18311 case MODE_LINE_NOPROP
:
18312 case MODE_LINE_TITLE
:
18313 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
18315 case MODE_LINE_STRING
:
18317 int bytepos
= last_offset
;
18318 int charpos
= string_byte_to_char (elt
, bytepos
);
18319 int endpos
= (precision
<= 0
18320 ? string_byte_to_char (elt
, offset
)
18321 : charpos
+ nchars
);
18323 n
+= store_mode_line_string (NULL
,
18324 Fsubstring (elt
, make_number (charpos
),
18325 make_number (endpos
)),
18329 case MODE_LINE_DISPLAY
:
18331 int bytepos
= last_offset
;
18332 int charpos
= string_byte_to_char (elt
, bytepos
);
18334 if (precision
<= 0)
18335 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18336 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18338 STRING_MULTIBYTE (elt
));
18343 else /* c == '%' */
18345 int percent_position
= offset
;
18347 /* Get the specified minimum width. Zero means
18350 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18351 field
= field
* 10 + c
- '0';
18353 /* Don't pad beyond the total padding allowed. */
18354 if (field_width
- n
> 0 && field
> field_width
- n
)
18355 field
= field_width
- n
;
18357 /* Note that either PRECISION <= 0 or N < PRECISION. */
18358 prec
= precision
- n
;
18361 n
+= display_mode_element (it
, depth
, field
, prec
,
18362 Vglobal_mode_string
, props
,
18367 int bytepos
, charpos
;
18368 unsigned char *spec
;
18369 Lisp_Object string
;
18371 bytepos
= percent_position
;
18372 charpos
= (STRING_MULTIBYTE (elt
)
18373 ? string_byte_to_char (elt
, bytepos
)
18375 spec
= decode_mode_spec (it
->w
, c
, field
, prec
, &string
);
18376 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18378 switch (mode_line_target
)
18380 case MODE_LINE_NOPROP
:
18381 case MODE_LINE_TITLE
:
18382 n
+= store_mode_line_noprop (spec
, field
, prec
);
18384 case MODE_LINE_STRING
:
18386 int len
= strlen (spec
);
18387 Lisp_Object tem
= make_string (spec
, len
);
18388 props
= Ftext_properties_at (make_number (charpos
), elt
);
18389 /* Should only keep face property in props */
18390 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18393 case MODE_LINE_DISPLAY
:
18395 int nglyphs_before
, nwritten
;
18397 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18398 nwritten
= display_string (spec
, string
, elt
,
18403 /* Assign to the glyphs written above the
18404 string where the `%x' came from, position
18408 struct glyph
*glyph
18409 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18413 for (i
= 0; i
< nwritten
; ++i
)
18415 glyph
[i
].object
= elt
;
18416 glyph
[i
].charpos
= charpos
;
18433 /* A symbol: process the value of the symbol recursively
18434 as if it appeared here directly. Avoid error if symbol void.
18435 Special case: if value of symbol is a string, output the string
18438 register Lisp_Object tem
;
18440 /* If the variable is not marked as risky to set
18441 then its contents are risky to use. */
18442 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18445 tem
= Fboundp (elt
);
18448 tem
= Fsymbol_value (elt
);
18449 /* If value is a string, output that string literally:
18450 don't check for % within it. */
18454 if (!EQ (tem
, elt
))
18456 /* Give up right away for nil or t. */
18466 register Lisp_Object car
, tem
;
18468 /* A cons cell: five distinct cases.
18469 If first element is :eval or :propertize, do something special.
18470 If first element is a string or a cons, process all the elements
18471 and effectively concatenate them.
18472 If first element is a negative number, truncate displaying cdr to
18473 at most that many characters. If positive, pad (with spaces)
18474 to at least that many characters.
18475 If first element is a symbol, process the cadr or caddr recursively
18476 according to whether the symbol's value is non-nil or nil. */
18478 if (EQ (car
, QCeval
))
18480 /* An element of the form (:eval FORM) means evaluate FORM
18481 and use the result as mode line elements. */
18486 if (CONSP (XCDR (elt
)))
18489 spec
= safe_eval (XCAR (XCDR (elt
)));
18490 n
+= display_mode_element (it
, depth
, field_width
- n
,
18491 precision
- n
, spec
, props
,
18495 else if (EQ (car
, QCpropertize
))
18497 /* An element of the form (:propertize ELT PROPS...)
18498 means display ELT but applying properties PROPS. */
18503 if (CONSP (XCDR (elt
)))
18504 n
+= display_mode_element (it
, depth
, field_width
- n
,
18505 precision
- n
, XCAR (XCDR (elt
)),
18506 XCDR (XCDR (elt
)), risky
);
18508 else if (SYMBOLP (car
))
18510 tem
= Fboundp (car
);
18514 /* elt is now the cdr, and we know it is a cons cell.
18515 Use its car if CAR has a non-nil value. */
18518 tem
= Fsymbol_value (car
);
18525 /* Symbol's value is nil (or symbol is unbound)
18526 Get the cddr of the original list
18527 and if possible find the caddr and use that. */
18531 else if (!CONSP (elt
))
18536 else if (INTEGERP (car
))
18538 register int lim
= XINT (car
);
18542 /* Negative int means reduce maximum width. */
18543 if (precision
<= 0)
18546 precision
= min (precision
, -lim
);
18550 /* Padding specified. Don't let it be more than
18551 current maximum. */
18553 lim
= min (precision
, lim
);
18555 /* If that's more padding than already wanted, queue it.
18556 But don't reduce padding already specified even if
18557 that is beyond the current truncation point. */
18558 field_width
= max (lim
, field_width
);
18562 else if (STRINGP (car
) || CONSP (car
))
18564 Lisp_Object halftail
= elt
;
18568 && (precision
<= 0 || n
< precision
))
18570 n
+= display_mode_element (it
, depth
,
18571 /* Do padding only after the last
18572 element in the list. */
18573 (! CONSP (XCDR (elt
))
18576 precision
- n
, XCAR (elt
),
18580 if ((len
& 1) == 0)
18581 halftail
= XCDR (halftail
);
18582 /* Check for cycle. */
18583 if (EQ (halftail
, elt
))
18592 elt
= build_string ("*invalid*");
18596 /* Pad to FIELD_WIDTH. */
18597 if (field_width
> 0 && n
< field_width
)
18599 switch (mode_line_target
)
18601 case MODE_LINE_NOPROP
:
18602 case MODE_LINE_TITLE
:
18603 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18605 case MODE_LINE_STRING
:
18606 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18608 case MODE_LINE_DISPLAY
:
18609 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18618 /* Store a mode-line string element in mode_line_string_list.
18620 If STRING is non-null, display that C string. Otherwise, the Lisp
18621 string LISP_STRING is displayed.
18623 FIELD_WIDTH is the minimum number of output glyphs to produce.
18624 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18625 with spaces. FIELD_WIDTH <= 0 means don't pad.
18627 PRECISION is the maximum number of characters to output from
18628 STRING. PRECISION <= 0 means don't truncate the string.
18630 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18631 properties to the string.
18633 PROPS are the properties to add to the string.
18634 The mode_line_string_face face property is always added to the string.
18638 store_mode_line_string (string
, lisp_string
, copy_string
, field_width
, precision
, props
)
18640 Lisp_Object lisp_string
;
18649 if (string
!= NULL
)
18651 len
= strlen (string
);
18652 if (precision
> 0 && len
> precision
)
18654 lisp_string
= make_string (string
, len
);
18656 props
= mode_line_string_face_prop
;
18657 else if (!NILP (mode_line_string_face
))
18659 Lisp_Object face
= Fplist_get (props
, Qface
);
18660 props
= Fcopy_sequence (props
);
18662 face
= mode_line_string_face
;
18664 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18665 props
= Fplist_put (props
, Qface
, face
);
18667 Fadd_text_properties (make_number (0), make_number (len
),
18668 props
, lisp_string
);
18672 len
= XFASTINT (Flength (lisp_string
));
18673 if (precision
> 0 && len
> precision
)
18676 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
18679 if (!NILP (mode_line_string_face
))
18683 props
= Ftext_properties_at (make_number (0), lisp_string
);
18684 face
= Fplist_get (props
, Qface
);
18686 face
= mode_line_string_face
;
18688 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18689 props
= Fcons (Qface
, Fcons (face
, Qnil
));
18691 lisp_string
= Fcopy_sequence (lisp_string
);
18694 Fadd_text_properties (make_number (0), make_number (len
),
18695 props
, lisp_string
);
18700 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18704 if (field_width
> len
)
18706 field_width
-= len
;
18707 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
18709 Fadd_text_properties (make_number (0), make_number (field_width
),
18710 props
, lisp_string
);
18711 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18719 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
18721 doc
: /* Format a string out of a mode line format specification.
18722 First arg FORMAT specifies the mode line format (see `mode-line-format'
18723 for details) to use.
18725 Optional second arg FACE specifies the face property to put
18726 on all characters for which no face is specified.
18727 The value t means whatever face the window's mode line currently uses
18728 \(either `mode-line' or `mode-line-inactive', depending).
18729 A value of nil means the default is no face property.
18730 If FACE is an integer, the value string has no text properties.
18732 Optional third and fourth args WINDOW and BUFFER specify the window
18733 and buffer to use as the context for the formatting (defaults
18734 are the selected window and the window's buffer). */)
18735 (format
, face
, window
, buffer
)
18736 Lisp_Object format
, face
, window
, buffer
;
18741 struct buffer
*old_buffer
= NULL
;
18743 int no_props
= INTEGERP (face
);
18744 int count
= SPECPDL_INDEX ();
18746 int string_start
= 0;
18749 window
= selected_window
;
18750 CHECK_WINDOW (window
);
18751 w
= XWINDOW (window
);
18754 buffer
= w
->buffer
;
18755 CHECK_BUFFER (buffer
);
18757 /* Make formatting the modeline a non-op when noninteractive, otherwise
18758 there will be problems later caused by a partially initialized frame. */
18759 if (NILP (format
) || noninteractive
)
18760 return empty_unibyte_string
;
18768 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
18769 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0);
18773 face_id
= DEFAULT_FACE_ID
;
18775 if (XBUFFER (buffer
) != current_buffer
)
18776 old_buffer
= current_buffer
;
18778 /* Save things including mode_line_proptrans_alist,
18779 and set that to nil so that we don't alter the outer value. */
18780 record_unwind_protect (unwind_format_mode_line
,
18781 format_mode_line_unwind_data
18782 (old_buffer
, selected_window
, 1));
18783 mode_line_proptrans_alist
= Qnil
;
18785 Fselect_window (window
, Qt
);
18787 set_buffer_internal_1 (XBUFFER (buffer
));
18789 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18793 mode_line_target
= MODE_LINE_NOPROP
;
18794 mode_line_string_face_prop
= Qnil
;
18795 mode_line_string_list
= Qnil
;
18796 string_start
= MODE_LINE_NOPROP_LEN (0);
18800 mode_line_target
= MODE_LINE_STRING
;
18801 mode_line_string_list
= Qnil
;
18802 mode_line_string_face
= face
;
18803 mode_line_string_face_prop
18804 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
18807 push_kboard (FRAME_KBOARD (it
.f
));
18808 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18813 len
= MODE_LINE_NOPROP_LEN (string_start
);
18814 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
18818 mode_line_string_list
= Fnreverse (mode_line_string_list
);
18819 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
18820 empty_unibyte_string
);
18823 unbind_to (count
, Qnil
);
18827 /* Write a null-terminated, right justified decimal representation of
18828 the positive integer D to BUF using a minimal field width WIDTH. */
18831 pint2str (buf
, width
, d
)
18832 register char *buf
;
18833 register int width
;
18836 register char *p
= buf
;
18844 *p
++ = d
% 10 + '0';
18849 for (width
-= (int) (p
- buf
); width
> 0; --width
)
18860 /* Write a null-terminated, right justified decimal and "human
18861 readable" representation of the nonnegative integer D to BUF using
18862 a minimal field width WIDTH. D should be smaller than 999.5e24. */
18864 static const char power_letter
[] =
18878 pint2hrstr (buf
, width
, d
)
18883 /* We aim to represent the nonnegative integer D as
18884 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
18887 /* -1 means: do not use TENTHS. */
18891 /* Length of QUOTIENT.TENTHS as a string. */
18897 if (1000 <= quotient
)
18899 /* Scale to the appropriate EXPONENT. */
18902 remainder
= quotient
% 1000;
18906 while (1000 <= quotient
);
18908 /* Round to nearest and decide whether to use TENTHS or not. */
18911 tenths
= remainder
/ 100;
18912 if (50 <= remainder
% 100)
18919 if (quotient
== 10)
18927 if (500 <= remainder
)
18929 if (quotient
< 999)
18940 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
18941 if (tenths
== -1 && quotient
<= 99)
18948 p
= psuffix
= buf
+ max (width
, length
);
18950 /* Print EXPONENT. */
18952 *psuffix
++ = power_letter
[exponent
];
18955 /* Print TENTHS. */
18958 *--p
= '0' + tenths
;
18962 /* Print QUOTIENT. */
18965 int digit
= quotient
% 10;
18966 *--p
= '0' + digit
;
18968 while ((quotient
/= 10) != 0);
18970 /* Print leading spaces. */
18975 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
18976 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
18977 type of CODING_SYSTEM. Return updated pointer into BUF. */
18979 static unsigned char invalid_eol_type
[] = "(*invalid*)";
18982 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
18983 Lisp_Object coding_system
;
18984 register char *buf
;
18988 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
18989 const unsigned char *eol_str
;
18991 /* The EOL conversion we are using. */
18992 Lisp_Object eoltype
;
18994 val
= CODING_SYSTEM_SPEC (coding_system
);
18997 if (!VECTORP (val
)) /* Not yet decided. */
19002 eoltype
= eol_mnemonic_undecided
;
19003 /* Don't mention EOL conversion if it isn't decided. */
19008 Lisp_Object eolvalue
;
19010 attrs
= AREF (val
, 0);
19011 eolvalue
= AREF (val
, 2);
19014 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19018 /* The EOL conversion that is normal on this system. */
19020 if (NILP (eolvalue
)) /* Not yet decided. */
19021 eoltype
= eol_mnemonic_undecided
;
19022 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19023 eoltype
= eol_mnemonic_undecided
;
19024 else /* eolvalue is Qunix, Qdos, or Qmac. */
19025 eoltype
= (EQ (eolvalue
, Qunix
)
19026 ? eol_mnemonic_unix
19027 : (EQ (eolvalue
, Qdos
) == 1
19028 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19034 /* Mention the EOL conversion if it is not the usual one. */
19035 if (STRINGP (eoltype
))
19037 eol_str
= SDATA (eoltype
);
19038 eol_str_len
= SBYTES (eoltype
);
19040 else if (CHARACTERP (eoltype
))
19042 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19043 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
19048 eol_str
= invalid_eol_type
;
19049 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19051 bcopy (eol_str
, buf
, eol_str_len
);
19052 buf
+= eol_str_len
;
19058 /* Return a string for the output of a mode line %-spec for window W,
19059 generated by character C. PRECISION >= 0 means don't return a
19060 string longer than that value. FIELD_WIDTH > 0 means pad the
19061 string returned with spaces to that value. Return a Lisp string in
19062 *STRING if the resulting string is taken from that Lisp string.
19064 Note we operate on the current buffer for most purposes,
19065 the exception being w->base_line_pos. */
19067 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19070 decode_mode_spec (w
, c
, field_width
, precision
, string
)
19073 int field_width
, precision
;
19074 Lisp_Object
*string
;
19077 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19078 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19079 struct buffer
*b
= current_buffer
;
19087 if (!NILP (b
->read_only
))
19089 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19094 /* This differs from %* only for a modified read-only buffer. */
19095 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19097 if (!NILP (b
->read_only
))
19102 /* This differs from %* in ignoring read-only-ness. */
19103 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19115 if (command_loop_level
> 5)
19117 p
= decode_mode_spec_buf
;
19118 for (i
= 0; i
< command_loop_level
; i
++)
19121 return decode_mode_spec_buf
;
19129 if (command_loop_level
> 5)
19131 p
= decode_mode_spec_buf
;
19132 for (i
= 0; i
< command_loop_level
; i
++)
19135 return decode_mode_spec_buf
;
19142 /* Let lots_of_dashes be a string of infinite length. */
19143 if (mode_line_target
== MODE_LINE_NOPROP
||
19144 mode_line_target
== MODE_LINE_STRING
)
19146 if (field_width
<= 0
19147 || field_width
> sizeof (lots_of_dashes
))
19149 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19150 decode_mode_spec_buf
[i
] = '-';
19151 decode_mode_spec_buf
[i
] = '\0';
19152 return decode_mode_spec_buf
;
19155 return lots_of_dashes
;
19163 /* %c and %l are ignored in `frame-title-format'.
19164 (In redisplay_internal, the frame title is drawn _before_ the
19165 windows are updated, so the stuff which depends on actual
19166 window contents (such as %l) may fail to render properly, or
19167 even crash emacs.) */
19168 if (mode_line_target
== MODE_LINE_TITLE
)
19172 int col
= (int) current_column (); /* iftc */
19173 w
->column_number_displayed
= make_number (col
);
19174 pint2str (decode_mode_spec_buf
, field_width
, col
);
19175 return decode_mode_spec_buf
;
19179 #ifndef SYSTEM_MALLOC
19181 if (NILP (Vmemory_full
))
19184 return "!MEM FULL! ";
19191 /* %F displays the frame name. */
19192 if (!NILP (f
->title
))
19193 return (char *) SDATA (f
->title
);
19194 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19195 return (char *) SDATA (f
->name
);
19204 int size
= ZV
- BEGV
;
19205 pint2str (decode_mode_spec_buf
, field_width
, size
);
19206 return decode_mode_spec_buf
;
19211 int size
= ZV
- BEGV
;
19212 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19213 return decode_mode_spec_buf
;
19218 int startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19219 int topline
, nlines
, junk
, height
;
19221 /* %c and %l are ignored in `frame-title-format'. */
19222 if (mode_line_target
== MODE_LINE_TITLE
)
19225 startpos
= XMARKER (w
->start
)->charpos
;
19226 startpos_byte
= marker_byte_position (w
->start
);
19227 height
= WINDOW_TOTAL_LINES (w
);
19229 /* If we decided that this buffer isn't suitable for line numbers,
19230 don't forget that too fast. */
19231 if (EQ (w
->base_line_pos
, w
->buffer
))
19233 /* But do forget it, if the window shows a different buffer now. */
19234 else if (BUFFERP (w
->base_line_pos
))
19235 w
->base_line_pos
= Qnil
;
19237 /* If the buffer is very big, don't waste time. */
19238 if (INTEGERP (Vline_number_display_limit
)
19239 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19241 w
->base_line_pos
= Qnil
;
19242 w
->base_line_number
= Qnil
;
19246 if (INTEGERP (w
->base_line_number
)
19247 && INTEGERP (w
->base_line_pos
)
19248 && XFASTINT (w
->base_line_pos
) <= startpos
)
19250 line
= XFASTINT (w
->base_line_number
);
19251 linepos
= XFASTINT (w
->base_line_pos
);
19252 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19257 linepos
= BUF_BEGV (b
);
19258 linepos_byte
= BUF_BEGV_BYTE (b
);
19261 /* Count lines from base line to window start position. */
19262 nlines
= display_count_lines (linepos
, linepos_byte
,
19266 topline
= nlines
+ line
;
19268 /* Determine a new base line, if the old one is too close
19269 or too far away, or if we did not have one.
19270 "Too close" means it's plausible a scroll-down would
19271 go back past it. */
19272 if (startpos
== BUF_BEGV (b
))
19274 w
->base_line_number
= make_number (topline
);
19275 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19277 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19278 || linepos
== BUF_BEGV (b
))
19280 int limit
= BUF_BEGV (b
);
19281 int limit_byte
= BUF_BEGV_BYTE (b
);
19283 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
19285 if (startpos
- distance
> limit
)
19287 limit
= startpos
- distance
;
19288 limit_byte
= CHAR_TO_BYTE (limit
);
19291 nlines
= display_count_lines (startpos
, startpos_byte
,
19293 - (height
* 2 + 30),
19295 /* If we couldn't find the lines we wanted within
19296 line_number_display_limit_width chars per line,
19297 give up on line numbers for this window. */
19298 if (position
== limit_byte
&& limit
== startpos
- distance
)
19300 w
->base_line_pos
= w
->buffer
;
19301 w
->base_line_number
= Qnil
;
19305 w
->base_line_number
= make_number (topline
- nlines
);
19306 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19309 /* Now count lines from the start pos to point. */
19310 nlines
= display_count_lines (startpos
, startpos_byte
,
19311 PT_BYTE
, PT
, &junk
);
19313 /* Record that we did display the line number. */
19314 line_number_displayed
= 1;
19316 /* Make the string to show. */
19317 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19318 return decode_mode_spec_buf
;
19321 char* p
= decode_mode_spec_buf
;
19322 int pad
= field_width
- 2;
19328 return decode_mode_spec_buf
;
19334 obj
= b
->mode_name
;
19338 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19344 int pos
= marker_position (w
->start
);
19345 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
19347 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19349 if (pos
<= BUF_BEGV (b
))
19354 else if (pos
<= BUF_BEGV (b
))
19358 if (total
> 1000000)
19359 /* Do it differently for a large value, to avoid overflow. */
19360 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19362 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19363 /* We can't normally display a 3-digit number,
19364 so get us a 2-digit number that is close. */
19367 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
19368 return decode_mode_spec_buf
;
19372 /* Display percentage of size above the bottom of the screen. */
19375 int toppos
= marker_position (w
->start
);
19376 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19377 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
19379 if (botpos
>= BUF_ZV (b
))
19381 if (toppos
<= BUF_BEGV (b
))
19388 if (total
> 1000000)
19389 /* Do it differently for a large value, to avoid overflow. */
19390 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19392 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19393 /* We can't normally display a 3-digit number,
19394 so get us a 2-digit number that is close. */
19397 if (toppos
<= BUF_BEGV (b
))
19398 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
19400 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
19401 return decode_mode_spec_buf
;
19406 /* status of process */
19407 obj
= Fget_buffer_process (Fcurrent_buffer ());
19409 return "no process";
19410 #ifdef subprocesses
19411 obj
= Fsymbol_name (Fprocess_status (obj
));
19417 int count
= inhibit_garbage_collection ();
19418 Lisp_Object val
= call1 (intern ("file-remote-p"),
19419 current_buffer
->directory
);
19420 unbind_to (count
, Qnil
);
19428 case 't': /* indicate TEXT or BINARY */
19429 #ifdef MODE_LINE_BINARY_TEXT
19430 return MODE_LINE_BINARY_TEXT (b
);
19436 /* coding-system (not including end-of-line format) */
19438 /* coding-system (including end-of-line type) */
19440 int eol_flag
= (c
== 'Z');
19441 char *p
= decode_mode_spec_buf
;
19443 if (! FRAME_WINDOW_P (f
))
19445 /* No need to mention EOL here--the terminal never needs
19446 to do EOL conversion. */
19447 p
= decode_mode_spec_coding (CODING_ID_NAME
19448 (FRAME_KEYBOARD_CODING (f
)->id
),
19450 p
= decode_mode_spec_coding (CODING_ID_NAME
19451 (FRAME_TERMINAL_CODING (f
)->id
),
19454 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
19457 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19458 #ifdef subprocesses
19459 obj
= Fget_buffer_process (Fcurrent_buffer ());
19460 if (PROCESSP (obj
))
19462 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19464 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19467 #endif /* subprocesses */
19470 return decode_mode_spec_buf
;
19477 return (char *) SDATA (obj
);
19484 /* Count up to COUNT lines starting from START / START_BYTE.
19485 But don't go beyond LIMIT_BYTE.
19486 Return the number of lines thus found (always nonnegative).
19488 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19491 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
19492 int start
, start_byte
, limit_byte
, count
;
19495 register unsigned char *cursor
;
19496 unsigned char *base
;
19498 register int ceiling
;
19499 register unsigned char *ceiling_addr
;
19500 int orig_count
= count
;
19502 /* If we are not in selective display mode,
19503 check only for newlines. */
19504 int selective_display
= (!NILP (current_buffer
->selective_display
)
19505 && !INTEGERP (current_buffer
->selective_display
));
19509 while (start_byte
< limit_byte
)
19511 ceiling
= BUFFER_CEILING_OF (start_byte
);
19512 ceiling
= min (limit_byte
- 1, ceiling
);
19513 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19514 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19517 if (selective_display
)
19518 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19521 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19524 if (cursor
!= ceiling_addr
)
19528 start_byte
+= cursor
- base
+ 1;
19529 *byte_pos_ptr
= start_byte
;
19533 if (++cursor
== ceiling_addr
)
19539 start_byte
+= cursor
- base
;
19544 while (start_byte
> limit_byte
)
19546 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19547 ceiling
= max (limit_byte
, ceiling
);
19548 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19549 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19552 if (selective_display
)
19553 while (--cursor
!= ceiling_addr
19554 && *cursor
!= '\n' && *cursor
!= 015)
19557 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19560 if (cursor
!= ceiling_addr
)
19564 start_byte
+= cursor
- base
+ 1;
19565 *byte_pos_ptr
= start_byte
;
19566 /* When scanning backwards, we should
19567 not count the newline posterior to which we stop. */
19568 return - orig_count
- 1;
19574 /* Here we add 1 to compensate for the last decrement
19575 of CURSOR, which took it past the valid range. */
19576 start_byte
+= cursor
- base
+ 1;
19580 *byte_pos_ptr
= limit_byte
;
19583 return - orig_count
+ count
;
19584 return orig_count
- count
;
19590 /***********************************************************************
19592 ***********************************************************************/
19594 /* Display a NUL-terminated string, starting with index START.
19596 If STRING is non-null, display that C string. Otherwise, the Lisp
19597 string LISP_STRING is displayed. There's a case that STRING is
19598 non-null and LISP_STRING is not nil. It means STRING is a string
19599 data of LISP_STRING. In that case, we display LISP_STRING while
19600 ignoring its text properties.
19602 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19603 FACE_STRING. Display STRING or LISP_STRING with the face at
19604 FACE_STRING_POS in FACE_STRING:
19606 Display the string in the environment given by IT, but use the
19607 standard display table, temporarily.
19609 FIELD_WIDTH is the minimum number of output glyphs to produce.
19610 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19611 with spaces. If STRING has more characters, more than FIELD_WIDTH
19612 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19614 PRECISION is the maximum number of characters to output from
19615 STRING. PRECISION < 0 means don't truncate the string.
19617 This is roughly equivalent to printf format specifiers:
19619 FIELD_WIDTH PRECISION PRINTF
19620 ----------------------------------------
19626 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19627 display them, and < 0 means obey the current buffer's value of
19628 enable_multibyte_characters.
19630 Value is the number of columns displayed. */
19633 display_string (string
, lisp_string
, face_string
, face_string_pos
,
19634 start
, it
, field_width
, precision
, max_x
, multibyte
)
19635 unsigned char *string
;
19636 Lisp_Object lisp_string
;
19637 Lisp_Object face_string
;
19638 EMACS_INT face_string_pos
;
19641 int field_width
, precision
, max_x
;
19644 int hpos_at_start
= it
->hpos
;
19645 int saved_face_id
= it
->face_id
;
19646 struct glyph_row
*row
= it
->glyph_row
;
19648 /* Initialize the iterator IT for iteration over STRING beginning
19649 with index START. */
19650 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19651 precision
, field_width
, multibyte
);
19652 if (string
&& STRINGP (lisp_string
))
19653 /* LISP_STRING is the one returned by decode_mode_spec. We should
19654 ignore its text properties. */
19655 it
->stop_charpos
= -1;
19657 /* If displaying STRING, set up the face of the iterator
19658 from LISP_STRING, if that's given. */
19659 if (STRINGP (face_string
))
19665 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19666 0, it
->region_beg_charpos
,
19667 it
->region_end_charpos
,
19668 &endptr
, it
->base_face_id
, 0);
19669 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19670 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
19673 /* Set max_x to the maximum allowed X position. Don't let it go
19674 beyond the right edge of the window. */
19676 max_x
= it
->last_visible_x
;
19678 max_x
= min (max_x
, it
->last_visible_x
);
19680 /* Skip over display elements that are not visible. because IT->w is
19682 if (it
->current_x
< it
->first_visible_x
)
19683 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
19684 MOVE_TO_POS
| MOVE_TO_X
);
19686 row
->ascent
= it
->max_ascent
;
19687 row
->height
= it
->max_ascent
+ it
->max_descent
;
19688 row
->phys_ascent
= it
->max_phys_ascent
;
19689 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19690 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19692 /* This condition is for the case that we are called with current_x
19693 past last_visible_x. */
19694 while (it
->current_x
< max_x
)
19696 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
19698 /* Get the next display element. */
19699 if (!get_next_display_element (it
))
19702 /* Produce glyphs. */
19703 x_before
= it
->current_x
;
19704 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19705 PRODUCE_GLYPHS (it
);
19707 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
19710 while (i
< nglyphs
)
19712 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19714 if (it
->line_wrap
!= TRUNCATE
19715 && x
+ glyph
->pixel_width
> max_x
)
19717 /* End of continued line or max_x reached. */
19718 if (CHAR_GLYPH_PADDING_P (*glyph
))
19720 /* A wide character is unbreakable. */
19721 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19722 it
->current_x
= x_before
;
19726 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19731 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
19733 /* Glyph is at least partially visible. */
19735 if (x
< it
->first_visible_x
)
19736 it
->glyph_row
->x
= x
- it
->first_visible_x
;
19740 /* Glyph is off the left margin of the display area.
19741 Should not happen. */
19745 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19746 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19747 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19748 row
->phys_height
= max (row
->phys_height
,
19749 it
->max_phys_ascent
+ it
->max_phys_descent
);
19750 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19751 it
->max_extra_line_spacing
);
19752 x
+= glyph
->pixel_width
;
19756 /* Stop if max_x reached. */
19760 /* Stop at line ends. */
19761 if (ITERATOR_AT_END_OF_LINE_P (it
))
19763 it
->continuation_lines_width
= 0;
19767 set_iterator_to_next (it
, 1);
19769 /* Stop if truncating at the right edge. */
19770 if (it
->line_wrap
== TRUNCATE
19771 && it
->current_x
>= it
->last_visible_x
)
19773 /* Add truncation mark, but don't do it if the line is
19774 truncated at a padding space. */
19775 if (IT_CHARPOS (*it
) < it
->string_nchars
)
19777 if (!FRAME_WINDOW_P (it
->f
))
19781 if (it
->current_x
> it
->last_visible_x
)
19783 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19784 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19786 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19788 row
->used
[TEXT_AREA
] = i
;
19789 produce_special_glyphs (it
, IT_TRUNCATION
);
19792 produce_special_glyphs (it
, IT_TRUNCATION
);
19794 it
->glyph_row
->truncated_on_right_p
= 1;
19800 /* Maybe insert a truncation at the left. */
19801 if (it
->first_visible_x
19802 && IT_CHARPOS (*it
) > 0)
19804 if (!FRAME_WINDOW_P (it
->f
))
19805 insert_left_trunc_glyphs (it
);
19806 it
->glyph_row
->truncated_on_left_p
= 1;
19809 it
->face_id
= saved_face_id
;
19811 /* Value is number of columns displayed. */
19812 return it
->hpos
- hpos_at_start
;
19817 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
19818 appears as an element of LIST or as the car of an element of LIST.
19819 If PROPVAL is a list, compare each element against LIST in that
19820 way, and return 1/2 if any element of PROPVAL is found in LIST.
19821 Otherwise return 0. This function cannot quit.
19822 The return value is 2 if the text is invisible but with an ellipsis
19823 and 1 if it's invisible and without an ellipsis. */
19826 invisible_p (propval
, list
)
19827 register Lisp_Object propval
;
19830 register Lisp_Object tail
, proptail
;
19832 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19834 register Lisp_Object tem
;
19836 if (EQ (propval
, tem
))
19838 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
19839 return NILP (XCDR (tem
)) ? 1 : 2;
19842 if (CONSP (propval
))
19844 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
19846 Lisp_Object propelt
;
19847 propelt
= XCAR (proptail
);
19848 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19850 register Lisp_Object tem
;
19852 if (EQ (propelt
, tem
))
19854 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
19855 return NILP (XCDR (tem
)) ? 1 : 2;
19863 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
19864 doc
: /* Non-nil if the property makes the text invisible.
19865 POS-OR-PROP can be a marker or number, in which case it is taken to be
19866 a position in the current buffer and the value of the `invisible' property
19867 is checked; or it can be some other value, which is then presumed to be the
19868 value of the `invisible' property of the text of interest.
19869 The non-nil value returned can be t for truly invisible text or something
19870 else if the text is replaced by an ellipsis. */)
19872 Lisp_Object pos_or_prop
;
19875 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
19876 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
19878 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
19879 return (invis
== 0 ? Qnil
19881 : make_number (invis
));
19884 /* Calculate a width or height in pixels from a specification using
19885 the following elements:
19888 NUM - a (fractional) multiple of the default font width/height
19889 (NUM) - specifies exactly NUM pixels
19890 UNIT - a fixed number of pixels, see below.
19891 ELEMENT - size of a display element in pixels, see below.
19892 (NUM . SPEC) - equals NUM * SPEC
19893 (+ SPEC SPEC ...) - add pixel values
19894 (- SPEC SPEC ...) - subtract pixel values
19895 (- SPEC) - negate pixel value
19898 INT or FLOAT - a number constant
19899 SYMBOL - use symbol's (buffer local) variable binding.
19902 in - pixels per inch *)
19903 mm - pixels per 1/1000 meter *)
19904 cm - pixels per 1/100 meter *)
19905 width - width of current font in pixels.
19906 height - height of current font in pixels.
19908 *) using the ratio(s) defined in display-pixels-per-inch.
19912 left-fringe - left fringe width in pixels
19913 right-fringe - right fringe width in pixels
19915 left-margin - left margin width in pixels
19916 right-margin - right margin width in pixels
19918 scroll-bar - scroll-bar area width in pixels
19922 Pixels corresponding to 5 inches:
19925 Total width of non-text areas on left side of window (if scroll-bar is on left):
19926 '(space :width (+ left-fringe left-margin scroll-bar))
19928 Align to first text column (in header line):
19929 '(space :align-to 0)
19931 Align to middle of text area minus half the width of variable `my-image'
19932 containing a loaded image:
19933 '(space :align-to (0.5 . (- text my-image)))
19935 Width of left margin minus width of 1 character in the default font:
19936 '(space :width (- left-margin 1))
19938 Width of left margin minus width of 2 characters in the current font:
19939 '(space :width (- left-margin (2 . width)))
19941 Center 1 character over left-margin (in header line):
19942 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
19944 Different ways to express width of left fringe plus left margin minus one pixel:
19945 '(space :width (- (+ left-fringe left-margin) (1)))
19946 '(space :width (+ left-fringe left-margin (- (1))))
19947 '(space :width (+ left-fringe left-margin (-1)))
19951 #define NUMVAL(X) \
19952 ((INTEGERP (X) || FLOATP (X)) \
19957 calc_pixel_width_or_height (res
, it
, prop
, font
, width_p
, align_to
)
19962 int width_p
, *align_to
;
19966 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
19967 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
19970 return OK_PIXELS (0);
19972 xassert (FRAME_LIVE_P (it
->f
));
19974 if (SYMBOLP (prop
))
19976 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
19978 char *unit
= SDATA (SYMBOL_NAME (prop
));
19980 if (unit
[0] == 'i' && unit
[1] == 'n')
19982 else if (unit
[0] == 'm' && unit
[1] == 'm')
19984 else if (unit
[0] == 'c' && unit
[1] == 'm')
19991 #ifdef HAVE_WINDOW_SYSTEM
19992 if (FRAME_WINDOW_P (it
->f
)
19994 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
19995 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
19997 return OK_PIXELS (ppi
/ pixels
);
20000 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20001 || (CONSP (Vdisplay_pixels_per_inch
)
20003 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20004 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20006 return OK_PIXELS (ppi
/ pixels
);
20012 #ifdef HAVE_WINDOW_SYSTEM
20013 if (EQ (prop
, Qheight
))
20014 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20015 if (EQ (prop
, Qwidth
))
20016 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20018 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20019 return OK_PIXELS (1);
20022 if (EQ (prop
, Qtext
))
20023 return OK_PIXELS (width_p
20024 ? window_box_width (it
->w
, TEXT_AREA
)
20025 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20027 if (align_to
&& *align_to
< 0)
20030 if (EQ (prop
, Qleft
))
20031 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20032 if (EQ (prop
, Qright
))
20033 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20034 if (EQ (prop
, Qcenter
))
20035 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20036 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20037 if (EQ (prop
, Qleft_fringe
))
20038 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20039 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20040 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20041 if (EQ (prop
, Qright_fringe
))
20042 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20043 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20044 : window_box_right_offset (it
->w
, TEXT_AREA
));
20045 if (EQ (prop
, Qleft_margin
))
20046 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20047 if (EQ (prop
, Qright_margin
))
20048 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20049 if (EQ (prop
, Qscroll_bar
))
20050 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20052 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20053 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20054 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20059 if (EQ (prop
, Qleft_fringe
))
20060 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20061 if (EQ (prop
, Qright_fringe
))
20062 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20063 if (EQ (prop
, Qleft_margin
))
20064 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20065 if (EQ (prop
, Qright_margin
))
20066 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20067 if (EQ (prop
, Qscroll_bar
))
20068 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20071 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20074 if (INTEGERP (prop
) || FLOATP (prop
))
20076 int base_unit
= (width_p
20077 ? FRAME_COLUMN_WIDTH (it
->f
)
20078 : FRAME_LINE_HEIGHT (it
->f
));
20079 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20084 Lisp_Object car
= XCAR (prop
);
20085 Lisp_Object cdr
= XCDR (prop
);
20089 #ifdef HAVE_WINDOW_SYSTEM
20090 if (FRAME_WINDOW_P (it
->f
)
20091 && valid_image_p (prop
))
20093 int id
= lookup_image (it
->f
, prop
);
20094 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20096 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20099 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20105 while (CONSP (cdr
))
20107 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20108 font
, width_p
, align_to
))
20111 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20116 if (EQ (car
, Qminus
))
20118 return OK_PIXELS (pixels
);
20121 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20124 if (INTEGERP (car
) || FLOATP (car
))
20127 pixels
= XFLOATINT (car
);
20129 return OK_PIXELS (pixels
);
20130 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20131 font
, width_p
, align_to
))
20132 return OK_PIXELS (pixels
* fact
);
20143 /***********************************************************************
20145 ***********************************************************************/
20147 #ifdef HAVE_WINDOW_SYSTEM
20152 dump_glyph_string (s
)
20153 struct glyph_string
*s
;
20155 fprintf (stderr
, "glyph string\n");
20156 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20157 s
->x
, s
->y
, s
->width
, s
->height
);
20158 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20159 fprintf (stderr
, " hl = %d\n", s
->hl
);
20160 fprintf (stderr
, " left overhang = %d, right = %d\n",
20161 s
->left_overhang
, s
->right_overhang
);
20162 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20163 fprintf (stderr
, " extends to end of line = %d\n",
20164 s
->extends_to_end_of_line_p
);
20165 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20166 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20169 #endif /* GLYPH_DEBUG */
20171 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20172 of XChar2b structures for S; it can't be allocated in
20173 init_glyph_string because it must be allocated via `alloca'. W
20174 is the window on which S is drawn. ROW and AREA are the glyph row
20175 and area within the row from which S is constructed. START is the
20176 index of the first glyph structure covered by S. HL is a
20177 face-override for drawing S. */
20180 #define OPTIONAL_HDC(hdc) hdc,
20181 #define DECLARE_HDC(hdc) HDC hdc;
20182 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20183 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20186 #ifndef OPTIONAL_HDC
20187 #define OPTIONAL_HDC(hdc)
20188 #define DECLARE_HDC(hdc)
20189 #define ALLOCATE_HDC(hdc, f)
20190 #define RELEASE_HDC(hdc, f)
20194 init_glyph_string (s
, OPTIONAL_HDC (hdc
) char2b
, w
, row
, area
, start
, hl
)
20195 struct glyph_string
*s
;
20199 struct glyph_row
*row
;
20200 enum glyph_row_area area
;
20202 enum draw_glyphs_face hl
;
20204 bzero (s
, sizeof *s
);
20206 s
->f
= XFRAME (w
->frame
);
20210 s
->display
= FRAME_X_DISPLAY (s
->f
);
20211 s
->window
= FRAME_X_WINDOW (s
->f
);
20212 s
->char2b
= char2b
;
20216 s
->first_glyph
= row
->glyphs
[area
] + start
;
20217 s
->height
= row
->height
;
20218 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20219 s
->ybase
= s
->y
+ row
->ascent
;
20223 /* Append the list of glyph strings with head H and tail T to the list
20224 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20227 append_glyph_string_lists (head
, tail
, h
, t
)
20228 struct glyph_string
**head
, **tail
;
20229 struct glyph_string
*h
, *t
;
20243 /* Prepend the list of glyph strings with head H and tail T to the
20244 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20248 prepend_glyph_string_lists (head
, tail
, h
, t
)
20249 struct glyph_string
**head
, **tail
;
20250 struct glyph_string
*h
, *t
;
20264 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20265 Set *HEAD and *TAIL to the resulting list. */
20268 append_glyph_string (head
, tail
, s
)
20269 struct glyph_string
**head
, **tail
;
20270 struct glyph_string
*s
;
20272 s
->next
= s
->prev
= NULL
;
20273 append_glyph_string_lists (head
, tail
, s
, s
);
20277 /* Get face and two-byte form of character C in face FACE_ID on frame
20278 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
20279 means we want to display multibyte text. DISPLAY_P non-zero means
20280 make sure that X resources for the face returned are allocated.
20281 Value is a pointer to a realized face that is ready for display if
20282 DISPLAY_P is non-zero. */
20284 static INLINE
struct face
*
20285 get_char_face_and_encoding (f
, c
, face_id
, char2b
, multibyte_p
, display_p
)
20289 int multibyte_p
, display_p
;
20291 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20295 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20297 if (code
!= FONT_INVALID_CODE
)
20298 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20300 STORE_XCHAR2B (char2b
, 0, 0);
20303 /* Make sure X resources of the face are allocated. */
20304 #ifdef HAVE_X_WINDOWS
20308 xassert (face
!= NULL
);
20309 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20316 /* Get face and two-byte form of character glyph GLYPH on frame F.
20317 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20318 a pointer to a realized face that is ready for display. */
20320 static INLINE
struct face
*
20321 get_glyph_face_and_encoding (f
, glyph
, char2b
, two_byte_p
)
20323 struct glyph
*glyph
;
20329 xassert (glyph
->type
== CHAR_GLYPH
);
20330 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20337 unsigned code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20339 if (code
!= FONT_INVALID_CODE
)
20340 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20342 STORE_XCHAR2B (char2b
, 0, 0);
20345 /* Make sure X resources of the face are allocated. */
20346 xassert (face
!= NULL
);
20347 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20352 /* Fill glyph string S with composition components specified by S->cmp.
20354 BASE_FACE is the base face of the composition.
20355 S->cmp_from is the index of the first component for S.
20357 OVERLAPS non-zero means S should draw the foreground only, and use
20358 its physical height for clipping. See also draw_glyphs.
20360 Value is the index of a component not in S. */
20363 fill_composite_glyph_string (s
, base_face
, overlaps
)
20364 struct glyph_string
*s
;
20365 struct face
*base_face
;
20369 /* For all glyphs of this composition, starting at the offset
20370 S->cmp_from, until we reach the end of the definition or encounter a
20371 glyph that requires the different face, add it to S. */
20376 s
->for_overlaps
= overlaps
;
20379 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20381 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20385 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20388 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20389 s
->char2b
+ i
, 1, 1);
20395 s
->font
= s
->face
->font
;
20397 else if (s
->face
!= face
)
20405 /* All glyph strings for the same composition has the same width,
20406 i.e. the width set for the first component of the composition. */
20407 s
->width
= s
->first_glyph
->pixel_width
;
20409 /* If the specified font could not be loaded, use the frame's
20410 default font, but record the fact that we couldn't load it in
20411 the glyph string so that we can draw rectangles for the
20412 characters of the glyph string. */
20413 if (s
->font
== NULL
)
20415 s
->font_not_found_p
= 1;
20416 s
->font
= FRAME_FONT (s
->f
);
20419 /* Adjust base line for subscript/superscript text. */
20420 s
->ybase
+= s
->first_glyph
->voffset
;
20422 /* This glyph string must always be drawn with 16-bit functions. */
20429 fill_gstring_glyph_string (s
, face_id
, start
, end
, overlaps
)
20430 struct glyph_string
*s
;
20432 int start
, end
, overlaps
;
20434 struct glyph
*glyph
, *last
;
20435 Lisp_Object lgstring
;
20438 s
->for_overlaps
= overlaps
;
20439 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20440 last
= s
->row
->glyphs
[s
->area
] + end
;
20441 s
->cmp_id
= glyph
->u
.cmp
.id
;
20442 s
->cmp_from
= glyph
->u
.cmp
.from
;
20443 s
->cmp_to
= glyph
->u
.cmp
.to
+ 1;
20444 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20445 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20446 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20448 while (glyph
< last
20449 && glyph
->u
.cmp
.automatic
20450 && glyph
->u
.cmp
.id
== s
->cmp_id
20451 && s
->cmp_to
== glyph
->u
.cmp
.from
)
20452 s
->cmp_to
= (glyph
++)->u
.cmp
.to
+ 1;
20454 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20456 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20457 unsigned code
= LGLYPH_CODE (lglyph
);
20459 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20461 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20462 return glyph
- s
->row
->glyphs
[s
->area
];
20466 /* Fill glyph string S from a sequence of character glyphs.
20468 FACE_ID is the face id of the string. START is the index of the
20469 first glyph to consider, END is the index of the last + 1.
20470 OVERLAPS non-zero means S should draw the foreground only, and use
20471 its physical height for clipping. See also draw_glyphs.
20473 Value is the index of the first glyph not in S. */
20476 fill_glyph_string (s
, face_id
, start
, end
, overlaps
)
20477 struct glyph_string
*s
;
20479 int start
, end
, overlaps
;
20481 struct glyph
*glyph
, *last
;
20483 int glyph_not_available_p
;
20485 xassert (s
->f
== XFRAME (s
->w
->frame
));
20486 xassert (s
->nchars
== 0);
20487 xassert (start
>= 0 && end
> start
);
20489 s
->for_overlaps
= overlaps
;
20490 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20491 last
= s
->row
->glyphs
[s
->area
] + end
;
20492 voffset
= glyph
->voffset
;
20493 s
->padding_p
= glyph
->padding_p
;
20494 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20496 while (glyph
< last
20497 && glyph
->type
== CHAR_GLYPH
20498 && glyph
->voffset
== voffset
20499 /* Same face id implies same font, nowadays. */
20500 && glyph
->face_id
== face_id
20501 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20505 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20506 s
->char2b
+ s
->nchars
,
20508 s
->two_byte_p
= two_byte_p
;
20510 xassert (s
->nchars
<= end
- start
);
20511 s
->width
+= glyph
->pixel_width
;
20512 if (glyph
++->padding_p
!= s
->padding_p
)
20516 s
->font
= s
->face
->font
;
20518 /* If the specified font could not be loaded, use the frame's font,
20519 but record the fact that we couldn't load it in
20520 S->font_not_found_p so that we can draw rectangles for the
20521 characters of the glyph string. */
20522 if (s
->font
== NULL
|| glyph_not_available_p
)
20524 s
->font_not_found_p
= 1;
20525 s
->font
= FRAME_FONT (s
->f
);
20528 /* Adjust base line for subscript/superscript text. */
20529 s
->ybase
+= voffset
;
20531 xassert (s
->face
&& s
->face
->gc
);
20532 return glyph
- s
->row
->glyphs
[s
->area
];
20536 /* Fill glyph string S from image glyph S->first_glyph. */
20539 fill_image_glyph_string (s
)
20540 struct glyph_string
*s
;
20542 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20543 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20545 s
->slice
= s
->first_glyph
->slice
;
20546 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20547 s
->font
= s
->face
->font
;
20548 s
->width
= s
->first_glyph
->pixel_width
;
20550 /* Adjust base line for subscript/superscript text. */
20551 s
->ybase
+= s
->first_glyph
->voffset
;
20555 /* Fill glyph string S from a sequence of stretch glyphs.
20557 ROW is the glyph row in which the glyphs are found, AREA is the
20558 area within the row. START is the index of the first glyph to
20559 consider, END is the index of the last + 1.
20561 Value is the index of the first glyph not in S. */
20564 fill_stretch_glyph_string (s
, row
, area
, start
, end
)
20565 struct glyph_string
*s
;
20566 struct glyph_row
*row
;
20567 enum glyph_row_area area
;
20570 struct glyph
*glyph
, *last
;
20571 int voffset
, face_id
;
20573 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20575 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20576 last
= s
->row
->glyphs
[s
->area
] + end
;
20577 face_id
= glyph
->face_id
;
20578 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20579 s
->font
= s
->face
->font
;
20580 s
->width
= glyph
->pixel_width
;
20582 voffset
= glyph
->voffset
;
20586 && glyph
->type
== STRETCH_GLYPH
20587 && glyph
->voffset
== voffset
20588 && glyph
->face_id
== face_id
);
20590 s
->width
+= glyph
->pixel_width
;
20592 /* Adjust base line for subscript/superscript text. */
20593 s
->ybase
+= voffset
;
20595 /* The case that face->gc == 0 is handled when drawing the glyph
20596 string by calling PREPARE_FACE_FOR_DISPLAY. */
20598 return glyph
- s
->row
->glyphs
[s
->area
];
20601 static struct font_metrics
*
20602 get_per_char_metric (f
, font
, char2b
)
20607 static struct font_metrics metrics
;
20608 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20610 if (! font
|| code
== FONT_INVALID_CODE
)
20612 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20617 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20618 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20619 assumed to be zero. */
20622 x_get_glyph_overhangs (glyph
, f
, left
, right
)
20623 struct glyph
*glyph
;
20627 *left
= *right
= 0;
20629 if (glyph
->type
== CHAR_GLYPH
)
20633 struct font_metrics
*pcm
;
20635 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20636 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
20638 if (pcm
->rbearing
> pcm
->width
)
20639 *right
= pcm
->rbearing
- pcm
->width
;
20640 if (pcm
->lbearing
< 0)
20641 *left
= -pcm
->lbearing
;
20644 else if (glyph
->type
== COMPOSITE_GLYPH
)
20646 if (! glyph
->u
.cmp
.automatic
)
20648 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20650 if (cmp
->rbearing
> cmp
->pixel_width
)
20651 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20652 if (cmp
->lbearing
< 0)
20653 *left
= - cmp
->lbearing
;
20657 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
20658 struct font_metrics metrics
;
20660 composition_gstring_width (gstring
, glyph
->u
.cmp
.from
,
20661 glyph
->u
.cmp
.to
+ 1, &metrics
);
20662 if (metrics
.rbearing
> metrics
.width
)
20663 *right
= metrics
.rbearing
- metrics
.width
;
20664 if (metrics
.lbearing
< 0)
20665 *left
= - metrics
.lbearing
;
20671 /* Return the index of the first glyph preceding glyph string S that
20672 is overwritten by S because of S's left overhang. Value is -1
20673 if no glyphs are overwritten. */
20676 left_overwritten (s
)
20677 struct glyph_string
*s
;
20681 if (s
->left_overhang
)
20684 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20685 int first
= s
->first_glyph
- glyphs
;
20687 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
20688 x
-= glyphs
[i
].pixel_width
;
20699 /* Return the index of the first glyph preceding glyph string S that
20700 is overwriting S because of its right overhang. Value is -1 if no
20701 glyph in front of S overwrites S. */
20704 left_overwriting (s
)
20705 struct glyph_string
*s
;
20708 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20709 int first
= s
->first_glyph
- glyphs
;
20713 for (i
= first
- 1; i
>= 0; --i
)
20716 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20719 x
-= glyphs
[i
].pixel_width
;
20726 /* Return the index of the last glyph following glyph string S that is
20727 overwritten by S because of S's right overhang. Value is -1 if
20728 no such glyph is found. */
20731 right_overwritten (s
)
20732 struct glyph_string
*s
;
20736 if (s
->right_overhang
)
20739 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20740 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20741 int end
= s
->row
->used
[s
->area
];
20743 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
20744 x
+= glyphs
[i
].pixel_width
;
20753 /* Return the index of the last glyph following glyph string S that
20754 overwrites S because of its left overhang. Value is negative
20755 if no such glyph is found. */
20758 right_overwriting (s
)
20759 struct glyph_string
*s
;
20762 int end
= s
->row
->used
[s
->area
];
20763 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20764 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20768 for (i
= first
; i
< end
; ++i
)
20771 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20774 x
+= glyphs
[i
].pixel_width
;
20781 /* Set background width of glyph string S. START is the index of the
20782 first glyph following S. LAST_X is the right-most x-position + 1
20783 in the drawing area. */
20786 set_glyph_string_background_width (s
, start
, last_x
)
20787 struct glyph_string
*s
;
20791 /* If the face of this glyph string has to be drawn to the end of
20792 the drawing area, set S->extends_to_end_of_line_p. */
20794 if (start
== s
->row
->used
[s
->area
]
20795 && s
->area
== TEXT_AREA
20796 && ((s
->row
->fill_line_p
20797 && (s
->hl
== DRAW_NORMAL_TEXT
20798 || s
->hl
== DRAW_IMAGE_RAISED
20799 || s
->hl
== DRAW_IMAGE_SUNKEN
))
20800 || s
->hl
== DRAW_MOUSE_FACE
))
20801 s
->extends_to_end_of_line_p
= 1;
20803 /* If S extends its face to the end of the line, set its
20804 background_width to the distance to the right edge of the drawing
20806 if (s
->extends_to_end_of_line_p
)
20807 s
->background_width
= last_x
- s
->x
+ 1;
20809 s
->background_width
= s
->width
;
20813 /* Compute overhangs and x-positions for glyph string S and its
20814 predecessors, or successors. X is the starting x-position for S.
20815 BACKWARD_P non-zero means process predecessors. */
20818 compute_overhangs_and_x (s
, x
, backward_p
)
20819 struct glyph_string
*s
;
20827 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20828 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20838 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20839 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20849 /* The following macros are only called from draw_glyphs below.
20850 They reference the following parameters of that function directly:
20851 `w', `row', `area', and `overlap_p'
20852 as well as the following local variables:
20853 `s', `f', and `hdc' (in W32) */
20856 /* On W32, silently add local `hdc' variable to argument list of
20857 init_glyph_string. */
20858 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20859 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
20861 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20862 init_glyph_string (s, char2b, w, row, area, start, hl)
20865 /* Add a glyph string for a stretch glyph to the list of strings
20866 between HEAD and TAIL. START is the index of the stretch glyph in
20867 row area AREA of glyph row ROW. END is the index of the last glyph
20868 in that glyph row area. X is the current output position assigned
20869 to the new glyph string constructed. HL overrides that face of the
20870 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20871 is the right-most x-position of the drawing area. */
20873 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
20874 and below -- keep them on one line. */
20875 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20878 s = (struct glyph_string *) alloca (sizeof *s); \
20879 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
20880 START = fill_stretch_glyph_string (s, row, area, START, END); \
20881 append_glyph_string (&HEAD, &TAIL, s); \
20887 /* Add a glyph string for an image glyph to the list of strings
20888 between HEAD and TAIL. START is the index of the image glyph in
20889 row area AREA of glyph row ROW. END is the index of the last glyph
20890 in that glyph row area. X is the current output position assigned
20891 to the new glyph string constructed. HL overrides that face of the
20892 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20893 is the right-most x-position of the drawing area. */
20895 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20898 s = (struct glyph_string *) alloca (sizeof *s); \
20899 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
20900 fill_image_glyph_string (s); \
20901 append_glyph_string (&HEAD, &TAIL, s); \
20908 /* Add a glyph string for a sequence of character glyphs to the list
20909 of strings between HEAD and TAIL. START is the index of the first
20910 glyph in row area AREA of glyph row ROW that is part of the new
20911 glyph string. END is the index of the last glyph in that glyph row
20912 area. X is the current output position assigned to the new glyph
20913 string constructed. HL overrides that face of the glyph; e.g. it
20914 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
20915 right-most x-position of the drawing area. */
20917 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
20923 face_id = (row)->glyphs[area][START].face_id; \
20925 s = (struct glyph_string *) alloca (sizeof *s); \
20926 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
20927 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20928 append_glyph_string (&HEAD, &TAIL, s); \
20930 START = fill_glyph_string (s, face_id, START, END, overlaps); \
20935 /* Add a glyph string for a composite sequence to the list of strings
20936 between HEAD and TAIL. START is the index of the first glyph in
20937 row area AREA of glyph row ROW that is part of the new glyph
20938 string. END is the index of the last glyph in that glyph row area.
20939 X is the current output position assigned to the new glyph string
20940 constructed. HL overrides that face of the glyph; e.g. it is
20941 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
20942 x-position of the drawing area. */
20944 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20946 int face_id = (row)->glyphs[area][START].face_id; \
20947 struct face *base_face = FACE_FROM_ID (f, face_id); \
20948 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
20949 struct composition *cmp = composition_table[cmp_id]; \
20951 struct glyph_string *first_s; \
20954 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
20956 /* Make glyph_strings for each glyph sequence that is drawable by \
20957 the same face, and append them to HEAD/TAIL. */ \
20958 for (n = 0; n < cmp->glyph_len;) \
20960 s = (struct glyph_string *) alloca (sizeof *s); \
20961 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20962 append_glyph_string (&(HEAD), &(TAIL), s); \
20968 n = fill_composite_glyph_string (s, base_face, overlaps); \
20976 /* Add a glyph string for a glyph-string sequence to the list of strings
20977 between HEAD and TAIL. */
20979 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20983 Lisp_Object gstring; \
20985 face_id = (row)->glyphs[area][START].face_id; \
20986 gstring = (composition_gstring_from_id \
20987 ((row)->glyphs[area][START].u.cmp.id)); \
20988 s = (struct glyph_string *) alloca (sizeof *s); \
20989 char2b = (XChar2b *) alloca ((sizeof *char2b) \
20990 * LGSTRING_GLYPH_LEN (gstring)); \
20991 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20992 append_glyph_string (&(HEAD), &(TAIL), s); \
20994 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
20998 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
20999 of AREA of glyph row ROW on window W between indices START and END.
21000 HL overrides the face for drawing glyph strings, e.g. it is
21001 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21002 x-positions of the drawing area.
21004 This is an ugly monster macro construct because we must use alloca
21005 to allocate glyph strings (because draw_glyphs can be called
21006 asynchronously). */
21008 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21011 HEAD = TAIL = NULL; \
21012 while (START < END) \
21014 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21015 switch (first_glyph->type) \
21018 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21022 case COMPOSITE_GLYPH: \
21023 if (first_glyph->u.cmp.automatic) \
21024 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21027 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21031 case STRETCH_GLYPH: \
21032 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21036 case IMAGE_GLYPH: \
21037 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21047 set_glyph_string_background_width (s, START, LAST_X); \
21054 /* Draw glyphs between START and END in AREA of ROW on window W,
21055 starting at x-position X. X is relative to AREA in W. HL is a
21056 face-override with the following meaning:
21058 DRAW_NORMAL_TEXT draw normally
21059 DRAW_CURSOR draw in cursor face
21060 DRAW_MOUSE_FACE draw in mouse face.
21061 DRAW_INVERSE_VIDEO draw in mode line face
21062 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21063 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21065 If OVERLAPS is non-zero, draw only the foreground of characters and
21066 clip to the physical height of ROW. Non-zero value also defines
21067 the overlapping part to be drawn:
21069 OVERLAPS_PRED overlap with preceding rows
21070 OVERLAPS_SUCC overlap with succeeding rows
21071 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21072 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21074 Value is the x-position reached, relative to AREA of W. */
21077 draw_glyphs (w
, x
, row
, area
, start
, end
, hl
, overlaps
)
21080 struct glyph_row
*row
;
21081 enum glyph_row_area area
;
21082 EMACS_INT start
, end
;
21083 enum draw_glyphs_face hl
;
21086 struct glyph_string
*head
, *tail
;
21087 struct glyph_string
*s
;
21088 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21089 int i
, j
, x_reached
, last_x
, area_left
= 0;
21090 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21093 ALLOCATE_HDC (hdc
, f
);
21095 /* Let's rather be paranoid than getting a SEGV. */
21096 end
= min (end
, row
->used
[area
]);
21097 start
= max (0, start
);
21098 start
= min (end
, start
);
21100 /* Translate X to frame coordinates. Set last_x to the right
21101 end of the drawing area. */
21102 if (row
->full_width_p
)
21104 /* X is relative to the left edge of W, without scroll bars
21106 area_left
= WINDOW_LEFT_EDGE_X (w
);
21107 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21111 area_left
= window_box_left (w
, area
);
21112 last_x
= area_left
+ window_box_width (w
, area
);
21116 /* Build a doubly-linked list of glyph_string structures between
21117 head and tail from what we have to draw. Note that the macro
21118 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21119 the reason we use a separate variable `i'. */
21121 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21123 x_reached
= tail
->x
+ tail
->background_width
;
21127 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21128 the row, redraw some glyphs in front or following the glyph
21129 strings built above. */
21130 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21132 struct glyph_string
*h
, *t
;
21133 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
21134 int mouse_beg_col
, mouse_end_col
, check_mouse_face
= 0;
21137 /* If mouse highlighting is on, we may need to draw adjacent
21138 glyphs using mouse-face highlighting. */
21139 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21141 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21143 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
21144 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
21146 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21148 check_mouse_face
= 1;
21149 mouse_beg_col
= (row
== mouse_beg_row
)
21150 ? dpyinfo
->mouse_face_beg_col
: 0;
21151 mouse_end_col
= (row
== mouse_end_row
)
21152 ? dpyinfo
->mouse_face_end_col
21153 : row
->used
[TEXT_AREA
];
21157 /* Compute overhangs for all glyph strings. */
21158 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21159 for (s
= head
; s
; s
= s
->next
)
21160 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21162 /* Prepend glyph strings for glyphs in front of the first glyph
21163 string that are overwritten because of the first glyph
21164 string's left overhang. The background of all strings
21165 prepended must be drawn because the first glyph string
21167 i
= left_overwritten (head
);
21170 enum draw_glyphs_face overlap_hl
;
21172 /* If this row contains mouse highlighting, attempt to draw
21173 the overlapped glyphs with the correct highlight. This
21174 code fails if the overlap encompasses more than one glyph
21175 and mouse-highlight spans only some of these glyphs.
21176 However, making it work perfectly involves a lot more
21177 code, and I don't know if the pathological case occurs in
21178 practice, so we'll stick to this for now. --- cyd */
21179 if (check_mouse_face
21180 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21181 overlap_hl
= DRAW_MOUSE_FACE
;
21183 overlap_hl
= DRAW_NORMAL_TEXT
;
21186 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21187 overlap_hl
, dummy_x
, last_x
);
21189 compute_overhangs_and_x (t
, head
->x
, 1);
21190 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21194 /* Prepend glyph strings for glyphs in front of the first glyph
21195 string that overwrite that glyph string because of their
21196 right overhang. For these strings, only the foreground must
21197 be drawn, because it draws over the glyph string at `head'.
21198 The background must not be drawn because this would overwrite
21199 right overhangs of preceding glyphs for which no glyph
21201 i
= left_overwriting (head
);
21204 enum draw_glyphs_face overlap_hl
;
21206 if (check_mouse_face
21207 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21208 overlap_hl
= DRAW_MOUSE_FACE
;
21210 overlap_hl
= DRAW_NORMAL_TEXT
;
21213 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21214 overlap_hl
, dummy_x
, last_x
);
21215 for (s
= h
; s
; s
= s
->next
)
21216 s
->background_filled_p
= 1;
21217 compute_overhangs_and_x (t
, head
->x
, 1);
21218 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21221 /* Append glyphs strings for glyphs following the last glyph
21222 string tail that are overwritten by tail. The background of
21223 these strings has to be drawn because tail's foreground draws
21225 i
= right_overwritten (tail
);
21228 enum draw_glyphs_face overlap_hl
;
21230 if (check_mouse_face
21231 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21232 overlap_hl
= DRAW_MOUSE_FACE
;
21234 overlap_hl
= DRAW_NORMAL_TEXT
;
21236 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21237 overlap_hl
, x
, last_x
);
21238 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21239 we don't have `end = i;' here. */
21240 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21241 append_glyph_string_lists (&head
, &tail
, h
, t
);
21245 /* Append glyph strings for glyphs following the last glyph
21246 string tail that overwrite tail. The foreground of such
21247 glyphs has to be drawn because it writes into the background
21248 of tail. The background must not be drawn because it could
21249 paint over the foreground of following glyphs. */
21250 i
= right_overwriting (tail
);
21253 enum draw_glyphs_face overlap_hl
;
21254 if (check_mouse_face
21255 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21256 overlap_hl
= DRAW_MOUSE_FACE
;
21258 overlap_hl
= DRAW_NORMAL_TEXT
;
21261 i
++; /* We must include the Ith glyph. */
21262 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21263 overlap_hl
, x
, last_x
);
21264 for (s
= h
; s
; s
= s
->next
)
21265 s
->background_filled_p
= 1;
21266 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21267 append_glyph_string_lists (&head
, &tail
, h
, t
);
21269 if (clip_head
|| clip_tail
)
21270 for (s
= head
; s
; s
= s
->next
)
21272 s
->clip_head
= clip_head
;
21273 s
->clip_tail
= clip_tail
;
21277 /* Draw all strings. */
21278 for (s
= head
; s
; s
= s
->next
)
21279 FRAME_RIF (f
)->draw_glyph_string (s
);
21282 /* When focus a sole frame and move horizontally, this sets on_p to 0
21283 causing a failure to erase prev cursor position. */
21284 if (area
== TEXT_AREA
21285 && !row
->full_width_p
21286 /* When drawing overlapping rows, only the glyph strings'
21287 foreground is drawn, which doesn't erase a cursor
21291 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21292 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21293 : (tail
? tail
->x
+ tail
->background_width
: x
));
21297 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21298 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21302 /* Value is the x-position up to which drawn, relative to AREA of W.
21303 This doesn't include parts drawn because of overhangs. */
21304 if (row
->full_width_p
)
21305 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21307 x_reached
-= area_left
;
21309 RELEASE_HDC (hdc
, f
);
21314 /* Expand row matrix if too narrow. Don't expand if area
21317 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21319 if (!fonts_changed_p \
21320 && (it->glyph_row->glyphs[area] \
21321 < it->glyph_row->glyphs[area + 1])) \
21323 it->w->ncols_scale_factor++; \
21324 fonts_changed_p = 1; \
21328 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21329 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21335 struct glyph
*glyph
;
21336 enum glyph_row_area area
= it
->area
;
21338 xassert (it
->glyph_row
);
21339 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21341 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21342 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21344 /* If the glyph row is reversed, we need to prepend the glyph
21345 rather than append it. */
21346 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21350 /* Make room for the additional glyph. */
21351 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21353 glyph
= it
->glyph_row
->glyphs
[area
];
21355 glyph
->charpos
= CHARPOS (it
->position
);
21356 glyph
->object
= it
->object
;
21357 if (it
->pixel_width
> 0)
21359 glyph
->pixel_width
= it
->pixel_width
;
21360 glyph
->padding_p
= 0;
21364 /* Assure at least 1-pixel width. Otherwise, cursor can't
21365 be displayed correctly. */
21366 glyph
->pixel_width
= 1;
21367 glyph
->padding_p
= 1;
21369 glyph
->ascent
= it
->ascent
;
21370 glyph
->descent
= it
->descent
;
21371 glyph
->voffset
= it
->voffset
;
21372 glyph
->type
= CHAR_GLYPH
;
21373 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21374 glyph
->multibyte_p
= it
->multibyte_p
;
21375 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21376 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21377 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21378 || it
->phys_descent
> it
->descent
);
21379 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21380 glyph
->face_id
= it
->face_id
;
21381 glyph
->u
.ch
= it
->char_to_display
;
21382 glyph
->slice
= null_glyph_slice
;
21383 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21386 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21387 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21389 glyph
->bidi_type
= it
->bidi_it
.type
;
21393 glyph
->resolved_level
= 0;
21394 glyph
->bidi_type
= UNKNOWN_BT
;
21396 ++it
->glyph_row
->used
[area
];
21399 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21402 /* Store one glyph for the composition IT->cmp_it.id in
21403 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21407 append_composite_glyph (it
)
21410 struct glyph
*glyph
;
21411 enum glyph_row_area area
= it
->area
;
21413 xassert (it
->glyph_row
);
21415 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21416 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21418 glyph
->charpos
= CHARPOS (it
->position
);
21419 glyph
->object
= it
->object
;
21420 glyph
->pixel_width
= it
->pixel_width
;
21421 glyph
->ascent
= it
->ascent
;
21422 glyph
->descent
= it
->descent
;
21423 glyph
->voffset
= it
->voffset
;
21424 glyph
->type
= COMPOSITE_GLYPH
;
21425 if (it
->cmp_it
.ch
< 0)
21427 glyph
->u
.cmp
.automatic
= 0;
21428 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21432 glyph
->u
.cmp
.automatic
= 1;
21433 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21434 glyph
->u
.cmp
.from
= it
->cmp_it
.from
;
21435 glyph
->u
.cmp
.to
= it
->cmp_it
.to
- 1;
21437 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21438 glyph
->multibyte_p
= it
->multibyte_p
;
21439 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21440 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21441 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21442 || it
->phys_descent
> it
->descent
);
21443 glyph
->padding_p
= 0;
21444 glyph
->glyph_not_available_p
= 0;
21445 glyph
->face_id
= it
->face_id
;
21446 glyph
->slice
= null_glyph_slice
;
21447 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21450 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21451 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21453 glyph
->bidi_type
= it
->bidi_it
.type
;
21455 ++it
->glyph_row
->used
[area
];
21458 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21462 /* Change IT->ascent and IT->height according to the setting of
21466 take_vertical_position_into_account (it
)
21471 if (it
->voffset
< 0)
21472 /* Increase the ascent so that we can display the text higher
21474 it
->ascent
-= it
->voffset
;
21476 /* Increase the descent so that we can display the text lower
21478 it
->descent
+= it
->voffset
;
21483 /* Produce glyphs/get display metrics for the image IT is loaded with.
21484 See the description of struct display_iterator in dispextern.h for
21485 an overview of struct display_iterator. */
21488 produce_image_glyph (it
)
21493 int glyph_ascent
, crop
;
21494 struct glyph_slice slice
;
21496 xassert (it
->what
== IT_IMAGE
);
21498 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21500 /* Make sure X resources of the face is loaded. */
21501 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21503 if (it
->image_id
< 0)
21505 /* Fringe bitmap. */
21506 it
->ascent
= it
->phys_ascent
= 0;
21507 it
->descent
= it
->phys_descent
= 0;
21508 it
->pixel_width
= 0;
21513 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21515 /* Make sure X resources of the image is loaded. */
21516 prepare_image_for_display (it
->f
, img
);
21518 slice
.x
= slice
.y
= 0;
21519 slice
.width
= img
->width
;
21520 slice
.height
= img
->height
;
21522 if (INTEGERP (it
->slice
.x
))
21523 slice
.x
= XINT (it
->slice
.x
);
21524 else if (FLOATP (it
->slice
.x
))
21525 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21527 if (INTEGERP (it
->slice
.y
))
21528 slice
.y
= XINT (it
->slice
.y
);
21529 else if (FLOATP (it
->slice
.y
))
21530 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21532 if (INTEGERP (it
->slice
.width
))
21533 slice
.width
= XINT (it
->slice
.width
);
21534 else if (FLOATP (it
->slice
.width
))
21535 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21537 if (INTEGERP (it
->slice
.height
))
21538 slice
.height
= XINT (it
->slice
.height
);
21539 else if (FLOATP (it
->slice
.height
))
21540 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21542 if (slice
.x
>= img
->width
)
21543 slice
.x
= img
->width
;
21544 if (slice
.y
>= img
->height
)
21545 slice
.y
= img
->height
;
21546 if (slice
.x
+ slice
.width
>= img
->width
)
21547 slice
.width
= img
->width
- slice
.x
;
21548 if (slice
.y
+ slice
.height
> img
->height
)
21549 slice
.height
= img
->height
- slice
.y
;
21551 if (slice
.width
== 0 || slice
.height
== 0)
21554 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21556 it
->descent
= slice
.height
- glyph_ascent
;
21558 it
->descent
+= img
->vmargin
;
21559 if (slice
.y
+ slice
.height
== img
->height
)
21560 it
->descent
+= img
->vmargin
;
21561 it
->phys_descent
= it
->descent
;
21563 it
->pixel_width
= slice
.width
;
21565 it
->pixel_width
+= img
->hmargin
;
21566 if (slice
.x
+ slice
.width
== img
->width
)
21567 it
->pixel_width
+= img
->hmargin
;
21569 /* It's quite possible for images to have an ascent greater than
21570 their height, so don't get confused in that case. */
21571 if (it
->descent
< 0)
21576 if (face
->box
!= FACE_NO_BOX
)
21578 if (face
->box_line_width
> 0)
21581 it
->ascent
+= face
->box_line_width
;
21582 if (slice
.y
+ slice
.height
== img
->height
)
21583 it
->descent
+= face
->box_line_width
;
21586 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21587 it
->pixel_width
+= eabs (face
->box_line_width
);
21588 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21589 it
->pixel_width
+= eabs (face
->box_line_width
);
21592 take_vertical_position_into_account (it
);
21594 /* Automatically crop wide image glyphs at right edge so we can
21595 draw the cursor on same display row. */
21596 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21597 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21599 it
->pixel_width
-= crop
;
21600 slice
.width
-= crop
;
21605 struct glyph
*glyph
;
21606 enum glyph_row_area area
= it
->area
;
21608 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21609 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21611 glyph
->charpos
= CHARPOS (it
->position
);
21612 glyph
->object
= it
->object
;
21613 glyph
->pixel_width
= it
->pixel_width
;
21614 glyph
->ascent
= glyph_ascent
;
21615 glyph
->descent
= it
->descent
;
21616 glyph
->voffset
= it
->voffset
;
21617 glyph
->type
= IMAGE_GLYPH
;
21618 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21619 glyph
->multibyte_p
= it
->multibyte_p
;
21620 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21621 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21622 glyph
->overlaps_vertically_p
= 0;
21623 glyph
->padding_p
= 0;
21624 glyph
->glyph_not_available_p
= 0;
21625 glyph
->face_id
= it
->face_id
;
21626 glyph
->u
.img_id
= img
->id
;
21627 glyph
->slice
= slice
;
21628 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21631 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21632 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21634 glyph
->bidi_type
= it
->bidi_it
.type
;
21636 ++it
->glyph_row
->used
[area
];
21639 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21644 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
21645 of the glyph, WIDTH and HEIGHT are the width and height of the
21646 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
21649 append_stretch_glyph (it
, object
, width
, height
, ascent
)
21651 Lisp_Object object
;
21655 struct glyph
*glyph
;
21656 enum glyph_row_area area
= it
->area
;
21658 xassert (ascent
>= 0 && ascent
<= height
);
21660 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21661 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21663 glyph
->charpos
= CHARPOS (it
->position
);
21664 glyph
->object
= object
;
21665 glyph
->pixel_width
= width
;
21666 glyph
->ascent
= ascent
;
21667 glyph
->descent
= height
- ascent
;
21668 glyph
->voffset
= it
->voffset
;
21669 glyph
->type
= STRETCH_GLYPH
;
21670 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21671 glyph
->multibyte_p
= it
->multibyte_p
;
21672 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21673 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21674 glyph
->overlaps_vertically_p
= 0;
21675 glyph
->padding_p
= 0;
21676 glyph
->glyph_not_available_p
= 0;
21677 glyph
->face_id
= it
->face_id
;
21678 glyph
->u
.stretch
.ascent
= ascent
;
21679 glyph
->u
.stretch
.height
= height
;
21680 glyph
->slice
= null_glyph_slice
;
21681 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21684 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21685 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21687 glyph
->bidi_type
= it
->bidi_it
.type
;
21689 ++it
->glyph_row
->used
[area
];
21692 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21696 /* Produce a stretch glyph for iterator IT. IT->object is the value
21697 of the glyph property displayed. The value must be a list
21698 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
21701 1. `:width WIDTH' specifies that the space should be WIDTH *
21702 canonical char width wide. WIDTH may be an integer or floating
21705 2. `:relative-width FACTOR' specifies that the width of the stretch
21706 should be computed from the width of the first character having the
21707 `glyph' property, and should be FACTOR times that width.
21709 3. `:align-to HPOS' specifies that the space should be wide enough
21710 to reach HPOS, a value in canonical character units.
21712 Exactly one of the above pairs must be present.
21714 4. `:height HEIGHT' specifies that the height of the stretch produced
21715 should be HEIGHT, measured in canonical character units.
21717 5. `:relative-height FACTOR' specifies that the height of the
21718 stretch should be FACTOR times the height of the characters having
21719 the glyph property.
21721 Either none or exactly one of 4 or 5 must be present.
21723 6. `:ascent ASCENT' specifies that ASCENT percent of the height
21724 of the stretch should be used for the ascent of the stretch.
21725 ASCENT must be in the range 0 <= ASCENT <= 100. */
21728 produce_stretch_glyph (it
)
21731 /* (space :width WIDTH :height HEIGHT ...) */
21732 Lisp_Object prop
, plist
;
21733 int width
= 0, height
= 0, align_to
= -1;
21734 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
21737 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21738 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
21740 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21742 /* List should start with `space'. */
21743 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
21744 plist
= XCDR (it
->object
);
21746 /* Compute the width of the stretch. */
21747 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
21748 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
21750 /* Absolute width `:width WIDTH' specified and valid. */
21751 zero_width_ok_p
= 1;
21754 else if (prop
= Fplist_get (plist
, QCrelative_width
),
21757 /* Relative width `:relative-width FACTOR' specified and valid.
21758 Compute the width of the characters having the `glyph'
21761 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
21764 if (it
->multibyte_p
)
21766 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
21767 - IT_BYTEPOS (*it
));
21768 it2
.c
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
21771 it2
.c
= *p
, it2
.len
= 1;
21773 it2
.glyph_row
= NULL
;
21774 it2
.what
= IT_CHARACTER
;
21775 x_produce_glyphs (&it2
);
21776 width
= NUMVAL (prop
) * it2
.pixel_width
;
21778 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
21779 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
21781 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
21782 align_to
= (align_to
< 0
21784 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
21785 else if (align_to
< 0)
21786 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
21787 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
21788 zero_width_ok_p
= 1;
21791 /* Nothing specified -> width defaults to canonical char width. */
21792 width
= FRAME_COLUMN_WIDTH (it
->f
);
21794 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
21797 /* Compute height. */
21798 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
21799 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21802 zero_height_ok_p
= 1;
21804 else if (prop
= Fplist_get (plist
, QCrelative_height
),
21806 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
21808 height
= FONT_HEIGHT (font
);
21810 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
21813 /* Compute percentage of height used for ascent. If
21814 `:ascent ASCENT' is present and valid, use that. Otherwise,
21815 derive the ascent from the font in use. */
21816 if (prop
= Fplist_get (plist
, QCascent
),
21817 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
21818 ascent
= height
* NUMVAL (prop
) / 100.0;
21819 else if (!NILP (prop
)
21820 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21821 ascent
= min (max (0, (int)tem
), height
);
21823 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
21825 if (width
> 0 && it
->line_wrap
!= TRUNCATE
21826 && it
->current_x
+ width
> it
->last_visible_x
)
21827 width
= it
->last_visible_x
- it
->current_x
- 1;
21829 if (width
> 0 && height
> 0 && it
->glyph_row
)
21831 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
21832 if (!STRINGP (object
))
21833 object
= it
->w
->buffer
;
21834 append_stretch_glyph (it
, object
, width
, height
, ascent
);
21837 it
->pixel_width
= width
;
21838 it
->ascent
= it
->phys_ascent
= ascent
;
21839 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
21840 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
21842 take_vertical_position_into_account (it
);
21845 /* Calculate line-height and line-spacing properties.
21846 An integer value specifies explicit pixel value.
21847 A float value specifies relative value to current face height.
21848 A cons (float . face-name) specifies relative value to
21849 height of specified face font.
21851 Returns height in pixels, or nil. */
21855 calc_line_height_property (it
, val
, font
, boff
, override
)
21859 int boff
, override
;
21861 Lisp_Object face_name
= Qnil
;
21862 int ascent
, descent
, height
;
21864 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
21869 face_name
= XCAR (val
);
21871 if (!NUMBERP (val
))
21872 val
= make_number (1);
21873 if (NILP (face_name
))
21875 height
= it
->ascent
+ it
->descent
;
21880 if (NILP (face_name
))
21882 font
= FRAME_FONT (it
->f
);
21883 boff
= FRAME_BASELINE_OFFSET (it
->f
);
21885 else if (EQ (face_name
, Qt
))
21894 face_id
= lookup_named_face (it
->f
, face_name
, 0);
21896 return make_number (-1);
21898 face
= FACE_FROM_ID (it
->f
, face_id
);
21901 return make_number (-1);
21902 boff
= font
->baseline_offset
;
21903 if (font
->vertical_centering
)
21904 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21907 ascent
= FONT_BASE (font
) + boff
;
21908 descent
= FONT_DESCENT (font
) - boff
;
21912 it
->override_ascent
= ascent
;
21913 it
->override_descent
= descent
;
21914 it
->override_boff
= boff
;
21917 height
= ascent
+ descent
;
21921 height
= (int)(XFLOAT_DATA (val
) * height
);
21922 else if (INTEGERP (val
))
21923 height
*= XINT (val
);
21925 return make_number (height
);
21930 Produce glyphs/get display metrics for the display element IT is
21931 loaded with. See the description of struct it in dispextern.h
21932 for an overview of struct it. */
21935 x_produce_glyphs (it
)
21938 int extra_line_spacing
= it
->extra_line_spacing
;
21940 it
->glyph_not_available_p
= 0;
21942 if (it
->what
== IT_CHARACTER
)
21946 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21947 struct font_metrics
*pcm
;
21948 int font_not_found_p
;
21949 int boff
; /* baseline offset */
21950 /* We may change it->multibyte_p upon unibyte<->multibyte
21951 conversion. So, save the current value now and restore it
21954 Note: It seems that we don't have to record multibyte_p in
21955 struct glyph because the character code itself tells whether
21956 or not the character is multibyte. Thus, in the future, we
21957 must consider eliminating the field `multibyte_p' in the
21959 int saved_multibyte_p
= it
->multibyte_p
;
21961 /* Maybe translate single-byte characters to multibyte, or the
21963 it
->char_to_display
= it
->c
;
21964 if (!ASCII_BYTE_P (it
->c
)
21965 && ! it
->multibyte_p
)
21967 if (SINGLE_BYTE_CHAR_P (it
->c
)
21968 && unibyte_display_via_language_environment
)
21970 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
21972 /* get_next_display_element assures that this decoding
21974 it
->char_to_display
= DECODE_CHAR (unibyte
, it
->c
);
21975 it
->multibyte_p
= 1;
21976 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
,
21978 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21982 /* Get font to use. Encode IT->char_to_display. */
21983 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
21984 &char2b
, it
->multibyte_p
, 0);
21987 font_not_found_p
= font
== NULL
;
21988 if (font_not_found_p
)
21990 /* When no suitable font found, display an empty box based
21991 on the metrics of the font of the default face (or what
21993 struct face
*no_font_face
21994 = FACE_FROM_ID (it
->f
,
21995 NILP (Vface_remapping_alist
) ? DEFAULT_FACE_ID
21996 : lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
21997 font
= no_font_face
->font
;
21998 boff
= font
->baseline_offset
;
22002 boff
= font
->baseline_offset
;
22003 if (font
->vertical_centering
)
22004 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22007 if (it
->char_to_display
>= ' '
22008 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
22010 /* Either unibyte or ASCII. */
22015 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22017 if (it
->override_ascent
>= 0)
22019 it
->ascent
= it
->override_ascent
;
22020 it
->descent
= it
->override_descent
;
22021 boff
= it
->override_boff
;
22025 it
->ascent
= FONT_BASE (font
) + boff
;
22026 it
->descent
= FONT_DESCENT (font
) - boff
;
22031 it
->phys_ascent
= pcm
->ascent
+ boff
;
22032 it
->phys_descent
= pcm
->descent
- boff
;
22033 it
->pixel_width
= pcm
->width
;
22037 it
->glyph_not_available_p
= 1;
22038 it
->phys_ascent
= it
->ascent
;
22039 it
->phys_descent
= it
->descent
;
22040 it
->pixel_width
= FONT_WIDTH (font
);
22043 if (it
->constrain_row_ascent_descent_p
)
22045 if (it
->descent
> it
->max_descent
)
22047 it
->ascent
+= it
->descent
- it
->max_descent
;
22048 it
->descent
= it
->max_descent
;
22050 if (it
->ascent
> it
->max_ascent
)
22052 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22053 it
->ascent
= it
->max_ascent
;
22055 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22056 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22057 extra_line_spacing
= 0;
22060 /* If this is a space inside a region of text with
22061 `space-width' property, change its width. */
22062 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22064 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22066 /* If face has a box, add the box thickness to the character
22067 height. If character has a box line to the left and/or
22068 right, add the box line width to the character's width. */
22069 if (face
->box
!= FACE_NO_BOX
)
22071 int thick
= face
->box_line_width
;
22075 it
->ascent
+= thick
;
22076 it
->descent
+= thick
;
22081 if (it
->start_of_box_run_p
)
22082 it
->pixel_width
+= thick
;
22083 if (it
->end_of_box_run_p
)
22084 it
->pixel_width
+= thick
;
22087 /* If face has an overline, add the height of the overline
22088 (1 pixel) and a 1 pixel margin to the character height. */
22089 if (face
->overline_p
)
22090 it
->ascent
+= overline_margin
;
22092 if (it
->constrain_row_ascent_descent_p
)
22094 if (it
->ascent
> it
->max_ascent
)
22095 it
->ascent
= it
->max_ascent
;
22096 if (it
->descent
> it
->max_descent
)
22097 it
->descent
= it
->max_descent
;
22100 take_vertical_position_into_account (it
);
22102 /* If we have to actually produce glyphs, do it. */
22107 /* Translate a space with a `space-width' property
22108 into a stretch glyph. */
22109 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22110 / FONT_HEIGHT (font
));
22111 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22112 it
->ascent
+ it
->descent
, ascent
);
22117 /* If characters with lbearing or rbearing are displayed
22118 in this line, record that fact in a flag of the
22119 glyph row. This is used to optimize X output code. */
22120 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22121 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22123 if (! stretched_p
&& it
->pixel_width
== 0)
22124 /* We assure that all visible glyphs have at least 1-pixel
22126 it
->pixel_width
= 1;
22128 else if (it
->char_to_display
== '\n')
22130 /* A newline has no width, but we need the height of the
22131 line. But if previous part of the line sets a height,
22132 don't increase that height */
22134 Lisp_Object height
;
22135 Lisp_Object total_height
= Qnil
;
22137 it
->override_ascent
= -1;
22138 it
->pixel_width
= 0;
22141 height
= get_it_property(it
, Qline_height
);
22142 /* Split (line-height total-height) list */
22144 && CONSP (XCDR (height
))
22145 && NILP (XCDR (XCDR (height
))))
22147 total_height
= XCAR (XCDR (height
));
22148 height
= XCAR (height
);
22150 height
= calc_line_height_property(it
, height
, font
, boff
, 1);
22152 if (it
->override_ascent
>= 0)
22154 it
->ascent
= it
->override_ascent
;
22155 it
->descent
= it
->override_descent
;
22156 boff
= it
->override_boff
;
22160 it
->ascent
= FONT_BASE (font
) + boff
;
22161 it
->descent
= FONT_DESCENT (font
) - boff
;
22164 if (EQ (height
, Qt
))
22166 if (it
->descent
> it
->max_descent
)
22168 it
->ascent
+= it
->descent
- it
->max_descent
;
22169 it
->descent
= it
->max_descent
;
22171 if (it
->ascent
> it
->max_ascent
)
22173 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22174 it
->ascent
= it
->max_ascent
;
22176 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22177 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22178 it
->constrain_row_ascent_descent_p
= 1;
22179 extra_line_spacing
= 0;
22183 Lisp_Object spacing
;
22185 it
->phys_ascent
= it
->ascent
;
22186 it
->phys_descent
= it
->descent
;
22188 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22189 && face
->box
!= FACE_NO_BOX
22190 && face
->box_line_width
> 0)
22192 it
->ascent
+= face
->box_line_width
;
22193 it
->descent
+= face
->box_line_width
;
22196 && XINT (height
) > it
->ascent
+ it
->descent
)
22197 it
->ascent
= XINT (height
) - it
->descent
;
22199 if (!NILP (total_height
))
22200 spacing
= calc_line_height_property(it
, total_height
, font
, boff
, 0);
22203 spacing
= get_it_property(it
, Qline_spacing
);
22204 spacing
= calc_line_height_property(it
, spacing
, font
, boff
, 0);
22206 if (INTEGERP (spacing
))
22208 extra_line_spacing
= XINT (spacing
);
22209 if (!NILP (total_height
))
22210 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22214 else if (it
->char_to_display
== '\t')
22216 if (font
->space_width
> 0)
22218 int tab_width
= it
->tab_width
* font
->space_width
;
22219 int x
= it
->current_x
+ it
->continuation_lines_width
;
22220 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22222 /* If the distance from the current position to the next tab
22223 stop is less than a space character width, use the
22224 tab stop after that. */
22225 if (next_tab_x
- x
< font
->space_width
)
22226 next_tab_x
+= tab_width
;
22228 it
->pixel_width
= next_tab_x
- x
;
22230 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22231 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22235 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22236 it
->ascent
+ it
->descent
, it
->ascent
);
22241 it
->pixel_width
= 0;
22247 /* A multi-byte character. Assume that the display width of the
22248 character is the width of the character multiplied by the
22249 width of the font. */
22251 /* If we found a font, this font should give us the right
22252 metrics. If we didn't find a font, use the frame's
22253 default font and calculate the width of the character by
22254 multiplying the width of font by the width of the
22257 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22259 if (font_not_found_p
|| !pcm
)
22261 int char_width
= CHAR_WIDTH (it
->char_to_display
);
22263 if (char_width
== 0)
22264 /* This is a non spacing character. But, as we are
22265 going to display an empty box, the box must occupy
22266 at least one column. */
22268 it
->glyph_not_available_p
= 1;
22269 it
->pixel_width
= font
->space_width
* char_width
;
22270 it
->phys_ascent
= FONT_BASE (font
) + boff
;
22271 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22275 it
->pixel_width
= pcm
->width
;
22276 it
->phys_ascent
= pcm
->ascent
+ boff
;
22277 it
->phys_descent
= pcm
->descent
- boff
;
22279 && (pcm
->lbearing
< 0
22280 || pcm
->rbearing
> pcm
->width
))
22281 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22284 it
->ascent
= FONT_BASE (font
) + boff
;
22285 it
->descent
= FONT_DESCENT (font
) - boff
;
22286 if (face
->box
!= FACE_NO_BOX
)
22288 int thick
= face
->box_line_width
;
22292 it
->ascent
+= thick
;
22293 it
->descent
+= thick
;
22298 if (it
->start_of_box_run_p
)
22299 it
->pixel_width
+= thick
;
22300 if (it
->end_of_box_run_p
)
22301 it
->pixel_width
+= thick
;
22304 /* If face has an overline, add the height of the overline
22305 (1 pixel) and a 1 pixel margin to the character height. */
22306 if (face
->overline_p
)
22307 it
->ascent
+= overline_margin
;
22309 take_vertical_position_into_account (it
);
22311 if (it
->ascent
< 0)
22313 if (it
->descent
< 0)
22318 if (it
->pixel_width
== 0)
22319 /* We assure that all visible glyphs have at least 1-pixel
22321 it
->pixel_width
= 1;
22323 it
->multibyte_p
= saved_multibyte_p
;
22325 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22327 /* A static composition.
22329 Note: A composition is represented as one glyph in the
22330 glyph matrix. There are no padding glyphs.
22332 Important note: pixel_width, ascent, and descent are the
22333 values of what is drawn by draw_glyphs (i.e. the values of
22334 the overall glyphs composed). */
22335 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22336 int boff
; /* baseline offset */
22337 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22338 int glyph_len
= cmp
->glyph_len
;
22339 struct font
*font
= face
->font
;
22343 /* If we have not yet calculated pixel size data of glyphs of
22344 the composition for the current face font, calculate them
22345 now. Theoretically, we have to check all fonts for the
22346 glyphs, but that requires much time and memory space. So,
22347 here we check only the font of the first glyph. This may
22348 lead to incorrect display, but it's very rare, and C-l
22349 (recenter-top-bottom) can correct the display anyway. */
22350 if (! cmp
->font
|| cmp
->font
!= font
)
22352 /* Ascent and descent of the font of the first character
22353 of this composition (adjusted by baseline offset).
22354 Ascent and descent of overall glyphs should not be less
22355 than these, respectively. */
22356 int font_ascent
, font_descent
, font_height
;
22357 /* Bounding box of the overall glyphs. */
22358 int leftmost
, rightmost
, lowest
, highest
;
22359 int lbearing
, rbearing
;
22360 int i
, width
, ascent
, descent
;
22361 int left_padded
= 0, right_padded
= 0;
22364 struct font_metrics
*pcm
;
22365 int font_not_found_p
;
22368 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22369 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22371 if (glyph_len
< cmp
->glyph_len
)
22373 for (i
= 0; i
< glyph_len
; i
++)
22375 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22377 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22382 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22383 : IT_CHARPOS (*it
));
22384 /* If no suitable font is found, use the default font. */
22385 font_not_found_p
= font
== NULL
;
22386 if (font_not_found_p
)
22388 face
= face
->ascii_face
;
22391 boff
= font
->baseline_offset
;
22392 if (font
->vertical_centering
)
22393 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22394 font_ascent
= FONT_BASE (font
) + boff
;
22395 font_descent
= FONT_DESCENT (font
) - boff
;
22396 font_height
= FONT_HEIGHT (font
);
22398 cmp
->font
= (void *) font
;
22401 if (! font_not_found_p
)
22403 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22404 &char2b
, it
->multibyte_p
, 0);
22405 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22408 /* Initialize the bounding box. */
22411 width
= pcm
->width
;
22412 ascent
= pcm
->ascent
;
22413 descent
= pcm
->descent
;
22414 lbearing
= pcm
->lbearing
;
22415 rbearing
= pcm
->rbearing
;
22419 width
= FONT_WIDTH (font
);
22420 ascent
= FONT_BASE (font
);
22421 descent
= FONT_DESCENT (font
);
22428 lowest
= - descent
+ boff
;
22429 highest
= ascent
+ boff
;
22431 if (! font_not_found_p
22432 && font
->default_ascent
22433 && CHAR_TABLE_P (Vuse_default_ascent
)
22434 && !NILP (Faref (Vuse_default_ascent
,
22435 make_number (it
->char_to_display
))))
22436 highest
= font
->default_ascent
+ boff
;
22438 /* Draw the first glyph at the normal position. It may be
22439 shifted to right later if some other glyphs are drawn
22441 cmp
->offsets
[i
* 2] = 0;
22442 cmp
->offsets
[i
* 2 + 1] = boff
;
22443 cmp
->lbearing
= lbearing
;
22444 cmp
->rbearing
= rbearing
;
22446 /* Set cmp->offsets for the remaining glyphs. */
22447 for (i
++; i
< glyph_len
; i
++)
22449 int left
, right
, btm
, top
;
22450 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22452 struct face
*this_face
;
22457 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22458 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22459 font
= this_face
->font
;
22465 this_boff
= font
->baseline_offset
;
22466 if (font
->vertical_centering
)
22467 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22468 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22469 &char2b
, it
->multibyte_p
, 0);
22470 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22473 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22476 width
= pcm
->width
;
22477 ascent
= pcm
->ascent
;
22478 descent
= pcm
->descent
;
22479 lbearing
= pcm
->lbearing
;
22480 rbearing
= pcm
->rbearing
;
22481 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22483 /* Relative composition with or without
22484 alternate chars. */
22485 left
= (leftmost
+ rightmost
- width
) / 2;
22486 btm
= - descent
+ boff
;
22487 if (font
->relative_compose
22488 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22489 || NILP (Faref (Vignore_relative_composition
,
22490 make_number (ch
)))))
22493 if (- descent
>= font
->relative_compose
)
22494 /* One extra pixel between two glyphs. */
22496 else if (ascent
<= 0)
22497 /* One extra pixel between two glyphs. */
22498 btm
= lowest
- 1 - ascent
- descent
;
22503 /* A composition rule is specified by an integer
22504 value that encodes global and new reference
22505 points (GREF and NREF). GREF and NREF are
22506 specified by numbers as below:
22508 0---1---2 -- ascent
22512 9--10--11 -- center
22514 ---3---4---5--- baseline
22516 6---7---8 -- descent
22518 int rule
= COMPOSITION_RULE (cmp
, i
);
22519 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
22521 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
22522 grefx
= gref
% 3, nrefx
= nref
% 3;
22523 grefy
= gref
/ 3, nrefy
= nref
/ 3;
22525 xoff
= font_height
* (xoff
- 128) / 256;
22527 yoff
= font_height
* (yoff
- 128) / 256;
22530 + grefx
* (rightmost
- leftmost
) / 2
22531 - nrefx
* width
/ 2
22534 btm
= ((grefy
== 0 ? highest
22536 : grefy
== 2 ? lowest
22537 : (highest
+ lowest
) / 2)
22538 - (nrefy
== 0 ? ascent
+ descent
22539 : nrefy
== 1 ? descent
- boff
22541 : (ascent
+ descent
) / 2)
22545 cmp
->offsets
[i
* 2] = left
;
22546 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
22548 /* Update the bounding box of the overall glyphs. */
22551 right
= left
+ width
;
22552 if (left
< leftmost
)
22554 if (right
> rightmost
)
22557 top
= btm
+ descent
+ ascent
;
22563 if (cmp
->lbearing
> left
+ lbearing
)
22564 cmp
->lbearing
= left
+ lbearing
;
22565 if (cmp
->rbearing
< left
+ rbearing
)
22566 cmp
->rbearing
= left
+ rbearing
;
22570 /* If there are glyphs whose x-offsets are negative,
22571 shift all glyphs to the right and make all x-offsets
22575 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22576 cmp
->offsets
[i
* 2] -= leftmost
;
22577 rightmost
-= leftmost
;
22578 cmp
->lbearing
-= leftmost
;
22579 cmp
->rbearing
-= leftmost
;
22582 if (left_padded
&& cmp
->lbearing
< 0)
22584 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22585 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
22586 rightmost
-= cmp
->lbearing
;
22587 cmp
->rbearing
-= cmp
->lbearing
;
22590 if (right_padded
&& rightmost
< cmp
->rbearing
)
22592 rightmost
= cmp
->rbearing
;
22595 cmp
->pixel_width
= rightmost
;
22596 cmp
->ascent
= highest
;
22597 cmp
->descent
= - lowest
;
22598 if (cmp
->ascent
< font_ascent
)
22599 cmp
->ascent
= font_ascent
;
22600 if (cmp
->descent
< font_descent
)
22601 cmp
->descent
= font_descent
;
22605 && (cmp
->lbearing
< 0
22606 || cmp
->rbearing
> cmp
->pixel_width
))
22607 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22609 it
->pixel_width
= cmp
->pixel_width
;
22610 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
22611 it
->descent
= it
->phys_descent
= cmp
->descent
;
22612 if (face
->box
!= FACE_NO_BOX
)
22614 int thick
= face
->box_line_width
;
22618 it
->ascent
+= thick
;
22619 it
->descent
+= thick
;
22624 if (it
->start_of_box_run_p
)
22625 it
->pixel_width
+= thick
;
22626 if (it
->end_of_box_run_p
)
22627 it
->pixel_width
+= thick
;
22630 /* If face has an overline, add the height of the overline
22631 (1 pixel) and a 1 pixel margin to the character height. */
22632 if (face
->overline_p
)
22633 it
->ascent
+= overline_margin
;
22635 take_vertical_position_into_account (it
);
22636 if (it
->ascent
< 0)
22638 if (it
->descent
< 0)
22642 append_composite_glyph (it
);
22644 else if (it
->what
== IT_COMPOSITION
)
22646 /* A dynamic (automatic) composition. */
22647 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22648 Lisp_Object gstring
;
22649 struct font_metrics metrics
;
22651 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
22653 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
22656 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
22657 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22658 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
22659 it
->descent
= it
->phys_descent
= metrics
.descent
;
22660 if (face
->box
!= FACE_NO_BOX
)
22662 int thick
= face
->box_line_width
;
22666 it
->ascent
+= thick
;
22667 it
->descent
+= thick
;
22672 if (it
->start_of_box_run_p
)
22673 it
->pixel_width
+= thick
;
22674 if (it
->end_of_box_run_p
)
22675 it
->pixel_width
+= thick
;
22677 /* If face has an overline, add the height of the overline
22678 (1 pixel) and a 1 pixel margin to the character height. */
22679 if (face
->overline_p
)
22680 it
->ascent
+= overline_margin
;
22681 take_vertical_position_into_account (it
);
22682 if (it
->ascent
< 0)
22684 if (it
->descent
< 0)
22688 append_composite_glyph (it
);
22690 else if (it
->what
== IT_IMAGE
)
22691 produce_image_glyph (it
);
22692 else if (it
->what
== IT_STRETCH
)
22693 produce_stretch_glyph (it
);
22695 /* Accumulate dimensions. Note: can't assume that it->descent > 0
22696 because this isn't true for images with `:ascent 100'. */
22697 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
22698 if (it
->area
== TEXT_AREA
)
22699 it
->current_x
+= it
->pixel_width
;
22701 if (extra_line_spacing
> 0)
22703 it
->descent
+= extra_line_spacing
;
22704 if (extra_line_spacing
> it
->max_extra_line_spacing
)
22705 it
->max_extra_line_spacing
= extra_line_spacing
;
22708 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
22709 it
->max_descent
= max (it
->max_descent
, it
->descent
);
22710 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
22711 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
22715 Output LEN glyphs starting at START at the nominal cursor position.
22716 Advance the nominal cursor over the text. The global variable
22717 updated_window contains the window being updated, updated_row is
22718 the glyph row being updated, and updated_area is the area of that
22719 row being updated. */
22722 x_write_glyphs (start
, len
)
22723 struct glyph
*start
;
22728 xassert (updated_window
&& updated_row
);
22731 /* Write glyphs. */
22733 hpos
= start
- updated_row
->glyphs
[updated_area
];
22734 x
= draw_glyphs (updated_window
, output_cursor
.x
,
22735 updated_row
, updated_area
,
22737 DRAW_NORMAL_TEXT
, 0);
22739 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
22740 if (updated_area
== TEXT_AREA
22741 && updated_window
->phys_cursor_on_p
22742 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
22743 && updated_window
->phys_cursor
.hpos
>= hpos
22744 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
22745 updated_window
->phys_cursor_on_p
= 0;
22749 /* Advance the output cursor. */
22750 output_cursor
.hpos
+= len
;
22751 output_cursor
.x
= x
;
22756 Insert LEN glyphs from START at the nominal cursor position. */
22759 x_insert_glyphs (start
, len
)
22760 struct glyph
*start
;
22765 int line_height
, shift_by_width
, shifted_region_width
;
22766 struct glyph_row
*row
;
22767 struct glyph
*glyph
;
22768 int frame_x
, frame_y
;
22771 xassert (updated_window
&& updated_row
);
22773 w
= updated_window
;
22774 f
= XFRAME (WINDOW_FRAME (w
));
22776 /* Get the height of the line we are in. */
22778 line_height
= row
->height
;
22780 /* Get the width of the glyphs to insert. */
22781 shift_by_width
= 0;
22782 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
22783 shift_by_width
+= glyph
->pixel_width
;
22785 /* Get the width of the region to shift right. */
22786 shifted_region_width
= (window_box_width (w
, updated_area
)
22791 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
22792 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
22794 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
22795 line_height
, shift_by_width
);
22797 /* Write the glyphs. */
22798 hpos
= start
- row
->glyphs
[updated_area
];
22799 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
22801 DRAW_NORMAL_TEXT
, 0);
22803 /* Advance the output cursor. */
22804 output_cursor
.hpos
+= len
;
22805 output_cursor
.x
+= shift_by_width
;
22811 Erase the current text line from the nominal cursor position
22812 (inclusive) to pixel column TO_X (exclusive). The idea is that
22813 everything from TO_X onward is already erased.
22815 TO_X is a pixel position relative to updated_area of
22816 updated_window. TO_X == -1 means clear to the end of this area. */
22819 x_clear_end_of_line (to_x
)
22823 struct window
*w
= updated_window
;
22824 int max_x
, min_y
, max_y
;
22825 int from_x
, from_y
, to_y
;
22827 xassert (updated_window
&& updated_row
);
22828 f
= XFRAME (w
->frame
);
22830 if (updated_row
->full_width_p
)
22831 max_x
= WINDOW_TOTAL_WIDTH (w
);
22833 max_x
= window_box_width (w
, updated_area
);
22834 max_y
= window_text_bottom_y (w
);
22836 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
22837 of window. For TO_X > 0, truncate to end of drawing area. */
22843 to_x
= min (to_x
, max_x
);
22845 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
22847 /* Notice if the cursor will be cleared by this operation. */
22848 if (!updated_row
->full_width_p
)
22849 notice_overwritten_cursor (w
, updated_area
,
22850 output_cursor
.x
, -1,
22852 MATRIX_ROW_BOTTOM_Y (updated_row
));
22854 from_x
= output_cursor
.x
;
22856 /* Translate to frame coordinates. */
22857 if (updated_row
->full_width_p
)
22859 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
22860 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
22864 int area_left
= window_box_left (w
, updated_area
);
22865 from_x
+= area_left
;
22869 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
22870 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
22871 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
22873 /* Prevent inadvertently clearing to end of the X window. */
22874 if (to_x
> from_x
&& to_y
> from_y
)
22877 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
22878 to_x
- from_x
, to_y
- from_y
);
22883 #endif /* HAVE_WINDOW_SYSTEM */
22887 /***********************************************************************
22889 ***********************************************************************/
22891 /* Value is the internal representation of the specified cursor type
22892 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
22893 of the bar cursor. */
22895 static enum text_cursor_kinds
22896 get_specified_cursor_type (arg
, width
)
22900 enum text_cursor_kinds type
;
22905 if (EQ (arg
, Qbox
))
22906 return FILLED_BOX_CURSOR
;
22908 if (EQ (arg
, Qhollow
))
22909 return HOLLOW_BOX_CURSOR
;
22911 if (EQ (arg
, Qbar
))
22918 && EQ (XCAR (arg
), Qbar
)
22919 && INTEGERP (XCDR (arg
))
22920 && XINT (XCDR (arg
)) >= 0)
22922 *width
= XINT (XCDR (arg
));
22926 if (EQ (arg
, Qhbar
))
22929 return HBAR_CURSOR
;
22933 && EQ (XCAR (arg
), Qhbar
)
22934 && INTEGERP (XCDR (arg
))
22935 && XINT (XCDR (arg
)) >= 0)
22937 *width
= XINT (XCDR (arg
));
22938 return HBAR_CURSOR
;
22941 /* Treat anything unknown as "hollow box cursor".
22942 It was bad to signal an error; people have trouble fixing
22943 .Xdefaults with Emacs, when it has something bad in it. */
22944 type
= HOLLOW_BOX_CURSOR
;
22949 /* Set the default cursor types for specified frame. */
22951 set_frame_cursor_types (f
, arg
)
22958 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
22959 FRAME_CURSOR_WIDTH (f
) = width
;
22961 /* By default, set up the blink-off state depending on the on-state. */
22963 tem
= Fassoc (arg
, Vblink_cursor_alist
);
22966 FRAME_BLINK_OFF_CURSOR (f
)
22967 = get_specified_cursor_type (XCDR (tem
), &width
);
22968 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
22971 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
22975 /* Return the cursor we want to be displayed in window W. Return
22976 width of bar/hbar cursor through WIDTH arg. Return with
22977 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
22978 (i.e. if the `system caret' should track this cursor).
22980 In a mini-buffer window, we want the cursor only to appear if we
22981 are reading input from this window. For the selected window, we
22982 want the cursor type given by the frame parameter or buffer local
22983 setting of cursor-type. If explicitly marked off, draw no cursor.
22984 In all other cases, we want a hollow box cursor. */
22986 static enum text_cursor_kinds
22987 get_window_cursor_type (w
, glyph
, width
, active_cursor
)
22989 struct glyph
*glyph
;
22991 int *active_cursor
;
22993 struct frame
*f
= XFRAME (w
->frame
);
22994 struct buffer
*b
= XBUFFER (w
->buffer
);
22995 int cursor_type
= DEFAULT_CURSOR
;
22996 Lisp_Object alt_cursor
;
22997 int non_selected
= 0;
22999 *active_cursor
= 1;
23002 if (cursor_in_echo_area
23003 && FRAME_HAS_MINIBUF_P (f
)
23004 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23006 if (w
== XWINDOW (echo_area_window
))
23008 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
23010 *width
= FRAME_CURSOR_WIDTH (f
);
23011 return FRAME_DESIRED_CURSOR (f
);
23014 return get_specified_cursor_type (b
->cursor_type
, width
);
23017 *active_cursor
= 0;
23021 /* Detect a nonselected window or nonselected frame. */
23022 else if (w
!= XWINDOW (f
->selected_window
)
23023 #ifdef HAVE_WINDOW_SYSTEM
23024 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
23028 *active_cursor
= 0;
23030 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23036 /* Never display a cursor in a window in which cursor-type is nil. */
23037 if (NILP (b
->cursor_type
))
23040 /* Get the normal cursor type for this window. */
23041 if (EQ (b
->cursor_type
, Qt
))
23043 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23044 *width
= FRAME_CURSOR_WIDTH (f
);
23047 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
23049 /* Use cursor-in-non-selected-windows instead
23050 for non-selected window or frame. */
23053 alt_cursor
= b
->cursor_in_non_selected_windows
;
23054 if (!EQ (Qt
, alt_cursor
))
23055 return get_specified_cursor_type (alt_cursor
, width
);
23056 /* t means modify the normal cursor type. */
23057 if (cursor_type
== FILLED_BOX_CURSOR
)
23058 cursor_type
= HOLLOW_BOX_CURSOR
;
23059 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23061 return cursor_type
;
23064 /* Use normal cursor if not blinked off. */
23065 if (!w
->cursor_off_p
)
23067 #ifdef HAVE_WINDOW_SYSTEM
23068 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23070 if (cursor_type
== FILLED_BOX_CURSOR
)
23072 /* Using a block cursor on large images can be very annoying.
23073 So use a hollow cursor for "large" images.
23074 If image is not transparent (no mask), also use hollow cursor. */
23075 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23076 if (img
!= NULL
&& IMAGEP (img
->spec
))
23078 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23079 where N = size of default frame font size.
23080 This should cover most of the "tiny" icons people may use. */
23082 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23083 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23084 cursor_type
= HOLLOW_BOX_CURSOR
;
23087 else if (cursor_type
!= NO_CURSOR
)
23089 /* Display current only supports BOX and HOLLOW cursors for images.
23090 So for now, unconditionally use a HOLLOW cursor when cursor is
23091 not a solid box cursor. */
23092 cursor_type
= HOLLOW_BOX_CURSOR
;
23096 return cursor_type
;
23099 /* Cursor is blinked off, so determine how to "toggle" it. */
23101 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23102 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
23103 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23105 /* Then see if frame has specified a specific blink off cursor type. */
23106 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23108 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23109 return FRAME_BLINK_OFF_CURSOR (f
);
23113 /* Some people liked having a permanently visible blinking cursor,
23114 while others had very strong opinions against it. So it was
23115 decided to remove it. KFS 2003-09-03 */
23117 /* Finally perform built-in cursor blinking:
23118 filled box <-> hollow box
23119 wide [h]bar <-> narrow [h]bar
23120 narrow [h]bar <-> no cursor
23121 other type <-> no cursor */
23123 if (cursor_type
== FILLED_BOX_CURSOR
)
23124 return HOLLOW_BOX_CURSOR
;
23126 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23129 return cursor_type
;
23137 #ifdef HAVE_WINDOW_SYSTEM
23139 /* Notice when the text cursor of window W has been completely
23140 overwritten by a drawing operation that outputs glyphs in AREA
23141 starting at X0 and ending at X1 in the line starting at Y0 and
23142 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23143 the rest of the line after X0 has been written. Y coordinates
23144 are window-relative. */
23147 notice_overwritten_cursor (w
, area
, x0
, x1
, y0
, y1
)
23149 enum glyph_row_area area
;
23150 int x0
, y0
, x1
, y1
;
23152 int cx0
, cx1
, cy0
, cy1
;
23153 struct glyph_row
*row
;
23155 if (!w
->phys_cursor_on_p
)
23157 if (area
!= TEXT_AREA
)
23160 if (w
->phys_cursor
.vpos
< 0
23161 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23162 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23163 !(row
->enabled_p
&& row
->displays_text_p
)))
23166 if (row
->cursor_in_fringe_p
)
23168 row
->cursor_in_fringe_p
= 0;
23169 draw_fringe_bitmap (w
, row
, 0);
23170 w
->phys_cursor_on_p
= 0;
23174 cx0
= w
->phys_cursor
.x
;
23175 cx1
= cx0
+ w
->phys_cursor_width
;
23176 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23179 /* The cursor image will be completely removed from the
23180 screen if the output area intersects the cursor area in
23181 y-direction. When we draw in [y0 y1[, and some part of
23182 the cursor is at y < y0, that part must have been drawn
23183 before. When scrolling, the cursor is erased before
23184 actually scrolling, so we don't come here. When not
23185 scrolling, the rows above the old cursor row must have
23186 changed, and in this case these rows must have written
23187 over the cursor image.
23189 Likewise if part of the cursor is below y1, with the
23190 exception of the cursor being in the first blank row at
23191 the buffer and window end because update_text_area
23192 doesn't draw that row. (Except when it does, but
23193 that's handled in update_text_area.) */
23195 cy0
= w
->phys_cursor
.y
;
23196 cy1
= cy0
+ w
->phys_cursor_height
;
23197 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23200 w
->phys_cursor_on_p
= 0;
23203 #endif /* HAVE_WINDOW_SYSTEM */
23206 /************************************************************************
23208 ************************************************************************/
23210 #ifdef HAVE_WINDOW_SYSTEM
23213 Fix the display of area AREA of overlapping row ROW in window W
23214 with respect to the overlapping part OVERLAPS. */
23217 x_fix_overlapping_area (w
, row
, area
, overlaps
)
23219 struct glyph_row
*row
;
23220 enum glyph_row_area area
;
23228 for (i
= 0; i
< row
->used
[area
];)
23230 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23232 int start
= i
, start_x
= x
;
23236 x
+= row
->glyphs
[area
][i
].pixel_width
;
23239 while (i
< row
->used
[area
]
23240 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23242 draw_glyphs (w
, start_x
, row
, area
,
23244 DRAW_NORMAL_TEXT
, overlaps
);
23248 x
+= row
->glyphs
[area
][i
].pixel_width
;
23258 Draw the cursor glyph of window W in glyph row ROW. See the
23259 comment of draw_glyphs for the meaning of HL. */
23262 draw_phys_cursor_glyph (w
, row
, hl
)
23264 struct glyph_row
*row
;
23265 enum draw_glyphs_face hl
;
23267 /* If cursor hpos is out of bounds, don't draw garbage. This can
23268 happen in mini-buffer windows when switching between echo area
23269 glyphs and mini-buffer. */
23270 if (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])
23272 int on_p
= w
->phys_cursor_on_p
;
23274 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23275 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23277 w
->phys_cursor_on_p
= on_p
;
23279 if (hl
== DRAW_CURSOR
)
23280 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23281 /* When we erase the cursor, and ROW is overlapped by other
23282 rows, make sure that these overlapping parts of other rows
23284 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23286 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23288 if (row
> w
->current_matrix
->rows
23289 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23290 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23291 OVERLAPS_ERASED_CURSOR
);
23293 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23294 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23295 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23296 OVERLAPS_ERASED_CURSOR
);
23303 Erase the image of a cursor of window W from the screen. */
23306 erase_phys_cursor (w
)
23309 struct frame
*f
= XFRAME (w
->frame
);
23310 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23311 int hpos
= w
->phys_cursor
.hpos
;
23312 int vpos
= w
->phys_cursor
.vpos
;
23313 int mouse_face_here_p
= 0;
23314 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23315 struct glyph_row
*cursor_row
;
23316 struct glyph
*cursor_glyph
;
23317 enum draw_glyphs_face hl
;
23319 /* No cursor displayed or row invalidated => nothing to do on the
23321 if (w
->phys_cursor_type
== NO_CURSOR
)
23322 goto mark_cursor_off
;
23324 /* VPOS >= active_glyphs->nrows means that window has been resized.
23325 Don't bother to erase the cursor. */
23326 if (vpos
>= active_glyphs
->nrows
)
23327 goto mark_cursor_off
;
23329 /* If row containing cursor is marked invalid, there is nothing we
23331 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23332 if (!cursor_row
->enabled_p
)
23333 goto mark_cursor_off
;
23335 /* If line spacing is > 0, old cursor may only be partially visible in
23336 window after split-window. So adjust visible height. */
23337 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23338 window_text_bottom_y (w
) - cursor_row
->y
);
23340 /* If row is completely invisible, don't attempt to delete a cursor which
23341 isn't there. This can happen if cursor is at top of a window, and
23342 we switch to a buffer with a header line in that window. */
23343 if (cursor_row
->visible_height
<= 0)
23344 goto mark_cursor_off
;
23346 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23347 if (cursor_row
->cursor_in_fringe_p
)
23349 cursor_row
->cursor_in_fringe_p
= 0;
23350 draw_fringe_bitmap (w
, cursor_row
, 0);
23351 goto mark_cursor_off
;
23354 /* This can happen when the new row is shorter than the old one.
23355 In this case, either draw_glyphs or clear_end_of_line
23356 should have cleared the cursor. Note that we wouldn't be
23357 able to erase the cursor in this case because we don't have a
23358 cursor glyph at hand. */
23359 if (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])
23360 goto mark_cursor_off
;
23362 /* If the cursor is in the mouse face area, redisplay that when
23363 we clear the cursor. */
23364 if (! NILP (dpyinfo
->mouse_face_window
)
23365 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
23366 && (vpos
> dpyinfo
->mouse_face_beg_row
23367 || (vpos
== dpyinfo
->mouse_face_beg_row
23368 && hpos
>= dpyinfo
->mouse_face_beg_col
))
23369 && (vpos
< dpyinfo
->mouse_face_end_row
23370 || (vpos
== dpyinfo
->mouse_face_end_row
23371 && hpos
< dpyinfo
->mouse_face_end_col
))
23372 /* Don't redraw the cursor's spot in mouse face if it is at the
23373 end of a line (on a newline). The cursor appears there, but
23374 mouse highlighting does not. */
23375 && cursor_row
->used
[TEXT_AREA
] > hpos
)
23376 mouse_face_here_p
= 1;
23378 /* Maybe clear the display under the cursor. */
23379 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23382 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23385 cursor_glyph
= get_phys_cursor_glyph (w
);
23386 if (cursor_glyph
== NULL
)
23387 goto mark_cursor_off
;
23389 width
= cursor_glyph
->pixel_width
;
23390 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23391 x
= w
->phys_cursor
.x
;
23393 width
-= left_x
- x
;
23394 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23395 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23396 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23399 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23402 /* Erase the cursor by redrawing the character underneath it. */
23403 if (mouse_face_here_p
)
23404 hl
= DRAW_MOUSE_FACE
;
23406 hl
= DRAW_NORMAL_TEXT
;
23407 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23410 w
->phys_cursor_on_p
= 0;
23411 w
->phys_cursor_type
= NO_CURSOR
;
23416 Display or clear cursor of window W. If ON is zero, clear the
23417 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23418 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23421 display_and_set_cursor (w
, on
, hpos
, vpos
, x
, y
)
23423 int on
, hpos
, vpos
, x
, y
;
23425 struct frame
*f
= XFRAME (w
->frame
);
23426 int new_cursor_type
;
23427 int new_cursor_width
;
23429 struct glyph_row
*glyph_row
;
23430 struct glyph
*glyph
;
23432 /* This is pointless on invisible frames, and dangerous on garbaged
23433 windows and frames; in the latter case, the frame or window may
23434 be in the midst of changing its size, and x and y may be off the
23436 if (! FRAME_VISIBLE_P (f
)
23437 || FRAME_GARBAGED_P (f
)
23438 || vpos
>= w
->current_matrix
->nrows
23439 || hpos
>= w
->current_matrix
->matrix_w
)
23442 /* If cursor is off and we want it off, return quickly. */
23443 if (!on
&& !w
->phys_cursor_on_p
)
23446 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23447 /* If cursor row is not enabled, we don't really know where to
23448 display the cursor. */
23449 if (!glyph_row
->enabled_p
)
23451 w
->phys_cursor_on_p
= 0;
23456 if (!glyph_row
->exact_window_width_line_p
23457 || hpos
< glyph_row
->used
[TEXT_AREA
])
23458 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23460 xassert (interrupt_input_blocked
);
23462 /* Set new_cursor_type to the cursor we want to be displayed. */
23463 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23464 &new_cursor_width
, &active_cursor
);
23466 /* If cursor is currently being shown and we don't want it to be or
23467 it is in the wrong place, or the cursor type is not what we want,
23469 if (w
->phys_cursor_on_p
23471 || w
->phys_cursor
.x
!= x
23472 || w
->phys_cursor
.y
!= y
23473 || new_cursor_type
!= w
->phys_cursor_type
23474 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23475 && new_cursor_width
!= w
->phys_cursor_width
)))
23476 erase_phys_cursor (w
);
23478 /* Don't check phys_cursor_on_p here because that flag is only set
23479 to zero in some cases where we know that the cursor has been
23480 completely erased, to avoid the extra work of erasing the cursor
23481 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23482 still not be visible, or it has only been partly erased. */
23485 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23486 w
->phys_cursor_height
= glyph_row
->height
;
23488 /* Set phys_cursor_.* before x_draw_.* is called because some
23489 of them may need the information. */
23490 w
->phys_cursor
.x
= x
;
23491 w
->phys_cursor
.y
= glyph_row
->y
;
23492 w
->phys_cursor
.hpos
= hpos
;
23493 w
->phys_cursor
.vpos
= vpos
;
23496 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23497 new_cursor_type
, new_cursor_width
,
23498 on
, active_cursor
);
23502 /* Switch the display of W's cursor on or off, according to the value
23506 update_window_cursor (w
, on
)
23510 /* Don't update cursor in windows whose frame is in the process
23511 of being deleted. */
23512 if (w
->current_matrix
)
23515 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23516 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23522 /* Call update_window_cursor with parameter ON_P on all leaf windows
23523 in the window tree rooted at W. */
23526 update_cursor_in_window_tree (w
, on_p
)
23532 if (!NILP (w
->hchild
))
23533 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23534 else if (!NILP (w
->vchild
))
23535 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23537 update_window_cursor (w
, on_p
);
23539 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
23545 Display the cursor on window W, or clear it, according to ON_P.
23546 Don't change the cursor's position. */
23549 x_update_cursor (f
, on_p
)
23553 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
23558 Clear the cursor of window W to background color, and mark the
23559 cursor as not shown. This is used when the text where the cursor
23560 is about to be rewritten. */
23566 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
23567 update_window_cursor (w
, 0);
23572 Display the active region described by mouse_face_* according to DRAW. */
23575 show_mouse_face (dpyinfo
, draw
)
23576 Display_Info
*dpyinfo
;
23577 enum draw_glyphs_face draw
;
23579 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
23580 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23582 if (/* If window is in the process of being destroyed, don't bother
23584 w
->current_matrix
!= NULL
23585 /* Don't update mouse highlight if hidden */
23586 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
23587 /* Recognize when we are called to operate on rows that don't exist
23588 anymore. This can happen when a window is split. */
23589 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
23591 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
23592 struct glyph_row
*row
, *first
, *last
;
23594 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
23595 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
23597 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
23599 int start_hpos
, end_hpos
, start_x
;
23601 /* For all but the first row, the highlight starts at column 0. */
23604 start_hpos
= dpyinfo
->mouse_face_beg_col
;
23605 start_x
= dpyinfo
->mouse_face_beg_x
;
23614 end_hpos
= dpyinfo
->mouse_face_end_col
;
23617 end_hpos
= row
->used
[TEXT_AREA
];
23618 if (draw
== DRAW_NORMAL_TEXT
)
23619 row
->fill_line_p
= 1; /* Clear to end of line */
23622 if (end_hpos
> start_hpos
)
23624 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
23625 start_hpos
, end_hpos
,
23629 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
23633 /* When we've written over the cursor, arrange for it to
23634 be displayed again. */
23635 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
23638 display_and_set_cursor (w
, 1,
23639 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23640 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23645 /* Change the mouse cursor. */
23646 if (draw
== DRAW_NORMAL_TEXT
&& !EQ (dpyinfo
->mouse_face_window
, f
->tool_bar_window
))
23647 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
23648 else if (draw
== DRAW_MOUSE_FACE
)
23649 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
23651 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
23655 Clear out the mouse-highlighted active region.
23656 Redraw it un-highlighted first. Value is non-zero if mouse
23657 face was actually drawn unhighlighted. */
23660 clear_mouse_face (dpyinfo
)
23661 Display_Info
*dpyinfo
;
23665 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
23667 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
23671 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
23672 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
23673 dpyinfo
->mouse_face_window
= Qnil
;
23674 dpyinfo
->mouse_face_overlay
= Qnil
;
23680 Non-zero if physical cursor of window W is within mouse face. */
23683 cursor_in_mouse_face_p (w
)
23686 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
23687 int in_mouse_face
= 0;
23689 if (WINDOWP (dpyinfo
->mouse_face_window
)
23690 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
23692 int hpos
= w
->phys_cursor
.hpos
;
23693 int vpos
= w
->phys_cursor
.vpos
;
23695 if (vpos
>= dpyinfo
->mouse_face_beg_row
23696 && vpos
<= dpyinfo
->mouse_face_end_row
23697 && (vpos
> dpyinfo
->mouse_face_beg_row
23698 || hpos
>= dpyinfo
->mouse_face_beg_col
)
23699 && (vpos
< dpyinfo
->mouse_face_end_row
23700 || hpos
< dpyinfo
->mouse_face_end_col
23701 || dpyinfo
->mouse_face_past_end
))
23705 return in_mouse_face
;
23711 /* This function sets the mouse_face_* elements of DPYINFO, assuming
23712 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
23713 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
23714 for the overlay or run of text properties specifying the mouse
23715 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
23716 before-string and after-string that must also be highlighted.
23717 DISPLAY_STRING, if non-nil, is a display string that may cover some
23718 or all of the highlighted text. */
23721 mouse_face_from_buffer_pos (Lisp_Object window
,
23722 Display_Info
*dpyinfo
,
23723 EMACS_INT mouse_charpos
,
23724 EMACS_INT start_charpos
,
23725 EMACS_INT end_charpos
,
23726 Lisp_Object before_string
,
23727 Lisp_Object after_string
,
23728 Lisp_Object display_string
)
23730 struct window
*w
= XWINDOW (window
);
23731 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23732 struct glyph_row
*row
;
23733 struct glyph
*glyph
, *end
;
23737 xassert (NILP (display_string
) || STRINGP (display_string
));
23738 xassert (NILP (before_string
) || STRINGP (before_string
));
23739 xassert (NILP (after_string
) || STRINGP (after_string
));
23741 /* Find the first highlighted glyph. */
23742 if (start_charpos
< MATRIX_ROW_START_CHARPOS (first
))
23744 dpyinfo
->mouse_face_beg_col
= 0;
23745 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
23746 dpyinfo
->mouse_face_beg_x
= first
->x
;
23747 dpyinfo
->mouse_face_beg_y
= first
->y
;
23751 row
= row_containing_pos (w
, start_charpos
, first
, NULL
, 0);
23753 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23755 /* If the before-string or display-string contains newlines,
23756 row_containing_pos skips to its last row. Move back. */
23757 if (!NILP (before_string
) || !NILP (display_string
))
23759 struct glyph_row
*prev
;
23760 while ((prev
= row
- 1, prev
>= first
)
23761 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
23762 && prev
->used
[TEXT_AREA
] > 0)
23764 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
23765 glyph
= beg
+ prev
->used
[TEXT_AREA
];
23766 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
23768 || !(EQ (glyph
->object
, before_string
)
23769 || EQ (glyph
->object
, display_string
)))
23775 glyph
= row
->glyphs
[TEXT_AREA
];
23776 end
= glyph
+ row
->used
[TEXT_AREA
];
23778 dpyinfo
->mouse_face_beg_y
= row
->y
;
23779 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
23781 /* Skip truncation glyphs at the start of the glyph row. */
23782 if (row
->displays_text_p
)
23784 && INTEGERP (glyph
->object
)
23785 && glyph
->charpos
< 0;
23787 x
+= glyph
->pixel_width
;
23789 /* Scan the glyph row, stopping before BEFORE_STRING or
23790 DISPLAY_STRING or START_CHARPOS. */
23792 && !INTEGERP (glyph
->object
)
23793 && !EQ (glyph
->object
, before_string
)
23794 && !EQ (glyph
->object
, display_string
)
23795 && !(BUFFERP (glyph
->object
)
23796 && glyph
->charpos
>= start_charpos
);
23798 x
+= glyph
->pixel_width
;
23800 dpyinfo
->mouse_face_beg_x
= x
;
23801 dpyinfo
->mouse_face_beg_col
= glyph
- row
->glyphs
[TEXT_AREA
];
23804 /* Find the last highlighted glyph. */
23805 row
= row_containing_pos (w
, end_charpos
, first
, NULL
, 0);
23808 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23809 dpyinfo
->mouse_face_past_end
= 1;
23811 else if (!NILP (after_string
))
23813 /* If the after-string has newlines, advance to its last row. */
23814 struct glyph_row
*next
;
23815 struct glyph_row
*last
23816 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23818 for (next
= row
+ 1;
23820 && next
->used
[TEXT_AREA
] > 0
23821 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
23826 glyph
= row
->glyphs
[TEXT_AREA
];
23827 end
= glyph
+ row
->used
[TEXT_AREA
];
23829 dpyinfo
->mouse_face_end_y
= row
->y
;
23830 dpyinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
23832 /* Skip truncation glyphs at the start of the row. */
23833 if (row
->displays_text_p
)
23835 && INTEGERP (glyph
->object
)
23836 && glyph
->charpos
< 0;
23838 x
+= glyph
->pixel_width
;
23840 /* Scan the glyph row, stopping at END_CHARPOS or when we encounter
23843 && !INTEGERP (glyph
->object
)
23844 && !EQ (glyph
->object
, after_string
)
23845 && !(BUFFERP (glyph
->object
) && glyph
->charpos
>= end_charpos
);
23847 x
+= glyph
->pixel_width
;
23849 /* If we found AFTER_STRING, consume it and stop. */
23850 if (EQ (glyph
->object
, after_string
))
23852 for (; EQ (glyph
->object
, after_string
) && glyph
< end
; ++glyph
)
23853 x
+= glyph
->pixel_width
;
23857 /* If there's no after-string, we must check if we overshot,
23858 which might be the case if we stopped after a string glyph.
23859 That glyph may belong to a before-string or display-string
23860 associated with the end position, which must not be
23862 Lisp_Object prev_object
;
23865 while (glyph
> row
->glyphs
[TEXT_AREA
])
23867 prev_object
= (glyph
- 1)->object
;
23868 if (!STRINGP (prev_object
) || EQ (prev_object
, display_string
))
23871 pos
= string_buffer_position (w
, prev_object
, end_charpos
);
23872 if (pos
&& pos
< end_charpos
)
23875 for (; glyph
> row
->glyphs
[TEXT_AREA
]
23876 && EQ ((glyph
- 1)->object
, prev_object
);
23878 x
-= (glyph
- 1)->pixel_width
;
23882 dpyinfo
->mouse_face_end_x
= x
;
23883 dpyinfo
->mouse_face_end_col
= glyph
- row
->glyphs
[TEXT_AREA
];
23884 dpyinfo
->mouse_face_window
= window
;
23885 dpyinfo
->mouse_face_face_id
23886 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
23888 !dpyinfo
->mouse_face_hidden
, -1);
23889 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23893 /* Find the position of the glyph for position POS in OBJECT in
23894 window W's current matrix, and return in *X, *Y the pixel
23895 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
23897 RIGHT_P non-zero means return the position of the right edge of the
23898 glyph, RIGHT_P zero means return the left edge position.
23900 If no glyph for POS exists in the matrix, return the position of
23901 the glyph with the next smaller position that is in the matrix, if
23902 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
23903 exists in the matrix, return the position of the glyph with the
23904 next larger position in OBJECT.
23906 Value is non-zero if a glyph was found. */
23909 fast_find_string_pos (w
, pos
, object
, hpos
, vpos
, x
, y
, right_p
)
23912 Lisp_Object object
;
23913 int *hpos
, *vpos
, *x
, *y
;
23916 int yb
= window_text_bottom_y (w
);
23917 struct glyph_row
*r
;
23918 struct glyph
*best_glyph
= NULL
;
23919 struct glyph_row
*best_row
= NULL
;
23922 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23923 r
->enabled_p
&& r
->y
< yb
;
23926 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
23927 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
23930 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
23931 if (EQ (g
->object
, object
))
23933 if (g
->charpos
== pos
)
23940 else if (best_glyph
== NULL
23941 || ((eabs (g
->charpos
- pos
)
23942 < eabs (best_glyph
->charpos
- pos
))
23945 : g
->charpos
> pos
)))
23959 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
23963 *x
+= best_glyph
->pixel_width
;
23968 *vpos
= best_row
- w
->current_matrix
->rows
;
23971 return best_glyph
!= NULL
;
23975 /* See if position X, Y is within a hot-spot of an image. */
23978 on_hot_spot_p (hot_spot
, x
, y
)
23979 Lisp_Object hot_spot
;
23982 if (!CONSP (hot_spot
))
23985 if (EQ (XCAR (hot_spot
), Qrect
))
23987 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
23988 Lisp_Object rect
= XCDR (hot_spot
);
23992 if (!CONSP (XCAR (rect
)))
23994 if (!CONSP (XCDR (rect
)))
23996 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
23998 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24000 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24002 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24006 else if (EQ (XCAR (hot_spot
), Qcircle
))
24008 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24009 Lisp_Object circ
= XCDR (hot_spot
);
24010 Lisp_Object lr
, lx0
, ly0
;
24012 && CONSP (XCAR (circ
))
24013 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24014 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24015 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24017 double r
= XFLOATINT (lr
);
24018 double dx
= XINT (lx0
) - x
;
24019 double dy
= XINT (ly0
) - y
;
24020 return (dx
* dx
+ dy
* dy
<= r
* r
);
24023 else if (EQ (XCAR (hot_spot
), Qpoly
))
24025 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24026 if (VECTORP (XCDR (hot_spot
)))
24028 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24029 Lisp_Object
*poly
= v
->contents
;
24033 Lisp_Object lx
, ly
;
24036 /* Need an even number of coordinates, and at least 3 edges. */
24037 if (n
< 6 || n
& 1)
24040 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24041 If count is odd, we are inside polygon. Pixels on edges
24042 may or may not be included depending on actual geometry of the
24044 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24045 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24047 x0
= XINT (lx
), y0
= XINT (ly
);
24048 for (i
= 0; i
< n
; i
+= 2)
24050 int x1
= x0
, y1
= y0
;
24051 if ((lx
= poly
[i
], !INTEGERP (lx
))
24052 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24054 x0
= XINT (lx
), y0
= XINT (ly
);
24056 /* Does this segment cross the X line? */
24064 if (y
> y0
&& y
> y1
)
24066 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24076 find_hot_spot (map
, x
, y
)
24080 while (CONSP (map
))
24082 if (CONSP (XCAR (map
))
24083 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
24091 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
24093 doc
: /* Lookup in image map MAP coordinates X and Y.
24094 An image map is an alist where each element has the format (AREA ID PLIST).
24095 An AREA is specified as either a rectangle, a circle, or a polygon:
24096 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
24097 pixel coordinates of the upper left and bottom right corners.
24098 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
24099 and the radius of the circle; r may be a float or integer.
24100 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
24101 vector describes one corner in the polygon.
24102 Returns the alist element for the first matching AREA in MAP. */)
24113 return find_hot_spot (map
, XINT (x
), XINT (y
));
24117 /* Display frame CURSOR, optionally using shape defined by POINTER. */
24119 define_frame_cursor1 (f
, cursor
, pointer
)
24122 Lisp_Object pointer
;
24124 /* Do not change cursor shape while dragging mouse. */
24125 if (!NILP (do_mouse_tracking
))
24128 if (!NILP (pointer
))
24130 if (EQ (pointer
, Qarrow
))
24131 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24132 else if (EQ (pointer
, Qhand
))
24133 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
24134 else if (EQ (pointer
, Qtext
))
24135 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24136 else if (EQ (pointer
, intern ("hdrag")))
24137 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24138 #ifdef HAVE_X_WINDOWS
24139 else if (EQ (pointer
, intern ("vdrag")))
24140 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
24142 else if (EQ (pointer
, intern ("hourglass")))
24143 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
24144 else if (EQ (pointer
, Qmodeline
))
24145 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
24147 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24150 if (cursor
!= No_Cursor
)
24151 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
24154 /* Take proper action when mouse has moved to the mode or header line
24155 or marginal area AREA of window W, x-position X and y-position Y.
24156 X is relative to the start of the text display area of W, so the
24157 width of bitmap areas and scroll bars must be subtracted to get a
24158 position relative to the start of the mode line. */
24161 note_mode_line_or_margin_highlight (window
, x
, y
, area
)
24162 Lisp_Object window
;
24164 enum window_part area
;
24166 struct window
*w
= XWINDOW (window
);
24167 struct frame
*f
= XFRAME (w
->frame
);
24168 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24169 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24170 Lisp_Object pointer
= Qnil
;
24171 int charpos
, dx
, dy
, width
, height
;
24172 Lisp_Object string
, object
= Qnil
;
24173 Lisp_Object pos
, help
;
24175 Lisp_Object mouse_face
;
24176 int original_x_pixel
= x
;
24177 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
24178 struct glyph_row
*row
;
24180 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
24185 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
24186 &object
, &dx
, &dy
, &width
, &height
);
24188 row
= (area
== ON_MODE_LINE
24189 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
24190 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
24193 if (row
->mode_line_p
&& row
->enabled_p
)
24195 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
24196 end
= glyph
+ row
->used
[TEXT_AREA
];
24198 for (x0
= original_x_pixel
;
24199 glyph
< end
&& x0
>= glyph
->pixel_width
;
24201 x0
-= glyph
->pixel_width
;
24209 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
24210 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
24211 &object
, &dx
, &dy
, &width
, &height
);
24216 if (IMAGEP (object
))
24218 Lisp_Object image_map
, hotspot
;
24219 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
24221 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
24223 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24225 Lisp_Object area_id
, plist
;
24227 area_id
= XCAR (hotspot
);
24228 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24229 If so, we could look for mouse-enter, mouse-leave
24230 properties in PLIST (and do something...). */
24231 hotspot
= XCDR (hotspot
);
24232 if (CONSP (hotspot
)
24233 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24235 pointer
= Fplist_get (plist
, Qpointer
);
24236 if (NILP (pointer
))
24238 help
= Fplist_get (plist
, Qhelp_echo
);
24241 help_echo_string
= help
;
24242 /* Is this correct? ++kfs */
24243 XSETWINDOW (help_echo_window
, w
);
24244 help_echo_object
= w
->buffer
;
24245 help_echo_pos
= charpos
;
24249 if (NILP (pointer
))
24250 pointer
= Fplist_get (XCDR (object
), QCpointer
);
24253 if (STRINGP (string
))
24255 pos
= make_number (charpos
);
24256 /* If we're on a string with `help-echo' text property, arrange
24257 for the help to be displayed. This is done by setting the
24258 global variable help_echo_string to the help string. */
24261 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
24264 help_echo_string
= help
;
24265 XSETWINDOW (help_echo_window
, w
);
24266 help_echo_object
= string
;
24267 help_echo_pos
= charpos
;
24271 if (NILP (pointer
))
24272 pointer
= Fget_text_property (pos
, Qpointer
, string
);
24274 /* Change the mouse pointer according to what is under X/Y. */
24275 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
24278 map
= Fget_text_property (pos
, Qlocal_map
, string
);
24279 if (!KEYMAPP (map
))
24280 map
= Fget_text_property (pos
, Qkeymap
, string
);
24281 if (!KEYMAPP (map
))
24282 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
24285 /* Change the mouse face according to what is under X/Y. */
24286 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
24287 if (!NILP (mouse_face
)
24288 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
24293 struct glyph
* tmp_glyph
;
24297 int total_pixel_width
;
24302 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
24303 Qmouse_face
, string
, Qnil
);
24305 b
= make_number (0);
24307 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
24309 e
= make_number (SCHARS (string
));
24311 /* Calculate the position(glyph position: GPOS) of GLYPH in
24312 displayed string. GPOS is different from CHARPOS.
24314 CHARPOS is the position of glyph in internal string
24315 object. A mode line string format has structures which
24316 is converted to a flatten by emacs lisp interpreter.
24317 The internal string is an element of the structures.
24318 The displayed string is the flatten string. */
24320 if (glyph
> row_start_glyph
)
24322 tmp_glyph
= glyph
- 1;
24323 while (tmp_glyph
>= row_start_glyph
24324 && tmp_glyph
->charpos
>= XINT (b
)
24325 && EQ (tmp_glyph
->object
, glyph
->object
))
24332 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
24333 displayed string holding GLYPH.
24335 GSEQ_LENGTH is different from SCHARS (STRING).
24336 SCHARS (STRING) returns the length of the internal string. */
24337 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
24338 tmp_glyph
->charpos
< XINT (e
);
24339 tmp_glyph
++, gseq_length
++)
24341 if (!EQ (tmp_glyph
->object
, glyph
->object
))
24345 total_pixel_width
= 0;
24346 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
24347 total_pixel_width
+= tmp_glyph
->pixel_width
;
24349 /* Pre calculation of re-rendering position */
24351 hpos
= (area
== ON_MODE_LINE
24352 ? (w
->current_matrix
)->nrows
- 1
24355 /* If the re-rendering position is included in the last
24356 re-rendering area, we should do nothing. */
24357 if ( EQ (window
, dpyinfo
->mouse_face_window
)
24358 && dpyinfo
->mouse_face_beg_col
<= vpos
24359 && vpos
< dpyinfo
->mouse_face_end_col
24360 && dpyinfo
->mouse_face_beg_row
== hpos
)
24363 if (clear_mouse_face (dpyinfo
))
24364 cursor
= No_Cursor
;
24366 dpyinfo
->mouse_face_beg_col
= vpos
;
24367 dpyinfo
->mouse_face_beg_row
= hpos
;
24369 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
24370 dpyinfo
->mouse_face_beg_y
= 0;
24372 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
24373 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
24375 dpyinfo
->mouse_face_end_x
= 0;
24376 dpyinfo
->mouse_face_end_y
= 0;
24378 dpyinfo
->mouse_face_past_end
= 0;
24379 dpyinfo
->mouse_face_window
= window
;
24381 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
24384 glyph
->face_id
, 1);
24385 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24387 if (NILP (pointer
))
24390 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
24391 clear_mouse_face (dpyinfo
);
24393 define_frame_cursor1 (f
, cursor
, pointer
);
24398 Take proper action when the mouse has moved to position X, Y on
24399 frame F as regards highlighting characters that have mouse-face
24400 properties. Also de-highlighting chars where the mouse was before.
24401 X and Y can be negative or out of range. */
24404 note_mouse_highlight (f
, x
, y
)
24408 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24409 enum window_part part
;
24410 Lisp_Object window
;
24412 Cursor cursor
= No_Cursor
;
24413 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
24416 /* When a menu is active, don't highlight because this looks odd. */
24417 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
24418 if (popup_activated ())
24422 if (NILP (Vmouse_highlight
)
24423 || !f
->glyphs_initialized_p
24424 || f
->pointer_invisible
)
24427 dpyinfo
->mouse_face_mouse_x
= x
;
24428 dpyinfo
->mouse_face_mouse_y
= y
;
24429 dpyinfo
->mouse_face_mouse_frame
= f
;
24431 if (dpyinfo
->mouse_face_defer
)
24434 if (gc_in_progress
)
24436 dpyinfo
->mouse_face_deferred_gc
= 1;
24440 /* Which window is that in? */
24441 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
24443 /* If we were displaying active text in another window, clear that.
24444 Also clear if we move out of text area in same window. */
24445 if (! EQ (window
, dpyinfo
->mouse_face_window
)
24446 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
24447 && !NILP (dpyinfo
->mouse_face_window
)))
24448 clear_mouse_face (dpyinfo
);
24450 /* Not on a window -> return. */
24451 if (!WINDOWP (window
))
24454 /* Reset help_echo_string. It will get recomputed below. */
24455 help_echo_string
= Qnil
;
24457 /* Convert to window-relative pixel coordinates. */
24458 w
= XWINDOW (window
);
24459 frame_to_window_pixel_xy (w
, &x
, &y
);
24461 /* Handle tool-bar window differently since it doesn't display a
24463 if (EQ (window
, f
->tool_bar_window
))
24465 note_tool_bar_highlight (f
, x
, y
);
24469 /* Mouse is on the mode, header line or margin? */
24470 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
24471 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
24473 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
24477 if (part
== ON_VERTICAL_BORDER
)
24479 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24480 help_echo_string
= build_string ("drag-mouse-1: resize");
24482 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
24483 || part
== ON_SCROLL_BAR
)
24484 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24486 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24488 /* Are we in a window whose display is up to date?
24489 And verify the buffer's text has not changed. */
24490 b
= XBUFFER (w
->buffer
);
24491 if (part
== ON_TEXT
24492 && EQ (w
->window_end_valid
, w
->buffer
)
24493 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
24494 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
24496 int hpos
, vpos
, i
, dx
, dy
, area
;
24498 struct glyph
*glyph
;
24499 Lisp_Object object
;
24500 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
24501 Lisp_Object
*overlay_vec
= NULL
;
24503 struct buffer
*obuf
;
24504 int obegv
, ozv
, same_region
;
24506 /* Find the glyph under X/Y. */
24507 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
24509 /* Look for :pointer property on image. */
24510 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24512 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24513 if (img
!= NULL
&& IMAGEP (img
->spec
))
24515 Lisp_Object image_map
, hotspot
;
24516 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
24518 && (hotspot
= find_hot_spot (image_map
,
24519 glyph
->slice
.x
+ dx
,
24520 glyph
->slice
.y
+ dy
),
24522 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24524 Lisp_Object area_id
, plist
;
24526 area_id
= XCAR (hotspot
);
24527 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24528 If so, we could look for mouse-enter, mouse-leave
24529 properties in PLIST (and do something...). */
24530 hotspot
= XCDR (hotspot
);
24531 if (CONSP (hotspot
)
24532 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24534 pointer
= Fplist_get (plist
, Qpointer
);
24535 if (NILP (pointer
))
24537 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
24538 if (!NILP (help_echo_string
))
24540 help_echo_window
= window
;
24541 help_echo_object
= glyph
->object
;
24542 help_echo_pos
= glyph
->charpos
;
24546 if (NILP (pointer
))
24547 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
24551 /* Clear mouse face if X/Y not over text. */
24553 || area
!= TEXT_AREA
24554 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
24556 if (clear_mouse_face (dpyinfo
))
24557 cursor
= No_Cursor
;
24558 if (NILP (pointer
))
24560 if (area
!= TEXT_AREA
)
24561 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24563 pointer
= Vvoid_text_area_pointer
;
24568 pos
= glyph
->charpos
;
24569 object
= glyph
->object
;
24570 if (!STRINGP (object
) && !BUFFERP (object
))
24573 /* If we get an out-of-range value, return now; avoid an error. */
24574 if (BUFFERP (object
) && pos
> BUF_Z (b
))
24577 /* Make the window's buffer temporarily current for
24578 overlays_at and compute_char_face. */
24579 obuf
= current_buffer
;
24580 current_buffer
= b
;
24586 /* Is this char mouse-active or does it have help-echo? */
24587 position
= make_number (pos
);
24589 if (BUFFERP (object
))
24591 /* Put all the overlays we want in a vector in overlay_vec. */
24592 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
24593 /* Sort overlays into increasing priority order. */
24594 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
24599 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
24600 && vpos
>= dpyinfo
->mouse_face_beg_row
24601 && vpos
<= dpyinfo
->mouse_face_end_row
24602 && (vpos
> dpyinfo
->mouse_face_beg_row
24603 || hpos
>= dpyinfo
->mouse_face_beg_col
)
24604 && (vpos
< dpyinfo
->mouse_face_end_row
24605 || hpos
< dpyinfo
->mouse_face_end_col
24606 || dpyinfo
->mouse_face_past_end
));
24609 cursor
= No_Cursor
;
24611 /* Check mouse-face highlighting. */
24613 /* If there exists an overlay with mouse-face overlapping
24614 the one we are currently highlighting, we have to
24615 check if we enter the overlapping overlay, and then
24616 highlight only that. */
24617 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
24618 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
24620 /* Find the highest priority overlay with a mouse-face. */
24622 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
24624 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
24625 if (!NILP (mouse_face
))
24626 overlay
= overlay_vec
[i
];
24629 /* If we're highlighting the same overlay as before, there's
24630 no need to do that again. */
24631 if (!NILP (overlay
) && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
24632 goto check_help_echo
;
24633 dpyinfo
->mouse_face_overlay
= overlay
;
24635 /* Clear the display of the old active region, if any. */
24636 if (clear_mouse_face (dpyinfo
))
24637 cursor
= No_Cursor
;
24639 /* If no overlay applies, get a text property. */
24640 if (NILP (overlay
))
24641 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
24643 /* Next, compute the bounds of the mouse highlighting and
24645 if (!NILP (mouse_face
) && STRINGP (object
))
24647 /* The mouse-highlighting comes from a display string
24648 with a mouse-face. */
24652 b
= Fprevious_single_property_change
24653 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
24654 e
= Fnext_single_property_change
24655 (position
, Qmouse_face
, object
, Qnil
);
24657 b
= make_number (0);
24659 e
= make_number (SCHARS (object
) - 1);
24661 fast_find_string_pos (w
, XINT (b
), object
,
24662 &dpyinfo
->mouse_face_beg_col
,
24663 &dpyinfo
->mouse_face_beg_row
,
24664 &dpyinfo
->mouse_face_beg_x
,
24665 &dpyinfo
->mouse_face_beg_y
, 0);
24666 fast_find_string_pos (w
, XINT (e
), object
,
24667 &dpyinfo
->mouse_face_end_col
,
24668 &dpyinfo
->mouse_face_end_row
,
24669 &dpyinfo
->mouse_face_end_x
,
24670 &dpyinfo
->mouse_face_end_y
, 1);
24671 dpyinfo
->mouse_face_past_end
= 0;
24672 dpyinfo
->mouse_face_window
= window
;
24673 dpyinfo
->mouse_face_face_id
24674 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
24675 glyph
->face_id
, 1);
24676 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24677 cursor
= No_Cursor
;
24681 /* The mouse-highlighting, if any, comes from an overlay
24682 or text property in the buffer. */
24683 Lisp_Object buffer
, display_string
;
24685 if (STRINGP (object
))
24687 /* If we are on a display string with no mouse-face,
24688 check if the text under it has one. */
24689 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
24690 int start
= MATRIX_ROW_START_CHARPOS (r
);
24691 pos
= string_buffer_position (w
, object
, start
);
24694 mouse_face
= get_char_property_and_overlay
24695 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
24696 buffer
= w
->buffer
;
24697 display_string
= object
;
24703 display_string
= Qnil
;
24706 if (!NILP (mouse_face
))
24708 Lisp_Object before
, after
;
24709 Lisp_Object before_string
, after_string
;
24711 if (NILP (overlay
))
24713 /* Handle the text property case. */
24714 before
= Fprevious_single_property_change
24715 (make_number (pos
+ 1), Qmouse_face
, buffer
,
24716 Fmarker_position (w
->start
));
24717 after
= Fnext_single_property_change
24718 (make_number (pos
), Qmouse_face
, buffer
,
24719 make_number (BUF_Z (XBUFFER (buffer
))
24720 - XFASTINT (w
->window_end_pos
)));
24721 before_string
= after_string
= Qnil
;
24725 /* Handle the overlay case. */
24726 before
= Foverlay_start (overlay
);
24727 after
= Foverlay_end (overlay
);
24728 before_string
= Foverlay_get (overlay
, Qbefore_string
);
24729 after_string
= Foverlay_get (overlay
, Qafter_string
);
24731 if (!STRINGP (before_string
)) before_string
= Qnil
;
24732 if (!STRINGP (after_string
)) after_string
= Qnil
;
24735 mouse_face_from_buffer_pos (window
, dpyinfo
, pos
,
24738 before_string
, after_string
,
24740 cursor
= No_Cursor
;
24747 /* Look for a `help-echo' property. */
24748 if (NILP (help_echo_string
)) {
24749 Lisp_Object help
, overlay
;
24751 /* Check overlays first. */
24752 help
= overlay
= Qnil
;
24753 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
24755 overlay
= overlay_vec
[i
];
24756 help
= Foverlay_get (overlay
, Qhelp_echo
);
24761 help_echo_string
= help
;
24762 help_echo_window
= window
;
24763 help_echo_object
= overlay
;
24764 help_echo_pos
= pos
;
24768 Lisp_Object object
= glyph
->object
;
24769 int charpos
= glyph
->charpos
;
24771 /* Try text properties. */
24772 if (STRINGP (object
)
24774 && charpos
< SCHARS (object
))
24776 help
= Fget_text_property (make_number (charpos
),
24777 Qhelp_echo
, object
);
24780 /* If the string itself doesn't specify a help-echo,
24781 see if the buffer text ``under'' it does. */
24782 struct glyph_row
*r
24783 = MATRIX_ROW (w
->current_matrix
, vpos
);
24784 int start
= MATRIX_ROW_START_CHARPOS (r
);
24785 EMACS_INT pos
= string_buffer_position (w
, object
, start
);
24788 help
= Fget_char_property (make_number (pos
),
24789 Qhelp_echo
, w
->buffer
);
24793 object
= w
->buffer
;
24798 else if (BUFFERP (object
)
24801 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
24806 help_echo_string
= help
;
24807 help_echo_window
= window
;
24808 help_echo_object
= object
;
24809 help_echo_pos
= charpos
;
24814 /* Look for a `pointer' property. */
24815 if (NILP (pointer
))
24817 /* Check overlays first. */
24818 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
24819 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
24821 if (NILP (pointer
))
24823 Lisp_Object object
= glyph
->object
;
24824 int charpos
= glyph
->charpos
;
24826 /* Try text properties. */
24827 if (STRINGP (object
)
24829 && charpos
< SCHARS (object
))
24831 pointer
= Fget_text_property (make_number (charpos
),
24833 if (NILP (pointer
))
24835 /* If the string itself doesn't specify a pointer,
24836 see if the buffer text ``under'' it does. */
24837 struct glyph_row
*r
24838 = MATRIX_ROW (w
->current_matrix
, vpos
);
24839 int start
= MATRIX_ROW_START_CHARPOS (r
);
24840 EMACS_INT pos
= string_buffer_position (w
, object
,
24843 pointer
= Fget_char_property (make_number (pos
),
24844 Qpointer
, w
->buffer
);
24847 else if (BUFFERP (object
)
24850 pointer
= Fget_text_property (make_number (charpos
),
24857 current_buffer
= obuf
;
24862 define_frame_cursor1 (f
, cursor
, pointer
);
24867 Clear any mouse-face on window W. This function is part of the
24868 redisplay interface, and is called from try_window_id and similar
24869 functions to ensure the mouse-highlight is off. */
24872 x_clear_window_mouse_face (w
)
24875 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
24876 Lisp_Object window
;
24879 XSETWINDOW (window
, w
);
24880 if (EQ (window
, dpyinfo
->mouse_face_window
))
24881 clear_mouse_face (dpyinfo
);
24887 Just discard the mouse face information for frame F, if any.
24888 This is used when the size of F is changed. */
24891 cancel_mouse_face (f
)
24894 Lisp_Object window
;
24895 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24897 window
= dpyinfo
->mouse_face_window
;
24898 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
24900 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
24901 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
24902 dpyinfo
->mouse_face_window
= Qnil
;
24907 #endif /* HAVE_WINDOW_SYSTEM */
24910 /***********************************************************************
24912 ***********************************************************************/
24914 #ifdef HAVE_WINDOW_SYSTEM
24916 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
24917 which intersects rectangle R. R is in window-relative coordinates. */
24920 expose_area (w
, row
, r
, area
)
24922 struct glyph_row
*row
;
24924 enum glyph_row_area area
;
24926 struct glyph
*first
= row
->glyphs
[area
];
24927 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
24928 struct glyph
*last
;
24929 int first_x
, start_x
, x
;
24931 if (area
== TEXT_AREA
&& row
->fill_line_p
)
24932 /* If row extends face to end of line write the whole line. */
24933 draw_glyphs (w
, 0, row
, area
,
24934 0, row
->used
[area
],
24935 DRAW_NORMAL_TEXT
, 0);
24938 /* Set START_X to the window-relative start position for drawing glyphs of
24939 AREA. The first glyph of the text area can be partially visible.
24940 The first glyphs of other areas cannot. */
24941 start_x
= window_box_left_offset (w
, area
);
24943 if (area
== TEXT_AREA
)
24946 /* Find the first glyph that must be redrawn. */
24948 && x
+ first
->pixel_width
< r
->x
)
24950 x
+= first
->pixel_width
;
24954 /* Find the last one. */
24958 && x
< r
->x
+ r
->width
)
24960 x
+= last
->pixel_width
;
24966 draw_glyphs (w
, first_x
- start_x
, row
, area
,
24967 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
24968 DRAW_NORMAL_TEXT
, 0);
24973 /* Redraw the parts of the glyph row ROW on window W intersecting
24974 rectangle R. R is in window-relative coordinates. Value is
24975 non-zero if mouse-face was overwritten. */
24978 expose_line (w
, row
, r
)
24980 struct glyph_row
*row
;
24983 xassert (row
->enabled_p
);
24985 if (row
->mode_line_p
|| w
->pseudo_window_p
)
24986 draw_glyphs (w
, 0, row
, TEXT_AREA
,
24987 0, row
->used
[TEXT_AREA
],
24988 DRAW_NORMAL_TEXT
, 0);
24991 if (row
->used
[LEFT_MARGIN_AREA
])
24992 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
24993 if (row
->used
[TEXT_AREA
])
24994 expose_area (w
, row
, r
, TEXT_AREA
);
24995 if (row
->used
[RIGHT_MARGIN_AREA
])
24996 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
24997 draw_row_fringe_bitmaps (w
, row
);
25000 return row
->mouse_face_p
;
25004 /* Redraw those parts of glyphs rows during expose event handling that
25005 overlap other rows. Redrawing of an exposed line writes over parts
25006 of lines overlapping that exposed line; this function fixes that.
25008 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
25009 row in W's current matrix that is exposed and overlaps other rows.
25010 LAST_OVERLAPPING_ROW is the last such row. */
25013 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
, r
)
25015 struct glyph_row
*first_overlapping_row
;
25016 struct glyph_row
*last_overlapping_row
;
25019 struct glyph_row
*row
;
25021 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
25022 if (row
->overlapping_p
)
25024 xassert (row
->enabled_p
&& !row
->mode_line_p
);
25027 if (row
->used
[LEFT_MARGIN_AREA
])
25028 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
25030 if (row
->used
[TEXT_AREA
])
25031 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
25033 if (row
->used
[RIGHT_MARGIN_AREA
])
25034 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
25040 /* Return non-zero if W's cursor intersects rectangle R. */
25043 phys_cursor_in_rect_p (w
, r
)
25047 XRectangle cr
, result
;
25048 struct glyph
*cursor_glyph
;
25049 struct glyph_row
*row
;
25051 if (w
->phys_cursor
.vpos
>= 0
25052 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
25053 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
25055 && row
->cursor_in_fringe_p
)
25057 /* Cursor is in the fringe. */
25058 cr
.x
= window_box_right_offset (w
,
25059 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
25060 ? RIGHT_MARGIN_AREA
25063 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
25064 cr
.height
= row
->height
;
25065 return x_intersect_rectangles (&cr
, r
, &result
);
25068 cursor_glyph
= get_phys_cursor_glyph (w
);
25071 /* r is relative to W's box, but w->phys_cursor.x is relative
25072 to left edge of W's TEXT area. Adjust it. */
25073 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
25074 cr
.y
= w
->phys_cursor
.y
;
25075 cr
.width
= cursor_glyph
->pixel_width
;
25076 cr
.height
= w
->phys_cursor_height
;
25077 /* ++KFS: W32 version used W32-specific IntersectRect here, but
25078 I assume the effect is the same -- and this is portable. */
25079 return x_intersect_rectangles (&cr
, r
, &result
);
25081 /* If we don't understand the format, pretend we're not in the hot-spot. */
25087 Draw a vertical window border to the right of window W if W doesn't
25088 have vertical scroll bars. */
25091 x_draw_vertical_border (w
)
25094 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25096 /* We could do better, if we knew what type of scroll-bar the adjacent
25097 windows (on either side) have... But we don't :-(
25098 However, I think this works ok. ++KFS 2003-04-25 */
25100 /* Redraw borders between horizontally adjacent windows. Don't
25101 do it for frames with vertical scroll bars because either the
25102 right scroll bar of a window, or the left scroll bar of its
25103 neighbor will suffice as a border. */
25104 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
25107 if (!WINDOW_RIGHTMOST_P (w
)
25108 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
25110 int x0
, x1
, y0
, y1
;
25112 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25115 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25118 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
25120 else if (!WINDOW_LEFTMOST_P (w
)
25121 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
25123 int x0
, x1
, y0
, y1
;
25125 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25128 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25131 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
25136 /* Redraw the part of window W intersection rectangle FR. Pixel
25137 coordinates in FR are frame-relative. Call this function with
25138 input blocked. Value is non-zero if the exposure overwrites
25142 expose_window (w
, fr
)
25146 struct frame
*f
= XFRAME (w
->frame
);
25148 int mouse_face_overwritten_p
= 0;
25150 /* If window is not yet fully initialized, do nothing. This can
25151 happen when toolkit scroll bars are used and a window is split.
25152 Reconfiguring the scroll bar will generate an expose for a newly
25154 if (w
->current_matrix
== NULL
)
25157 /* When we're currently updating the window, display and current
25158 matrix usually don't agree. Arrange for a thorough display
25160 if (w
== updated_window
)
25162 SET_FRAME_GARBAGED (f
);
25166 /* Frame-relative pixel rectangle of W. */
25167 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
25168 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
25169 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
25170 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
25172 if (x_intersect_rectangles (fr
, &wr
, &r
))
25174 int yb
= window_text_bottom_y (w
);
25175 struct glyph_row
*row
;
25176 int cursor_cleared_p
;
25177 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
25179 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
25180 r
.x
, r
.y
, r
.width
, r
.height
));
25182 /* Convert to window coordinates. */
25183 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
25184 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
25186 /* Turn off the cursor. */
25187 if (!w
->pseudo_window_p
25188 && phys_cursor_in_rect_p (w
, &r
))
25190 x_clear_cursor (w
);
25191 cursor_cleared_p
= 1;
25194 cursor_cleared_p
= 0;
25196 /* Update lines intersecting rectangle R. */
25197 first_overlapping_row
= last_overlapping_row
= NULL
;
25198 for (row
= w
->current_matrix
->rows
;
25203 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
25205 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
25206 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
25207 || (r
.y
>= y0
&& r
.y
< y1
)
25208 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
25210 /* A header line may be overlapping, but there is no need
25211 to fix overlapping areas for them. KFS 2005-02-12 */
25212 if (row
->overlapping_p
&& !row
->mode_line_p
)
25214 if (first_overlapping_row
== NULL
)
25215 first_overlapping_row
= row
;
25216 last_overlapping_row
= row
;
25220 if (expose_line (w
, row
, &r
))
25221 mouse_face_overwritten_p
= 1;
25224 else if (row
->overlapping_p
)
25226 /* We must redraw a row overlapping the exposed area. */
25228 ? y0
+ row
->phys_height
> r
.y
25229 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
25231 if (first_overlapping_row
== NULL
)
25232 first_overlapping_row
= row
;
25233 last_overlapping_row
= row
;
25241 /* Display the mode line if there is one. */
25242 if (WINDOW_WANTS_MODELINE_P (w
)
25243 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
25245 && row
->y
< r
.y
+ r
.height
)
25247 if (expose_line (w
, row
, &r
))
25248 mouse_face_overwritten_p
= 1;
25251 if (!w
->pseudo_window_p
)
25253 /* Fix the display of overlapping rows. */
25254 if (first_overlapping_row
)
25255 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
25258 /* Draw border between windows. */
25259 x_draw_vertical_border (w
);
25261 /* Turn the cursor on again. */
25262 if (cursor_cleared_p
)
25263 update_window_cursor (w
, 1);
25267 return mouse_face_overwritten_p
;
25272 /* Redraw (parts) of all windows in the window tree rooted at W that
25273 intersect R. R contains frame pixel coordinates. Value is
25274 non-zero if the exposure overwrites mouse-face. */
25277 expose_window_tree (w
, r
)
25281 struct frame
*f
= XFRAME (w
->frame
);
25282 int mouse_face_overwritten_p
= 0;
25284 while (w
&& !FRAME_GARBAGED_P (f
))
25286 if (!NILP (w
->hchild
))
25287 mouse_face_overwritten_p
25288 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
25289 else if (!NILP (w
->vchild
))
25290 mouse_face_overwritten_p
25291 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
25293 mouse_face_overwritten_p
|= expose_window (w
, r
);
25295 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
25298 return mouse_face_overwritten_p
;
25303 Redisplay an exposed area of frame F. X and Y are the upper-left
25304 corner of the exposed rectangle. W and H are width and height of
25305 the exposed area. All are pixel values. W or H zero means redraw
25306 the entire frame. */
25309 expose_frame (f
, x
, y
, w
, h
)
25314 int mouse_face_overwritten_p
= 0;
25316 TRACE ((stderr
, "expose_frame "));
25318 /* No need to redraw if frame will be redrawn soon. */
25319 if (FRAME_GARBAGED_P (f
))
25321 TRACE ((stderr
, " garbaged\n"));
25325 /* If basic faces haven't been realized yet, there is no point in
25326 trying to redraw anything. This can happen when we get an expose
25327 event while Emacs is starting, e.g. by moving another window. */
25328 if (FRAME_FACE_CACHE (f
) == NULL
25329 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
25331 TRACE ((stderr
, " no faces\n"));
25335 if (w
== 0 || h
== 0)
25338 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
25339 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
25349 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
25350 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
25352 if (WINDOWP (f
->tool_bar_window
))
25353 mouse_face_overwritten_p
25354 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
25356 #ifdef HAVE_X_WINDOWS
25358 #ifndef USE_X_TOOLKIT
25359 if (WINDOWP (f
->menu_bar_window
))
25360 mouse_face_overwritten_p
25361 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
25362 #endif /* not USE_X_TOOLKIT */
25366 /* Some window managers support a focus-follows-mouse style with
25367 delayed raising of frames. Imagine a partially obscured frame,
25368 and moving the mouse into partially obscured mouse-face on that
25369 frame. The visible part of the mouse-face will be highlighted,
25370 then the WM raises the obscured frame. With at least one WM, KDE
25371 2.1, Emacs is not getting any event for the raising of the frame
25372 (even tried with SubstructureRedirectMask), only Expose events.
25373 These expose events will draw text normally, i.e. not
25374 highlighted. Which means we must redo the highlight here.
25375 Subsume it under ``we love X''. --gerd 2001-08-15 */
25376 /* Included in Windows version because Windows most likely does not
25377 do the right thing if any third party tool offers
25378 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
25379 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
25381 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25382 if (f
== dpyinfo
->mouse_face_mouse_frame
)
25384 int x
= dpyinfo
->mouse_face_mouse_x
;
25385 int y
= dpyinfo
->mouse_face_mouse_y
;
25386 clear_mouse_face (dpyinfo
);
25387 note_mouse_highlight (f
, x
, y
);
25394 Determine the intersection of two rectangles R1 and R2. Return
25395 the intersection in *RESULT. Value is non-zero if RESULT is not
25399 x_intersect_rectangles (r1
, r2
, result
)
25400 XRectangle
*r1
, *r2
, *result
;
25402 XRectangle
*left
, *right
;
25403 XRectangle
*upper
, *lower
;
25404 int intersection_p
= 0;
25406 /* Rearrange so that R1 is the left-most rectangle. */
25408 left
= r1
, right
= r2
;
25410 left
= r2
, right
= r1
;
25412 /* X0 of the intersection is right.x0, if this is inside R1,
25413 otherwise there is no intersection. */
25414 if (right
->x
<= left
->x
+ left
->width
)
25416 result
->x
= right
->x
;
25418 /* The right end of the intersection is the minimum of the
25419 the right ends of left and right. */
25420 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
25423 /* Same game for Y. */
25425 upper
= r1
, lower
= r2
;
25427 upper
= r2
, lower
= r1
;
25429 /* The upper end of the intersection is lower.y0, if this is inside
25430 of upper. Otherwise, there is no intersection. */
25431 if (lower
->y
<= upper
->y
+ upper
->height
)
25433 result
->y
= lower
->y
;
25435 /* The lower end of the intersection is the minimum of the lower
25436 ends of upper and lower. */
25437 result
->height
= (min (lower
->y
+ lower
->height
,
25438 upper
->y
+ upper
->height
)
25440 intersection_p
= 1;
25444 return intersection_p
;
25447 #endif /* HAVE_WINDOW_SYSTEM */
25450 /***********************************************************************
25452 ***********************************************************************/
25457 Vwith_echo_area_save_vector
= Qnil
;
25458 staticpro (&Vwith_echo_area_save_vector
);
25460 Vmessage_stack
= Qnil
;
25461 staticpro (&Vmessage_stack
);
25463 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
25464 staticpro (&Qinhibit_redisplay
);
25466 message_dolog_marker1
= Fmake_marker ();
25467 staticpro (&message_dolog_marker1
);
25468 message_dolog_marker2
= Fmake_marker ();
25469 staticpro (&message_dolog_marker2
);
25470 message_dolog_marker3
= Fmake_marker ();
25471 staticpro (&message_dolog_marker3
);
25474 defsubr (&Sdump_frame_glyph_matrix
);
25475 defsubr (&Sdump_glyph_matrix
);
25476 defsubr (&Sdump_glyph_row
);
25477 defsubr (&Sdump_tool_bar_row
);
25478 defsubr (&Strace_redisplay
);
25479 defsubr (&Strace_to_stderr
);
25481 #ifdef HAVE_WINDOW_SYSTEM
25482 defsubr (&Stool_bar_lines_needed
);
25483 defsubr (&Slookup_image_map
);
25485 defsubr (&Sformat_mode_line
);
25486 defsubr (&Sinvisible_p
);
25488 staticpro (&Qmenu_bar_update_hook
);
25489 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
25491 staticpro (&Qoverriding_terminal_local_map
);
25492 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
25494 staticpro (&Qoverriding_local_map
);
25495 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
25497 staticpro (&Qwindow_scroll_functions
);
25498 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
25500 staticpro (&Qwindow_text_change_functions
);
25501 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
25503 staticpro (&Qredisplay_end_trigger_functions
);
25504 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
25506 staticpro (&Qinhibit_point_motion_hooks
);
25507 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
25509 Qeval
= intern_c_string ("eval");
25510 staticpro (&Qeval
);
25512 QCdata
= intern_c_string (":data");
25513 staticpro (&QCdata
);
25514 Qdisplay
= intern_c_string ("display");
25515 staticpro (&Qdisplay
);
25516 Qspace_width
= intern_c_string ("space-width");
25517 staticpro (&Qspace_width
);
25518 Qraise
= intern_c_string ("raise");
25519 staticpro (&Qraise
);
25520 Qslice
= intern_c_string ("slice");
25521 staticpro (&Qslice
);
25522 Qspace
= intern_c_string ("space");
25523 staticpro (&Qspace
);
25524 Qmargin
= intern_c_string ("margin");
25525 staticpro (&Qmargin
);
25526 Qpointer
= intern_c_string ("pointer");
25527 staticpro (&Qpointer
);
25528 Qleft_margin
= intern_c_string ("left-margin");
25529 staticpro (&Qleft_margin
);
25530 Qright_margin
= intern_c_string ("right-margin");
25531 staticpro (&Qright_margin
);
25532 Qcenter
= intern_c_string ("center");
25533 staticpro (&Qcenter
);
25534 Qline_height
= intern_c_string ("line-height");
25535 staticpro (&Qline_height
);
25536 QCalign_to
= intern_c_string (":align-to");
25537 staticpro (&QCalign_to
);
25538 QCrelative_width
= intern_c_string (":relative-width");
25539 staticpro (&QCrelative_width
);
25540 QCrelative_height
= intern_c_string (":relative-height");
25541 staticpro (&QCrelative_height
);
25542 QCeval
= intern_c_string (":eval");
25543 staticpro (&QCeval
);
25544 QCpropertize
= intern_c_string (":propertize");
25545 staticpro (&QCpropertize
);
25546 QCfile
= intern_c_string (":file");
25547 staticpro (&QCfile
);
25548 Qfontified
= intern_c_string ("fontified");
25549 staticpro (&Qfontified
);
25550 Qfontification_functions
= intern_c_string ("fontification-functions");
25551 staticpro (&Qfontification_functions
);
25552 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
25553 staticpro (&Qtrailing_whitespace
);
25554 Qescape_glyph
= intern_c_string ("escape-glyph");
25555 staticpro (&Qescape_glyph
);
25556 Qnobreak_space
= intern_c_string ("nobreak-space");
25557 staticpro (&Qnobreak_space
);
25558 Qimage
= intern_c_string ("image");
25559 staticpro (&Qimage
);
25560 QCmap
= intern_c_string (":map");
25561 staticpro (&QCmap
);
25562 QCpointer
= intern_c_string (":pointer");
25563 staticpro (&QCpointer
);
25564 Qrect
= intern_c_string ("rect");
25565 staticpro (&Qrect
);
25566 Qcircle
= intern_c_string ("circle");
25567 staticpro (&Qcircle
);
25568 Qpoly
= intern_c_string ("poly");
25569 staticpro (&Qpoly
);
25570 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
25571 staticpro (&Qmessage_truncate_lines
);
25572 Qgrow_only
= intern_c_string ("grow-only");
25573 staticpro (&Qgrow_only
);
25574 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
25575 staticpro (&Qinhibit_menubar_update
);
25576 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
25577 staticpro (&Qinhibit_eval_during_redisplay
);
25578 Qposition
= intern_c_string ("position");
25579 staticpro (&Qposition
);
25580 Qbuffer_position
= intern_c_string ("buffer-position");
25581 staticpro (&Qbuffer_position
);
25582 Qobject
= intern_c_string ("object");
25583 staticpro (&Qobject
);
25584 Qbar
= intern_c_string ("bar");
25586 Qhbar
= intern_c_string ("hbar");
25587 staticpro (&Qhbar
);
25588 Qbox
= intern_c_string ("box");
25590 Qhollow
= intern_c_string ("hollow");
25591 staticpro (&Qhollow
);
25592 Qhand
= intern_c_string ("hand");
25593 staticpro (&Qhand
);
25594 Qarrow
= intern_c_string ("arrow");
25595 staticpro (&Qarrow
);
25596 Qtext
= intern_c_string ("text");
25597 staticpro (&Qtext
);
25598 Qrisky_local_variable
= intern_c_string ("risky-local-variable");
25599 staticpro (&Qrisky_local_variable
);
25600 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
25601 staticpro (&Qinhibit_free_realized_faces
);
25603 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
25604 Fcons (intern_c_string ("void-variable"), Qnil
)),
25606 staticpro (&list_of_error
);
25608 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
25609 staticpro (&Qlast_arrow_position
);
25610 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
25611 staticpro (&Qlast_arrow_string
);
25613 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
25614 staticpro (&Qoverlay_arrow_string
);
25615 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
25616 staticpro (&Qoverlay_arrow_bitmap
);
25618 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
25619 staticpro (&echo_buffer
[0]);
25620 staticpro (&echo_buffer
[1]);
25622 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
25623 staticpro (&echo_area_buffer
[0]);
25624 staticpro (&echo_area_buffer
[1]);
25626 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
25627 staticpro (&Vmessages_buffer_name
);
25629 mode_line_proptrans_alist
= Qnil
;
25630 staticpro (&mode_line_proptrans_alist
);
25631 mode_line_string_list
= Qnil
;
25632 staticpro (&mode_line_string_list
);
25633 mode_line_string_face
= Qnil
;
25634 staticpro (&mode_line_string_face
);
25635 mode_line_string_face_prop
= Qnil
;
25636 staticpro (&mode_line_string_face_prop
);
25637 Vmode_line_unwind_vector
= Qnil
;
25638 staticpro (&Vmode_line_unwind_vector
);
25640 help_echo_string
= Qnil
;
25641 staticpro (&help_echo_string
);
25642 help_echo_object
= Qnil
;
25643 staticpro (&help_echo_object
);
25644 help_echo_window
= Qnil
;
25645 staticpro (&help_echo_window
);
25646 previous_help_echo_string
= Qnil
;
25647 staticpro (&previous_help_echo_string
);
25648 help_echo_pos
= -1;
25650 Qright_to_left
= intern_c_string ("right-to-left");
25651 staticpro (&Qright_to_left
);
25652 Qleft_to_right
= intern_c_string ("left-to-right");
25653 staticpro (&Qleft_to_right
);
25655 #ifdef HAVE_WINDOW_SYSTEM
25656 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
25657 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
25658 For example, if a block cursor is over a tab, it will be drawn as
25659 wide as that tab on the display. */);
25660 x_stretch_cursor_p
= 0;
25663 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
25664 doc
: /* *Non-nil means highlight trailing whitespace.
25665 The face used for trailing whitespace is `trailing-whitespace'. */);
25666 Vshow_trailing_whitespace
= Qnil
;
25668 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
25669 doc
: /* *Control highlighting of nobreak space and soft hyphen.
25670 A value of t means highlight the character itself (for nobreak space,
25671 use face `nobreak-space').
25672 A value of nil means no highlighting.
25673 Other values mean display the escape glyph followed by an ordinary
25674 space or ordinary hyphen. */);
25675 Vnobreak_char_display
= Qt
;
25677 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
25678 doc
: /* *The pointer shape to show in void text areas.
25679 A value of nil means to show the text pointer. Other options are `arrow',
25680 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
25681 Vvoid_text_area_pointer
= Qarrow
;
25683 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
25684 doc
: /* Non-nil means don't actually do any redisplay.
25685 This is used for internal purposes. */);
25686 Vinhibit_redisplay
= Qnil
;
25688 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
25689 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
25690 Vglobal_mode_string
= Qnil
;
25692 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
25693 doc
: /* Marker for where to display an arrow on top of the buffer text.
25694 This must be the beginning of a line in order to work.
25695 See also `overlay-arrow-string'. */);
25696 Voverlay_arrow_position
= Qnil
;
25698 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
25699 doc
: /* String to display as an arrow in non-window frames.
25700 See also `overlay-arrow-position'. */);
25701 Voverlay_arrow_string
= make_pure_c_string ("=>");
25703 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
25704 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
25705 The symbols on this list are examined during redisplay to determine
25706 where to display overlay arrows. */);
25707 Voverlay_arrow_variable_list
25708 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
25710 DEFVAR_INT ("scroll-step", &scroll_step
,
25711 doc
: /* *The number of lines to try scrolling a window by when point moves out.
25712 If that fails to bring point back on frame, point is centered instead.
25713 If this is zero, point is always centered after it moves off frame.
25714 If you want scrolling to always be a line at a time, you should set
25715 `scroll-conservatively' to a large value rather than set this to 1. */);
25717 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
25718 doc
: /* *Scroll up to this many lines, to bring point back on screen.
25719 If point moves off-screen, redisplay will scroll by up to
25720 `scroll-conservatively' lines in order to bring point just barely
25721 onto the screen again. If that cannot be done, then redisplay
25722 recenters point as usual.
25724 A value of zero means always recenter point if it moves off screen. */);
25725 scroll_conservatively
= 0;
25727 DEFVAR_INT ("scroll-margin", &scroll_margin
,
25728 doc
: /* *Number of lines of margin at the top and bottom of a window.
25729 Recenter the window whenever point gets within this many lines
25730 of the top or bottom of the window. */);
25733 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
25734 doc
: /* Pixels per inch value for non-window system displays.
25735 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
25736 Vdisplay_pixels_per_inch
= make_float (72.0);
25739 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
25742 DEFVAR_LISP ("truncate-partial-width-windows",
25743 &Vtruncate_partial_width_windows
,
25744 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
25745 For an integer value, truncate lines in each window narrower than the
25746 full frame width, provided the window width is less than that integer;
25747 otherwise, respect the value of `truncate-lines'.
25749 For any other non-nil value, truncate lines in all windows that do
25750 not span the full frame width.
25752 A value of nil means to respect the value of `truncate-lines'.
25754 If `word-wrap' is enabled, you might want to reduce this. */);
25755 Vtruncate_partial_width_windows
= make_number (50);
25757 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
25758 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
25759 Any other value means to use the appropriate face, `mode-line',
25760 `header-line', or `menu' respectively. */);
25761 mode_line_inverse_video
= 1;
25763 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
25764 doc
: /* *Maximum buffer size for which line number should be displayed.
25765 If the buffer is bigger than this, the line number does not appear
25766 in the mode line. A value of nil means no limit. */);
25767 Vline_number_display_limit
= Qnil
;
25769 DEFVAR_INT ("line-number-display-limit-width",
25770 &line_number_display_limit_width
,
25771 doc
: /* *Maximum line width (in characters) for line number display.
25772 If the average length of the lines near point is bigger than this, then the
25773 line number may be omitted from the mode line. */);
25774 line_number_display_limit_width
= 200;
25776 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
25777 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
25778 highlight_nonselected_windows
= 0;
25780 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
25781 doc
: /* Non-nil if more than one frame is visible on this display.
25782 Minibuffer-only frames don't count, but iconified frames do.
25783 This variable is not guaranteed to be accurate except while processing
25784 `frame-title-format' and `icon-title-format'. */);
25786 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
25787 doc
: /* Template for displaying the title bar of visible frames.
25788 \(Assuming the window manager supports this feature.)
25790 This variable has the same structure as `mode-line-format', except that
25791 the %c and %l constructs are ignored. It is used only on frames for
25792 which no explicit name has been set \(see `modify-frame-parameters'). */);
25794 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
25795 doc
: /* Template for displaying the title bar of an iconified frame.
25796 \(Assuming the window manager supports this feature.)
25797 This variable has the same structure as `mode-line-format' (which see),
25798 and is used only on frames for which no explicit name has been set
25799 \(see `modify-frame-parameters'). */);
25801 = Vframe_title_format
25802 = pure_cons (intern_c_string ("multiple-frames"),
25803 pure_cons (make_pure_c_string ("%b"),
25804 pure_cons (pure_cons (empty_unibyte_string
,
25805 pure_cons (intern_c_string ("invocation-name"),
25806 pure_cons (make_pure_c_string ("@"),
25807 pure_cons (intern_c_string ("system-name"),
25811 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
25812 doc
: /* Maximum number of lines to keep in the message log buffer.
25813 If nil, disable message logging. If t, log messages but don't truncate
25814 the buffer when it becomes large. */);
25815 Vmessage_log_max
= make_number (100);
25817 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
25818 doc
: /* Functions called before redisplay, if window sizes have changed.
25819 The value should be a list of functions that take one argument.
25820 Just before redisplay, for each frame, if any of its windows have changed
25821 size since the last redisplay, or have been split or deleted,
25822 all the functions in the list are called, with the frame as argument. */);
25823 Vwindow_size_change_functions
= Qnil
;
25825 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
25826 doc
: /* List of functions to call before redisplaying a window with scrolling.
25827 Each function is called with two arguments, the window and its new
25828 display-start position. Note that these functions are also called by
25829 `set-window-buffer'. Also note that the value of `window-end' is not
25830 valid when these functions are called. */);
25831 Vwindow_scroll_functions
= Qnil
;
25833 DEFVAR_LISP ("window-text-change-functions",
25834 &Vwindow_text_change_functions
,
25835 doc
: /* Functions to call in redisplay when text in the window might change. */);
25836 Vwindow_text_change_functions
= Qnil
;
25838 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
25839 doc
: /* Functions called when redisplay of a window reaches the end trigger.
25840 Each function is called with two arguments, the window and the end trigger value.
25841 See `set-window-redisplay-end-trigger'. */);
25842 Vredisplay_end_trigger_functions
= Qnil
;
25844 DEFVAR_LISP ("mouse-autoselect-window", &Vmouse_autoselect_window
,
25845 doc
: /* *Non-nil means autoselect window with mouse pointer.
25846 If nil, do not autoselect windows.
25847 A positive number means delay autoselection by that many seconds: a
25848 window is autoselected only after the mouse has remained in that
25849 window for the duration of the delay.
25850 A negative number has a similar effect, but causes windows to be
25851 autoselected only after the mouse has stopped moving. \(Because of
25852 the way Emacs compares mouse events, you will occasionally wait twice
25853 that time before the window gets selected.\)
25854 Any other value means to autoselect window instantaneously when the
25855 mouse pointer enters it.
25857 Autoselection selects the minibuffer only if it is active, and never
25858 unselects the minibuffer if it is active.
25860 When customizing this variable make sure that the actual value of
25861 `focus-follows-mouse' matches the behavior of your window manager. */);
25862 Vmouse_autoselect_window
= Qnil
;
25864 DEFVAR_LISP ("auto-resize-tool-bars", &Vauto_resize_tool_bars
,
25865 doc
: /* *Non-nil means automatically resize tool-bars.
25866 This dynamically changes the tool-bar's height to the minimum height
25867 that is needed to make all tool-bar items visible.
25868 If value is `grow-only', the tool-bar's height is only increased
25869 automatically; to decrease the tool-bar height, use \\[recenter]. */);
25870 Vauto_resize_tool_bars
= Qt
;
25872 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
25873 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
25874 auto_raise_tool_bar_buttons_p
= 1;
25876 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
25877 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
25878 make_cursor_line_fully_visible_p
= 1;
25880 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
25881 doc
: /* *Border below tool-bar in pixels.
25882 If an integer, use it as the height of the border.
25883 If it is one of `internal-border-width' or `border-width', use the
25884 value of the corresponding frame parameter.
25885 Otherwise, no border is added below the tool-bar. */);
25886 Vtool_bar_border
= Qinternal_border_width
;
25888 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
25889 doc
: /* *Margin around tool-bar buttons in pixels.
25890 If an integer, use that for both horizontal and vertical margins.
25891 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
25892 HORZ specifying the horizontal margin, and VERT specifying the
25893 vertical margin. */);
25894 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
25896 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
25897 doc
: /* *Relief thickness of tool-bar buttons. */);
25898 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
25900 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
25901 doc
: /* List of functions to call to fontify regions of text.
25902 Each function is called with one argument POS. Functions must
25903 fontify a region starting at POS in the current buffer, and give
25904 fontified regions the property `fontified'. */);
25905 Vfontification_functions
= Qnil
;
25906 Fmake_variable_buffer_local (Qfontification_functions
);
25908 DEFVAR_BOOL ("unibyte-display-via-language-environment",
25909 &unibyte_display_via_language_environment
,
25910 doc
: /* *Non-nil means display unibyte text according to language environment.
25911 Specifically, this means that raw bytes in the range 160-255 decimal
25912 are displayed by converting them to the equivalent multibyte characters
25913 according to the current language environment. As a result, they are
25914 displayed according to the current fontset.
25916 Note that this variable affects only how these bytes are displayed,
25917 but does not change the fact they are interpreted as raw bytes. */);
25918 unibyte_display_via_language_environment
= 0;
25920 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
25921 doc
: /* *Maximum height for resizing mini-windows.
25922 If a float, it specifies a fraction of the mini-window frame's height.
25923 If an integer, it specifies a number of lines. */);
25924 Vmax_mini_window_height
= make_float (0.25);
25926 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
25927 doc
: /* *How to resize mini-windows.
25928 A value of nil means don't automatically resize mini-windows.
25929 A value of t means resize them to fit the text displayed in them.
25930 A value of `grow-only', the default, means let mini-windows grow
25931 only, until their display becomes empty, at which point the windows
25932 go back to their normal size. */);
25933 Vresize_mini_windows
= Qgrow_only
;
25935 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
25936 doc
: /* Alist specifying how to blink the cursor off.
25937 Each element has the form (ON-STATE . OFF-STATE). Whenever the
25938 `cursor-type' frame-parameter or variable equals ON-STATE,
25939 comparing using `equal', Emacs uses OFF-STATE to specify
25940 how to blink it off. ON-STATE and OFF-STATE are values for
25941 the `cursor-type' frame parameter.
25943 If a frame's ON-STATE has no entry in this list,
25944 the frame's other specifications determine how to blink the cursor off. */);
25945 Vblink_cursor_alist
= Qnil
;
25947 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
25948 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
25949 automatic_hscrolling_p
= 1;
25950 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
25951 staticpro (&Qauto_hscroll_mode
);
25953 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
25954 doc
: /* *How many columns away from the window edge point is allowed to get
25955 before automatic hscrolling will horizontally scroll the window. */);
25956 hscroll_margin
= 5;
25958 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
25959 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
25960 When point is less than `hscroll-margin' columns from the window
25961 edge, automatic hscrolling will scroll the window by the amount of columns
25962 determined by this variable. If its value is a positive integer, scroll that
25963 many columns. If it's a positive floating-point number, it specifies the
25964 fraction of the window's width to scroll. If it's nil or zero, point will be
25965 centered horizontally after the scroll. Any other value, including negative
25966 numbers, are treated as if the value were zero.
25968 Automatic hscrolling always moves point outside the scroll margin, so if
25969 point was more than scroll step columns inside the margin, the window will
25970 scroll more than the value given by the scroll step.
25972 Note that the lower bound for automatic hscrolling specified by `scroll-left'
25973 and `scroll-right' overrides this variable's effect. */);
25974 Vhscroll_step
= make_number (0);
25976 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
25977 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
25978 Bind this around calls to `message' to let it take effect. */);
25979 message_truncate_lines
= 0;
25981 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
25982 doc
: /* Normal hook run to update the menu bar definitions.
25983 Redisplay runs this hook before it redisplays the menu bar.
25984 This is used to update submenus such as Buffers,
25985 whose contents depend on various data. */);
25986 Vmenu_bar_update_hook
= Qnil
;
25988 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
25989 doc
: /* Frame for which we are updating a menu.
25990 The enable predicate for a menu binding should check this variable. */);
25991 Vmenu_updating_frame
= Qnil
;
25993 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
25994 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
25995 inhibit_menubar_update
= 0;
25997 DEFVAR_LISP ("wrap-prefix", &Vwrap_prefix
,
25998 doc
: /* Prefix prepended to all continuation lines at display time.
25999 The value may be a string, an image, or a stretch-glyph; it is
26000 interpreted in the same way as the value of a `display' text property.
26002 This variable is overridden by any `wrap-prefix' text or overlay
26005 To add a prefix to non-continuation lines, use `line-prefix'. */);
26006 Vwrap_prefix
= Qnil
;
26007 staticpro (&Qwrap_prefix
);
26008 Qwrap_prefix
= intern_c_string ("wrap-prefix");
26009 Fmake_variable_buffer_local (Qwrap_prefix
);
26011 DEFVAR_LISP ("line-prefix", &Vline_prefix
,
26012 doc
: /* Prefix prepended to all non-continuation lines at display time.
26013 The value may be a string, an image, or a stretch-glyph; it is
26014 interpreted in the same way as the value of a `display' text property.
26016 This variable is overridden by any `line-prefix' text or overlay
26019 To add a prefix to continuation lines, use `wrap-prefix'. */);
26020 Vline_prefix
= Qnil
;
26021 staticpro (&Qline_prefix
);
26022 Qline_prefix
= intern_c_string ("line-prefix");
26023 Fmake_variable_buffer_local (Qline_prefix
);
26025 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
26026 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
26027 inhibit_eval_during_redisplay
= 0;
26029 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
26030 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
26031 inhibit_free_realized_faces
= 0;
26034 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
26035 doc
: /* Inhibit try_window_id display optimization. */);
26036 inhibit_try_window_id
= 0;
26038 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
26039 doc
: /* Inhibit try_window_reusing display optimization. */);
26040 inhibit_try_window_reusing
= 0;
26042 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
26043 doc
: /* Inhibit try_cursor_movement display optimization. */);
26044 inhibit_try_cursor_movement
= 0;
26045 #endif /* GLYPH_DEBUG */
26047 DEFVAR_INT ("overline-margin", &overline_margin
,
26048 doc
: /* *Space between overline and text, in pixels.
26049 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
26050 margin to the caracter height. */);
26051 overline_margin
= 2;
26053 DEFVAR_INT ("underline-minimum-offset",
26054 &underline_minimum_offset
,
26055 doc
: /* Minimum distance between baseline and underline.
26056 This can improve legibility of underlined text at small font sizes,
26057 particularly when using variable `x-use-underline-position-properties'
26058 with fonts that specify an UNDERLINE_POSITION relatively close to the
26059 baseline. The default value is 1. */);
26060 underline_minimum_offset
= 1;
26062 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p
,
26063 doc
: /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
26064 display_hourglass_p
= 1;
26066 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay
,
26067 doc
: /* *Seconds to wait before displaying an hourglass pointer.
26068 Value must be an integer or float. */);
26069 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
26071 hourglass_atimer
= NULL
;
26072 hourglass_shown_p
= 0;
26076 /* Initialize this module when Emacs starts. */
26081 Lisp_Object root_window
;
26082 struct window
*mini_w
;
26084 current_header_line_height
= current_mode_line_height
= -1;
26086 CHARPOS (this_line_start_pos
) = 0;
26088 mini_w
= XWINDOW (minibuf_window
);
26089 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
26091 if (!noninteractive
)
26093 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
26096 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
26097 set_window_height (root_window
,
26098 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
26100 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
26101 set_window_height (minibuf_window
, 1, 0);
26103 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
26104 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
26106 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
26107 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
26108 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
26110 /* The default ellipsis glyphs `...'. */
26111 for (i
= 0; i
< 3; ++i
)
26112 default_invis_vector
[i
] = make_number ('.');
26116 /* Allocate the buffer for frame titles.
26117 Also used for `format-mode-line'. */
26119 mode_line_noprop_buf
= (char *) xmalloc (size
);
26120 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
26121 mode_line_noprop_ptr
= mode_line_noprop_buf
;
26122 mode_line_target
= MODE_LINE_DISPLAY
;
26125 help_echo_showing_p
= 0;
26128 /* Since w32 does not support atimers, it defines its own implementation of
26129 the following three functions in w32fns.c. */
26132 /* Platform-independent portion of hourglass implementation. */
26134 /* Return non-zero if houglass timer has been started or hourglass is shown. */
26136 hourglass_started ()
26138 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
26141 /* Cancel a currently active hourglass timer, and start a new one. */
26145 #if defined (HAVE_WINDOW_SYSTEM)
26147 int secs
, usecs
= 0;
26149 cancel_hourglass ();
26151 if (INTEGERP (Vhourglass_delay
)
26152 && XINT (Vhourglass_delay
) > 0)
26153 secs
= XFASTINT (Vhourglass_delay
);
26154 else if (FLOATP (Vhourglass_delay
)
26155 && XFLOAT_DATA (Vhourglass_delay
) > 0)
26158 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
26159 secs
= XFASTINT (tem
);
26160 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
26163 secs
= DEFAULT_HOURGLASS_DELAY
;
26165 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
26166 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
26167 show_hourglass
, NULL
);
26172 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
26175 cancel_hourglass ()
26177 #if defined (HAVE_WINDOW_SYSTEM)
26178 if (hourglass_atimer
)
26180 cancel_atimer (hourglass_atimer
);
26181 hourglass_atimer
= NULL
;
26184 if (hourglass_shown_p
)
26188 #endif /* ! WINDOWSNT */
26190 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
26191 (do not change this comment) */