1 /* Display generation from window structure and buffer text.
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995,
3 1997, 1998, 1999, 2000, 2001, 2002, 2003,
4 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3, or (at your option)
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
23 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
27 Emacs separates the task of updating the display from code
28 modifying global state, e.g. buffer text. This way functions
29 operating on buffers don't also have to be concerned with updating
32 Updating the display is triggered by the Lisp interpreter when it
33 decides it's time to do it. This is done either automatically for
34 you as part of the interpreter's command loop or as the result of
35 calling Lisp functions like `sit-for'. The C function `redisplay'
36 in xdisp.c is the only entry into the inner redisplay code. (Or,
37 let's say almost---see the description of direct update
40 The following diagram shows how redisplay code is invoked. As you
41 can see, Lisp calls redisplay and vice versa. Under window systems
42 like X, some portions of the redisplay code are also called
43 asynchronously during mouse movement or expose events. It is very
44 important that these code parts do NOT use the C library (malloc,
45 free) because many C libraries under Unix are not reentrant. They
46 may also NOT call functions of the Lisp interpreter which could
47 change the interpreter's state. If you don't follow these rules,
48 you will encounter bugs which are very hard to explain.
50 (Direct functions, see below)
51 direct_output_for_insert,
52 direct_forward_char (dispnew.c)
53 +---------------------------------+
56 +--------------+ redisplay +----------------+
57 | Lisp machine |---------------->| Redisplay code |<--+
58 +--------------+ (xdisp.c) +----------------+ |
60 +----------------------------------+ |
61 Don't use this path when called |
64 expose_window (asynchronous) |
66 X expose events -----+
68 What does redisplay do? Obviously, it has to figure out somehow what
69 has been changed since the last time the display has been updated,
70 and to make these changes visible. Preferably it would do that in
71 a moderately intelligent way, i.e. fast.
73 Changes in buffer text can be deduced from window and buffer
74 structures, and from some global variables like `beg_unchanged' and
75 `end_unchanged'. The contents of the display are additionally
76 recorded in a `glyph matrix', a two-dimensional matrix of glyph
77 structures. Each row in such a matrix corresponds to a line on the
78 display, and each glyph in a row corresponds to a column displaying
79 a character, an image, or what else. This matrix is called the
80 `current glyph matrix' or `current matrix' in redisplay
83 For buffer parts that have been changed since the last update, a
84 second glyph matrix is constructed, the so called `desired glyph
85 matrix' or short `desired matrix'. Current and desired matrix are
86 then compared to find a cheap way to update the display, e.g. by
87 reusing part of the display by scrolling lines.
92 You will find a lot of redisplay optimizations when you start
93 looking at the innards of redisplay. The overall goal of all these
94 optimizations is to make redisplay fast because it is done
97 Two optimizations are not found in xdisp.c. These are the direct
98 operations mentioned above. As the name suggests they follow a
99 different principle than the rest of redisplay. Instead of
100 building a desired matrix and then comparing it with the current
101 display, they perform their actions directly on the display and on
104 One direct operation updates the display after one character has
105 been entered. The other one moves the cursor by one position
106 forward or backward. You find these functions under the names
107 `direct_output_for_insert' and `direct_output_forward_char' in
113 Desired matrices are always built per Emacs window. The function
114 `display_line' is the central function to look at if you are
115 interested. It constructs one row in a desired matrix given an
116 iterator structure containing both a buffer position and a
117 description of the environment in which the text is to be
118 displayed. But this is too early, read on.
120 Characters and pixmaps displayed for a range of buffer text depend
121 on various settings of buffers and windows, on overlays and text
122 properties, on display tables, on selective display. The good news
123 is that all this hairy stuff is hidden behind a small set of
124 interface functions taking an iterator structure (struct it)
127 Iteration over things to be displayed is then simple. It is
128 started by initializing an iterator with a call to init_iterator.
129 Calls to get_next_display_element fill the iterator structure with
130 relevant information about the next thing to display. Calls to
131 set_iterator_to_next move the iterator to the next thing.
133 Besides this, an iterator also contains information about the
134 display environment in which glyphs for display elements are to be
135 produced. It has fields for the width and height of the display,
136 the information whether long lines are truncated or continued, a
137 current X and Y position, and lots of other stuff you can better
140 Glyphs in a desired matrix are normally constructed in a loop
141 calling get_next_display_element and then produce_glyphs. The call
142 to produce_glyphs will fill the iterator structure with pixel
143 information about the element being displayed and at the same time
144 produce glyphs for it. If the display element fits on the line
145 being displayed, set_iterator_to_next is called next, otherwise the
146 glyphs produced are discarded.
151 That just couldn't be all, could it? What about terminal types not
152 supporting operations on sub-windows of the screen? To update the
153 display on such a terminal, window-based glyph matrices are not
154 well suited. To be able to reuse part of the display (scrolling
155 lines up and down), we must instead have a view of the whole
156 screen. This is what `frame matrices' are for. They are a trick.
158 Frames on terminals like above have a glyph pool. Windows on such
159 a frame sub-allocate their glyph memory from their frame's glyph
160 pool. The frame itself is given its own glyph matrices. By
161 coincidence---or maybe something else---rows in window glyph
162 matrices are slices of corresponding rows in frame matrices. Thus
163 writing to window matrices implicitly updates a frame matrix which
164 provides us with the view of the whole screen that we originally
165 wanted to have without having to move many bytes around. To be
166 honest, there is a little bit more done, but not much more. If you
167 plan to extend that code, take a look at dispnew.c. The function
168 build_frame_matrix is a good starting point. */
174 #include "keyboard.h"
177 #include "termchar.h"
178 #include "dispextern.h"
180 #include "character.h"
183 #include "commands.h"
187 #include "termhooks.h"
188 #include "intervals.h"
191 #include "region-cache.h"
193 #include "blockinput.h"
195 #ifdef HAVE_X_WINDOWS
205 #ifdef HAVE_WINDOW_SYSTEM
206 #ifdef USE_FONT_BACKEND
208 #endif /* USE_FONT_BACKEND */
209 #endif /* HAVE_WINDOW_SYSTEM */
211 #ifndef FRAME_X_OUTPUT
212 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
215 #define INFINITY 10000000
217 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
219 extern void set_frame_menubar
P_ ((struct frame
*f
, int, int));
220 extern int pending_menu_activation
;
223 extern int interrupt_input
;
224 extern int command_loop_level
;
226 extern Lisp_Object do_mouse_tracking
;
228 extern int minibuffer_auto_raise
;
229 extern Lisp_Object Vminibuffer_list
;
231 extern Lisp_Object Qface
;
232 extern Lisp_Object Qmode_line
, Qmode_line_inactive
, Qheader_line
;
234 extern Lisp_Object Voverriding_local_map
;
235 extern Lisp_Object Voverriding_local_map_menu_flag
;
236 extern Lisp_Object Qmenu_item
;
237 extern Lisp_Object Qwhen
;
238 extern Lisp_Object Qhelp_echo
;
240 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
241 Lisp_Object Qwindow_scroll_functions
, Vwindow_scroll_functions
;
242 Lisp_Object Qwindow_text_change_functions
, Vwindow_text_change_functions
;
243 Lisp_Object Qredisplay_end_trigger_functions
, Vredisplay_end_trigger_functions
;
244 Lisp_Object Qinhibit_point_motion_hooks
;
245 Lisp_Object QCeval
, QCfile
, QCdata
, QCpropertize
;
246 Lisp_Object Qfontified
;
247 Lisp_Object Qgrow_only
;
248 Lisp_Object Qinhibit_eval_during_redisplay
;
249 Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
252 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
255 Lisp_Object Qarrow
, Qhand
, Qtext
;
257 Lisp_Object Qrisky_local_variable
;
259 /* Holds the list (error). */
260 Lisp_Object list_of_error
;
262 /* Functions called to fontify regions of text. */
264 Lisp_Object Vfontification_functions
;
265 Lisp_Object Qfontification_functions
;
267 /* Non-nil means automatically select any window when the mouse
268 cursor moves into it. */
269 Lisp_Object Vmouse_autoselect_window
;
271 /* Non-zero means draw tool bar buttons raised when the mouse moves
274 int auto_raise_tool_bar_buttons_p
;
276 /* Non-zero means to reposition window if cursor line is only partially visible. */
278 int make_cursor_line_fully_visible_p
;
280 /* Margin below tool bar in pixels. 0 or nil means no margin.
281 If value is `internal-border-width' or `border-width',
282 the corresponding frame parameter is used. */
284 Lisp_Object Vtool_bar_border
;
286 /* Margin around tool bar buttons in pixels. */
288 Lisp_Object Vtool_bar_button_margin
;
290 /* Thickness of shadow to draw around tool bar buttons. */
292 EMACS_INT tool_bar_button_relief
;
294 /* Non-nil means automatically resize tool-bars so that all tool-bar
295 items are visible, and no blank lines remain.
297 If value is `grow-only', only make tool-bar bigger. */
299 Lisp_Object Vauto_resize_tool_bars
;
301 /* Non-zero means draw block and hollow cursor as wide as the glyph
302 under it. For example, if a block cursor is over a tab, it will be
303 drawn as wide as that tab on the display. */
305 int x_stretch_cursor_p
;
307 /* Non-nil means don't actually do any redisplay. */
309 Lisp_Object Vinhibit_redisplay
, Qinhibit_redisplay
;
311 /* Non-zero means Lisp evaluation during redisplay is inhibited. */
313 int inhibit_eval_during_redisplay
;
315 /* Names of text properties relevant for redisplay. */
317 Lisp_Object Qdisplay
;
318 extern Lisp_Object Qface
, Qinvisible
, Qwidth
;
320 /* Symbols used in text property values. */
322 Lisp_Object Vdisplay_pixels_per_inch
;
323 Lisp_Object Qspace
, QCalign_to
, QCrelative_width
, QCrelative_height
;
324 Lisp_Object Qleft_margin
, Qright_margin
, Qspace_width
, Qraise
;
327 Lisp_Object Qmargin
, Qpointer
;
328 Lisp_Object Qline_height
;
329 extern Lisp_Object Qheight
;
330 extern Lisp_Object QCwidth
, QCheight
, QCascent
;
331 extern Lisp_Object Qscroll_bar
;
332 extern Lisp_Object Qcursor
;
334 /* Non-nil means highlight trailing whitespace. */
336 Lisp_Object Vshow_trailing_whitespace
;
338 /* Non-nil means escape non-break space and hyphens. */
340 Lisp_Object Vnobreak_char_display
;
342 #ifdef HAVE_WINDOW_SYSTEM
343 extern Lisp_Object Voverflow_newline_into_fringe
;
345 /* Test if overflow newline into fringe. Called with iterator IT
346 at or past right window margin, and with IT->current_x set. */
348 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) \
349 (!NILP (Voverflow_newline_into_fringe) \
350 && FRAME_WINDOW_P (it->f) \
351 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) > 0 \
352 && it->current_x == it->last_visible_x)
354 #endif /* HAVE_WINDOW_SYSTEM */
356 /* Non-nil means show the text cursor in void text areas
357 i.e. in blank areas after eol and eob. This used to be
358 the default in 21.3. */
360 Lisp_Object Vvoid_text_area_pointer
;
362 /* Name of the face used to highlight trailing whitespace. */
364 Lisp_Object Qtrailing_whitespace
;
366 /* Name and number of the face used to highlight escape glyphs. */
368 Lisp_Object Qescape_glyph
;
370 /* Name and number of the face used to highlight non-breaking spaces. */
372 Lisp_Object Qnobreak_space
;
374 /* The symbol `image' which is the car of the lists used to represent
379 /* The image map types. */
380 Lisp_Object QCmap
, QCpointer
;
381 Lisp_Object Qrect
, Qcircle
, Qpoly
;
383 /* Non-zero means print newline to stdout before next mini-buffer
386 int noninteractive_need_newline
;
388 /* Non-zero means print newline to message log before next message. */
390 static int message_log_need_newline
;
392 /* Three markers that message_dolog uses.
393 It could allocate them itself, but that causes trouble
394 in handling memory-full errors. */
395 static Lisp_Object message_dolog_marker1
;
396 static Lisp_Object message_dolog_marker2
;
397 static Lisp_Object message_dolog_marker3
;
399 /* The buffer position of the first character appearing entirely or
400 partially on the line of the selected window which contains the
401 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
402 redisplay optimization in redisplay_internal. */
404 static struct text_pos this_line_start_pos
;
406 /* Number of characters past the end of the line above, including the
407 terminating newline. */
409 static struct text_pos this_line_end_pos
;
411 /* The vertical positions and the height of this line. */
413 static int this_line_vpos
;
414 static int this_line_y
;
415 static int this_line_pixel_height
;
417 /* X position at which this display line starts. Usually zero;
418 negative if first character is partially visible. */
420 static int this_line_start_x
;
422 /* Buffer that this_line_.* variables are referring to. */
424 static struct buffer
*this_line_buffer
;
426 /* Nonzero means truncate lines in all windows less wide than the
429 int truncate_partial_width_windows
;
431 /* A flag to control how to display unibyte 8-bit character. */
433 int unibyte_display_via_language_environment
;
435 /* Nonzero means we have more than one non-mini-buffer-only frame.
436 Not guaranteed to be accurate except while parsing
437 frame-title-format. */
441 Lisp_Object Vglobal_mode_string
;
444 /* List of variables (symbols) which hold markers for overlay arrows.
445 The symbols on this list are examined during redisplay to determine
446 where to display overlay arrows. */
448 Lisp_Object Voverlay_arrow_variable_list
;
450 /* Marker for where to display an arrow on top of the buffer text. */
452 Lisp_Object Voverlay_arrow_position
;
454 /* String to display for the arrow. Only used on terminal frames. */
456 Lisp_Object Voverlay_arrow_string
;
458 /* Values of those variables at last redisplay are stored as
459 properties on `overlay-arrow-position' symbol. However, if
460 Voverlay_arrow_position is a marker, last-arrow-position is its
461 numerical position. */
463 Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
465 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
466 properties on a symbol in overlay-arrow-variable-list. */
468 Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
470 /* Like mode-line-format, but for the title bar on a visible frame. */
472 Lisp_Object Vframe_title_format
;
474 /* Like mode-line-format, but for the title bar on an iconified frame. */
476 Lisp_Object Vicon_title_format
;
478 /* List of functions to call when a window's size changes. These
479 functions get one arg, a frame on which one or more windows' sizes
482 static Lisp_Object Vwindow_size_change_functions
;
484 Lisp_Object Qmenu_bar_update_hook
, Vmenu_bar_update_hook
;
486 /* Nonzero if an overlay arrow has been displayed in this window. */
488 static int overlay_arrow_seen
;
490 /* Nonzero means highlight the region even in nonselected windows. */
492 int highlight_nonselected_windows
;
494 /* If cursor motion alone moves point off frame, try scrolling this
495 many lines up or down if that will bring it back. */
497 static EMACS_INT scroll_step
;
499 /* Nonzero means scroll just far enough to bring point back on the
500 screen, when appropriate. */
502 static EMACS_INT scroll_conservatively
;
504 /* Recenter the window whenever point gets within this many lines of
505 the top or bottom of the window. This value is translated into a
506 pixel value by multiplying it with FRAME_LINE_HEIGHT, which means
507 that there is really a fixed pixel height scroll margin. */
509 EMACS_INT scroll_margin
;
511 /* Number of windows showing the buffer of the selected window (or
512 another buffer with the same base buffer). keyboard.c refers to
517 /* Vector containing glyphs for an ellipsis `...'. */
519 static Lisp_Object default_invis_vector
[3];
521 /* Zero means display the mode-line/header-line/menu-bar in the default face
522 (this slightly odd definition is for compatibility with previous versions
523 of emacs), non-zero means display them using their respective faces.
525 This variable is deprecated. */
527 int mode_line_inverse_video
;
529 /* Prompt to display in front of the mini-buffer contents. */
531 Lisp_Object minibuf_prompt
;
533 /* Width of current mini-buffer prompt. Only set after display_line
534 of the line that contains the prompt. */
536 int minibuf_prompt_width
;
538 /* This is the window where the echo area message was displayed. It
539 is always a mini-buffer window, but it may not be the same window
540 currently active as a mini-buffer. */
542 Lisp_Object echo_area_window
;
544 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
545 pushes the current message and the value of
546 message_enable_multibyte on the stack, the function restore_message
547 pops the stack and displays MESSAGE again. */
549 Lisp_Object Vmessage_stack
;
551 /* Nonzero means multibyte characters were enabled when the echo area
552 message was specified. */
554 int message_enable_multibyte
;
556 /* Nonzero if we should redraw the mode lines on the next redisplay. */
558 int update_mode_lines
;
560 /* Nonzero if window sizes or contents have changed since last
561 redisplay that finished. */
563 int windows_or_buffers_changed
;
565 /* Nonzero means a frame's cursor type has been changed. */
567 int cursor_type_changed
;
569 /* Nonzero after display_mode_line if %l was used and it displayed a
572 int line_number_displayed
;
574 /* Maximum buffer size for which to display line numbers. */
576 Lisp_Object Vline_number_display_limit
;
578 /* Line width to consider when repositioning for line number display. */
580 static EMACS_INT line_number_display_limit_width
;
582 /* Number of lines to keep in the message log buffer. t means
583 infinite. nil means don't log at all. */
585 Lisp_Object Vmessage_log_max
;
587 /* The name of the *Messages* buffer, a string. */
589 static Lisp_Object Vmessages_buffer_name
;
591 /* Current, index 0, and last displayed echo area message. Either
592 buffers from echo_buffers, or nil to indicate no message. */
594 Lisp_Object echo_area_buffer
[2];
596 /* The buffers referenced from echo_area_buffer. */
598 static Lisp_Object echo_buffer
[2];
600 /* A vector saved used in with_area_buffer to reduce consing. */
602 static Lisp_Object Vwith_echo_area_save_vector
;
604 /* Non-zero means display_echo_area should display the last echo area
605 message again. Set by redisplay_preserve_echo_area. */
607 static int display_last_displayed_message_p
;
609 /* Nonzero if echo area is being used by print; zero if being used by
612 int message_buf_print
;
614 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
616 Lisp_Object Qinhibit_menubar_update
;
617 int inhibit_menubar_update
;
619 /* When evaluating expressions from menu bar items (enable conditions,
620 for instance), this is the frame they are being processed for. */
622 Lisp_Object Vmenu_updating_frame
;
624 /* Maximum height for resizing mini-windows. Either a float
625 specifying a fraction of the available height, or an integer
626 specifying a number of lines. */
628 Lisp_Object Vmax_mini_window_height
;
630 /* Non-zero means messages should be displayed with truncated
631 lines instead of being continued. */
633 int message_truncate_lines
;
634 Lisp_Object Qmessage_truncate_lines
;
636 /* Set to 1 in clear_message to make redisplay_internal aware
637 of an emptied echo area. */
639 static int message_cleared_p
;
641 /* How to blink the default frame cursor off. */
642 Lisp_Object Vblink_cursor_alist
;
644 /* A scratch glyph row with contents used for generating truncation
645 glyphs. Also used in direct_output_for_insert. */
647 #define MAX_SCRATCH_GLYPHS 100
648 struct glyph_row scratch_glyph_row
;
649 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
651 /* Ascent and height of the last line processed by move_it_to. */
653 static int last_max_ascent
, last_height
;
655 /* Non-zero if there's a help-echo in the echo area. */
657 int help_echo_showing_p
;
659 /* If >= 0, computed, exact values of mode-line and header-line height
660 to use in the macros CURRENT_MODE_LINE_HEIGHT and
661 CURRENT_HEADER_LINE_HEIGHT. */
663 int current_mode_line_height
, current_header_line_height
;
665 /* The maximum distance to look ahead for text properties. Values
666 that are too small let us call compute_char_face and similar
667 functions too often which is expensive. Values that are too large
668 let us call compute_char_face and alike too often because we
669 might not be interested in text properties that far away. */
671 #define TEXT_PROP_DISTANCE_LIMIT 100
675 /* Variables to turn off display optimizations from Lisp. */
677 int inhibit_try_window_id
, inhibit_try_window_reusing
;
678 int inhibit_try_cursor_movement
;
680 /* Non-zero means print traces of redisplay if compiled with
683 int trace_redisplay_p
;
685 #endif /* GLYPH_DEBUG */
687 #ifdef DEBUG_TRACE_MOVE
688 /* Non-zero means trace with TRACE_MOVE to stderr. */
691 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
693 #define TRACE_MOVE(x) (void) 0
696 /* Non-zero means automatically scroll windows horizontally to make
699 int automatic_hscrolling_p
;
700 Lisp_Object Qauto_hscroll_mode
;
702 /* How close to the margin can point get before the window is scrolled
704 EMACS_INT hscroll_margin
;
706 /* How much to scroll horizontally when point is inside the above margin. */
707 Lisp_Object Vhscroll_step
;
709 /* The variable `resize-mini-windows'. If nil, don't resize
710 mini-windows. If t, always resize them to fit the text they
711 display. If `grow-only', let mini-windows grow only until they
714 Lisp_Object Vresize_mini_windows
;
716 /* Buffer being redisplayed -- for redisplay_window_error. */
718 struct buffer
*displayed_buffer
;
720 /* Space between overline and text. */
722 EMACS_INT overline_margin
;
724 /* Value returned from text property handlers (see below). */
729 HANDLED_RECOMPUTE_PROPS
,
730 HANDLED_OVERLAY_STRING_CONSUMED
,
734 /* A description of text properties that redisplay is interested
739 /* The name of the property. */
742 /* A unique index for the property. */
745 /* A handler function called to set up iterator IT from the property
746 at IT's current position. Value is used to steer handle_stop. */
747 enum prop_handled (*handler
) P_ ((struct it
*it
));
750 static enum prop_handled handle_face_prop
P_ ((struct it
*));
751 static enum prop_handled handle_invisible_prop
P_ ((struct it
*));
752 static enum prop_handled handle_display_prop
P_ ((struct it
*));
753 static enum prop_handled handle_composition_prop
P_ ((struct it
*));
754 static enum prop_handled handle_overlay_change
P_ ((struct it
*));
755 static enum prop_handled handle_fontified_prop
P_ ((struct it
*));
756 static enum prop_handled handle_auto_composed_prop
P_ ((struct it
*));
758 /* Properties handled by iterators. */
760 static struct props it_props
[] =
762 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
763 /* Handle `face' before `display' because some sub-properties of
764 `display' need to know the face. */
765 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
766 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
767 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
768 {&Qauto_composed
, AUTO_COMPOSED_PROP_IDX
, handle_auto_composed_prop
},
769 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
773 /* Value is the position described by X. If X is a marker, value is
774 the marker_position of X. Otherwise, value is X. */
776 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
778 /* Enumeration returned by some move_it_.* functions internally. */
782 /* Not used. Undefined value. */
785 /* Move ended at the requested buffer position or ZV. */
786 MOVE_POS_MATCH_OR_ZV
,
788 /* Move ended at the requested X pixel position. */
791 /* Move within a line ended at the end of a line that must be
795 /* Move within a line ended at the end of a line that would
796 be displayed truncated. */
799 /* Move within a line ended at a line end. */
803 /* This counter is used to clear the face cache every once in a while
804 in redisplay_internal. It is incremented for each redisplay.
805 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
808 #define CLEAR_FACE_CACHE_COUNT 500
809 static int clear_face_cache_count
;
811 /* Similarly for the image cache. */
813 #ifdef HAVE_WINDOW_SYSTEM
814 #define CLEAR_IMAGE_CACHE_COUNT 101
815 static int clear_image_cache_count
;
818 /* Non-zero while redisplay_internal is in progress. */
822 /* Non-zero means don't free realized faces. Bound while freeing
823 realized faces is dangerous because glyph matrices might still
826 int inhibit_free_realized_faces
;
827 Lisp_Object Qinhibit_free_realized_faces
;
829 /* If a string, XTread_socket generates an event to display that string.
830 (The display is done in read_char.) */
832 Lisp_Object help_echo_string
;
833 Lisp_Object help_echo_window
;
834 Lisp_Object help_echo_object
;
837 /* Temporary variable for XTread_socket. */
839 Lisp_Object previous_help_echo_string
;
841 /* Null glyph slice */
843 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
846 /* Function prototypes. */
848 static void setup_for_ellipsis
P_ ((struct it
*, int));
849 static void mark_window_display_accurate_1
P_ ((struct window
*, int));
850 static int single_display_spec_string_p
P_ ((Lisp_Object
, Lisp_Object
));
851 static int display_prop_string_p
P_ ((Lisp_Object
, Lisp_Object
));
852 static int cursor_row_p
P_ ((struct window
*, struct glyph_row
*));
853 static int redisplay_mode_lines
P_ ((Lisp_Object
, int));
854 static char *decode_mode_spec_coding
P_ ((Lisp_Object
, char *, int));
857 static int invisible_text_between_p
P_ ((struct it
*, int, int));
860 static void pint2str
P_ ((char *, int, int));
861 static void pint2hrstr
P_ ((char *, int, int));
862 static struct text_pos run_window_scroll_functions
P_ ((Lisp_Object
,
864 static void reconsider_clip_changes
P_ ((struct window
*, struct buffer
*));
865 static int text_outside_line_unchanged_p
P_ ((struct window
*, int, int));
866 static void store_mode_line_noprop_char
P_ ((char));
867 static int store_mode_line_noprop
P_ ((const unsigned char *, int, int));
868 static void x_consider_frame_title
P_ ((Lisp_Object
));
869 static void handle_stop
P_ ((struct it
*));
870 static int tool_bar_lines_needed
P_ ((struct frame
*, int *));
871 static int single_display_spec_intangible_p
P_ ((Lisp_Object
));
872 static void ensure_echo_area_buffers
P_ ((void));
873 static Lisp_Object unwind_with_echo_area_buffer
P_ ((Lisp_Object
));
874 static Lisp_Object with_echo_area_buffer_unwind_data
P_ ((struct window
*));
875 static int with_echo_area_buffer
P_ ((struct window
*, int,
876 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
877 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
878 static void clear_garbaged_frames
P_ ((void));
879 static int current_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
880 static int truncate_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
881 static int set_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
882 static int display_echo_area
P_ ((struct window
*));
883 static int display_echo_area_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
884 static int resize_mini_window_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
885 static Lisp_Object unwind_redisplay
P_ ((Lisp_Object
));
886 static int string_char_and_length
P_ ((const unsigned char *, int, int *));
887 static struct text_pos display_prop_end
P_ ((struct it
*, Lisp_Object
,
889 static int compute_window_start_on_continuation_line
P_ ((struct window
*));
890 static Lisp_Object safe_eval_handler
P_ ((Lisp_Object
));
891 static void insert_left_trunc_glyphs
P_ ((struct it
*));
892 static struct glyph_row
*get_overlay_arrow_glyph_row
P_ ((struct window
*,
894 static void extend_face_to_end_of_line
P_ ((struct it
*));
895 static int append_space_for_newline
P_ ((struct it
*, int));
896 static int cursor_row_fully_visible_p
P_ ((struct window
*, int, int));
897 static int try_scrolling
P_ ((Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int));
898 static int try_cursor_movement
P_ ((Lisp_Object
, struct text_pos
, int *));
899 static int trailing_whitespace_p
P_ ((int));
900 static int message_log_check_duplicate
P_ ((int, int, int, int));
901 static void push_it
P_ ((struct it
*));
902 static void pop_it
P_ ((struct it
*));
903 static void sync_frame_with_window_matrix_rows
P_ ((struct window
*));
904 static void select_frame_for_redisplay
P_ ((Lisp_Object
));
905 static void redisplay_internal
P_ ((int));
906 static int echo_area_display
P_ ((int));
907 static void redisplay_windows
P_ ((Lisp_Object
));
908 static void redisplay_window
P_ ((Lisp_Object
, int));
909 static Lisp_Object
redisplay_window_error ();
910 static Lisp_Object redisplay_window_0
P_ ((Lisp_Object
));
911 static Lisp_Object redisplay_window_1
P_ ((Lisp_Object
));
912 static int update_menu_bar
P_ ((struct frame
*, int, int));
913 static int try_window_reusing_current_matrix
P_ ((struct window
*));
914 static int try_window_id
P_ ((struct window
*));
915 static int display_line
P_ ((struct it
*));
916 static int display_mode_lines
P_ ((struct window
*));
917 static int display_mode_line
P_ ((struct window
*, enum face_id
, Lisp_Object
));
918 static int display_mode_element
P_ ((struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int));
919 static int store_mode_line_string
P_ ((char *, Lisp_Object
, int, int, int, Lisp_Object
));
920 static char *decode_mode_spec
P_ ((struct window
*, int, int, int, int *));
921 static void display_menu_bar
P_ ((struct window
*));
922 static int display_count_lines
P_ ((int, int, int, int, int *));
923 static int display_string
P_ ((unsigned char *, Lisp_Object
, Lisp_Object
,
924 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int));
925 static void compute_line_metrics
P_ ((struct it
*));
926 static void run_redisplay_end_trigger_hook
P_ ((struct it
*));
927 static int get_overlay_strings
P_ ((struct it
*, int));
928 static int get_overlay_strings_1
P_ ((struct it
*, int, int));
929 static void next_overlay_string
P_ ((struct it
*));
930 static void reseat
P_ ((struct it
*, struct text_pos
, int));
931 static void reseat_1
P_ ((struct it
*, struct text_pos
, int));
932 static void back_to_previous_visible_line_start
P_ ((struct it
*));
933 void reseat_at_previous_visible_line_start
P_ ((struct it
*));
934 static void reseat_at_next_visible_line_start
P_ ((struct it
*, int));
935 static int next_element_from_ellipsis
P_ ((struct it
*));
936 static int next_element_from_display_vector
P_ ((struct it
*));
937 static int next_element_from_string
P_ ((struct it
*));
938 static int next_element_from_c_string
P_ ((struct it
*));
939 static int next_element_from_buffer
P_ ((struct it
*));
940 static int next_element_from_composition
P_ ((struct it
*));
941 static int next_element_from_image
P_ ((struct it
*));
942 static int next_element_from_stretch
P_ ((struct it
*));
943 static void load_overlay_strings
P_ ((struct it
*, int));
944 static int init_from_display_pos
P_ ((struct it
*, struct window
*,
945 struct display_pos
*));
946 static void reseat_to_string
P_ ((struct it
*, unsigned char *,
947 Lisp_Object
, int, int, int, int));
948 static enum move_it_result move_it_in_display_line_to
P_ ((struct it
*,
950 void move_it_vertically_backward
P_ ((struct it
*, int));
951 static void init_to_row_start
P_ ((struct it
*, struct window
*,
952 struct glyph_row
*));
953 static int init_to_row_end
P_ ((struct it
*, struct window
*,
954 struct glyph_row
*));
955 static void back_to_previous_line_start
P_ ((struct it
*));
956 static int forward_to_next_line_start
P_ ((struct it
*, int *));
957 static struct text_pos string_pos_nchars_ahead
P_ ((struct text_pos
,
959 static struct text_pos string_pos
P_ ((int, Lisp_Object
));
960 static struct text_pos c_string_pos
P_ ((int, unsigned char *, int));
961 static int number_of_chars
P_ ((unsigned char *, int));
962 static void compute_stop_pos
P_ ((struct it
*));
963 static void compute_string_pos
P_ ((struct text_pos
*, struct text_pos
,
965 static int face_before_or_after_it_pos
P_ ((struct it
*, int));
966 static EMACS_INT next_overlay_change
P_ ((EMACS_INT
));
967 static int handle_single_display_spec
P_ ((struct it
*, Lisp_Object
,
968 Lisp_Object
, Lisp_Object
,
969 struct text_pos
*, int));
970 static int underlying_face_id
P_ ((struct it
*));
971 static int in_ellipses_for_invisible_text_p
P_ ((struct display_pos
*,
974 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
975 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
977 #ifdef HAVE_WINDOW_SYSTEM
979 static void update_tool_bar
P_ ((struct frame
*, int));
980 static void build_desired_tool_bar_string
P_ ((struct frame
*f
));
981 static int redisplay_tool_bar
P_ ((struct frame
*));
982 static void display_tool_bar_line
P_ ((struct it
*, int));
983 static void notice_overwritten_cursor
P_ ((struct window
*,
985 int, int, int, int));
989 #endif /* HAVE_WINDOW_SYSTEM */
992 /***********************************************************************
993 Window display dimensions
994 ***********************************************************************/
996 /* Return the bottom boundary y-position for text lines in window W.
997 This is the first y position at which a line cannot start.
998 It is relative to the top of the window.
1000 This is the height of W minus the height of a mode line, if any. */
1003 window_text_bottom_y (w
)
1006 int height
= WINDOW_TOTAL_HEIGHT (w
);
1008 if (WINDOW_WANTS_MODELINE_P (w
))
1009 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
1013 /* Return the pixel width of display area AREA of window W. AREA < 0
1014 means return the total width of W, not including fringes to
1015 the left and right of the window. */
1018 window_box_width (w
, area
)
1022 int cols
= XFASTINT (w
->total_cols
);
1025 if (!w
->pseudo_window_p
)
1027 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
1029 if (area
== TEXT_AREA
)
1031 if (INTEGERP (w
->left_margin_cols
))
1032 cols
-= XFASTINT (w
->left_margin_cols
);
1033 if (INTEGERP (w
->right_margin_cols
))
1034 cols
-= XFASTINT (w
->right_margin_cols
);
1035 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
1037 else if (area
== LEFT_MARGIN_AREA
)
1039 cols
= (INTEGERP (w
->left_margin_cols
)
1040 ? XFASTINT (w
->left_margin_cols
) : 0);
1043 else if (area
== RIGHT_MARGIN_AREA
)
1045 cols
= (INTEGERP (w
->right_margin_cols
)
1046 ? XFASTINT (w
->right_margin_cols
) : 0);
1051 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1055 /* Return the pixel height of the display area of window W, not
1056 including mode lines of W, if any. */
1059 window_box_height (w
)
1062 struct frame
*f
= XFRAME (w
->frame
);
1063 int height
= WINDOW_TOTAL_HEIGHT (w
);
1065 xassert (height
>= 0);
1067 /* Note: the code below that determines the mode-line/header-line
1068 height is essentially the same as that contained in the macro
1069 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1070 the appropriate glyph row has its `mode_line_p' flag set,
1071 and if it doesn't, uses estimate_mode_line_height instead. */
1073 if (WINDOW_WANTS_MODELINE_P (w
))
1075 struct glyph_row
*ml_row
1076 = (w
->current_matrix
&& w
->current_matrix
->rows
1077 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1079 if (ml_row
&& ml_row
->mode_line_p
)
1080 height
-= ml_row
->height
;
1082 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1085 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1087 struct glyph_row
*hl_row
1088 = (w
->current_matrix
&& w
->current_matrix
->rows
1089 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1091 if (hl_row
&& hl_row
->mode_line_p
)
1092 height
-= hl_row
->height
;
1094 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1097 /* With a very small font and a mode-line that's taller than
1098 default, we might end up with a negative height. */
1099 return max (0, height
);
1102 /* Return the window-relative coordinate of the left edge of display
1103 area AREA of window W. AREA < 0 means return the left edge of the
1104 whole window, to the right of the left fringe of W. */
1107 window_box_left_offset (w
, area
)
1113 if (w
->pseudo_window_p
)
1116 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1118 if (area
== TEXT_AREA
)
1119 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1120 + window_box_width (w
, LEFT_MARGIN_AREA
));
1121 else if (area
== RIGHT_MARGIN_AREA
)
1122 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1123 + window_box_width (w
, LEFT_MARGIN_AREA
)
1124 + window_box_width (w
, TEXT_AREA
)
1125 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1127 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1128 else if (area
== LEFT_MARGIN_AREA
1129 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1130 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1136 /* Return the window-relative coordinate of the right edge of display
1137 area AREA of window W. AREA < 0 means return the left edge of the
1138 whole window, to the left of the right fringe of W. */
1141 window_box_right_offset (w
, area
)
1145 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1148 /* Return the frame-relative coordinate of the left edge of display
1149 area AREA of window W. AREA < 0 means return the left edge of the
1150 whole window, to the right of the left fringe of W. */
1153 window_box_left (w
, area
)
1157 struct frame
*f
= XFRAME (w
->frame
);
1160 if (w
->pseudo_window_p
)
1161 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1163 x
= (WINDOW_LEFT_EDGE_X (w
)
1164 + window_box_left_offset (w
, area
));
1170 /* Return the frame-relative coordinate of the right edge of display
1171 area AREA of window W. AREA < 0 means return the left edge of the
1172 whole window, to the left of the right fringe of W. */
1175 window_box_right (w
, area
)
1179 return window_box_left (w
, area
) + window_box_width (w
, area
);
1182 /* Get the bounding box of the display area AREA of window W, without
1183 mode lines, in frame-relative coordinates. AREA < 0 means the
1184 whole window, not including the left and right fringes of
1185 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1186 coordinates of the upper-left corner of the box. Return in
1187 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1190 window_box (w
, area
, box_x
, box_y
, box_width
, box_height
)
1193 int *box_x
, *box_y
, *box_width
, *box_height
;
1196 *box_width
= window_box_width (w
, area
);
1198 *box_height
= window_box_height (w
);
1200 *box_x
= window_box_left (w
, area
);
1203 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1204 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1205 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1210 /* Get the bounding box of the display area AREA of window W, without
1211 mode lines. AREA < 0 means the whole window, not including the
1212 left and right fringe of the window. Return in *TOP_LEFT_X
1213 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1214 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1215 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1219 window_box_edges (w
, area
, top_left_x
, top_left_y
,
1220 bottom_right_x
, bottom_right_y
)
1223 int *top_left_x
, *top_left_y
, *bottom_right_x
, *bottom_right_y
;
1225 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1227 *bottom_right_x
+= *top_left_x
;
1228 *bottom_right_y
+= *top_left_y
;
1233 /***********************************************************************
1235 ***********************************************************************/
1237 /* Return the bottom y-position of the line the iterator IT is in.
1238 This can modify IT's settings. */
1244 int line_height
= it
->max_ascent
+ it
->max_descent
;
1245 int line_top_y
= it
->current_y
;
1247 if (line_height
== 0)
1250 line_height
= last_height
;
1251 else if (IT_CHARPOS (*it
) < ZV
)
1253 move_it_by_lines (it
, 1, 1);
1254 line_height
= (it
->max_ascent
|| it
->max_descent
1255 ? it
->max_ascent
+ it
->max_descent
1260 struct glyph_row
*row
= it
->glyph_row
;
1262 /* Use the default character height. */
1263 it
->glyph_row
= NULL
;
1264 it
->what
= IT_CHARACTER
;
1267 PRODUCE_GLYPHS (it
);
1268 line_height
= it
->ascent
+ it
->descent
;
1269 it
->glyph_row
= row
;
1273 return line_top_y
+ line_height
;
1277 /* Return 1 if position CHARPOS is visible in window W.
1278 CHARPOS < 0 means return info about WINDOW_END position.
1279 If visible, set *X and *Y to pixel coordinates of top left corner.
1280 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1281 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1284 pos_visible_p (w
, charpos
, x
, y
, rtop
, rbot
, rowh
, vpos
)
1286 int charpos
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
;
1289 struct text_pos top
;
1291 struct buffer
*old_buffer
= NULL
;
1296 if (XBUFFER (w
->buffer
) != current_buffer
)
1298 old_buffer
= current_buffer
;
1299 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1302 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1304 /* Compute exact mode line heights. */
1305 if (WINDOW_WANTS_MODELINE_P (w
))
1306 current_mode_line_height
1307 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1308 current_buffer
->mode_line_format
);
1310 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1311 current_header_line_height
1312 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1313 current_buffer
->header_line_format
);
1315 start_display (&it
, w
, top
);
1316 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1317 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1319 /* Note that we may overshoot because of invisible text. */
1320 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1322 int top_x
= it
.current_x
;
1323 int top_y
= it
.current_y
;
1324 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1325 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1327 if (top_y
< window_top_y
)
1328 visible_p
= bottom_y
> window_top_y
;
1329 else if (top_y
< it
.last_visible_y
)
1333 Lisp_Object window
, prop
;
1335 XSETWINDOW (window
, w
);
1336 prop
= Fget_char_property (make_number (it
.position
.charpos
),
1337 Qinvisible
, window
);
1339 /* If charpos coincides with invisible text covered with an
1340 ellipsis, use the first glyph of the ellipsis to compute
1341 the pixel positions. */
1342 if (TEXT_PROP_MEANS_INVISIBLE (prop
) == 2)
1344 struct glyph_row
*row
= it
.glyph_row
;
1345 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1346 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1349 for (; glyph
< end
&& glyph
->charpos
< charpos
; glyph
++)
1350 x
+= glyph
->pixel_width
;
1356 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1357 *rtop
= max (0, window_top_y
- top_y
);
1358 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1359 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1360 - max (top_y
, window_top_y
)));
1369 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1370 move_it_by_lines (&it
, 1, 0);
1371 if (charpos
< IT_CHARPOS (it
)
1372 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1375 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1377 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1378 *rtop
= max (0, -it2
.current_y
);
1379 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1380 - it
.last_visible_y
));
1381 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1383 - max (it2
.current_y
,
1384 WINDOW_HEADER_LINE_HEIGHT (w
))));
1390 set_buffer_internal_1 (old_buffer
);
1392 current_header_line_height
= current_mode_line_height
= -1;
1394 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1395 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1398 /* Debugging code. */
1400 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1401 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1403 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1410 /* Return the next character from STR which is MAXLEN bytes long.
1411 Return in *LEN the length of the character. This is like
1412 STRING_CHAR_AND_LENGTH but never returns an invalid character. If
1413 we find one, we return a `?', but with the length of the invalid
1417 string_char_and_length (str
, maxlen
, len
)
1418 const unsigned char *str
;
1423 c
= STRING_CHAR_AND_LENGTH (str
, maxlen
, *len
);
1424 if (!CHAR_VALID_P (c
, 1))
1425 /* We may not change the length here because other places in Emacs
1426 don't use this function, i.e. they silently accept invalid
1435 /* Given a position POS containing a valid character and byte position
1436 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1438 static struct text_pos
1439 string_pos_nchars_ahead (pos
, string
, nchars
)
1440 struct text_pos pos
;
1444 xassert (STRINGP (string
) && nchars
>= 0);
1446 if (STRING_MULTIBYTE (string
))
1448 int rest
= SBYTES (string
) - BYTEPOS (pos
);
1449 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1454 string_char_and_length (p
, rest
, &len
);
1455 p
+= len
, rest
-= len
;
1456 xassert (rest
>= 0);
1458 BYTEPOS (pos
) += len
;
1462 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1468 /* Value is the text position, i.e. character and byte position,
1469 for character position CHARPOS in STRING. */
1471 static INLINE
struct text_pos
1472 string_pos (charpos
, string
)
1476 struct text_pos pos
;
1477 xassert (STRINGP (string
));
1478 xassert (charpos
>= 0);
1479 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1484 /* Value is a text position, i.e. character and byte position, for
1485 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1486 means recognize multibyte characters. */
1488 static struct text_pos
1489 c_string_pos (charpos
, s
, multibyte_p
)
1494 struct text_pos pos
;
1496 xassert (s
!= NULL
);
1497 xassert (charpos
>= 0);
1501 int rest
= strlen (s
), len
;
1503 SET_TEXT_POS (pos
, 0, 0);
1506 string_char_and_length (s
, rest
, &len
);
1507 s
+= len
, rest
-= len
;
1508 xassert (rest
>= 0);
1510 BYTEPOS (pos
) += len
;
1514 SET_TEXT_POS (pos
, charpos
, charpos
);
1520 /* Value is the number of characters in C string S. MULTIBYTE_P
1521 non-zero means recognize multibyte characters. */
1524 number_of_chars (s
, multibyte_p
)
1532 int rest
= strlen (s
), len
;
1533 unsigned char *p
= (unsigned char *) s
;
1535 for (nchars
= 0; rest
> 0; ++nchars
)
1537 string_char_and_length (p
, rest
, &len
);
1538 rest
-= len
, p
+= len
;
1542 nchars
= strlen (s
);
1548 /* Compute byte position NEWPOS->bytepos corresponding to
1549 NEWPOS->charpos. POS is a known position in string STRING.
1550 NEWPOS->charpos must be >= POS.charpos. */
1553 compute_string_pos (newpos
, pos
, string
)
1554 struct text_pos
*newpos
, pos
;
1557 xassert (STRINGP (string
));
1558 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1560 if (STRING_MULTIBYTE (string
))
1561 *newpos
= string_pos_nchars_ahead (pos
, string
,
1562 CHARPOS (*newpos
) - CHARPOS (pos
));
1564 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1568 Return an estimation of the pixel height of mode or top lines on
1569 frame F. FACE_ID specifies what line's height to estimate. */
1572 estimate_mode_line_height (f
, face_id
)
1574 enum face_id face_id
;
1576 #ifdef HAVE_WINDOW_SYSTEM
1577 if (FRAME_WINDOW_P (f
))
1579 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1581 /* This function is called so early when Emacs starts that the face
1582 cache and mode line face are not yet initialized. */
1583 if (FRAME_FACE_CACHE (f
))
1585 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1589 height
= FONT_HEIGHT (face
->font
);
1590 if (face
->box_line_width
> 0)
1591 height
+= 2 * face
->box_line_width
;
1602 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1603 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1604 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1605 not force the value into range. */
1608 pixel_to_glyph_coords (f
, pix_x
, pix_y
, x
, y
, bounds
, noclip
)
1610 register int pix_x
, pix_y
;
1612 NativeRectangle
*bounds
;
1616 #ifdef HAVE_WINDOW_SYSTEM
1617 if (FRAME_WINDOW_P (f
))
1619 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1620 even for negative values. */
1622 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1624 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1626 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1627 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1630 STORE_NATIVE_RECT (*bounds
,
1631 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1632 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1633 FRAME_COLUMN_WIDTH (f
) - 1,
1634 FRAME_LINE_HEIGHT (f
) - 1);
1640 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1641 pix_x
= FRAME_TOTAL_COLS (f
);
1645 else if (pix_y
> FRAME_LINES (f
))
1646 pix_y
= FRAME_LINES (f
);
1656 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1657 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1658 can't tell the positions because W's display is not up to date,
1662 glyph_to_pixel_coords (w
, hpos
, vpos
, frame_x
, frame_y
)
1665 int *frame_x
, *frame_y
;
1667 #ifdef HAVE_WINDOW_SYSTEM
1668 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1672 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1673 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1675 if (display_completed
)
1677 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1678 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1679 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1685 hpos
+= glyph
->pixel_width
;
1689 /* If first glyph is partially visible, its first visible position is still 0. */
1701 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1702 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1713 #ifdef HAVE_WINDOW_SYSTEM
1715 /* Find the glyph under window-relative coordinates X/Y in window W.
1716 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1717 strings. Return in *HPOS and *VPOS the row and column number of
1718 the glyph found. Return in *AREA the glyph area containing X.
1719 Value is a pointer to the glyph found or null if X/Y is not on
1720 text, or we can't tell because W's current matrix is not up to
1723 static struct glyph
*
1724 x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, dx
, dy
, area
)
1727 int *hpos
, *vpos
, *dx
, *dy
, *area
;
1729 struct glyph
*glyph
, *end
;
1730 struct glyph_row
*row
= NULL
;
1733 /* Find row containing Y. Give up if some row is not enabled. */
1734 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1736 row
= MATRIX_ROW (w
->current_matrix
, i
);
1737 if (!row
->enabled_p
)
1739 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1746 /* Give up if Y is not in the window. */
1747 if (i
== w
->current_matrix
->nrows
)
1750 /* Get the glyph area containing X. */
1751 if (w
->pseudo_window_p
)
1758 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1760 *area
= LEFT_MARGIN_AREA
;
1761 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1763 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1766 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1770 *area
= RIGHT_MARGIN_AREA
;
1771 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1775 /* Find glyph containing X. */
1776 glyph
= row
->glyphs
[*area
];
1777 end
= glyph
+ row
->used
[*area
];
1779 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1781 x
-= glyph
->pixel_width
;
1791 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1794 *hpos
= glyph
- row
->glyphs
[*area
];
1800 Convert frame-relative x/y to coordinates relative to window W.
1801 Takes pseudo-windows into account. */
1804 frame_to_window_pixel_xy (w
, x
, y
)
1808 if (w
->pseudo_window_p
)
1810 /* A pseudo-window is always full-width, and starts at the
1811 left edge of the frame, plus a frame border. */
1812 struct frame
*f
= XFRAME (w
->frame
);
1813 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1814 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1818 *x
-= WINDOW_LEFT_EDGE_X (w
);
1819 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1824 Return in RECTS[] at most N clipping rectangles for glyph string S.
1825 Return the number of stored rectangles. */
1828 get_glyph_string_clip_rects (s
, rects
, n
)
1829 struct glyph_string
*s
;
1830 NativeRectangle
*rects
;
1838 if (s
->row
->full_width_p
)
1840 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1841 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1842 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1844 /* Unless displaying a mode or menu bar line, which are always
1845 fully visible, clip to the visible part of the row. */
1846 if (s
->w
->pseudo_window_p
)
1847 r
.height
= s
->row
->visible_height
;
1849 r
.height
= s
->height
;
1853 /* This is a text line that may be partially visible. */
1854 r
.x
= window_box_left (s
->w
, s
->area
);
1855 r
.width
= window_box_width (s
->w
, s
->area
);
1856 r
.height
= s
->row
->visible_height
;
1860 if (r
.x
< s
->clip_head
->x
)
1862 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1863 r
.width
-= s
->clip_head
->x
- r
.x
;
1866 r
.x
= s
->clip_head
->x
;
1869 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1871 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1872 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1877 /* If S draws overlapping rows, it's sufficient to use the top and
1878 bottom of the window for clipping because this glyph string
1879 intentionally draws over other lines. */
1880 if (s
->for_overlaps
)
1882 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1883 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1885 /* Alas, the above simple strategy does not work for the
1886 environments with anti-aliased text: if the same text is
1887 drawn onto the same place multiple times, it gets thicker.
1888 If the overlap we are processing is for the erased cursor, we
1889 take the intersection with the rectagle of the cursor. */
1890 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1892 XRectangle rc
, r_save
= r
;
1894 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1895 rc
.y
= s
->w
->phys_cursor
.y
;
1896 rc
.width
= s
->w
->phys_cursor_width
;
1897 rc
.height
= s
->w
->phys_cursor_height
;
1899 x_intersect_rectangles (&r_save
, &rc
, &r
);
1904 /* Don't use S->y for clipping because it doesn't take partially
1905 visible lines into account. For example, it can be negative for
1906 partially visible lines at the top of a window. */
1907 if (!s
->row
->full_width_p
1908 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1909 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1911 r
.y
= max (0, s
->row
->y
);
1913 /* If drawing a tool-bar window, draw it over the internal border
1914 at the top of the window. */
1915 if (WINDOWP (s
->f
->tool_bar_window
)
1916 && s
->w
== XWINDOW (s
->f
->tool_bar_window
))
1917 r
.y
-= FRAME_INTERNAL_BORDER_WIDTH (s
->f
);
1920 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1922 /* If drawing the cursor, don't let glyph draw outside its
1923 advertised boundaries. Cleartype does this under some circumstances. */
1924 if (s
->hl
== DRAW_CURSOR
)
1926 struct glyph
*glyph
= s
->first_glyph
;
1931 r
.width
-= s
->x
- r
.x
;
1934 r
.width
= min (r
.width
, glyph
->pixel_width
);
1936 /* If r.y is below window bottom, ensure that we still see a cursor. */
1937 height
= min (glyph
->ascent
+ glyph
->descent
,
1938 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1939 max_y
= window_text_bottom_y (s
->w
) - height
;
1940 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1941 if (s
->ybase
- glyph
->ascent
> max_y
)
1948 /* Don't draw cursor glyph taller than our actual glyph. */
1949 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1950 if (height
< r
.height
)
1952 max_y
= r
.y
+ r
.height
;
1953 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1954 r
.height
= min (max_y
- r
.y
, height
);
1961 XRectangle r_save
= r
;
1963 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1967 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1968 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1970 #ifdef CONVERT_FROM_XRECT
1971 CONVERT_FROM_XRECT (r
, *rects
);
1979 /* If we are processing overlapping and allowed to return
1980 multiple clipping rectangles, we exclude the row of the glyph
1981 string from the clipping rectangle. This is to avoid drawing
1982 the same text on the environment with anti-aliasing. */
1983 #ifdef CONVERT_FROM_XRECT
1986 XRectangle
*rs
= rects
;
1988 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
1990 if (s
->for_overlaps
& OVERLAPS_PRED
)
1993 if (r
.y
+ r
.height
> row_y
)
1996 rs
[i
].height
= row_y
- r
.y
;
2002 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2005 if (r
.y
< row_y
+ s
->row
->visible_height
)
2007 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2009 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2010 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2019 #ifdef CONVERT_FROM_XRECT
2020 for (i
= 0; i
< n
; i
++)
2021 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2028 Return in *NR the clipping rectangle for glyph string S. */
2031 get_glyph_string_clip_rect (s
, nr
)
2032 struct glyph_string
*s
;
2033 NativeRectangle
*nr
;
2035 get_glyph_string_clip_rects (s
, nr
, 1);
2040 Return the position and height of the phys cursor in window W.
2041 Set w->phys_cursor_width to width of phys cursor.
2045 get_phys_cursor_geometry (w
, row
, glyph
, xp
, yp
, heightp
)
2047 struct glyph_row
*row
;
2048 struct glyph
*glyph
;
2049 int *xp
, *yp
, *heightp
;
2051 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2052 int x
, y
, wd
, h
, h0
, y0
;
2054 /* Compute the width of the rectangle to draw. If on a stretch
2055 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2056 rectangle as wide as the glyph, but use a canonical character
2058 wd
= glyph
->pixel_width
- 1;
2063 x
= w
->phys_cursor
.x
;
2070 if (glyph
->type
== STRETCH_GLYPH
2071 && !x_stretch_cursor_p
)
2072 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2073 w
->phys_cursor_width
= wd
;
2075 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2077 /* If y is below window bottom, ensure that we still see a cursor. */
2078 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2080 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2081 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2083 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2086 h
= max (h
- (y0
- y
) + 1, h0
);
2091 y0
= window_text_bottom_y (w
) - h0
;
2099 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2100 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2105 * Remember which glyph the mouse is over.
2109 remember_mouse_glyph (f
, gx
, gy
, rect
)
2112 NativeRectangle
*rect
;
2116 struct glyph_row
*r
, *gr
, *end_row
;
2117 enum window_part part
;
2118 enum glyph_row_area area
;
2119 int x
, y
, width
, height
;
2121 /* Try to determine frame pixel position and size of the glyph under
2122 frame pixel coordinates X/Y on frame F. */
2124 if (!f
->glyphs_initialized_p
2125 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, &x
, &y
, 0),
2128 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2129 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2133 w
= XWINDOW (window
);
2134 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2135 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2137 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2138 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2140 if (w
->pseudo_window_p
)
2143 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2149 case ON_LEFT_MARGIN
:
2150 area
= LEFT_MARGIN_AREA
;
2153 case ON_RIGHT_MARGIN
:
2154 area
= RIGHT_MARGIN_AREA
;
2157 case ON_HEADER_LINE
:
2159 gr
= (part
== ON_HEADER_LINE
2160 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2161 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2164 goto text_glyph_row_found
;
2171 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2172 if (r
->y
+ r
->height
> y
)
2178 text_glyph_row_found
:
2181 struct glyph
*g
= gr
->glyphs
[area
];
2182 struct glyph
*end
= g
+ gr
->used
[area
];
2184 height
= gr
->height
;
2185 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2186 if (gx
+ g
->pixel_width
> x
)
2191 if (g
->type
== IMAGE_GLYPH
)
2193 /* Don't remember when mouse is over image, as
2194 image may have hot-spots. */
2195 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2198 width
= g
->pixel_width
;
2202 /* Use nominal char spacing at end of line. */
2204 gx
+= (x
/ width
) * width
;
2207 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2208 gx
+= window_box_left_offset (w
, area
);
2212 /* Use nominal line height at end of window. */
2213 gx
= (x
/ width
) * width
;
2215 gy
+= (y
/ height
) * height
;
2219 case ON_LEFT_FRINGE
:
2220 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2221 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2222 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2223 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2226 case ON_RIGHT_FRINGE
:
2227 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2228 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2229 : window_box_right_offset (w
, TEXT_AREA
));
2230 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2234 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2236 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2237 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2238 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2240 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2244 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2245 if (r
->y
+ r
->height
> y
)
2252 height
= gr
->height
;
2255 /* Use nominal line height at end of window. */
2257 gy
+= (y
/ height
) * height
;
2264 /* If there is no glyph under the mouse, then we divide the screen
2265 into a grid of the smallest glyph in the frame, and use that
2268 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2269 round down even for negative values. */
2275 gx
= (gx
/ width
) * width
;
2276 gy
= (gy
/ height
) * height
;
2281 gx
+= WINDOW_LEFT_EDGE_X (w
);
2282 gy
+= WINDOW_TOP_EDGE_Y (w
);
2285 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2287 /* Visible feedback for debugging. */
2290 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2291 f
->output_data
.x
->normal_gc
,
2292 gx
, gy
, width
, height
);
2298 #endif /* HAVE_WINDOW_SYSTEM */
2301 /***********************************************************************
2302 Lisp form evaluation
2303 ***********************************************************************/
2305 /* Error handler for safe_eval and safe_call. */
2308 safe_eval_handler (arg
)
2311 add_to_log ("Error during redisplay: %s", arg
, Qnil
);
2316 /* Evaluate SEXPR and return the result, or nil if something went
2317 wrong. Prevent redisplay during the evaluation. */
2319 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2320 Return the result, or nil if something went wrong. Prevent
2321 redisplay during the evaluation. */
2324 safe_call (nargs
, args
)
2330 if (inhibit_eval_during_redisplay
)
2334 int count
= SPECPDL_INDEX ();
2335 struct gcpro gcpro1
;
2338 gcpro1
.nvars
= nargs
;
2339 specbind (Qinhibit_redisplay
, Qt
);
2340 /* Use Qt to ensure debugger does not run,
2341 so there is no possibility of wanting to redisplay. */
2342 val
= internal_condition_case_2 (Ffuncall
, nargs
, args
, Qt
,
2345 val
= unbind_to (count
, val
);
2352 /* Call function FN with one argument ARG.
2353 Return the result, or nil if something went wrong. */
2356 safe_call1 (fn
, arg
)
2357 Lisp_Object fn
, arg
;
2359 Lisp_Object args
[2];
2362 return safe_call (2, args
);
2365 static Lisp_Object Qeval
;
2368 safe_eval (Lisp_Object sexpr
)
2370 return safe_call1 (Qeval
, sexpr
);
2373 /* Call function FN with one argument ARG.
2374 Return the result, or nil if something went wrong. */
2377 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2379 Lisp_Object args
[3];
2383 return safe_call (3, args
);
2388 /***********************************************************************
2390 ***********************************************************************/
2394 /* Define CHECK_IT to perform sanity checks on iterators.
2395 This is for debugging. It is too slow to do unconditionally. */
2401 if (it
->method
== GET_FROM_STRING
)
2403 xassert (STRINGP (it
->string
));
2404 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2408 xassert (IT_STRING_CHARPOS (*it
) < 0);
2409 if (it
->method
== GET_FROM_BUFFER
)
2411 /* Check that character and byte positions agree. */
2412 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2417 xassert (it
->current
.dpvec_index
>= 0);
2419 xassert (it
->current
.dpvec_index
< 0);
2422 #define CHECK_IT(IT) check_it ((IT))
2426 #define CHECK_IT(IT) (void) 0
2433 /* Check that the window end of window W is what we expect it
2434 to be---the last row in the current matrix displaying text. */
2437 check_window_end (w
)
2440 if (!MINI_WINDOW_P (w
)
2441 && !NILP (w
->window_end_valid
))
2443 struct glyph_row
*row
;
2444 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2445 XFASTINT (w
->window_end_vpos
)),
2447 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2448 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2452 #define CHECK_WINDOW_END(W) check_window_end ((W))
2454 #else /* not GLYPH_DEBUG */
2456 #define CHECK_WINDOW_END(W) (void) 0
2458 #endif /* not GLYPH_DEBUG */
2462 /***********************************************************************
2463 Iterator initialization
2464 ***********************************************************************/
2466 /* Initialize IT for displaying current_buffer in window W, starting
2467 at character position CHARPOS. CHARPOS < 0 means that no buffer
2468 position is specified which is useful when the iterator is assigned
2469 a position later. BYTEPOS is the byte position corresponding to
2470 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2472 If ROW is not null, calls to produce_glyphs with IT as parameter
2473 will produce glyphs in that row.
2475 BASE_FACE_ID is the id of a base face to use. It must be one of
2476 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2477 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2478 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2480 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2481 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2482 will be initialized to use the corresponding mode line glyph row of
2483 the desired matrix of W. */
2486 init_iterator (it
, w
, charpos
, bytepos
, row
, base_face_id
)
2489 int charpos
, bytepos
;
2490 struct glyph_row
*row
;
2491 enum face_id base_face_id
;
2493 int highlight_region_p
;
2495 /* Some precondition checks. */
2496 xassert (w
!= NULL
&& it
!= NULL
);
2497 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2500 /* If face attributes have been changed since the last redisplay,
2501 free realized faces now because they depend on face definitions
2502 that might have changed. Don't free faces while there might be
2503 desired matrices pending which reference these faces. */
2504 if (face_change_count
&& !inhibit_free_realized_faces
)
2506 face_change_count
= 0;
2507 free_all_realized_faces (Qnil
);
2510 /* Use one of the mode line rows of W's desired matrix if
2514 if (base_face_id
== MODE_LINE_FACE_ID
2515 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2516 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2517 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2518 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2522 bzero (it
, sizeof *it
);
2523 it
->current
.overlay_string_index
= -1;
2524 it
->current
.dpvec_index
= -1;
2525 it
->base_face_id
= base_face_id
;
2527 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2529 /* The window in which we iterate over current_buffer: */
2530 XSETWINDOW (it
->window
, w
);
2532 it
->f
= XFRAME (w
->frame
);
2534 /* Extra space between lines (on window systems only). */
2535 if (base_face_id
== DEFAULT_FACE_ID
2536 && FRAME_WINDOW_P (it
->f
))
2538 if (NATNUMP (current_buffer
->extra_line_spacing
))
2539 it
->extra_line_spacing
= XFASTINT (current_buffer
->extra_line_spacing
);
2540 else if (FLOATP (current_buffer
->extra_line_spacing
))
2541 it
->extra_line_spacing
= (XFLOAT_DATA (current_buffer
->extra_line_spacing
)
2542 * FRAME_LINE_HEIGHT (it
->f
));
2543 else if (it
->f
->extra_line_spacing
> 0)
2544 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2545 it
->max_extra_line_spacing
= 0;
2548 /* If realized faces have been removed, e.g. because of face
2549 attribute changes of named faces, recompute them. When running
2550 in batch mode, the face cache of the initial frame is null. If
2551 we happen to get called, make a dummy face cache. */
2552 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2553 init_frame_faces (it
->f
);
2554 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2555 recompute_basic_faces (it
->f
);
2557 /* Current value of the `slice', `space-width', and 'height' properties. */
2558 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2559 it
->space_width
= Qnil
;
2560 it
->font_height
= Qnil
;
2561 it
->override_ascent
= -1;
2563 /* Are control characters displayed as `^C'? */
2564 it
->ctl_arrow_p
= !NILP (current_buffer
->ctl_arrow
);
2566 /* -1 means everything between a CR and the following line end
2567 is invisible. >0 means lines indented more than this value are
2569 it
->selective
= (INTEGERP (current_buffer
->selective_display
)
2570 ? XFASTINT (current_buffer
->selective_display
)
2571 : (!NILP (current_buffer
->selective_display
)
2573 it
->selective_display_ellipsis_p
2574 = !NILP (current_buffer
->selective_display_ellipses
);
2576 /* Display table to use. */
2577 it
->dp
= window_display_table (w
);
2579 /* Are multibyte characters enabled in current_buffer? */
2580 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
2582 /* Non-zero if we should highlight the region. */
2584 = (!NILP (Vtransient_mark_mode
)
2585 && !NILP (current_buffer
->mark_active
)
2586 && XMARKER (current_buffer
->mark
)->buffer
!= 0);
2588 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2589 start and end of a visible region in window IT->w. Set both to
2590 -1 to indicate no region. */
2591 if (highlight_region_p
2592 /* Maybe highlight only in selected window. */
2593 && (/* Either show region everywhere. */
2594 highlight_nonselected_windows
2595 /* Or show region in the selected window. */
2596 || w
== XWINDOW (selected_window
)
2597 /* Or show the region if we are in the mini-buffer and W is
2598 the window the mini-buffer refers to. */
2599 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2600 && WINDOWP (minibuf_selected_window
)
2601 && w
== XWINDOW (minibuf_selected_window
))))
2603 int charpos
= marker_position (current_buffer
->mark
);
2604 it
->region_beg_charpos
= min (PT
, charpos
);
2605 it
->region_end_charpos
= max (PT
, charpos
);
2608 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2610 /* Get the position at which the redisplay_end_trigger hook should
2611 be run, if it is to be run at all. */
2612 if (MARKERP (w
->redisplay_end_trigger
)
2613 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2614 it
->redisplay_end_trigger_charpos
2615 = marker_position (w
->redisplay_end_trigger
);
2616 else if (INTEGERP (w
->redisplay_end_trigger
))
2617 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2619 /* Correct bogus values of tab_width. */
2620 it
->tab_width
= XINT (current_buffer
->tab_width
);
2621 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2624 /* Are lines in the display truncated? */
2625 it
->truncate_lines_p
2626 = (base_face_id
!= DEFAULT_FACE_ID
2627 || XINT (it
->w
->hscroll
)
2628 || (truncate_partial_width_windows
2629 && !WINDOW_FULL_WIDTH_P (it
->w
))
2630 || !NILP (current_buffer
->truncate_lines
));
2632 /* Get dimensions of truncation and continuation glyphs. These are
2633 displayed as fringe bitmaps under X, so we don't need them for such
2635 if (!FRAME_WINDOW_P (it
->f
))
2637 if (it
->truncate_lines_p
)
2639 /* We will need the truncation glyph. */
2640 xassert (it
->glyph_row
== NULL
);
2641 produce_special_glyphs (it
, IT_TRUNCATION
);
2642 it
->truncation_pixel_width
= it
->pixel_width
;
2646 /* We will need the continuation glyph. */
2647 xassert (it
->glyph_row
== NULL
);
2648 produce_special_glyphs (it
, IT_CONTINUATION
);
2649 it
->continuation_pixel_width
= it
->pixel_width
;
2652 /* Reset these values to zero because the produce_special_glyphs
2653 above has changed them. */
2654 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2655 it
->phys_ascent
= it
->phys_descent
= 0;
2658 /* Set this after getting the dimensions of truncation and
2659 continuation glyphs, so that we don't produce glyphs when calling
2660 produce_special_glyphs, above. */
2661 it
->glyph_row
= row
;
2662 it
->area
= TEXT_AREA
;
2664 /* Get the dimensions of the display area. The display area
2665 consists of the visible window area plus a horizontally scrolled
2666 part to the left of the window. All x-values are relative to the
2667 start of this total display area. */
2668 if (base_face_id
!= DEFAULT_FACE_ID
)
2670 /* Mode lines, menu bar in terminal frames. */
2671 it
->first_visible_x
= 0;
2672 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2677 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2678 it
->last_visible_x
= (it
->first_visible_x
2679 + window_box_width (w
, TEXT_AREA
));
2681 /* If we truncate lines, leave room for the truncator glyph(s) at
2682 the right margin. Otherwise, leave room for the continuation
2683 glyph(s). Truncation and continuation glyphs are not inserted
2684 for window-based redisplay. */
2685 if (!FRAME_WINDOW_P (it
->f
))
2687 if (it
->truncate_lines_p
)
2688 it
->last_visible_x
-= it
->truncation_pixel_width
;
2690 it
->last_visible_x
-= it
->continuation_pixel_width
;
2693 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2694 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2697 /* Leave room for a border glyph. */
2698 if (!FRAME_WINDOW_P (it
->f
)
2699 && !WINDOW_RIGHTMOST_P (it
->w
))
2700 it
->last_visible_x
-= 1;
2702 it
->last_visible_y
= window_text_bottom_y (w
);
2704 /* For mode lines and alike, arrange for the first glyph having a
2705 left box line if the face specifies a box. */
2706 if (base_face_id
!= DEFAULT_FACE_ID
)
2710 it
->face_id
= base_face_id
;
2712 /* If we have a boxed mode line, make the first character appear
2713 with a left box line. */
2714 face
= FACE_FROM_ID (it
->f
, base_face_id
);
2715 if (face
->box
!= FACE_NO_BOX
)
2716 it
->start_of_box_run_p
= 1;
2719 /* If a buffer position was specified, set the iterator there,
2720 getting overlays and face properties from that position. */
2721 if (charpos
>= BUF_BEG (current_buffer
))
2723 it
->end_charpos
= ZV
;
2725 IT_CHARPOS (*it
) = charpos
;
2727 /* Compute byte position if not specified. */
2728 if (bytepos
< charpos
)
2729 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2731 IT_BYTEPOS (*it
) = bytepos
;
2733 it
->start
= it
->current
;
2735 /* Compute faces etc. */
2736 reseat (it
, it
->current
.pos
, 1);
2743 /* Initialize IT for the display of window W with window start POS. */
2746 start_display (it
, w
, pos
)
2749 struct text_pos pos
;
2751 struct glyph_row
*row
;
2752 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2754 row
= w
->desired_matrix
->rows
+ first_vpos
;
2755 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2756 it
->first_vpos
= first_vpos
;
2758 /* Don't reseat to previous visible line start if current start
2759 position is in a string or image. */
2760 if (it
->method
== GET_FROM_BUFFER
&& !it
->truncate_lines_p
)
2762 int start_at_line_beg_p
;
2763 int first_y
= it
->current_y
;
2765 /* If window start is not at a line start, skip forward to POS to
2766 get the correct continuation lines width. */
2767 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2768 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2769 if (!start_at_line_beg_p
)
2773 reseat_at_previous_visible_line_start (it
);
2774 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2776 new_x
= it
->current_x
+ it
->pixel_width
;
2778 /* If lines are continued, this line may end in the middle
2779 of a multi-glyph character (e.g. a control character
2780 displayed as \003, or in the middle of an overlay
2781 string). In this case move_it_to above will not have
2782 taken us to the start of the continuation line but to the
2783 end of the continued line. */
2784 if (it
->current_x
> 0
2785 && !it
->truncate_lines_p
/* Lines are continued. */
2786 && (/* And glyph doesn't fit on the line. */
2787 new_x
> it
->last_visible_x
2788 /* Or it fits exactly and we're on a window
2790 || (new_x
== it
->last_visible_x
2791 && FRAME_WINDOW_P (it
->f
))))
2793 if (it
->current
.dpvec_index
>= 0
2794 || it
->current
.overlay_string_index
>= 0)
2796 set_iterator_to_next (it
, 1);
2797 move_it_in_display_line_to (it
, -1, -1, 0);
2800 it
->continuation_lines_width
+= it
->current_x
;
2803 /* We're starting a new display line, not affected by the
2804 height of the continued line, so clear the appropriate
2805 fields in the iterator structure. */
2806 it
->max_ascent
= it
->max_descent
= 0;
2807 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2809 it
->current_y
= first_y
;
2811 it
->current_x
= it
->hpos
= 0;
2815 #if 0 /* Don't assert the following because start_display is sometimes
2816 called intentionally with a window start that is not at a
2817 line start. Please leave this code in as a comment. */
2819 /* Window start should be on a line start, now. */
2820 xassert (it
->continuation_lines_width
2821 || IT_CHARPOS (it
) == BEGV
2822 || FETCH_BYTE (IT_BYTEPOS (it
) - 1) == '\n');
2827 /* Return 1 if POS is a position in ellipses displayed for invisible
2828 text. W is the window we display, for text property lookup. */
2831 in_ellipses_for_invisible_text_p (pos
, w
)
2832 struct display_pos
*pos
;
2835 Lisp_Object prop
, window
;
2837 int charpos
= CHARPOS (pos
->pos
);
2839 /* If POS specifies a position in a display vector, this might
2840 be for an ellipsis displayed for invisible text. We won't
2841 get the iterator set up for delivering that ellipsis unless
2842 we make sure that it gets aware of the invisible text. */
2843 if (pos
->dpvec_index
>= 0
2844 && pos
->overlay_string_index
< 0
2845 && CHARPOS (pos
->string_pos
) < 0
2847 && (XSETWINDOW (window
, w
),
2848 prop
= Fget_char_property (make_number (charpos
),
2849 Qinvisible
, window
),
2850 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2852 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2854 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2861 /* Initialize IT for stepping through current_buffer in window W,
2862 starting at position POS that includes overlay string and display
2863 vector/ control character translation position information. Value
2864 is zero if there are overlay strings with newlines at POS. */
2867 init_from_display_pos (it
, w
, pos
)
2870 struct display_pos
*pos
;
2872 int charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2873 int i
, overlay_strings_with_newlines
= 0;
2875 /* If POS specifies a position in a display vector, this might
2876 be for an ellipsis displayed for invisible text. We won't
2877 get the iterator set up for delivering that ellipsis unless
2878 we make sure that it gets aware of the invisible text. */
2879 if (in_ellipses_for_invisible_text_p (pos
, w
))
2885 /* Keep in mind: the call to reseat in init_iterator skips invisible
2886 text, so we might end up at a position different from POS. This
2887 is only a problem when POS is a row start after a newline and an
2888 overlay starts there with an after-string, and the overlay has an
2889 invisible property. Since we don't skip invisible text in
2890 display_line and elsewhere immediately after consuming the
2891 newline before the row start, such a POS will not be in a string,
2892 but the call to init_iterator below will move us to the
2894 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2896 /* This only scans the current chunk -- it should scan all chunks.
2897 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2898 to 16 in 22.1 to make this a lesser problem. */
2899 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2901 const char *s
= SDATA (it
->overlay_strings
[i
]);
2902 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2904 while (s
< e
&& *s
!= '\n')
2909 overlay_strings_with_newlines
= 1;
2914 /* If position is within an overlay string, set up IT to the right
2916 if (pos
->overlay_string_index
>= 0)
2920 /* If the first overlay string happens to have a `display'
2921 property for an image, the iterator will be set up for that
2922 image, and we have to undo that setup first before we can
2923 correct the overlay string index. */
2924 if (it
->method
== GET_FROM_IMAGE
)
2927 /* We already have the first chunk of overlay strings in
2928 IT->overlay_strings. Load more until the one for
2929 pos->overlay_string_index is in IT->overlay_strings. */
2930 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2932 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2933 it
->current
.overlay_string_index
= 0;
2936 load_overlay_strings (it
, 0);
2937 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2941 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2942 relative_index
= (it
->current
.overlay_string_index
2943 % OVERLAY_STRING_CHUNK_SIZE
);
2944 it
->string
= it
->overlay_strings
[relative_index
];
2945 xassert (STRINGP (it
->string
));
2946 it
->current
.string_pos
= pos
->string_pos
;
2947 it
->method
= GET_FROM_STRING
;
2950 #if 0 /* This is bogus because POS not having an overlay string
2951 position does not mean it's after the string. Example: A
2952 line starting with a before-string and initialization of IT
2953 to the previous row's end position. */
2954 else if (it
->current
.overlay_string_index
>= 0)
2956 /* If POS says we're already after an overlay string ending at
2957 POS, make sure to pop the iterator because it will be in
2958 front of that overlay string. When POS is ZV, we've thereby
2959 also ``processed'' overlay strings at ZV. */
2962 xassert (it
->current
.overlay_string_index
== -1);
2963 xassert (it
->method
== GET_FROM_BUFFER
);
2964 if (CHARPOS (pos
->pos
) == ZV
)
2965 it
->overlay_strings_at_end_processed_p
= 1;
2969 if (CHARPOS (pos
->string_pos
) >= 0)
2971 /* Recorded position is not in an overlay string, but in another
2972 string. This can only be a string from a `display' property.
2973 IT should already be filled with that string. */
2974 it
->current
.string_pos
= pos
->string_pos
;
2975 xassert (STRINGP (it
->string
));
2978 /* Restore position in display vector translations, control
2979 character translations or ellipses. */
2980 if (pos
->dpvec_index
>= 0)
2982 if (it
->dpvec
== NULL
)
2983 get_next_display_element (it
);
2984 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2985 it
->current
.dpvec_index
= pos
->dpvec_index
;
2989 return !overlay_strings_with_newlines
;
2993 /* Initialize IT for stepping through current_buffer in window W
2994 starting at ROW->start. */
2997 init_to_row_start (it
, w
, row
)
3000 struct glyph_row
*row
;
3002 init_from_display_pos (it
, w
, &row
->start
);
3003 it
->start
= row
->start
;
3004 it
->continuation_lines_width
= row
->continuation_lines_width
;
3009 /* Initialize IT for stepping through current_buffer in window W
3010 starting in the line following ROW, i.e. starting at ROW->end.
3011 Value is zero if there are overlay strings with newlines at ROW's
3015 init_to_row_end (it
, w
, row
)
3018 struct glyph_row
*row
;
3022 if (init_from_display_pos (it
, w
, &row
->end
))
3024 if (row
->continued_p
)
3025 it
->continuation_lines_width
3026 = row
->continuation_lines_width
+ row
->pixel_width
;
3037 /***********************************************************************
3039 ***********************************************************************/
3041 /* Called when IT reaches IT->stop_charpos. Handle text property and
3042 overlay changes. Set IT->stop_charpos to the next position where
3049 enum prop_handled handled
;
3050 int handle_overlay_change_p
;
3054 it
->current
.dpvec_index
= -1;
3055 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3056 it
->ignore_overlay_strings_at_pos_p
= 0;
3058 /* Use face of preceding text for ellipsis (if invisible) */
3059 if (it
->selective_display_ellipsis_p
)
3060 it
->saved_face_id
= it
->face_id
;
3064 handled
= HANDLED_NORMALLY
;
3066 /* Call text property handlers. */
3067 for (p
= it_props
; p
->handler
; ++p
)
3069 handled
= p
->handler (it
);
3071 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3073 else if (handled
== HANDLED_RETURN
)
3075 /* We still want to show before and after strings from
3076 overlays even if the actual buffer text is replaced. */
3077 if (!handle_overlay_change_p
|| it
->sp
> 1)
3079 if (!get_overlay_strings_1 (it
, 0, 0))
3081 it
->ignore_overlay_strings_at_pos_p
= 1;
3082 it
->string_from_display_prop_p
= 0;
3083 handle_overlay_change_p
= 0;
3084 handled
= HANDLED_RECOMPUTE_PROPS
;
3087 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3088 handle_overlay_change_p
= 0;
3091 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3093 /* Don't check for overlay strings below when set to deliver
3094 characters from a display vector. */
3095 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3096 handle_overlay_change_p
= 0;
3098 /* Handle overlay changes.
3099 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3100 if it finds overlays. */
3101 if (handle_overlay_change_p
)
3102 handled
= handle_overlay_change (it
);
3105 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3107 /* Determine where to stop next. */
3108 if (handled
== HANDLED_NORMALLY
)
3109 compute_stop_pos (it
);
3113 /* Compute IT->stop_charpos from text property and overlay change
3114 information for IT's current position. */
3117 compute_stop_pos (it
)
3120 register INTERVAL iv
, next_iv
;
3121 Lisp_Object object
, limit
, position
;
3123 /* If nowhere else, stop at the end. */
3124 it
->stop_charpos
= it
->end_charpos
;
3126 if (STRINGP (it
->string
))
3128 /* Strings are usually short, so don't limit the search for
3130 object
= it
->string
;
3132 position
= make_number (IT_STRING_CHARPOS (*it
));
3138 /* If next overlay change is in front of the current stop pos
3139 (which is IT->end_charpos), stop there. Note: value of
3140 next_overlay_change is point-max if no overlay change
3142 charpos
= next_overlay_change (IT_CHARPOS (*it
));
3143 if (charpos
< it
->stop_charpos
)
3144 it
->stop_charpos
= charpos
;
3146 /* If showing the region, we have to stop at the region
3147 start or end because the face might change there. */
3148 if (it
->region_beg_charpos
> 0)
3150 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3151 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3152 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3153 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3156 /* Set up variables for computing the stop position from text
3157 property changes. */
3158 XSETBUFFER (object
, current_buffer
);
3159 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3160 position
= make_number (IT_CHARPOS (*it
));
3164 /* Get the interval containing IT's position. Value is a null
3165 interval if there isn't such an interval. */
3166 iv
= validate_interval_range (object
, &position
, &position
, 0);
3167 if (!NULL_INTERVAL_P (iv
))
3169 Lisp_Object values_here
[LAST_PROP_IDX
];
3172 /* Get properties here. */
3173 for (p
= it_props
; p
->handler
; ++p
)
3174 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3176 /* Look for an interval following iv that has different
3178 for (next_iv
= next_interval (iv
);
3179 (!NULL_INTERVAL_P (next_iv
)
3181 || XFASTINT (limit
) > next_iv
->position
));
3182 next_iv
= next_interval (next_iv
))
3184 for (p
= it_props
; p
->handler
; ++p
)
3186 Lisp_Object new_value
;
3188 new_value
= textget (next_iv
->plist
, *p
->name
);
3189 if (!EQ (values_here
[p
->idx
], new_value
))
3197 if (!NULL_INTERVAL_P (next_iv
))
3199 if (INTEGERP (limit
)
3200 && next_iv
->position
>= XFASTINT (limit
))
3201 /* No text property change up to limit. */
3202 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3204 /* Text properties change in next_iv. */
3205 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3209 xassert (STRINGP (it
->string
)
3210 || (it
->stop_charpos
>= BEGV
3211 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3215 /* Return the position of the next overlay change after POS in
3216 current_buffer. Value is point-max if no overlay change
3217 follows. This is like `next-overlay-change' but doesn't use
3221 next_overlay_change (pos
)
3226 Lisp_Object
*overlays
;
3229 /* Get all overlays at the given position. */
3230 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3232 /* If any of these overlays ends before endpos,
3233 use its ending point instead. */
3234 for (i
= 0; i
< noverlays
; ++i
)
3239 oend
= OVERLAY_END (overlays
[i
]);
3240 oendpos
= OVERLAY_POSITION (oend
);
3241 endpos
= min (endpos
, oendpos
);
3249 /***********************************************************************
3251 ***********************************************************************/
3253 /* Handle changes in the `fontified' property of the current buffer by
3254 calling hook functions from Qfontification_functions to fontify
3257 static enum prop_handled
3258 handle_fontified_prop (it
)
3261 Lisp_Object prop
, pos
;
3262 enum prop_handled handled
= HANDLED_NORMALLY
;
3264 if (!NILP (Vmemory_full
))
3267 /* Get the value of the `fontified' property at IT's current buffer
3268 position. (The `fontified' property doesn't have a special
3269 meaning in strings.) If the value is nil, call functions from
3270 Qfontification_functions. */
3271 if (!STRINGP (it
->string
)
3273 && !NILP (Vfontification_functions
)
3274 && !NILP (Vrun_hooks
)
3275 && (pos
= make_number (IT_CHARPOS (*it
)),
3276 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3277 /* Ignore the special cased nil value always present at EOB since
3278 no amount of fontifying will be able to change it. */
3279 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3281 int count
= SPECPDL_INDEX ();
3284 val
= Vfontification_functions
;
3285 specbind (Qfontification_functions
, Qnil
);
3287 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3288 safe_call1 (val
, pos
);
3291 Lisp_Object globals
, fn
;
3292 struct gcpro gcpro1
, gcpro2
;
3295 GCPRO2 (val
, globals
);
3297 for (; CONSP (val
); val
= XCDR (val
))
3303 /* A value of t indicates this hook has a local
3304 binding; it means to run the global binding too.
3305 In a global value, t should not occur. If it
3306 does, we must ignore it to avoid an endless
3308 for (globals
= Fdefault_value (Qfontification_functions
);
3310 globals
= XCDR (globals
))
3312 fn
= XCAR (globals
);
3314 safe_call1 (fn
, pos
);
3318 safe_call1 (fn
, pos
);
3324 unbind_to (count
, Qnil
);
3326 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3327 something. This avoids an endless loop if they failed to
3328 fontify the text for which reason ever. */
3329 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3330 handled
= HANDLED_RECOMPUTE_PROPS
;
3338 /***********************************************************************
3340 ***********************************************************************/
3342 /* Set up iterator IT from face properties at its current position.
3343 Called from handle_stop. */
3345 static enum prop_handled
3346 handle_face_prop (it
)
3350 EMACS_INT next_stop
;
3352 if (!STRINGP (it
->string
))
3355 = face_at_buffer_position (it
->w
,
3357 it
->region_beg_charpos
,
3358 it
->region_end_charpos
,
3361 + TEXT_PROP_DISTANCE_LIMIT
),
3364 /* Is this a start of a run of characters with box face?
3365 Caveat: this can be called for a freshly initialized
3366 iterator; face_id is -1 in this case. We know that the new
3367 face will not change until limit, i.e. if the new face has a
3368 box, all characters up to limit will have one. But, as
3369 usual, we don't know whether limit is really the end. */
3370 if (new_face_id
!= it
->face_id
)
3372 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3374 /* If new face has a box but old face has not, this is
3375 the start of a run of characters with box, i.e. it has
3376 a shadow on the left side. The value of face_id of the
3377 iterator will be -1 if this is the initial call that gets
3378 the face. In this case, we have to look in front of IT's
3379 position and see whether there is a face != new_face_id. */
3380 it
->start_of_box_run_p
3381 = (new_face
->box
!= FACE_NO_BOX
3382 && (it
->face_id
>= 0
3383 || IT_CHARPOS (*it
) == BEG
3384 || new_face_id
!= face_before_it_pos (it
)));
3385 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3390 int base_face_id
, bufpos
;
3392 Lisp_Object from_overlay
3393 = (it
->current
.overlay_string_index
>= 0
3394 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3397 /* See if we got to this string directly or indirectly from
3398 an overlay property. That includes the before-string or
3399 after-string of an overlay, strings in display properties
3400 provided by an overlay, their text properties, etc.
3402 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3403 if (! NILP (from_overlay
))
3404 for (i
= it
->sp
- 1; i
>= 0; i
--)
3406 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3408 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3409 else if (! NILP (it
->stack
[i
].from_overlay
))
3410 from_overlay
= it
->stack
[i
].from_overlay
;
3412 if (!NILP (from_overlay
))
3416 if (! NILP (from_overlay
))
3418 bufpos
= IT_CHARPOS (*it
);
3419 /* For a string from an overlay, the base face depends
3420 only on text properties and ignores overlays. */
3422 = face_for_overlay_string (it
->w
,
3424 it
->region_beg_charpos
,
3425 it
->region_end_charpos
,
3428 + TEXT_PROP_DISTANCE_LIMIT
),
3436 /* For strings from a `display' property, use the face at
3437 IT's current buffer position as the base face to merge
3438 with, so that overlay strings appear in the same face as
3439 surrounding text, unless they specify their own
3441 base_face_id
= underlying_face_id (it
);
3444 new_face_id
= face_at_string_position (it
->w
,
3446 IT_STRING_CHARPOS (*it
),
3448 it
->region_beg_charpos
,
3449 it
->region_end_charpos
,
3453 #if 0 /* This shouldn't be neccessary. Let's check it. */
3454 /* If IT is used to display a mode line we would really like to
3455 use the mode line face instead of the frame's default face. */
3456 if (it
->glyph_row
== MATRIX_MODE_LINE_ROW (it
->w
->desired_matrix
)
3457 && new_face_id
== DEFAULT_FACE_ID
)
3458 new_face_id
= CURRENT_MODE_LINE_FACE_ID (it
->w
);
3461 /* Is this a start of a run of characters with box? Caveat:
3462 this can be called for a freshly allocated iterator; face_id
3463 is -1 is this case. We know that the new face will not
3464 change until the next check pos, i.e. if the new face has a
3465 box, all characters up to that position will have a
3466 box. But, as usual, we don't know whether that position
3467 is really the end. */
3468 if (new_face_id
!= it
->face_id
)
3470 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3471 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3473 /* If new face has a box but old face hasn't, this is the
3474 start of a run of characters with box, i.e. it has a
3475 shadow on the left side. */
3476 it
->start_of_box_run_p
3477 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3478 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3482 it
->face_id
= new_face_id
;
3483 return HANDLED_NORMALLY
;
3487 /* Return the ID of the face ``underlying'' IT's current position,
3488 which is in a string. If the iterator is associated with a
3489 buffer, return the face at IT's current buffer position.
3490 Otherwise, use the iterator's base_face_id. */
3493 underlying_face_id (it
)
3496 int face_id
= it
->base_face_id
, i
;
3498 xassert (STRINGP (it
->string
));
3500 for (i
= it
->sp
- 1; i
>= 0; --i
)
3501 if (NILP (it
->stack
[i
].string
))
3502 face_id
= it
->stack
[i
].face_id
;
3508 /* Compute the face one character before or after the current position
3509 of IT. BEFORE_P non-zero means get the face in front of IT's
3510 position. Value is the id of the face. */
3513 face_before_or_after_it_pos (it
, before_p
)
3518 EMACS_INT next_check_charpos
;
3519 struct text_pos pos
;
3521 xassert (it
->s
== NULL
);
3523 if (STRINGP (it
->string
))
3525 int bufpos
, base_face_id
;
3527 /* No face change past the end of the string (for the case
3528 we are padding with spaces). No face change before the
3530 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3531 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3534 /* Set pos to the position before or after IT's current position. */
3536 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3538 /* For composition, we must check the character after the
3540 pos
= (it
->what
== IT_COMPOSITION
3541 ? string_pos (IT_STRING_CHARPOS (*it
) + it
->cmp_len
, it
->string
)
3542 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3544 if (it
->current
.overlay_string_index
>= 0)
3545 bufpos
= IT_CHARPOS (*it
);
3549 base_face_id
= underlying_face_id (it
);
3551 /* Get the face for ASCII, or unibyte. */
3552 face_id
= face_at_string_position (it
->w
,
3556 it
->region_beg_charpos
,
3557 it
->region_end_charpos
,
3558 &next_check_charpos
,
3561 /* Correct the face for charsets different from ASCII. Do it
3562 for the multibyte case only. The face returned above is
3563 suitable for unibyte text if IT->string is unibyte. */
3564 if (STRING_MULTIBYTE (it
->string
))
3566 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3567 int rest
= SBYTES (it
->string
) - BYTEPOS (pos
);
3569 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3571 c
= string_char_and_length (p
, rest
, &len
);
3572 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3577 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3578 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3581 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3582 pos
= it
->current
.pos
;
3585 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3588 if (it
->what
== IT_COMPOSITION
)
3589 /* For composition, we must check the position after the
3591 pos
.charpos
+= it
->cmp_len
, pos
.bytepos
+= it
->len
;
3593 INC_TEXT_POS (pos
, it
->multibyte_p
);
3596 /* Determine face for CHARSET_ASCII, or unibyte. */
3597 face_id
= face_at_buffer_position (it
->w
,
3599 it
->region_beg_charpos
,
3600 it
->region_end_charpos
,
3601 &next_check_charpos
,
3604 /* Correct the face for charsets different from ASCII. Do it
3605 for the multibyte case only. The face returned above is
3606 suitable for unibyte text if current_buffer is unibyte. */
3607 if (it
->multibyte_p
)
3609 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3610 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3611 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3620 /***********************************************************************
3622 ***********************************************************************/
3624 /* Set up iterator IT from invisible properties at its current
3625 position. Called from handle_stop. */
3627 static enum prop_handled
3628 handle_invisible_prop (it
)
3631 enum prop_handled handled
= HANDLED_NORMALLY
;
3633 if (STRINGP (it
->string
))
3635 extern Lisp_Object Qinvisible
;
3636 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3638 /* Get the value of the invisible text property at the
3639 current position. Value will be nil if there is no such
3641 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3642 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3645 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3647 handled
= HANDLED_RECOMPUTE_PROPS
;
3649 /* Get the position at which the next change of the
3650 invisible text property can be found in IT->string.
3651 Value will be nil if the property value is the same for
3652 all the rest of IT->string. */
3653 XSETINT (limit
, SCHARS (it
->string
));
3654 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3657 /* Text at current position is invisible. The next
3658 change in the property is at position end_charpos.
3659 Move IT's current position to that position. */
3660 if (INTEGERP (end_charpos
)
3661 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3663 struct text_pos old
;
3664 old
= it
->current
.string_pos
;
3665 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3666 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3670 /* The rest of the string is invisible. If this is an
3671 overlay string, proceed with the next overlay string
3672 or whatever comes and return a character from there. */
3673 if (it
->current
.overlay_string_index
>= 0)
3675 next_overlay_string (it
);
3676 /* Don't check for overlay strings when we just
3677 finished processing them. */
3678 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3682 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3683 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3691 EMACS_INT newpos
, next_stop
, start_charpos
;
3692 Lisp_Object pos
, prop
, overlay
;
3694 /* First of all, is there invisible text at this position? */
3695 start_charpos
= IT_CHARPOS (*it
);
3696 pos
= make_number (IT_CHARPOS (*it
));
3697 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3699 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3701 /* If we are on invisible text, skip over it. */
3702 if (invis_p
&& IT_CHARPOS (*it
) < it
->end_charpos
)
3704 /* Record whether we have to display an ellipsis for the
3706 int display_ellipsis_p
= invis_p
== 2;
3708 handled
= HANDLED_RECOMPUTE_PROPS
;
3710 /* Loop skipping over invisible text. The loop is left at
3711 ZV or with IT on the first char being visible again. */
3714 /* Try to skip some invisible text. Return value is the
3715 position reached which can be equal to IT's position
3716 if there is nothing invisible here. This skips both
3717 over invisible text properties and overlays with
3718 invisible property. */
3719 newpos
= skip_invisible (IT_CHARPOS (*it
),
3720 &next_stop
, ZV
, it
->window
);
3722 /* If we skipped nothing at all we weren't at invisible
3723 text in the first place. If everything to the end of
3724 the buffer was skipped, end the loop. */
3725 if (newpos
== IT_CHARPOS (*it
) || newpos
>= ZV
)
3729 /* We skipped some characters but not necessarily
3730 all there are. Check if we ended up on visible
3731 text. Fget_char_property returns the property of
3732 the char before the given position, i.e. if we
3733 get invis_p = 0, this means that the char at
3734 newpos is visible. */
3735 pos
= make_number (newpos
);
3736 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3737 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3740 /* If we ended up on invisible text, proceed to
3741 skip starting with next_stop. */
3743 IT_CHARPOS (*it
) = next_stop
;
3745 /* If there are adjacent invisible texts, don't lose the
3746 second one's ellipsis. */
3748 display_ellipsis_p
= 1;
3752 /* The position newpos is now either ZV or on visible text. */
3753 IT_CHARPOS (*it
) = newpos
;
3754 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3756 /* If there are before-strings at the start of invisible
3757 text, and the text is invisible because of a text
3758 property, arrange to show before-strings because 20.x did
3759 it that way. (If the text is invisible because of an
3760 overlay property instead of a text property, this is
3761 already handled in the overlay code.) */
3763 && get_overlay_strings (it
, start_charpos
))
3765 handled
= HANDLED_RECOMPUTE_PROPS
;
3766 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3768 else if (display_ellipsis_p
)
3770 /* Make sure that the glyphs of the ellipsis will get
3771 correct `charpos' values. If we would not update
3772 it->position here, the glyphs would belong to the
3773 last visible character _before_ the invisible
3774 text, which confuses `set_cursor_from_row'.
3776 We use the last invisible position instead of the
3777 first because this way the cursor is always drawn on
3778 the first "." of the ellipsis, whenever PT is inside
3779 the invisible text. Otherwise the cursor would be
3780 placed _after_ the ellipsis when the point is after the
3781 first invisible character. */
3782 if (!STRINGP (it
->object
))
3784 it
->position
.charpos
= IT_CHARPOS (*it
) - 1;
3785 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3787 setup_for_ellipsis (it
, 0);
3788 /* Let the ellipsis display before
3789 considering any properties of the following char.
3790 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3791 handled
= HANDLED_RETURN
;
3800 /* Make iterator IT return `...' next.
3801 Replaces LEN characters from buffer. */
3804 setup_for_ellipsis (it
, len
)
3808 /* Use the display table definition for `...'. Invalid glyphs
3809 will be handled by the method returning elements from dpvec. */
3810 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3812 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3813 it
->dpvec
= v
->contents
;
3814 it
->dpend
= v
->contents
+ v
->size
;
3818 /* Default `...'. */
3819 it
->dpvec
= default_invis_vector
;
3820 it
->dpend
= default_invis_vector
+ 3;
3823 it
->dpvec_char_len
= len
;
3824 it
->current
.dpvec_index
= 0;
3825 it
->dpvec_face_id
= -1;
3827 /* Remember the current face id in case glyphs specify faces.
3828 IT's face is restored in set_iterator_to_next.
3829 saved_face_id was set to preceding char's face in handle_stop. */
3830 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3831 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3833 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3839 /***********************************************************************
3841 ***********************************************************************/
3843 /* Set up iterator IT from `display' property at its current position.
3844 Called from handle_stop.
3845 We return HANDLED_RETURN if some part of the display property
3846 overrides the display of the buffer text itself.
3847 Otherwise we return HANDLED_NORMALLY. */
3849 static enum prop_handled
3850 handle_display_prop (it
)
3853 Lisp_Object prop
, object
, overlay
;
3854 struct text_pos
*position
;
3855 /* Nonzero if some property replaces the display of the text itself. */
3856 int display_replaced_p
= 0;
3858 if (STRINGP (it
->string
))
3860 object
= it
->string
;
3861 position
= &it
->current
.string_pos
;
3865 XSETWINDOW (object
, it
->w
);
3866 position
= &it
->current
.pos
;
3869 /* Reset those iterator values set from display property values. */
3870 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3871 it
->space_width
= Qnil
;
3872 it
->font_height
= Qnil
;
3875 /* We don't support recursive `display' properties, i.e. string
3876 values that have a string `display' property, that have a string
3877 `display' property etc. */
3878 if (!it
->string_from_display_prop_p
)
3879 it
->area
= TEXT_AREA
;
3881 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
3882 Qdisplay
, object
, &overlay
);
3884 return HANDLED_NORMALLY
;
3885 /* Now OVERLAY is the overlay that gave us this property, or nil
3886 if it was a text property. */
3888 if (!STRINGP (it
->string
))
3889 object
= it
->w
->buffer
;
3892 /* Simple properties. */
3893 && !EQ (XCAR (prop
), Qimage
)
3894 && !EQ (XCAR (prop
), Qspace
)
3895 && !EQ (XCAR (prop
), Qwhen
)
3896 && !EQ (XCAR (prop
), Qslice
)
3897 && !EQ (XCAR (prop
), Qspace_width
)
3898 && !EQ (XCAR (prop
), Qheight
)
3899 && !EQ (XCAR (prop
), Qraise
)
3900 /* Marginal area specifications. */
3901 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3902 && !EQ (XCAR (prop
), Qleft_fringe
)
3903 && !EQ (XCAR (prop
), Qright_fringe
)
3904 && !NILP (XCAR (prop
)))
3906 for (; CONSP (prop
); prop
= XCDR (prop
))
3908 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
3909 position
, display_replaced_p
))
3911 display_replaced_p
= 1;
3912 /* If some text in a string is replaced, `position' no
3913 longer points to the position of `object'. */
3914 if (STRINGP (object
))
3919 else if (VECTORP (prop
))
3922 for (i
= 0; i
< ASIZE (prop
); ++i
)
3923 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
3924 position
, display_replaced_p
))
3926 display_replaced_p
= 1;
3927 /* If some text in a string is replaced, `position' no
3928 longer points to the position of `object'. */
3929 if (STRINGP (object
))
3935 int ret
= handle_single_display_spec (it
, prop
, object
, overlay
,
3937 if (ret
< 0) /* Replaced by "", i.e. nothing. */
3938 return HANDLED_RECOMPUTE_PROPS
;
3940 display_replaced_p
= 1;
3943 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
3947 /* Value is the position of the end of the `display' property starting
3948 at START_POS in OBJECT. */
3950 static struct text_pos
3951 display_prop_end (it
, object
, start_pos
)
3954 struct text_pos start_pos
;
3957 struct text_pos end_pos
;
3959 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
3960 Qdisplay
, object
, Qnil
);
3961 CHARPOS (end_pos
) = XFASTINT (end
);
3962 if (STRINGP (object
))
3963 compute_string_pos (&end_pos
, start_pos
, it
->string
);
3965 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
3971 /* Set up IT from a single `display' specification PROP. OBJECT
3972 is the object in which the `display' property was found. *POSITION
3973 is the position at which it was found. DISPLAY_REPLACED_P non-zero
3974 means that we previously saw a display specification which already
3975 replaced text display with something else, for example an image;
3976 we ignore such properties after the first one has been processed.
3978 OVERLAY is the overlay this `display' property came from,
3979 or nil if it was a text property.
3981 If PROP is a `space' or `image' specification, and in some other
3982 cases too, set *POSITION to the position where the `display'
3985 Value is non-zero if something was found which replaces the display
3986 of buffer or string text. Specifically, the value is -1 if that
3987 "something" is "nothing". */
3990 handle_single_display_spec (it
, spec
, object
, overlay
, position
,
3991 display_replaced_before_p
)
3995 Lisp_Object overlay
;
3996 struct text_pos
*position
;
3997 int display_replaced_before_p
;
4000 Lisp_Object location
, value
;
4001 struct text_pos start_pos
, save_pos
;
4004 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4005 If the result is non-nil, use VALUE instead of SPEC. */
4007 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4016 if (!NILP (form
) && !EQ (form
, Qt
))
4018 int count
= SPECPDL_INDEX ();
4019 struct gcpro gcpro1
;
4021 /* Bind `object' to the object having the `display' property, a
4022 buffer or string. Bind `position' to the position in the
4023 object where the property was found, and `buffer-position'
4024 to the current position in the buffer. */
4025 specbind (Qobject
, object
);
4026 specbind (Qposition
, make_number (CHARPOS (*position
)));
4027 specbind (Qbuffer_position
,
4028 make_number (STRINGP (object
)
4029 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
4031 form
= safe_eval (form
);
4033 unbind_to (count
, Qnil
);
4039 /* Handle `(height HEIGHT)' specifications. */
4041 && EQ (XCAR (spec
), Qheight
)
4042 && CONSP (XCDR (spec
)))
4044 if (!FRAME_WINDOW_P (it
->f
))
4047 it
->font_height
= XCAR (XCDR (spec
));
4048 if (!NILP (it
->font_height
))
4050 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4051 int new_height
= -1;
4053 if (CONSP (it
->font_height
)
4054 && (EQ (XCAR (it
->font_height
), Qplus
)
4055 || EQ (XCAR (it
->font_height
), Qminus
))
4056 && CONSP (XCDR (it
->font_height
))
4057 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4059 /* `(+ N)' or `(- N)' where N is an integer. */
4060 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4061 if (EQ (XCAR (it
->font_height
), Qplus
))
4063 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4065 else if (FUNCTIONP (it
->font_height
))
4067 /* Call function with current height as argument.
4068 Value is the new height. */
4070 height
= safe_call1 (it
->font_height
,
4071 face
->lface
[LFACE_HEIGHT_INDEX
]);
4072 if (NUMBERP (height
))
4073 new_height
= XFLOATINT (height
);
4075 else if (NUMBERP (it
->font_height
))
4077 /* Value is a multiple of the canonical char height. */
4080 face
= FACE_FROM_ID (it
->f
, DEFAULT_FACE_ID
);
4081 new_height
= (XFLOATINT (it
->font_height
)
4082 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
4086 /* Evaluate IT->font_height with `height' bound to the
4087 current specified height to get the new height. */
4088 int count
= SPECPDL_INDEX ();
4090 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4091 value
= safe_eval (it
->font_height
);
4092 unbind_to (count
, Qnil
);
4094 if (NUMBERP (value
))
4095 new_height
= XFLOATINT (value
);
4099 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4105 /* Handle `(space-width WIDTH)'. */
4107 && EQ (XCAR (spec
), Qspace_width
)
4108 && CONSP (XCDR (spec
)))
4110 if (!FRAME_WINDOW_P (it
->f
))
4113 value
= XCAR (XCDR (spec
));
4114 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4115 it
->space_width
= value
;
4120 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4122 && EQ (XCAR (spec
), Qslice
))
4126 if (!FRAME_WINDOW_P (it
->f
))
4129 if (tem
= XCDR (spec
), CONSP (tem
))
4131 it
->slice
.x
= XCAR (tem
);
4132 if (tem
= XCDR (tem
), CONSP (tem
))
4134 it
->slice
.y
= XCAR (tem
);
4135 if (tem
= XCDR (tem
), CONSP (tem
))
4137 it
->slice
.width
= XCAR (tem
);
4138 if (tem
= XCDR (tem
), CONSP (tem
))
4139 it
->slice
.height
= XCAR (tem
);
4147 /* Handle `(raise FACTOR)'. */
4149 && EQ (XCAR (spec
), Qraise
)
4150 && CONSP (XCDR (spec
)))
4152 if (!FRAME_WINDOW_P (it
->f
))
4155 #ifdef HAVE_WINDOW_SYSTEM
4156 value
= XCAR (XCDR (spec
));
4157 if (NUMBERP (value
))
4159 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4160 it
->voffset
= - (XFLOATINT (value
)
4161 * (FONT_HEIGHT (face
->font
)));
4163 #endif /* HAVE_WINDOW_SYSTEM */
4168 /* Don't handle the other kinds of display specifications
4169 inside a string that we got from a `display' property. */
4170 if (it
->string_from_display_prop_p
)
4173 /* Characters having this form of property are not displayed, so
4174 we have to find the end of the property. */
4175 start_pos
= *position
;
4176 *position
= display_prop_end (it
, object
, start_pos
);
4179 /* Stop the scan at that end position--we assume that all
4180 text properties change there. */
4181 it
->stop_charpos
= position
->charpos
;
4183 /* Handle `(left-fringe BITMAP [FACE])'
4184 and `(right-fringe BITMAP [FACE])'. */
4186 && (EQ (XCAR (spec
), Qleft_fringe
)
4187 || EQ (XCAR (spec
), Qright_fringe
))
4188 && CONSP (XCDR (spec
)))
4190 int face_id
= DEFAULT_FACE_ID
;
4193 if (!FRAME_WINDOW_P (it
->f
))
4194 /* If we return here, POSITION has been advanced
4195 across the text with this property. */
4198 #ifdef HAVE_WINDOW_SYSTEM
4199 value
= XCAR (XCDR (spec
));
4200 if (!SYMBOLP (value
)
4201 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4202 /* If we return here, POSITION has been advanced
4203 across the text with this property. */
4206 if (CONSP (XCDR (XCDR (spec
))))
4208 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4209 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4215 /* Save current settings of IT so that we can restore them
4216 when we are finished with the glyph property value. */
4218 save_pos
= it
->position
;
4219 it
->position
= *position
;
4221 it
->position
= save_pos
;
4223 it
->area
= TEXT_AREA
;
4224 it
->what
= IT_IMAGE
;
4225 it
->image_id
= -1; /* no image */
4226 it
->position
= start_pos
;
4227 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4228 it
->method
= GET_FROM_IMAGE
;
4229 it
->from_overlay
= Qnil
;
4230 it
->face_id
= face_id
;
4232 /* Say that we haven't consumed the characters with
4233 `display' property yet. The call to pop_it in
4234 set_iterator_to_next will clean this up. */
4235 *position
= start_pos
;
4237 if (EQ (XCAR (spec
), Qleft_fringe
))
4239 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4240 it
->left_user_fringe_face_id
= face_id
;
4244 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4245 it
->right_user_fringe_face_id
= face_id
;
4247 #endif /* HAVE_WINDOW_SYSTEM */
4251 /* Prepare to handle `((margin left-margin) ...)',
4252 `((margin right-margin) ...)' and `((margin nil) ...)'
4253 prefixes for display specifications. */
4254 location
= Qunbound
;
4255 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4259 value
= XCDR (spec
);
4261 value
= XCAR (value
);
4264 if (EQ (XCAR (tem
), Qmargin
)
4265 && (tem
= XCDR (tem
),
4266 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4268 || EQ (tem
, Qleft_margin
)
4269 || EQ (tem
, Qright_margin
))))
4273 if (EQ (location
, Qunbound
))
4279 /* After this point, VALUE is the property after any
4280 margin prefix has been stripped. It must be a string,
4281 an image specification, or `(space ...)'.
4283 LOCATION specifies where to display: `left-margin',
4284 `right-margin' or nil. */
4286 valid_p
= (STRINGP (value
)
4287 #ifdef HAVE_WINDOW_SYSTEM
4288 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4289 #endif /* not HAVE_WINDOW_SYSTEM */
4290 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4292 if (valid_p
&& !display_replaced_before_p
)
4294 /* Save current settings of IT so that we can restore them
4295 when we are finished with the glyph property value. */
4296 save_pos
= it
->position
;
4297 it
->position
= *position
;
4299 it
->position
= save_pos
;
4300 it
->from_overlay
= overlay
;
4302 if (NILP (location
))
4303 it
->area
= TEXT_AREA
;
4304 else if (EQ (location
, Qleft_margin
))
4305 it
->area
= LEFT_MARGIN_AREA
;
4307 it
->area
= RIGHT_MARGIN_AREA
;
4309 if (STRINGP (value
))
4311 if (SCHARS (value
) == 0)
4314 return -1; /* Replaced by "", i.e. nothing. */
4317 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4318 it
->current
.overlay_string_index
= -1;
4319 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4320 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4321 it
->method
= GET_FROM_STRING
;
4322 it
->stop_charpos
= 0;
4323 it
->string_from_display_prop_p
= 1;
4324 /* Say that we haven't consumed the characters with
4325 `display' property yet. The call to pop_it in
4326 set_iterator_to_next will clean this up. */
4327 if (BUFFERP (object
))
4328 *position
= start_pos
;
4330 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4332 it
->method
= GET_FROM_STRETCH
;
4334 *position
= it
->position
= start_pos
;
4336 #ifdef HAVE_WINDOW_SYSTEM
4339 it
->what
= IT_IMAGE
;
4340 it
->image_id
= lookup_image (it
->f
, value
);
4341 it
->position
= start_pos
;
4342 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4343 it
->method
= GET_FROM_IMAGE
;
4345 /* Say that we haven't consumed the characters with
4346 `display' property yet. The call to pop_it in
4347 set_iterator_to_next will clean this up. */
4348 *position
= start_pos
;
4350 #endif /* HAVE_WINDOW_SYSTEM */
4355 /* Invalid property or property not supported. Restore
4356 POSITION to what it was before. */
4357 *position
= start_pos
;
4362 /* Check if SPEC is a display sub-property value whose text should be
4363 treated as intangible. */
4366 single_display_spec_intangible_p (prop
)
4369 /* Skip over `when FORM'. */
4370 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4384 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4385 we don't need to treat text as intangible. */
4386 if (EQ (XCAR (prop
), Qmargin
))
4394 || EQ (XCAR (prop
), Qleft_margin
)
4395 || EQ (XCAR (prop
), Qright_margin
))
4399 return (CONSP (prop
)
4400 && (EQ (XCAR (prop
), Qimage
)
4401 || EQ (XCAR (prop
), Qspace
)));
4405 /* Check if PROP is a display property value whose text should be
4406 treated as intangible. */
4409 display_prop_intangible_p (prop
)
4413 && CONSP (XCAR (prop
))
4414 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4416 /* A list of sub-properties. */
4417 while (CONSP (prop
))
4419 if (single_display_spec_intangible_p (XCAR (prop
)))
4424 else if (VECTORP (prop
))
4426 /* A vector of sub-properties. */
4428 for (i
= 0; i
< ASIZE (prop
); ++i
)
4429 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4433 return single_display_spec_intangible_p (prop
);
4439 /* Return 1 if PROP is a display sub-property value containing STRING. */
4442 single_display_spec_string_p (prop
, string
)
4443 Lisp_Object prop
, string
;
4445 if (EQ (string
, prop
))
4448 /* Skip over `when FORM'. */
4449 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4458 /* Skip over `margin LOCATION'. */
4459 if (EQ (XCAR (prop
), Qmargin
))
4470 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4474 /* Return 1 if STRING appears in the `display' property PROP. */
4477 display_prop_string_p (prop
, string
)
4478 Lisp_Object prop
, string
;
4481 && CONSP (XCAR (prop
))
4482 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4484 /* A list of sub-properties. */
4485 while (CONSP (prop
))
4487 if (single_display_spec_string_p (XCAR (prop
), string
))
4492 else if (VECTORP (prop
))
4494 /* A vector of sub-properties. */
4496 for (i
= 0; i
< ASIZE (prop
); ++i
)
4497 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4501 return single_display_spec_string_p (prop
, string
);
4507 /* Determine from which buffer position in W's buffer STRING comes
4508 from. AROUND_CHARPOS is an approximate position where it could
4509 be from. Value is the buffer position or 0 if it couldn't be
4512 W's buffer must be current.
4514 This function is necessary because we don't record buffer positions
4515 in glyphs generated from strings (to keep struct glyph small).
4516 This function may only use code that doesn't eval because it is
4517 called asynchronously from note_mouse_highlight. */
4520 string_buffer_position (w
, string
, around_charpos
)
4525 Lisp_Object limit
, prop
, pos
;
4526 const int MAX_DISTANCE
= 1000;
4529 pos
= make_number (around_charpos
);
4530 limit
= make_number (min (XINT (pos
) + MAX_DISTANCE
, ZV
));
4531 while (!found
&& !EQ (pos
, limit
))
4533 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4534 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4537 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
, limit
);
4542 pos
= make_number (around_charpos
);
4543 limit
= make_number (max (XINT (pos
) - MAX_DISTANCE
, BEGV
));
4544 while (!found
&& !EQ (pos
, limit
))
4546 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4547 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4550 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4555 return found
? XINT (pos
) : 0;
4560 /***********************************************************************
4561 `composition' property
4562 ***********************************************************************/
4564 static enum prop_handled
4565 handle_auto_composed_prop (it
)
4568 enum prop_handled handled
= HANDLED_NORMALLY
;
4570 if (FUNCTIONP (Vauto_composition_function
))
4572 Lisp_Object val
= Qnil
;
4573 EMACS_INT pos
, limit
= -1;
4575 if (STRINGP (it
->string
))
4576 pos
= IT_STRING_CHARPOS (*it
);
4578 pos
= IT_CHARPOS (*it
);
4580 val
= Fget_text_property (make_number (pos
), Qauto_composed
, it
->string
);
4583 Lisp_Object cmp_prop
;
4584 EMACS_INT cmp_start
, cmp_end
;
4586 #ifdef USE_FONT_BACKEND
4587 if (enable_font_backend
4588 && get_property_and_range (pos
, Qcomposition
, &cmp_prop
,
4589 &cmp_start
, &cmp_end
, it
->string
)
4591 && COMPOSITION_METHOD (cmp_prop
) == COMPOSITION_WITH_GLYPH_STRING
)
4593 Lisp_Object gstring
= COMPOSITION_COMPONENTS (cmp_prop
);
4594 Lisp_Object font_object
= LGSTRING_FONT (gstring
);
4596 if (! EQ (font_object
,
4597 font_at (-1, pos
, FACE_FROM_ID (it
->f
, it
->face_id
),
4598 it
->w
, it
->string
)))
4599 /* We must re-compute the composition for the
4608 /* As Fnext_single_char_property_change is very slow, we
4609 limit the search to the current line. */
4610 if (STRINGP (it
->string
))
4611 limit
= SCHARS (it
->string
);
4613 limit
= find_next_newline_no_quit (pos
, 1);
4614 end
= Fnext_single_char_property_change (make_number (pos
),
4617 make_number (limit
));
4619 if (XINT (end
) < limit
)
4620 /* The current point is auto-composed, but there exist
4621 characters not yet composed beyond the
4622 auto-composed region. There's a possiblity that
4623 the last characters in the region may be newly
4628 if (NILP (val
) && ! STRINGP (it
->string
))
4631 limit
= (STRINGP (it
->string
) ? SCHARS (it
->string
)
4632 : find_next_newline_no_quit (pos
, 1));
4635 int count
= SPECPDL_INDEX ();
4636 Lisp_Object args
[5];
4638 args
[0] = Vauto_composition_function
;
4639 specbind (Qauto_composition_function
, Qnil
);
4640 args
[1] = make_number (pos
);
4641 args
[2] = make_number (limit
);
4642 #ifdef USE_FONT_BACKEND
4643 if (enable_font_backend
)
4644 args
[3] = it
->window
;
4646 #endif /* USE_FONT_BACKEND */
4648 args
[4] = it
->string
;
4649 safe_call (5, args
);
4650 unbind_to (count
, Qnil
);
4658 /* Set up iterator IT from `composition' property at its current
4659 position. Called from handle_stop. */
4661 static enum prop_handled
4662 handle_composition_prop (it
)
4665 Lisp_Object prop
, string
;
4666 EMACS_INT pos
, pos_byte
, start
, end
;
4667 enum prop_handled handled
= HANDLED_NORMALLY
;
4669 if (STRINGP (it
->string
))
4673 pos
= IT_STRING_CHARPOS (*it
);
4674 pos_byte
= IT_STRING_BYTEPOS (*it
);
4675 string
= it
->string
;
4676 s
= SDATA (string
) + pos_byte
;
4677 it
->c
= STRING_CHAR (s
, 0);
4681 pos
= IT_CHARPOS (*it
);
4682 pos_byte
= IT_BYTEPOS (*it
);
4684 it
->c
= FETCH_CHAR (pos_byte
);
4687 /* If there's a valid composition and point is not inside of the
4688 composition (in the case that the composition is from the current
4689 buffer), draw a glyph composed from the composition components. */
4690 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4691 && COMPOSITION_VALID_P (start
, end
, prop
)
4692 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4698 if (STRINGP (it
->string
))
4699 pos_byte
= string_char_to_byte (it
->string
, start
);
4701 pos_byte
= CHAR_TO_BYTE (start
);
4703 id
= get_composition_id (start
, pos_byte
, end
- start
, prop
, string
);
4707 struct composition
*cmp
= composition_table
[id
];
4709 if (cmp
->glyph_len
== 0)
4712 if (STRINGP (it
->string
))
4714 IT_STRING_CHARPOS (*it
) = end
;
4715 IT_STRING_BYTEPOS (*it
) = string_char_to_byte (it
->string
,
4720 IT_CHARPOS (*it
) = end
;
4721 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (end
);
4723 return HANDLED_RECOMPUTE_PROPS
;
4726 it
->stop_charpos
= end
;
4729 it
->method
= GET_FROM_COMPOSITION
;
4731 it
->cmp_len
= COMPOSITION_LENGTH (prop
);
4732 /* For a terminal, draw only the first (non-TAB) character
4733 of the components. */
4734 #ifdef USE_FONT_BACKEND
4735 if (composition_table
[id
]->method
== COMPOSITION_WITH_GLYPH_STRING
)
4737 /* FIXME: This doesn't do anything!?! */
4738 Lisp_Object lgstring
= AREF (XHASH_TABLE (composition_hash_table
)
4740 cmp
->hash_index
* 2);
4743 #endif /* USE_FONT_BACKEND */
4747 for (i
= 0; i
< cmp
->glyph_len
; i
++)
4748 if ((it
->c
= COMPOSITION_GLYPH (composition_table
[id
], i
))
4754 it
->len
= (STRINGP (it
->string
)
4755 ? string_char_to_byte (it
->string
, end
)
4756 : CHAR_TO_BYTE (end
)) - pos_byte
;
4757 handled
= HANDLED_RETURN
;
4766 /***********************************************************************
4768 ***********************************************************************/
4770 /* The following structure is used to record overlay strings for
4771 later sorting in load_overlay_strings. */
4773 struct overlay_entry
4775 Lisp_Object overlay
;
4782 /* Set up iterator IT from overlay strings at its current position.
4783 Called from handle_stop. */
4785 static enum prop_handled
4786 handle_overlay_change (it
)
4789 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4790 return HANDLED_RECOMPUTE_PROPS
;
4792 return HANDLED_NORMALLY
;
4796 /* Set up the next overlay string for delivery by IT, if there is an
4797 overlay string to deliver. Called by set_iterator_to_next when the
4798 end of the current overlay string is reached. If there are more
4799 overlay strings to display, IT->string and
4800 IT->current.overlay_string_index are set appropriately here.
4801 Otherwise IT->string is set to nil. */
4804 next_overlay_string (it
)
4807 ++it
->current
.overlay_string_index
;
4808 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4810 /* No more overlay strings. Restore IT's settings to what
4811 they were before overlay strings were processed, and
4812 continue to deliver from current_buffer. */
4813 int display_ellipsis_p
= it
->stack
[it
->sp
- 1].display_ellipsis_p
;
4817 || it
->method
== GET_FROM_COMPOSITION
4818 || (NILP (it
->string
)
4819 && it
->method
== GET_FROM_BUFFER
4820 && it
->stop_charpos
>= BEGV
4821 && it
->stop_charpos
<= it
->end_charpos
));
4822 it
->current
.overlay_string_index
= -1;
4823 it
->n_overlay_strings
= 0;
4825 /* If we're at the end of the buffer, record that we have
4826 processed the overlay strings there already, so that
4827 next_element_from_buffer doesn't try it again. */
4828 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4829 it
->overlay_strings_at_end_processed_p
= 1;
4831 /* If we have to display `...' for invisible text, set
4832 the iterator up for that. */
4833 if (display_ellipsis_p
)
4834 setup_for_ellipsis (it
, 0);
4838 /* There are more overlay strings to process. If
4839 IT->current.overlay_string_index has advanced to a position
4840 where we must load IT->overlay_strings with more strings, do
4842 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4844 if (it
->current
.overlay_string_index
&& i
== 0)
4845 load_overlay_strings (it
, 0);
4847 /* Initialize IT to deliver display elements from the overlay
4849 it
->string
= it
->overlay_strings
[i
];
4850 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4851 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4852 it
->method
= GET_FROM_STRING
;
4853 it
->stop_charpos
= 0;
4860 /* Compare two overlay_entry structures E1 and E2. Used as a
4861 comparison function for qsort in load_overlay_strings. Overlay
4862 strings for the same position are sorted so that
4864 1. All after-strings come in front of before-strings, except
4865 when they come from the same overlay.
4867 2. Within after-strings, strings are sorted so that overlay strings
4868 from overlays with higher priorities come first.
4870 2. Within before-strings, strings are sorted so that overlay
4871 strings from overlays with higher priorities come last.
4873 Value is analogous to strcmp. */
4877 compare_overlay_entries (e1
, e2
)
4880 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4881 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4884 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4886 /* Let after-strings appear in front of before-strings if
4887 they come from different overlays. */
4888 if (EQ (entry1
->overlay
, entry2
->overlay
))
4889 result
= entry1
->after_string_p
? 1 : -1;
4891 result
= entry1
->after_string_p
? -1 : 1;
4893 else if (entry1
->after_string_p
)
4894 /* After-strings sorted in order of decreasing priority. */
4895 result
= entry2
->priority
- entry1
->priority
;
4897 /* Before-strings sorted in order of increasing priority. */
4898 result
= entry1
->priority
- entry2
->priority
;
4904 /* Load the vector IT->overlay_strings with overlay strings from IT's
4905 current buffer position, or from CHARPOS if that is > 0. Set
4906 IT->n_overlays to the total number of overlay strings found.
4908 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4909 a time. On entry into load_overlay_strings,
4910 IT->current.overlay_string_index gives the number of overlay
4911 strings that have already been loaded by previous calls to this
4914 IT->add_overlay_start contains an additional overlay start
4915 position to consider for taking overlay strings from, if non-zero.
4916 This position comes into play when the overlay has an `invisible'
4917 property, and both before and after-strings. When we've skipped to
4918 the end of the overlay, because of its `invisible' property, we
4919 nevertheless want its before-string to appear.
4920 IT->add_overlay_start will contain the overlay start position
4923 Overlay strings are sorted so that after-string strings come in
4924 front of before-string strings. Within before and after-strings,
4925 strings are sorted by overlay priority. See also function
4926 compare_overlay_entries. */
4929 load_overlay_strings (it
, charpos
)
4933 extern Lisp_Object Qafter_string
, Qbefore_string
, Qwindow
, Qpriority
;
4934 Lisp_Object overlay
, window
, str
, invisible
;
4935 struct Lisp_Overlay
*ov
;
4938 int n
= 0, i
, j
, invis_p
;
4939 struct overlay_entry
*entries
4940 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4943 charpos
= IT_CHARPOS (*it
);
4945 /* Append the overlay string STRING of overlay OVERLAY to vector
4946 `entries' which has size `size' and currently contains `n'
4947 elements. AFTER_P non-zero means STRING is an after-string of
4949 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4952 Lisp_Object priority; \
4956 int new_size = 2 * size; \
4957 struct overlay_entry *old = entries; \
4959 (struct overlay_entry *) alloca (new_size \
4960 * sizeof *entries); \
4961 bcopy (old, entries, size * sizeof *entries); \
4965 entries[n].string = (STRING); \
4966 entries[n].overlay = (OVERLAY); \
4967 priority = Foverlay_get ((OVERLAY), Qpriority); \
4968 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4969 entries[n].after_string_p = (AFTER_P); \
4974 /* Process overlay before the overlay center. */
4975 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4977 XSETMISC (overlay
, ov
);
4978 xassert (OVERLAYP (overlay
));
4979 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4980 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4985 /* Skip this overlay if it doesn't start or end at IT's current
4987 if (end
!= charpos
&& start
!= charpos
)
4990 /* Skip this overlay if it doesn't apply to IT->w. */
4991 window
= Foverlay_get (overlay
, Qwindow
);
4992 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4995 /* If the text ``under'' the overlay is invisible, both before-
4996 and after-strings from this overlay are visible; start and
4997 end position are indistinguishable. */
4998 invisible
= Foverlay_get (overlay
, Qinvisible
);
4999 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5001 /* If overlay has a non-empty before-string, record it. */
5002 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5003 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5005 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5007 /* If overlay has a non-empty after-string, record it. */
5008 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5009 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5011 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5014 /* Process overlays after the overlay center. */
5015 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5017 XSETMISC (overlay
, ov
);
5018 xassert (OVERLAYP (overlay
));
5019 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5020 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5022 if (start
> charpos
)
5025 /* Skip this overlay if it doesn't start or end at IT's current
5027 if (end
!= charpos
&& start
!= charpos
)
5030 /* Skip this overlay if it doesn't apply to IT->w. */
5031 window
= Foverlay_get (overlay
, Qwindow
);
5032 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5035 /* If the text ``under'' the overlay is invisible, it has a zero
5036 dimension, and both before- and after-strings apply. */
5037 invisible
= Foverlay_get (overlay
, Qinvisible
);
5038 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5040 /* If overlay has a non-empty before-string, record it. */
5041 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5042 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5044 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5046 /* If overlay has a non-empty after-string, record it. */
5047 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5048 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5050 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5053 #undef RECORD_OVERLAY_STRING
5057 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5059 /* Record the total number of strings to process. */
5060 it
->n_overlay_strings
= n
;
5062 /* IT->current.overlay_string_index is the number of overlay strings
5063 that have already been consumed by IT. Copy some of the
5064 remaining overlay strings to IT->overlay_strings. */
5066 j
= it
->current
.overlay_string_index
;
5067 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5069 it
->overlay_strings
[i
] = entries
[j
].string
;
5070 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5077 /* Get the first chunk of overlay strings at IT's current buffer
5078 position, or at CHARPOS if that is > 0. Value is non-zero if at
5079 least one overlay string was found. */
5082 get_overlay_strings_1 (it
, charpos
, compute_stop_p
)
5087 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5088 process. This fills IT->overlay_strings with strings, and sets
5089 IT->n_overlay_strings to the total number of strings to process.
5090 IT->pos.overlay_string_index has to be set temporarily to zero
5091 because load_overlay_strings needs this; it must be set to -1
5092 when no overlay strings are found because a zero value would
5093 indicate a position in the first overlay string. */
5094 it
->current
.overlay_string_index
= 0;
5095 load_overlay_strings (it
, charpos
);
5097 /* If we found overlay strings, set up IT to deliver display
5098 elements from the first one. Otherwise set up IT to deliver
5099 from current_buffer. */
5100 if (it
->n_overlay_strings
)
5102 /* Make sure we know settings in current_buffer, so that we can
5103 restore meaningful values when we're done with the overlay
5106 compute_stop_pos (it
);
5107 xassert (it
->face_id
>= 0);
5109 /* Save IT's settings. They are restored after all overlay
5110 strings have been processed. */
5111 xassert (!compute_stop_p
|| it
->sp
== 0);
5114 /* Set up IT to deliver display elements from the first overlay
5116 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5117 it
->string
= it
->overlay_strings
[0];
5118 it
->from_overlay
= Qnil
;
5119 it
->stop_charpos
= 0;
5120 xassert (STRINGP (it
->string
));
5121 it
->end_charpos
= SCHARS (it
->string
);
5122 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5123 it
->method
= GET_FROM_STRING
;
5127 it
->current
.overlay_string_index
= -1;
5132 get_overlay_strings (it
, charpos
)
5137 it
->method
= GET_FROM_BUFFER
;
5139 (void) get_overlay_strings_1 (it
, charpos
, 1);
5143 /* Value is non-zero if we found at least one overlay string. */
5144 return STRINGP (it
->string
);
5149 /***********************************************************************
5150 Saving and restoring state
5151 ***********************************************************************/
5153 /* Save current settings of IT on IT->stack. Called, for example,
5154 before setting up IT for an overlay string, to be able to restore
5155 IT's settings to what they were after the overlay string has been
5162 struct iterator_stack_entry
*p
;
5164 xassert (it
->sp
< IT_STACK_SIZE
);
5165 p
= it
->stack
+ it
->sp
;
5167 p
->stop_charpos
= it
->stop_charpos
;
5168 xassert (it
->face_id
>= 0);
5169 p
->face_id
= it
->face_id
;
5170 p
->string
= it
->string
;
5171 p
->method
= it
->method
;
5172 p
->from_overlay
= it
->from_overlay
;
5175 case GET_FROM_IMAGE
:
5176 p
->u
.image
.object
= it
->object
;
5177 p
->u
.image
.image_id
= it
->image_id
;
5178 p
->u
.image
.slice
= it
->slice
;
5180 case GET_FROM_COMPOSITION
:
5181 p
->u
.comp
.object
= it
->object
;
5182 p
->u
.comp
.c
= it
->c
;
5183 p
->u
.comp
.len
= it
->len
;
5184 p
->u
.comp
.cmp_id
= it
->cmp_id
;
5185 p
->u
.comp
.cmp_len
= it
->cmp_len
;
5187 case GET_FROM_STRETCH
:
5188 p
->u
.stretch
.object
= it
->object
;
5191 p
->position
= it
->position
;
5192 p
->current
= it
->current
;
5193 p
->end_charpos
= it
->end_charpos
;
5194 p
->string_nchars
= it
->string_nchars
;
5196 p
->multibyte_p
= it
->multibyte_p
;
5197 p
->space_width
= it
->space_width
;
5198 p
->font_height
= it
->font_height
;
5199 p
->voffset
= it
->voffset
;
5200 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5201 p
->display_ellipsis_p
= 0;
5206 /* Restore IT's settings from IT->stack. Called, for example, when no
5207 more overlay strings must be processed, and we return to delivering
5208 display elements from a buffer, or when the end of a string from a
5209 `display' property is reached and we return to delivering display
5210 elements from an overlay string, or from a buffer. */
5216 struct iterator_stack_entry
*p
;
5218 xassert (it
->sp
> 0);
5220 p
= it
->stack
+ it
->sp
;
5221 it
->stop_charpos
= p
->stop_charpos
;
5222 it
->face_id
= p
->face_id
;
5223 it
->current
= p
->current
;
5224 it
->position
= p
->position
;
5225 it
->string
= p
->string
;
5226 it
->from_overlay
= p
->from_overlay
;
5227 if (NILP (it
->string
))
5228 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5229 it
->method
= p
->method
;
5232 case GET_FROM_IMAGE
:
5233 it
->image_id
= p
->u
.image
.image_id
;
5234 it
->object
= p
->u
.image
.object
;
5235 it
->slice
= p
->u
.image
.slice
;
5237 case GET_FROM_COMPOSITION
:
5238 it
->object
= p
->u
.comp
.object
;
5239 it
->c
= p
->u
.comp
.c
;
5240 it
->len
= p
->u
.comp
.len
;
5241 it
->cmp_id
= p
->u
.comp
.cmp_id
;
5242 it
->cmp_len
= p
->u
.comp
.cmp_len
;
5244 case GET_FROM_STRETCH
:
5245 it
->object
= p
->u
.comp
.object
;
5247 case GET_FROM_BUFFER
:
5248 it
->object
= it
->w
->buffer
;
5250 case GET_FROM_STRING
:
5251 it
->object
= it
->string
;
5254 it
->end_charpos
= p
->end_charpos
;
5255 it
->string_nchars
= p
->string_nchars
;
5257 it
->multibyte_p
= p
->multibyte_p
;
5258 it
->space_width
= p
->space_width
;
5259 it
->font_height
= p
->font_height
;
5260 it
->voffset
= p
->voffset
;
5261 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5266 /***********************************************************************
5268 ***********************************************************************/
5270 /* Set IT's current position to the previous line start. */
5273 back_to_previous_line_start (it
)
5276 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5277 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5281 /* Move IT to the next line start.
5283 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5284 we skipped over part of the text (as opposed to moving the iterator
5285 continuously over the text). Otherwise, don't change the value
5288 Newlines may come from buffer text, overlay strings, or strings
5289 displayed via the `display' property. That's the reason we can't
5290 simply use find_next_newline_no_quit.
5292 Note that this function may not skip over invisible text that is so
5293 because of text properties and immediately follows a newline. If
5294 it would, function reseat_at_next_visible_line_start, when called
5295 from set_iterator_to_next, would effectively make invisible
5296 characters following a newline part of the wrong glyph row, which
5297 leads to wrong cursor motion. */
5300 forward_to_next_line_start (it
, skipped_p
)
5304 int old_selective
, newline_found_p
, n
;
5305 const int MAX_NEWLINE_DISTANCE
= 500;
5307 /* If already on a newline, just consume it to avoid unintended
5308 skipping over invisible text below. */
5309 if (it
->what
== IT_CHARACTER
5311 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5313 set_iterator_to_next (it
, 0);
5318 /* Don't handle selective display in the following. It's (a)
5319 unnecessary because it's done by the caller, and (b) leads to an
5320 infinite recursion because next_element_from_ellipsis indirectly
5321 calls this function. */
5322 old_selective
= it
->selective
;
5325 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5326 from buffer text. */
5327 for (n
= newline_found_p
= 0;
5328 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5329 n
+= STRINGP (it
->string
) ? 0 : 1)
5331 if (!get_next_display_element (it
))
5333 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5334 set_iterator_to_next (it
, 0);
5337 /* If we didn't find a newline near enough, see if we can use a
5339 if (!newline_found_p
)
5341 int start
= IT_CHARPOS (*it
);
5342 int limit
= find_next_newline_no_quit (start
, 1);
5345 xassert (!STRINGP (it
->string
));
5347 /* If there isn't any `display' property in sight, and no
5348 overlays, we can just use the position of the newline in
5350 if (it
->stop_charpos
>= limit
5351 || ((pos
= Fnext_single_property_change (make_number (start
),
5353 Qnil
, make_number (limit
)),
5355 && next_overlay_change (start
) == ZV
))
5357 IT_CHARPOS (*it
) = limit
;
5358 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5359 *skipped_p
= newline_found_p
= 1;
5363 while (get_next_display_element (it
)
5364 && !newline_found_p
)
5366 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5367 set_iterator_to_next (it
, 0);
5372 it
->selective
= old_selective
;
5373 return newline_found_p
;
5377 /* Set IT's current position to the previous visible line start. Skip
5378 invisible text that is so either due to text properties or due to
5379 selective display. Caution: this does not change IT->current_x and
5383 back_to_previous_visible_line_start (it
)
5386 while (IT_CHARPOS (*it
) > BEGV
)
5388 back_to_previous_line_start (it
);
5390 if (IT_CHARPOS (*it
) <= BEGV
)
5393 /* If selective > 0, then lines indented more than that values
5395 if (it
->selective
> 0
5396 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5397 (double) it
->selective
)) /* iftc */
5400 /* Check the newline before point for invisibility. */
5403 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5404 Qinvisible
, it
->window
);
5405 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5409 if (IT_CHARPOS (*it
) <= BEGV
)
5416 Lisp_Object val
, overlay
;
5418 /* If newline is part of a composition, continue from start of composition */
5419 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5420 && beg
< IT_CHARPOS (*it
))
5423 /* If newline is replaced by a display property, find start of overlay
5424 or interval and continue search from that point. */
5426 pos
= --IT_CHARPOS (it2
);
5429 if (handle_display_prop (&it2
) == HANDLED_RETURN
5430 && !NILP (val
= get_char_property_and_overlay
5431 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5432 && (OVERLAYP (overlay
)
5433 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5434 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5437 /* Newline is not replaced by anything -- so we are done. */
5443 IT_CHARPOS (*it
) = beg
;
5444 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5448 it
->continuation_lines_width
= 0;
5450 xassert (IT_CHARPOS (*it
) >= BEGV
);
5451 xassert (IT_CHARPOS (*it
) == BEGV
5452 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5457 /* Reseat iterator IT at the previous visible line start. Skip
5458 invisible text that is so either due to text properties or due to
5459 selective display. At the end, update IT's overlay information,
5460 face information etc. */
5463 reseat_at_previous_visible_line_start (it
)
5466 back_to_previous_visible_line_start (it
);
5467 reseat (it
, it
->current
.pos
, 1);
5472 /* Reseat iterator IT on the next visible line start in the current
5473 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5474 preceding the line start. Skip over invisible text that is so
5475 because of selective display. Compute faces, overlays etc at the
5476 new position. Note that this function does not skip over text that
5477 is invisible because of text properties. */
5480 reseat_at_next_visible_line_start (it
, on_newline_p
)
5484 int newline_found_p
, skipped_p
= 0;
5486 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5488 /* Skip over lines that are invisible because they are indented
5489 more than the value of IT->selective. */
5490 if (it
->selective
> 0)
5491 while (IT_CHARPOS (*it
) < ZV
5492 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5493 (double) it
->selective
)) /* iftc */
5495 xassert (IT_BYTEPOS (*it
) == BEGV
5496 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5497 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5500 /* Position on the newline if that's what's requested. */
5501 if (on_newline_p
&& newline_found_p
)
5503 if (STRINGP (it
->string
))
5505 if (IT_STRING_CHARPOS (*it
) > 0)
5507 --IT_STRING_CHARPOS (*it
);
5508 --IT_STRING_BYTEPOS (*it
);
5511 else if (IT_CHARPOS (*it
) > BEGV
)
5515 reseat (it
, it
->current
.pos
, 0);
5519 reseat (it
, it
->current
.pos
, 0);
5526 /***********************************************************************
5527 Changing an iterator's position
5528 ***********************************************************************/
5530 /* Change IT's current position to POS in current_buffer. If FORCE_P
5531 is non-zero, always check for text properties at the new position.
5532 Otherwise, text properties are only looked up if POS >=
5533 IT->check_charpos of a property. */
5536 reseat (it
, pos
, force_p
)
5538 struct text_pos pos
;
5541 int original_pos
= IT_CHARPOS (*it
);
5543 reseat_1 (it
, pos
, 0);
5545 /* Determine where to check text properties. Avoid doing it
5546 where possible because text property lookup is very expensive. */
5548 || CHARPOS (pos
) > it
->stop_charpos
5549 || CHARPOS (pos
) < original_pos
)
5556 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5557 IT->stop_pos to POS, also. */
5560 reseat_1 (it
, pos
, set_stop_p
)
5562 struct text_pos pos
;
5565 /* Don't call this function when scanning a C string. */
5566 xassert (it
->s
== NULL
);
5568 /* POS must be a reasonable value. */
5569 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5571 it
->current
.pos
= it
->position
= pos
;
5572 it
->end_charpos
= ZV
;
5574 it
->current
.dpvec_index
= -1;
5575 it
->current
.overlay_string_index
= -1;
5576 IT_STRING_CHARPOS (*it
) = -1;
5577 IT_STRING_BYTEPOS (*it
) = -1;
5579 it
->method
= GET_FROM_BUFFER
;
5580 it
->object
= it
->w
->buffer
;
5581 it
->area
= TEXT_AREA
;
5582 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
5584 it
->string_from_display_prop_p
= 0;
5585 it
->face_before_selective_p
= 0;
5588 it
->stop_charpos
= CHARPOS (pos
);
5592 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5593 If S is non-null, it is a C string to iterate over. Otherwise,
5594 STRING gives a Lisp string to iterate over.
5596 If PRECISION > 0, don't return more then PRECISION number of
5597 characters from the string.
5599 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5600 characters have been returned. FIELD_WIDTH < 0 means an infinite
5603 MULTIBYTE = 0 means disable processing of multibyte characters,
5604 MULTIBYTE > 0 means enable it,
5605 MULTIBYTE < 0 means use IT->multibyte_p.
5607 IT must be initialized via a prior call to init_iterator before
5608 calling this function. */
5611 reseat_to_string (it
, s
, string
, charpos
, precision
, field_width
, multibyte
)
5616 int precision
, field_width
, multibyte
;
5618 /* No region in strings. */
5619 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5621 /* No text property checks performed by default, but see below. */
5622 it
->stop_charpos
= -1;
5624 /* Set iterator position and end position. */
5625 bzero (&it
->current
, sizeof it
->current
);
5626 it
->current
.overlay_string_index
= -1;
5627 it
->current
.dpvec_index
= -1;
5628 xassert (charpos
>= 0);
5630 /* If STRING is specified, use its multibyteness, otherwise use the
5631 setting of MULTIBYTE, if specified. */
5633 it
->multibyte_p
= multibyte
> 0;
5637 xassert (STRINGP (string
));
5638 it
->string
= string
;
5640 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5641 it
->method
= GET_FROM_STRING
;
5642 it
->current
.string_pos
= string_pos (charpos
, string
);
5649 /* Note that we use IT->current.pos, not it->current.string_pos,
5650 for displaying C strings. */
5651 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5652 if (it
->multibyte_p
)
5654 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5655 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5659 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5660 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5663 it
->method
= GET_FROM_C_STRING
;
5666 /* PRECISION > 0 means don't return more than PRECISION characters
5668 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5669 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5671 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5672 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5673 FIELD_WIDTH < 0 means infinite field width. This is useful for
5674 padding with `-' at the end of a mode line. */
5675 if (field_width
< 0)
5676 field_width
= INFINITY
;
5677 if (field_width
> it
->end_charpos
- charpos
)
5678 it
->end_charpos
= charpos
+ field_width
;
5680 /* Use the standard display table for displaying strings. */
5681 if (DISP_TABLE_P (Vstandard_display_table
))
5682 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5684 it
->stop_charpos
= charpos
;
5690 /***********************************************************************
5692 ***********************************************************************/
5694 /* Map enum it_method value to corresponding next_element_from_* function. */
5696 static int (* get_next_element
[NUM_IT_METHODS
]) P_ ((struct it
*it
)) =
5698 next_element_from_buffer
,
5699 next_element_from_display_vector
,
5700 next_element_from_composition
,
5701 next_element_from_string
,
5702 next_element_from_c_string
,
5703 next_element_from_image
,
5704 next_element_from_stretch
5707 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5709 /* Load IT's display element fields with information about the next
5710 display element from the current position of IT. Value is zero if
5711 end of buffer (or C string) is reached. */
5713 static struct frame
*last_escape_glyph_frame
= NULL
;
5714 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5715 static int last_escape_glyph_merged_face_id
= 0;
5718 get_next_display_element (it
)
5721 /* Non-zero means that we found a display element. Zero means that
5722 we hit the end of what we iterate over. Performance note: the
5723 function pointer `method' used here turns out to be faster than
5724 using a sequence of if-statements. */
5728 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5730 if (it
->what
== IT_CHARACTER
)
5732 /* Map via display table or translate control characters.
5733 IT->c, IT->len etc. have been set to the next character by
5734 the function call above. If we have a display table, and it
5735 contains an entry for IT->c, translate it. Don't do this if
5736 IT->c itself comes from a display table, otherwise we could
5737 end up in an infinite recursion. (An alternative could be to
5738 count the recursion depth of this function and signal an
5739 error when a certain maximum depth is reached.) Is it worth
5741 if (success_p
&& it
->dpvec
== NULL
)
5746 && (dv
= DISP_CHAR_VECTOR (it
->dp
, it
->c
),
5749 struct Lisp_Vector
*v
= XVECTOR (dv
);
5751 /* Return the first character from the display table
5752 entry, if not empty. If empty, don't display the
5753 current character. */
5756 it
->dpvec_char_len
= it
->len
;
5757 it
->dpvec
= v
->contents
;
5758 it
->dpend
= v
->contents
+ v
->size
;
5759 it
->current
.dpvec_index
= 0;
5760 it
->dpvec_face_id
= -1;
5761 it
->saved_face_id
= it
->face_id
;
5762 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5767 set_iterator_to_next (it
, 0);
5772 /* Translate control characters into `\003' or `^C' form.
5773 Control characters coming from a display table entry are
5774 currently not translated because we use IT->dpvec to hold
5775 the translation. This could easily be changed but I
5776 don't believe that it is worth doing.
5778 If it->multibyte_p is nonzero, non-printable non-ASCII
5779 characters are also translated to octal form.
5781 If it->multibyte_p is zero, eight-bit characters that
5782 don't have corresponding multibyte char code are also
5783 translated to octal form. */
5784 else if ((it
->c
< ' '
5785 ? (it
->area
!= TEXT_AREA
5786 /* In mode line, treat \n, \t like other crl chars. */
5788 && it
->glyph_row
&& it
->glyph_row
->mode_line_p
)
5789 || (it
->c
!= '\n' && it
->c
!= '\t'))
5791 ? (!CHAR_PRINTABLE_P (it
->c
)
5792 || (!NILP (Vnobreak_char_display
)
5793 && (it
->c
== 0xA0 /* NO-BREAK SPACE */
5794 || it
->c
== 0xAD /* SOFT HYPHEN */)))
5796 && (! unibyte_display_via_language_environment
5797 || (UNIBYTE_CHAR_HAS_MULTIBYTE_P (it
->c
)))))))
5799 /* IT->c is a control character which must be displayed
5800 either as '\003' or as `^C' where the '\\' and '^'
5801 can be defined in the display table. Fill
5802 IT->ctl_chars with glyphs for what we have to
5803 display. Then, set IT->dpvec to these glyphs. */
5806 int face_id
, lface_id
= 0 ;
5809 /* Handle control characters with ^. */
5811 if (it
->c
< 128 && it
->ctl_arrow_p
)
5815 g
= '^'; /* default glyph for Control */
5816 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5818 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5819 && GLYPH_CODE_CHAR_VALID_P (gc
))
5821 g
= GLYPH_CODE_CHAR (gc
);
5822 lface_id
= GLYPH_CODE_FACE (gc
);
5826 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5828 else if (it
->f
== last_escape_glyph_frame
5829 && it
->face_id
== last_escape_glyph_face_id
)
5831 face_id
= last_escape_glyph_merged_face_id
;
5835 /* Merge the escape-glyph face into the current face. */
5836 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5838 last_escape_glyph_frame
= it
->f
;
5839 last_escape_glyph_face_id
= it
->face_id
;
5840 last_escape_glyph_merged_face_id
= face_id
;
5843 XSETINT (it
->ctl_chars
[0], g
);
5844 XSETINT (it
->ctl_chars
[1], it
->c
^ 0100);
5846 goto display_control
;
5849 /* Handle non-break space in the mode where it only gets
5852 if (EQ (Vnobreak_char_display
, Qt
)
5855 /* Merge the no-break-space face into the current face. */
5856 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5860 XSETINT (it
->ctl_chars
[0], ' ');
5862 goto display_control
;
5865 /* Handle sequences that start with the "escape glyph". */
5867 /* the default escape glyph is \. */
5868 escape_glyph
= '\\';
5871 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5872 && GLYPH_CODE_CHAR_VALID_P (gc
))
5874 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5875 lface_id
= GLYPH_CODE_FACE (gc
);
5879 /* The display table specified a face.
5880 Merge it into face_id and also into escape_glyph. */
5881 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5884 else if (it
->f
== last_escape_glyph_frame
5885 && it
->face_id
== last_escape_glyph_face_id
)
5887 face_id
= last_escape_glyph_merged_face_id
;
5891 /* Merge the escape-glyph face into the current face. */
5892 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5894 last_escape_glyph_frame
= it
->f
;
5895 last_escape_glyph_face_id
= it
->face_id
;
5896 last_escape_glyph_merged_face_id
= face_id
;
5899 /* Handle soft hyphens in the mode where they only get
5902 if (EQ (Vnobreak_char_display
, Qt
)
5906 XSETINT (it
->ctl_chars
[0], '-');
5908 goto display_control
;
5911 /* Handle non-break space and soft hyphen
5912 with the escape glyph. */
5914 if (it
->c
== 0xA0 || it
->c
== 0xAD)
5916 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5917 it
->c
= (it
->c
== 0xA0 ? ' ' : '-');
5918 XSETINT (it
->ctl_chars
[1], it
->c
);
5920 goto display_control
;
5924 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
5928 /* Set IT->ctl_chars[0] to the glyph for `\\'. */
5929 if (CHAR_BYTE8_P (it
->c
))
5931 str
[0] = CHAR_TO_BYTE8 (it
->c
);
5934 else if (it
->c
< 256)
5941 /* It's an invalid character, which shouldn't
5942 happen actually, but due to bugs it may
5943 happen. Let's print the char as is, there's
5944 not much meaningful we can do with it. */
5946 str
[1] = it
->c
>> 8;
5947 str
[2] = it
->c
>> 16;
5948 str
[3] = it
->c
>> 24;
5952 for (i
= 0; i
< len
; i
++)
5955 XSETINT (it
->ctl_chars
[i
* 4], escape_glyph
);
5956 /* Insert three more glyphs into IT->ctl_chars for
5957 the octal display of the character. */
5958 g
= ((str
[i
] >> 6) & 7) + '0';
5959 XSETINT (it
->ctl_chars
[i
* 4 + 1], g
);
5960 g
= ((str
[i
] >> 3) & 7) + '0';
5961 XSETINT (it
->ctl_chars
[i
* 4 + 2], g
);
5962 g
= (str
[i
] & 7) + '0';
5963 XSETINT (it
->ctl_chars
[i
* 4 + 3], g
);
5969 /* Set up IT->dpvec and return first character from it. */
5970 it
->dpvec_char_len
= it
->len
;
5971 it
->dpvec
= it
->ctl_chars
;
5972 it
->dpend
= it
->dpvec
+ ctl_len
;
5973 it
->current
.dpvec_index
= 0;
5974 it
->dpvec_face_id
= face_id
;
5975 it
->saved_face_id
= it
->face_id
;
5976 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5983 /* Adjust face id for a multibyte character. There are no multibyte
5984 character in unibyte text. */
5985 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
5988 && FRAME_WINDOW_P (it
->f
))
5990 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5991 int pos
= (it
->s
? -1
5992 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
5993 : IT_CHARPOS (*it
));
5995 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->c
, pos
, it
->string
);
5998 /* Is this character the last one of a run of characters with
5999 box? If yes, set IT->end_of_box_run_p to 1. */
6006 it
->end_of_box_run_p
6007 = ((face_id
= face_after_it_pos (it
),
6008 face_id
!= it
->face_id
)
6009 && (face
= FACE_FROM_ID (it
->f
, face_id
),
6010 face
->box
== FACE_NO_BOX
));
6013 /* Value is 0 if end of buffer or string reached. */
6018 /* Move IT to the next display element.
6020 RESEAT_P non-zero means if called on a newline in buffer text,
6021 skip to the next visible line start.
6023 Functions get_next_display_element and set_iterator_to_next are
6024 separate because I find this arrangement easier to handle than a
6025 get_next_display_element function that also increments IT's
6026 position. The way it is we can first look at an iterator's current
6027 display element, decide whether it fits on a line, and if it does,
6028 increment the iterator position. The other way around we probably
6029 would either need a flag indicating whether the iterator has to be
6030 incremented the next time, or we would have to implement a
6031 decrement position function which would not be easy to write. */
6034 set_iterator_to_next (it
, reseat_p
)
6038 /* Reset flags indicating start and end of a sequence of characters
6039 with box. Reset them at the start of this function because
6040 moving the iterator to a new position might set them. */
6041 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6045 case GET_FROM_BUFFER
:
6046 /* The current display element of IT is a character from
6047 current_buffer. Advance in the buffer, and maybe skip over
6048 invisible lines that are so because of selective display. */
6049 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6050 reseat_at_next_visible_line_start (it
, 0);
6053 xassert (it
->len
!= 0);
6054 IT_BYTEPOS (*it
) += it
->len
;
6055 IT_CHARPOS (*it
) += 1;
6056 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6060 case GET_FROM_COMPOSITION
:
6061 xassert (it
->cmp_id
>= 0 && it
->cmp_id
< n_compositions
);
6062 xassert (it
->sp
> 0);
6064 if (it
->method
== GET_FROM_STRING
)
6066 IT_STRING_BYTEPOS (*it
) += it
->len
;
6067 IT_STRING_CHARPOS (*it
) += it
->cmp_len
;
6068 goto consider_string_end
;
6070 else if (it
->method
== GET_FROM_BUFFER
)
6072 IT_BYTEPOS (*it
) += it
->len
;
6073 IT_CHARPOS (*it
) += it
->cmp_len
;
6077 case GET_FROM_C_STRING
:
6078 /* Current display element of IT is from a C string. */
6079 IT_BYTEPOS (*it
) += it
->len
;
6080 IT_CHARPOS (*it
) += 1;
6083 case GET_FROM_DISPLAY_VECTOR
:
6084 /* Current display element of IT is from a display table entry.
6085 Advance in the display table definition. Reset it to null if
6086 end reached, and continue with characters from buffers/
6088 ++it
->current
.dpvec_index
;
6090 /* Restore face of the iterator to what they were before the
6091 display vector entry (these entries may contain faces). */
6092 it
->face_id
= it
->saved_face_id
;
6094 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6096 int recheck_faces
= it
->ellipsis_p
;
6099 it
->method
= GET_FROM_C_STRING
;
6100 else if (STRINGP (it
->string
))
6101 it
->method
= GET_FROM_STRING
;
6104 it
->method
= GET_FROM_BUFFER
;
6105 it
->object
= it
->w
->buffer
;
6109 it
->current
.dpvec_index
= -1;
6111 /* Skip over characters which were displayed via IT->dpvec. */
6112 if (it
->dpvec_char_len
< 0)
6113 reseat_at_next_visible_line_start (it
, 1);
6114 else if (it
->dpvec_char_len
> 0)
6116 if (it
->method
== GET_FROM_STRING
6117 && it
->n_overlay_strings
> 0)
6118 it
->ignore_overlay_strings_at_pos_p
= 1;
6119 it
->len
= it
->dpvec_char_len
;
6120 set_iterator_to_next (it
, reseat_p
);
6123 /* Maybe recheck faces after display vector */
6125 it
->stop_charpos
= IT_CHARPOS (*it
);
6129 case GET_FROM_STRING
:
6130 /* Current display element is a character from a Lisp string. */
6131 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6132 IT_STRING_BYTEPOS (*it
) += it
->len
;
6133 IT_STRING_CHARPOS (*it
) += 1;
6135 consider_string_end
:
6137 if (it
->current
.overlay_string_index
>= 0)
6139 /* IT->string is an overlay string. Advance to the
6140 next, if there is one. */
6141 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6142 next_overlay_string (it
);
6146 /* IT->string is not an overlay string. If we reached
6147 its end, and there is something on IT->stack, proceed
6148 with what is on the stack. This can be either another
6149 string, this time an overlay string, or a buffer. */
6150 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6154 if (it
->method
== GET_FROM_STRING
)
6155 goto consider_string_end
;
6160 case GET_FROM_IMAGE
:
6161 case GET_FROM_STRETCH
:
6162 /* The position etc with which we have to proceed are on
6163 the stack. The position may be at the end of a string,
6164 if the `display' property takes up the whole string. */
6165 xassert (it
->sp
> 0);
6167 if (it
->method
== GET_FROM_STRING
)
6168 goto consider_string_end
;
6172 /* There are no other methods defined, so this should be a bug. */
6176 xassert (it
->method
!= GET_FROM_STRING
6177 || (STRINGP (it
->string
)
6178 && IT_STRING_CHARPOS (*it
) >= 0));
6181 /* Load IT's display element fields with information about the next
6182 display element which comes from a display table entry or from the
6183 result of translating a control character to one of the forms `^C'
6186 IT->dpvec holds the glyphs to return as characters.
6187 IT->saved_face_id holds the face id before the display vector--
6188 it is restored into IT->face_idin set_iterator_to_next. */
6191 next_element_from_display_vector (it
)
6197 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6199 it
->face_id
= it
->saved_face_id
;
6201 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6202 That seemed totally bogus - so I changed it... */
6204 if ((gc
= it
->dpvec
[it
->current
.dpvec_index
], GLYPH_CODE_P (gc
))
6205 && GLYPH_CODE_CHAR_VALID_P (gc
))
6207 it
->c
= GLYPH_CODE_CHAR (gc
);
6208 it
->len
= CHAR_BYTES (it
->c
);
6210 /* The entry may contain a face id to use. Such a face id is
6211 the id of a Lisp face, not a realized face. A face id of
6212 zero means no face is specified. */
6213 if (it
->dpvec_face_id
>= 0)
6214 it
->face_id
= it
->dpvec_face_id
;
6217 int lface_id
= GLYPH_CODE_FACE (gc
);
6219 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6224 /* Display table entry is invalid. Return a space. */
6225 it
->c
= ' ', it
->len
= 1;
6227 /* Don't change position and object of the iterator here. They are
6228 still the values of the character that had this display table
6229 entry or was translated, and that's what we want. */
6230 it
->what
= IT_CHARACTER
;
6235 /* Load IT with the next display element from Lisp string IT->string.
6236 IT->current.string_pos is the current position within the string.
6237 If IT->current.overlay_string_index >= 0, the Lisp string is an
6241 next_element_from_string (it
)
6244 struct text_pos position
;
6246 xassert (STRINGP (it
->string
));
6247 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6248 position
= it
->current
.string_pos
;
6250 /* Time to check for invisible text? */
6251 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6252 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6256 /* Since a handler may have changed IT->method, we must
6258 return GET_NEXT_DISPLAY_ELEMENT (it
);
6261 if (it
->current
.overlay_string_index
>= 0)
6263 /* Get the next character from an overlay string. In overlay
6264 strings, There is no field width or padding with spaces to
6266 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6271 else if (STRING_MULTIBYTE (it
->string
))
6273 int remaining
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6274 const unsigned char *s
= (SDATA (it
->string
)
6275 + IT_STRING_BYTEPOS (*it
));
6276 it
->c
= string_char_and_length (s
, remaining
, &it
->len
);
6280 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6286 /* Get the next character from a Lisp string that is not an
6287 overlay string. Such strings come from the mode line, for
6288 example. We may have to pad with spaces, or truncate the
6289 string. See also next_element_from_c_string. */
6290 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6295 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6297 /* Pad with spaces. */
6298 it
->c
= ' ', it
->len
= 1;
6299 CHARPOS (position
) = BYTEPOS (position
) = -1;
6301 else if (STRING_MULTIBYTE (it
->string
))
6303 int maxlen
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6304 const unsigned char *s
= (SDATA (it
->string
)
6305 + IT_STRING_BYTEPOS (*it
));
6306 it
->c
= string_char_and_length (s
, maxlen
, &it
->len
);
6310 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6315 /* Record what we have and where it came from. */
6316 it
->what
= IT_CHARACTER
;
6317 it
->object
= it
->string
;
6318 it
->position
= position
;
6323 /* Load IT with next display element from C string IT->s.
6324 IT->string_nchars is the maximum number of characters to return
6325 from the string. IT->end_charpos may be greater than
6326 IT->string_nchars when this function is called, in which case we
6327 may have to return padding spaces. Value is zero if end of string
6328 reached, including padding spaces. */
6331 next_element_from_c_string (it
)
6337 it
->what
= IT_CHARACTER
;
6338 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6341 /* IT's position can be greater IT->string_nchars in case a field
6342 width or precision has been specified when the iterator was
6344 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6346 /* End of the game. */
6350 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6352 /* Pad with spaces. */
6353 it
->c
= ' ', it
->len
= 1;
6354 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6356 else if (it
->multibyte_p
)
6358 /* Implementation note: The calls to strlen apparently aren't a
6359 performance problem because there is no noticeable performance
6360 difference between Emacs running in unibyte or multibyte mode. */
6361 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
6362 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
),
6366 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6372 /* Set up IT to return characters from an ellipsis, if appropriate.
6373 The definition of the ellipsis glyphs may come from a display table
6374 entry. This function Fills IT with the first glyph from the
6375 ellipsis if an ellipsis is to be displayed. */
6378 next_element_from_ellipsis (it
)
6381 if (it
->selective_display_ellipsis_p
)
6382 setup_for_ellipsis (it
, it
->len
);
6385 /* The face at the current position may be different from the
6386 face we find after the invisible text. Remember what it
6387 was in IT->saved_face_id, and signal that it's there by
6388 setting face_before_selective_p. */
6389 it
->saved_face_id
= it
->face_id
;
6390 it
->method
= GET_FROM_BUFFER
;
6391 it
->object
= it
->w
->buffer
;
6392 reseat_at_next_visible_line_start (it
, 1);
6393 it
->face_before_selective_p
= 1;
6396 return GET_NEXT_DISPLAY_ELEMENT (it
);
6400 /* Deliver an image display element. The iterator IT is already
6401 filled with image information (done in handle_display_prop). Value
6406 next_element_from_image (it
)
6409 it
->what
= IT_IMAGE
;
6414 /* Fill iterator IT with next display element from a stretch glyph
6415 property. IT->object is the value of the text property. Value is
6419 next_element_from_stretch (it
)
6422 it
->what
= IT_STRETCH
;
6427 /* Load IT with the next display element from current_buffer. Value
6428 is zero if end of buffer reached. IT->stop_charpos is the next
6429 position at which to stop and check for text properties or buffer
6433 next_element_from_buffer (it
)
6438 /* Check this assumption, otherwise, we would never enter the
6439 if-statement, below. */
6440 xassert (IT_CHARPOS (*it
) >= BEGV
6441 && IT_CHARPOS (*it
) <= it
->stop_charpos
);
6443 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6445 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6447 int overlay_strings_follow_p
;
6449 /* End of the game, except when overlay strings follow that
6450 haven't been returned yet. */
6451 if (it
->overlay_strings_at_end_processed_p
)
6452 overlay_strings_follow_p
= 0;
6455 it
->overlay_strings_at_end_processed_p
= 1;
6456 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6459 if (overlay_strings_follow_p
)
6460 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6464 it
->position
= it
->current
.pos
;
6471 return GET_NEXT_DISPLAY_ELEMENT (it
);
6476 /* No face changes, overlays etc. in sight, so just return a
6477 character from current_buffer. */
6480 /* Maybe run the redisplay end trigger hook. Performance note:
6481 This doesn't seem to cost measurable time. */
6482 if (it
->redisplay_end_trigger_charpos
6484 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6485 run_redisplay_end_trigger_hook (it
);
6487 /* Get the next character, maybe multibyte. */
6488 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6489 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6491 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT_BYTE
? ZV_BYTE
: GPT_BYTE
)
6492 - IT_BYTEPOS (*it
));
6493 it
->c
= string_char_and_length (p
, maxlen
, &it
->len
);
6496 it
->c
= *p
, it
->len
= 1;
6498 /* Record what we have and where it came from. */
6499 it
->what
= IT_CHARACTER
;
6500 it
->object
= it
->w
->buffer
;
6501 it
->position
= it
->current
.pos
;
6503 /* Normally we return the character found above, except when we
6504 really want to return an ellipsis for selective display. */
6509 /* A value of selective > 0 means hide lines indented more
6510 than that number of columns. */
6511 if (it
->selective
> 0
6512 && IT_CHARPOS (*it
) + 1 < ZV
6513 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6514 IT_BYTEPOS (*it
) + 1,
6515 (double) it
->selective
)) /* iftc */
6517 success_p
= next_element_from_ellipsis (it
);
6518 it
->dpvec_char_len
= -1;
6521 else if (it
->c
== '\r' && it
->selective
== -1)
6523 /* A value of selective == -1 means that everything from the
6524 CR to the end of the line is invisible, with maybe an
6525 ellipsis displayed for it. */
6526 success_p
= next_element_from_ellipsis (it
);
6527 it
->dpvec_char_len
= -1;
6532 /* Value is zero if end of buffer reached. */
6533 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6538 /* Run the redisplay end trigger hook for IT. */
6541 run_redisplay_end_trigger_hook (it
)
6544 Lisp_Object args
[3];
6546 /* IT->glyph_row should be non-null, i.e. we should be actually
6547 displaying something, or otherwise we should not run the hook. */
6548 xassert (it
->glyph_row
);
6550 /* Set up hook arguments. */
6551 args
[0] = Qredisplay_end_trigger_functions
;
6552 args
[1] = it
->window
;
6553 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6554 it
->redisplay_end_trigger_charpos
= 0;
6556 /* Since we are *trying* to run these functions, don't try to run
6557 them again, even if they get an error. */
6558 it
->w
->redisplay_end_trigger
= Qnil
;
6559 Frun_hook_with_args (3, args
);
6561 /* Notice if it changed the face of the character we are on. */
6562 handle_face_prop (it
);
6566 /* Deliver a composition display element. The iterator IT is already
6567 filled with composition information (done in
6568 handle_composition_prop). Value is always 1. */
6571 next_element_from_composition (it
)
6574 it
->what
= IT_COMPOSITION
;
6575 it
->position
= (STRINGP (it
->string
)
6576 ? it
->current
.string_pos
6578 if (STRINGP (it
->string
))
6579 it
->object
= it
->string
;
6581 it
->object
= it
->w
->buffer
;
6587 /***********************************************************************
6588 Moving an iterator without producing glyphs
6589 ***********************************************************************/
6591 /* Check if iterator is at a position corresponding to a valid buffer
6592 position after some move_it_ call. */
6594 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6595 ((it)->method == GET_FROM_STRING \
6596 ? IT_STRING_CHARPOS (*it) == 0 \
6600 /* Move iterator IT to a specified buffer or X position within one
6601 line on the display without producing glyphs.
6603 OP should be a bit mask including some or all of these bits:
6604 MOVE_TO_X: Stop on reaching x-position TO_X.
6605 MOVE_TO_POS: Stop on reaching buffer or string position TO_CHARPOS.
6606 Regardless of OP's value, stop in reaching the end of the display line.
6608 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6609 This means, in particular, that TO_X includes window's horizontal
6612 The return value has several possible values that
6613 say what condition caused the scan to stop:
6615 MOVE_POS_MATCH_OR_ZV
6616 - when TO_POS or ZV was reached.
6619 -when TO_X was reached before TO_POS or ZV were reached.
6622 - when we reached the end of the display area and the line must
6626 - when we reached the end of the display area and the line is
6630 - when we stopped at a line end, i.e. a newline or a CR and selective
6633 static enum move_it_result
6634 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
)
6636 int to_charpos
, to_x
, op
;
6638 enum move_it_result result
= MOVE_UNDEFINED
;
6639 struct glyph_row
*saved_glyph_row
;
6641 /* Don't produce glyphs in produce_glyphs. */
6642 saved_glyph_row
= it
->glyph_row
;
6643 it
->glyph_row
= NULL
;
6645 #define BUFFER_POS_REACHED_P() \
6646 ((op & MOVE_TO_POS) != 0 \
6647 && BUFFERP (it->object) \
6648 && IT_CHARPOS (*it) >= to_charpos \
6649 && (it->method == GET_FROM_BUFFER \
6650 || (it->method == GET_FROM_DISPLAY_VECTOR \
6651 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6656 int x
, i
, ascent
= 0, descent
= 0;
6658 /* Stop if we move beyond TO_CHARPOS (after an image or stretch glyph). */
6659 if ((op
& MOVE_TO_POS
) != 0
6660 && BUFFERP (it
->object
)
6661 && it
->method
== GET_FROM_BUFFER
6662 && IT_CHARPOS (*it
) > to_charpos
)
6664 result
= MOVE_POS_MATCH_OR_ZV
;
6668 /* Stop when ZV reached.
6669 We used to stop here when TO_CHARPOS reached as well, but that is
6670 too soon if this glyph does not fit on this line. So we handle it
6671 explicitly below. */
6672 if (!get_next_display_element (it
)
6673 || (it
->truncate_lines_p
6674 && BUFFER_POS_REACHED_P ()))
6676 result
= MOVE_POS_MATCH_OR_ZV
;
6680 /* The call to produce_glyphs will get the metrics of the
6681 display element IT is loaded with. We record in x the
6682 x-position before this display element in case it does not
6686 /* Remember the line height so far in case the next element doesn't
6688 if (!it
->truncate_lines_p
)
6690 ascent
= it
->max_ascent
;
6691 descent
= it
->max_descent
;
6694 PRODUCE_GLYPHS (it
);
6696 if (it
->area
!= TEXT_AREA
)
6698 set_iterator_to_next (it
, 1);
6702 /* The number of glyphs we get back in IT->nglyphs will normally
6703 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
6704 character on a terminal frame, or (iii) a line end. For the
6705 second case, IT->nglyphs - 1 padding glyphs will be present
6706 (on X frames, there is only one glyph produced for a
6707 composite character.
6709 The behavior implemented below means, for continuation lines,
6710 that as many spaces of a TAB as fit on the current line are
6711 displayed there. For terminal frames, as many glyphs of a
6712 multi-glyph character are displayed in the current line, too.
6713 This is what the old redisplay code did, and we keep it that
6714 way. Under X, the whole shape of a complex character must
6715 fit on the line or it will be completely displayed in the
6718 Note that both for tabs and padding glyphs, all glyphs have
6722 /* More than one glyph or glyph doesn't fit on line. All
6723 glyphs have the same width. */
6724 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
6726 int x_before_this_char
= x
;
6727 int hpos_before_this_char
= it
->hpos
;
6729 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
6731 new_x
= x
+ single_glyph_width
;
6733 /* We want to leave anything reaching TO_X to the caller. */
6734 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
6736 if (BUFFER_POS_REACHED_P ())
6737 goto buffer_pos_reached
;
6739 result
= MOVE_X_REACHED
;
6742 else if (/* Lines are continued. */
6743 !it
->truncate_lines_p
6744 && (/* And glyph doesn't fit on the line. */
6745 new_x
> it
->last_visible_x
6746 /* Or it fits exactly and we're on a window
6748 || (new_x
== it
->last_visible_x
6749 && FRAME_WINDOW_P (it
->f
))))
6751 if (/* IT->hpos == 0 means the very first glyph
6752 doesn't fit on the line, e.g. a wide image. */
6754 || (new_x
== it
->last_visible_x
6755 && FRAME_WINDOW_P (it
->f
)))
6758 it
->current_x
= new_x
;
6760 /* The character's last glyph just barely fits
6762 if (i
== it
->nglyphs
- 1)
6764 /* If this is the destination position,
6765 return a position *before* it in this row,
6766 now that we know it fits in this row. */
6767 if (BUFFER_POS_REACHED_P ())
6769 it
->hpos
= hpos_before_this_char
;
6770 it
->current_x
= x_before_this_char
;
6771 result
= MOVE_POS_MATCH_OR_ZV
;
6775 set_iterator_to_next (it
, 1);
6776 #ifdef HAVE_WINDOW_SYSTEM
6777 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
6779 if (!get_next_display_element (it
))
6781 result
= MOVE_POS_MATCH_OR_ZV
;
6784 if (BUFFER_POS_REACHED_P ())
6786 if (ITERATOR_AT_END_OF_LINE_P (it
))
6787 result
= MOVE_POS_MATCH_OR_ZV
;
6789 result
= MOVE_LINE_CONTINUED
;
6792 if (ITERATOR_AT_END_OF_LINE_P (it
))
6794 result
= MOVE_NEWLINE_OR_CR
;
6798 #endif /* HAVE_WINDOW_SYSTEM */
6804 it
->max_ascent
= ascent
;
6805 it
->max_descent
= descent
;
6808 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
6810 result
= MOVE_LINE_CONTINUED
;
6813 else if (BUFFER_POS_REACHED_P ())
6814 goto buffer_pos_reached
;
6815 else if (new_x
> it
->first_visible_x
)
6817 /* Glyph is visible. Increment number of glyphs that
6818 would be displayed. */
6823 /* Glyph is completely off the left margin of the display
6824 area. Nothing to do. */
6828 if (result
!= MOVE_UNDEFINED
)
6831 else if (BUFFER_POS_REACHED_P ())
6835 it
->max_ascent
= ascent
;
6836 it
->max_descent
= descent
;
6837 result
= MOVE_POS_MATCH_OR_ZV
;
6840 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
6842 /* Stop when TO_X specified and reached. This check is
6843 necessary here because of lines consisting of a line end,
6844 only. The line end will not produce any glyphs and we
6845 would never get MOVE_X_REACHED. */
6846 xassert (it
->nglyphs
== 0);
6847 result
= MOVE_X_REACHED
;
6851 /* Is this a line end? If yes, we're done. */
6852 if (ITERATOR_AT_END_OF_LINE_P (it
))
6854 result
= MOVE_NEWLINE_OR_CR
;
6858 /* The current display element has been consumed. Advance
6860 set_iterator_to_next (it
, 1);
6862 /* Stop if lines are truncated and IT's current x-position is
6863 past the right edge of the window now. */
6864 if (it
->truncate_lines_p
6865 && it
->current_x
>= it
->last_visible_x
)
6867 #ifdef HAVE_WINDOW_SYSTEM
6868 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
6870 if (!get_next_display_element (it
)
6871 || BUFFER_POS_REACHED_P ())
6873 result
= MOVE_POS_MATCH_OR_ZV
;
6876 if (ITERATOR_AT_END_OF_LINE_P (it
))
6878 result
= MOVE_NEWLINE_OR_CR
;
6882 #endif /* HAVE_WINDOW_SYSTEM */
6883 result
= MOVE_LINE_TRUNCATED
;
6888 #undef BUFFER_POS_REACHED_P
6890 /* Restore the iterator settings altered at the beginning of this
6892 it
->glyph_row
= saved_glyph_row
;
6897 /* Move IT forward until it satisfies one or more of the criteria in
6898 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
6900 OP is a bit-mask that specifies where to stop, and in particular,
6901 which of those four position arguments makes a difference. See the
6902 description of enum move_operation_enum.
6904 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
6905 screen line, this function will set IT to the next position >
6909 move_it_to (it
, to_charpos
, to_x
, to_y
, to_vpos
, op
)
6911 int to_charpos
, to_x
, to_y
, to_vpos
;
6914 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
6920 if (op
& MOVE_TO_VPOS
)
6922 /* If no TO_CHARPOS and no TO_X specified, stop at the
6923 start of the line TO_VPOS. */
6924 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
6926 if (it
->vpos
== to_vpos
)
6932 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
6936 /* TO_VPOS >= 0 means stop at TO_X in the line at
6937 TO_VPOS, or at TO_POS, whichever comes first. */
6938 if (it
->vpos
== to_vpos
)
6944 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
6946 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
6951 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
6953 /* We have reached TO_X but not in the line we want. */
6954 skip
= move_it_in_display_line_to (it
, to_charpos
,
6956 if (skip
== MOVE_POS_MATCH_OR_ZV
)
6964 else if (op
& MOVE_TO_Y
)
6966 struct it it_backup
;
6968 /* TO_Y specified means stop at TO_X in the line containing
6969 TO_Y---or at TO_CHARPOS if this is reached first. The
6970 problem is that we can't really tell whether the line
6971 contains TO_Y before we have completely scanned it, and
6972 this may skip past TO_X. What we do is to first scan to
6975 If TO_X is not specified, use a TO_X of zero. The reason
6976 is to make the outcome of this function more predictable.
6977 If we didn't use TO_X == 0, we would stop at the end of
6978 the line which is probably not what a caller would expect
6980 skip
= move_it_in_display_line_to (it
, to_charpos
,
6984 | (op
& MOVE_TO_POS
)));
6986 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
6987 if (skip
== MOVE_POS_MATCH_OR_ZV
)
6993 /* If TO_X was reached, we would like to know whether TO_Y
6994 is in the line. This can only be said if we know the
6995 total line height which requires us to scan the rest of
6997 if (skip
== MOVE_X_REACHED
)
6999 /* Wait! We can conclude that TO_Y is in the line if
7000 the already scanned glyphs make the line tall enough
7001 because further scanning doesn't make it shorter. */
7002 line_height
= it
->max_ascent
+ it
->max_descent
;
7003 if (to_y
>= it
->current_y
7004 && to_y
< it
->current_y
+ line_height
)
7010 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7011 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7013 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7016 /* Now, decide whether TO_Y is in this line. */
7017 line_height
= it
->max_ascent
+ it
->max_descent
;
7018 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7020 if (to_y
>= it
->current_y
7021 && to_y
< it
->current_y
+ line_height
)
7023 if (skip
== MOVE_X_REACHED
)
7024 /* If TO_Y is in this line and TO_X was reached above,
7025 we scanned too far. We have to restore IT's settings
7026 to the ones before skipping. */
7030 else if (skip
== MOVE_X_REACHED
)
7033 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7040 else if (BUFFERP (it
->object
)
7041 && it
->method
== GET_FROM_BUFFER
7042 && IT_CHARPOS (*it
) >= to_charpos
)
7043 skip
= MOVE_POS_MATCH_OR_ZV
;
7045 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7049 case MOVE_POS_MATCH_OR_ZV
:
7053 case MOVE_NEWLINE_OR_CR
:
7054 set_iterator_to_next (it
, 1);
7055 it
->continuation_lines_width
= 0;
7058 case MOVE_LINE_TRUNCATED
:
7059 it
->continuation_lines_width
= 0;
7060 reseat_at_next_visible_line_start (it
, 0);
7061 if ((op
& MOVE_TO_POS
) != 0
7062 && IT_CHARPOS (*it
) > to_charpos
)
7069 case MOVE_LINE_CONTINUED
:
7070 /* For continued lines ending in a tab, some of the glyphs
7071 associated with the tab are displayed on the current
7072 line. Since it->current_x does not include these glyphs,
7073 we use it->last_visible_x instead. */
7074 it
->continuation_lines_width
+=
7075 (it
->c
== '\t') ? it
->last_visible_x
: it
->current_x
;
7082 /* Reset/increment for the next run. */
7083 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7084 it
->current_x
= it
->hpos
= 0;
7085 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7087 last_height
= it
->max_ascent
+ it
->max_descent
;
7088 last_max_ascent
= it
->max_ascent
;
7089 it
->max_ascent
= it
->max_descent
= 0;
7094 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7098 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7100 If DY > 0, move IT backward at least that many pixels. DY = 0
7101 means move IT backward to the preceding line start or BEGV. This
7102 function may move over more than DY pixels if IT->current_y - DY
7103 ends up in the middle of a line; in this case IT->current_y will be
7104 set to the top of the line moved to. */
7107 move_it_vertically_backward (it
, dy
)
7118 start_pos
= IT_CHARPOS (*it
);
7120 /* Estimate how many newlines we must move back. */
7121 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7123 /* Set the iterator's position that many lines back. */
7124 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7125 back_to_previous_visible_line_start (it
);
7127 /* Reseat the iterator here. When moving backward, we don't want
7128 reseat to skip forward over invisible text, set up the iterator
7129 to deliver from overlay strings at the new position etc. So,
7130 use reseat_1 here. */
7131 reseat_1 (it
, it
->current
.pos
, 1);
7133 /* We are now surely at a line start. */
7134 it
->current_x
= it
->hpos
= 0;
7135 it
->continuation_lines_width
= 0;
7137 /* Move forward and see what y-distance we moved. First move to the
7138 start of the next line so that we get its height. We need this
7139 height to be able to tell whether we reached the specified
7142 it2
.max_ascent
= it2
.max_descent
= 0;
7145 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7146 MOVE_TO_POS
| MOVE_TO_VPOS
);
7148 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7149 xassert (IT_CHARPOS (*it
) >= BEGV
);
7152 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7153 xassert (IT_CHARPOS (*it
) >= BEGV
);
7154 /* H is the actual vertical distance from the position in *IT
7155 and the starting position. */
7156 h
= it2
.current_y
- it
->current_y
;
7157 /* NLINES is the distance in number of lines. */
7158 nlines
= it2
.vpos
- it
->vpos
;
7160 /* Correct IT's y and vpos position
7161 so that they are relative to the starting point. */
7167 /* DY == 0 means move to the start of the screen line. The
7168 value of nlines is > 0 if continuation lines were involved. */
7170 move_it_by_lines (it
, nlines
, 1);
7172 /* I think this assert is bogus if buffer contains
7173 invisible text or images. KFS. */
7174 xassert (IT_CHARPOS (*it
) <= start_pos
);
7179 /* The y-position we try to reach, relative to *IT.
7180 Note that H has been subtracted in front of the if-statement. */
7181 int target_y
= it
->current_y
+ h
- dy
;
7182 int y0
= it3
.current_y
;
7183 int y1
= line_bottom_y (&it3
);
7184 int line_height
= y1
- y0
;
7186 /* If we did not reach target_y, try to move further backward if
7187 we can. If we moved too far backward, try to move forward. */
7188 if (target_y
< it
->current_y
7189 /* This is heuristic. In a window that's 3 lines high, with
7190 a line height of 13 pixels each, recentering with point
7191 on the bottom line will try to move -39/2 = 19 pixels
7192 backward. Try to avoid moving into the first line. */
7193 && (it
->current_y
- target_y
7194 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7195 && IT_CHARPOS (*it
) > BEGV
)
7197 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7198 target_y
- it
->current_y
));
7199 dy
= it
->current_y
- target_y
;
7200 goto move_further_back
;
7202 else if (target_y
>= it
->current_y
+ line_height
7203 && IT_CHARPOS (*it
) < ZV
)
7205 /* Should move forward by at least one line, maybe more.
7207 Note: Calling move_it_by_lines can be expensive on
7208 terminal frames, where compute_motion is used (via
7209 vmotion) to do the job, when there are very long lines
7210 and truncate-lines is nil. That's the reason for
7211 treating terminal frames specially here. */
7213 if (!FRAME_WINDOW_P (it
->f
))
7214 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7219 move_it_by_lines (it
, 1, 1);
7221 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7225 /* I think this assert is bogus if buffer contains
7226 invisible text or images. KFS. */
7227 xassert (IT_CHARPOS (*it
) >= BEGV
);
7234 /* Move IT by a specified amount of pixel lines DY. DY negative means
7235 move backwards. DY = 0 means move to start of screen line. At the
7236 end, IT will be on the start of a screen line. */
7239 move_it_vertically (it
, dy
)
7244 move_it_vertically_backward (it
, -dy
);
7247 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7248 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7249 MOVE_TO_POS
| MOVE_TO_Y
);
7250 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7252 /* If buffer ends in ZV without a newline, move to the start of
7253 the line to satisfy the post-condition. */
7254 if (IT_CHARPOS (*it
) == ZV
7256 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7257 move_it_by_lines (it
, 0, 0);
7262 /* Move iterator IT past the end of the text line it is in. */
7265 move_it_past_eol (it
)
7268 enum move_it_result rc
;
7270 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7271 if (rc
== MOVE_NEWLINE_OR_CR
)
7272 set_iterator_to_next (it
, 0);
7276 #if 0 /* Currently not used. */
7278 /* Return non-zero if some text between buffer positions START_CHARPOS
7279 and END_CHARPOS is invisible. IT->window is the window for text
7283 invisible_text_between_p (it
, start_charpos
, end_charpos
)
7285 int start_charpos
, end_charpos
;
7287 Lisp_Object prop
, limit
;
7288 int invisible_found_p
;
7290 xassert (it
!= NULL
&& start_charpos
<= end_charpos
);
7292 /* Is text at START invisible? */
7293 prop
= Fget_char_property (make_number (start_charpos
), Qinvisible
,
7295 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
7296 invisible_found_p
= 1;
7299 limit
= Fnext_single_char_property_change (make_number (start_charpos
),
7301 make_number (end_charpos
));
7302 invisible_found_p
= XFASTINT (limit
) < end_charpos
;
7305 return invisible_found_p
;
7311 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7312 negative means move up. DVPOS == 0 means move to the start of the
7313 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7314 NEED_Y_P is zero, IT->current_y will be left unchanged.
7316 Further optimization ideas: If we would know that IT->f doesn't use
7317 a face with proportional font, we could be faster for
7318 truncate-lines nil. */
7321 move_it_by_lines (it
, dvpos
, need_y_p
)
7323 int dvpos
, need_y_p
;
7325 struct position pos
;
7327 /* The commented-out optimization uses vmotion on terminals. This
7328 gives bad results, because elements like it->what, on which
7329 callers such as pos_visible_p rely, aren't updated. */
7330 /* if (!FRAME_WINDOW_P (it->f))
7332 struct text_pos textpos;
7334 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7335 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7336 reseat (it, textpos, 1);
7337 it->vpos += pos.vpos;
7338 it->current_y += pos.vpos;
7344 /* DVPOS == 0 means move to the start of the screen line. */
7345 move_it_vertically_backward (it
, 0);
7346 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7347 /* Let next call to line_bottom_y calculate real line height */
7352 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7353 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7354 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7359 int start_charpos
, i
;
7361 /* Start at the beginning of the screen line containing IT's
7362 position. This may actually move vertically backwards,
7363 in case of overlays, so adjust dvpos accordingly. */
7365 move_it_vertically_backward (it
, 0);
7368 /* Go back -DVPOS visible lines and reseat the iterator there. */
7369 start_charpos
= IT_CHARPOS (*it
);
7370 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7371 back_to_previous_visible_line_start (it
);
7372 reseat (it
, it
->current
.pos
, 1);
7374 /* Move further back if we end up in a string or an image. */
7375 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7377 /* First try to move to start of display line. */
7379 move_it_vertically_backward (it
, 0);
7381 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7383 /* If start of line is still in string or image,
7384 move further back. */
7385 back_to_previous_visible_line_start (it
);
7386 reseat (it
, it
->current
.pos
, 1);
7390 it
->current_x
= it
->hpos
= 0;
7392 /* Above call may have moved too far if continuation lines
7393 are involved. Scan forward and see if it did. */
7395 it2
.vpos
= it2
.current_y
= 0;
7396 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7397 it
->vpos
-= it2
.vpos
;
7398 it
->current_y
-= it2
.current_y
;
7399 it
->current_x
= it
->hpos
= 0;
7401 /* If we moved too far back, move IT some lines forward. */
7402 if (it2
.vpos
> -dvpos
)
7404 int delta
= it2
.vpos
+ dvpos
;
7406 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7407 /* Move back again if we got too far ahead. */
7408 if (IT_CHARPOS (*it
) >= start_charpos
)
7414 /* Return 1 if IT points into the middle of a display vector. */
7417 in_display_vector_p (it
)
7420 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7421 && it
->current
.dpvec_index
> 0
7422 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7426 /***********************************************************************
7428 ***********************************************************************/
7431 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7435 add_to_log (format
, arg1
, arg2
)
7437 Lisp_Object arg1
, arg2
;
7439 Lisp_Object args
[3];
7440 Lisp_Object msg
, fmt
;
7443 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7446 /* Do nothing if called asynchronously. Inserting text into
7447 a buffer may call after-change-functions and alike and
7448 that would means running Lisp asynchronously. */
7449 if (handling_signal
)
7453 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7455 args
[0] = fmt
= build_string (format
);
7458 msg
= Fformat (3, args
);
7460 len
= SBYTES (msg
) + 1;
7461 SAFE_ALLOCA (buffer
, char *, len
);
7462 bcopy (SDATA (msg
), buffer
, len
);
7464 message_dolog (buffer
, len
- 1, 1, 0);
7471 /* Output a newline in the *Messages* buffer if "needs" one. */
7474 message_log_maybe_newline ()
7476 if (message_log_need_newline
)
7477 message_dolog ("", 0, 1, 0);
7481 /* Add a string M of length NBYTES to the message log, optionally
7482 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7483 nonzero, means interpret the contents of M as multibyte. This
7484 function calls low-level routines in order to bypass text property
7485 hooks, etc. which might not be safe to run.
7487 This may GC (insert may run before/after change hooks),
7488 so the buffer M must NOT point to a Lisp string. */
7491 message_dolog (m
, nbytes
, nlflag
, multibyte
)
7493 int nbytes
, nlflag
, multibyte
;
7495 if (!NILP (Vmemory_full
))
7498 if (!NILP (Vmessage_log_max
))
7500 struct buffer
*oldbuf
;
7501 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7502 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7503 int point_at_end
= 0;
7505 Lisp_Object old_deactivate_mark
, tem
;
7506 struct gcpro gcpro1
;
7508 old_deactivate_mark
= Vdeactivate_mark
;
7509 oldbuf
= current_buffer
;
7510 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7511 current_buffer
->undo_list
= Qt
;
7513 oldpoint
= message_dolog_marker1
;
7514 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7515 oldbegv
= message_dolog_marker2
;
7516 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7517 oldzv
= message_dolog_marker3
;
7518 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7519 GCPRO1 (old_deactivate_mark
);
7527 BEGV_BYTE
= BEG_BYTE
;
7530 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7532 /* Insert the string--maybe converting multibyte to single byte
7533 or vice versa, so that all the text fits the buffer. */
7535 && NILP (current_buffer
->enable_multibyte_characters
))
7537 int i
, c
, char_bytes
;
7538 unsigned char work
[1];
7540 /* Convert a multibyte string to single-byte
7541 for the *Message* buffer. */
7542 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
7544 c
= string_char_and_length (m
+ i
, nbytes
- i
, &char_bytes
);
7545 work
[0] = (ASCII_CHAR_P (c
)
7547 : multibyte_char_to_unibyte (c
, Qnil
));
7548 insert_1_both (work
, 1, 1, 1, 0, 0);
7551 else if (! multibyte
7552 && ! NILP (current_buffer
->enable_multibyte_characters
))
7554 int i
, c
, char_bytes
;
7555 unsigned char *msg
= (unsigned char *) m
;
7556 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7557 /* Convert a single-byte string to multibyte
7558 for the *Message* buffer. */
7559 for (i
= 0; i
< nbytes
; i
++)
7562 c
= unibyte_char_to_multibyte (c
);
7563 char_bytes
= CHAR_STRING (c
, str
);
7564 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
7568 insert_1 (m
, nbytes
, 1, 0, 0);
7572 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
7573 insert_1 ("\n", 1, 1, 0, 0);
7575 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7577 this_bol_byte
= PT_BYTE
;
7579 /* See if this line duplicates the previous one.
7580 If so, combine duplicates. */
7583 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7585 prev_bol_byte
= PT_BYTE
;
7587 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
7588 this_bol
, this_bol_byte
);
7591 del_range_both (prev_bol
, prev_bol_byte
,
7592 this_bol
, this_bol_byte
, 0);
7598 /* If you change this format, don't forget to also
7599 change message_log_check_duplicate. */
7600 sprintf (dupstr
, " [%d times]", dup
);
7601 duplen
= strlen (dupstr
);
7602 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
7603 insert_1 (dupstr
, duplen
, 1, 0, 1);
7608 /* If we have more than the desired maximum number of lines
7609 in the *Messages* buffer now, delete the oldest ones.
7610 This is safe because we don't have undo in this buffer. */
7612 if (NATNUMP (Vmessage_log_max
))
7614 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
7615 -XFASTINT (Vmessage_log_max
) - 1, 0);
7616 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
7619 BEGV
= XMARKER (oldbegv
)->charpos
;
7620 BEGV_BYTE
= marker_byte_position (oldbegv
);
7629 ZV
= XMARKER (oldzv
)->charpos
;
7630 ZV_BYTE
= marker_byte_position (oldzv
);
7634 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7636 /* We can't do Fgoto_char (oldpoint) because it will run some
7638 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
7639 XMARKER (oldpoint
)->bytepos
);
7642 unchain_marker (XMARKER (oldpoint
));
7643 unchain_marker (XMARKER (oldbegv
));
7644 unchain_marker (XMARKER (oldzv
));
7646 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
7647 set_buffer_internal (oldbuf
);
7649 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
7650 message_log_need_newline
= !nlflag
;
7651 Vdeactivate_mark
= old_deactivate_mark
;
7656 /* We are at the end of the buffer after just having inserted a newline.
7657 (Note: We depend on the fact we won't be crossing the gap.)
7658 Check to see if the most recent message looks a lot like the previous one.
7659 Return 0 if different, 1 if the new one should just replace it, or a
7660 value N > 1 if we should also append " [N times]". */
7663 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
7664 int prev_bol
, this_bol
;
7665 int prev_bol_byte
, this_bol_byte
;
7668 int len
= Z_BYTE
- 1 - this_bol_byte
;
7670 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
7671 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
7673 for (i
= 0; i
< len
; i
++)
7675 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
7683 if (*p1
++ == ' ' && *p1
++ == '[')
7686 while (*p1
>= '0' && *p1
<= '9')
7687 n
= n
* 10 + *p1
++ - '0';
7688 if (strncmp (p1
, " times]\n", 8) == 0)
7695 /* Display an echo area message M with a specified length of NBYTES
7696 bytes. The string may include null characters. If M is 0, clear
7697 out any existing message, and let the mini-buffer text show
7700 This may GC, so the buffer M must NOT point to a Lisp string. */
7703 message2 (m
, nbytes
, multibyte
)
7708 /* First flush out any partial line written with print. */
7709 message_log_maybe_newline ();
7711 message_dolog (m
, nbytes
, 1, multibyte
);
7712 message2_nolog (m
, nbytes
, multibyte
);
7716 /* The non-logging counterpart of message2. */
7719 message2_nolog (m
, nbytes
, multibyte
)
7721 int nbytes
, multibyte
;
7723 struct frame
*sf
= SELECTED_FRAME ();
7724 message_enable_multibyte
= multibyte
;
7728 if (noninteractive_need_newline
)
7729 putc ('\n', stderr
);
7730 noninteractive_need_newline
= 0;
7732 fwrite (m
, nbytes
, 1, stderr
);
7733 if (cursor_in_echo_area
== 0)
7734 fprintf (stderr
, "\n");
7737 /* A null message buffer means that the frame hasn't really been
7738 initialized yet. Error messages get reported properly by
7739 cmd_error, so this must be just an informative message; toss it. */
7740 else if (INTERACTIVE
7741 && sf
->glyphs_initialized_p
7742 && FRAME_MESSAGE_BUF (sf
))
7744 Lisp_Object mini_window
;
7747 /* Get the frame containing the mini-buffer
7748 that the selected frame is using. */
7749 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7750 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
7752 FRAME_SAMPLE_VISIBILITY (f
);
7753 if (FRAME_VISIBLE_P (sf
)
7754 && ! FRAME_VISIBLE_P (f
))
7755 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
7759 set_message (m
, Qnil
, nbytes
, multibyte
);
7760 if (minibuffer_auto_raise
)
7761 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
7764 clear_message (1, 1);
7766 do_pending_window_change (0);
7767 echo_area_display (1);
7768 do_pending_window_change (0);
7769 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
7770 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
7775 /* Display an echo area message M with a specified length of NBYTES
7776 bytes. The string may include null characters. If M is not a
7777 string, clear out any existing message, and let the mini-buffer
7780 This function cancels echoing. */
7783 message3 (m
, nbytes
, multibyte
)
7788 struct gcpro gcpro1
;
7791 clear_message (1,1);
7794 /* First flush out any partial line written with print. */
7795 message_log_maybe_newline ();
7801 SAFE_ALLOCA (buffer
, char *, nbytes
);
7802 bcopy (SDATA (m
), buffer
, nbytes
);
7803 message_dolog (buffer
, nbytes
, 1, multibyte
);
7806 message3_nolog (m
, nbytes
, multibyte
);
7812 /* The non-logging version of message3.
7813 This does not cancel echoing, because it is used for echoing.
7814 Perhaps we need to make a separate function for echoing
7815 and make this cancel echoing. */
7818 message3_nolog (m
, nbytes
, multibyte
)
7820 int nbytes
, multibyte
;
7822 struct frame
*sf
= SELECTED_FRAME ();
7823 message_enable_multibyte
= multibyte
;
7827 if (noninteractive_need_newline
)
7828 putc ('\n', stderr
);
7829 noninteractive_need_newline
= 0;
7831 fwrite (SDATA (m
), nbytes
, 1, stderr
);
7832 if (cursor_in_echo_area
== 0)
7833 fprintf (stderr
, "\n");
7836 /* A null message buffer means that the frame hasn't really been
7837 initialized yet. Error messages get reported properly by
7838 cmd_error, so this must be just an informative message; toss it. */
7839 else if (INTERACTIVE
7840 && sf
->glyphs_initialized_p
7841 && FRAME_MESSAGE_BUF (sf
))
7843 Lisp_Object mini_window
;
7847 /* Get the frame containing the mini-buffer
7848 that the selected frame is using. */
7849 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7850 frame
= XWINDOW (mini_window
)->frame
;
7853 FRAME_SAMPLE_VISIBILITY (f
);
7854 if (FRAME_VISIBLE_P (sf
)
7855 && !FRAME_VISIBLE_P (f
))
7856 Fmake_frame_visible (frame
);
7858 if (STRINGP (m
) && SCHARS (m
) > 0)
7860 set_message (NULL
, m
, nbytes
, multibyte
);
7861 if (minibuffer_auto_raise
)
7862 Fraise_frame (frame
);
7863 /* Assume we are not echoing.
7864 (If we are, echo_now will override this.) */
7865 echo_message_buffer
= Qnil
;
7868 clear_message (1, 1);
7870 do_pending_window_change (0);
7871 echo_area_display (1);
7872 do_pending_window_change (0);
7873 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
7874 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
7879 /* Display a null-terminated echo area message M. If M is 0, clear
7880 out any existing message, and let the mini-buffer text show through.
7882 The buffer M must continue to exist until after the echo area gets
7883 cleared or some other message gets displayed there. Do not pass
7884 text that is stored in a Lisp string. Do not pass text in a buffer
7885 that was alloca'd. */
7891 message2 (m
, (m
? strlen (m
) : 0), 0);
7895 /* The non-logging counterpart of message1. */
7901 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
7904 /* Display a message M which contains a single %s
7905 which gets replaced with STRING. */
7908 message_with_string (m
, string
, log
)
7913 CHECK_STRING (string
);
7919 if (noninteractive_need_newline
)
7920 putc ('\n', stderr
);
7921 noninteractive_need_newline
= 0;
7922 fprintf (stderr
, m
, SDATA (string
));
7923 if (cursor_in_echo_area
== 0)
7924 fprintf (stderr
, "\n");
7928 else if (INTERACTIVE
)
7930 /* The frame whose minibuffer we're going to display the message on.
7931 It may be larger than the selected frame, so we need
7932 to use its buffer, not the selected frame's buffer. */
7933 Lisp_Object mini_window
;
7934 struct frame
*f
, *sf
= SELECTED_FRAME ();
7936 /* Get the frame containing the minibuffer
7937 that the selected frame is using. */
7938 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7939 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
7941 /* A null message buffer means that the frame hasn't really been
7942 initialized yet. Error messages get reported properly by
7943 cmd_error, so this must be just an informative message; toss it. */
7944 if (FRAME_MESSAGE_BUF (f
))
7946 Lisp_Object args
[2], message
;
7947 struct gcpro gcpro1
, gcpro2
;
7949 args
[0] = build_string (m
);
7950 args
[1] = message
= string
;
7951 GCPRO2 (args
[0], message
);
7954 message
= Fformat (2, args
);
7957 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
7959 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
7963 /* Print should start at the beginning of the message
7964 buffer next time. */
7965 message_buf_print
= 0;
7971 /* Dump an informative message to the minibuf. If M is 0, clear out
7972 any existing message, and let the mini-buffer text show through. */
7976 message (m
, a1
, a2
, a3
)
7978 EMACS_INT a1
, a2
, a3
;
7984 if (noninteractive_need_newline
)
7985 putc ('\n', stderr
);
7986 noninteractive_need_newline
= 0;
7987 fprintf (stderr
, m
, a1
, a2
, a3
);
7988 if (cursor_in_echo_area
== 0)
7989 fprintf (stderr
, "\n");
7993 else if (INTERACTIVE
)
7995 /* The frame whose mini-buffer we're going to display the message
7996 on. It may be larger than the selected frame, so we need to
7997 use its buffer, not the selected frame's buffer. */
7998 Lisp_Object mini_window
;
7999 struct frame
*f
, *sf
= SELECTED_FRAME ();
8001 /* Get the frame containing the mini-buffer
8002 that the selected frame is using. */
8003 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8004 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8006 /* A null message buffer means that the frame hasn't really been
8007 initialized yet. Error messages get reported properly by
8008 cmd_error, so this must be just an informative message; toss
8010 if (FRAME_MESSAGE_BUF (f
))
8021 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8022 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
8024 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8025 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3,
8027 #endif /* NO_ARG_ARRAY */
8029 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8034 /* Print should start at the beginning of the message
8035 buffer next time. */
8036 message_buf_print
= 0;
8042 /* The non-logging version of message. */
8045 message_nolog (m
, a1
, a2
, a3
)
8047 EMACS_INT a1
, a2
, a3
;
8049 Lisp_Object old_log_max
;
8050 old_log_max
= Vmessage_log_max
;
8051 Vmessage_log_max
= Qnil
;
8052 message (m
, a1
, a2
, a3
);
8053 Vmessage_log_max
= old_log_max
;
8057 /* Display the current message in the current mini-buffer. This is
8058 only called from error handlers in process.c, and is not time
8064 if (!NILP (echo_area_buffer
[0]))
8067 string
= Fcurrent_message ();
8068 message3 (string
, SBYTES (string
),
8069 !NILP (current_buffer
->enable_multibyte_characters
));
8074 /* Make sure echo area buffers in `echo_buffers' are live.
8075 If they aren't, make new ones. */
8078 ensure_echo_area_buffers ()
8082 for (i
= 0; i
< 2; ++i
)
8083 if (!BUFFERP (echo_buffer
[i
])
8084 || NILP (XBUFFER (echo_buffer
[i
])->name
))
8087 Lisp_Object old_buffer
;
8090 old_buffer
= echo_buffer
[i
];
8091 sprintf (name
, " *Echo Area %d*", i
);
8092 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8093 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
8095 for (j
= 0; j
< 2; ++j
)
8096 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8097 echo_area_buffer
[j
] = echo_buffer
[i
];
8102 /* Call FN with args A1..A4 with either the current or last displayed
8103 echo_area_buffer as current buffer.
8105 WHICH zero means use the current message buffer
8106 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8107 from echo_buffer[] and clear it.
8109 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8110 suitable buffer from echo_buffer[] and clear it.
8112 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8113 that the current message becomes the last displayed one, make
8114 choose a suitable buffer for echo_area_buffer[0], and clear it.
8116 Value is what FN returns. */
8119 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
)
8122 int (*fn
) P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
8128 int this_one
, the_other
, clear_buffer_p
, rc
;
8129 int count
= SPECPDL_INDEX ();
8131 /* If buffers aren't live, make new ones. */
8132 ensure_echo_area_buffers ();
8137 this_one
= 0, the_other
= 1;
8139 this_one
= 1, the_other
= 0;
8142 this_one
= 0, the_other
= 1;
8145 /* We need a fresh one in case the current echo buffer equals
8146 the one containing the last displayed echo area message. */
8147 if (!NILP (echo_area_buffer
[this_one
])
8148 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8149 echo_area_buffer
[this_one
] = Qnil
;
8152 /* Choose a suitable buffer from echo_buffer[] is we don't
8154 if (NILP (echo_area_buffer
[this_one
]))
8156 echo_area_buffer
[this_one
]
8157 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8158 ? echo_buffer
[the_other
]
8159 : echo_buffer
[this_one
]);
8163 buffer
= echo_area_buffer
[this_one
];
8165 /* Don't get confused by reusing the buffer used for echoing
8166 for a different purpose. */
8167 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8170 record_unwind_protect (unwind_with_echo_area_buffer
,
8171 with_echo_area_buffer_unwind_data (w
));
8173 /* Make the echo area buffer current. Note that for display
8174 purposes, it is not necessary that the displayed window's buffer
8175 == current_buffer, except for text property lookup. So, let's
8176 only set that buffer temporarily here without doing a full
8177 Fset_window_buffer. We must also change w->pointm, though,
8178 because otherwise an assertions in unshow_buffer fails, and Emacs
8180 set_buffer_internal_1 (XBUFFER (buffer
));
8184 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8187 current_buffer
->undo_list
= Qt
;
8188 current_buffer
->read_only
= Qnil
;
8189 specbind (Qinhibit_read_only
, Qt
);
8190 specbind (Qinhibit_modification_hooks
, Qt
);
8192 if (clear_buffer_p
&& Z
> BEG
)
8195 xassert (BEGV
>= BEG
);
8196 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8198 rc
= fn (a1
, a2
, a3
, a4
);
8200 xassert (BEGV
>= BEG
);
8201 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8203 unbind_to (count
, Qnil
);
8208 /* Save state that should be preserved around the call to the function
8209 FN called in with_echo_area_buffer. */
8212 with_echo_area_buffer_unwind_data (w
)
8216 Lisp_Object vector
, tmp
;
8218 /* Reduce consing by keeping one vector in
8219 Vwith_echo_area_save_vector. */
8220 vector
= Vwith_echo_area_save_vector
;
8221 Vwith_echo_area_save_vector
= Qnil
;
8224 vector
= Fmake_vector (make_number (7), Qnil
);
8226 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8227 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8228 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8232 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8233 ASET (vector
, i
, w
->buffer
); ++i
;
8234 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8235 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8240 for (; i
< end
; ++i
)
8241 ASET (vector
, i
, Qnil
);
8244 xassert (i
== ASIZE (vector
));
8249 /* Restore global state from VECTOR which was created by
8250 with_echo_area_buffer_unwind_data. */
8253 unwind_with_echo_area_buffer (vector
)
8256 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8257 Vdeactivate_mark
= AREF (vector
, 1);
8258 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8260 if (WINDOWP (AREF (vector
, 3)))
8263 Lisp_Object buffer
, charpos
, bytepos
;
8265 w
= XWINDOW (AREF (vector
, 3));
8266 buffer
= AREF (vector
, 4);
8267 charpos
= AREF (vector
, 5);
8268 bytepos
= AREF (vector
, 6);
8271 set_marker_both (w
->pointm
, buffer
,
8272 XFASTINT (charpos
), XFASTINT (bytepos
));
8275 Vwith_echo_area_save_vector
= vector
;
8280 /* Set up the echo area for use by print functions. MULTIBYTE_P
8281 non-zero means we will print multibyte. */
8284 setup_echo_area_for_printing (multibyte_p
)
8287 /* If we can't find an echo area any more, exit. */
8288 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8291 ensure_echo_area_buffers ();
8293 if (!message_buf_print
)
8295 /* A message has been output since the last time we printed.
8296 Choose a fresh echo area buffer. */
8297 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8298 echo_area_buffer
[0] = echo_buffer
[1];
8300 echo_area_buffer
[0] = echo_buffer
[0];
8302 /* Switch to that buffer and clear it. */
8303 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8304 current_buffer
->truncate_lines
= Qnil
;
8308 int count
= SPECPDL_INDEX ();
8309 specbind (Qinhibit_read_only
, Qt
);
8310 /* Note that undo recording is always disabled. */
8312 unbind_to (count
, Qnil
);
8314 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8316 /* Set up the buffer for the multibyteness we need. */
8318 != !NILP (current_buffer
->enable_multibyte_characters
))
8319 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8321 /* Raise the frame containing the echo area. */
8322 if (minibuffer_auto_raise
)
8324 struct frame
*sf
= SELECTED_FRAME ();
8325 Lisp_Object mini_window
;
8326 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8327 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8330 message_log_maybe_newline ();
8331 message_buf_print
= 1;
8335 if (NILP (echo_area_buffer
[0]))
8337 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8338 echo_area_buffer
[0] = echo_buffer
[1];
8340 echo_area_buffer
[0] = echo_buffer
[0];
8343 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8345 /* Someone switched buffers between print requests. */
8346 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8347 current_buffer
->truncate_lines
= Qnil
;
8353 /* Display an echo area message in window W. Value is non-zero if W's
8354 height is changed. If display_last_displayed_message_p is
8355 non-zero, display the message that was last displayed, otherwise
8356 display the current message. */
8359 display_echo_area (w
)
8362 int i
, no_message_p
, window_height_changed_p
, count
;
8364 /* Temporarily disable garbage collections while displaying the echo
8365 area. This is done because a GC can print a message itself.
8366 That message would modify the echo area buffer's contents while a
8367 redisplay of the buffer is going on, and seriously confuse
8369 count
= inhibit_garbage_collection ();
8371 /* If there is no message, we must call display_echo_area_1
8372 nevertheless because it resizes the window. But we will have to
8373 reset the echo_area_buffer in question to nil at the end because
8374 with_echo_area_buffer will sets it to an empty buffer. */
8375 i
= display_last_displayed_message_p
? 1 : 0;
8376 no_message_p
= NILP (echo_area_buffer
[i
]);
8378 window_height_changed_p
8379 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8380 display_echo_area_1
,
8381 (EMACS_INT
) w
, Qnil
, 0, 0);
8384 echo_area_buffer
[i
] = Qnil
;
8386 unbind_to (count
, Qnil
);
8387 return window_height_changed_p
;
8391 /* Helper for display_echo_area. Display the current buffer which
8392 contains the current echo area message in window W, a mini-window,
8393 a pointer to which is passed in A1. A2..A4 are currently not used.
8394 Change the height of W so that all of the message is displayed.
8395 Value is non-zero if height of W was changed. */
8398 display_echo_area_1 (a1
, a2
, a3
, a4
)
8403 struct window
*w
= (struct window
*) a1
;
8405 struct text_pos start
;
8406 int window_height_changed_p
= 0;
8408 /* Do this before displaying, so that we have a large enough glyph
8409 matrix for the display. If we can't get enough space for the
8410 whole text, display the last N lines. That works by setting w->start. */
8411 window_height_changed_p
= resize_mini_window (w
, 0);
8413 /* Use the starting position chosen by resize_mini_window. */
8414 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8417 clear_glyph_matrix (w
->desired_matrix
);
8418 XSETWINDOW (window
, w
);
8419 try_window (window
, start
, 0);
8421 return window_height_changed_p
;
8425 /* Resize the echo area window to exactly the size needed for the
8426 currently displayed message, if there is one. If a mini-buffer
8427 is active, don't shrink it. */
8430 resize_echo_area_exactly ()
8432 if (BUFFERP (echo_area_buffer
[0])
8433 && WINDOWP (echo_area_window
))
8435 struct window
*w
= XWINDOW (echo_area_window
);
8437 Lisp_Object resize_exactly
;
8439 if (minibuf_level
== 0)
8440 resize_exactly
= Qt
;
8442 resize_exactly
= Qnil
;
8444 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8445 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8448 ++windows_or_buffers_changed
;
8449 ++update_mode_lines
;
8450 redisplay_internal (0);
8456 /* Callback function for with_echo_area_buffer, when used from
8457 resize_echo_area_exactly. A1 contains a pointer to the window to
8458 resize, EXACTLY non-nil means resize the mini-window exactly to the
8459 size of the text displayed. A3 and A4 are not used. Value is what
8460 resize_mini_window returns. */
8463 resize_mini_window_1 (a1
, exactly
, a3
, a4
)
8465 Lisp_Object exactly
;
8468 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8472 /* Resize mini-window W to fit the size of its contents. EXACT_P
8473 means size the window exactly to the size needed. Otherwise, it's
8474 only enlarged until W's buffer is empty.
8476 Set W->start to the right place to begin display. If the whole
8477 contents fit, start at the beginning. Otherwise, start so as
8478 to make the end of the contents appear. This is particularly
8479 important for y-or-n-p, but seems desirable generally.
8481 Value is non-zero if the window height has been changed. */
8484 resize_mini_window (w
, exact_p
)
8488 struct frame
*f
= XFRAME (w
->frame
);
8489 int window_height_changed_p
= 0;
8491 xassert (MINI_WINDOW_P (w
));
8493 /* By default, start display at the beginning. */
8494 set_marker_both (w
->start
, w
->buffer
,
8495 BUF_BEGV (XBUFFER (w
->buffer
)),
8496 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8498 /* Don't resize windows while redisplaying a window; it would
8499 confuse redisplay functions when the size of the window they are
8500 displaying changes from under them. Such a resizing can happen,
8501 for instance, when which-func prints a long message while
8502 we are running fontification-functions. We're running these
8503 functions with safe_call which binds inhibit-redisplay to t. */
8504 if (!NILP (Vinhibit_redisplay
))
8507 /* Nil means don't try to resize. */
8508 if (NILP (Vresize_mini_windows
)
8509 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8512 if (!FRAME_MINIBUF_ONLY_P (f
))
8515 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8516 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8517 int height
, max_height
;
8518 int unit
= FRAME_LINE_HEIGHT (f
);
8519 struct text_pos start
;
8520 struct buffer
*old_current_buffer
= NULL
;
8522 if (current_buffer
!= XBUFFER (w
->buffer
))
8524 old_current_buffer
= current_buffer
;
8525 set_buffer_internal (XBUFFER (w
->buffer
));
8528 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8530 /* Compute the max. number of lines specified by the user. */
8531 if (FLOATP (Vmax_mini_window_height
))
8532 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8533 else if (INTEGERP (Vmax_mini_window_height
))
8534 max_height
= XINT (Vmax_mini_window_height
);
8536 max_height
= total_height
/ 4;
8538 /* Correct that max. height if it's bogus. */
8539 max_height
= max (1, max_height
);
8540 max_height
= min (total_height
, max_height
);
8542 /* Find out the height of the text in the window. */
8543 if (it
.truncate_lines_p
)
8548 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8549 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8550 height
= it
.current_y
+ last_height
;
8552 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
8553 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
8554 height
= (height
+ unit
- 1) / unit
;
8557 /* Compute a suitable window start. */
8558 if (height
> max_height
)
8560 height
= max_height
;
8561 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8562 move_it_vertically_backward (&it
, (height
- 1) * unit
);
8563 start
= it
.current
.pos
;
8566 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
8567 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
8569 if (EQ (Vresize_mini_windows
, Qgrow_only
))
8571 /* Let it grow only, until we display an empty message, in which
8572 case the window shrinks again. */
8573 if (height
> WINDOW_TOTAL_LINES (w
))
8575 int old_height
= WINDOW_TOTAL_LINES (w
);
8576 freeze_window_starts (f
, 1);
8577 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8578 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8580 else if (height
< WINDOW_TOTAL_LINES (w
)
8581 && (exact_p
|| BEGV
== ZV
))
8583 int old_height
= WINDOW_TOTAL_LINES (w
);
8584 freeze_window_starts (f
, 0);
8585 shrink_mini_window (w
);
8586 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8591 /* Always resize to exact size needed. */
8592 if (height
> WINDOW_TOTAL_LINES (w
))
8594 int old_height
= WINDOW_TOTAL_LINES (w
);
8595 freeze_window_starts (f
, 1);
8596 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8597 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8599 else if (height
< WINDOW_TOTAL_LINES (w
))
8601 int old_height
= WINDOW_TOTAL_LINES (w
);
8602 freeze_window_starts (f
, 0);
8603 shrink_mini_window (w
);
8607 freeze_window_starts (f
, 1);
8608 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8611 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8615 if (old_current_buffer
)
8616 set_buffer_internal (old_current_buffer
);
8619 return window_height_changed_p
;
8623 /* Value is the current message, a string, or nil if there is no
8631 if (!BUFFERP (echo_area_buffer
[0]))
8635 with_echo_area_buffer (0, 0, current_message_1
,
8636 (EMACS_INT
) &msg
, Qnil
, 0, 0);
8638 echo_area_buffer
[0] = Qnil
;
8646 current_message_1 (a1
, a2
, a3
, a4
)
8651 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
8654 *msg
= make_buffer_string (BEG
, Z
, 1);
8661 /* Push the current message on Vmessage_stack for later restauration
8662 by restore_message. Value is non-zero if the current message isn't
8663 empty. This is a relatively infrequent operation, so it's not
8664 worth optimizing. */
8670 msg
= current_message ();
8671 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
8672 return STRINGP (msg
);
8676 /* Restore message display from the top of Vmessage_stack. */
8683 xassert (CONSP (Vmessage_stack
));
8684 msg
= XCAR (Vmessage_stack
);
8686 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8688 message3_nolog (msg
, 0, 0);
8692 /* Handler for record_unwind_protect calling pop_message. */
8695 pop_message_unwind (dummy
)
8702 /* Pop the top-most entry off Vmessage_stack. */
8707 xassert (CONSP (Vmessage_stack
));
8708 Vmessage_stack
= XCDR (Vmessage_stack
);
8712 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
8713 exits. If the stack is not empty, we have a missing pop_message
8717 check_message_stack ()
8719 if (!NILP (Vmessage_stack
))
8724 /* Truncate to NCHARS what will be displayed in the echo area the next
8725 time we display it---but don't redisplay it now. */
8728 truncate_echo_area (nchars
)
8732 echo_area_buffer
[0] = Qnil
;
8733 /* A null message buffer means that the frame hasn't really been
8734 initialized yet. Error messages get reported properly by
8735 cmd_error, so this must be just an informative message; toss it. */
8736 else if (!noninteractive
8738 && !NILP (echo_area_buffer
[0]))
8740 struct frame
*sf
= SELECTED_FRAME ();
8741 if (FRAME_MESSAGE_BUF (sf
))
8742 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
8747 /* Helper function for truncate_echo_area. Truncate the current
8748 message to at most NCHARS characters. */
8751 truncate_message_1 (nchars
, a2
, a3
, a4
)
8756 if (BEG
+ nchars
< Z
)
8757 del_range (BEG
+ nchars
, Z
);
8759 echo_area_buffer
[0] = Qnil
;
8764 /* Set the current message to a substring of S or STRING.
8766 If STRING is a Lisp string, set the message to the first NBYTES
8767 bytes from STRING. NBYTES zero means use the whole string. If
8768 STRING is multibyte, the message will be displayed multibyte.
8770 If S is not null, set the message to the first LEN bytes of S. LEN
8771 zero means use the whole string. MULTIBYTE_P non-zero means S is
8772 multibyte. Display the message multibyte in that case.
8774 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
8775 to t before calling set_message_1 (which calls insert).
8779 set_message (s
, string
, nbytes
, multibyte_p
)
8782 int nbytes
, multibyte_p
;
8784 message_enable_multibyte
8785 = ((s
&& multibyte_p
)
8786 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
8788 with_echo_area_buffer (0, -1, set_message_1
,
8789 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
8790 message_buf_print
= 0;
8791 help_echo_showing_p
= 0;
8795 /* Helper function for set_message. Arguments have the same meaning
8796 as there, with A1 corresponding to S and A2 corresponding to STRING
8797 This function is called with the echo area buffer being
8801 set_message_1 (a1
, a2
, nbytes
, multibyte_p
)
8804 EMACS_INT nbytes
, multibyte_p
;
8806 const char *s
= (const char *) a1
;
8807 Lisp_Object string
= a2
;
8809 /* Change multibyteness of the echo buffer appropriately. */
8810 if (message_enable_multibyte
8811 != !NILP (current_buffer
->enable_multibyte_characters
))
8812 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
8814 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
8816 /* Insert new message at BEG. */
8817 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8819 if (STRINGP (string
))
8824 nbytes
= SBYTES (string
);
8825 nchars
= string_byte_to_char (string
, nbytes
);
8827 /* This function takes care of single/multibyte conversion. We
8828 just have to ensure that the echo area buffer has the right
8829 setting of enable_multibyte_characters. */
8830 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
8835 nbytes
= strlen (s
);
8837 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
8839 /* Convert from multi-byte to single-byte. */
8841 unsigned char work
[1];
8843 /* Convert a multibyte string to single-byte. */
8844 for (i
= 0; i
< nbytes
; i
+= n
)
8846 c
= string_char_and_length (s
+ i
, nbytes
- i
, &n
);
8847 work
[0] = (ASCII_CHAR_P (c
)
8849 : multibyte_char_to_unibyte (c
, Qnil
));
8850 insert_1_both (work
, 1, 1, 1, 0, 0);
8853 else if (!multibyte_p
8854 && !NILP (current_buffer
->enable_multibyte_characters
))
8856 /* Convert from single-byte to multi-byte. */
8858 const unsigned char *msg
= (const unsigned char *) s
;
8859 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8861 /* Convert a single-byte string to multibyte. */
8862 for (i
= 0; i
< nbytes
; i
++)
8865 c
= unibyte_char_to_multibyte (c
);
8866 n
= CHAR_STRING (c
, str
);
8867 insert_1_both (str
, 1, n
, 1, 0, 0);
8871 insert_1 (s
, nbytes
, 1, 0, 0);
8878 /* Clear messages. CURRENT_P non-zero means clear the current
8879 message. LAST_DISPLAYED_P non-zero means clear the message
8883 clear_message (current_p
, last_displayed_p
)
8884 int current_p
, last_displayed_p
;
8888 echo_area_buffer
[0] = Qnil
;
8889 message_cleared_p
= 1;
8892 if (last_displayed_p
)
8893 echo_area_buffer
[1] = Qnil
;
8895 message_buf_print
= 0;
8898 /* Clear garbaged frames.
8900 This function is used where the old redisplay called
8901 redraw_garbaged_frames which in turn called redraw_frame which in
8902 turn called clear_frame. The call to clear_frame was a source of
8903 flickering. I believe a clear_frame is not necessary. It should
8904 suffice in the new redisplay to invalidate all current matrices,
8905 and ensure a complete redisplay of all windows. */
8908 clear_garbaged_frames ()
8912 Lisp_Object tail
, frame
;
8913 int changed_count
= 0;
8915 FOR_EACH_FRAME (tail
, frame
)
8917 struct frame
*f
= XFRAME (frame
);
8919 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
8923 Fredraw_frame (frame
);
8924 f
->force_flush_display_p
= 1;
8926 clear_current_matrices (f
);
8935 ++windows_or_buffers_changed
;
8940 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
8941 is non-zero update selected_frame. Value is non-zero if the
8942 mini-windows height has been changed. */
8945 echo_area_display (update_frame_p
)
8948 Lisp_Object mini_window
;
8951 int window_height_changed_p
= 0;
8952 struct frame
*sf
= SELECTED_FRAME ();
8954 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8955 w
= XWINDOW (mini_window
);
8956 f
= XFRAME (WINDOW_FRAME (w
));
8958 /* Don't display if frame is invisible or not yet initialized. */
8959 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
8962 #ifdef HAVE_WINDOW_SYSTEM
8963 /* When Emacs starts, selected_frame may be the initial terminal
8964 frame. If we let this through, a message would be displayed on
8966 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
8968 #endif /* HAVE_WINDOW_SYSTEM */
8970 /* Redraw garbaged frames. */
8972 clear_garbaged_frames ();
8974 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
8976 echo_area_window
= mini_window
;
8977 window_height_changed_p
= display_echo_area (w
);
8978 w
->must_be_updated_p
= 1;
8980 /* Update the display, unless called from redisplay_internal.
8981 Also don't update the screen during redisplay itself. The
8982 update will happen at the end of redisplay, and an update
8983 here could cause confusion. */
8984 if (update_frame_p
&& !redisplaying_p
)
8988 /* If the display update has been interrupted by pending
8989 input, update mode lines in the frame. Due to the
8990 pending input, it might have been that redisplay hasn't
8991 been called, so that mode lines above the echo area are
8992 garbaged. This looks odd, so we prevent it here. */
8993 if (!display_completed
)
8994 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
8996 if (window_height_changed_p
8997 /* Don't do this if Emacs is shutting down. Redisplay
8998 needs to run hooks. */
8999 && !NILP (Vrun_hooks
))
9001 /* Must update other windows. Likewise as in other
9002 cases, don't let this update be interrupted by
9004 int count
= SPECPDL_INDEX ();
9005 specbind (Qredisplay_dont_pause
, Qt
);
9006 windows_or_buffers_changed
= 1;
9007 redisplay_internal (0);
9008 unbind_to (count
, Qnil
);
9010 else if (FRAME_WINDOW_P (f
) && n
== 0)
9012 /* Window configuration is the same as before.
9013 Can do with a display update of the echo area,
9014 unless we displayed some mode lines. */
9015 update_single_window (w
, 1);
9016 FRAME_RIF (f
)->flush_display (f
);
9019 update_frame (f
, 1, 1);
9021 /* If cursor is in the echo area, make sure that the next
9022 redisplay displays the minibuffer, so that the cursor will
9023 be replaced with what the minibuffer wants. */
9024 if (cursor_in_echo_area
)
9025 ++windows_or_buffers_changed
;
9028 else if (!EQ (mini_window
, selected_window
))
9029 windows_or_buffers_changed
++;
9031 /* Last displayed message is now the current message. */
9032 echo_area_buffer
[1] = echo_area_buffer
[0];
9033 /* Inform read_char that we're not echoing. */
9034 echo_message_buffer
= Qnil
;
9036 /* Prevent redisplay optimization in redisplay_internal by resetting
9037 this_line_start_pos. This is done because the mini-buffer now
9038 displays the message instead of its buffer text. */
9039 if (EQ (mini_window
, selected_window
))
9040 CHARPOS (this_line_start_pos
) = 0;
9042 return window_height_changed_p
;
9047 /***********************************************************************
9048 Mode Lines and Frame Titles
9049 ***********************************************************************/
9051 /* A buffer for constructing non-propertized mode-line strings and
9052 frame titles in it; allocated from the heap in init_xdisp and
9053 resized as needed in store_mode_line_noprop_char. */
9055 static char *mode_line_noprop_buf
;
9057 /* The buffer's end, and a current output position in it. */
9059 static char *mode_line_noprop_buf_end
;
9060 static char *mode_line_noprop_ptr
;
9062 #define MODE_LINE_NOPROP_LEN(start) \
9063 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9066 MODE_LINE_DISPLAY
= 0,
9072 /* Alist that caches the results of :propertize.
9073 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9074 static Lisp_Object mode_line_proptrans_alist
;
9076 /* List of strings making up the mode-line. */
9077 static Lisp_Object mode_line_string_list
;
9079 /* Base face property when building propertized mode line string. */
9080 static Lisp_Object mode_line_string_face
;
9081 static Lisp_Object mode_line_string_face_prop
;
9084 /* Unwind data for mode line strings */
9086 static Lisp_Object Vmode_line_unwind_vector
;
9089 format_mode_line_unwind_data (struct buffer
*obuf
,
9093 Lisp_Object vector
, tmp
;
9095 /* Reduce consing by keeping one vector in
9096 Vwith_echo_area_save_vector. */
9097 vector
= Vmode_line_unwind_vector
;
9098 Vmode_line_unwind_vector
= Qnil
;
9101 vector
= Fmake_vector (make_number (8), Qnil
);
9103 ASET (vector
, 0, make_number (mode_line_target
));
9104 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9105 ASET (vector
, 2, mode_line_string_list
);
9106 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9107 ASET (vector
, 4, mode_line_string_face
);
9108 ASET (vector
, 5, mode_line_string_face_prop
);
9111 XSETBUFFER (tmp
, obuf
);
9114 ASET (vector
, 6, tmp
);
9115 ASET (vector
, 7, owin
);
9121 unwind_format_mode_line (vector
)
9124 mode_line_target
= XINT (AREF (vector
, 0));
9125 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9126 mode_line_string_list
= AREF (vector
, 2);
9127 if (! EQ (AREF (vector
, 3), Qt
))
9128 mode_line_proptrans_alist
= AREF (vector
, 3);
9129 mode_line_string_face
= AREF (vector
, 4);
9130 mode_line_string_face_prop
= AREF (vector
, 5);
9132 if (!NILP (AREF (vector
, 7)))
9133 /* Select window before buffer, since it may change the buffer. */
9134 Fselect_window (AREF (vector
, 7), Qt
);
9136 if (!NILP (AREF (vector
, 6)))
9138 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9139 ASET (vector
, 6, Qnil
);
9142 Vmode_line_unwind_vector
= vector
;
9147 /* Store a single character C for the frame title in mode_line_noprop_buf.
9148 Re-allocate mode_line_noprop_buf if necessary. */
9152 store_mode_line_noprop_char (char c
)
9154 store_mode_line_noprop_char (c
)
9158 /* If output position has reached the end of the allocated buffer,
9159 double the buffer's size. */
9160 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9162 int len
= MODE_LINE_NOPROP_LEN (0);
9163 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9164 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9165 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9166 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9169 *mode_line_noprop_ptr
++ = c
;
9173 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9174 mode_line_noprop_ptr. STR is the string to store. Do not copy
9175 characters that yield more columns than PRECISION; PRECISION <= 0
9176 means copy the whole string. Pad with spaces until FIELD_WIDTH
9177 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9178 pad. Called from display_mode_element when it is used to build a
9182 store_mode_line_noprop (str
, field_width
, precision
)
9183 const unsigned char *str
;
9184 int field_width
, precision
;
9189 /* Copy at most PRECISION chars from STR. */
9190 nbytes
= strlen (str
);
9191 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9193 store_mode_line_noprop_char (*str
++);
9195 /* Fill up with spaces until FIELD_WIDTH reached. */
9196 while (field_width
> 0
9199 store_mode_line_noprop_char (' ');
9206 /***********************************************************************
9208 ***********************************************************************/
9210 #ifdef HAVE_WINDOW_SYSTEM
9212 /* Set the title of FRAME, if it has changed. The title format is
9213 Vicon_title_format if FRAME is iconified, otherwise it is
9214 frame_title_format. */
9217 x_consider_frame_title (frame
)
9220 struct frame
*f
= XFRAME (frame
);
9222 if (FRAME_WINDOW_P (f
)
9223 || FRAME_MINIBUF_ONLY_P (f
)
9224 || f
->explicit_name
)
9226 /* Do we have more than one visible frame on this X display? */
9233 int count
= SPECPDL_INDEX ();
9235 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9237 Lisp_Object other_frame
= XCAR (tail
);
9238 struct frame
*tf
= XFRAME (other_frame
);
9241 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9242 && !FRAME_MINIBUF_ONLY_P (tf
)
9243 && !EQ (other_frame
, tip_frame
)
9244 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9248 /* Set global variable indicating that multiple frames exist. */
9249 multiple_frames
= CONSP (tail
);
9251 /* Switch to the buffer of selected window of the frame. Set up
9252 mode_line_target so that display_mode_element will output into
9253 mode_line_noprop_buf; then display the title. */
9254 record_unwind_protect (unwind_format_mode_line
,
9255 format_mode_line_unwind_data
9256 (current_buffer
, selected_window
, 0));
9258 Fselect_window (f
->selected_window
, Qt
);
9259 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9260 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9262 mode_line_target
= MODE_LINE_TITLE
;
9263 title_start
= MODE_LINE_NOPROP_LEN (0);
9264 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9265 NULL
, DEFAULT_FACE_ID
);
9266 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9267 len
= MODE_LINE_NOPROP_LEN (title_start
);
9268 title
= mode_line_noprop_buf
+ title_start
;
9269 unbind_to (count
, Qnil
);
9271 /* Set the title only if it's changed. This avoids consing in
9272 the common case where it hasn't. (If it turns out that we've
9273 already wasted too much time by walking through the list with
9274 display_mode_element, then we might need to optimize at a
9275 higher level than this.) */
9276 if (! STRINGP (f
->name
)
9277 || SBYTES (f
->name
) != len
9278 || bcmp (title
, SDATA (f
->name
), len
) != 0)
9279 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9283 #endif /* not HAVE_WINDOW_SYSTEM */
9288 /***********************************************************************
9290 ***********************************************************************/
9293 /* Prepare for redisplay by updating menu-bar item lists when
9294 appropriate. This can call eval. */
9297 prepare_menu_bars ()
9300 struct gcpro gcpro1
, gcpro2
;
9302 Lisp_Object tooltip_frame
;
9304 #ifdef HAVE_WINDOW_SYSTEM
9305 tooltip_frame
= tip_frame
;
9307 tooltip_frame
= Qnil
;
9310 /* Update all frame titles based on their buffer names, etc. We do
9311 this before the menu bars so that the buffer-menu will show the
9312 up-to-date frame titles. */
9313 #ifdef HAVE_WINDOW_SYSTEM
9314 if (windows_or_buffers_changed
|| update_mode_lines
)
9316 Lisp_Object tail
, frame
;
9318 FOR_EACH_FRAME (tail
, frame
)
9321 if (!EQ (frame
, tooltip_frame
)
9322 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9323 x_consider_frame_title (frame
);
9326 #endif /* HAVE_WINDOW_SYSTEM */
9328 /* Update the menu bar item lists, if appropriate. This has to be
9329 done before any actual redisplay or generation of display lines. */
9330 all_windows
= (update_mode_lines
9331 || buffer_shared
> 1
9332 || windows_or_buffers_changed
);
9335 Lisp_Object tail
, frame
;
9336 int count
= SPECPDL_INDEX ();
9337 /* 1 means that update_menu_bar has run its hooks
9338 so any further calls to update_menu_bar shouldn't do so again. */
9339 int menu_bar_hooks_run
= 0;
9341 record_unwind_save_match_data ();
9343 FOR_EACH_FRAME (tail
, frame
)
9347 /* Ignore tooltip frame. */
9348 if (EQ (frame
, tooltip_frame
))
9351 /* If a window on this frame changed size, report that to
9352 the user and clear the size-change flag. */
9353 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9355 Lisp_Object functions
;
9357 /* Clear flag first in case we get an error below. */
9358 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9359 functions
= Vwindow_size_change_functions
;
9360 GCPRO2 (tail
, functions
);
9362 while (CONSP (functions
))
9364 call1 (XCAR (functions
), frame
);
9365 functions
= XCDR (functions
);
9371 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9372 #ifdef HAVE_WINDOW_SYSTEM
9373 update_tool_bar (f
, 0);
9375 mac_update_title_bar (f
, 0);
9381 unbind_to (count
, Qnil
);
9385 struct frame
*sf
= SELECTED_FRAME ();
9386 update_menu_bar (sf
, 1, 0);
9387 #ifdef HAVE_WINDOW_SYSTEM
9388 update_tool_bar (sf
, 1);
9390 mac_update_title_bar (sf
, 1);
9395 /* Motif needs this. See comment in xmenu.c. Turn it off when
9396 pending_menu_activation is not defined. */
9397 #ifdef USE_X_TOOLKIT
9398 pending_menu_activation
= 0;
9403 /* Update the menu bar item list for frame F. This has to be done
9404 before we start to fill in any display lines, because it can call
9407 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9409 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9410 already ran the menu bar hooks for this redisplay, so there
9411 is no need to run them again. The return value is the
9412 updated value of this flag, to pass to the next call. */
9415 update_menu_bar (f
, save_match_data
, hooks_run
)
9417 int save_match_data
;
9421 register struct window
*w
;
9423 /* If called recursively during a menu update, do nothing. This can
9424 happen when, for instance, an activate-menubar-hook causes a
9426 if (inhibit_menubar_update
)
9429 window
= FRAME_SELECTED_WINDOW (f
);
9430 w
= XWINDOW (window
);
9432 #if 0 /* The if statement below this if statement used to include the
9433 condition !NILP (w->update_mode_line), rather than using
9434 update_mode_lines directly, and this if statement may have
9435 been added to make that condition work. Now the if
9436 statement below matches its comment, this isn't needed. */
9437 if (update_mode_lines
)
9438 w
->update_mode_line
= Qt
;
9441 if (FRAME_WINDOW_P (f
)
9443 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
9444 || defined (USE_GTK)
9445 FRAME_EXTERNAL_MENU_BAR (f
)
9447 FRAME_MENU_BAR_LINES (f
) > 0
9449 : FRAME_MENU_BAR_LINES (f
) > 0)
9451 /* If the user has switched buffers or windows, we need to
9452 recompute to reflect the new bindings. But we'll
9453 recompute when update_mode_lines is set too; that means
9454 that people can use force-mode-line-update to request
9455 that the menu bar be recomputed. The adverse effect on
9456 the rest of the redisplay algorithm is about the same as
9457 windows_or_buffers_changed anyway. */
9458 if (windows_or_buffers_changed
9459 /* This used to test w->update_mode_line, but we believe
9460 there is no need to recompute the menu in that case. */
9461 || update_mode_lines
9462 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9463 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9464 != !NILP (w
->last_had_star
))
9465 || ((!NILP (Vtransient_mark_mode
)
9466 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9467 != !NILP (w
->region_showing
)))
9469 struct buffer
*prev
= current_buffer
;
9470 int count
= SPECPDL_INDEX ();
9472 specbind (Qinhibit_menubar_update
, Qt
);
9474 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9475 if (save_match_data
)
9476 record_unwind_save_match_data ();
9477 if (NILP (Voverriding_local_map_menu_flag
))
9479 specbind (Qoverriding_terminal_local_map
, Qnil
);
9480 specbind (Qoverriding_local_map
, Qnil
);
9485 /* Run the Lucid hook. */
9486 safe_run_hooks (Qactivate_menubar_hook
);
9488 /* If it has changed current-menubar from previous value,
9489 really recompute the menu-bar from the value. */
9490 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9491 call0 (Qrecompute_lucid_menubar
);
9493 safe_run_hooks (Qmenu_bar_update_hook
);
9498 XSETFRAME (Vmenu_updating_frame
, f
);
9499 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9501 /* Redisplay the menu bar in case we changed it. */
9502 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
9503 || defined (USE_GTK)
9504 if (FRAME_WINDOW_P (f
))
9507 /* All frames on Mac OS share the same menubar. So only
9508 the selected frame should be allowed to set it. */
9509 if (f
== SELECTED_FRAME ())
9511 set_frame_menubar (f
, 0, 0);
9514 /* On a terminal screen, the menu bar is an ordinary screen
9515 line, and this makes it get updated. */
9516 w
->update_mode_line
= Qt
;
9517 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || MAC_OS || USE_GTK) */
9518 /* In the non-toolkit version, the menu bar is an ordinary screen
9519 line, and this makes it get updated. */
9520 w
->update_mode_line
= Qt
;
9521 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || MAC_OS || USE_GTK) */
9523 unbind_to (count
, Qnil
);
9524 set_buffer_internal_1 (prev
);
9533 /***********************************************************************
9535 ***********************************************************************/
9537 #ifdef HAVE_WINDOW_SYSTEM
9540 Nominal cursor position -- where to draw output.
9541 HPOS and VPOS are window relative glyph matrix coordinates.
9542 X and Y are window relative pixel coordinates. */
9544 struct cursor_pos output_cursor
;
9548 Set the global variable output_cursor to CURSOR. All cursor
9549 positions are relative to updated_window. */
9552 set_output_cursor (cursor
)
9553 struct cursor_pos
*cursor
;
9555 output_cursor
.hpos
= cursor
->hpos
;
9556 output_cursor
.vpos
= cursor
->vpos
;
9557 output_cursor
.x
= cursor
->x
;
9558 output_cursor
.y
= cursor
->y
;
9563 Set a nominal cursor position.
9565 HPOS and VPOS are column/row positions in a window glyph matrix. X
9566 and Y are window text area relative pixel positions.
9568 If this is done during an update, updated_window will contain the
9569 window that is being updated and the position is the future output
9570 cursor position for that window. If updated_window is null, use
9571 selected_window and display the cursor at the given position. */
9574 x_cursor_to (vpos
, hpos
, y
, x
)
9575 int vpos
, hpos
, y
, x
;
9579 /* If updated_window is not set, work on selected_window. */
9583 w
= XWINDOW (selected_window
);
9585 /* Set the output cursor. */
9586 output_cursor
.hpos
= hpos
;
9587 output_cursor
.vpos
= vpos
;
9588 output_cursor
.x
= x
;
9589 output_cursor
.y
= y
;
9591 /* If not called as part of an update, really display the cursor.
9592 This will also set the cursor position of W. */
9593 if (updated_window
== NULL
)
9596 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
9597 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
9598 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
9603 #endif /* HAVE_WINDOW_SYSTEM */
9606 /***********************************************************************
9608 ***********************************************************************/
9610 #ifdef HAVE_WINDOW_SYSTEM
9612 /* Where the mouse was last time we reported a mouse event. */
9614 FRAME_PTR last_mouse_frame
;
9616 /* Tool-bar item index of the item on which a mouse button was pressed
9619 int last_tool_bar_item
;
9622 /* Update the tool-bar item list for frame F. This has to be done
9623 before we start to fill in any display lines. Called from
9624 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
9625 and restore it here. */
9628 update_tool_bar (f
, save_match_data
)
9630 int save_match_data
;
9632 #if defined (USE_GTK) || USE_MAC_TOOLBAR
9633 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
9635 int do_update
= WINDOWP (f
->tool_bar_window
)
9636 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
9644 window
= FRAME_SELECTED_WINDOW (f
);
9645 w
= XWINDOW (window
);
9647 /* If the user has switched buffers or windows, we need to
9648 recompute to reflect the new bindings. But we'll
9649 recompute when update_mode_lines is set too; that means
9650 that people can use force-mode-line-update to request
9651 that the menu bar be recomputed. The adverse effect on
9652 the rest of the redisplay algorithm is about the same as
9653 windows_or_buffers_changed anyway. */
9654 if (windows_or_buffers_changed
9655 || !NILP (w
->update_mode_line
)
9656 || update_mode_lines
9657 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9658 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9659 != !NILP (w
->last_had_star
))
9660 || ((!NILP (Vtransient_mark_mode
)
9661 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9662 != !NILP (w
->region_showing
)))
9664 struct buffer
*prev
= current_buffer
;
9665 int count
= SPECPDL_INDEX ();
9666 Lisp_Object new_tool_bar
;
9668 struct gcpro gcpro1
;
9670 /* Set current_buffer to the buffer of the selected
9671 window of the frame, so that we get the right local
9673 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9675 /* Save match data, if we must. */
9676 if (save_match_data
)
9677 record_unwind_save_match_data ();
9679 /* Make sure that we don't accidentally use bogus keymaps. */
9680 if (NILP (Voverriding_local_map_menu_flag
))
9682 specbind (Qoverriding_terminal_local_map
, Qnil
);
9683 specbind (Qoverriding_local_map
, Qnil
);
9686 GCPRO1 (new_tool_bar
);
9688 /* Build desired tool-bar items from keymaps. */
9689 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
9692 /* Redisplay the tool-bar if we changed it. */
9693 if (new_n_tool_bar
!= f
->n_tool_bar_items
9694 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
9696 /* Redisplay that happens asynchronously due to an expose event
9697 may access f->tool_bar_items. Make sure we update both
9698 variables within BLOCK_INPUT so no such event interrupts. */
9700 f
->tool_bar_items
= new_tool_bar
;
9701 f
->n_tool_bar_items
= new_n_tool_bar
;
9702 w
->update_mode_line
= Qt
;
9708 unbind_to (count
, Qnil
);
9709 set_buffer_internal_1 (prev
);
9715 /* Set F->desired_tool_bar_string to a Lisp string representing frame
9716 F's desired tool-bar contents. F->tool_bar_items must have
9717 been set up previously by calling prepare_menu_bars. */
9720 build_desired_tool_bar_string (f
)
9723 int i
, size
, size_needed
;
9724 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9725 Lisp_Object image
, plist
, props
;
9727 image
= plist
= props
= Qnil
;
9728 GCPRO3 (image
, plist
, props
);
9730 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
9731 Otherwise, make a new string. */
9733 /* The size of the string we might be able to reuse. */
9734 size
= (STRINGP (f
->desired_tool_bar_string
)
9735 ? SCHARS (f
->desired_tool_bar_string
)
9738 /* We need one space in the string for each image. */
9739 size_needed
= f
->n_tool_bar_items
;
9741 /* Reuse f->desired_tool_bar_string, if possible. */
9742 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
9743 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
9747 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
9748 Fremove_text_properties (make_number (0), make_number (size
),
9749 props
, f
->desired_tool_bar_string
);
9752 /* Put a `display' property on the string for the images to display,
9753 put a `menu_item' property on tool-bar items with a value that
9754 is the index of the item in F's tool-bar item vector. */
9755 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
9757 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
9759 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
9760 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
9761 int hmargin
, vmargin
, relief
, idx
, end
;
9762 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
;
9764 /* If image is a vector, choose the image according to the
9766 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
9767 if (VECTORP (image
))
9771 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
9772 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
9775 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
9776 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
9778 xassert (ASIZE (image
) >= idx
);
9779 image
= AREF (image
, idx
);
9784 /* Ignore invalid image specifications. */
9785 if (!valid_image_p (image
))
9788 /* Display the tool-bar button pressed, or depressed. */
9789 plist
= Fcopy_sequence (XCDR (image
));
9791 /* Compute margin and relief to draw. */
9792 relief
= (tool_bar_button_relief
>= 0
9793 ? tool_bar_button_relief
9794 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
9795 hmargin
= vmargin
= relief
;
9797 if (INTEGERP (Vtool_bar_button_margin
)
9798 && XINT (Vtool_bar_button_margin
) > 0)
9800 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
9801 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
9803 else if (CONSP (Vtool_bar_button_margin
))
9805 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
9806 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
9807 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
9809 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
9810 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
9811 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
9814 if (auto_raise_tool_bar_buttons_p
)
9816 /* Add a `:relief' property to the image spec if the item is
9820 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
9827 /* If image is selected, display it pressed, i.e. with a
9828 negative relief. If it's not selected, display it with a
9830 plist
= Fplist_put (plist
, QCrelief
,
9832 ? make_number (-relief
)
9833 : make_number (relief
)));
9838 /* Put a margin around the image. */
9839 if (hmargin
|| vmargin
)
9841 if (hmargin
== vmargin
)
9842 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
9844 plist
= Fplist_put (plist
, QCmargin
,
9845 Fcons (make_number (hmargin
),
9846 make_number (vmargin
)));
9849 /* If button is not enabled, and we don't have special images
9850 for the disabled state, make the image appear disabled by
9851 applying an appropriate algorithm to it. */
9852 if (!enabled_p
&& idx
< 0)
9853 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
9855 /* Put a `display' text property on the string for the image to
9856 display. Put a `menu-item' property on the string that gives
9857 the start of this item's properties in the tool-bar items
9859 image
= Fcons (Qimage
, plist
);
9860 props
= list4 (Qdisplay
, image
,
9861 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
9863 /* Let the last image hide all remaining spaces in the tool bar
9864 string. The string can be longer than needed when we reuse a
9866 if (i
+ 1 == f
->n_tool_bar_items
)
9867 end
= SCHARS (f
->desired_tool_bar_string
);
9870 Fadd_text_properties (make_number (i
), make_number (end
),
9871 props
, f
->desired_tool_bar_string
);
9879 /* Display one line of the tool-bar of frame IT->f.
9881 HEIGHT specifies the desired height of the tool-bar line.
9882 If the actual height of the glyph row is less than HEIGHT, the
9883 row's height is increased to HEIGHT, and the icons are centered
9884 vertically in the new height.
9886 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
9887 count a final empty row in case the tool-bar width exactly matches
9892 display_tool_bar_line (it
, height
)
9896 struct glyph_row
*row
= it
->glyph_row
;
9897 int max_x
= it
->last_visible_x
;
9900 prepare_desired_row (row
);
9901 row
->y
= it
->current_y
;
9903 /* Note that this isn't made use of if the face hasn't a box,
9904 so there's no need to check the face here. */
9905 it
->start_of_box_run_p
= 1;
9907 while (it
->current_x
< max_x
)
9909 int x
, n_glyphs_before
, i
, nglyphs
;
9910 struct it it_before
;
9912 /* Get the next display element. */
9913 if (!get_next_display_element (it
))
9915 /* Don't count empty row if we are counting needed tool-bar lines. */
9916 if (height
< 0 && !it
->hpos
)
9921 /* Produce glyphs. */
9922 n_glyphs_before
= row
->used
[TEXT_AREA
];
9925 PRODUCE_GLYPHS (it
);
9927 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
9929 x
= it_before
.current_x
;
9932 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
9934 if (x
+ glyph
->pixel_width
> max_x
)
9936 /* Glyph doesn't fit on line. Backtrack. */
9937 row
->used
[TEXT_AREA
] = n_glyphs_before
;
9939 /* If this is the only glyph on this line, it will never fit on the
9940 toolbar, so skip it. But ensure there is at least one glyph,
9941 so we don't accidentally disable the tool-bar. */
9942 if (n_glyphs_before
== 0
9943 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
9949 x
+= glyph
->pixel_width
;
9953 /* Stop at line ends. */
9954 if (ITERATOR_AT_END_OF_LINE_P (it
))
9957 set_iterator_to_next (it
, 1);
9962 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
9964 /* Use default face for the border below the tool bar.
9966 FIXME: When auto-resize-tool-bars is grow-only, there is
9967 no additional border below the possibly empty tool-bar lines.
9968 So to make the extra empty lines look "normal", we have to
9969 use the tool-bar face for the border too. */
9970 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
9971 it
->face_id
= DEFAULT_FACE_ID
;
9973 extend_face_to_end_of_line (it
);
9974 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
9975 last
->right_box_line_p
= 1;
9976 if (last
== row
->glyphs
[TEXT_AREA
])
9977 last
->left_box_line_p
= 1;
9979 /* Make line the desired height and center it vertically. */
9980 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
9982 /* Don't add more than one line height. */
9983 height
%= FRAME_LINE_HEIGHT (it
->f
);
9984 it
->max_ascent
+= height
/ 2;
9985 it
->max_descent
+= (height
+ 1) / 2;
9988 compute_line_metrics (it
);
9990 /* If line is empty, make it occupy the rest of the tool-bar. */
9991 if (!row
->displays_text_p
)
9993 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
9994 row
->visible_height
= row
->height
;
9995 row
->ascent
= row
->phys_ascent
= 0;
9996 row
->extra_line_spacing
= 0;
9999 row
->full_width_p
= 1;
10000 row
->continued_p
= 0;
10001 row
->truncated_on_left_p
= 0;
10002 row
->truncated_on_right_p
= 0;
10004 it
->current_x
= it
->hpos
= 0;
10005 it
->current_y
+= row
->height
;
10011 /* Max tool-bar height. */
10013 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10014 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10016 /* Value is the number of screen lines needed to make all tool-bar
10017 items of frame F visible. The number of actual rows needed is
10018 returned in *N_ROWS if non-NULL. */
10021 tool_bar_lines_needed (f
, n_rows
)
10025 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10027 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10028 the desired matrix, so use (unused) mode-line row as temporary row to
10029 avoid destroying the first tool-bar row. */
10030 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10032 /* Initialize an iterator for iteration over
10033 F->desired_tool_bar_string in the tool-bar window of frame F. */
10034 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10035 it
.first_visible_x
= 0;
10036 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10037 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10039 while (!ITERATOR_AT_END_P (&it
))
10041 clear_glyph_row (temp_row
);
10042 it
.glyph_row
= temp_row
;
10043 display_tool_bar_line (&it
, -1);
10045 clear_glyph_row (temp_row
);
10047 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10049 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10051 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10055 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10057 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10066 frame
= selected_frame
;
10068 CHECK_FRAME (frame
);
10069 f
= XFRAME (frame
);
10071 if (WINDOWP (f
->tool_bar_window
)
10072 || (w
= XWINDOW (f
->tool_bar_window
),
10073 WINDOW_TOTAL_LINES (w
) > 0))
10075 update_tool_bar (f
, 1);
10076 if (f
->n_tool_bar_items
)
10078 build_desired_tool_bar_string (f
);
10079 nlines
= tool_bar_lines_needed (f
, NULL
);
10083 return make_number (nlines
);
10087 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10088 height should be changed. */
10091 redisplay_tool_bar (f
)
10096 struct glyph_row
*row
;
10098 #if defined (USE_GTK) || USE_MAC_TOOLBAR
10099 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10100 update_frame_tool_bar (f
);
10104 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10105 do anything. This means you must start with tool-bar-lines
10106 non-zero to get the auto-sizing effect. Or in other words, you
10107 can turn off tool-bars by specifying tool-bar-lines zero. */
10108 if (!WINDOWP (f
->tool_bar_window
)
10109 || (w
= XWINDOW (f
->tool_bar_window
),
10110 WINDOW_TOTAL_LINES (w
) == 0))
10113 /* Set up an iterator for the tool-bar window. */
10114 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10115 it
.first_visible_x
= 0;
10116 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10117 row
= it
.glyph_row
;
10119 /* Build a string that represents the contents of the tool-bar. */
10120 build_desired_tool_bar_string (f
);
10121 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10123 if (f
->n_tool_bar_rows
== 0)
10127 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10128 nlines
!= WINDOW_TOTAL_LINES (w
)))
10130 extern Lisp_Object Qtool_bar_lines
;
10132 int old_height
= WINDOW_TOTAL_LINES (w
);
10134 XSETFRAME (frame
, f
);
10135 Fmodify_frame_parameters (frame
,
10136 Fcons (Fcons (Qtool_bar_lines
,
10137 make_number (nlines
)),
10139 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10141 clear_glyph_matrix (w
->desired_matrix
);
10142 fonts_changed_p
= 1;
10148 /* Display as many lines as needed to display all tool-bar items. */
10150 if (f
->n_tool_bar_rows
> 0)
10152 int border
, rows
, height
, extra
;
10154 if (INTEGERP (Vtool_bar_border
))
10155 border
= XINT (Vtool_bar_border
);
10156 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10157 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10158 else if (EQ (Vtool_bar_border
, Qborder_width
))
10159 border
= f
->border_width
;
10165 rows
= f
->n_tool_bar_rows
;
10166 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10167 extra
= it
.last_visible_y
- border
- height
* rows
;
10169 while (it
.current_y
< it
.last_visible_y
)
10172 if (extra
> 0 && rows
-- > 0)
10174 h
= (extra
+ rows
- 1) / rows
;
10177 display_tool_bar_line (&it
, height
+ h
);
10182 while (it
.current_y
< it
.last_visible_y
)
10183 display_tool_bar_line (&it
, 0);
10186 /* It doesn't make much sense to try scrolling in the tool-bar
10187 window, so don't do it. */
10188 w
->desired_matrix
->no_scrolling_p
= 1;
10189 w
->must_be_updated_p
= 1;
10191 if (!NILP (Vauto_resize_tool_bars
))
10193 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10194 int change_height_p
= 0;
10196 /* If we couldn't display everything, change the tool-bar's
10197 height if there is room for more. */
10198 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10199 && it
.current_y
< max_tool_bar_height
)
10200 change_height_p
= 1;
10202 row
= it
.glyph_row
- 1;
10204 /* If there are blank lines at the end, except for a partially
10205 visible blank line at the end that is smaller than
10206 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10207 if (!row
->displays_text_p
10208 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10209 change_height_p
= 1;
10211 /* If row displays tool-bar items, but is partially visible,
10212 change the tool-bar's height. */
10213 if (row
->displays_text_p
10214 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10215 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10216 change_height_p
= 1;
10218 /* Resize windows as needed by changing the `tool-bar-lines'
10219 frame parameter. */
10220 if (change_height_p
)
10222 extern Lisp_Object Qtool_bar_lines
;
10224 int old_height
= WINDOW_TOTAL_LINES (w
);
10226 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10228 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10229 && !f
->minimize_tool_bar_window_p
)
10230 ? (nlines
> old_height
)
10231 : (nlines
!= old_height
));
10232 f
->minimize_tool_bar_window_p
= 0;
10234 if (change_height_p
)
10236 XSETFRAME (frame
, f
);
10237 Fmodify_frame_parameters (frame
,
10238 Fcons (Fcons (Qtool_bar_lines
,
10239 make_number (nlines
)),
10241 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10243 clear_glyph_matrix (w
->desired_matrix
);
10244 f
->n_tool_bar_rows
= nrows
;
10245 fonts_changed_p
= 1;
10252 f
->minimize_tool_bar_window_p
= 0;
10257 /* Get information about the tool-bar item which is displayed in GLYPH
10258 on frame F. Return in *PROP_IDX the index where tool-bar item
10259 properties start in F->tool_bar_items. Value is zero if
10260 GLYPH doesn't display a tool-bar item. */
10263 tool_bar_item_info (f
, glyph
, prop_idx
)
10265 struct glyph
*glyph
;
10272 /* This function can be called asynchronously, which means we must
10273 exclude any possibility that Fget_text_property signals an
10275 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10276 charpos
= max (0, charpos
);
10278 /* Get the text property `menu-item' at pos. The value of that
10279 property is the start index of this item's properties in
10280 F->tool_bar_items. */
10281 prop
= Fget_text_property (make_number (charpos
),
10282 Qmenu_item
, f
->current_tool_bar_string
);
10283 if (INTEGERP (prop
))
10285 *prop_idx
= XINT (prop
);
10295 /* Get information about the tool-bar item at position X/Y on frame F.
10296 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10297 the current matrix of the tool-bar window of F, or NULL if not
10298 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10299 item in F->tool_bar_items. Value is
10301 -1 if X/Y is not on a tool-bar item
10302 0 if X/Y is on the same item that was highlighted before.
10306 get_tool_bar_item (f
, x
, y
, glyph
, hpos
, vpos
, prop_idx
)
10309 struct glyph
**glyph
;
10310 int *hpos
, *vpos
, *prop_idx
;
10312 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10313 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10316 /* Find the glyph under X/Y. */
10317 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10318 if (*glyph
== NULL
)
10321 /* Get the start of this tool-bar item's properties in
10322 f->tool_bar_items. */
10323 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10326 /* Is mouse on the highlighted item? */
10327 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
10328 && *vpos
>= dpyinfo
->mouse_face_beg_row
10329 && *vpos
<= dpyinfo
->mouse_face_end_row
10330 && (*vpos
> dpyinfo
->mouse_face_beg_row
10331 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
10332 && (*vpos
< dpyinfo
->mouse_face_end_row
10333 || *hpos
< dpyinfo
->mouse_face_end_col
10334 || dpyinfo
->mouse_face_past_end
))
10342 Handle mouse button event on the tool-bar of frame F, at
10343 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10344 0 for button release. MODIFIERS is event modifiers for button
10348 handle_tool_bar_click (f
, x
, y
, down_p
, modifiers
)
10351 unsigned int modifiers
;
10353 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10354 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10355 int hpos
, vpos
, prop_idx
;
10356 struct glyph
*glyph
;
10357 Lisp_Object enabled_p
;
10359 /* If not on the highlighted tool-bar item, return. */
10360 frame_to_window_pixel_xy (w
, &x
, &y
);
10361 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10364 /* If item is disabled, do nothing. */
10365 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10366 if (NILP (enabled_p
))
10371 /* Show item in pressed state. */
10372 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
10373 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10374 last_tool_bar_item
= prop_idx
;
10378 Lisp_Object key
, frame
;
10379 struct input_event event
;
10380 EVENT_INIT (event
);
10382 /* Show item in released state. */
10383 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
10384 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10386 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10388 XSETFRAME (frame
, f
);
10389 event
.kind
= TOOL_BAR_EVENT
;
10390 event
.frame_or_window
= frame
;
10392 kbd_buffer_store_event (&event
);
10394 event
.kind
= TOOL_BAR_EVENT
;
10395 event
.frame_or_window
= frame
;
10397 event
.modifiers
= modifiers
;
10398 kbd_buffer_store_event (&event
);
10399 last_tool_bar_item
= -1;
10404 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10405 tool-bar window-relative coordinates X/Y. Called from
10406 note_mouse_highlight. */
10409 note_tool_bar_highlight (f
, x
, y
)
10413 Lisp_Object window
= f
->tool_bar_window
;
10414 struct window
*w
= XWINDOW (window
);
10415 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10417 struct glyph
*glyph
;
10418 struct glyph_row
*row
;
10420 Lisp_Object enabled_p
;
10422 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10423 int mouse_down_p
, rc
;
10425 /* Function note_mouse_highlight is called with negative x(y
10426 values when mouse moves outside of the frame. */
10427 if (x
<= 0 || y
<= 0)
10429 clear_mouse_face (dpyinfo
);
10433 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10436 /* Not on tool-bar item. */
10437 clear_mouse_face (dpyinfo
);
10441 /* On same tool-bar item as before. */
10442 goto set_help_echo
;
10444 clear_mouse_face (dpyinfo
);
10446 /* Mouse is down, but on different tool-bar item? */
10447 mouse_down_p
= (dpyinfo
->grabbed
10448 && f
== last_mouse_frame
10449 && FRAME_LIVE_P (f
));
10451 && last_tool_bar_item
!= prop_idx
)
10454 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10455 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10457 /* If tool-bar item is not enabled, don't highlight it. */
10458 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10459 if (!NILP (enabled_p
))
10461 /* Compute the x-position of the glyph. In front and past the
10462 image is a space. We include this in the highlighted area. */
10463 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10464 for (i
= x
= 0; i
< hpos
; ++i
)
10465 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10467 /* Record this as the current active region. */
10468 dpyinfo
->mouse_face_beg_col
= hpos
;
10469 dpyinfo
->mouse_face_beg_row
= vpos
;
10470 dpyinfo
->mouse_face_beg_x
= x
;
10471 dpyinfo
->mouse_face_beg_y
= row
->y
;
10472 dpyinfo
->mouse_face_past_end
= 0;
10474 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
10475 dpyinfo
->mouse_face_end_row
= vpos
;
10476 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10477 dpyinfo
->mouse_face_end_y
= row
->y
;
10478 dpyinfo
->mouse_face_window
= window
;
10479 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10481 /* Display it as active. */
10482 show_mouse_face (dpyinfo
, draw
);
10483 dpyinfo
->mouse_face_image_state
= draw
;
10488 /* Set help_echo_string to a help string to display for this tool-bar item.
10489 XTread_socket does the rest. */
10490 help_echo_object
= help_echo_window
= Qnil
;
10491 help_echo_pos
= -1;
10492 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10493 if (NILP (help_echo_string
))
10494 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10497 #endif /* HAVE_WINDOW_SYSTEM */
10501 /************************************************************************
10502 Horizontal scrolling
10503 ************************************************************************/
10505 static int hscroll_window_tree
P_ ((Lisp_Object
));
10506 static int hscroll_windows
P_ ((Lisp_Object
));
10508 /* For all leaf windows in the window tree rooted at WINDOW, set their
10509 hscroll value so that PT is (i) visible in the window, and (ii) so
10510 that it is not within a certain margin at the window's left and
10511 right border. Value is non-zero if any window's hscroll has been
10515 hscroll_window_tree (window
)
10516 Lisp_Object window
;
10518 int hscrolled_p
= 0;
10519 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10520 int hscroll_step_abs
= 0;
10521 double hscroll_step_rel
= 0;
10523 if (hscroll_relative_p
)
10525 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10526 if (hscroll_step_rel
< 0)
10528 hscroll_relative_p
= 0;
10529 hscroll_step_abs
= 0;
10532 else if (INTEGERP (Vhscroll_step
))
10534 hscroll_step_abs
= XINT (Vhscroll_step
);
10535 if (hscroll_step_abs
< 0)
10536 hscroll_step_abs
= 0;
10539 hscroll_step_abs
= 0;
10541 while (WINDOWP (window
))
10543 struct window
*w
= XWINDOW (window
);
10545 if (WINDOWP (w
->hchild
))
10546 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10547 else if (WINDOWP (w
->vchild
))
10548 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10549 else if (w
->cursor
.vpos
>= 0)
10552 int text_area_width
;
10553 struct glyph_row
*current_cursor_row
10554 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10555 struct glyph_row
*desired_cursor_row
10556 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10557 struct glyph_row
*cursor_row
10558 = (desired_cursor_row
->enabled_p
10559 ? desired_cursor_row
10560 : current_cursor_row
);
10562 text_area_width
= window_box_width (w
, TEXT_AREA
);
10564 /* Scroll when cursor is inside this scroll margin. */
10565 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10567 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10568 && ((XFASTINT (w
->hscroll
)
10569 && w
->cursor
.x
<= h_margin
)
10570 || (cursor_row
->enabled_p
10571 && cursor_row
->truncated_on_right_p
10572 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10576 struct buffer
*saved_current_buffer
;
10580 /* Find point in a display of infinite width. */
10581 saved_current_buffer
= current_buffer
;
10582 current_buffer
= XBUFFER (w
->buffer
);
10584 if (w
== XWINDOW (selected_window
))
10585 pt
= BUF_PT (current_buffer
);
10588 pt
= marker_position (w
->pointm
);
10589 pt
= max (BEGV
, pt
);
10593 /* Move iterator to pt starting at cursor_row->start in
10594 a line with infinite width. */
10595 init_to_row_start (&it
, w
, cursor_row
);
10596 it
.last_visible_x
= INFINITY
;
10597 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
10598 current_buffer
= saved_current_buffer
;
10600 /* Position cursor in window. */
10601 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
10602 hscroll
= max (0, (it
.current_x
10603 - (ITERATOR_AT_END_OF_LINE_P (&it
)
10604 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
10605 : (text_area_width
/ 2))))
10606 / FRAME_COLUMN_WIDTH (it
.f
);
10607 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
10609 if (hscroll_relative_p
)
10610 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
10613 wanted_x
= text_area_width
10614 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10617 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10621 if (hscroll_relative_p
)
10622 wanted_x
= text_area_width
* hscroll_step_rel
10625 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10628 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10630 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
10632 /* Don't call Fset_window_hscroll if value hasn't
10633 changed because it will prevent redisplay
10635 if (XFASTINT (w
->hscroll
) != hscroll
)
10637 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
10638 w
->hscroll
= make_number (hscroll
);
10647 /* Value is non-zero if hscroll of any leaf window has been changed. */
10648 return hscrolled_p
;
10652 /* Set hscroll so that cursor is visible and not inside horizontal
10653 scroll margins for all windows in the tree rooted at WINDOW. See
10654 also hscroll_window_tree above. Value is non-zero if any window's
10655 hscroll has been changed. If it has, desired matrices on the frame
10656 of WINDOW are cleared. */
10659 hscroll_windows (window
)
10660 Lisp_Object window
;
10662 int hscrolled_p
= hscroll_window_tree (window
);
10664 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
10665 return hscrolled_p
;
10670 /************************************************************************
10672 ************************************************************************/
10674 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
10675 to a non-zero value. This is sometimes handy to have in a debugger
10680 /* First and last unchanged row for try_window_id. */
10682 int debug_first_unchanged_at_end_vpos
;
10683 int debug_last_unchanged_at_beg_vpos
;
10685 /* Delta vpos and y. */
10687 int debug_dvpos
, debug_dy
;
10689 /* Delta in characters and bytes for try_window_id. */
10691 int debug_delta
, debug_delta_bytes
;
10693 /* Values of window_end_pos and window_end_vpos at the end of
10696 EMACS_INT debug_end_pos
, debug_end_vpos
;
10698 /* Append a string to W->desired_matrix->method. FMT is a printf
10699 format string. A1...A9 are a supplement for a variable-length
10700 argument list. If trace_redisplay_p is non-zero also printf the
10701 resulting string to stderr. */
10704 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
10707 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
10710 char *method
= w
->desired_matrix
->method
;
10711 int len
= strlen (method
);
10712 int size
= sizeof w
->desired_matrix
->method
;
10713 int remaining
= size
- len
- 1;
10715 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
10716 if (len
&& remaining
)
10719 --remaining
, ++len
;
10722 strncpy (method
+ len
, buffer
, remaining
);
10724 if (trace_redisplay_p
)
10725 fprintf (stderr
, "%p (%s): %s\n",
10727 ((BUFFERP (w
->buffer
)
10728 && STRINGP (XBUFFER (w
->buffer
)->name
))
10729 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
10734 #endif /* GLYPH_DEBUG */
10737 /* Value is non-zero if all changes in window W, which displays
10738 current_buffer, are in the text between START and END. START is a
10739 buffer position, END is given as a distance from Z. Used in
10740 redisplay_internal for display optimization. */
10743 text_outside_line_unchanged_p (w
, start
, end
)
10747 int unchanged_p
= 1;
10749 /* If text or overlays have changed, see where. */
10750 if (XFASTINT (w
->last_modified
) < MODIFF
10751 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
10753 /* Gap in the line? */
10754 if (GPT
< start
|| Z
- GPT
< end
)
10757 /* Changes start in front of the line, or end after it? */
10759 && (BEG_UNCHANGED
< start
- 1
10760 || END_UNCHANGED
< end
))
10763 /* If selective display, can't optimize if changes start at the
10764 beginning of the line. */
10766 && INTEGERP (current_buffer
->selective_display
)
10767 && XINT (current_buffer
->selective_display
) > 0
10768 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
10771 /* If there are overlays at the start or end of the line, these
10772 may have overlay strings with newlines in them. A change at
10773 START, for instance, may actually concern the display of such
10774 overlay strings as well, and they are displayed on different
10775 lines. So, quickly rule out this case. (For the future, it
10776 might be desirable to implement something more telling than
10777 just BEG/END_UNCHANGED.) */
10780 if (BEG
+ BEG_UNCHANGED
== start
10781 && overlay_touches_p (start
))
10783 if (END_UNCHANGED
== end
10784 && overlay_touches_p (Z
- end
))
10789 return unchanged_p
;
10793 /* Do a frame update, taking possible shortcuts into account. This is
10794 the main external entry point for redisplay.
10796 If the last redisplay displayed an echo area message and that message
10797 is no longer requested, we clear the echo area or bring back the
10798 mini-buffer if that is in use. */
10803 redisplay_internal (0);
10808 overlay_arrow_string_or_property (var
)
10813 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
10816 return Voverlay_arrow_string
;
10819 /* Return 1 if there are any overlay-arrows in current_buffer. */
10821 overlay_arrow_in_current_buffer_p ()
10825 for (vlist
= Voverlay_arrow_variable_list
;
10827 vlist
= XCDR (vlist
))
10829 Lisp_Object var
= XCAR (vlist
);
10832 if (!SYMBOLP (var
))
10834 val
= find_symbol_value (var
);
10836 && current_buffer
== XMARKER (val
)->buffer
)
10843 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
10847 overlay_arrows_changed_p ()
10851 for (vlist
= Voverlay_arrow_variable_list
;
10853 vlist
= XCDR (vlist
))
10855 Lisp_Object var
= XCAR (vlist
);
10856 Lisp_Object val
, pstr
;
10858 if (!SYMBOLP (var
))
10860 val
= find_symbol_value (var
);
10861 if (!MARKERP (val
))
10863 if (! EQ (COERCE_MARKER (val
),
10864 Fget (var
, Qlast_arrow_position
))
10865 || ! (pstr
= overlay_arrow_string_or_property (var
),
10866 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
10872 /* Mark overlay arrows to be updated on next redisplay. */
10875 update_overlay_arrows (up_to_date
)
10880 for (vlist
= Voverlay_arrow_variable_list
;
10882 vlist
= XCDR (vlist
))
10884 Lisp_Object var
= XCAR (vlist
);
10886 if (!SYMBOLP (var
))
10889 if (up_to_date
> 0)
10891 Lisp_Object val
= find_symbol_value (var
);
10892 Fput (var
, Qlast_arrow_position
,
10893 COERCE_MARKER (val
));
10894 Fput (var
, Qlast_arrow_string
,
10895 overlay_arrow_string_or_property (var
));
10897 else if (up_to_date
< 0
10898 || !NILP (Fget (var
, Qlast_arrow_position
)))
10900 Fput (var
, Qlast_arrow_position
, Qt
);
10901 Fput (var
, Qlast_arrow_string
, Qt
);
10907 /* Return overlay arrow string to display at row.
10908 Return integer (bitmap number) for arrow bitmap in left fringe.
10909 Return nil if no overlay arrow. */
10912 overlay_arrow_at_row (it
, row
)
10914 struct glyph_row
*row
;
10918 for (vlist
= Voverlay_arrow_variable_list
;
10920 vlist
= XCDR (vlist
))
10922 Lisp_Object var
= XCAR (vlist
);
10925 if (!SYMBOLP (var
))
10928 val
= find_symbol_value (var
);
10931 && current_buffer
== XMARKER (val
)->buffer
10932 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
10934 if (FRAME_WINDOW_P (it
->f
)
10935 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
10937 #ifdef HAVE_WINDOW_SYSTEM
10938 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
10941 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
10942 return make_number (fringe_bitmap
);
10945 return make_number (-1); /* Use default arrow bitmap */
10947 return overlay_arrow_string_or_property (var
);
10954 /* Return 1 if point moved out of or into a composition. Otherwise
10955 return 0. PREV_BUF and PREV_PT are the last point buffer and
10956 position. BUF and PT are the current point buffer and position. */
10959 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
10960 struct buffer
*prev_buf
, *buf
;
10963 EMACS_INT start
, end
;
10965 Lisp_Object buffer
;
10967 XSETBUFFER (buffer
, buf
);
10968 /* Check a composition at the last point if point moved within the
10970 if (prev_buf
== buf
)
10973 /* Point didn't move. */
10976 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
10977 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
10978 && COMPOSITION_VALID_P (start
, end
, prop
)
10979 && start
< prev_pt
&& end
> prev_pt
)
10980 /* The last point was within the composition. Return 1 iff
10981 point moved out of the composition. */
10982 return (pt
<= start
|| pt
>= end
);
10985 /* Check a composition at the current point. */
10986 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
10987 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
10988 && COMPOSITION_VALID_P (start
, end
, prop
)
10989 && start
< pt
&& end
> pt
);
10993 /* Reconsider the setting of B->clip_changed which is displayed
10997 reconsider_clip_changes (w
, b
)
11001 if (b
->clip_changed
11002 && !NILP (w
->window_end_valid
)
11003 && w
->current_matrix
->buffer
== b
11004 && w
->current_matrix
->zv
== BUF_ZV (b
)
11005 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11006 b
->clip_changed
= 0;
11008 /* If display wasn't paused, and W is not a tool bar window, see if
11009 point has been moved into or out of a composition. In that case,
11010 we set b->clip_changed to 1 to force updating the screen. If
11011 b->clip_changed has already been set to 1, we can skip this
11013 if (!b
->clip_changed
11014 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11018 if (w
== XWINDOW (selected_window
))
11019 pt
= BUF_PT (current_buffer
);
11021 pt
= marker_position (w
->pointm
);
11023 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11024 || pt
!= XINT (w
->last_point
))
11025 && check_point_in_composition (w
->current_matrix
->buffer
,
11026 XINT (w
->last_point
),
11027 XBUFFER (w
->buffer
), pt
))
11028 b
->clip_changed
= 1;
11033 /* Select FRAME to forward the values of frame-local variables into C
11034 variables so that the redisplay routines can access those values
11038 select_frame_for_redisplay (frame
)
11041 Lisp_Object tail
, sym
, val
;
11042 Lisp_Object old
= selected_frame
;
11044 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11046 selected_frame
= frame
;
11050 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11051 if (CONSP (XCAR (tail
))
11052 && (sym
= XCAR (XCAR (tail
)),
11054 && (sym
= indirect_variable (sym
),
11055 val
= SYMBOL_VALUE (sym
),
11056 (BUFFER_LOCAL_VALUEP (val
)))
11057 && XBUFFER_LOCAL_VALUE (val
)->check_frame
)
11058 /* Use find_symbol_value rather than Fsymbol_value
11059 to avoid an error if it is void. */
11060 find_symbol_value (sym
);
11061 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11065 #define STOP_POLLING \
11066 do { if (! polling_stopped_here) stop_polling (); \
11067 polling_stopped_here = 1; } while (0)
11069 #define RESUME_POLLING \
11070 do { if (polling_stopped_here) start_polling (); \
11071 polling_stopped_here = 0; } while (0)
11074 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11075 response to any user action; therefore, we should preserve the echo
11076 area. (Actually, our caller does that job.) Perhaps in the future
11077 avoid recentering windows if it is not necessary; currently that
11078 causes some problems. */
11081 redisplay_internal (preserve_echo_area
)
11082 int preserve_echo_area
;
11084 struct window
*w
= XWINDOW (selected_window
);
11087 int must_finish
= 0;
11088 struct text_pos tlbufpos
, tlendpos
;
11089 int number_of_visible_frames
;
11092 int polling_stopped_here
= 0;
11093 Lisp_Object old_frame
= selected_frame
;
11095 /* Non-zero means redisplay has to consider all windows on all
11096 frames. Zero means, only selected_window is considered. */
11097 int consider_all_windows_p
;
11099 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11101 /* No redisplay if running in batch mode or frame is not yet fully
11102 initialized, or redisplay is explicitly turned off by setting
11103 Vinhibit_redisplay. */
11105 || !NILP (Vinhibit_redisplay
))
11108 /* Don't examine these until after testing Vinhibit_redisplay.
11109 When Emacs is shutting down, perhaps because its connection to
11110 X has dropped, we should not look at them at all. */
11111 f
= XFRAME (w
->frame
);
11112 sf
= SELECTED_FRAME ();
11114 if (!f
->glyphs_initialized_p
)
11117 /* The flag redisplay_performed_directly_p is set by
11118 direct_output_for_insert when it already did the whole screen
11119 update necessary. */
11120 if (redisplay_performed_directly_p
)
11122 redisplay_performed_directly_p
= 0;
11123 if (!hscroll_windows (selected_window
))
11127 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (MAC_OS)
11128 if (popup_activated ())
11132 /* I don't think this happens but let's be paranoid. */
11133 if (redisplaying_p
)
11136 /* Record a function that resets redisplaying_p to its old value
11137 when we leave this function. */
11138 count
= SPECPDL_INDEX ();
11139 record_unwind_protect (unwind_redisplay
,
11140 Fcons (make_number (redisplaying_p
), selected_frame
));
11142 specbind (Qinhibit_free_realized_faces
, Qnil
);
11145 Lisp_Object tail
, frame
;
11147 FOR_EACH_FRAME (tail
, frame
)
11149 struct frame
*f
= XFRAME (frame
);
11150 f
->already_hscrolled_p
= 0;
11155 if (!EQ (old_frame
, selected_frame
)
11156 && FRAME_LIVE_P (XFRAME (old_frame
)))
11157 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11158 selected_frame and selected_window to be temporarily out-of-sync so
11159 when we come back here via `goto retry', we need to resync because we
11160 may need to run Elisp code (via prepare_menu_bars). */
11161 select_frame_for_redisplay (old_frame
);
11164 reconsider_clip_changes (w
, current_buffer
);
11165 last_escape_glyph_frame
= NULL
;
11166 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11168 /* If new fonts have been loaded that make a glyph matrix adjustment
11169 necessary, do it. */
11170 if (fonts_changed_p
)
11172 adjust_glyphs (NULL
);
11173 ++windows_or_buffers_changed
;
11174 fonts_changed_p
= 0;
11177 /* If face_change_count is non-zero, init_iterator will free all
11178 realized faces, which includes the faces referenced from current
11179 matrices. So, we can't reuse current matrices in this case. */
11180 if (face_change_count
)
11181 ++windows_or_buffers_changed
;
11183 if (FRAME_TERMCAP_P (sf
)
11184 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11186 /* Since frames on a single ASCII terminal share the same
11187 display area, displaying a different frame means redisplay
11188 the whole thing. */
11189 windows_or_buffers_changed
++;
11190 SET_FRAME_GARBAGED (sf
);
11191 FRAME_TTY (sf
)->previous_frame
= sf
;
11194 /* Set the visible flags for all frames. Do this before checking
11195 for resized or garbaged frames; they want to know if their frames
11196 are visible. See the comment in frame.h for
11197 FRAME_SAMPLE_VISIBILITY. */
11199 Lisp_Object tail
, frame
;
11201 number_of_visible_frames
= 0;
11203 FOR_EACH_FRAME (tail
, frame
)
11205 struct frame
*f
= XFRAME (frame
);
11207 FRAME_SAMPLE_VISIBILITY (f
);
11208 if (FRAME_VISIBLE_P (f
))
11209 ++number_of_visible_frames
;
11210 clear_desired_matrices (f
);
11215 /* Notice any pending interrupt request to change frame size. */
11216 do_pending_window_change (1);
11218 /* Clear frames marked as garbaged. */
11219 if (frame_garbaged
)
11220 clear_garbaged_frames ();
11222 /* Build menubar and tool-bar items. */
11223 if (NILP (Vmemory_full
))
11224 prepare_menu_bars ();
11226 if (windows_or_buffers_changed
)
11227 update_mode_lines
++;
11229 /* Detect case that we need to write or remove a star in the mode line. */
11230 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11232 w
->update_mode_line
= Qt
;
11233 if (buffer_shared
> 1)
11234 update_mode_lines
++;
11237 /* Avoid invocation of point motion hooks by `current_column' below. */
11238 count1
= SPECPDL_INDEX ();
11239 specbind (Qinhibit_point_motion_hooks
, Qt
);
11241 /* If %c is in the mode line, update it if needed. */
11242 if (!NILP (w
->column_number_displayed
)
11243 /* This alternative quickly identifies a common case
11244 where no change is needed. */
11245 && !(PT
== XFASTINT (w
->last_point
)
11246 && XFASTINT (w
->last_modified
) >= MODIFF
11247 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11248 && (XFASTINT (w
->column_number_displayed
)
11249 != (int) current_column ())) /* iftc */
11250 w
->update_mode_line
= Qt
;
11252 unbind_to (count1
, Qnil
);
11254 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11256 /* The variable buffer_shared is set in redisplay_window and
11257 indicates that we redisplay a buffer in different windows. See
11259 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11260 || cursor_type_changed
);
11262 /* If specs for an arrow have changed, do thorough redisplay
11263 to ensure we remove any arrow that should no longer exist. */
11264 if (overlay_arrows_changed_p ())
11265 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11267 /* Normally the message* functions will have already displayed and
11268 updated the echo area, but the frame may have been trashed, or
11269 the update may have been preempted, so display the echo area
11270 again here. Checking message_cleared_p captures the case that
11271 the echo area should be cleared. */
11272 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11273 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11274 || (message_cleared_p
11275 && minibuf_level
== 0
11276 /* If the mini-window is currently selected, this means the
11277 echo-area doesn't show through. */
11278 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11280 int window_height_changed_p
= echo_area_display (0);
11283 /* If we don't display the current message, don't clear the
11284 message_cleared_p flag, because, if we did, we wouldn't clear
11285 the echo area in the next redisplay which doesn't preserve
11287 if (!display_last_displayed_message_p
)
11288 message_cleared_p
= 0;
11290 if (fonts_changed_p
)
11292 else if (window_height_changed_p
)
11294 consider_all_windows_p
= 1;
11295 ++update_mode_lines
;
11296 ++windows_or_buffers_changed
;
11298 /* If window configuration was changed, frames may have been
11299 marked garbaged. Clear them or we will experience
11300 surprises wrt scrolling. */
11301 if (frame_garbaged
)
11302 clear_garbaged_frames ();
11305 else if (EQ (selected_window
, minibuf_window
)
11306 && (current_buffer
->clip_changed
11307 || XFASTINT (w
->last_modified
) < MODIFF
11308 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11309 && resize_mini_window (w
, 0))
11311 /* Resized active mini-window to fit the size of what it is
11312 showing if its contents might have changed. */
11314 consider_all_windows_p
= 1;
11315 ++windows_or_buffers_changed
;
11316 ++update_mode_lines
;
11318 /* If window configuration was changed, frames may have been
11319 marked garbaged. Clear them or we will experience
11320 surprises wrt scrolling. */
11321 if (frame_garbaged
)
11322 clear_garbaged_frames ();
11326 /* If showing the region, and mark has changed, we must redisplay
11327 the whole window. The assignment to this_line_start_pos prevents
11328 the optimization directly below this if-statement. */
11329 if (((!NILP (Vtransient_mark_mode
)
11330 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
11331 != !NILP (w
->region_showing
))
11332 || (!NILP (w
->region_showing
)
11333 && !EQ (w
->region_showing
,
11334 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
11335 CHARPOS (this_line_start_pos
) = 0;
11337 /* Optimize the case that only the line containing the cursor in the
11338 selected window has changed. Variables starting with this_ are
11339 set in display_line and record information about the line
11340 containing the cursor. */
11341 tlbufpos
= this_line_start_pos
;
11342 tlendpos
= this_line_end_pos
;
11343 if (!consider_all_windows_p
11344 && CHARPOS (tlbufpos
) > 0
11345 && NILP (w
->update_mode_line
)
11346 && !current_buffer
->clip_changed
11347 && !current_buffer
->prevent_redisplay_optimizations_p
11348 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11349 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11350 /* Make sure recorded data applies to current buffer, etc. */
11351 && this_line_buffer
== current_buffer
11352 && current_buffer
== XBUFFER (w
->buffer
)
11353 && NILP (w
->force_start
)
11354 && NILP (w
->optional_new_start
)
11355 /* Point must be on the line that we have info recorded about. */
11356 && PT
>= CHARPOS (tlbufpos
)
11357 && PT
<= Z
- CHARPOS (tlendpos
)
11358 /* All text outside that line, including its final newline,
11359 must be unchanged */
11360 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11361 CHARPOS (tlendpos
)))
11363 if (CHARPOS (tlbufpos
) > BEGV
11364 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11365 && (CHARPOS (tlbufpos
) == ZV
11366 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11367 /* Former continuation line has disappeared by becoming empty */
11369 else if (XFASTINT (w
->last_modified
) < MODIFF
11370 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11371 || MINI_WINDOW_P (w
))
11373 /* We have to handle the case of continuation around a
11374 wide-column character (See the comment in indent.c around
11377 For instance, in the following case:
11379 -------- Insert --------
11380 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11381 J_I_ ==> J_I_ `^^' are cursors.
11385 As we have to redraw the line above, we should goto cancel. */
11388 int line_height_before
= this_line_pixel_height
;
11390 /* Note that start_display will handle the case that the
11391 line starting at tlbufpos is a continuation lines. */
11392 start_display (&it
, w
, tlbufpos
);
11394 /* Implementation note: It this still necessary? */
11395 if (it
.current_x
!= this_line_start_x
)
11398 TRACE ((stderr
, "trying display optimization 1\n"));
11399 w
->cursor
.vpos
= -1;
11400 overlay_arrow_seen
= 0;
11401 it
.vpos
= this_line_vpos
;
11402 it
.current_y
= this_line_y
;
11403 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11404 display_line (&it
);
11406 /* If line contains point, is not continued,
11407 and ends at same distance from eob as before, we win */
11408 if (w
->cursor
.vpos
>= 0
11409 /* Line is not continued, otherwise this_line_start_pos
11410 would have been set to 0 in display_line. */
11411 && CHARPOS (this_line_start_pos
)
11412 /* Line ends as before. */
11413 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11414 /* Line has same height as before. Otherwise other lines
11415 would have to be shifted up or down. */
11416 && this_line_pixel_height
== line_height_before
)
11418 /* If this is not the window's last line, we must adjust
11419 the charstarts of the lines below. */
11420 if (it
.current_y
< it
.last_visible_y
)
11422 struct glyph_row
*row
11423 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11424 int delta
, delta_bytes
;
11426 if (Z
- CHARPOS (tlendpos
) == ZV
)
11428 /* This line ends at end of (accessible part of)
11429 buffer. There is no newline to count. */
11431 - CHARPOS (tlendpos
)
11432 - MATRIX_ROW_START_CHARPOS (row
));
11433 delta_bytes
= (Z_BYTE
11434 - BYTEPOS (tlendpos
)
11435 - MATRIX_ROW_START_BYTEPOS (row
));
11439 /* This line ends in a newline. Must take
11440 account of the newline and the rest of the
11441 text that follows. */
11443 - CHARPOS (tlendpos
)
11444 - MATRIX_ROW_START_CHARPOS (row
));
11445 delta_bytes
= (Z_BYTE
11446 - BYTEPOS (tlendpos
)
11447 - MATRIX_ROW_START_BYTEPOS (row
));
11450 increment_matrix_positions (w
->current_matrix
,
11451 this_line_vpos
+ 1,
11452 w
->current_matrix
->nrows
,
11453 delta
, delta_bytes
);
11456 /* If this row displays text now but previously didn't,
11457 or vice versa, w->window_end_vpos may have to be
11459 if ((it
.glyph_row
- 1)->displays_text_p
)
11461 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11462 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11464 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11465 && this_line_vpos
> 0)
11466 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11467 w
->window_end_valid
= Qnil
;
11469 /* Update hint: No need to try to scroll in update_window. */
11470 w
->desired_matrix
->no_scrolling_p
= 1;
11473 *w
->desired_matrix
->method
= 0;
11474 debug_method_add (w
, "optimization 1");
11476 #ifdef HAVE_WINDOW_SYSTEM
11477 update_window_fringes (w
, 0);
11484 else if (/* Cursor position hasn't changed. */
11485 PT
== XFASTINT (w
->last_point
)
11486 /* Make sure the cursor was last displayed
11487 in this window. Otherwise we have to reposition it. */
11488 && 0 <= w
->cursor
.vpos
11489 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11493 do_pending_window_change (1);
11495 /* We used to always goto end_of_redisplay here, but this
11496 isn't enough if we have a blinking cursor. */
11497 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11498 goto end_of_redisplay
;
11502 /* If highlighting the region, or if the cursor is in the echo area,
11503 then we can't just move the cursor. */
11504 else if (! (!NILP (Vtransient_mark_mode
)
11505 && !NILP (current_buffer
->mark_active
))
11506 && (EQ (selected_window
, current_buffer
->last_selected_window
)
11507 || highlight_nonselected_windows
)
11508 && NILP (w
->region_showing
)
11509 && NILP (Vshow_trailing_whitespace
)
11510 && !cursor_in_echo_area
)
11513 struct glyph_row
*row
;
11515 /* Skip from tlbufpos to PT and see where it is. Note that
11516 PT may be in invisible text. If so, we will end at the
11517 next visible position. */
11518 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11519 NULL
, DEFAULT_FACE_ID
);
11520 it
.current_x
= this_line_start_x
;
11521 it
.current_y
= this_line_y
;
11522 it
.vpos
= this_line_vpos
;
11524 /* The call to move_it_to stops in front of PT, but
11525 moves over before-strings. */
11526 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11528 if (it
.vpos
== this_line_vpos
11529 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11532 xassert (this_line_vpos
== it
.vpos
);
11533 xassert (this_line_y
== it
.current_y
);
11534 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11536 *w
->desired_matrix
->method
= 0;
11537 debug_method_add (w
, "optimization 3");
11546 /* Text changed drastically or point moved off of line. */
11547 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11550 CHARPOS (this_line_start_pos
) = 0;
11551 consider_all_windows_p
|= buffer_shared
> 1;
11552 ++clear_face_cache_count
;
11553 #ifdef HAVE_WINDOW_SYSTEM
11554 ++clear_image_cache_count
;
11557 /* Build desired matrices, and update the display. If
11558 consider_all_windows_p is non-zero, do it for all windows on all
11559 frames. Otherwise do it for selected_window, only. */
11561 if (consider_all_windows_p
)
11563 Lisp_Object tail
, frame
;
11565 FOR_EACH_FRAME (tail
, frame
)
11566 XFRAME (frame
)->updated_p
= 0;
11568 /* Recompute # windows showing selected buffer. This will be
11569 incremented each time such a window is displayed. */
11572 FOR_EACH_FRAME (tail
, frame
)
11574 struct frame
*f
= XFRAME (frame
);
11576 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11578 if (! EQ (frame
, selected_frame
))
11579 /* Select the frame, for the sake of frame-local
11581 select_frame_for_redisplay (frame
);
11583 /* Mark all the scroll bars to be removed; we'll redeem
11584 the ones we want when we redisplay their windows. */
11585 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11586 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11588 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11589 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11591 /* Any scroll bars which redisplay_windows should have
11592 nuked should now go away. */
11593 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11594 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
11596 /* If fonts changed, display again. */
11597 /* ??? rms: I suspect it is a mistake to jump all the way
11598 back to retry here. It should just retry this frame. */
11599 if (fonts_changed_p
)
11602 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11604 /* See if we have to hscroll. */
11605 if (!f
->already_hscrolled_p
)
11607 f
->already_hscrolled_p
= 1;
11608 if (hscroll_windows (f
->root_window
))
11612 /* Prevent various kinds of signals during display
11613 update. stdio is not robust about handling
11614 signals, which can cause an apparent I/O
11616 if (interrupt_input
)
11617 unrequest_sigio ();
11620 /* Update the display. */
11621 set_window_update_flags (XWINDOW (f
->root_window
), 1);
11622 pause
|= update_frame (f
, 0, 0);
11623 #if 0 /* Exiting the loop can leave the wrong value for buffer_shared. */
11633 if (!EQ (old_frame
, selected_frame
)
11634 && FRAME_LIVE_P (XFRAME (old_frame
)))
11635 /* We played a bit fast-and-loose above and allowed selected_frame
11636 and selected_window to be temporarily out-of-sync but let's make
11637 sure this stays contained. */
11638 select_frame_for_redisplay (old_frame
);
11639 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
11643 /* Do the mark_window_display_accurate after all windows have
11644 been redisplayed because this call resets flags in buffers
11645 which are needed for proper redisplay. */
11646 FOR_EACH_FRAME (tail
, frame
)
11648 struct frame
*f
= XFRAME (frame
);
11651 mark_window_display_accurate (f
->root_window
, 1);
11652 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
11653 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
11658 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11660 Lisp_Object mini_window
;
11661 struct frame
*mini_frame
;
11663 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
11664 /* Use list_of_error, not Qerror, so that
11665 we catch only errors and don't run the debugger. */
11666 internal_condition_case_1 (redisplay_window_1
, selected_window
,
11668 redisplay_window_error
);
11670 /* Compare desired and current matrices, perform output. */
11673 /* If fonts changed, display again. */
11674 if (fonts_changed_p
)
11677 /* Prevent various kinds of signals during display update.
11678 stdio is not robust about handling signals,
11679 which can cause an apparent I/O error. */
11680 if (interrupt_input
)
11681 unrequest_sigio ();
11684 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11686 if (hscroll_windows (selected_window
))
11689 XWINDOW (selected_window
)->must_be_updated_p
= 1;
11690 pause
= update_frame (sf
, 0, 0);
11693 /* We may have called echo_area_display at the top of this
11694 function. If the echo area is on another frame, that may
11695 have put text on a frame other than the selected one, so the
11696 above call to update_frame would not have caught it. Catch
11698 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11699 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
11701 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
11703 XWINDOW (mini_window
)->must_be_updated_p
= 1;
11704 pause
|= update_frame (mini_frame
, 0, 0);
11705 if (!pause
&& hscroll_windows (mini_window
))
11710 /* If display was paused because of pending input, make sure we do a
11711 thorough update the next time. */
11714 /* Prevent the optimization at the beginning of
11715 redisplay_internal that tries a single-line update of the
11716 line containing the cursor in the selected window. */
11717 CHARPOS (this_line_start_pos
) = 0;
11719 /* Let the overlay arrow be updated the next time. */
11720 update_overlay_arrows (0);
11722 /* If we pause after scrolling, some rows in the current
11723 matrices of some windows are not valid. */
11724 if (!WINDOW_FULL_WIDTH_P (w
)
11725 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
11726 update_mode_lines
= 1;
11730 if (!consider_all_windows_p
)
11732 /* This has already been done above if
11733 consider_all_windows_p is set. */
11734 mark_window_display_accurate_1 (w
, 1);
11736 /* Say overlay arrows are up to date. */
11737 update_overlay_arrows (1);
11739 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
11740 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
11743 update_mode_lines
= 0;
11744 windows_or_buffers_changed
= 0;
11745 cursor_type_changed
= 0;
11748 /* Start SIGIO interrupts coming again. Having them off during the
11749 code above makes it less likely one will discard output, but not
11750 impossible, since there might be stuff in the system buffer here.
11751 But it is much hairier to try to do anything about that. */
11752 if (interrupt_input
)
11756 /* If a frame has become visible which was not before, redisplay
11757 again, so that we display it. Expose events for such a frame
11758 (which it gets when becoming visible) don't call the parts of
11759 redisplay constructing glyphs, so simply exposing a frame won't
11760 display anything in this case. So, we have to display these
11761 frames here explicitly. */
11764 Lisp_Object tail
, frame
;
11767 FOR_EACH_FRAME (tail
, frame
)
11769 int this_is_visible
= 0;
11771 if (XFRAME (frame
)->visible
)
11772 this_is_visible
= 1;
11773 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
11774 if (XFRAME (frame
)->visible
)
11775 this_is_visible
= 1;
11777 if (this_is_visible
)
11781 if (new_count
!= number_of_visible_frames
)
11782 windows_or_buffers_changed
++;
11785 /* Change frame size now if a change is pending. */
11786 do_pending_window_change (1);
11788 /* If we just did a pending size change, or have additional
11789 visible frames, redisplay again. */
11790 if (windows_or_buffers_changed
&& !pause
)
11793 /* Clear the face cache eventually. */
11794 if (consider_all_windows_p
)
11796 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
11798 clear_face_cache (0);
11799 clear_face_cache_count
= 0;
11801 #ifdef HAVE_WINDOW_SYSTEM
11802 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
11804 clear_image_caches (Qnil
);
11805 clear_image_cache_count
= 0;
11807 #endif /* HAVE_WINDOW_SYSTEM */
11811 unbind_to (count
, Qnil
);
11816 /* Redisplay, but leave alone any recent echo area message unless
11817 another message has been requested in its place.
11819 This is useful in situations where you need to redisplay but no
11820 user action has occurred, making it inappropriate for the message
11821 area to be cleared. See tracking_off and
11822 wait_reading_process_output for examples of these situations.
11824 FROM_WHERE is an integer saying from where this function was
11825 called. This is useful for debugging. */
11828 redisplay_preserve_echo_area (from_where
)
11831 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
11833 if (!NILP (echo_area_buffer
[1]))
11835 /* We have a previously displayed message, but no current
11836 message. Redisplay the previous message. */
11837 display_last_displayed_message_p
= 1;
11838 redisplay_internal (1);
11839 display_last_displayed_message_p
= 0;
11842 redisplay_internal (1);
11844 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
11845 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11846 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
11850 /* Function registered with record_unwind_protect in
11851 redisplay_internal. Reset redisplaying_p to the value it had
11852 before redisplay_internal was called, and clear
11853 prevent_freeing_realized_faces_p. It also selects the previously
11854 selected frame, unless it has been deleted (by an X connection
11855 failure during redisplay, for example). */
11858 unwind_redisplay (val
)
11861 Lisp_Object old_redisplaying_p
, old_frame
;
11863 old_redisplaying_p
= XCAR (val
);
11864 redisplaying_p
= XFASTINT (old_redisplaying_p
);
11865 old_frame
= XCDR (val
);
11866 if (! EQ (old_frame
, selected_frame
)
11867 && FRAME_LIVE_P (XFRAME (old_frame
)))
11868 select_frame_for_redisplay (old_frame
);
11873 /* Mark the display of window W as accurate or inaccurate. If
11874 ACCURATE_P is non-zero mark display of W as accurate. If
11875 ACCURATE_P is zero, arrange for W to be redisplayed the next time
11876 redisplay_internal is called. */
11879 mark_window_display_accurate_1 (w
, accurate_p
)
11883 if (BUFFERP (w
->buffer
))
11885 struct buffer
*b
= XBUFFER (w
->buffer
);
11888 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
11889 w
->last_overlay_modified
11890 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
11892 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
11896 b
->clip_changed
= 0;
11897 b
->prevent_redisplay_optimizations_p
= 0;
11899 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
11900 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
11901 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
11902 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
11904 w
->current_matrix
->buffer
= b
;
11905 w
->current_matrix
->begv
= BUF_BEGV (b
);
11906 w
->current_matrix
->zv
= BUF_ZV (b
);
11908 w
->last_cursor
= w
->cursor
;
11909 w
->last_cursor_off_p
= w
->cursor_off_p
;
11911 if (w
== XWINDOW (selected_window
))
11912 w
->last_point
= make_number (BUF_PT (b
));
11914 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
11920 w
->window_end_valid
= w
->buffer
;
11921 #if 0 /* This is incorrect with variable-height lines. */
11922 xassert (XINT (w
->window_end_vpos
)
11923 < (WINDOW_TOTAL_LINES (w
)
11924 - (WINDOW_WANTS_MODELINE_P (w
) ? 1 : 0)));
11926 w
->update_mode_line
= Qnil
;
11931 /* Mark the display of windows in the window tree rooted at WINDOW as
11932 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
11933 windows as accurate. If ACCURATE_P is zero, arrange for windows to
11934 be redisplayed the next time redisplay_internal is called. */
11937 mark_window_display_accurate (window
, accurate_p
)
11938 Lisp_Object window
;
11943 for (; !NILP (window
); window
= w
->next
)
11945 w
= XWINDOW (window
);
11946 mark_window_display_accurate_1 (w
, accurate_p
);
11948 if (!NILP (w
->vchild
))
11949 mark_window_display_accurate (w
->vchild
, accurate_p
);
11950 if (!NILP (w
->hchild
))
11951 mark_window_display_accurate (w
->hchild
, accurate_p
);
11956 update_overlay_arrows (1);
11960 /* Force a thorough redisplay the next time by setting
11961 last_arrow_position and last_arrow_string to t, which is
11962 unequal to any useful value of Voverlay_arrow_... */
11963 update_overlay_arrows (-1);
11968 /* Return value in display table DP (Lisp_Char_Table *) for character
11969 C. Since a display table doesn't have any parent, we don't have to
11970 follow parent. Do not call this function directly but use the
11971 macro DISP_CHAR_VECTOR. */
11974 disp_char_vector (dp
, c
)
11975 struct Lisp_Char_Table
*dp
;
11980 if (ASCII_CHAR_P (c
))
11983 if (SUB_CHAR_TABLE_P (val
))
11984 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
11990 XSETCHAR_TABLE (table
, dp
);
11991 val
= char_table_ref (table
, c
);
12000 /***********************************************************************
12002 ***********************************************************************/
12004 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12007 redisplay_windows (window
)
12008 Lisp_Object window
;
12010 while (!NILP (window
))
12012 struct window
*w
= XWINDOW (window
);
12014 if (!NILP (w
->hchild
))
12015 redisplay_windows (w
->hchild
);
12016 else if (!NILP (w
->vchild
))
12017 redisplay_windows (w
->vchild
);
12020 displayed_buffer
= XBUFFER (w
->buffer
);
12021 /* Use list_of_error, not Qerror, so that
12022 we catch only errors and don't run the debugger. */
12023 internal_condition_case_1 (redisplay_window_0
, window
,
12025 redisplay_window_error
);
12033 redisplay_window_error ()
12035 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12040 redisplay_window_0 (window
)
12041 Lisp_Object window
;
12043 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12044 redisplay_window (window
, 0);
12049 redisplay_window_1 (window
)
12050 Lisp_Object window
;
12052 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12053 redisplay_window (window
, 1);
12058 /* Increment GLYPH until it reaches END or CONDITION fails while
12059 adding (GLYPH)->pixel_width to X. */
12061 #define SKIP_GLYPHS(glyph, end, x, condition) \
12064 (x) += (glyph)->pixel_width; \
12067 while ((glyph) < (end) && (condition))
12070 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12071 DELTA is the number of bytes by which positions recorded in ROW
12072 differ from current buffer positions.
12074 Return 0 if cursor is not on this row. 1 otherwise. */
12077 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
12079 struct glyph_row
*row
;
12080 struct glyph_matrix
*matrix
;
12081 int delta
, delta_bytes
, dy
, dvpos
;
12083 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12084 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12085 struct glyph
*cursor
= NULL
;
12086 /* The first glyph that starts a sequence of glyphs from string. */
12087 struct glyph
*string_start
;
12088 /* The X coordinate of string_start. */
12089 int string_start_x
;
12090 /* The last known character position. */
12091 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12092 /* The last known character position before string_start. */
12093 int string_before_pos
;
12096 int cursor_from_overlay_pos
= 0;
12097 int pt_old
= PT
- delta
;
12099 /* Skip over glyphs not having an object at the start of the row.
12100 These are special glyphs like truncation marks on terminal
12102 if (row
->displays_text_p
)
12104 && INTEGERP (glyph
->object
)
12105 && glyph
->charpos
< 0)
12107 x
+= glyph
->pixel_width
;
12111 string_start
= NULL
;
12113 && !INTEGERP (glyph
->object
)
12114 && (!BUFFERP (glyph
->object
)
12115 || (last_pos
= glyph
->charpos
) < pt_old
))
12117 if (! STRINGP (glyph
->object
))
12119 string_start
= NULL
;
12120 x
+= glyph
->pixel_width
;
12122 if (cursor_from_overlay_pos
12123 && last_pos
>= cursor_from_overlay_pos
)
12125 cursor_from_overlay_pos
= 0;
12131 if (string_start
== NULL
)
12133 string_before_pos
= last_pos
;
12134 string_start
= glyph
;
12135 string_start_x
= x
;
12137 /* Skip all glyphs from string. */
12142 if ((cursor
== NULL
|| glyph
> cursor
)
12143 && (cprop
= Fget_char_property (make_number ((glyph
)->charpos
),
12144 Qcursor
, (glyph
)->object
),
12146 && (pos
= string_buffer_position (w
, glyph
->object
,
12147 string_before_pos
),
12148 (pos
== 0 /* From overlay */
12149 || pos
== pt_old
)))
12151 /* Estimate overlay buffer position from the buffer
12152 positions of the glyphs before and after the overlay.
12153 Add 1 to last_pos so that if point corresponds to the
12154 glyph right after the overlay, we still use a 'cursor'
12155 property found in that overlay. */
12156 cursor_from_overlay_pos
= (pos
? 0 : last_pos
12157 + (INTEGERP (cprop
) ? XINT (cprop
) : 0));
12161 x
+= glyph
->pixel_width
;
12164 while (glyph
< end
&& EQ (glyph
->object
, string_start
->object
));
12168 if (cursor
!= NULL
)
12173 else if (row
->ends_in_ellipsis_p
&& glyph
== end
)
12175 /* Scan back over the ellipsis glyphs, decrementing positions. */
12176 while (glyph
> row
->glyphs
[TEXT_AREA
]
12177 && (glyph
- 1)->charpos
== last_pos
)
12178 glyph
--, x
-= glyph
->pixel_width
;
12179 /* That loop always goes one position too far,
12180 including the glyph before the ellipsis.
12181 So scan forward over that one. */
12182 x
+= glyph
->pixel_width
;
12185 else if (string_start
12186 && (glyph
== end
|| !BUFFERP (glyph
->object
) || last_pos
> pt_old
))
12188 /* We may have skipped over point because the previous glyphs
12189 are from string. As there's no easy way to know the
12190 character position of the current glyph, find the correct
12191 glyph on point by scanning from string_start again. */
12193 Lisp_Object string
;
12194 struct glyph
*stop
= glyph
;
12197 limit
= make_number (pt_old
+ 1);
12198 glyph
= string_start
;
12199 x
= string_start_x
;
12200 string
= glyph
->object
;
12201 pos
= string_buffer_position (w
, string
, string_before_pos
);
12202 /* If STRING is from overlay, LAST_POS == 0. We skip such glyphs
12203 because we always put cursor after overlay strings. */
12204 while (pos
== 0 && glyph
< stop
)
12206 string
= glyph
->object
;
12207 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12209 pos
= string_buffer_position (w
, glyph
->object
, string_before_pos
);
12212 while (glyph
< stop
)
12214 pos
= XINT (Fnext_single_char_property_change
12215 (make_number (pos
), Qdisplay
, Qnil
, limit
));
12218 /* Skip glyphs from the same string. */
12219 string
= glyph
->object
;
12220 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12221 /* Skip glyphs from an overlay. */
12222 while (glyph
< stop
12223 && ! string_buffer_position (w
, glyph
->object
, pos
))
12225 string
= glyph
->object
;
12226 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12230 /* If we reached the end of the line, and end was from a string,
12231 cursor is not on this line. */
12232 if (glyph
== end
&& row
->continued_p
)
12236 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12238 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12239 w
->cursor
.y
= row
->y
+ dy
;
12241 if (w
== XWINDOW (selected_window
))
12243 if (!row
->continued_p
12244 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12247 this_line_buffer
= XBUFFER (w
->buffer
);
12249 CHARPOS (this_line_start_pos
)
12250 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12251 BYTEPOS (this_line_start_pos
)
12252 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12254 CHARPOS (this_line_end_pos
)
12255 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12256 BYTEPOS (this_line_end_pos
)
12257 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12259 this_line_y
= w
->cursor
.y
;
12260 this_line_pixel_height
= row
->height
;
12261 this_line_vpos
= w
->cursor
.vpos
;
12262 this_line_start_x
= row
->x
;
12265 CHARPOS (this_line_start_pos
) = 0;
12272 /* Run window scroll functions, if any, for WINDOW with new window
12273 start STARTP. Sets the window start of WINDOW to that position.
12275 We assume that the window's buffer is really current. */
12277 static INLINE
struct text_pos
12278 run_window_scroll_functions (window
, startp
)
12279 Lisp_Object window
;
12280 struct text_pos startp
;
12282 struct window
*w
= XWINDOW (window
);
12283 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12285 if (current_buffer
!= XBUFFER (w
->buffer
))
12288 if (!NILP (Vwindow_scroll_functions
))
12290 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12291 make_number (CHARPOS (startp
)));
12292 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12293 /* In case the hook functions switch buffers. */
12294 if (current_buffer
!= XBUFFER (w
->buffer
))
12295 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12302 /* Make sure the line containing the cursor is fully visible.
12303 A value of 1 means there is nothing to be done.
12304 (Either the line is fully visible, or it cannot be made so,
12305 or we cannot tell.)
12307 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12308 is higher than window.
12310 A value of 0 means the caller should do scrolling
12311 as if point had gone off the screen. */
12314 cursor_row_fully_visible_p (w
, force_p
, current_matrix_p
)
12317 int current_matrix_p
;
12319 struct glyph_matrix
*matrix
;
12320 struct glyph_row
*row
;
12323 if (!make_cursor_line_fully_visible_p
)
12326 /* It's not always possible to find the cursor, e.g, when a window
12327 is full of overlay strings. Don't do anything in that case. */
12328 if (w
->cursor
.vpos
< 0)
12331 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
12332 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
12334 /* If the cursor row is not partially visible, there's nothing to do. */
12335 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
12338 /* If the row the cursor is in is taller than the window's height,
12339 it's not clear what to do, so do nothing. */
12340 window_height
= window_box_height (w
);
12341 if (row
->height
>= window_height
)
12343 if (!force_p
|| MINI_WINDOW_P (w
)
12344 || w
->vscroll
|| w
->cursor
.vpos
== 0)
12350 /* This code used to try to scroll the window just enough to make
12351 the line visible. It returned 0 to say that the caller should
12352 allocate larger glyph matrices. */
12354 if (MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (w
, row
))
12356 int dy
= row
->height
- row
->visible_height
;
12359 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
12361 else /* MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P (w, row)) */
12363 int dy
= - (row
->height
- row
->visible_height
);
12366 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
12369 /* When we change the cursor y-position of the selected window,
12370 change this_line_y as well so that the display optimization for
12371 the cursor line of the selected window in redisplay_internal uses
12372 the correct y-position. */
12373 if (w
== XWINDOW (selected_window
))
12374 this_line_y
= w
->cursor
.y
;
12376 /* If vscrolling requires a larger glyph matrix, arrange for a fresh
12377 redisplay with larger matrices. */
12378 if (matrix
->nrows
< required_matrix_height (w
))
12380 fonts_changed_p
= 1;
12389 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
12390 non-zero means only WINDOW is redisplayed in redisplay_internal.
12391 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
12392 in redisplay_window to bring a partially visible line into view in
12393 the case that only the cursor has moved.
12395 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
12396 last screen line's vertical height extends past the end of the screen.
12400 1 if scrolling succeeded
12402 0 if scrolling didn't find point.
12404 -1 if new fonts have been loaded so that we must interrupt
12405 redisplay, adjust glyph matrices, and try again. */
12411 SCROLLING_NEED_LARGER_MATRICES
12415 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
12416 scroll_step
, temp_scroll_step
, last_line_misfit
)
12417 Lisp_Object window
;
12418 int just_this_one_p
;
12419 EMACS_INT scroll_conservatively
, scroll_step
;
12420 int temp_scroll_step
;
12421 int last_line_misfit
;
12423 struct window
*w
= XWINDOW (window
);
12424 struct frame
*f
= XFRAME (w
->frame
);
12425 struct text_pos scroll_margin_pos
;
12426 struct text_pos pos
;
12427 struct text_pos startp
;
12429 Lisp_Object window_end
;
12430 int this_scroll_margin
;
12434 int amount_to_scroll
= 0;
12435 Lisp_Object aggressive
;
12437 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
12440 debug_method_add (w
, "try_scrolling");
12443 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12445 /* Compute scroll margin height in pixels. We scroll when point is
12446 within this distance from the top or bottom of the window. */
12447 if (scroll_margin
> 0)
12449 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
12450 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
12453 this_scroll_margin
= 0;
12455 /* Force scroll_conservatively to have a reasonable value so it doesn't
12456 cause an overflow while computing how much to scroll. */
12457 if (scroll_conservatively
)
12458 scroll_conservatively
= min (scroll_conservatively
,
12459 MOST_POSITIVE_FIXNUM
/ FRAME_LINE_HEIGHT (f
));
12461 /* Compute how much we should try to scroll maximally to bring point
12463 if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
12464 scroll_max
= max (scroll_step
,
12465 max (scroll_conservatively
, temp_scroll_step
));
12466 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
12467 || NUMBERP (current_buffer
->scroll_up_aggressively
))
12468 /* We're trying to scroll because of aggressive scrolling
12469 but no scroll_step is set. Choose an arbitrary one. Maybe
12470 there should be a variable for this. */
12474 scroll_max
*= FRAME_LINE_HEIGHT (f
);
12476 /* Decide whether we have to scroll down. Start at the window end
12477 and move this_scroll_margin up to find the position of the scroll
12479 window_end
= Fwindow_end (window
, Qt
);
12483 CHARPOS (scroll_margin_pos
) = XINT (window_end
);
12484 BYTEPOS (scroll_margin_pos
) = CHAR_TO_BYTE (CHARPOS (scroll_margin_pos
));
12486 if (this_scroll_margin
|| extra_scroll_margin_lines
)
12488 start_display (&it
, w
, scroll_margin_pos
);
12489 if (this_scroll_margin
)
12490 move_it_vertically_backward (&it
, this_scroll_margin
);
12491 if (extra_scroll_margin_lines
)
12492 move_it_by_lines (&it
, - extra_scroll_margin_lines
, 0);
12493 scroll_margin_pos
= it
.current
.pos
;
12496 if (PT
>= CHARPOS (scroll_margin_pos
))
12500 /* Point is in the scroll margin at the bottom of the window, or
12501 below. Compute a new window start that makes point visible. */
12503 /* Compute the distance from the scroll margin to PT.
12504 Give up if the distance is greater than scroll_max. */
12505 start_display (&it
, w
, scroll_margin_pos
);
12507 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
12508 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
12510 /* To make point visible, we have to move the window start
12511 down so that the line the cursor is in is visible, which
12512 means we have to add in the height of the cursor line. */
12513 dy
= line_bottom_y (&it
) - y0
;
12515 if (dy
> scroll_max
)
12516 return SCROLLING_FAILED
;
12518 /* Move the window start down. If scrolling conservatively,
12519 move it just enough down to make point visible. If
12520 scroll_step is set, move it down by scroll_step. */
12521 start_display (&it
, w
, startp
);
12523 if (scroll_conservatively
)
12524 /* Set AMOUNT_TO_SCROLL to at least one line,
12525 and at most scroll_conservatively lines. */
12527 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
12528 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
12529 else if (scroll_step
|| temp_scroll_step
)
12530 amount_to_scroll
= scroll_max
;
12533 aggressive
= current_buffer
->scroll_up_aggressively
;
12534 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12535 if (NUMBERP (aggressive
))
12537 double float_amount
= XFLOATINT (aggressive
) * height
;
12538 amount_to_scroll
= float_amount
;
12539 if (amount_to_scroll
== 0 && float_amount
> 0)
12540 amount_to_scroll
= 1;
12544 if (amount_to_scroll
<= 0)
12545 return SCROLLING_FAILED
;
12547 /* If moving by amount_to_scroll leaves STARTP unchanged,
12548 move it down one screen line. */
12550 move_it_vertically (&it
, amount_to_scroll
);
12551 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
12552 move_it_by_lines (&it
, 1, 1);
12553 startp
= it
.current
.pos
;
12557 /* See if point is inside the scroll margin at the top of the
12559 scroll_margin_pos
= startp
;
12560 if (this_scroll_margin
)
12562 start_display (&it
, w
, startp
);
12563 move_it_vertically (&it
, this_scroll_margin
);
12564 scroll_margin_pos
= it
.current
.pos
;
12567 if (PT
< CHARPOS (scroll_margin_pos
))
12569 /* Point is in the scroll margin at the top of the window or
12570 above what is displayed in the window. */
12573 /* Compute the vertical distance from PT to the scroll
12574 margin position. Give up if distance is greater than
12576 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
12577 start_display (&it
, w
, pos
);
12579 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
12580 it
.last_visible_y
, -1,
12581 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
12582 dy
= it
.current_y
- y0
;
12583 if (dy
> scroll_max
)
12584 return SCROLLING_FAILED
;
12586 /* Compute new window start. */
12587 start_display (&it
, w
, startp
);
12589 if (scroll_conservatively
)
12591 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
12592 else if (scroll_step
|| temp_scroll_step
)
12593 amount_to_scroll
= scroll_max
;
12596 aggressive
= current_buffer
->scroll_down_aggressively
;
12597 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12598 if (NUMBERP (aggressive
))
12600 double float_amount
= XFLOATINT (aggressive
) * height
;
12601 amount_to_scroll
= float_amount
;
12602 if (amount_to_scroll
== 0 && float_amount
> 0)
12603 amount_to_scroll
= 1;
12607 if (amount_to_scroll
<= 0)
12608 return SCROLLING_FAILED
;
12610 move_it_vertically_backward (&it
, amount_to_scroll
);
12611 startp
= it
.current
.pos
;
12615 /* Run window scroll functions. */
12616 startp
= run_window_scroll_functions (window
, startp
);
12618 /* Display the window. Give up if new fonts are loaded, or if point
12620 if (!try_window (window
, startp
, 0))
12621 rc
= SCROLLING_NEED_LARGER_MATRICES
;
12622 else if (w
->cursor
.vpos
< 0)
12624 clear_glyph_matrix (w
->desired_matrix
);
12625 rc
= SCROLLING_FAILED
;
12629 /* Maybe forget recorded base line for line number display. */
12630 if (!just_this_one_p
12631 || current_buffer
->clip_changed
12632 || BEG_UNCHANGED
< CHARPOS (startp
))
12633 w
->base_line_number
= Qnil
;
12635 /* If cursor ends up on a partially visible line,
12636 treat that as being off the bottom of the screen. */
12637 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
12639 clear_glyph_matrix (w
->desired_matrix
);
12640 ++extra_scroll_margin_lines
;
12643 rc
= SCROLLING_SUCCESS
;
12650 /* Compute a suitable window start for window W if display of W starts
12651 on a continuation line. Value is non-zero if a new window start
12654 The new window start will be computed, based on W's width, starting
12655 from the start of the continued line. It is the start of the
12656 screen line with the minimum distance from the old start W->start. */
12659 compute_window_start_on_continuation_line (w
)
12662 struct text_pos pos
, start_pos
;
12663 int window_start_changed_p
= 0;
12665 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
12667 /* If window start is on a continuation line... Window start may be
12668 < BEGV in case there's invisible text at the start of the
12669 buffer (M-x rmail, for example). */
12670 if (CHARPOS (start_pos
) > BEGV
12671 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
12674 struct glyph_row
*row
;
12676 /* Handle the case that the window start is out of range. */
12677 if (CHARPOS (start_pos
) < BEGV
)
12678 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
12679 else if (CHARPOS (start_pos
) > ZV
)
12680 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
12682 /* Find the start of the continued line. This should be fast
12683 because scan_buffer is fast (newline cache). */
12684 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
12685 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
12686 row
, DEFAULT_FACE_ID
);
12687 reseat_at_previous_visible_line_start (&it
);
12689 /* If the line start is "too far" away from the window start,
12690 say it takes too much time to compute a new window start. */
12691 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
12692 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
12694 int min_distance
, distance
;
12696 /* Move forward by display lines to find the new window
12697 start. If window width was enlarged, the new start can
12698 be expected to be > the old start. If window width was
12699 decreased, the new window start will be < the old start.
12700 So, we're looking for the display line start with the
12701 minimum distance from the old window start. */
12702 pos
= it
.current
.pos
;
12703 min_distance
= INFINITY
;
12704 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
12705 distance
< min_distance
)
12707 min_distance
= distance
;
12708 pos
= it
.current
.pos
;
12709 move_it_by_lines (&it
, 1, 0);
12712 /* Set the window start there. */
12713 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
12714 window_start_changed_p
= 1;
12718 return window_start_changed_p
;
12722 /* Try cursor movement in case text has not changed in window WINDOW,
12723 with window start STARTP. Value is
12725 CURSOR_MOVEMENT_SUCCESS if successful
12727 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
12729 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
12730 display. *SCROLL_STEP is set to 1, under certain circumstances, if
12731 we want to scroll as if scroll-step were set to 1. See the code.
12733 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
12734 which case we have to abort this redisplay, and adjust matrices
12739 CURSOR_MOVEMENT_SUCCESS
,
12740 CURSOR_MOVEMENT_CANNOT_BE_USED
,
12741 CURSOR_MOVEMENT_MUST_SCROLL
,
12742 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
12746 try_cursor_movement (window
, startp
, scroll_step
)
12747 Lisp_Object window
;
12748 struct text_pos startp
;
12751 struct window
*w
= XWINDOW (window
);
12752 struct frame
*f
= XFRAME (w
->frame
);
12753 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
12756 if (inhibit_try_cursor_movement
)
12760 /* Handle case where text has not changed, only point, and it has
12761 not moved off the frame. */
12762 if (/* Point may be in this window. */
12763 PT
>= CHARPOS (startp
)
12764 /* Selective display hasn't changed. */
12765 && !current_buffer
->clip_changed
12766 /* Function force-mode-line-update is used to force a thorough
12767 redisplay. It sets either windows_or_buffers_changed or
12768 update_mode_lines. So don't take a shortcut here for these
12770 && !update_mode_lines
12771 && !windows_or_buffers_changed
12772 && !cursor_type_changed
12773 /* Can't use this case if highlighting a region. When a
12774 region exists, cursor movement has to do more than just
12776 && !(!NILP (Vtransient_mark_mode
)
12777 && !NILP (current_buffer
->mark_active
))
12778 && NILP (w
->region_showing
)
12779 && NILP (Vshow_trailing_whitespace
)
12780 /* Right after splitting windows, last_point may be nil. */
12781 && INTEGERP (w
->last_point
)
12782 /* This code is not used for mini-buffer for the sake of the case
12783 of redisplaying to replace an echo area message; since in
12784 that case the mini-buffer contents per se are usually
12785 unchanged. This code is of no real use in the mini-buffer
12786 since the handling of this_line_start_pos, etc., in redisplay
12787 handles the same cases. */
12788 && !EQ (window
, minibuf_window
)
12789 /* When splitting windows or for new windows, it happens that
12790 redisplay is called with a nil window_end_vpos or one being
12791 larger than the window. This should really be fixed in
12792 window.c. I don't have this on my list, now, so we do
12793 approximately the same as the old redisplay code. --gerd. */
12794 && INTEGERP (w
->window_end_vpos
)
12795 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
12796 && (FRAME_WINDOW_P (f
)
12797 || !overlay_arrow_in_current_buffer_p ()))
12799 int this_scroll_margin
, top_scroll_margin
;
12800 struct glyph_row
*row
= NULL
;
12803 debug_method_add (w
, "cursor movement");
12806 /* Scroll if point within this distance from the top or bottom
12807 of the window. This is a pixel value. */
12808 this_scroll_margin
= max (0, scroll_margin
);
12809 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
12810 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
12812 top_scroll_margin
= this_scroll_margin
;
12813 if (WINDOW_WANTS_HEADER_LINE_P (w
))
12814 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
12816 /* Start with the row the cursor was displayed during the last
12817 not paused redisplay. Give up if that row is not valid. */
12818 if (w
->last_cursor
.vpos
< 0
12819 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
12820 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12823 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
12824 if (row
->mode_line_p
)
12826 if (!row
->enabled_p
)
12827 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12830 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
12833 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
12835 if (PT
> XFASTINT (w
->last_point
))
12837 /* Point has moved forward. */
12838 while (MATRIX_ROW_END_CHARPOS (row
) < PT
12839 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
12841 xassert (row
->enabled_p
);
12845 /* The end position of a row equals the start position
12846 of the next row. If PT is there, we would rather
12847 display it in the next line. */
12848 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
12849 && MATRIX_ROW_END_CHARPOS (row
) == PT
12850 && !cursor_row_p (w
, row
))
12853 /* If within the scroll margin, scroll. Note that
12854 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
12855 the next line would be drawn, and that
12856 this_scroll_margin can be zero. */
12857 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
12858 || PT
> MATRIX_ROW_END_CHARPOS (row
)
12859 /* Line is completely visible last line in window
12860 and PT is to be set in the next line. */
12861 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
12862 && PT
== MATRIX_ROW_END_CHARPOS (row
)
12863 && !row
->ends_at_zv_p
12864 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
12867 else if (PT
< XFASTINT (w
->last_point
))
12869 /* Cursor has to be moved backward. Note that PT >=
12870 CHARPOS (startp) because of the outer if-statement. */
12871 while (!row
->mode_line_p
12872 && (MATRIX_ROW_START_CHARPOS (row
) > PT
12873 || (MATRIX_ROW_START_CHARPOS (row
) == PT
12874 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
12875 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
12876 row
> w
->current_matrix
->rows
12877 && (row
-1)->ends_in_newline_from_string_p
))))
12878 && (row
->y
> top_scroll_margin
12879 || CHARPOS (startp
) == BEGV
))
12881 xassert (row
->enabled_p
);
12885 /* Consider the following case: Window starts at BEGV,
12886 there is invisible, intangible text at BEGV, so that
12887 display starts at some point START > BEGV. It can
12888 happen that we are called with PT somewhere between
12889 BEGV and START. Try to handle that case. */
12890 if (row
< w
->current_matrix
->rows
12891 || row
->mode_line_p
)
12893 row
= w
->current_matrix
->rows
;
12894 if (row
->mode_line_p
)
12898 /* Due to newlines in overlay strings, we may have to
12899 skip forward over overlay strings. */
12900 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
12901 && MATRIX_ROW_END_CHARPOS (row
) == PT
12902 && !cursor_row_p (w
, row
))
12905 /* If within the scroll margin, scroll. */
12906 if (row
->y
< top_scroll_margin
12907 && CHARPOS (startp
) != BEGV
)
12912 /* Cursor did not move. So don't scroll even if cursor line
12913 is partially visible, as it was so before. */
12914 rc
= CURSOR_MOVEMENT_SUCCESS
;
12917 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
12918 || PT
> MATRIX_ROW_END_CHARPOS (row
))
12920 /* if PT is not in the glyph row, give up. */
12921 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12923 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
12924 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
12925 && make_cursor_line_fully_visible_p
)
12927 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
12928 && !row
->ends_at_zv_p
12929 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
12930 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12931 else if (row
->height
> window_box_height (w
))
12933 /* If we end up in a partially visible line, let's
12934 make it fully visible, except when it's taller
12935 than the window, in which case we can't do much
12938 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12942 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
12943 if (!cursor_row_fully_visible_p (w
, 0, 1))
12944 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12946 rc
= CURSOR_MOVEMENT_SUCCESS
;
12950 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12955 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
12957 rc
= CURSOR_MOVEMENT_SUCCESS
;
12962 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
12963 && MATRIX_ROW_START_CHARPOS (row
) == PT
12964 && cursor_row_p (w
, row
));
12973 set_vertical_scroll_bar (w
)
12976 int start
, end
, whole
;
12978 /* Calculate the start and end positions for the current window.
12979 At some point, it would be nice to choose between scrollbars
12980 which reflect the whole buffer size, with special markers
12981 indicating narrowing, and scrollbars which reflect only the
12984 Note that mini-buffers sometimes aren't displaying any text. */
12985 if (!MINI_WINDOW_P (w
)
12986 || (w
== XWINDOW (minibuf_window
)
12987 && NILP (echo_area_buffer
[0])))
12989 struct buffer
*buf
= XBUFFER (w
->buffer
);
12990 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
12991 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
12992 /* I don't think this is guaranteed to be right. For the
12993 moment, we'll pretend it is. */
12994 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
12998 if (whole
< (end
- start
))
12999 whole
= end
- start
;
13002 start
= end
= whole
= 0;
13004 /* Indicate what this scroll bar ought to be displaying now. */
13005 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13006 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13007 (w
, end
- start
, whole
, start
);
13011 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13012 selected_window is redisplayed.
13014 We can return without actually redisplaying the window if
13015 fonts_changed_p is nonzero. In that case, redisplay_internal will
13019 redisplay_window (window
, just_this_one_p
)
13020 Lisp_Object window
;
13021 int just_this_one_p
;
13023 struct window
*w
= XWINDOW (window
);
13024 struct frame
*f
= XFRAME (w
->frame
);
13025 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13026 struct buffer
*old
= current_buffer
;
13027 struct text_pos lpoint
, opoint
, startp
;
13028 int update_mode_line
;
13031 /* Record it now because it's overwritten. */
13032 int current_matrix_up_to_date_p
= 0;
13033 int used_current_matrix_p
= 0;
13034 /* This is less strict than current_matrix_up_to_date_p.
13035 It indictes that the buffer contents and narrowing are unchanged. */
13036 int buffer_unchanged_p
= 0;
13037 int temp_scroll_step
= 0;
13038 int count
= SPECPDL_INDEX ();
13040 int centering_position
= -1;
13041 int last_line_misfit
= 0;
13042 int beg_unchanged
, end_unchanged
;
13044 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13047 /* W must be a leaf window here. */
13048 xassert (!NILP (w
->buffer
));
13050 *w
->desired_matrix
->method
= 0;
13054 reconsider_clip_changes (w
, buffer
);
13056 /* Has the mode line to be updated? */
13057 update_mode_line
= (!NILP (w
->update_mode_line
)
13058 || update_mode_lines
13059 || buffer
->clip_changed
13060 || buffer
->prevent_redisplay_optimizations_p
);
13062 if (MINI_WINDOW_P (w
))
13064 if (w
== XWINDOW (echo_area_window
)
13065 && !NILP (echo_area_buffer
[0]))
13067 if (update_mode_line
)
13068 /* We may have to update a tty frame's menu bar or a
13069 tool-bar. Example `M-x C-h C-h C-g'. */
13070 goto finish_menu_bars
;
13072 /* We've already displayed the echo area glyphs in this window. */
13073 goto finish_scroll_bars
;
13075 else if ((w
!= XWINDOW (minibuf_window
)
13076 || minibuf_level
== 0)
13077 /* When buffer is nonempty, redisplay window normally. */
13078 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13079 /* Quail displays non-mini buffers in minibuffer window.
13080 In that case, redisplay the window normally. */
13081 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13083 /* W is a mini-buffer window, but it's not active, so clear
13085 int yb
= window_text_bottom_y (w
);
13086 struct glyph_row
*row
;
13089 for (y
= 0, row
= w
->desired_matrix
->rows
;
13091 y
+= row
->height
, ++row
)
13092 blank_row (w
, row
, y
);
13093 goto finish_scroll_bars
;
13096 clear_glyph_matrix (w
->desired_matrix
);
13099 /* Otherwise set up data on this window; select its buffer and point
13101 /* Really select the buffer, for the sake of buffer-local
13103 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13105 current_matrix_up_to_date_p
13106 = (!NILP (w
->window_end_valid
)
13107 && !current_buffer
->clip_changed
13108 && !current_buffer
->prevent_redisplay_optimizations_p
13109 && XFASTINT (w
->last_modified
) >= MODIFF
13110 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13112 /* Run the window-bottom-change-functions
13113 if it is possible that the text on the screen has changed
13114 (either due to modification of the text, or any other reason). */
13115 if (!current_matrix_up_to_date_p
13116 && !NILP (Vwindow_text_change_functions
))
13118 safe_run_hooks (Qwindow_text_change_functions
);
13122 beg_unchanged
= BEG_UNCHANGED
;
13123 end_unchanged
= END_UNCHANGED
;
13125 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13127 specbind (Qinhibit_point_motion_hooks
, Qt
);
13130 = (!NILP (w
->window_end_valid
)
13131 && !current_buffer
->clip_changed
13132 && XFASTINT (w
->last_modified
) >= MODIFF
13133 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13135 /* When windows_or_buffers_changed is non-zero, we can't rely on
13136 the window end being valid, so set it to nil there. */
13137 if (windows_or_buffers_changed
)
13139 /* If window starts on a continuation line, maybe adjust the
13140 window start in case the window's width changed. */
13141 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13142 compute_window_start_on_continuation_line (w
);
13144 w
->window_end_valid
= Qnil
;
13147 /* Some sanity checks. */
13148 CHECK_WINDOW_END (w
);
13149 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13151 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13154 /* If %c is in mode line, update it if needed. */
13155 if (!NILP (w
->column_number_displayed
)
13156 /* This alternative quickly identifies a common case
13157 where no change is needed. */
13158 && !(PT
== XFASTINT (w
->last_point
)
13159 && XFASTINT (w
->last_modified
) >= MODIFF
13160 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13161 && (XFASTINT (w
->column_number_displayed
)
13162 != (int) current_column ())) /* iftc */
13163 update_mode_line
= 1;
13165 /* Count number of windows showing the selected buffer. An indirect
13166 buffer counts as its base buffer. */
13167 if (!just_this_one_p
)
13169 struct buffer
*current_base
, *window_base
;
13170 current_base
= current_buffer
;
13171 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13172 if (current_base
->base_buffer
)
13173 current_base
= current_base
->base_buffer
;
13174 if (window_base
->base_buffer
)
13175 window_base
= window_base
->base_buffer
;
13176 if (current_base
== window_base
)
13180 /* Point refers normally to the selected window. For any other
13181 window, set up appropriate value. */
13182 if (!EQ (window
, selected_window
))
13184 int new_pt
= XMARKER (w
->pointm
)->charpos
;
13185 int new_pt_byte
= marker_byte_position (w
->pointm
);
13189 new_pt_byte
= BEGV_BYTE
;
13190 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13192 else if (new_pt
> (ZV
- 1))
13195 new_pt_byte
= ZV_BYTE
;
13196 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13199 /* We don't use SET_PT so that the point-motion hooks don't run. */
13200 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13203 /* If any of the character widths specified in the display table
13204 have changed, invalidate the width run cache. It's true that
13205 this may be a bit late to catch such changes, but the rest of
13206 redisplay goes (non-fatally) haywire when the display table is
13207 changed, so why should we worry about doing any better? */
13208 if (current_buffer
->width_run_cache
)
13210 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13212 if (! disptab_matches_widthtab (disptab
,
13213 XVECTOR (current_buffer
->width_table
)))
13215 invalidate_region_cache (current_buffer
,
13216 current_buffer
->width_run_cache
,
13218 recompute_width_table (current_buffer
, disptab
);
13222 /* If window-start is screwed up, choose a new one. */
13223 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13226 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13228 /* If someone specified a new starting point but did not insist,
13229 check whether it can be used. */
13230 if (!NILP (w
->optional_new_start
)
13231 && CHARPOS (startp
) >= BEGV
13232 && CHARPOS (startp
) <= ZV
)
13234 w
->optional_new_start
= Qnil
;
13235 start_display (&it
, w
, startp
);
13236 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13237 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13238 if (IT_CHARPOS (it
) == PT
)
13239 w
->force_start
= Qt
;
13240 /* IT may overshoot PT if text at PT is invisible. */
13241 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13242 w
->force_start
= Qt
;
13247 /* Handle case where place to start displaying has been specified,
13248 unless the specified location is outside the accessible range. */
13249 if (!NILP (w
->force_start
)
13250 || w
->frozen_window_start_p
)
13252 /* We set this later on if we have to adjust point. */
13256 w
->force_start
= Qnil
;
13258 w
->window_end_valid
= Qnil
;
13260 /* Forget any recorded base line for line number display. */
13261 if (!buffer_unchanged_p
)
13262 w
->base_line_number
= Qnil
;
13264 /* Redisplay the mode line. Select the buffer properly for that.
13265 Also, run the hook window-scroll-functions
13266 because we have scrolled. */
13267 /* Note, we do this after clearing force_start because
13268 if there's an error, it is better to forget about force_start
13269 than to get into an infinite loop calling the hook functions
13270 and having them get more errors. */
13271 if (!update_mode_line
13272 || ! NILP (Vwindow_scroll_functions
))
13274 update_mode_line
= 1;
13275 w
->update_mode_line
= Qt
;
13276 startp
= run_window_scroll_functions (window
, startp
);
13279 w
->last_modified
= make_number (0);
13280 w
->last_overlay_modified
= make_number (0);
13281 if (CHARPOS (startp
) < BEGV
)
13282 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13283 else if (CHARPOS (startp
) > ZV
)
13284 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
13286 /* Redisplay, then check if cursor has been set during the
13287 redisplay. Give up if new fonts were loaded. */
13288 val
= try_window (window
, startp
, 1);
13291 w
->force_start
= Qt
;
13292 clear_glyph_matrix (w
->desired_matrix
);
13293 goto need_larger_matrices
;
13295 /* Point was outside the scroll margins. */
13297 new_vpos
= window_box_height (w
) / 2;
13299 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
13301 /* If point does not appear, try to move point so it does
13302 appear. The desired matrix has been built above, so we
13303 can use it here. */
13304 new_vpos
= window_box_height (w
) / 2;
13307 if (!cursor_row_fully_visible_p (w
, 0, 0))
13309 /* Point does appear, but on a line partly visible at end of window.
13310 Move it back to a fully-visible line. */
13311 new_vpos
= window_box_height (w
);
13314 /* If we need to move point for either of the above reasons,
13315 now actually do it. */
13318 struct glyph_row
*row
;
13320 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
13321 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
13324 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
13325 MATRIX_ROW_START_BYTEPOS (row
));
13327 if (w
!= XWINDOW (selected_window
))
13328 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
13329 else if (current_buffer
== old
)
13330 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13332 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
13334 /* If we are highlighting the region, then we just changed
13335 the region, so redisplay to show it. */
13336 if (!NILP (Vtransient_mark_mode
)
13337 && !NILP (current_buffer
->mark_active
))
13339 clear_glyph_matrix (w
->desired_matrix
);
13340 if (!try_window (window
, startp
, 0))
13341 goto need_larger_matrices
;
13346 debug_method_add (w
, "forced window start");
13351 /* Handle case where text has not changed, only point, and it has
13352 not moved off the frame, and we are not retrying after hscroll.
13353 (current_matrix_up_to_date_p is nonzero when retrying.) */
13354 if (current_matrix_up_to_date_p
13355 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
13356 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
13360 case CURSOR_MOVEMENT_SUCCESS
:
13361 used_current_matrix_p
= 1;
13364 #if 0 /* try_cursor_movement never returns this value. */
13365 case CURSOR_MOVEMENT_NEED_LARGER_MATRICES
:
13366 goto need_larger_matrices
;
13369 case CURSOR_MOVEMENT_MUST_SCROLL
:
13370 goto try_to_scroll
;
13376 /* If current starting point was originally the beginning of a line
13377 but no longer is, find a new starting point. */
13378 else if (!NILP (w
->start_at_line_beg
)
13379 && !(CHARPOS (startp
) <= BEGV
13380 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
13383 debug_method_add (w
, "recenter 1");
13388 /* Try scrolling with try_window_id. Value is > 0 if update has
13389 been done, it is -1 if we know that the same window start will
13390 not work. It is 0 if unsuccessful for some other reason. */
13391 else if ((tem
= try_window_id (w
)) != 0)
13394 debug_method_add (w
, "try_window_id %d", tem
);
13397 if (fonts_changed_p
)
13398 goto need_larger_matrices
;
13402 /* Otherwise try_window_id has returned -1 which means that we
13403 don't want the alternative below this comment to execute. */
13405 else if (CHARPOS (startp
) >= BEGV
13406 && CHARPOS (startp
) <= ZV
13407 && PT
>= CHARPOS (startp
)
13408 && (CHARPOS (startp
) < ZV
13409 /* Avoid starting at end of buffer. */
13410 || CHARPOS (startp
) == BEGV
13411 || (XFASTINT (w
->last_modified
) >= MODIFF
13412 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
13415 /* If first window line is a continuation line, and window start
13416 is inside the modified region, but the first change is before
13417 current window start, we must select a new window start.
13419 However, if this is the result of a down-mouse event (e.g. by
13420 extending the mouse-drag-overlay), we don't want to select a
13421 new window start, since that would change the position under
13422 the mouse, resulting in an unwanted mouse-movement rather
13423 than a simple mouse-click. */
13424 if (NILP (w
->start_at_line_beg
)
13425 && NILP (do_mouse_tracking
)
13426 && CHARPOS (startp
) > BEGV
13427 && CHARPOS (startp
) > BEG
+ beg_unchanged
13428 && CHARPOS (startp
) <= Z
- end_unchanged
)
13430 w
->force_start
= Qt
;
13431 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13432 compute_window_start_on_continuation_line (w
);
13433 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13438 debug_method_add (w
, "same window start");
13441 /* Try to redisplay starting at same place as before.
13442 If point has not moved off frame, accept the results. */
13443 if (!current_matrix_up_to_date_p
13444 /* Don't use try_window_reusing_current_matrix in this case
13445 because a window scroll function can have changed the
13447 || !NILP (Vwindow_scroll_functions
)
13448 || MINI_WINDOW_P (w
)
13449 || !(used_current_matrix_p
13450 = try_window_reusing_current_matrix (w
)))
13452 IF_DEBUG (debug_method_add (w
, "1"));
13453 if (try_window (window
, startp
, 1) < 0)
13454 /* -1 means we need to scroll.
13455 0 means we need new matrices, but fonts_changed_p
13456 is set in that case, so we will detect it below. */
13457 goto try_to_scroll
;
13460 if (fonts_changed_p
)
13461 goto need_larger_matrices
;
13463 if (w
->cursor
.vpos
>= 0)
13465 if (!just_this_one_p
13466 || current_buffer
->clip_changed
13467 || BEG_UNCHANGED
< CHARPOS (startp
))
13468 /* Forget any recorded base line for line number display. */
13469 w
->base_line_number
= Qnil
;
13471 if (!cursor_row_fully_visible_p (w
, 1, 0))
13473 clear_glyph_matrix (w
->desired_matrix
);
13474 last_line_misfit
= 1;
13476 /* Drop through and scroll. */
13481 clear_glyph_matrix (w
->desired_matrix
);
13486 w
->last_modified
= make_number (0);
13487 w
->last_overlay_modified
= make_number (0);
13489 /* Redisplay the mode line. Select the buffer properly for that. */
13490 if (!update_mode_line
)
13492 update_mode_line
= 1;
13493 w
->update_mode_line
= Qt
;
13496 /* Try to scroll by specified few lines. */
13497 if ((scroll_conservatively
13499 || temp_scroll_step
13500 || NUMBERP (current_buffer
->scroll_up_aggressively
)
13501 || NUMBERP (current_buffer
->scroll_down_aggressively
))
13502 && !current_buffer
->clip_changed
13503 && CHARPOS (startp
) >= BEGV
13504 && CHARPOS (startp
) <= ZV
)
13506 /* The function returns -1 if new fonts were loaded, 1 if
13507 successful, 0 if not successful. */
13508 int rc
= try_scrolling (window
, just_this_one_p
,
13509 scroll_conservatively
,
13511 temp_scroll_step
, last_line_misfit
);
13514 case SCROLLING_SUCCESS
:
13517 case SCROLLING_NEED_LARGER_MATRICES
:
13518 goto need_larger_matrices
;
13520 case SCROLLING_FAILED
:
13528 /* Finally, just choose place to start which centers point */
13531 if (centering_position
< 0)
13532 centering_position
= window_box_height (w
) / 2;
13535 debug_method_add (w
, "recenter");
13538 /* w->vscroll = 0; */
13540 /* Forget any previously recorded base line for line number display. */
13541 if (!buffer_unchanged_p
)
13542 w
->base_line_number
= Qnil
;
13544 /* Move backward half the height of the window. */
13545 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13546 it
.current_y
= it
.last_visible_y
;
13547 move_it_vertically_backward (&it
, centering_position
);
13548 xassert (IT_CHARPOS (it
) >= BEGV
);
13550 /* The function move_it_vertically_backward may move over more
13551 than the specified y-distance. If it->w is small, e.g. a
13552 mini-buffer window, we may end up in front of the window's
13553 display area. Start displaying at the start of the line
13554 containing PT in this case. */
13555 if (it
.current_y
<= 0)
13557 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13558 move_it_vertically_backward (&it
, 0);
13560 /* I think this assert is bogus if buffer contains
13561 invisible text or images. KFS. */
13562 xassert (IT_CHARPOS (it
) <= PT
);
13567 it
.current_x
= it
.hpos
= 0;
13569 /* Set startp here explicitly in case that helps avoid an infinite loop
13570 in case the window-scroll-functions functions get errors. */
13571 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
13573 /* Run scroll hooks. */
13574 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
13576 /* Redisplay the window. */
13577 if (!current_matrix_up_to_date_p
13578 || windows_or_buffers_changed
13579 || cursor_type_changed
13580 /* Don't use try_window_reusing_current_matrix in this case
13581 because it can have changed the buffer. */
13582 || !NILP (Vwindow_scroll_functions
)
13583 || !just_this_one_p
13584 || MINI_WINDOW_P (w
)
13585 || !(used_current_matrix_p
13586 = try_window_reusing_current_matrix (w
)))
13587 try_window (window
, startp
, 0);
13589 /* If new fonts have been loaded (due to fontsets), give up. We
13590 have to start a new redisplay since we need to re-adjust glyph
13592 if (fonts_changed_p
)
13593 goto need_larger_matrices
;
13595 /* If cursor did not appear assume that the middle of the window is
13596 in the first line of the window. Do it again with the next line.
13597 (Imagine a window of height 100, displaying two lines of height
13598 60. Moving back 50 from it->last_visible_y will end in the first
13600 if (w
->cursor
.vpos
< 0)
13602 if (!NILP (w
->window_end_valid
)
13603 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
13605 clear_glyph_matrix (w
->desired_matrix
);
13606 move_it_by_lines (&it
, 1, 0);
13607 try_window (window
, it
.current
.pos
, 0);
13609 else if (PT
< IT_CHARPOS (it
))
13611 clear_glyph_matrix (w
->desired_matrix
);
13612 move_it_by_lines (&it
, -1, 0);
13613 try_window (window
, it
.current
.pos
, 0);
13617 /* Not much we can do about it. */
13621 /* Consider the following case: Window starts at BEGV, there is
13622 invisible, intangible text at BEGV, so that display starts at
13623 some point START > BEGV. It can happen that we are called with
13624 PT somewhere between BEGV and START. Try to handle that case. */
13625 if (w
->cursor
.vpos
< 0)
13627 struct glyph_row
*row
= w
->current_matrix
->rows
;
13628 if (row
->mode_line_p
)
13630 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13633 if (!cursor_row_fully_visible_p (w
, 0, 0))
13635 /* If vscroll is enabled, disable it and try again. */
13639 clear_glyph_matrix (w
->desired_matrix
);
13643 /* If centering point failed to make the whole line visible,
13644 put point at the top instead. That has to make the whole line
13645 visible, if it can be done. */
13646 if (centering_position
== 0)
13649 clear_glyph_matrix (w
->desired_matrix
);
13650 centering_position
= 0;
13656 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13657 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
13658 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
13661 /* Display the mode line, if we must. */
13662 if ((update_mode_line
13663 /* If window not full width, must redo its mode line
13664 if (a) the window to its side is being redone and
13665 (b) we do a frame-based redisplay. This is a consequence
13666 of how inverted lines are drawn in frame-based redisplay. */
13667 || (!just_this_one_p
13668 && !FRAME_WINDOW_P (f
)
13669 && !WINDOW_FULL_WIDTH_P (w
))
13670 /* Line number to display. */
13671 || INTEGERP (w
->base_line_pos
)
13672 /* Column number is displayed and different from the one displayed. */
13673 || (!NILP (w
->column_number_displayed
)
13674 && (XFASTINT (w
->column_number_displayed
)
13675 != (int) current_column ()))) /* iftc */
13676 /* This means that the window has a mode line. */
13677 && (WINDOW_WANTS_MODELINE_P (w
)
13678 || WINDOW_WANTS_HEADER_LINE_P (w
)))
13680 display_mode_lines (w
);
13682 /* If mode line height has changed, arrange for a thorough
13683 immediate redisplay using the correct mode line height. */
13684 if (WINDOW_WANTS_MODELINE_P (w
)
13685 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
13687 fonts_changed_p
= 1;
13688 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
13689 = DESIRED_MODE_LINE_HEIGHT (w
);
13692 /* If top line height has changed, arrange for a thorough
13693 immediate redisplay using the correct mode line height. */
13694 if (WINDOW_WANTS_HEADER_LINE_P (w
)
13695 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
13697 fonts_changed_p
= 1;
13698 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
13699 = DESIRED_HEADER_LINE_HEIGHT (w
);
13702 if (fonts_changed_p
)
13703 goto need_larger_matrices
;
13706 if (!line_number_displayed
13707 && !BUFFERP (w
->base_line_pos
))
13709 w
->base_line_pos
= Qnil
;
13710 w
->base_line_number
= Qnil
;
13715 /* When we reach a frame's selected window, redo the frame's menu bar. */
13716 if (update_mode_line
13717 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
13719 int redisplay_menu_p
= 0;
13720 int redisplay_tool_bar_p
= 0;
13722 if (FRAME_WINDOW_P (f
))
13724 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
13725 || defined (USE_GTK)
13726 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
13728 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13732 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13734 if (redisplay_menu_p
)
13735 display_menu_bar (w
);
13737 #ifdef HAVE_WINDOW_SYSTEM
13738 if (FRAME_WINDOW_P (f
))
13740 #if defined (USE_GTK) || USE_MAC_TOOLBAR
13741 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
13743 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
13744 && (FRAME_TOOL_BAR_LINES (f
) > 0
13745 || !NILP (Vauto_resize_tool_bars
));
13748 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
13750 extern int ignore_mouse_drag_p
;
13751 ignore_mouse_drag_p
= 1;
13757 #ifdef HAVE_WINDOW_SYSTEM
13758 if (FRAME_WINDOW_P (f
)
13759 && update_window_fringes (w
, (just_this_one_p
13760 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
13761 || w
->pseudo_window_p
)))
13765 if (draw_window_fringes (w
, 1))
13766 x_draw_vertical_border (w
);
13770 #endif /* HAVE_WINDOW_SYSTEM */
13772 /* We go to this label, with fonts_changed_p nonzero,
13773 if it is necessary to try again using larger glyph matrices.
13774 We have to redeem the scroll bar even in this case,
13775 because the loop in redisplay_internal expects that. */
13776 need_larger_matrices
:
13778 finish_scroll_bars
:
13780 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
13782 /* Set the thumb's position and size. */
13783 set_vertical_scroll_bar (w
);
13785 /* Note that we actually used the scroll bar attached to this
13786 window, so it shouldn't be deleted at the end of redisplay. */
13787 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
13788 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
13791 /* Restore current_buffer and value of point in it. */
13792 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
13793 set_buffer_internal_1 (old
);
13794 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
13795 shorter. This can be caused by log truncation in *Messages*. */
13796 if (CHARPOS (lpoint
) <= ZV
)
13797 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
13799 unbind_to (count
, Qnil
);
13803 /* Build the complete desired matrix of WINDOW with a window start
13804 buffer position POS.
13806 Value is 1 if successful. It is zero if fonts were loaded during
13807 redisplay which makes re-adjusting glyph matrices necessary, and -1
13808 if point would appear in the scroll margins.
13809 (We check that only if CHECK_MARGINS is nonzero. */
13812 try_window (window
, pos
, check_margins
)
13813 Lisp_Object window
;
13814 struct text_pos pos
;
13817 struct window
*w
= XWINDOW (window
);
13819 struct glyph_row
*last_text_row
= NULL
;
13820 struct frame
*f
= XFRAME (w
->frame
);
13822 /* Make POS the new window start. */
13823 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
13825 /* Mark cursor position as unknown. No overlay arrow seen. */
13826 w
->cursor
.vpos
= -1;
13827 overlay_arrow_seen
= 0;
13829 /* Initialize iterator and info to start at POS. */
13830 start_display (&it
, w
, pos
);
13832 /* Display all lines of W. */
13833 while (it
.current_y
< it
.last_visible_y
)
13835 if (display_line (&it
))
13836 last_text_row
= it
.glyph_row
- 1;
13837 if (fonts_changed_p
)
13841 /* Don't let the cursor end in the scroll margins. */
13843 && !MINI_WINDOW_P (w
))
13845 int this_scroll_margin
;
13847 this_scroll_margin
= max (0, scroll_margin
);
13848 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13849 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
13851 if ((w
->cursor
.y
>= 0 /* not vscrolled */
13852 && w
->cursor
.y
< this_scroll_margin
13853 && CHARPOS (pos
) > BEGV
13854 && IT_CHARPOS (it
) < ZV
)
13855 /* rms: considering make_cursor_line_fully_visible_p here
13856 seems to give wrong results. We don't want to recenter
13857 when the last line is partly visible, we want to allow
13858 that case to be handled in the usual way. */
13859 || (w
->cursor
.y
+ 1) > it
.last_visible_y
)
13861 w
->cursor
.vpos
= -1;
13862 clear_glyph_matrix (w
->desired_matrix
);
13867 /* If bottom moved off end of frame, change mode line percentage. */
13868 if (XFASTINT (w
->window_end_pos
) <= 0
13869 && Z
!= IT_CHARPOS (it
))
13870 w
->update_mode_line
= Qt
;
13872 /* Set window_end_pos to the offset of the last character displayed
13873 on the window from the end of current_buffer. Set
13874 window_end_vpos to its row number. */
13877 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
13878 w
->window_end_bytepos
13879 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
13881 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
13883 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
13884 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
13885 ->displays_text_p
);
13889 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
13890 w
->window_end_pos
= make_number (Z
- ZV
);
13891 w
->window_end_vpos
= make_number (0);
13894 /* But that is not valid info until redisplay finishes. */
13895 w
->window_end_valid
= Qnil
;
13901 /************************************************************************
13902 Window redisplay reusing current matrix when buffer has not changed
13903 ************************************************************************/
13905 /* Try redisplay of window W showing an unchanged buffer with a
13906 different window start than the last time it was displayed by
13907 reusing its current matrix. Value is non-zero if successful.
13908 W->start is the new window start. */
13911 try_window_reusing_current_matrix (w
)
13914 struct frame
*f
= XFRAME (w
->frame
);
13915 struct glyph_row
*row
, *bottom_row
;
13918 struct text_pos start
, new_start
;
13919 int nrows_scrolled
, i
;
13920 struct glyph_row
*last_text_row
;
13921 struct glyph_row
*last_reused_text_row
;
13922 struct glyph_row
*start_row
;
13923 int start_vpos
, min_y
, max_y
;
13926 if (inhibit_try_window_reusing
)
13930 if (/* This function doesn't handle terminal frames. */
13931 !FRAME_WINDOW_P (f
)
13932 /* Don't try to reuse the display if windows have been split
13934 || windows_or_buffers_changed
13935 || cursor_type_changed
)
13938 /* Can't do this if region may have changed. */
13939 if ((!NILP (Vtransient_mark_mode
)
13940 && !NILP (current_buffer
->mark_active
))
13941 || !NILP (w
->region_showing
)
13942 || !NILP (Vshow_trailing_whitespace
))
13945 /* If top-line visibility has changed, give up. */
13946 if (WINDOW_WANTS_HEADER_LINE_P (w
)
13947 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
13950 /* Give up if old or new display is scrolled vertically. We could
13951 make this function handle this, but right now it doesn't. */
13952 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
13953 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
13956 /* The variable new_start now holds the new window start. The old
13957 start `start' can be determined from the current matrix. */
13958 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
13959 start
= start_row
->start
.pos
;
13960 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
13962 /* Clear the desired matrix for the display below. */
13963 clear_glyph_matrix (w
->desired_matrix
);
13965 if (CHARPOS (new_start
) <= CHARPOS (start
))
13969 /* Don't use this method if the display starts with an ellipsis
13970 displayed for invisible text. It's not easy to handle that case
13971 below, and it's certainly not worth the effort since this is
13972 not a frequent case. */
13973 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
13976 IF_DEBUG (debug_method_add (w
, "twu1"));
13978 /* Display up to a row that can be reused. The variable
13979 last_text_row is set to the last row displayed that displays
13980 text. Note that it.vpos == 0 if or if not there is a
13981 header-line; it's not the same as the MATRIX_ROW_VPOS! */
13982 start_display (&it
, w
, new_start
);
13983 first_row_y
= it
.current_y
;
13984 w
->cursor
.vpos
= -1;
13985 last_text_row
= last_reused_text_row
= NULL
;
13987 while (it
.current_y
< it
.last_visible_y
13988 && !fonts_changed_p
)
13990 /* If we have reached into the characters in the START row,
13991 that means the line boundaries have changed. So we
13992 can't start copying with the row START. Maybe it will
13993 work to start copying with the following row. */
13994 while (IT_CHARPOS (it
) > CHARPOS (start
))
13996 /* Advance to the next row as the "start". */
13998 start
= start_row
->start
.pos
;
13999 /* If there are no more rows to try, or just one, give up. */
14000 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14001 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14002 || CHARPOS (start
) == ZV
)
14004 clear_glyph_matrix (w
->desired_matrix
);
14008 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14010 /* If we have reached alignment,
14011 we can copy the rest of the rows. */
14012 if (IT_CHARPOS (it
) == CHARPOS (start
))
14015 if (display_line (&it
))
14016 last_text_row
= it
.glyph_row
- 1;
14019 /* A value of current_y < last_visible_y means that we stopped
14020 at the previous window start, which in turn means that we
14021 have at least one reusable row. */
14022 if (it
.current_y
< it
.last_visible_y
)
14024 /* IT.vpos always starts from 0; it counts text lines. */
14025 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14027 /* Find PT if not already found in the lines displayed. */
14028 if (w
->cursor
.vpos
< 0)
14030 int dy
= it
.current_y
- start_row
->y
;
14032 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14033 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14035 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14036 dy
, nrows_scrolled
);
14039 clear_glyph_matrix (w
->desired_matrix
);
14044 /* Scroll the display. Do it before the current matrix is
14045 changed. The problem here is that update has not yet
14046 run, i.e. part of the current matrix is not up to date.
14047 scroll_run_hook will clear the cursor, and use the
14048 current matrix to get the height of the row the cursor is
14050 run
.current_y
= start_row
->y
;
14051 run
.desired_y
= it
.current_y
;
14052 run
.height
= it
.last_visible_y
- it
.current_y
;
14054 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14057 FRAME_RIF (f
)->update_window_begin_hook (w
);
14058 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14059 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14060 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14064 /* Shift current matrix down by nrows_scrolled lines. */
14065 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14066 rotate_matrix (w
->current_matrix
,
14068 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14071 /* Disable lines that must be updated. */
14072 for (i
= 0; i
< nrows_scrolled
; ++i
)
14073 (start_row
+ i
)->enabled_p
= 0;
14075 /* Re-compute Y positions. */
14076 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14077 max_y
= it
.last_visible_y
;
14078 for (row
= start_row
+ nrows_scrolled
;
14082 row
->y
= it
.current_y
;
14083 row
->visible_height
= row
->height
;
14085 if (row
->y
< min_y
)
14086 row
->visible_height
-= min_y
- row
->y
;
14087 if (row
->y
+ row
->height
> max_y
)
14088 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14089 row
->redraw_fringe_bitmaps_p
= 1;
14091 it
.current_y
+= row
->height
;
14093 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14094 last_reused_text_row
= row
;
14095 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14099 /* Disable lines in the current matrix which are now
14100 below the window. */
14101 for (++row
; row
< bottom_row
; ++row
)
14102 row
->enabled_p
= row
->mode_line_p
= 0;
14105 /* Update window_end_pos etc.; last_reused_text_row is the last
14106 reused row from the current matrix containing text, if any.
14107 The value of last_text_row is the last displayed line
14108 containing text. */
14109 if (last_reused_text_row
)
14111 w
->window_end_bytepos
14112 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14114 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14116 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14117 w
->current_matrix
));
14119 else if (last_text_row
)
14121 w
->window_end_bytepos
14122 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14124 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14126 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14130 /* This window must be completely empty. */
14131 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14132 w
->window_end_pos
= make_number (Z
- ZV
);
14133 w
->window_end_vpos
= make_number (0);
14135 w
->window_end_valid
= Qnil
;
14137 /* Update hint: don't try scrolling again in update_window. */
14138 w
->desired_matrix
->no_scrolling_p
= 1;
14141 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14145 else if (CHARPOS (new_start
) > CHARPOS (start
))
14147 struct glyph_row
*pt_row
, *row
;
14148 struct glyph_row
*first_reusable_row
;
14149 struct glyph_row
*first_row_to_display
;
14151 int yb
= window_text_bottom_y (w
);
14153 /* Find the row starting at new_start, if there is one. Don't
14154 reuse a partially visible line at the end. */
14155 first_reusable_row
= start_row
;
14156 while (first_reusable_row
->enabled_p
14157 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14158 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14159 < CHARPOS (new_start
)))
14160 ++first_reusable_row
;
14162 /* Give up if there is no row to reuse. */
14163 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14164 || !first_reusable_row
->enabled_p
14165 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14166 != CHARPOS (new_start
)))
14169 /* We can reuse fully visible rows beginning with
14170 first_reusable_row to the end of the window. Set
14171 first_row_to_display to the first row that cannot be reused.
14172 Set pt_row to the row containing point, if there is any. */
14174 for (first_row_to_display
= first_reusable_row
;
14175 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14176 ++first_row_to_display
)
14178 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14179 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14180 pt_row
= first_row_to_display
;
14183 /* Start displaying at the start of first_row_to_display. */
14184 xassert (first_row_to_display
->y
< yb
);
14185 init_to_row_start (&it
, w
, first_row_to_display
);
14187 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14189 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14191 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14192 + WINDOW_HEADER_LINE_HEIGHT (w
));
14194 /* Display lines beginning with first_row_to_display in the
14195 desired matrix. Set last_text_row to the last row displayed
14196 that displays text. */
14197 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14198 if (pt_row
== NULL
)
14199 w
->cursor
.vpos
= -1;
14200 last_text_row
= NULL
;
14201 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14202 if (display_line (&it
))
14203 last_text_row
= it
.glyph_row
- 1;
14205 /* Give up If point isn't in a row displayed or reused. */
14206 if (w
->cursor
.vpos
< 0)
14208 clear_glyph_matrix (w
->desired_matrix
);
14212 /* If point is in a reused row, adjust y and vpos of the cursor
14216 w
->cursor
.vpos
-= nrows_scrolled
;
14217 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14220 /* Scroll the display. */
14221 run
.current_y
= first_reusable_row
->y
;
14222 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14223 run
.height
= it
.last_visible_y
- run
.current_y
;
14224 dy
= run
.current_y
- run
.desired_y
;
14229 FRAME_RIF (f
)->update_window_begin_hook (w
);
14230 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14231 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14232 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14236 /* Adjust Y positions of reused rows. */
14237 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14238 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14239 max_y
= it
.last_visible_y
;
14240 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14243 row
->visible_height
= row
->height
;
14244 if (row
->y
< min_y
)
14245 row
->visible_height
-= min_y
- row
->y
;
14246 if (row
->y
+ row
->height
> max_y
)
14247 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14248 row
->redraw_fringe_bitmaps_p
= 1;
14251 /* Scroll the current matrix. */
14252 xassert (nrows_scrolled
> 0);
14253 rotate_matrix (w
->current_matrix
,
14255 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14258 /* Disable rows not reused. */
14259 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
14260 row
->enabled_p
= 0;
14262 /* Point may have moved to a different line, so we cannot assume that
14263 the previous cursor position is valid; locate the correct row. */
14266 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14267 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
14271 w
->cursor
.y
= row
->y
;
14273 if (row
< bottom_row
)
14275 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14276 while (glyph
->charpos
< PT
)
14279 w
->cursor
.x
+= glyph
->pixel_width
;
14285 /* Adjust window end. A null value of last_text_row means that
14286 the window end is in reused rows which in turn means that
14287 only its vpos can have changed. */
14290 w
->window_end_bytepos
14291 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14293 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14295 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14300 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
14303 w
->window_end_valid
= Qnil
;
14304 w
->desired_matrix
->no_scrolling_p
= 1;
14307 debug_method_add (w
, "try_window_reusing_current_matrix 2");
14317 /************************************************************************
14318 Window redisplay reusing current matrix when buffer has changed
14319 ************************************************************************/
14321 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
14322 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
14324 static struct glyph_row
*
14325 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
14326 struct glyph_row
*));
14329 /* Return the last row in MATRIX displaying text. If row START is
14330 non-null, start searching with that row. IT gives the dimensions
14331 of the display. Value is null if matrix is empty; otherwise it is
14332 a pointer to the row found. */
14334 static struct glyph_row
*
14335 find_last_row_displaying_text (matrix
, it
, start
)
14336 struct glyph_matrix
*matrix
;
14338 struct glyph_row
*start
;
14340 struct glyph_row
*row
, *row_found
;
14342 /* Set row_found to the last row in IT->w's current matrix
14343 displaying text. The loop looks funny but think of partially
14346 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
14347 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14349 xassert (row
->enabled_p
);
14351 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
14360 /* Return the last row in the current matrix of W that is not affected
14361 by changes at the start of current_buffer that occurred since W's
14362 current matrix was built. Value is null if no such row exists.
14364 BEG_UNCHANGED us the number of characters unchanged at the start of
14365 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
14366 first changed character in current_buffer. Characters at positions <
14367 BEG + BEG_UNCHANGED are at the same buffer positions as they were
14368 when the current matrix was built. */
14370 static struct glyph_row
*
14371 find_last_unchanged_at_beg_row (w
)
14374 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
14375 struct glyph_row
*row
;
14376 struct glyph_row
*row_found
= NULL
;
14377 int yb
= window_text_bottom_y (w
);
14379 /* Find the last row displaying unchanged text. */
14380 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14381 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14382 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
)
14384 if (/* If row ends before first_changed_pos, it is unchanged,
14385 except in some case. */
14386 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
14387 /* When row ends in ZV and we write at ZV it is not
14389 && !row
->ends_at_zv_p
14390 /* When first_changed_pos is the end of a continued line,
14391 row is not unchanged because it may be no longer
14393 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
14394 && (row
->continued_p
14395 || row
->exact_window_width_line_p
)))
14398 /* Stop if last visible row. */
14399 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
14409 /* Find the first glyph row in the current matrix of W that is not
14410 affected by changes at the end of current_buffer since the
14411 time W's current matrix was built.
14413 Return in *DELTA the number of chars by which buffer positions in
14414 unchanged text at the end of current_buffer must be adjusted.
14416 Return in *DELTA_BYTES the corresponding number of bytes.
14418 Value is null if no such row exists, i.e. all rows are affected by
14421 static struct glyph_row
*
14422 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
14424 int *delta
, *delta_bytes
;
14426 struct glyph_row
*row
;
14427 struct glyph_row
*row_found
= NULL
;
14429 *delta
= *delta_bytes
= 0;
14431 /* Display must not have been paused, otherwise the current matrix
14432 is not up to date. */
14433 eassert (!NILP (w
->window_end_valid
));
14435 /* A value of window_end_pos >= END_UNCHANGED means that the window
14436 end is in the range of changed text. If so, there is no
14437 unchanged row at the end of W's current matrix. */
14438 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
14441 /* Set row to the last row in W's current matrix displaying text. */
14442 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14444 /* If matrix is entirely empty, no unchanged row exists. */
14445 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14447 /* The value of row is the last glyph row in the matrix having a
14448 meaningful buffer position in it. The end position of row
14449 corresponds to window_end_pos. This allows us to translate
14450 buffer positions in the current matrix to current buffer
14451 positions for characters not in changed text. */
14452 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14453 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14454 int last_unchanged_pos
, last_unchanged_pos_old
;
14455 struct glyph_row
*first_text_row
14456 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14458 *delta
= Z
- Z_old
;
14459 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14461 /* Set last_unchanged_pos to the buffer position of the last
14462 character in the buffer that has not been changed. Z is the
14463 index + 1 of the last character in current_buffer, i.e. by
14464 subtracting END_UNCHANGED we get the index of the last
14465 unchanged character, and we have to add BEG to get its buffer
14467 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
14468 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
14470 /* Search backward from ROW for a row displaying a line that
14471 starts at a minimum position >= last_unchanged_pos_old. */
14472 for (; row
> first_text_row
; --row
)
14474 /* This used to abort, but it can happen.
14475 It is ok to just stop the search instead here. KFS. */
14476 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14479 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
14484 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
14490 /* Make sure that glyph rows in the current matrix of window W
14491 reference the same glyph memory as corresponding rows in the
14492 frame's frame matrix. This function is called after scrolling W's
14493 current matrix on a terminal frame in try_window_id and
14494 try_window_reusing_current_matrix. */
14497 sync_frame_with_window_matrix_rows (w
)
14500 struct frame
*f
= XFRAME (w
->frame
);
14501 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
14503 /* Preconditions: W must be a leaf window and full-width. Its frame
14504 must have a frame matrix. */
14505 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
14506 xassert (WINDOW_FULL_WIDTH_P (w
));
14507 xassert (!FRAME_WINDOW_P (f
));
14509 /* If W is a full-width window, glyph pointers in W's current matrix
14510 have, by definition, to be the same as glyph pointers in the
14511 corresponding frame matrix. Note that frame matrices have no
14512 marginal areas (see build_frame_matrix). */
14513 window_row
= w
->current_matrix
->rows
;
14514 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
14515 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
14516 while (window_row
< window_row_end
)
14518 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
14519 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
14521 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
14522 frame_row
->glyphs
[TEXT_AREA
] = start
;
14523 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
14524 frame_row
->glyphs
[LAST_AREA
] = end
;
14526 /* Disable frame rows whose corresponding window rows have
14527 been disabled in try_window_id. */
14528 if (!window_row
->enabled_p
)
14529 frame_row
->enabled_p
= 0;
14531 ++window_row
, ++frame_row
;
14536 /* Find the glyph row in window W containing CHARPOS. Consider all
14537 rows between START and END (not inclusive). END null means search
14538 all rows to the end of the display area of W. Value is the row
14539 containing CHARPOS or null. */
14542 row_containing_pos (w
, charpos
, start
, end
, dy
)
14545 struct glyph_row
*start
, *end
;
14548 struct glyph_row
*row
= start
;
14551 /* If we happen to start on a header-line, skip that. */
14552 if (row
->mode_line_p
)
14555 if ((end
&& row
>= end
) || !row
->enabled_p
)
14558 last_y
= window_text_bottom_y (w
) - dy
;
14562 /* Give up if we have gone too far. */
14563 if (end
&& row
>= end
)
14565 /* This formerly returned if they were equal.
14566 I think that both quantities are of a "last plus one" type;
14567 if so, when they are equal, the row is within the screen. -- rms. */
14568 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
14571 /* If it is in this row, return this row. */
14572 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
14573 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
14574 /* The end position of a row equals the start
14575 position of the next row. If CHARPOS is there, we
14576 would rather display it in the next line, except
14577 when this line ends in ZV. */
14578 && !row
->ends_at_zv_p
14579 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14580 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
14587 /* Try to redisplay window W by reusing its existing display. W's
14588 current matrix must be up to date when this function is called,
14589 i.e. window_end_valid must not be nil.
14593 1 if display has been updated
14594 0 if otherwise unsuccessful
14595 -1 if redisplay with same window start is known not to succeed
14597 The following steps are performed:
14599 1. Find the last row in the current matrix of W that is not
14600 affected by changes at the start of current_buffer. If no such row
14603 2. Find the first row in W's current matrix that is not affected by
14604 changes at the end of current_buffer. Maybe there is no such row.
14606 3. Display lines beginning with the row + 1 found in step 1 to the
14607 row found in step 2 or, if step 2 didn't find a row, to the end of
14610 4. If cursor is not known to appear on the window, give up.
14612 5. If display stopped at the row found in step 2, scroll the
14613 display and current matrix as needed.
14615 6. Maybe display some lines at the end of W, if we must. This can
14616 happen under various circumstances, like a partially visible line
14617 becoming fully visible, or because newly displayed lines are displayed
14618 in smaller font sizes.
14620 7. Update W's window end information. */
14626 struct frame
*f
= XFRAME (w
->frame
);
14627 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
14628 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
14629 struct glyph_row
*last_unchanged_at_beg_row
;
14630 struct glyph_row
*first_unchanged_at_end_row
;
14631 struct glyph_row
*row
;
14632 struct glyph_row
*bottom_row
;
14635 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
14636 struct text_pos start_pos
;
14638 int first_unchanged_at_end_vpos
= 0;
14639 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
14640 struct text_pos start
;
14641 int first_changed_charpos
, last_changed_charpos
;
14644 if (inhibit_try_window_id
)
14648 /* This is handy for debugging. */
14650 #define GIVE_UP(X) \
14652 fprintf (stderr, "try_window_id give up %d\n", (X)); \
14656 #define GIVE_UP(X) return 0
14659 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
14661 /* Don't use this for mini-windows because these can show
14662 messages and mini-buffers, and we don't handle that here. */
14663 if (MINI_WINDOW_P (w
))
14666 /* This flag is used to prevent redisplay optimizations. */
14667 if (windows_or_buffers_changed
|| cursor_type_changed
)
14670 /* Verify that narrowing has not changed.
14671 Also verify that we were not told to prevent redisplay optimizations.
14672 It would be nice to further
14673 reduce the number of cases where this prevents try_window_id. */
14674 if (current_buffer
->clip_changed
14675 || current_buffer
->prevent_redisplay_optimizations_p
)
14678 /* Window must either use window-based redisplay or be full width. */
14679 if (!FRAME_WINDOW_P (f
)
14680 && (!FRAME_LINE_INS_DEL_OK (f
)
14681 || !WINDOW_FULL_WIDTH_P (w
)))
14684 /* Give up if point is not known NOT to appear in W. */
14685 if (PT
< CHARPOS (start
))
14688 /* Another way to prevent redisplay optimizations. */
14689 if (XFASTINT (w
->last_modified
) == 0)
14692 /* Verify that window is not hscrolled. */
14693 if (XFASTINT (w
->hscroll
) != 0)
14696 /* Verify that display wasn't paused. */
14697 if (NILP (w
->window_end_valid
))
14700 /* Can't use this if highlighting a region because a cursor movement
14701 will do more than just set the cursor. */
14702 if (!NILP (Vtransient_mark_mode
)
14703 && !NILP (current_buffer
->mark_active
))
14706 /* Likewise if highlighting trailing whitespace. */
14707 if (!NILP (Vshow_trailing_whitespace
))
14710 /* Likewise if showing a region. */
14711 if (!NILP (w
->region_showing
))
14714 /* Can use this if overlay arrow position and or string have changed. */
14715 if (overlay_arrows_changed_p ())
14719 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
14720 only if buffer has really changed. The reason is that the gap is
14721 initially at Z for freshly visited files. The code below would
14722 set end_unchanged to 0 in that case. */
14723 if (MODIFF
> SAVE_MODIFF
14724 /* This seems to happen sometimes after saving a buffer. */
14725 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
14727 if (GPT
- BEG
< BEG_UNCHANGED
)
14728 BEG_UNCHANGED
= GPT
- BEG
;
14729 if (Z
- GPT
< END_UNCHANGED
)
14730 END_UNCHANGED
= Z
- GPT
;
14733 /* The position of the first and last character that has been changed. */
14734 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
14735 last_changed_charpos
= Z
- END_UNCHANGED
;
14737 /* If window starts after a line end, and the last change is in
14738 front of that newline, then changes don't affect the display.
14739 This case happens with stealth-fontification. Note that although
14740 the display is unchanged, glyph positions in the matrix have to
14741 be adjusted, of course. */
14742 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14743 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14744 && ((last_changed_charpos
< CHARPOS (start
)
14745 && CHARPOS (start
) == BEGV
)
14746 || (last_changed_charpos
< CHARPOS (start
) - 1
14747 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
14749 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
14750 struct glyph_row
*r0
;
14752 /* Compute how many chars/bytes have been added to or removed
14753 from the buffer. */
14754 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14755 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14757 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14759 /* Give up if PT is not in the window. Note that it already has
14760 been checked at the start of try_window_id that PT is not in
14761 front of the window start. */
14762 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
14765 /* If window start is unchanged, we can reuse the whole matrix
14766 as is, after adjusting glyph positions. No need to compute
14767 the window end again, since its offset from Z hasn't changed. */
14768 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14769 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
14770 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
14771 /* PT must not be in a partially visible line. */
14772 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
14773 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
14775 /* Adjust positions in the glyph matrix. */
14776 if (delta
|| delta_bytes
)
14778 struct glyph_row
*r1
14779 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
14780 increment_matrix_positions (w
->current_matrix
,
14781 MATRIX_ROW_VPOS (r0
, current_matrix
),
14782 MATRIX_ROW_VPOS (r1
, current_matrix
),
14783 delta
, delta_bytes
);
14786 /* Set the cursor. */
14787 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
14789 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
14796 /* Handle the case that changes are all below what is displayed in
14797 the window, and that PT is in the window. This shortcut cannot
14798 be taken if ZV is visible in the window, and text has been added
14799 there that is visible in the window. */
14800 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
14801 /* ZV is not visible in the window, or there are no
14802 changes at ZV, actually. */
14803 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
14804 || first_changed_charpos
== last_changed_charpos
))
14806 struct glyph_row
*r0
;
14808 /* Give up if PT is not in the window. Note that it already has
14809 been checked at the start of try_window_id that PT is not in
14810 front of the window start. */
14811 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
14814 /* If window start is unchanged, we can reuse the whole matrix
14815 as is, without changing glyph positions since no text has
14816 been added/removed in front of the window end. */
14817 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14818 if (TEXT_POS_EQUAL_P (start
, r0
->start
.pos
)
14819 /* PT must not be in a partially visible line. */
14820 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
14821 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
14823 /* We have to compute the window end anew since text
14824 can have been added/removed after it. */
14826 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
14827 w
->window_end_bytepos
14828 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
14830 /* Set the cursor. */
14831 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
14833 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
14840 /* Give up if window start is in the changed area.
14842 The condition used to read
14844 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
14846 but why that was tested escapes me at the moment. */
14847 if (CHARPOS (start
) >= first_changed_charpos
14848 && CHARPOS (start
) <= last_changed_charpos
)
14851 /* Check that window start agrees with the start of the first glyph
14852 row in its current matrix. Check this after we know the window
14853 start is not in changed text, otherwise positions would not be
14855 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14856 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
14859 /* Give up if the window ends in strings. Overlay strings
14860 at the end are difficult to handle, so don't try. */
14861 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
14862 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
14865 /* Compute the position at which we have to start displaying new
14866 lines. Some of the lines at the top of the window might be
14867 reusable because they are not displaying changed text. Find the
14868 last row in W's current matrix not affected by changes at the
14869 start of current_buffer. Value is null if changes start in the
14870 first line of window. */
14871 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
14872 if (last_unchanged_at_beg_row
)
14874 /* Avoid starting to display in the moddle of a character, a TAB
14875 for instance. This is easier than to set up the iterator
14876 exactly, and it's not a frequent case, so the additional
14877 effort wouldn't really pay off. */
14878 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
14879 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
14880 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
14881 --last_unchanged_at_beg_row
;
14883 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
14886 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
14888 start_pos
= it
.current
.pos
;
14890 /* Start displaying new lines in the desired matrix at the same
14891 vpos we would use in the current matrix, i.e. below
14892 last_unchanged_at_beg_row. */
14893 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
14895 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
14896 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
14898 xassert (it
.hpos
== 0 && it
.current_x
== 0);
14902 /* There are no reusable lines at the start of the window.
14903 Start displaying in the first text line. */
14904 start_display (&it
, w
, start
);
14905 it
.vpos
= it
.first_vpos
;
14906 start_pos
= it
.current
.pos
;
14909 /* Find the first row that is not affected by changes at the end of
14910 the buffer. Value will be null if there is no unchanged row, in
14911 which case we must redisplay to the end of the window. delta
14912 will be set to the value by which buffer positions beginning with
14913 first_unchanged_at_end_row have to be adjusted due to text
14915 first_unchanged_at_end_row
14916 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
14917 IF_DEBUG (debug_delta
= delta
);
14918 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
14920 /* Set stop_pos to the buffer position up to which we will have to
14921 display new lines. If first_unchanged_at_end_row != NULL, this
14922 is the buffer position of the start of the line displayed in that
14923 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
14924 that we don't stop at a buffer position. */
14926 if (first_unchanged_at_end_row
)
14928 xassert (last_unchanged_at_beg_row
== NULL
14929 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
14931 /* If this is a continuation line, move forward to the next one
14932 that isn't. Changes in lines above affect this line.
14933 Caution: this may move first_unchanged_at_end_row to a row
14934 not displaying text. */
14935 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
14936 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
14937 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
14938 < it
.last_visible_y
))
14939 ++first_unchanged_at_end_row
;
14941 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
14942 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
14943 >= it
.last_visible_y
))
14944 first_unchanged_at_end_row
= NULL
;
14947 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
14949 first_unchanged_at_end_vpos
14950 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
14951 xassert (stop_pos
>= Z
- END_UNCHANGED
);
14954 else if (last_unchanged_at_beg_row
== NULL
)
14960 /* Either there is no unchanged row at the end, or the one we have
14961 now displays text. This is a necessary condition for the window
14962 end pos calculation at the end of this function. */
14963 xassert (first_unchanged_at_end_row
== NULL
14964 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
14966 debug_last_unchanged_at_beg_vpos
14967 = (last_unchanged_at_beg_row
14968 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
14970 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
14972 #endif /* GLYPH_DEBUG != 0 */
14975 /* Display new lines. Set last_text_row to the last new line
14976 displayed which has text on it, i.e. might end up as being the
14977 line where the window_end_vpos is. */
14978 w
->cursor
.vpos
= -1;
14979 last_text_row
= NULL
;
14980 overlay_arrow_seen
= 0;
14981 while (it
.current_y
< it
.last_visible_y
14982 && !fonts_changed_p
14983 && (first_unchanged_at_end_row
== NULL
14984 || IT_CHARPOS (it
) < stop_pos
))
14986 if (display_line (&it
))
14987 last_text_row
= it
.glyph_row
- 1;
14990 if (fonts_changed_p
)
14994 /* Compute differences in buffer positions, y-positions etc. for
14995 lines reused at the bottom of the window. Compute what we can
14997 if (first_unchanged_at_end_row
14998 /* No lines reused because we displayed everything up to the
14999 bottom of the window. */
15000 && it
.current_y
< it
.last_visible_y
)
15003 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15005 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15006 run
.current_y
= first_unchanged_at_end_row
->y
;
15007 run
.desired_y
= run
.current_y
+ dy
;
15008 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15012 delta
= delta_bytes
= dvpos
= dy
15013 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15014 first_unchanged_at_end_row
= NULL
;
15016 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15019 /* Find the cursor if not already found. We have to decide whether
15020 PT will appear on this window (it sometimes doesn't, but this is
15021 not a very frequent case.) This decision has to be made before
15022 the current matrix is altered. A value of cursor.vpos < 0 means
15023 that PT is either in one of the lines beginning at
15024 first_unchanged_at_end_row or below the window. Don't care for
15025 lines that might be displayed later at the window end; as
15026 mentioned, this is not a frequent case. */
15027 if (w
->cursor
.vpos
< 0)
15029 /* Cursor in unchanged rows at the top? */
15030 if (PT
< CHARPOS (start_pos
)
15031 && last_unchanged_at_beg_row
)
15033 row
= row_containing_pos (w
, PT
,
15034 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15035 last_unchanged_at_beg_row
+ 1, 0);
15037 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15040 /* Start from first_unchanged_at_end_row looking for PT. */
15041 else if (first_unchanged_at_end_row
)
15043 row
= row_containing_pos (w
, PT
- delta
,
15044 first_unchanged_at_end_row
, NULL
, 0);
15046 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15047 delta_bytes
, dy
, dvpos
);
15050 /* Give up if cursor was not found. */
15051 if (w
->cursor
.vpos
< 0)
15053 clear_glyph_matrix (w
->desired_matrix
);
15058 /* Don't let the cursor end in the scroll margins. */
15060 int this_scroll_margin
, cursor_height
;
15062 this_scroll_margin
= max (0, scroll_margin
);
15063 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15064 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15065 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15067 if ((w
->cursor
.y
< this_scroll_margin
15068 && CHARPOS (start
) > BEGV
)
15069 /* Old redisplay didn't take scroll margin into account at the bottom,
15070 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15071 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15072 ? cursor_height
+ this_scroll_margin
15073 : 1)) > it
.last_visible_y
)
15075 w
->cursor
.vpos
= -1;
15076 clear_glyph_matrix (w
->desired_matrix
);
15081 /* Scroll the display. Do it before changing the current matrix so
15082 that xterm.c doesn't get confused about where the cursor glyph is
15084 if (dy
&& run
.height
)
15088 if (FRAME_WINDOW_P (f
))
15090 FRAME_RIF (f
)->update_window_begin_hook (w
);
15091 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15092 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15093 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15097 /* Terminal frame. In this case, dvpos gives the number of
15098 lines to scroll by; dvpos < 0 means scroll up. */
15099 int first_unchanged_at_end_vpos
15100 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15101 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
15102 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15103 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15104 + window_internal_height (w
));
15106 /* Perform the operation on the screen. */
15109 /* Scroll last_unchanged_at_beg_row to the end of the
15110 window down dvpos lines. */
15111 set_terminal_window (f
, end
);
15113 /* On dumb terminals delete dvpos lines at the end
15114 before inserting dvpos empty lines. */
15115 if (!FRAME_SCROLL_REGION_OK (f
))
15116 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15118 /* Insert dvpos empty lines in front of
15119 last_unchanged_at_beg_row. */
15120 ins_del_lines (f
, from
, dvpos
);
15122 else if (dvpos
< 0)
15124 /* Scroll up last_unchanged_at_beg_vpos to the end of
15125 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15126 set_terminal_window (f
, end
);
15128 /* Delete dvpos lines in front of
15129 last_unchanged_at_beg_vpos. ins_del_lines will set
15130 the cursor to the given vpos and emit |dvpos| delete
15132 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15134 /* On a dumb terminal insert dvpos empty lines at the
15136 if (!FRAME_SCROLL_REGION_OK (f
))
15137 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15140 set_terminal_window (f
, 0);
15146 /* Shift reused rows of the current matrix to the right position.
15147 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15149 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15150 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15153 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15154 bottom_vpos
, dvpos
);
15155 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15158 else if (dvpos
> 0)
15160 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15161 bottom_vpos
, dvpos
);
15162 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15163 first_unchanged_at_end_vpos
+ dvpos
, 0);
15166 /* For frame-based redisplay, make sure that current frame and window
15167 matrix are in sync with respect to glyph memory. */
15168 if (!FRAME_WINDOW_P (f
))
15169 sync_frame_with_window_matrix_rows (w
);
15171 /* Adjust buffer positions in reused rows. */
15172 if (delta
|| delta_bytes
)
15173 increment_matrix_positions (current_matrix
,
15174 first_unchanged_at_end_vpos
+ dvpos
,
15175 bottom_vpos
, delta
, delta_bytes
);
15177 /* Adjust Y positions. */
15179 shift_glyph_matrix (w
, current_matrix
,
15180 first_unchanged_at_end_vpos
+ dvpos
,
15183 if (first_unchanged_at_end_row
)
15185 first_unchanged_at_end_row
+= dvpos
;
15186 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15187 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15188 first_unchanged_at_end_row
= NULL
;
15191 /* If scrolling up, there may be some lines to display at the end of
15193 last_text_row_at_end
= NULL
;
15196 /* Scrolling up can leave for example a partially visible line
15197 at the end of the window to be redisplayed. */
15198 /* Set last_row to the glyph row in the current matrix where the
15199 window end line is found. It has been moved up or down in
15200 the matrix by dvpos. */
15201 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
15202 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
15204 /* If last_row is the window end line, it should display text. */
15205 xassert (last_row
->displays_text_p
);
15207 /* If window end line was partially visible before, begin
15208 displaying at that line. Otherwise begin displaying with the
15209 line following it. */
15210 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
15212 init_to_row_start (&it
, w
, last_row
);
15213 it
.vpos
= last_vpos
;
15214 it
.current_y
= last_row
->y
;
15218 init_to_row_end (&it
, w
, last_row
);
15219 it
.vpos
= 1 + last_vpos
;
15220 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
15224 /* We may start in a continuation line. If so, we have to
15225 get the right continuation_lines_width and current_x. */
15226 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
15227 it
.hpos
= it
.current_x
= 0;
15229 /* Display the rest of the lines at the window end. */
15230 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15231 while (it
.current_y
< it
.last_visible_y
15232 && !fonts_changed_p
)
15234 /* Is it always sure that the display agrees with lines in
15235 the current matrix? I don't think so, so we mark rows
15236 displayed invalid in the current matrix by setting their
15237 enabled_p flag to zero. */
15238 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
15239 if (display_line (&it
))
15240 last_text_row_at_end
= it
.glyph_row
- 1;
15244 /* Update window_end_pos and window_end_vpos. */
15245 if (first_unchanged_at_end_row
15246 && !last_text_row_at_end
)
15248 /* Window end line if one of the preserved rows from the current
15249 matrix. Set row to the last row displaying text in current
15250 matrix starting at first_unchanged_at_end_row, after
15252 xassert (first_unchanged_at_end_row
->displays_text_p
);
15253 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
15254 first_unchanged_at_end_row
);
15255 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
15257 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15258 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15260 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
15261 xassert (w
->window_end_bytepos
>= 0);
15262 IF_DEBUG (debug_method_add (w
, "A"));
15264 else if (last_text_row_at_end
)
15267 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
15268 w
->window_end_bytepos
15269 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
15271 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
15272 xassert (w
->window_end_bytepos
>= 0);
15273 IF_DEBUG (debug_method_add (w
, "B"));
15275 else if (last_text_row
)
15277 /* We have displayed either to the end of the window or at the
15278 end of the window, i.e. the last row with text is to be found
15279 in the desired matrix. */
15281 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15282 w
->window_end_bytepos
15283 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15285 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
15286 xassert (w
->window_end_bytepos
>= 0);
15288 else if (first_unchanged_at_end_row
== NULL
15289 && last_text_row
== NULL
15290 && last_text_row_at_end
== NULL
)
15292 /* Displayed to end of window, but no line containing text was
15293 displayed. Lines were deleted at the end of the window. */
15294 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
15295 int vpos
= XFASTINT (w
->window_end_vpos
);
15296 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
15297 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
15300 row
== NULL
&& vpos
>= first_vpos
;
15301 --vpos
, --current_row
, --desired_row
)
15303 if (desired_row
->enabled_p
)
15305 if (desired_row
->displays_text_p
)
15308 else if (current_row
->displays_text_p
)
15312 xassert (row
!= NULL
);
15313 w
->window_end_vpos
= make_number (vpos
+ 1);
15314 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15315 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15316 xassert (w
->window_end_bytepos
>= 0);
15317 IF_DEBUG (debug_method_add (w
, "C"));
15322 #if 0 /* This leads to problems, for instance when the cursor is
15323 at ZV, and the cursor line displays no text. */
15324 /* Disable rows below what's displayed in the window. This makes
15325 debugging easier. */
15326 enable_glyph_matrix_rows (current_matrix
,
15327 XFASTINT (w
->window_end_vpos
) + 1,
15331 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
15332 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
15334 /* Record that display has not been completed. */
15335 w
->window_end_valid
= Qnil
;
15336 w
->desired_matrix
->no_scrolling_p
= 1;
15344 /***********************************************************************
15345 More debugging support
15346 ***********************************************************************/
15350 void dump_glyph_row
P_ ((struct glyph_row
*, int, int));
15351 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
15352 void dump_glyph
P_ ((struct glyph_row
*, struct glyph
*, int));
15355 /* Dump the contents of glyph matrix MATRIX on stderr.
15357 GLYPHS 0 means don't show glyph contents.
15358 GLYPHS 1 means show glyphs in short form
15359 GLYPHS > 1 means show glyphs in long form. */
15362 dump_glyph_matrix (matrix
, glyphs
)
15363 struct glyph_matrix
*matrix
;
15367 for (i
= 0; i
< matrix
->nrows
; ++i
)
15368 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
15372 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
15373 the glyph row and area where the glyph comes from. */
15376 dump_glyph (row
, glyph
, area
)
15377 struct glyph_row
*row
;
15378 struct glyph
*glyph
;
15381 if (glyph
->type
== CHAR_GLYPH
)
15384 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15385 glyph
- row
->glyphs
[TEXT_AREA
],
15388 (BUFFERP (glyph
->object
)
15390 : (STRINGP (glyph
->object
)
15393 glyph
->pixel_width
,
15395 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
15399 glyph
->left_box_line_p
,
15400 glyph
->right_box_line_p
);
15402 else if (glyph
->type
== STRETCH_GLYPH
)
15405 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15406 glyph
- row
->glyphs
[TEXT_AREA
],
15409 (BUFFERP (glyph
->object
)
15411 : (STRINGP (glyph
->object
)
15414 glyph
->pixel_width
,
15418 glyph
->left_box_line_p
,
15419 glyph
->right_box_line_p
);
15421 else if (glyph
->type
== IMAGE_GLYPH
)
15424 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15425 glyph
- row
->glyphs
[TEXT_AREA
],
15428 (BUFFERP (glyph
->object
)
15430 : (STRINGP (glyph
->object
)
15433 glyph
->pixel_width
,
15437 glyph
->left_box_line_p
,
15438 glyph
->right_box_line_p
);
15440 else if (glyph
->type
== COMPOSITE_GLYPH
)
15443 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15444 glyph
- row
->glyphs
[TEXT_AREA
],
15447 (BUFFERP (glyph
->object
)
15449 : (STRINGP (glyph
->object
)
15452 glyph
->pixel_width
,
15456 glyph
->left_box_line_p
,
15457 glyph
->right_box_line_p
);
15462 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
15463 GLYPHS 0 means don't show glyph contents.
15464 GLYPHS 1 means show glyphs in short form
15465 GLYPHS > 1 means show glyphs in long form. */
15468 dump_glyph_row (row
, vpos
, glyphs
)
15469 struct glyph_row
*row
;
15474 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
15475 fprintf (stderr
, "======================================================================\n");
15477 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
15478 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
15480 MATRIX_ROW_START_CHARPOS (row
),
15481 MATRIX_ROW_END_CHARPOS (row
),
15482 row
->used
[TEXT_AREA
],
15483 row
->contains_overlapping_glyphs_p
,
15485 row
->truncated_on_left_p
,
15486 row
->truncated_on_right_p
,
15488 MATRIX_ROW_CONTINUATION_LINE_P (row
),
15489 row
->displays_text_p
,
15492 row
->ends_in_middle_of_char_p
,
15493 row
->starts_in_middle_of_char_p
,
15499 row
->visible_height
,
15502 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
15503 row
->end
.overlay_string_index
,
15504 row
->continuation_lines_width
);
15505 fprintf (stderr
, "%9d %5d\n",
15506 CHARPOS (row
->start
.string_pos
),
15507 CHARPOS (row
->end
.string_pos
));
15508 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
15509 row
->end
.dpvec_index
);
15516 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15518 struct glyph
*glyph
= row
->glyphs
[area
];
15519 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
15521 /* Glyph for a line end in text. */
15522 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
15525 if (glyph
< glyph_end
)
15526 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
15528 for (; glyph
< glyph_end
; ++glyph
)
15529 dump_glyph (row
, glyph
, area
);
15532 else if (glyphs
== 1)
15536 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15538 char *s
= (char *) alloca (row
->used
[area
] + 1);
15541 for (i
= 0; i
< row
->used
[area
]; ++i
)
15543 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
15544 if (glyph
->type
== CHAR_GLYPH
15545 && glyph
->u
.ch
< 0x80
15546 && glyph
->u
.ch
>= ' ')
15547 s
[i
] = glyph
->u
.ch
;
15553 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
15559 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
15560 Sdump_glyph_matrix
, 0, 1, "p",
15561 doc
: /* Dump the current matrix of the selected window to stderr.
15562 Shows contents of glyph row structures. With non-nil
15563 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
15564 glyphs in short form, otherwise show glyphs in long form. */)
15566 Lisp_Object glyphs
;
15568 struct window
*w
= XWINDOW (selected_window
);
15569 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15571 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
15572 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
15573 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
15574 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
15575 fprintf (stderr
, "=============================================\n");
15576 dump_glyph_matrix (w
->current_matrix
,
15577 NILP (glyphs
) ? 0 : XINT (glyphs
));
15582 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
15583 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
15586 struct frame
*f
= XFRAME (selected_frame
);
15587 dump_glyph_matrix (f
->current_matrix
, 1);
15592 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
15593 doc
: /* Dump glyph row ROW to stderr.
15594 GLYPH 0 means don't dump glyphs.
15595 GLYPH 1 means dump glyphs in short form.
15596 GLYPH > 1 or omitted means dump glyphs in long form. */)
15598 Lisp_Object row
, glyphs
;
15600 struct glyph_matrix
*matrix
;
15603 CHECK_NUMBER (row
);
15604 matrix
= XWINDOW (selected_window
)->current_matrix
;
15606 if (vpos
>= 0 && vpos
< matrix
->nrows
)
15607 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
15609 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15614 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
15615 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
15616 GLYPH 0 means don't dump glyphs.
15617 GLYPH 1 means dump glyphs in short form.
15618 GLYPH > 1 or omitted means dump glyphs in long form. */)
15620 Lisp_Object row
, glyphs
;
15622 struct frame
*sf
= SELECTED_FRAME ();
15623 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
15626 CHECK_NUMBER (row
);
15628 if (vpos
>= 0 && vpos
< m
->nrows
)
15629 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
15630 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15635 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
15636 doc
: /* Toggle tracing of redisplay.
15637 With ARG, turn tracing on if and only if ARG is positive. */)
15642 trace_redisplay_p
= !trace_redisplay_p
;
15645 arg
= Fprefix_numeric_value (arg
);
15646 trace_redisplay_p
= XINT (arg
) > 0;
15653 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
15654 doc
: /* Like `format', but print result to stderr.
15655 usage: (trace-to-stderr STRING &rest OBJECTS) */)
15660 Lisp_Object s
= Fformat (nargs
, args
);
15661 fprintf (stderr
, "%s", SDATA (s
));
15665 #endif /* GLYPH_DEBUG */
15669 /***********************************************************************
15670 Building Desired Matrix Rows
15671 ***********************************************************************/
15673 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
15674 Used for non-window-redisplay windows, and for windows w/o left fringe. */
15676 static struct glyph_row
*
15677 get_overlay_arrow_glyph_row (w
, overlay_arrow_string
)
15679 Lisp_Object overlay_arrow_string
;
15681 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
15682 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15683 struct buffer
*old
= current_buffer
;
15684 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
15685 int arrow_len
= SCHARS (overlay_arrow_string
);
15686 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
15687 const unsigned char *p
;
15690 int n_glyphs_before
;
15692 set_buffer_temp (buffer
);
15693 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
15694 it
.glyph_row
->used
[TEXT_AREA
] = 0;
15695 SET_TEXT_POS (it
.position
, 0, 0);
15697 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
15699 while (p
< arrow_end
)
15701 Lisp_Object face
, ilisp
;
15703 /* Get the next character. */
15705 it
.c
= string_char_and_length (p
, arrow_len
, &it
.len
);
15707 it
.c
= *p
, it
.len
= 1;
15710 /* Get its face. */
15711 ilisp
= make_number (p
- arrow_string
);
15712 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
15713 it
.face_id
= compute_char_face (f
, it
.c
, face
);
15715 /* Compute its width, get its glyphs. */
15716 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
15717 SET_TEXT_POS (it
.position
, -1, -1);
15718 PRODUCE_GLYPHS (&it
);
15720 /* If this character doesn't fit any more in the line, we have
15721 to remove some glyphs. */
15722 if (it
.current_x
> it
.last_visible_x
)
15724 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
15729 set_buffer_temp (old
);
15730 return it
.glyph_row
;
15734 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
15735 glyphs are only inserted for terminal frames since we can't really
15736 win with truncation glyphs when partially visible glyphs are
15737 involved. Which glyphs to insert is determined by
15738 produce_special_glyphs. */
15741 insert_left_trunc_glyphs (it
)
15744 struct it truncate_it
;
15745 struct glyph
*from
, *end
, *to
, *toend
;
15747 xassert (!FRAME_WINDOW_P (it
->f
));
15749 /* Get the truncation glyphs. */
15751 truncate_it
.current_x
= 0;
15752 truncate_it
.face_id
= DEFAULT_FACE_ID
;
15753 truncate_it
.glyph_row
= &scratch_glyph_row
;
15754 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
15755 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
15756 truncate_it
.object
= make_number (0);
15757 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
15759 /* Overwrite glyphs from IT with truncation glyphs. */
15760 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15761 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
15762 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
15763 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
15768 /* There may be padding glyphs left over. Overwrite them too. */
15769 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
15771 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15777 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
15781 /* Compute the pixel height and width of IT->glyph_row.
15783 Most of the time, ascent and height of a display line will be equal
15784 to the max_ascent and max_height values of the display iterator
15785 structure. This is not the case if
15787 1. We hit ZV without displaying anything. In this case, max_ascent
15788 and max_height will be zero.
15790 2. We have some glyphs that don't contribute to the line height.
15791 (The glyph row flag contributes_to_line_height_p is for future
15792 pixmap extensions).
15794 The first case is easily covered by using default values because in
15795 these cases, the line height does not really matter, except that it
15796 must not be zero. */
15799 compute_line_metrics (it
)
15802 struct glyph_row
*row
= it
->glyph_row
;
15805 if (FRAME_WINDOW_P (it
->f
))
15807 int i
, min_y
, max_y
;
15809 /* The line may consist of one space only, that was added to
15810 place the cursor on it. If so, the row's height hasn't been
15812 if (row
->height
== 0)
15814 if (it
->max_ascent
+ it
->max_descent
== 0)
15815 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
15816 row
->ascent
= it
->max_ascent
;
15817 row
->height
= it
->max_ascent
+ it
->max_descent
;
15818 row
->phys_ascent
= it
->max_phys_ascent
;
15819 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
15820 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
15823 /* Compute the width of this line. */
15824 row
->pixel_width
= row
->x
;
15825 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
15826 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
15828 xassert (row
->pixel_width
>= 0);
15829 xassert (row
->ascent
>= 0 && row
->height
> 0);
15831 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
15832 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
15834 /* If first line's physical ascent is larger than its logical
15835 ascent, use the physical ascent, and make the row taller.
15836 This makes accented characters fully visible. */
15837 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
15838 && row
->phys_ascent
> row
->ascent
)
15840 row
->height
+= row
->phys_ascent
- row
->ascent
;
15841 row
->ascent
= row
->phys_ascent
;
15844 /* Compute how much of the line is visible. */
15845 row
->visible_height
= row
->height
;
15847 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
15848 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
15850 if (row
->y
< min_y
)
15851 row
->visible_height
-= min_y
- row
->y
;
15852 if (row
->y
+ row
->height
> max_y
)
15853 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15857 row
->pixel_width
= row
->used
[TEXT_AREA
];
15858 if (row
->continued_p
)
15859 row
->pixel_width
-= it
->continuation_pixel_width
;
15860 else if (row
->truncated_on_right_p
)
15861 row
->pixel_width
-= it
->truncation_pixel_width
;
15862 row
->ascent
= row
->phys_ascent
= 0;
15863 row
->height
= row
->phys_height
= row
->visible_height
= 1;
15864 row
->extra_line_spacing
= 0;
15867 /* Compute a hash code for this row. */
15869 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15870 for (i
= 0; i
< row
->used
[area
]; ++i
)
15871 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
15872 + row
->glyphs
[area
][i
].u
.val
15873 + row
->glyphs
[area
][i
].face_id
15874 + row
->glyphs
[area
][i
].padding_p
15875 + (row
->glyphs
[area
][i
].type
<< 2));
15877 it
->max_ascent
= it
->max_descent
= 0;
15878 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
15882 /* Append one space to the glyph row of iterator IT if doing a
15883 window-based redisplay. The space has the same face as
15884 IT->face_id. Value is non-zero if a space was added.
15886 This function is called to make sure that there is always one glyph
15887 at the end of a glyph row that the cursor can be set on under
15888 window-systems. (If there weren't such a glyph we would not know
15889 how wide and tall a box cursor should be displayed).
15891 At the same time this space let's a nicely handle clearing to the
15892 end of the line if the row ends in italic text. */
15895 append_space_for_newline (it
, default_face_p
)
15897 int default_face_p
;
15899 if (FRAME_WINDOW_P (it
->f
))
15901 int n
= it
->glyph_row
->used
[TEXT_AREA
];
15903 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
15904 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
15906 /* Save some values that must not be changed.
15907 Must save IT->c and IT->len because otherwise
15908 ITERATOR_AT_END_P wouldn't work anymore after
15909 append_space_for_newline has been called. */
15910 enum display_element_type saved_what
= it
->what
;
15911 int saved_c
= it
->c
, saved_len
= it
->len
;
15912 int saved_x
= it
->current_x
;
15913 int saved_face_id
= it
->face_id
;
15914 struct text_pos saved_pos
;
15915 Lisp_Object saved_object
;
15918 saved_object
= it
->object
;
15919 saved_pos
= it
->position
;
15921 it
->what
= IT_CHARACTER
;
15922 bzero (&it
->position
, sizeof it
->position
);
15923 it
->object
= make_number (0);
15927 if (default_face_p
)
15928 it
->face_id
= DEFAULT_FACE_ID
;
15929 else if (it
->face_before_selective_p
)
15930 it
->face_id
= it
->saved_face_id
;
15931 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
15932 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
15934 PRODUCE_GLYPHS (it
);
15936 it
->override_ascent
= -1;
15937 it
->constrain_row_ascent_descent_p
= 0;
15938 it
->current_x
= saved_x
;
15939 it
->object
= saved_object
;
15940 it
->position
= saved_pos
;
15941 it
->what
= saved_what
;
15942 it
->face_id
= saved_face_id
;
15943 it
->len
= saved_len
;
15953 /* Extend the face of the last glyph in the text area of IT->glyph_row
15954 to the end of the display line. Called from display_line.
15955 If the glyph row is empty, add a space glyph to it so that we
15956 know the face to draw. Set the glyph row flag fill_line_p. */
15959 extend_face_to_end_of_line (it
)
15963 struct frame
*f
= it
->f
;
15965 /* If line is already filled, do nothing. */
15966 if (it
->current_x
>= it
->last_visible_x
)
15969 /* Face extension extends the background and box of IT->face_id
15970 to the end of the line. If the background equals the background
15971 of the frame, we don't have to do anything. */
15972 if (it
->face_before_selective_p
)
15973 face
= FACE_FROM_ID (it
->f
, it
->saved_face_id
);
15975 face
= FACE_FROM_ID (f
, it
->face_id
);
15977 if (FRAME_WINDOW_P (f
)
15978 && it
->glyph_row
->displays_text_p
15979 && face
->box
== FACE_NO_BOX
15980 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
15984 /* Set the glyph row flag indicating that the face of the last glyph
15985 in the text area has to be drawn to the end of the text area. */
15986 it
->glyph_row
->fill_line_p
= 1;
15988 /* If current character of IT is not ASCII, make sure we have the
15989 ASCII face. This will be automatically undone the next time
15990 get_next_display_element returns a multibyte character. Note
15991 that the character will always be single byte in unibyte text. */
15992 if (!ASCII_CHAR_P (it
->c
))
15994 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
15997 if (FRAME_WINDOW_P (f
))
15999 /* If the row is empty, add a space with the current face of IT,
16000 so that we know which face to draw. */
16001 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16003 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16004 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16005 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16010 /* Save some values that must not be changed. */
16011 int saved_x
= it
->current_x
;
16012 struct text_pos saved_pos
;
16013 Lisp_Object saved_object
;
16014 enum display_element_type saved_what
= it
->what
;
16015 int saved_face_id
= it
->face_id
;
16017 saved_object
= it
->object
;
16018 saved_pos
= it
->position
;
16020 it
->what
= IT_CHARACTER
;
16021 bzero (&it
->position
, sizeof it
->position
);
16022 it
->object
= make_number (0);
16025 it
->face_id
= face
->id
;
16027 PRODUCE_GLYPHS (it
);
16029 while (it
->current_x
<= it
->last_visible_x
)
16030 PRODUCE_GLYPHS (it
);
16032 /* Don't count these blanks really. It would let us insert a left
16033 truncation glyph below and make us set the cursor on them, maybe. */
16034 it
->current_x
= saved_x
;
16035 it
->object
= saved_object
;
16036 it
->position
= saved_pos
;
16037 it
->what
= saved_what
;
16038 it
->face_id
= saved_face_id
;
16043 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16044 trailing whitespace. */
16047 trailing_whitespace_p (charpos
)
16050 int bytepos
= CHAR_TO_BYTE (charpos
);
16053 while (bytepos
< ZV_BYTE
16054 && (c
= FETCH_CHAR (bytepos
),
16055 c
== ' ' || c
== '\t'))
16058 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16060 if (bytepos
!= PT_BYTE
)
16067 /* Highlight trailing whitespace, if any, in ROW. */
16070 highlight_trailing_whitespace (f
, row
)
16072 struct glyph_row
*row
;
16074 int used
= row
->used
[TEXT_AREA
];
16078 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16079 struct glyph
*glyph
= start
+ used
- 1;
16081 /* Skip over glyphs inserted to display the cursor at the
16082 end of a line, for extending the face of the last glyph
16083 to the end of the line on terminals, and for truncation
16084 and continuation glyphs. */
16085 while (glyph
>= start
16086 && glyph
->type
== CHAR_GLYPH
16087 && INTEGERP (glyph
->object
))
16090 /* If last glyph is a space or stretch, and it's trailing
16091 whitespace, set the face of all trailing whitespace glyphs in
16092 IT->glyph_row to `trailing-whitespace'. */
16094 && BUFFERP (glyph
->object
)
16095 && (glyph
->type
== STRETCH_GLYPH
16096 || (glyph
->type
== CHAR_GLYPH
16097 && glyph
->u
.ch
== ' '))
16098 && trailing_whitespace_p (glyph
->charpos
))
16100 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
16104 while (glyph
>= start
16105 && BUFFERP (glyph
->object
)
16106 && (glyph
->type
== STRETCH_GLYPH
16107 || (glyph
->type
== CHAR_GLYPH
16108 && glyph
->u
.ch
== ' ')))
16109 (glyph
--)->face_id
= face_id
;
16115 /* Value is non-zero if glyph row ROW in window W should be
16116 used to hold the cursor. */
16119 cursor_row_p (w
, row
)
16121 struct glyph_row
*row
;
16123 int cursor_row_p
= 1;
16125 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
16127 /* Suppose the row ends on a string.
16128 Unless the row is continued, that means it ends on a newline
16129 in the string. If it's anything other than a display string
16130 (e.g. a before-string from an overlay), we don't want the
16131 cursor there. (This heuristic seems to give the optimal
16132 behavior for the various types of multi-line strings.) */
16133 if (CHARPOS (row
->end
.string_pos
) >= 0)
16135 if (row
->continued_p
)
16139 /* Check for `display' property. */
16140 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
16141 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
16142 struct glyph
*glyph
;
16145 for (glyph
= end
; glyph
>= beg
; --glyph
)
16146 if (STRINGP (glyph
->object
))
16149 = Fget_char_property (make_number (PT
),
16153 && display_prop_string_p (prop
, glyph
->object
));
16158 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
16160 /* If the row ends in middle of a real character,
16161 and the line is continued, we want the cursor here.
16162 That's because MATRIX_ROW_END_CHARPOS would equal
16163 PT if PT is before the character. */
16164 if (!row
->ends_in_ellipsis_p
)
16165 cursor_row_p
= row
->continued_p
;
16167 /* If the row ends in an ellipsis, then
16168 MATRIX_ROW_END_CHARPOS will equal point after the invisible text.
16169 We want that position to be displayed after the ellipsis. */
16172 /* If the row ends at ZV, display the cursor at the end of that
16173 row instead of at the start of the row below. */
16174 else if (row
->ends_at_zv_p
)
16180 return cursor_row_p
;
16184 /* Construct the glyph row IT->glyph_row in the desired matrix of
16185 IT->w from text at the current position of IT. See dispextern.h
16186 for an overview of struct it. Value is non-zero if
16187 IT->glyph_row displays text, as opposed to a line displaying ZV
16194 struct glyph_row
*row
= it
->glyph_row
;
16195 Lisp_Object overlay_arrow_string
;
16197 /* We always start displaying at hpos zero even if hscrolled. */
16198 xassert (it
->hpos
== 0 && it
->current_x
== 0);
16200 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
16201 >= it
->w
->desired_matrix
->nrows
)
16203 it
->w
->nrows_scale_factor
++;
16204 fonts_changed_p
= 1;
16208 /* Is IT->w showing the region? */
16209 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
16211 /* Clear the result glyph row and enable it. */
16212 prepare_desired_row (row
);
16214 row
->y
= it
->current_y
;
16215 row
->start
= it
->start
;
16216 row
->continuation_lines_width
= it
->continuation_lines_width
;
16217 row
->displays_text_p
= 1;
16218 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
16219 it
->starts_in_middle_of_char_p
= 0;
16221 /* Arrange the overlays nicely for our purposes. Usually, we call
16222 display_line on only one line at a time, in which case this
16223 can't really hurt too much, or we call it on lines which appear
16224 one after another in the buffer, in which case all calls to
16225 recenter_overlay_lists but the first will be pretty cheap. */
16226 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
16228 /* Move over display elements that are not visible because we are
16229 hscrolled. This may stop at an x-position < IT->first_visible_x
16230 if the first glyph is partially visible or if we hit a line end. */
16231 if (it
->current_x
< it
->first_visible_x
)
16233 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
16234 MOVE_TO_POS
| MOVE_TO_X
);
16237 /* Get the initial row height. This is either the height of the
16238 text hscrolled, if there is any, or zero. */
16239 row
->ascent
= it
->max_ascent
;
16240 row
->height
= it
->max_ascent
+ it
->max_descent
;
16241 row
->phys_ascent
= it
->max_phys_ascent
;
16242 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16243 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16245 /* Loop generating characters. The loop is left with IT on the next
16246 character to display. */
16249 int n_glyphs_before
, hpos_before
, x_before
;
16251 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
16253 /* Retrieve the next thing to display. Value is zero if end of
16255 if (!get_next_display_element (it
))
16257 /* Maybe add a space at the end of this line that is used to
16258 display the cursor there under X. Set the charpos of the
16259 first glyph of blank lines not corresponding to any text
16261 #ifdef HAVE_WINDOW_SYSTEM
16262 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16263 row
->exact_window_width_line_p
= 1;
16265 #endif /* HAVE_WINDOW_SYSTEM */
16266 if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
16267 || row
->used
[TEXT_AREA
] == 0)
16269 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
16270 row
->displays_text_p
= 0;
16272 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
16273 && (!MINI_WINDOW_P (it
->w
)
16274 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
16275 row
->indicate_empty_line_p
= 1;
16278 it
->continuation_lines_width
= 0;
16279 row
->ends_at_zv_p
= 1;
16283 /* Now, get the metrics of what we want to display. This also
16284 generates glyphs in `row' (which is IT->glyph_row). */
16285 n_glyphs_before
= row
->used
[TEXT_AREA
];
16288 /* Remember the line height so far in case the next element doesn't
16289 fit on the line. */
16290 if (!it
->truncate_lines_p
)
16292 ascent
= it
->max_ascent
;
16293 descent
= it
->max_descent
;
16294 phys_ascent
= it
->max_phys_ascent
;
16295 phys_descent
= it
->max_phys_descent
;
16298 PRODUCE_GLYPHS (it
);
16300 /* If this display element was in marginal areas, continue with
16302 if (it
->area
!= TEXT_AREA
)
16304 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16305 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16306 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16307 row
->phys_height
= max (row
->phys_height
,
16308 it
->max_phys_ascent
+ it
->max_phys_descent
);
16309 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16310 it
->max_extra_line_spacing
);
16311 set_iterator_to_next (it
, 1);
16315 /* Does the display element fit on the line? If we truncate
16316 lines, we should draw past the right edge of the window. If
16317 we don't truncate, we want to stop so that we can display the
16318 continuation glyph before the right margin. If lines are
16319 continued, there are two possible strategies for characters
16320 resulting in more than 1 glyph (e.g. tabs): Display as many
16321 glyphs as possible in this line and leave the rest for the
16322 continuation line, or display the whole element in the next
16323 line. Original redisplay did the former, so we do it also. */
16324 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
16325 hpos_before
= it
->hpos
;
16328 if (/* Not a newline. */
16330 /* Glyphs produced fit entirely in the line. */
16331 && it
->current_x
< it
->last_visible_x
)
16333 it
->hpos
+= nglyphs
;
16334 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16335 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16336 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16337 row
->phys_height
= max (row
->phys_height
,
16338 it
->max_phys_ascent
+ it
->max_phys_descent
);
16339 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16340 it
->max_extra_line_spacing
);
16341 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
16342 row
->x
= x
- it
->first_visible_x
;
16347 struct glyph
*glyph
;
16349 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
16351 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
16352 new_x
= x
+ glyph
->pixel_width
;
16354 if (/* Lines are continued. */
16355 !it
->truncate_lines_p
16356 && (/* Glyph doesn't fit on the line. */
16357 new_x
> it
->last_visible_x
16358 /* Or it fits exactly on a window system frame. */
16359 || (new_x
== it
->last_visible_x
16360 && FRAME_WINDOW_P (it
->f
))))
16362 /* End of a continued line. */
16365 || (new_x
== it
->last_visible_x
16366 && FRAME_WINDOW_P (it
->f
)))
16368 /* Current glyph is the only one on the line or
16369 fits exactly on the line. We must continue
16370 the line because we can't draw the cursor
16371 after the glyph. */
16372 row
->continued_p
= 1;
16373 it
->current_x
= new_x
;
16374 it
->continuation_lines_width
+= new_x
;
16376 if (i
== nglyphs
- 1)
16378 set_iterator_to_next (it
, 1);
16379 #ifdef HAVE_WINDOW_SYSTEM
16380 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16382 if (!get_next_display_element (it
))
16384 row
->exact_window_width_line_p
= 1;
16385 it
->continuation_lines_width
= 0;
16386 row
->continued_p
= 0;
16387 row
->ends_at_zv_p
= 1;
16389 else if (ITERATOR_AT_END_OF_LINE_P (it
))
16391 row
->continued_p
= 0;
16392 row
->exact_window_width_line_p
= 1;
16395 #endif /* HAVE_WINDOW_SYSTEM */
16398 else if (CHAR_GLYPH_PADDING_P (*glyph
)
16399 && !FRAME_WINDOW_P (it
->f
))
16401 /* A padding glyph that doesn't fit on this line.
16402 This means the whole character doesn't fit
16404 row
->used
[TEXT_AREA
] = n_glyphs_before
;
16406 /* Fill the rest of the row with continuation
16407 glyphs like in 20.x. */
16408 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
16409 < row
->glyphs
[1 + TEXT_AREA
])
16410 produce_special_glyphs (it
, IT_CONTINUATION
);
16412 row
->continued_p
= 1;
16413 it
->current_x
= x_before
;
16414 it
->continuation_lines_width
+= x_before
;
16416 /* Restore the height to what it was before the
16417 element not fitting on the line. */
16418 it
->max_ascent
= ascent
;
16419 it
->max_descent
= descent
;
16420 it
->max_phys_ascent
= phys_ascent
;
16421 it
->max_phys_descent
= phys_descent
;
16423 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
16425 /* A TAB that extends past the right edge of the
16426 window. This produces a single glyph on
16427 window system frames. We leave the glyph in
16428 this row and let it fill the row, but don't
16429 consume the TAB. */
16430 it
->continuation_lines_width
+= it
->last_visible_x
;
16431 row
->ends_in_middle_of_char_p
= 1;
16432 row
->continued_p
= 1;
16433 glyph
->pixel_width
= it
->last_visible_x
- x
;
16434 it
->starts_in_middle_of_char_p
= 1;
16438 /* Something other than a TAB that draws past
16439 the right edge of the window. Restore
16440 positions to values before the element. */
16441 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
16443 /* Display continuation glyphs. */
16444 if (!FRAME_WINDOW_P (it
->f
))
16445 produce_special_glyphs (it
, IT_CONTINUATION
);
16446 row
->continued_p
= 1;
16448 it
->current_x
= x_before
;
16449 it
->continuation_lines_width
+= x
;
16450 extend_face_to_end_of_line (it
);
16452 if (nglyphs
> 1 && i
> 0)
16454 row
->ends_in_middle_of_char_p
= 1;
16455 it
->starts_in_middle_of_char_p
= 1;
16458 /* Restore the height to what it was before the
16459 element not fitting on the line. */
16460 it
->max_ascent
= ascent
;
16461 it
->max_descent
= descent
;
16462 it
->max_phys_ascent
= phys_ascent
;
16463 it
->max_phys_descent
= phys_descent
;
16468 else if (new_x
> it
->first_visible_x
)
16470 /* Increment number of glyphs actually displayed. */
16473 if (x
< it
->first_visible_x
)
16474 /* Glyph is partially visible, i.e. row starts at
16475 negative X position. */
16476 row
->x
= x
- it
->first_visible_x
;
16480 /* Glyph is completely off the left margin of the
16481 window. This should not happen because of the
16482 move_it_in_display_line at the start of this
16483 function, unless the text display area of the
16484 window is empty. */
16485 xassert (it
->first_visible_x
<= it
->last_visible_x
);
16489 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16490 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16491 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16492 row
->phys_height
= max (row
->phys_height
,
16493 it
->max_phys_ascent
+ it
->max_phys_descent
);
16494 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16495 it
->max_extra_line_spacing
);
16497 /* End of this display line if row is continued. */
16498 if (row
->continued_p
|| row
->ends_at_zv_p
)
16503 /* Is this a line end? If yes, we're also done, after making
16504 sure that a non-default face is extended up to the right
16505 margin of the window. */
16506 if (ITERATOR_AT_END_OF_LINE_P (it
))
16508 int used_before
= row
->used
[TEXT_AREA
];
16510 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
16512 #ifdef HAVE_WINDOW_SYSTEM
16513 /* Add a space at the end of the line that is used to
16514 display the cursor there. */
16515 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16516 append_space_for_newline (it
, 0);
16517 #endif /* HAVE_WINDOW_SYSTEM */
16519 /* Extend the face to the end of the line. */
16520 extend_face_to_end_of_line (it
);
16522 /* Make sure we have the position. */
16523 if (used_before
== 0)
16524 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
16526 /* Consume the line end. This skips over invisible lines. */
16527 set_iterator_to_next (it
, 1);
16528 it
->continuation_lines_width
= 0;
16532 /* Proceed with next display element. Note that this skips
16533 over lines invisible because of selective display. */
16534 set_iterator_to_next (it
, 1);
16536 /* If we truncate lines, we are done when the last displayed
16537 glyphs reach past the right margin of the window. */
16538 if (it
->truncate_lines_p
16539 && (FRAME_WINDOW_P (it
->f
)
16540 ? (it
->current_x
>= it
->last_visible_x
)
16541 : (it
->current_x
> it
->last_visible_x
)))
16543 /* Maybe add truncation glyphs. */
16544 if (!FRAME_WINDOW_P (it
->f
))
16548 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
16549 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
16552 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
16554 row
->used
[TEXT_AREA
] = i
;
16555 produce_special_glyphs (it
, IT_TRUNCATION
);
16558 #ifdef HAVE_WINDOW_SYSTEM
16561 /* Don't truncate if we can overflow newline into fringe. */
16562 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16564 if (!get_next_display_element (it
))
16566 it
->continuation_lines_width
= 0;
16567 row
->ends_at_zv_p
= 1;
16568 row
->exact_window_width_line_p
= 1;
16571 if (ITERATOR_AT_END_OF_LINE_P (it
))
16573 row
->exact_window_width_line_p
= 1;
16574 goto at_end_of_line
;
16578 #endif /* HAVE_WINDOW_SYSTEM */
16580 row
->truncated_on_right_p
= 1;
16581 it
->continuation_lines_width
= 0;
16582 reseat_at_next_visible_line_start (it
, 0);
16583 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
16584 it
->hpos
= hpos_before
;
16585 it
->current_x
= x_before
;
16590 /* If line is not empty and hscrolled, maybe insert truncation glyphs
16591 at the left window margin. */
16592 if (it
->first_visible_x
16593 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
16595 if (!FRAME_WINDOW_P (it
->f
))
16596 insert_left_trunc_glyphs (it
);
16597 row
->truncated_on_left_p
= 1;
16600 /* If the start of this line is the overlay arrow-position, then
16601 mark this glyph row as the one containing the overlay arrow.
16602 This is clearly a mess with variable size fonts. It would be
16603 better to let it be displayed like cursors under X. */
16604 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
16605 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
16606 !NILP (overlay_arrow_string
)))
16608 /* Overlay arrow in window redisplay is a fringe bitmap. */
16609 if (STRINGP (overlay_arrow_string
))
16611 struct glyph_row
*arrow_row
16612 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
16613 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
16614 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
16615 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
16616 struct glyph
*p2
, *end
;
16618 /* Copy the arrow glyphs. */
16619 while (glyph
< arrow_end
)
16622 /* Throw away padding glyphs. */
16624 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16625 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
16631 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
16636 xassert (INTEGERP (overlay_arrow_string
));
16637 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
16639 overlay_arrow_seen
= 1;
16642 /* Compute pixel dimensions of this line. */
16643 compute_line_metrics (it
);
16645 /* Remember the position at which this line ends. */
16646 row
->end
= it
->current
;
16648 /* Record whether this row ends inside an ellipsis. */
16649 row
->ends_in_ellipsis_p
16650 = (it
->method
== GET_FROM_DISPLAY_VECTOR
16651 && it
->ellipsis_p
);
16653 /* Save fringe bitmaps in this row. */
16654 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
16655 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
16656 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
16657 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
16659 it
->left_user_fringe_bitmap
= 0;
16660 it
->left_user_fringe_face_id
= 0;
16661 it
->right_user_fringe_bitmap
= 0;
16662 it
->right_user_fringe_face_id
= 0;
16664 /* Maybe set the cursor. */
16665 if (it
->w
->cursor
.vpos
< 0
16666 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
16667 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
16668 && cursor_row_p (it
->w
, row
))
16669 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
16671 /* Highlight trailing whitespace. */
16672 if (!NILP (Vshow_trailing_whitespace
))
16673 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
16675 /* Prepare for the next line. This line starts horizontally at (X
16676 HPOS) = (0 0). Vertical positions are incremented. As a
16677 convenience for the caller, IT->glyph_row is set to the next
16679 it
->current_x
= it
->hpos
= 0;
16680 it
->current_y
+= row
->height
;
16683 it
->start
= it
->current
;
16684 return row
->displays_text_p
;
16689 /***********************************************************************
16691 ***********************************************************************/
16693 /* Redisplay the menu bar in the frame for window W.
16695 The menu bar of X frames that don't have X toolkit support is
16696 displayed in a special window W->frame->menu_bar_window.
16698 The menu bar of terminal frames is treated specially as far as
16699 glyph matrices are concerned. Menu bar lines are not part of
16700 windows, so the update is done directly on the frame matrix rows
16701 for the menu bar. */
16704 display_menu_bar (w
)
16707 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16712 /* Don't do all this for graphical frames. */
16714 if (FRAME_W32_P (f
))
16717 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
16722 if (FRAME_MAC_P (f
))
16726 #ifdef USE_X_TOOLKIT
16727 xassert (!FRAME_WINDOW_P (f
));
16728 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
16729 it
.first_visible_x
= 0;
16730 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
16731 #else /* not USE_X_TOOLKIT */
16732 if (FRAME_WINDOW_P (f
))
16734 /* Menu bar lines are displayed in the desired matrix of the
16735 dummy window menu_bar_window. */
16736 struct window
*menu_w
;
16737 xassert (WINDOWP (f
->menu_bar_window
));
16738 menu_w
= XWINDOW (f
->menu_bar_window
);
16739 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
16741 it
.first_visible_x
= 0;
16742 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
16746 /* This is a TTY frame, i.e. character hpos/vpos are used as
16748 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
16750 it
.first_visible_x
= 0;
16751 it
.last_visible_x
= FRAME_COLS (f
);
16753 #endif /* not USE_X_TOOLKIT */
16755 if (! mode_line_inverse_video
)
16756 /* Force the menu-bar to be displayed in the default face. */
16757 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
16759 /* Clear all rows of the menu bar. */
16760 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
16762 struct glyph_row
*row
= it
.glyph_row
+ i
;
16763 clear_glyph_row (row
);
16764 row
->enabled_p
= 1;
16765 row
->full_width_p
= 1;
16768 /* Display all items of the menu bar. */
16769 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
16770 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
16772 Lisp_Object string
;
16774 /* Stop at nil string. */
16775 string
= AREF (items
, i
+ 1);
16779 /* Remember where item was displayed. */
16780 ASET (items
, i
+ 3, make_number (it
.hpos
));
16782 /* Display the item, pad with one space. */
16783 if (it
.current_x
< it
.last_visible_x
)
16784 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
16785 SCHARS (string
) + 1, 0, 0, -1);
16788 /* Fill out the line with spaces. */
16789 if (it
.current_x
< it
.last_visible_x
)
16790 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
16792 /* Compute the total height of the lines. */
16793 compute_line_metrics (&it
);
16798 /***********************************************************************
16800 ***********************************************************************/
16802 /* Redisplay mode lines in the window tree whose root is WINDOW. If
16803 FORCE is non-zero, redisplay mode lines unconditionally.
16804 Otherwise, redisplay only mode lines that are garbaged. Value is
16805 the number of windows whose mode lines were redisplayed. */
16808 redisplay_mode_lines (window
, force
)
16809 Lisp_Object window
;
16814 while (!NILP (window
))
16816 struct window
*w
= XWINDOW (window
);
16818 if (WINDOWP (w
->hchild
))
16819 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
16820 else if (WINDOWP (w
->vchild
))
16821 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
16823 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
16824 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
16826 struct text_pos lpoint
;
16827 struct buffer
*old
= current_buffer
;
16829 /* Set the window's buffer for the mode line display. */
16830 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16831 set_buffer_internal_1 (XBUFFER (w
->buffer
));
16833 /* Point refers normally to the selected window. For any
16834 other window, set up appropriate value. */
16835 if (!EQ (window
, selected_window
))
16837 struct text_pos pt
;
16839 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
16840 if (CHARPOS (pt
) < BEGV
)
16841 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16842 else if (CHARPOS (pt
) > (ZV
- 1))
16843 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
16845 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
16848 /* Display mode lines. */
16849 clear_glyph_matrix (w
->desired_matrix
);
16850 if (display_mode_lines (w
))
16853 w
->must_be_updated_p
= 1;
16856 /* Restore old settings. */
16857 set_buffer_internal_1 (old
);
16858 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16868 /* Display the mode and/or top line of window W. Value is the number
16869 of mode lines displayed. */
16872 display_mode_lines (w
)
16875 Lisp_Object old_selected_window
, old_selected_frame
;
16878 old_selected_frame
= selected_frame
;
16879 selected_frame
= w
->frame
;
16880 old_selected_window
= selected_window
;
16881 XSETWINDOW (selected_window
, w
);
16883 /* These will be set while the mode line specs are processed. */
16884 line_number_displayed
= 0;
16885 w
->column_number_displayed
= Qnil
;
16887 if (WINDOW_WANTS_MODELINE_P (w
))
16889 struct window
*sel_w
= XWINDOW (old_selected_window
);
16891 /* Select mode line face based on the real selected window. */
16892 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
16893 current_buffer
->mode_line_format
);
16897 if (WINDOW_WANTS_HEADER_LINE_P (w
))
16899 display_mode_line (w
, HEADER_LINE_FACE_ID
,
16900 current_buffer
->header_line_format
);
16904 selected_frame
= old_selected_frame
;
16905 selected_window
= old_selected_window
;
16910 /* Display mode or top line of window W. FACE_ID specifies which line
16911 to display; it is either MODE_LINE_FACE_ID or HEADER_LINE_FACE_ID.
16912 FORMAT is the mode line format to display. Value is the pixel
16913 height of the mode line displayed. */
16916 display_mode_line (w
, face_id
, format
)
16918 enum face_id face_id
;
16919 Lisp_Object format
;
16923 int count
= SPECPDL_INDEX ();
16925 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
16926 /* Don't extend on a previously drawn mode-line.
16927 This may happen if called from pos_visible_p. */
16928 it
.glyph_row
->enabled_p
= 0;
16929 prepare_desired_row (it
.glyph_row
);
16931 it
.glyph_row
->mode_line_p
= 1;
16933 if (! mode_line_inverse_video
)
16934 /* Force the mode-line to be displayed in the default face. */
16935 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
16937 record_unwind_protect (unwind_format_mode_line
,
16938 format_mode_line_unwind_data (NULL
, Qnil
, 0));
16940 mode_line_target
= MODE_LINE_DISPLAY
;
16942 /* Temporarily make frame's keyboard the current kboard so that
16943 kboard-local variables in the mode_line_format will get the right
16945 push_kboard (FRAME_KBOARD (it
.f
));
16946 record_unwind_save_match_data ();
16947 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
16950 unbind_to (count
, Qnil
);
16952 /* Fill up with spaces. */
16953 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
16955 compute_line_metrics (&it
);
16956 it
.glyph_row
->full_width_p
= 1;
16957 it
.glyph_row
->continued_p
= 0;
16958 it
.glyph_row
->truncated_on_left_p
= 0;
16959 it
.glyph_row
->truncated_on_right_p
= 0;
16961 /* Make a 3D mode-line have a shadow at its right end. */
16962 face
= FACE_FROM_ID (it
.f
, face_id
);
16963 extend_face_to_end_of_line (&it
);
16964 if (face
->box
!= FACE_NO_BOX
)
16966 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
16967 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
16968 last
->right_box_line_p
= 1;
16971 return it
.glyph_row
->height
;
16974 /* Move element ELT in LIST to the front of LIST.
16975 Return the updated list. */
16978 move_elt_to_front (elt
, list
)
16979 Lisp_Object elt
, list
;
16981 register Lisp_Object tail
, prev
;
16982 register Lisp_Object tem
;
16986 while (CONSP (tail
))
16992 /* Splice out the link TAIL. */
16994 list
= XCDR (tail
);
16996 Fsetcdr (prev
, XCDR (tail
));
16998 /* Now make it the first. */
16999 Fsetcdr (tail
, list
);
17004 tail
= XCDR (tail
);
17008 /* Not found--return unchanged LIST. */
17012 /* Contribute ELT to the mode line for window IT->w. How it
17013 translates into text depends on its data type.
17015 IT describes the display environment in which we display, as usual.
17017 DEPTH is the depth in recursion. It is used to prevent
17018 infinite recursion here.
17020 FIELD_WIDTH is the number of characters the display of ELT should
17021 occupy in the mode line, and PRECISION is the maximum number of
17022 characters to display from ELT's representation. See
17023 display_string for details.
17025 Returns the hpos of the end of the text generated by ELT.
17027 PROPS is a property list to add to any string we encounter.
17029 If RISKY is nonzero, remove (disregard) any properties in any string
17030 we encounter, and ignore :eval and :propertize.
17032 The global variable `mode_line_target' determines whether the
17033 output is passed to `store_mode_line_noprop',
17034 `store_mode_line_string', or `display_string'. */
17037 display_mode_element (it
, depth
, field_width
, precision
, elt
, props
, risky
)
17040 int field_width
, precision
;
17041 Lisp_Object elt
, props
;
17044 int n
= 0, field
, prec
;
17049 elt
= build_string ("*too-deep*");
17053 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
17057 /* A string: output it and check for %-constructs within it. */
17061 if (SCHARS (elt
) > 0
17062 && (!NILP (props
) || risky
))
17064 Lisp_Object oprops
, aelt
;
17065 oprops
= Ftext_properties_at (make_number (0), elt
);
17067 /* If the starting string's properties are not what
17068 we want, translate the string. Also, if the string
17069 is risky, do that anyway. */
17071 if (NILP (Fequal (props
, oprops
)) || risky
)
17073 /* If the starting string has properties,
17074 merge the specified ones onto the existing ones. */
17075 if (! NILP (oprops
) && !risky
)
17079 oprops
= Fcopy_sequence (oprops
);
17081 while (CONSP (tem
))
17083 oprops
= Fplist_put (oprops
, XCAR (tem
),
17084 XCAR (XCDR (tem
)));
17085 tem
= XCDR (XCDR (tem
));
17090 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
17091 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
17093 /* AELT is what we want. Move it to the front
17094 without consing. */
17096 mode_line_proptrans_alist
17097 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
17103 /* If AELT has the wrong props, it is useless.
17104 so get rid of it. */
17106 mode_line_proptrans_alist
17107 = Fdelq (aelt
, mode_line_proptrans_alist
);
17109 elt
= Fcopy_sequence (elt
);
17110 Fset_text_properties (make_number (0), Flength (elt
),
17112 /* Add this item to mode_line_proptrans_alist. */
17113 mode_line_proptrans_alist
17114 = Fcons (Fcons (elt
, props
),
17115 mode_line_proptrans_alist
);
17116 /* Truncate mode_line_proptrans_alist
17117 to at most 50 elements. */
17118 tem
= Fnthcdr (make_number (50),
17119 mode_line_proptrans_alist
);
17121 XSETCDR (tem
, Qnil
);
17130 prec
= precision
- n
;
17131 switch (mode_line_target
)
17133 case MODE_LINE_NOPROP
:
17134 case MODE_LINE_TITLE
:
17135 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
17137 case MODE_LINE_STRING
:
17138 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
17140 case MODE_LINE_DISPLAY
:
17141 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
17142 0, prec
, 0, STRING_MULTIBYTE (elt
));
17149 /* Handle the non-literal case. */
17151 while ((precision
<= 0 || n
< precision
)
17152 && SREF (elt
, offset
) != 0
17153 && (mode_line_target
!= MODE_LINE_DISPLAY
17154 || it
->current_x
< it
->last_visible_x
))
17156 int last_offset
= offset
;
17158 /* Advance to end of string or next format specifier. */
17159 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
17162 if (offset
- 1 != last_offset
)
17164 int nchars
, nbytes
;
17166 /* Output to end of string or up to '%'. Field width
17167 is length of string. Don't output more than
17168 PRECISION allows us. */
17171 prec
= c_string_width (SDATA (elt
) + last_offset
,
17172 offset
- last_offset
, precision
- n
,
17175 switch (mode_line_target
)
17177 case MODE_LINE_NOPROP
:
17178 case MODE_LINE_TITLE
:
17179 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
17181 case MODE_LINE_STRING
:
17183 int bytepos
= last_offset
;
17184 int charpos
= string_byte_to_char (elt
, bytepos
);
17185 int endpos
= (precision
<= 0
17186 ? string_byte_to_char (elt
, offset
)
17187 : charpos
+ nchars
);
17189 n
+= store_mode_line_string (NULL
,
17190 Fsubstring (elt
, make_number (charpos
),
17191 make_number (endpos
)),
17195 case MODE_LINE_DISPLAY
:
17197 int bytepos
= last_offset
;
17198 int charpos
= string_byte_to_char (elt
, bytepos
);
17200 if (precision
<= 0)
17201 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
17202 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
17204 STRING_MULTIBYTE (elt
));
17209 else /* c == '%' */
17211 int percent_position
= offset
;
17213 /* Get the specified minimum width. Zero means
17216 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
17217 field
= field
* 10 + c
- '0';
17219 /* Don't pad beyond the total padding allowed. */
17220 if (field_width
- n
> 0 && field
> field_width
- n
)
17221 field
= field_width
- n
;
17223 /* Note that either PRECISION <= 0 or N < PRECISION. */
17224 prec
= precision
- n
;
17227 n
+= display_mode_element (it
, depth
, field
, prec
,
17228 Vglobal_mode_string
, props
,
17233 int bytepos
, charpos
;
17234 unsigned char *spec
;
17236 bytepos
= percent_position
;
17237 charpos
= (STRING_MULTIBYTE (elt
)
17238 ? string_byte_to_char (elt
, bytepos
)
17241 = decode_mode_spec (it
->w
, c
, field
, prec
, &multibyte
);
17243 switch (mode_line_target
)
17245 case MODE_LINE_NOPROP
:
17246 case MODE_LINE_TITLE
:
17247 n
+= store_mode_line_noprop (spec
, field
, prec
);
17249 case MODE_LINE_STRING
:
17251 int len
= strlen (spec
);
17252 Lisp_Object tem
= make_string (spec
, len
);
17253 props
= Ftext_properties_at (make_number (charpos
), elt
);
17254 /* Should only keep face property in props */
17255 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
17258 case MODE_LINE_DISPLAY
:
17260 int nglyphs_before
, nwritten
;
17262 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
17263 nwritten
= display_string (spec
, Qnil
, elt
,
17268 /* Assign to the glyphs written above the
17269 string where the `%x' came from, position
17273 struct glyph
*glyph
17274 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
17278 for (i
= 0; i
< nwritten
; ++i
)
17280 glyph
[i
].object
= elt
;
17281 glyph
[i
].charpos
= charpos
;
17298 /* A symbol: process the value of the symbol recursively
17299 as if it appeared here directly. Avoid error if symbol void.
17300 Special case: if value of symbol is a string, output the string
17303 register Lisp_Object tem
;
17305 /* If the variable is not marked as risky to set
17306 then its contents are risky to use. */
17307 if (NILP (Fget (elt
, Qrisky_local_variable
)))
17310 tem
= Fboundp (elt
);
17313 tem
= Fsymbol_value (elt
);
17314 /* If value is a string, output that string literally:
17315 don't check for % within it. */
17319 if (!EQ (tem
, elt
))
17321 /* Give up right away for nil or t. */
17331 register Lisp_Object car
, tem
;
17333 /* A cons cell: five distinct cases.
17334 If first element is :eval or :propertize, do something special.
17335 If first element is a string or a cons, process all the elements
17336 and effectively concatenate them.
17337 If first element is a negative number, truncate displaying cdr to
17338 at most that many characters. If positive, pad (with spaces)
17339 to at least that many characters.
17340 If first element is a symbol, process the cadr or caddr recursively
17341 according to whether the symbol's value is non-nil or nil. */
17343 if (EQ (car
, QCeval
))
17345 /* An element of the form (:eval FORM) means evaluate FORM
17346 and use the result as mode line elements. */
17351 if (CONSP (XCDR (elt
)))
17354 spec
= safe_eval (XCAR (XCDR (elt
)));
17355 n
+= display_mode_element (it
, depth
, field_width
- n
,
17356 precision
- n
, spec
, props
,
17360 else if (EQ (car
, QCpropertize
))
17362 /* An element of the form (:propertize ELT PROPS...)
17363 means display ELT but applying properties PROPS. */
17368 if (CONSP (XCDR (elt
)))
17369 n
+= display_mode_element (it
, depth
, field_width
- n
,
17370 precision
- n
, XCAR (XCDR (elt
)),
17371 XCDR (XCDR (elt
)), risky
);
17373 else if (SYMBOLP (car
))
17375 tem
= Fboundp (car
);
17379 /* elt is now the cdr, and we know it is a cons cell.
17380 Use its car if CAR has a non-nil value. */
17383 tem
= Fsymbol_value (car
);
17390 /* Symbol's value is nil (or symbol is unbound)
17391 Get the cddr of the original list
17392 and if possible find the caddr and use that. */
17396 else if (!CONSP (elt
))
17401 else if (INTEGERP (car
))
17403 register int lim
= XINT (car
);
17407 /* Negative int means reduce maximum width. */
17408 if (precision
<= 0)
17411 precision
= min (precision
, -lim
);
17415 /* Padding specified. Don't let it be more than
17416 current maximum. */
17418 lim
= min (precision
, lim
);
17420 /* If that's more padding than already wanted, queue it.
17421 But don't reduce padding already specified even if
17422 that is beyond the current truncation point. */
17423 field_width
= max (lim
, field_width
);
17427 else if (STRINGP (car
) || CONSP (car
))
17429 register int limit
= 50;
17430 /* Limit is to protect against circular lists. */
17433 && (precision
<= 0 || n
< precision
))
17435 n
+= display_mode_element (it
, depth
,
17436 /* Do padding only after the last
17437 element in the list. */
17438 (! CONSP (XCDR (elt
))
17441 precision
- n
, XCAR (elt
),
17451 elt
= build_string ("*invalid*");
17455 /* Pad to FIELD_WIDTH. */
17456 if (field_width
> 0 && n
< field_width
)
17458 switch (mode_line_target
)
17460 case MODE_LINE_NOPROP
:
17461 case MODE_LINE_TITLE
:
17462 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
17464 case MODE_LINE_STRING
:
17465 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
17467 case MODE_LINE_DISPLAY
:
17468 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
17477 /* Store a mode-line string element in mode_line_string_list.
17479 If STRING is non-null, display that C string. Otherwise, the Lisp
17480 string LISP_STRING is displayed.
17482 FIELD_WIDTH is the minimum number of output glyphs to produce.
17483 If STRING has fewer characters than FIELD_WIDTH, pad to the right
17484 with spaces. FIELD_WIDTH <= 0 means don't pad.
17486 PRECISION is the maximum number of characters to output from
17487 STRING. PRECISION <= 0 means don't truncate the string.
17489 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
17490 properties to the string.
17492 PROPS are the properties to add to the string.
17493 The mode_line_string_face face property is always added to the string.
17497 store_mode_line_string (string
, lisp_string
, copy_string
, field_width
, precision
, props
)
17499 Lisp_Object lisp_string
;
17508 if (string
!= NULL
)
17510 len
= strlen (string
);
17511 if (precision
> 0 && len
> precision
)
17513 lisp_string
= make_string (string
, len
);
17515 props
= mode_line_string_face_prop
;
17516 else if (!NILP (mode_line_string_face
))
17518 Lisp_Object face
= Fplist_get (props
, Qface
);
17519 props
= Fcopy_sequence (props
);
17521 face
= mode_line_string_face
;
17523 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17524 props
= Fplist_put (props
, Qface
, face
);
17526 Fadd_text_properties (make_number (0), make_number (len
),
17527 props
, lisp_string
);
17531 len
= XFASTINT (Flength (lisp_string
));
17532 if (precision
> 0 && len
> precision
)
17535 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
17538 if (!NILP (mode_line_string_face
))
17542 props
= Ftext_properties_at (make_number (0), lisp_string
);
17543 face
= Fplist_get (props
, Qface
);
17545 face
= mode_line_string_face
;
17547 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17548 props
= Fcons (Qface
, Fcons (face
, Qnil
));
17550 lisp_string
= Fcopy_sequence (lisp_string
);
17553 Fadd_text_properties (make_number (0), make_number (len
),
17554 props
, lisp_string
);
17559 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17563 if (field_width
> len
)
17565 field_width
-= len
;
17566 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
17568 Fadd_text_properties (make_number (0), make_number (field_width
),
17569 props
, lisp_string
);
17570 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17578 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
17580 doc
: /* Format a string out of a mode line format specification.
17581 First arg FORMAT specifies the mode line format (see `mode-line-format'
17582 for details) to use.
17584 Optional second arg FACE specifies the face property to put
17585 on all characters for which no face is specified.
17586 The value t means whatever face the window's mode line currently uses
17587 \(either `mode-line' or `mode-line-inactive', depending).
17588 A value of nil means the default is no face property.
17589 If FACE is an integer, the value string has no text properties.
17591 Optional third and fourth args WINDOW and BUFFER specify the window
17592 and buffer to use as the context for the formatting (defaults
17593 are the selected window and the window's buffer). */)
17594 (format
, face
, window
, buffer
)
17595 Lisp_Object format
, face
, window
, buffer
;
17600 struct buffer
*old_buffer
= NULL
;
17602 int no_props
= INTEGERP (face
);
17603 int count
= SPECPDL_INDEX ();
17605 int string_start
= 0;
17608 window
= selected_window
;
17609 CHECK_WINDOW (window
);
17610 w
= XWINDOW (window
);
17613 buffer
= w
->buffer
;
17614 CHECK_BUFFER (buffer
);
17616 /* Make formatting the modeline a non-op when noninteractive, otherwise
17617 there will be problems later caused by a partially initialized frame. */
17618 if (NILP (format
) || noninteractive
)
17619 return empty_unibyte_string
;
17627 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
17628 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0);
17632 face_id
= DEFAULT_FACE_ID
;
17634 if (XBUFFER (buffer
) != current_buffer
)
17635 old_buffer
= current_buffer
;
17637 /* Save things including mode_line_proptrans_alist,
17638 and set that to nil so that we don't alter the outer value. */
17639 record_unwind_protect (unwind_format_mode_line
,
17640 format_mode_line_unwind_data
17641 (old_buffer
, selected_window
, 1));
17642 mode_line_proptrans_alist
= Qnil
;
17644 Fselect_window (window
, Qt
);
17646 set_buffer_internal_1 (XBUFFER (buffer
));
17648 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
17652 mode_line_target
= MODE_LINE_NOPROP
;
17653 mode_line_string_face_prop
= Qnil
;
17654 mode_line_string_list
= Qnil
;
17655 string_start
= MODE_LINE_NOPROP_LEN (0);
17659 mode_line_target
= MODE_LINE_STRING
;
17660 mode_line_string_list
= Qnil
;
17661 mode_line_string_face
= face
;
17662 mode_line_string_face_prop
17663 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
17666 push_kboard (FRAME_KBOARD (it
.f
));
17667 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
17672 len
= MODE_LINE_NOPROP_LEN (string_start
);
17673 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
17677 mode_line_string_list
= Fnreverse (mode_line_string_list
);
17678 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
17679 empty_unibyte_string
);
17682 unbind_to (count
, Qnil
);
17686 /* Write a null-terminated, right justified decimal representation of
17687 the positive integer D to BUF using a minimal field width WIDTH. */
17690 pint2str (buf
, width
, d
)
17691 register char *buf
;
17692 register int width
;
17695 register char *p
= buf
;
17703 *p
++ = d
% 10 + '0';
17708 for (width
-= (int) (p
- buf
); width
> 0; --width
)
17719 /* Write a null-terminated, right justified decimal and "human
17720 readable" representation of the nonnegative integer D to BUF using
17721 a minimal field width WIDTH. D should be smaller than 999.5e24. */
17723 static const char power_letter
[] =
17737 pint2hrstr (buf
, width
, d
)
17742 /* We aim to represent the nonnegative integer D as
17743 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
17746 /* -1 means: do not use TENTHS. */
17750 /* Length of QUOTIENT.TENTHS as a string. */
17756 if (1000 <= quotient
)
17758 /* Scale to the appropriate EXPONENT. */
17761 remainder
= quotient
% 1000;
17765 while (1000 <= quotient
);
17767 /* Round to nearest and decide whether to use TENTHS or not. */
17770 tenths
= remainder
/ 100;
17771 if (50 <= remainder
% 100)
17778 if (quotient
== 10)
17786 if (500 <= remainder
)
17788 if (quotient
< 999)
17799 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
17800 if (tenths
== -1 && quotient
<= 99)
17807 p
= psuffix
= buf
+ max (width
, length
);
17809 /* Print EXPONENT. */
17811 *psuffix
++ = power_letter
[exponent
];
17814 /* Print TENTHS. */
17817 *--p
= '0' + tenths
;
17821 /* Print QUOTIENT. */
17824 int digit
= quotient
% 10;
17825 *--p
= '0' + digit
;
17827 while ((quotient
/= 10) != 0);
17829 /* Print leading spaces. */
17834 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
17835 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
17836 type of CODING_SYSTEM. Return updated pointer into BUF. */
17838 static unsigned char invalid_eol_type
[] = "(*invalid*)";
17841 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
17842 Lisp_Object coding_system
;
17843 register char *buf
;
17847 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
17848 const unsigned char *eol_str
;
17850 /* The EOL conversion we are using. */
17851 Lisp_Object eoltype
;
17853 val
= CODING_SYSTEM_SPEC (coding_system
);
17856 if (!VECTORP (val
)) /* Not yet decided. */
17861 eoltype
= eol_mnemonic_undecided
;
17862 /* Don't mention EOL conversion if it isn't decided. */
17867 Lisp_Object eolvalue
;
17869 attrs
= AREF (val
, 0);
17870 eolvalue
= AREF (val
, 2);
17873 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
17877 /* The EOL conversion that is normal on this system. */
17879 if (NILP (eolvalue
)) /* Not yet decided. */
17880 eoltype
= eol_mnemonic_undecided
;
17881 else if (VECTORP (eolvalue
)) /* Not yet decided. */
17882 eoltype
= eol_mnemonic_undecided
;
17883 else /* eolvalue is Qunix, Qdos, or Qmac. */
17884 eoltype
= (EQ (eolvalue
, Qunix
)
17885 ? eol_mnemonic_unix
17886 : (EQ (eolvalue
, Qdos
) == 1
17887 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
17893 /* Mention the EOL conversion if it is not the usual one. */
17894 if (STRINGP (eoltype
))
17896 eol_str
= SDATA (eoltype
);
17897 eol_str_len
= SBYTES (eoltype
);
17899 else if (CHARACTERP (eoltype
))
17901 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
17902 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
17907 eol_str
= invalid_eol_type
;
17908 eol_str_len
= sizeof (invalid_eol_type
) - 1;
17910 bcopy (eol_str
, buf
, eol_str_len
);
17911 buf
+= eol_str_len
;
17917 /* Return a string for the output of a mode line %-spec for window W,
17918 generated by character C. PRECISION >= 0 means don't return a
17919 string longer than that value. FIELD_WIDTH > 0 means pad the
17920 string returned with spaces to that value. Return 1 in *MULTIBYTE
17921 if the result is multibyte text.
17923 Note we operate on the current buffer for most purposes,
17924 the exception being w->base_line_pos. */
17926 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
17929 decode_mode_spec (w
, c
, field_width
, precision
, multibyte
)
17932 int field_width
, precision
;
17936 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17937 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
17938 struct buffer
*b
= current_buffer
;
17946 if (!NILP (b
->read_only
))
17948 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
17953 /* This differs from %* only for a modified read-only buffer. */
17954 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
17956 if (!NILP (b
->read_only
))
17961 /* This differs from %* in ignoring read-only-ness. */
17962 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
17974 if (command_loop_level
> 5)
17976 p
= decode_mode_spec_buf
;
17977 for (i
= 0; i
< command_loop_level
; i
++)
17980 return decode_mode_spec_buf
;
17988 if (command_loop_level
> 5)
17990 p
= decode_mode_spec_buf
;
17991 for (i
= 0; i
< command_loop_level
; i
++)
17994 return decode_mode_spec_buf
;
18001 /* Let lots_of_dashes be a string of infinite length. */
18002 if (mode_line_target
== MODE_LINE_NOPROP
||
18003 mode_line_target
== MODE_LINE_STRING
)
18005 if (field_width
<= 0
18006 || field_width
> sizeof (lots_of_dashes
))
18008 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
18009 decode_mode_spec_buf
[i
] = '-';
18010 decode_mode_spec_buf
[i
] = '\0';
18011 return decode_mode_spec_buf
;
18014 return lots_of_dashes
;
18022 /* %c and %l are ignored in `frame-title-format'.
18023 (In redisplay_internal, the frame title is drawn _before_ the
18024 windows are updated, so the stuff which depends on actual
18025 window contents (such as %l) may fail to render properly, or
18026 even crash emacs.) */
18027 if (mode_line_target
== MODE_LINE_TITLE
)
18031 int col
= (int) current_column (); /* iftc */
18032 w
->column_number_displayed
= make_number (col
);
18033 pint2str (decode_mode_spec_buf
, field_width
, col
);
18034 return decode_mode_spec_buf
;
18038 #ifndef SYSTEM_MALLOC
18040 if (NILP (Vmemory_full
))
18043 return "!MEM FULL! ";
18050 /* %F displays the frame name. */
18051 if (!NILP (f
->title
))
18052 return (char *) SDATA (f
->title
);
18053 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
18054 return (char *) SDATA (f
->name
);
18063 int size
= ZV
- BEGV
;
18064 pint2str (decode_mode_spec_buf
, field_width
, size
);
18065 return decode_mode_spec_buf
;
18070 int size
= ZV
- BEGV
;
18071 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
18072 return decode_mode_spec_buf
;
18077 int startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
18078 int topline
, nlines
, junk
, height
;
18080 /* %c and %l are ignored in `frame-title-format'. */
18081 if (mode_line_target
== MODE_LINE_TITLE
)
18084 startpos
= XMARKER (w
->start
)->charpos
;
18085 startpos_byte
= marker_byte_position (w
->start
);
18086 height
= WINDOW_TOTAL_LINES (w
);
18088 /* If we decided that this buffer isn't suitable for line numbers,
18089 don't forget that too fast. */
18090 if (EQ (w
->base_line_pos
, w
->buffer
))
18092 /* But do forget it, if the window shows a different buffer now. */
18093 else if (BUFFERP (w
->base_line_pos
))
18094 w
->base_line_pos
= Qnil
;
18096 /* If the buffer is very big, don't waste time. */
18097 if (INTEGERP (Vline_number_display_limit
)
18098 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
18100 w
->base_line_pos
= Qnil
;
18101 w
->base_line_number
= Qnil
;
18105 if (INTEGERP (w
->base_line_number
)
18106 && INTEGERP (w
->base_line_pos
)
18107 && XFASTINT (w
->base_line_pos
) <= startpos
)
18109 line
= XFASTINT (w
->base_line_number
);
18110 linepos
= XFASTINT (w
->base_line_pos
);
18111 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
18116 linepos
= BUF_BEGV (b
);
18117 linepos_byte
= BUF_BEGV_BYTE (b
);
18120 /* Count lines from base line to window start position. */
18121 nlines
= display_count_lines (linepos
, linepos_byte
,
18125 topline
= nlines
+ line
;
18127 /* Determine a new base line, if the old one is too close
18128 or too far away, or if we did not have one.
18129 "Too close" means it's plausible a scroll-down would
18130 go back past it. */
18131 if (startpos
== BUF_BEGV (b
))
18133 w
->base_line_number
= make_number (topline
);
18134 w
->base_line_pos
= make_number (BUF_BEGV (b
));
18136 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
18137 || linepos
== BUF_BEGV (b
))
18139 int limit
= BUF_BEGV (b
);
18140 int limit_byte
= BUF_BEGV_BYTE (b
);
18142 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
18144 if (startpos
- distance
> limit
)
18146 limit
= startpos
- distance
;
18147 limit_byte
= CHAR_TO_BYTE (limit
);
18150 nlines
= display_count_lines (startpos
, startpos_byte
,
18152 - (height
* 2 + 30),
18154 /* If we couldn't find the lines we wanted within
18155 line_number_display_limit_width chars per line,
18156 give up on line numbers for this window. */
18157 if (position
== limit_byte
&& limit
== startpos
- distance
)
18159 w
->base_line_pos
= w
->buffer
;
18160 w
->base_line_number
= Qnil
;
18164 w
->base_line_number
= make_number (topline
- nlines
);
18165 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
18168 /* Now count lines from the start pos to point. */
18169 nlines
= display_count_lines (startpos
, startpos_byte
,
18170 PT_BYTE
, PT
, &junk
);
18172 /* Record that we did display the line number. */
18173 line_number_displayed
= 1;
18175 /* Make the string to show. */
18176 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
18177 return decode_mode_spec_buf
;
18180 char* p
= decode_mode_spec_buf
;
18181 int pad
= field_width
- 2;
18187 return decode_mode_spec_buf
;
18193 obj
= b
->mode_name
;
18197 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
18203 int pos
= marker_position (w
->start
);
18204 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
18206 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
18208 if (pos
<= BUF_BEGV (b
))
18213 else if (pos
<= BUF_BEGV (b
))
18217 if (total
> 1000000)
18218 /* Do it differently for a large value, to avoid overflow. */
18219 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
18221 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
18222 /* We can't normally display a 3-digit number,
18223 so get us a 2-digit number that is close. */
18226 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
18227 return decode_mode_spec_buf
;
18231 /* Display percentage of size above the bottom of the screen. */
18234 int toppos
= marker_position (w
->start
);
18235 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
18236 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
18238 if (botpos
>= BUF_ZV (b
))
18240 if (toppos
<= BUF_BEGV (b
))
18247 if (total
> 1000000)
18248 /* Do it differently for a large value, to avoid overflow. */
18249 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
18251 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
18252 /* We can't normally display a 3-digit number,
18253 so get us a 2-digit number that is close. */
18256 if (toppos
<= BUF_BEGV (b
))
18257 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
18259 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
18260 return decode_mode_spec_buf
;
18265 /* status of process */
18266 obj
= Fget_buffer_process (Fcurrent_buffer ());
18268 return "no process";
18269 #ifdef subprocesses
18270 obj
= Fsymbol_name (Fprocess_status (obj
));
18277 val
= call1 (intern ("file-remote-p"), current_buffer
->directory
);
18284 case 't': /* indicate TEXT or BINARY */
18285 #ifdef MODE_LINE_BINARY_TEXT
18286 return MODE_LINE_BINARY_TEXT (b
);
18292 /* coding-system (not including end-of-line format) */
18294 /* coding-system (including end-of-line type) */
18296 int eol_flag
= (c
== 'Z');
18297 char *p
= decode_mode_spec_buf
;
18299 if (! FRAME_WINDOW_P (f
))
18301 /* No need to mention EOL here--the terminal never needs
18302 to do EOL conversion. */
18303 p
= decode_mode_spec_coding (CODING_ID_NAME
18304 (FRAME_KEYBOARD_CODING (f
)->id
),
18306 p
= decode_mode_spec_coding (CODING_ID_NAME
18307 (FRAME_TERMINAL_CODING (f
)->id
),
18310 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
18313 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
18314 #ifdef subprocesses
18315 obj
= Fget_buffer_process (Fcurrent_buffer ());
18316 if (PROCESSP (obj
))
18318 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
18320 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
18323 #endif /* subprocesses */
18326 return decode_mode_spec_buf
;
18332 *multibyte
= STRING_MULTIBYTE (obj
);
18333 return (char *) SDATA (obj
);
18340 /* Count up to COUNT lines starting from START / START_BYTE.
18341 But don't go beyond LIMIT_BYTE.
18342 Return the number of lines thus found (always nonnegative).
18344 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
18347 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
18348 int start
, start_byte
, limit_byte
, count
;
18351 register unsigned char *cursor
;
18352 unsigned char *base
;
18354 register int ceiling
;
18355 register unsigned char *ceiling_addr
;
18356 int orig_count
= count
;
18358 /* If we are not in selective display mode,
18359 check only for newlines. */
18360 int selective_display
= (!NILP (current_buffer
->selective_display
)
18361 && !INTEGERP (current_buffer
->selective_display
));
18365 while (start_byte
< limit_byte
)
18367 ceiling
= BUFFER_CEILING_OF (start_byte
);
18368 ceiling
= min (limit_byte
- 1, ceiling
);
18369 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
18370 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
18373 if (selective_display
)
18374 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
18377 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
18380 if (cursor
!= ceiling_addr
)
18384 start_byte
+= cursor
- base
+ 1;
18385 *byte_pos_ptr
= start_byte
;
18389 if (++cursor
== ceiling_addr
)
18395 start_byte
+= cursor
- base
;
18400 while (start_byte
> limit_byte
)
18402 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
18403 ceiling
= max (limit_byte
, ceiling
);
18404 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
18405 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
18408 if (selective_display
)
18409 while (--cursor
!= ceiling_addr
18410 && *cursor
!= '\n' && *cursor
!= 015)
18413 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
18416 if (cursor
!= ceiling_addr
)
18420 start_byte
+= cursor
- base
+ 1;
18421 *byte_pos_ptr
= start_byte
;
18422 /* When scanning backwards, we should
18423 not count the newline posterior to which we stop. */
18424 return - orig_count
- 1;
18430 /* Here we add 1 to compensate for the last decrement
18431 of CURSOR, which took it past the valid range. */
18432 start_byte
+= cursor
- base
+ 1;
18436 *byte_pos_ptr
= limit_byte
;
18439 return - orig_count
+ count
;
18440 return orig_count
- count
;
18446 /***********************************************************************
18448 ***********************************************************************/
18450 /* Display a NUL-terminated string, starting with index START.
18452 If STRING is non-null, display that C string. Otherwise, the Lisp
18453 string LISP_STRING is displayed.
18455 If FACE_STRING is not nil, FACE_STRING_POS is a position in
18456 FACE_STRING. Display STRING or LISP_STRING with the face at
18457 FACE_STRING_POS in FACE_STRING:
18459 Display the string in the environment given by IT, but use the
18460 standard display table, temporarily.
18462 FIELD_WIDTH is the minimum number of output glyphs to produce.
18463 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18464 with spaces. If STRING has more characters, more than FIELD_WIDTH
18465 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
18467 PRECISION is the maximum number of characters to output from
18468 STRING. PRECISION < 0 means don't truncate the string.
18470 This is roughly equivalent to printf format specifiers:
18472 FIELD_WIDTH PRECISION PRINTF
18473 ----------------------------------------
18479 MULTIBYTE zero means do not display multibyte chars, > 0 means do
18480 display them, and < 0 means obey the current buffer's value of
18481 enable_multibyte_characters.
18483 Value is the number of columns displayed. */
18486 display_string (string
, lisp_string
, face_string
, face_string_pos
,
18487 start
, it
, field_width
, precision
, max_x
, multibyte
)
18488 unsigned char *string
;
18489 Lisp_Object lisp_string
;
18490 Lisp_Object face_string
;
18491 EMACS_INT face_string_pos
;
18494 int field_width
, precision
, max_x
;
18497 int hpos_at_start
= it
->hpos
;
18498 int saved_face_id
= it
->face_id
;
18499 struct glyph_row
*row
= it
->glyph_row
;
18501 /* Initialize the iterator IT for iteration over STRING beginning
18502 with index START. */
18503 reseat_to_string (it
, string
, lisp_string
, start
,
18504 precision
, field_width
, multibyte
);
18506 /* If displaying STRING, set up the face of the iterator
18507 from LISP_STRING, if that's given. */
18508 if (STRINGP (face_string
))
18514 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
18515 0, it
->region_beg_charpos
,
18516 it
->region_end_charpos
,
18517 &endptr
, it
->base_face_id
, 0);
18518 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18519 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
18522 /* Set max_x to the maximum allowed X position. Don't let it go
18523 beyond the right edge of the window. */
18525 max_x
= it
->last_visible_x
;
18527 max_x
= min (max_x
, it
->last_visible_x
);
18529 /* Skip over display elements that are not visible. because IT->w is
18531 if (it
->current_x
< it
->first_visible_x
)
18532 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
18533 MOVE_TO_POS
| MOVE_TO_X
);
18535 row
->ascent
= it
->max_ascent
;
18536 row
->height
= it
->max_ascent
+ it
->max_descent
;
18537 row
->phys_ascent
= it
->max_phys_ascent
;
18538 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18539 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18541 /* This condition is for the case that we are called with current_x
18542 past last_visible_x. */
18543 while (it
->current_x
< max_x
)
18545 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
18547 /* Get the next display element. */
18548 if (!get_next_display_element (it
))
18551 /* Produce glyphs. */
18552 x_before
= it
->current_x
;
18553 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18554 PRODUCE_GLYPHS (it
);
18556 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
18559 while (i
< nglyphs
)
18561 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18563 if (!it
->truncate_lines_p
18564 && x
+ glyph
->pixel_width
> max_x
)
18566 /* End of continued line or max_x reached. */
18567 if (CHAR_GLYPH_PADDING_P (*glyph
))
18569 /* A wide character is unbreakable. */
18570 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18571 it
->current_x
= x_before
;
18575 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
18580 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
18582 /* Glyph is at least partially visible. */
18584 if (x
< it
->first_visible_x
)
18585 it
->glyph_row
->x
= x
- it
->first_visible_x
;
18589 /* Glyph is off the left margin of the display area.
18590 Should not happen. */
18594 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18595 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18596 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18597 row
->phys_height
= max (row
->phys_height
,
18598 it
->max_phys_ascent
+ it
->max_phys_descent
);
18599 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18600 it
->max_extra_line_spacing
);
18601 x
+= glyph
->pixel_width
;
18605 /* Stop if max_x reached. */
18609 /* Stop at line ends. */
18610 if (ITERATOR_AT_END_OF_LINE_P (it
))
18612 it
->continuation_lines_width
= 0;
18616 set_iterator_to_next (it
, 1);
18618 /* Stop if truncating at the right edge. */
18619 if (it
->truncate_lines_p
18620 && it
->current_x
>= it
->last_visible_x
)
18622 /* Add truncation mark, but don't do it if the line is
18623 truncated at a padding space. */
18624 if (IT_CHARPOS (*it
) < it
->string_nchars
)
18626 if (!FRAME_WINDOW_P (it
->f
))
18630 if (it
->current_x
> it
->last_visible_x
)
18632 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
18633 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18635 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
18637 row
->used
[TEXT_AREA
] = i
;
18638 produce_special_glyphs (it
, IT_TRUNCATION
);
18641 produce_special_glyphs (it
, IT_TRUNCATION
);
18643 it
->glyph_row
->truncated_on_right_p
= 1;
18649 /* Maybe insert a truncation at the left. */
18650 if (it
->first_visible_x
18651 && IT_CHARPOS (*it
) > 0)
18653 if (!FRAME_WINDOW_P (it
->f
))
18654 insert_left_trunc_glyphs (it
);
18655 it
->glyph_row
->truncated_on_left_p
= 1;
18658 it
->face_id
= saved_face_id
;
18660 /* Value is number of columns displayed. */
18661 return it
->hpos
- hpos_at_start
;
18666 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
18667 appears as an element of LIST or as the car of an element of LIST.
18668 If PROPVAL is a list, compare each element against LIST in that
18669 way, and return 1/2 if any element of PROPVAL is found in LIST.
18670 Otherwise return 0. This function cannot quit.
18671 The return value is 2 if the text is invisible but with an ellipsis
18672 and 1 if it's invisible and without an ellipsis. */
18675 invisible_p (propval
, list
)
18676 register Lisp_Object propval
;
18679 register Lisp_Object tail
, proptail
;
18681 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
18683 register Lisp_Object tem
;
18685 if (EQ (propval
, tem
))
18687 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
18688 return NILP (XCDR (tem
)) ? 1 : 2;
18691 if (CONSP (propval
))
18693 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
18695 Lisp_Object propelt
;
18696 propelt
= XCAR (proptail
);
18697 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
18699 register Lisp_Object tem
;
18701 if (EQ (propelt
, tem
))
18703 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
18704 return NILP (XCDR (tem
)) ? 1 : 2;
18712 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
18713 doc
: /* Non-nil if the property makes the text invisible.
18714 POS-OR-PROP can be a marker or number, in which case it is taken to be
18715 a position in the current buffer and the value of the `invisible' property
18716 is checked; or it can be some other value, which is then presumed to be the
18717 value of the `invisible' property of the text of interest.
18718 The non-nil value returned can be t for truly invisible text or something
18719 else if the text is replaced by an ellipsis. */)
18721 Lisp_Object pos_or_prop
;
18724 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
18725 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
18727 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
18728 return (invis
== 0 ? Qnil
18730 : make_number (invis
));
18733 /* Calculate a width or height in pixels from a specification using
18734 the following elements:
18737 NUM - a (fractional) multiple of the default font width/height
18738 (NUM) - specifies exactly NUM pixels
18739 UNIT - a fixed number of pixels, see below.
18740 ELEMENT - size of a display element in pixels, see below.
18741 (NUM . SPEC) - equals NUM * SPEC
18742 (+ SPEC SPEC ...) - add pixel values
18743 (- SPEC SPEC ...) - subtract pixel values
18744 (- SPEC) - negate pixel value
18747 INT or FLOAT - a number constant
18748 SYMBOL - use symbol's (buffer local) variable binding.
18751 in - pixels per inch *)
18752 mm - pixels per 1/1000 meter *)
18753 cm - pixels per 1/100 meter *)
18754 width - width of current font in pixels.
18755 height - height of current font in pixels.
18757 *) using the ratio(s) defined in display-pixels-per-inch.
18761 left-fringe - left fringe width in pixels
18762 right-fringe - right fringe width in pixels
18764 left-margin - left margin width in pixels
18765 right-margin - right margin width in pixels
18767 scroll-bar - scroll-bar area width in pixels
18771 Pixels corresponding to 5 inches:
18774 Total width of non-text areas on left side of window (if scroll-bar is on left):
18775 '(space :width (+ left-fringe left-margin scroll-bar))
18777 Align to first text column (in header line):
18778 '(space :align-to 0)
18780 Align to middle of text area minus half the width of variable `my-image'
18781 containing a loaded image:
18782 '(space :align-to (0.5 . (- text my-image)))
18784 Width of left margin minus width of 1 character in the default font:
18785 '(space :width (- left-margin 1))
18787 Width of left margin minus width of 2 characters in the current font:
18788 '(space :width (- left-margin (2 . width)))
18790 Center 1 character over left-margin (in header line):
18791 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
18793 Different ways to express width of left fringe plus left margin minus one pixel:
18794 '(space :width (- (+ left-fringe left-margin) (1)))
18795 '(space :width (+ left-fringe left-margin (- (1))))
18796 '(space :width (+ left-fringe left-margin (-1)))
18800 #define NUMVAL(X) \
18801 ((INTEGERP (X) || FLOATP (X)) \
18806 calc_pixel_width_or_height (res
, it
, prop
, font
, width_p
, align_to
)
18811 int width_p
, *align_to
;
18815 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
18816 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
18819 return OK_PIXELS (0);
18821 xassert (FRAME_LIVE_P (it
->f
));
18823 if (SYMBOLP (prop
))
18825 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
18827 char *unit
= SDATA (SYMBOL_NAME (prop
));
18829 if (unit
[0] == 'i' && unit
[1] == 'n')
18831 else if (unit
[0] == 'm' && unit
[1] == 'm')
18833 else if (unit
[0] == 'c' && unit
[1] == 'm')
18840 #ifdef HAVE_WINDOW_SYSTEM
18841 if (FRAME_WINDOW_P (it
->f
)
18843 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
18844 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
18846 return OK_PIXELS (ppi
/ pixels
);
18849 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
18850 || (CONSP (Vdisplay_pixels_per_inch
)
18852 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
18853 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
18855 return OK_PIXELS (ppi
/ pixels
);
18861 #ifdef HAVE_WINDOW_SYSTEM
18862 if (EQ (prop
, Qheight
))
18863 return OK_PIXELS (font
? FONT_HEIGHT ((XFontStruct
*)font
) : FRAME_LINE_HEIGHT (it
->f
));
18864 if (EQ (prop
, Qwidth
))
18865 return OK_PIXELS (font
? FONT_WIDTH ((XFontStruct
*)font
) : FRAME_COLUMN_WIDTH (it
->f
));
18867 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
18868 return OK_PIXELS (1);
18871 if (EQ (prop
, Qtext
))
18872 return OK_PIXELS (width_p
18873 ? window_box_width (it
->w
, TEXT_AREA
)
18874 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
18876 if (align_to
&& *align_to
< 0)
18879 if (EQ (prop
, Qleft
))
18880 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
18881 if (EQ (prop
, Qright
))
18882 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
18883 if (EQ (prop
, Qcenter
))
18884 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
18885 + window_box_width (it
->w
, TEXT_AREA
) / 2);
18886 if (EQ (prop
, Qleft_fringe
))
18887 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
18888 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
18889 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
18890 if (EQ (prop
, Qright_fringe
))
18891 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
18892 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
18893 : window_box_right_offset (it
->w
, TEXT_AREA
));
18894 if (EQ (prop
, Qleft_margin
))
18895 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
18896 if (EQ (prop
, Qright_margin
))
18897 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
18898 if (EQ (prop
, Qscroll_bar
))
18899 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
18901 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
18902 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
18903 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
18908 if (EQ (prop
, Qleft_fringe
))
18909 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
18910 if (EQ (prop
, Qright_fringe
))
18911 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
18912 if (EQ (prop
, Qleft_margin
))
18913 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
18914 if (EQ (prop
, Qright_margin
))
18915 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
18916 if (EQ (prop
, Qscroll_bar
))
18917 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
18920 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
18923 if (INTEGERP (prop
) || FLOATP (prop
))
18925 int base_unit
= (width_p
18926 ? FRAME_COLUMN_WIDTH (it
->f
)
18927 : FRAME_LINE_HEIGHT (it
->f
));
18928 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
18933 Lisp_Object car
= XCAR (prop
);
18934 Lisp_Object cdr
= XCDR (prop
);
18938 #ifdef HAVE_WINDOW_SYSTEM
18939 if (FRAME_WINDOW_P (it
->f
)
18940 && valid_image_p (prop
))
18942 int id
= lookup_image (it
->f
, prop
);
18943 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
18945 return OK_PIXELS (width_p
? img
->width
: img
->height
);
18948 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
18954 while (CONSP (cdr
))
18956 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
18957 font
, width_p
, align_to
))
18960 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
18965 if (EQ (car
, Qminus
))
18967 return OK_PIXELS (pixels
);
18970 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
18973 if (INTEGERP (car
) || FLOATP (car
))
18976 pixels
= XFLOATINT (car
);
18978 return OK_PIXELS (pixels
);
18979 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
18980 font
, width_p
, align_to
))
18981 return OK_PIXELS (pixels
* fact
);
18992 /***********************************************************************
18994 ***********************************************************************/
18996 #ifdef HAVE_WINDOW_SYSTEM
19001 dump_glyph_string (s
)
19002 struct glyph_string
*s
;
19004 fprintf (stderr
, "glyph string\n");
19005 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
19006 s
->x
, s
->y
, s
->width
, s
->height
);
19007 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
19008 fprintf (stderr
, " hl = %d\n", s
->hl
);
19009 fprintf (stderr
, " left overhang = %d, right = %d\n",
19010 s
->left_overhang
, s
->right_overhang
);
19011 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
19012 fprintf (stderr
, " extends to end of line = %d\n",
19013 s
->extends_to_end_of_line_p
);
19014 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
19015 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
19018 #endif /* GLYPH_DEBUG */
19020 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
19021 of XChar2b structures for S; it can't be allocated in
19022 init_glyph_string because it must be allocated via `alloca'. W
19023 is the window on which S is drawn. ROW and AREA are the glyph row
19024 and area within the row from which S is constructed. START is the
19025 index of the first glyph structure covered by S. HL is a
19026 face-override for drawing S. */
19029 #define OPTIONAL_HDC(hdc) hdc,
19030 #define DECLARE_HDC(hdc) HDC hdc;
19031 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
19032 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
19035 #ifndef OPTIONAL_HDC
19036 #define OPTIONAL_HDC(hdc)
19037 #define DECLARE_HDC(hdc)
19038 #define ALLOCATE_HDC(hdc, f)
19039 #define RELEASE_HDC(hdc, f)
19043 init_glyph_string (s
, OPTIONAL_HDC (hdc
) char2b
, w
, row
, area
, start
, hl
)
19044 struct glyph_string
*s
;
19048 struct glyph_row
*row
;
19049 enum glyph_row_area area
;
19051 enum draw_glyphs_face hl
;
19053 bzero (s
, sizeof *s
);
19055 s
->f
= XFRAME (w
->frame
);
19059 s
->display
= FRAME_X_DISPLAY (s
->f
);
19060 s
->window
= FRAME_X_WINDOW (s
->f
);
19061 s
->char2b
= char2b
;
19065 s
->first_glyph
= row
->glyphs
[area
] + start
;
19066 s
->height
= row
->height
;
19067 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
19069 /* Display the internal border below the tool-bar window. */
19070 if (WINDOWP (s
->f
->tool_bar_window
)
19071 && s
->w
== XWINDOW (s
->f
->tool_bar_window
))
19072 s
->y
-= FRAME_INTERNAL_BORDER_WIDTH (s
->f
);
19074 s
->ybase
= s
->y
+ row
->ascent
;
19078 /* Append the list of glyph strings with head H and tail T to the list
19079 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
19082 append_glyph_string_lists (head
, tail
, h
, t
)
19083 struct glyph_string
**head
, **tail
;
19084 struct glyph_string
*h
, *t
;
19098 /* Prepend the list of glyph strings with head H and tail T to the
19099 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
19103 prepend_glyph_string_lists (head
, tail
, h
, t
)
19104 struct glyph_string
**head
, **tail
;
19105 struct glyph_string
*h
, *t
;
19119 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
19120 Set *HEAD and *TAIL to the resulting list. */
19123 append_glyph_string (head
, tail
, s
)
19124 struct glyph_string
**head
, **tail
;
19125 struct glyph_string
*s
;
19127 s
->next
= s
->prev
= NULL
;
19128 append_glyph_string_lists (head
, tail
, s
, s
);
19132 /* Get face and two-byte form of character C in face FACE_ID on frame
19133 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
19134 means we want to display multibyte text. DISPLAY_P non-zero means
19135 make sure that X resources for the face returned are allocated.
19136 Value is a pointer to a realized face that is ready for display if
19137 DISPLAY_P is non-zero. */
19139 static INLINE
struct face
*
19140 get_char_face_and_encoding (f
, c
, face_id
, char2b
, multibyte_p
, display_p
)
19144 int multibyte_p
, display_p
;
19146 struct face
*face
= FACE_FROM_ID (f
, face_id
);
19148 #ifdef USE_FONT_BACKEND
19149 if (enable_font_backend
)
19151 struct font
*font
= (struct font
*) face
->font_info
;
19155 unsigned code
= font
->driver
->encode_char (font
, c
);
19157 if (code
!= FONT_INVALID_CODE
)
19158 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19160 STORE_XCHAR2B (char2b
, 0, 0);
19164 #endif /* USE_FONT_BACKEND */
19167 /* Unibyte case. We don't have to encode, but we have to make
19168 sure to use a face suitable for unibyte. */
19169 STORE_XCHAR2B (char2b
, 0, c
);
19170 face_id
= FACE_FOR_CHAR (f
, face
, c
, -1, Qnil
);
19171 face
= FACE_FROM_ID (f
, face_id
);
19175 /* Case of ASCII in a face known to fit ASCII. */
19176 STORE_XCHAR2B (char2b
, 0, c
);
19178 else if (face
->font
!= NULL
)
19180 struct font_info
*font_info
19181 = FONT_INFO_FROM_ID (f
, face
->font_info_id
);
19182 struct charset
*charset
= CHARSET_FROM_ID (font_info
->charset
);
19183 unsigned code
= ENCODE_CHAR (charset
, c
);
19185 if (CHARSET_DIMENSION (charset
) == 1)
19186 STORE_XCHAR2B (char2b
, 0, code
);
19188 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19189 /* Maybe encode the character in *CHAR2B. */
19190 FRAME_RIF (f
)->encode_char (c
, char2b
, font_info
, charset
, NULL
);
19193 /* Make sure X resources of the face are allocated. */
19194 #ifdef HAVE_X_WINDOWS
19198 xassert (face
!= NULL
);
19199 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19206 /* Get face and two-byte form of character glyph GLYPH on frame F.
19207 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
19208 a pointer to a realized face that is ready for display. */
19210 static INLINE
struct face
*
19211 get_glyph_face_and_encoding (f
, glyph
, char2b
, two_byte_p
)
19213 struct glyph
*glyph
;
19219 xassert (glyph
->type
== CHAR_GLYPH
);
19220 face
= FACE_FROM_ID (f
, glyph
->face_id
);
19225 #ifdef USE_FONT_BACKEND
19226 if (enable_font_backend
)
19228 struct font
*font
= (struct font
*) face
->font_info
;
19232 unsigned code
= font
->driver
->encode_char (font
, glyph
->u
.ch
);
19234 if (code
!= FONT_INVALID_CODE
)
19235 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19237 STORE_XCHAR2B (char2b
, 0, code
);
19241 #endif /* USE_FONT_BACKEND */
19242 if (!glyph
->multibyte_p
)
19244 /* Unibyte case. We don't have to encode, but we have to make
19245 sure to use a face suitable for unibyte. */
19246 STORE_XCHAR2B (char2b
, 0, glyph
->u
.ch
);
19248 else if (glyph
->u
.ch
< 128)
19250 /* Case of ASCII in a face known to fit ASCII. */
19251 STORE_XCHAR2B (char2b
, 0, glyph
->u
.ch
);
19255 struct font_info
*font_info
19256 = FONT_INFO_FROM_ID (f
, face
->font_info_id
);
19259 struct charset
*charset
= CHARSET_FROM_ID (font_info
->charset
);
19260 unsigned code
= ENCODE_CHAR (charset
, glyph
->u
.ch
);
19262 if (CHARSET_DIMENSION (charset
) == 1)
19263 STORE_XCHAR2B (char2b
, 0, code
);
19265 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19267 /* Maybe encode the character in *CHAR2B. */
19268 if (CHARSET_ID (charset
) != charset_ascii
)
19271 = FRAME_RIF (f
)->encode_char (glyph
->u
.ch
, char2b
, font_info
,
19272 charset
, two_byte_p
);
19277 /* Make sure X resources of the face are allocated. */
19278 xassert (face
!= NULL
);
19279 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19284 /* Fill glyph string S with composition components specified by S->cmp.
19286 BASE_FACE is the base face of the composition.
19287 S->gidx is the index of the first component for S.
19289 OVERLAPS non-zero means S should draw the foreground only, and use
19290 its physical height for clipping. See also draw_glyphs.
19292 Value is the index of a component not in S. */
19295 fill_composite_glyph_string (s
, base_face
, overlaps
)
19296 struct glyph_string
*s
;
19297 struct face
*base_face
;
19304 s
->for_overlaps
= overlaps
;
19306 #ifdef USE_FONT_BACKEND
19307 if (enable_font_backend
&& s
->cmp
->method
== COMPOSITION_WITH_GLYPH_STRING
)
19309 Lisp_Object gstring
19310 = AREF (XHASH_TABLE (composition_hash_table
)->key_and_value
,
19311 s
->cmp
->hash_index
* 2);
19313 s
->face
= base_face
;
19314 s
->font_info
= base_face
->font_info
;
19315 s
->font
= s
->font_info
->font
;
19316 for (i
= 0, s
->nchars
= 0; i
< s
->cmp
->glyph_len
; i
++, s
->nchars
++)
19318 Lisp_Object g
= LGSTRING_GLYPH (gstring
, i
);
19320 XChar2b
* store_pos
;
19323 code
= LGLYPH_CODE (g
);
19324 store_pos
= s
->char2b
+ i
;
19325 STORE_XCHAR2B (store_pos
, code
>> 8, code
& 0xFF);
19327 s
->width
= s
->cmp
->pixel_width
;
19330 #endif /* USE_FONT_BACKEND */
19332 /* For all glyphs of this composition, starting at the offset
19333 S->gidx, until we reach the end of the definition or encounter a
19334 glyph that requires the different face, add it to S. */
19339 s
->font_info
= NULL
;
19340 for (i
= s
->gidx
; i
< s
->cmp
->glyph_len
; i
++)
19342 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
19346 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
19349 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
19350 s
->char2b
+ i
, 1, 1);
19356 s
->font
= s
->face
->font
;
19357 s
->font_info
= FONT_INFO_FROM_FACE (s
->f
, s
->face
);
19359 else if (s
->face
!= face
)
19366 /* All glyph strings for the same composition has the same width,
19367 i.e. the width set for the first component of the composition. */
19368 s
->width
= s
->first_glyph
->pixel_width
;
19371 /* If the specified font could not be loaded, use the frame's
19372 default font, but record the fact that we couldn't load it in
19373 the glyph string so that we can draw rectangles for the
19374 characters of the glyph string. */
19375 if (s
->font
== NULL
)
19377 s
->font_not_found_p
= 1;
19378 s
->font
= FRAME_FONT (s
->f
);
19381 /* Adjust base line for subscript/superscript text. */
19382 s
->ybase
+= s
->first_glyph
->voffset
;
19384 /* This glyph string must always be drawn with 16-bit functions. */
19387 return s
->gidx
+ s
->nchars
;
19391 /* Fill glyph string S from a sequence of character glyphs.
19393 FACE_ID is the face id of the string. START is the index of the
19394 first glyph to consider, END is the index of the last + 1.
19395 OVERLAPS non-zero means S should draw the foreground only, and use
19396 its physical height for clipping. See also draw_glyphs.
19398 Value is the index of the first glyph not in S. */
19401 fill_glyph_string (s
, face_id
, start
, end
, overlaps
)
19402 struct glyph_string
*s
;
19404 int start
, end
, overlaps
;
19406 struct glyph
*glyph
, *last
;
19408 int glyph_not_available_p
;
19410 xassert (s
->f
== XFRAME (s
->w
->frame
));
19411 xassert (s
->nchars
== 0);
19412 xassert (start
>= 0 && end
> start
);
19414 s
->for_overlaps
= overlaps
,
19415 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19416 last
= s
->row
->glyphs
[s
->area
] + end
;
19417 voffset
= glyph
->voffset
;
19418 s
->padding_p
= glyph
->padding_p
;
19419 glyph_not_available_p
= glyph
->glyph_not_available_p
;
19421 while (glyph
< last
19422 && glyph
->type
== CHAR_GLYPH
19423 && glyph
->voffset
== voffset
19424 /* Same face id implies same font, nowadays. */
19425 && glyph
->face_id
== face_id
19426 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
19430 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
19431 s
->char2b
+ s
->nchars
,
19433 s
->two_byte_p
= two_byte_p
;
19435 xassert (s
->nchars
<= end
- start
);
19436 s
->width
+= glyph
->pixel_width
;
19437 if (glyph
++->padding_p
!= s
->padding_p
)
19441 s
->font
= s
->face
->font
;
19442 s
->font_info
= FONT_INFO_FROM_FACE (s
->f
, s
->face
);
19444 /* If the specified font could not be loaded, use the frame's font,
19445 but record the fact that we couldn't load it in
19446 S->font_not_found_p so that we can draw rectangles for the
19447 characters of the glyph string. */
19448 if (s
->font
== NULL
|| glyph_not_available_p
)
19450 s
->font_not_found_p
= 1;
19451 s
->font
= FRAME_FONT (s
->f
);
19454 /* Adjust base line for subscript/superscript text. */
19455 s
->ybase
+= voffset
;
19457 xassert (s
->face
&& s
->face
->gc
);
19458 return glyph
- s
->row
->glyphs
[s
->area
];
19462 /* Fill glyph string S from image glyph S->first_glyph. */
19465 fill_image_glyph_string (s
)
19466 struct glyph_string
*s
;
19468 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
19469 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
19471 s
->slice
= s
->first_glyph
->slice
;
19472 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
19473 s
->font
= s
->face
->font
;
19474 s
->width
= s
->first_glyph
->pixel_width
;
19476 /* Adjust base line for subscript/superscript text. */
19477 s
->ybase
+= s
->first_glyph
->voffset
;
19481 /* Fill glyph string S from a sequence of stretch glyphs.
19483 ROW is the glyph row in which the glyphs are found, AREA is the
19484 area within the row. START is the index of the first glyph to
19485 consider, END is the index of the last + 1.
19487 Value is the index of the first glyph not in S. */
19490 fill_stretch_glyph_string (s
, row
, area
, start
, end
)
19491 struct glyph_string
*s
;
19492 struct glyph_row
*row
;
19493 enum glyph_row_area area
;
19496 struct glyph
*glyph
, *last
;
19497 int voffset
, face_id
;
19499 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
19501 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19502 last
= s
->row
->glyphs
[s
->area
] + end
;
19503 face_id
= glyph
->face_id
;
19504 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
19505 s
->font
= s
->face
->font
;
19506 s
->font_info
= FONT_INFO_FROM_FACE (s
->f
, s
->face
);
19507 s
->width
= glyph
->pixel_width
;
19509 voffset
= glyph
->voffset
;
19513 && glyph
->type
== STRETCH_GLYPH
19514 && glyph
->voffset
== voffset
19515 && glyph
->face_id
== face_id
);
19517 s
->width
+= glyph
->pixel_width
;
19519 /* Adjust base line for subscript/superscript text. */
19520 s
->ybase
+= voffset
;
19522 /* The case that face->gc == 0 is handled when drawing the glyph
19523 string by calling PREPARE_FACE_FOR_DISPLAY. */
19525 return glyph
- s
->row
->glyphs
[s
->area
];
19528 static XCharStruct
*
19529 get_per_char_metric (f
, font
, font_info
, char2b
, font_type
)
19532 struct font_info
*font_info
;
19536 #ifdef USE_FONT_BACKEND
19537 if (enable_font_backend
)
19539 static XCharStruct pcm_value
;
19540 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
19541 struct font
*fontp
;
19542 struct font_metrics metrics
;
19544 if (! font_info
|| code
== FONT_INVALID_CODE
)
19546 fontp
= (struct font
*) font_info
;
19547 fontp
->driver
->text_extents (fontp
, &code
, 1, &metrics
);
19548 pcm_value
.lbearing
= metrics
.lbearing
;
19549 pcm_value
.rbearing
= metrics
.rbearing
;
19550 pcm_value
.ascent
= metrics
.ascent
;
19551 pcm_value
.descent
= metrics
.descent
;
19552 pcm_value
.width
= metrics
.width
;
19555 #endif /* USE_FONT_BACKEND */
19556 return FRAME_RIF (f
)->per_char_metric (font
, char2b
, font_type
);
19560 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
19561 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
19562 assumed to be zero. */
19565 x_get_glyph_overhangs (glyph
, f
, left
, right
)
19566 struct glyph
*glyph
;
19570 *left
= *right
= 0;
19572 if (glyph
->type
== CHAR_GLYPH
)
19576 struct font_info
*font_info
;
19580 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
19582 font_info
= FONT_INFO_FROM_FACE (f
, face
);
19583 if (font
/* ++KFS: Should this be font_info ? */
19584 && (pcm
= get_per_char_metric (f
, font
, font_info
, &char2b
, glyph
->font_type
)))
19586 if (pcm
->rbearing
> pcm
->width
)
19587 *right
= pcm
->rbearing
- pcm
->width
;
19588 if (pcm
->lbearing
< 0)
19589 *left
= -pcm
->lbearing
;
19592 else if (glyph
->type
== COMPOSITE_GLYPH
)
19594 struct composition
*cmp
= composition_table
[glyph
->u
.cmp_id
];
19596 *right
= cmp
->rbearing
- cmp
->pixel_width
;
19597 *left
= - cmp
->lbearing
;
19602 /* Return the index of the first glyph preceding glyph string S that
19603 is overwritten by S because of S's left overhang. Value is -1
19604 if no glyphs are overwritten. */
19607 left_overwritten (s
)
19608 struct glyph_string
*s
;
19612 if (s
->left_overhang
)
19615 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19616 int first
= s
->first_glyph
- glyphs
;
19618 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
19619 x
-= glyphs
[i
].pixel_width
;
19630 /* Return the index of the first glyph preceding glyph string S that
19631 is overwriting S because of its right overhang. Value is -1 if no
19632 glyph in front of S overwrites S. */
19635 left_overwriting (s
)
19636 struct glyph_string
*s
;
19639 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19640 int first
= s
->first_glyph
- glyphs
;
19644 for (i
= first
- 1; i
>= 0; --i
)
19647 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
19650 x
-= glyphs
[i
].pixel_width
;
19657 /* Return the index of the last glyph following glyph string S that is
19658 not overwritten by S because of S's right overhang. Value is -1 if
19659 no such glyph is found. */
19662 right_overwritten (s
)
19663 struct glyph_string
*s
;
19667 if (s
->right_overhang
)
19670 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19671 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19672 int end
= s
->row
->used
[s
->area
];
19674 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
19675 x
+= glyphs
[i
].pixel_width
;
19684 /* Return the index of the last glyph following glyph string S that
19685 overwrites S because of its left overhang. Value is negative
19686 if no such glyph is found. */
19689 right_overwriting (s
)
19690 struct glyph_string
*s
;
19693 int end
= s
->row
->used
[s
->area
];
19694 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19695 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19699 for (i
= first
; i
< end
; ++i
)
19702 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
19705 x
+= glyphs
[i
].pixel_width
;
19712 /* Set background width of glyph string S. START is the index of the
19713 first glyph following S. LAST_X is the right-most x-position + 1
19714 in the drawing area. */
19717 set_glyph_string_background_width (s
, start
, last_x
)
19718 struct glyph_string
*s
;
19722 /* If the face of this glyph string has to be drawn to the end of
19723 the drawing area, set S->extends_to_end_of_line_p. */
19725 if (start
== s
->row
->used
[s
->area
]
19726 && s
->area
== TEXT_AREA
19727 && ((s
->row
->fill_line_p
19728 && (s
->hl
== DRAW_NORMAL_TEXT
19729 || s
->hl
== DRAW_IMAGE_RAISED
19730 || s
->hl
== DRAW_IMAGE_SUNKEN
))
19731 || s
->hl
== DRAW_MOUSE_FACE
))
19732 s
->extends_to_end_of_line_p
= 1;
19734 /* If S extends its face to the end of the line, set its
19735 background_width to the distance to the right edge of the drawing
19737 if (s
->extends_to_end_of_line_p
)
19738 s
->background_width
= last_x
- s
->x
+ 1;
19740 s
->background_width
= s
->width
;
19744 /* Compute overhangs and x-positions for glyph string S and its
19745 predecessors, or successors. X is the starting x-position for S.
19746 BACKWARD_P non-zero means process predecessors. */
19749 compute_overhangs_and_x (s
, x
, backward_p
)
19750 struct glyph_string
*s
;
19758 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
19759 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
19769 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
19770 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
19780 /* The following macros are only called from draw_glyphs below.
19781 They reference the following parameters of that function directly:
19782 `w', `row', `area', and `overlap_p'
19783 as well as the following local variables:
19784 `s', `f', and `hdc' (in W32) */
19787 /* On W32, silently add local `hdc' variable to argument list of
19788 init_glyph_string. */
19789 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
19790 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
19792 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
19793 init_glyph_string (s, char2b, w, row, area, start, hl)
19796 /* Add a glyph string for a stretch glyph to the list of strings
19797 between HEAD and TAIL. START is the index of the stretch glyph in
19798 row area AREA of glyph row ROW. END is the index of the last glyph
19799 in that glyph row area. X is the current output position assigned
19800 to the new glyph string constructed. HL overrides that face of the
19801 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
19802 is the right-most x-position of the drawing area. */
19804 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
19805 and below -- keep them on one line. */
19806 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
19809 s = (struct glyph_string *) alloca (sizeof *s); \
19810 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
19811 START = fill_stretch_glyph_string (s, row, area, START, END); \
19812 append_glyph_string (&HEAD, &TAIL, s); \
19818 /* Add a glyph string for an image glyph to the list of strings
19819 between HEAD and TAIL. START is the index of the image glyph in
19820 row area AREA of glyph row ROW. END is the index of the last glyph
19821 in that glyph row area. X is the current output position assigned
19822 to the new glyph string constructed. HL overrides that face of the
19823 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
19824 is the right-most x-position of the drawing area. */
19826 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
19829 s = (struct glyph_string *) alloca (sizeof *s); \
19830 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
19831 fill_image_glyph_string (s); \
19832 append_glyph_string (&HEAD, &TAIL, s); \
19839 /* Add a glyph string for a sequence of character glyphs to the list
19840 of strings between HEAD and TAIL. START is the index of the first
19841 glyph in row area AREA of glyph row ROW that is part of the new
19842 glyph string. END is the index of the last glyph in that glyph row
19843 area. X is the current output position assigned to the new glyph
19844 string constructed. HL overrides that face of the glyph; e.g. it
19845 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
19846 right-most x-position of the drawing area. */
19848 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
19854 face_id = (row)->glyphs[area][START].face_id; \
19856 s = (struct glyph_string *) alloca (sizeof *s); \
19857 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
19858 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
19859 append_glyph_string (&HEAD, &TAIL, s); \
19861 START = fill_glyph_string (s, face_id, START, END, overlaps); \
19866 /* Add a glyph string for a composite sequence to the list of strings
19867 between HEAD and TAIL. START is the index of the first glyph in
19868 row area AREA of glyph row ROW that is part of the new glyph
19869 string. END is the index of the last glyph in that glyph row area.
19870 X is the current output position assigned to the new glyph string
19871 constructed. HL overrides that face of the glyph; e.g. it is
19872 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
19873 x-position of the drawing area. */
19875 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
19877 int face_id = (row)->glyphs[area][START].face_id; \
19878 struct face *base_face = FACE_FROM_ID (f, face_id); \
19879 int cmp_id = (row)->glyphs[area][START].u.cmp_id; \
19880 struct composition *cmp = composition_table[cmp_id]; \
19882 struct glyph_string *first_s; \
19885 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
19887 /* Make glyph_strings for each glyph sequence that is drawable by \
19888 the same face, and append them to HEAD/TAIL. */ \
19889 for (n = 0; n < cmp->glyph_len;) \
19891 s = (struct glyph_string *) alloca (sizeof *s); \
19892 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
19893 append_glyph_string (&(HEAD), &(TAIL), s); \
19899 n = fill_composite_glyph_string (s, base_face, overlaps); \
19907 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
19908 of AREA of glyph row ROW on window W between indices START and END.
19909 HL overrides the face for drawing glyph strings, e.g. it is
19910 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
19911 x-positions of the drawing area.
19913 This is an ugly monster macro construct because we must use alloca
19914 to allocate glyph strings (because draw_glyphs can be called
19915 asynchronously). */
19917 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
19920 HEAD = TAIL = NULL; \
19921 while (START < END) \
19923 struct glyph *first_glyph = (row)->glyphs[area] + START; \
19924 switch (first_glyph->type) \
19927 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
19931 case COMPOSITE_GLYPH: \
19932 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
19936 case STRETCH_GLYPH: \
19937 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
19941 case IMAGE_GLYPH: \
19942 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
19952 set_glyph_string_background_width (s, START, LAST_X); \
19960 /* Draw glyphs between START and END in AREA of ROW on window W,
19961 starting at x-position X. X is relative to AREA in W. HL is a
19962 face-override with the following meaning:
19964 DRAW_NORMAL_TEXT draw normally
19965 DRAW_CURSOR draw in cursor face
19966 DRAW_MOUSE_FACE draw in mouse face.
19967 DRAW_INVERSE_VIDEO draw in mode line face
19968 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
19969 DRAW_IMAGE_RAISED draw an image with a raised relief around it
19971 If OVERLAPS is non-zero, draw only the foreground of characters and
19972 clip to the physical height of ROW. Non-zero value also defines
19973 the overlapping part to be drawn:
19975 OVERLAPS_PRED overlap with preceding rows
19976 OVERLAPS_SUCC overlap with succeeding rows
19977 OVERLAPS_BOTH overlap with both preceding/succeeding rows
19978 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
19980 Value is the x-position reached, relative to AREA of W. */
19983 draw_glyphs (w
, x
, row
, area
, start
, end
, hl
, overlaps
)
19986 struct glyph_row
*row
;
19987 enum glyph_row_area area
;
19988 EMACS_INT start
, end
;
19989 enum draw_glyphs_face hl
;
19992 struct glyph_string
*head
, *tail
;
19993 struct glyph_string
*s
;
19994 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
19995 int last_x
, area_width
;
19998 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20001 ALLOCATE_HDC (hdc
, f
);
20003 /* Let's rather be paranoid than getting a SEGV. */
20004 end
= min (end
, row
->used
[area
]);
20005 start
= max (0, start
);
20006 start
= min (end
, start
);
20008 /* Translate X to frame coordinates. Set last_x to the right
20009 end of the drawing area. */
20010 if (row
->full_width_p
)
20012 /* X is relative to the left edge of W, without scroll bars
20014 x
+= WINDOW_LEFT_EDGE_X (w
);
20015 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
20019 int area_left
= window_box_left (w
, area
);
20021 area_width
= window_box_width (w
, area
);
20022 last_x
= area_left
+ area_width
;
20025 /* Build a doubly-linked list of glyph_string structures between
20026 head and tail from what we have to draw. Note that the macro
20027 BUILD_GLYPH_STRINGS will modify its start parameter. That's
20028 the reason we use a separate variable `i'. */
20030 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
20032 x_reached
= tail
->x
+ tail
->background_width
;
20036 /* If there are any glyphs with lbearing < 0 or rbearing > width in
20037 the row, redraw some glyphs in front or following the glyph
20038 strings built above. */
20039 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
20042 struct glyph_string
*h
, *t
;
20044 /* Compute overhangs for all glyph strings. */
20045 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
20046 for (s
= head
; s
; s
= s
->next
)
20047 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
20049 /* Prepend glyph strings for glyphs in front of the first glyph
20050 string that are overwritten because of the first glyph
20051 string's left overhang. The background of all strings
20052 prepended must be drawn because the first glyph string
20054 i
= left_overwritten (head
);
20058 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
20059 DRAW_NORMAL_TEXT
, dummy_x
, last_x
);
20061 compute_overhangs_and_x (t
, head
->x
, 1);
20062 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
20066 /* Prepend glyph strings for glyphs in front of the first glyph
20067 string that overwrite that glyph string because of their
20068 right overhang. For these strings, only the foreground must
20069 be drawn, because it draws over the glyph string at `head'.
20070 The background must not be drawn because this would overwrite
20071 right overhangs of preceding glyphs for which no glyph
20073 i
= left_overwriting (head
);
20077 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
20078 DRAW_NORMAL_TEXT
, dummy_x
, last_x
);
20079 for (s
= h
; s
; s
= s
->next
)
20080 s
->background_filled_p
= 1;
20081 compute_overhangs_and_x (t
, head
->x
, 1);
20082 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
20085 /* Append glyphs strings for glyphs following the last glyph
20086 string tail that are overwritten by tail. The background of
20087 these strings has to be drawn because tail's foreground draws
20089 i
= right_overwritten (tail
);
20092 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
20093 DRAW_NORMAL_TEXT
, x
, last_x
);
20094 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
20095 append_glyph_string_lists (&head
, &tail
, h
, t
);
20099 /* Append glyph strings for glyphs following the last glyph
20100 string tail that overwrite tail. The foreground of such
20101 glyphs has to be drawn because it writes into the background
20102 of tail. The background must not be drawn because it could
20103 paint over the foreground of following glyphs. */
20104 i
= right_overwriting (tail
);
20108 i
++; /* We must include the Ith glyph. */
20109 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
20110 DRAW_NORMAL_TEXT
, x
, last_x
);
20111 for (s
= h
; s
; s
= s
->next
)
20112 s
->background_filled_p
= 1;
20113 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
20114 append_glyph_string_lists (&head
, &tail
, h
, t
);
20116 if (clip_head
|| clip_tail
)
20117 for (s
= head
; s
; s
= s
->next
)
20119 s
->clip_head
= clip_head
;
20120 s
->clip_tail
= clip_tail
;
20124 /* Draw all strings. */
20125 for (s
= head
; s
; s
= s
->next
)
20126 FRAME_RIF (f
)->draw_glyph_string (s
);
20128 if (area
== TEXT_AREA
20129 && !row
->full_width_p
20130 /* When drawing overlapping rows, only the glyph strings'
20131 foreground is drawn, which doesn't erase a cursor
20135 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
20136 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
20137 : (tail
? tail
->x
+ tail
->background_width
: x
));
20139 int text_left
= window_box_left (w
, TEXT_AREA
);
20143 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
20144 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
20147 /* Value is the x-position up to which drawn, relative to AREA of W.
20148 This doesn't include parts drawn because of overhangs. */
20149 if (row
->full_width_p
)
20150 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
20152 x_reached
-= window_box_left (w
, area
);
20154 RELEASE_HDC (hdc
, f
);
20159 /* Expand row matrix if too narrow. Don't expand if area
20162 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
20164 if (!fonts_changed_p \
20165 && (it->glyph_row->glyphs[area] \
20166 < it->glyph_row->glyphs[area + 1])) \
20168 it->w->ncols_scale_factor++; \
20169 fonts_changed_p = 1; \
20173 /* Store one glyph for IT->char_to_display in IT->glyph_row.
20174 Called from x_produce_glyphs when IT->glyph_row is non-null. */
20180 struct glyph
*glyph
;
20181 enum glyph_row_area area
= it
->area
;
20183 xassert (it
->glyph_row
);
20184 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
20186 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20187 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20189 glyph
->charpos
= CHARPOS (it
->position
);
20190 glyph
->object
= it
->object
;
20191 if (it
->pixel_width
> 0)
20193 glyph
->pixel_width
= it
->pixel_width
;
20194 glyph
->padding_p
= 0;
20198 /* Assure at least 1-pixel width. Otherwise, cursor can't
20199 be displayed correctly. */
20200 glyph
->pixel_width
= 1;
20201 glyph
->padding_p
= 1;
20203 glyph
->ascent
= it
->ascent
;
20204 glyph
->descent
= it
->descent
;
20205 glyph
->voffset
= it
->voffset
;
20206 glyph
->type
= CHAR_GLYPH
;
20207 glyph
->multibyte_p
= it
->multibyte_p
;
20208 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20209 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20210 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
20211 || it
->phys_descent
> it
->descent
);
20212 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
20213 glyph
->face_id
= it
->face_id
;
20214 glyph
->u
.ch
= it
->char_to_display
;
20215 glyph
->slice
= null_glyph_slice
;
20216 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20217 ++it
->glyph_row
->used
[area
];
20220 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20223 /* Store one glyph for the composition IT->cmp_id in IT->glyph_row.
20224 Called from x_produce_glyphs when IT->glyph_row is non-null. */
20227 append_composite_glyph (it
)
20230 struct glyph
*glyph
;
20231 enum glyph_row_area area
= it
->area
;
20233 xassert (it
->glyph_row
);
20235 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20236 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20238 glyph
->charpos
= CHARPOS (it
->position
);
20239 glyph
->object
= it
->object
;
20240 glyph
->pixel_width
= it
->pixel_width
;
20241 glyph
->ascent
= it
->ascent
;
20242 glyph
->descent
= it
->descent
;
20243 glyph
->voffset
= it
->voffset
;
20244 glyph
->type
= COMPOSITE_GLYPH
;
20245 glyph
->multibyte_p
= it
->multibyte_p
;
20246 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20247 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20248 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
20249 || it
->phys_descent
> it
->descent
);
20250 glyph
->padding_p
= 0;
20251 glyph
->glyph_not_available_p
= 0;
20252 glyph
->face_id
= it
->face_id
;
20253 glyph
->u
.cmp_id
= it
->cmp_id
;
20254 glyph
->slice
= null_glyph_slice
;
20255 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20256 ++it
->glyph_row
->used
[area
];
20259 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20263 /* Change IT->ascent and IT->height according to the setting of
20267 take_vertical_position_into_account (it
)
20272 if (it
->voffset
< 0)
20273 /* Increase the ascent so that we can display the text higher
20275 it
->ascent
-= it
->voffset
;
20277 /* Increase the descent so that we can display the text lower
20279 it
->descent
+= it
->voffset
;
20284 /* Produce glyphs/get display metrics for the image IT is loaded with.
20285 See the description of struct display_iterator in dispextern.h for
20286 an overview of struct display_iterator. */
20289 produce_image_glyph (it
)
20294 int glyph_ascent
, crop
;
20295 struct glyph_slice slice
;
20297 xassert (it
->what
== IT_IMAGE
);
20299 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20301 /* Make sure X resources of the face is loaded. */
20302 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
20304 if (it
->image_id
< 0)
20306 /* Fringe bitmap. */
20307 it
->ascent
= it
->phys_ascent
= 0;
20308 it
->descent
= it
->phys_descent
= 0;
20309 it
->pixel_width
= 0;
20314 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
20316 /* Make sure X resources of the image is loaded. */
20317 prepare_image_for_display (it
->f
, img
);
20319 slice
.x
= slice
.y
= 0;
20320 slice
.width
= img
->width
;
20321 slice
.height
= img
->height
;
20323 if (INTEGERP (it
->slice
.x
))
20324 slice
.x
= XINT (it
->slice
.x
);
20325 else if (FLOATP (it
->slice
.x
))
20326 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
20328 if (INTEGERP (it
->slice
.y
))
20329 slice
.y
= XINT (it
->slice
.y
);
20330 else if (FLOATP (it
->slice
.y
))
20331 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
20333 if (INTEGERP (it
->slice
.width
))
20334 slice
.width
= XINT (it
->slice
.width
);
20335 else if (FLOATP (it
->slice
.width
))
20336 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
20338 if (INTEGERP (it
->slice
.height
))
20339 slice
.height
= XINT (it
->slice
.height
);
20340 else if (FLOATP (it
->slice
.height
))
20341 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
20343 if (slice
.x
>= img
->width
)
20344 slice
.x
= img
->width
;
20345 if (slice
.y
>= img
->height
)
20346 slice
.y
= img
->height
;
20347 if (slice
.x
+ slice
.width
>= img
->width
)
20348 slice
.width
= img
->width
- slice
.x
;
20349 if (slice
.y
+ slice
.height
> img
->height
)
20350 slice
.height
= img
->height
- slice
.y
;
20352 if (slice
.width
== 0 || slice
.height
== 0)
20355 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
20357 it
->descent
= slice
.height
- glyph_ascent
;
20359 it
->descent
+= img
->vmargin
;
20360 if (slice
.y
+ slice
.height
== img
->height
)
20361 it
->descent
+= img
->vmargin
;
20362 it
->phys_descent
= it
->descent
;
20364 it
->pixel_width
= slice
.width
;
20366 it
->pixel_width
+= img
->hmargin
;
20367 if (slice
.x
+ slice
.width
== img
->width
)
20368 it
->pixel_width
+= img
->hmargin
;
20370 /* It's quite possible for images to have an ascent greater than
20371 their height, so don't get confused in that case. */
20372 if (it
->descent
< 0)
20375 #if 0 /* this breaks image tiling */
20376 /* If this glyph is alone on the last line, adjust it.ascent to minimum row ascent. */
20377 int face_ascent
= face
->font
? FONT_BASE (face
->font
) : FRAME_BASELINE_OFFSET (it
->f
);
20378 if (face_ascent
> it
->ascent
)
20379 it
->ascent
= it
->phys_ascent
= face_ascent
;
20384 if (face
->box
!= FACE_NO_BOX
)
20386 if (face
->box_line_width
> 0)
20389 it
->ascent
+= face
->box_line_width
;
20390 if (slice
.y
+ slice
.height
== img
->height
)
20391 it
->descent
+= face
->box_line_width
;
20394 if (it
->start_of_box_run_p
&& slice
.x
== 0)
20395 it
->pixel_width
+= eabs (face
->box_line_width
);
20396 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
20397 it
->pixel_width
+= eabs (face
->box_line_width
);
20400 take_vertical_position_into_account (it
);
20402 /* Automatically crop wide image glyphs at right edge so we can
20403 draw the cursor on same display row. */
20404 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
20405 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
20407 it
->pixel_width
-= crop
;
20408 slice
.width
-= crop
;
20413 struct glyph
*glyph
;
20414 enum glyph_row_area area
= it
->area
;
20416 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20417 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20419 glyph
->charpos
= CHARPOS (it
->position
);
20420 glyph
->object
= it
->object
;
20421 glyph
->pixel_width
= it
->pixel_width
;
20422 glyph
->ascent
= glyph_ascent
;
20423 glyph
->descent
= it
->descent
;
20424 glyph
->voffset
= it
->voffset
;
20425 glyph
->type
= IMAGE_GLYPH
;
20426 glyph
->multibyte_p
= it
->multibyte_p
;
20427 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20428 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20429 glyph
->overlaps_vertically_p
= 0;
20430 glyph
->padding_p
= 0;
20431 glyph
->glyph_not_available_p
= 0;
20432 glyph
->face_id
= it
->face_id
;
20433 glyph
->u
.img_id
= img
->id
;
20434 glyph
->slice
= slice
;
20435 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20436 ++it
->glyph_row
->used
[area
];
20439 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20444 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
20445 of the glyph, WIDTH and HEIGHT are the width and height of the
20446 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
20449 append_stretch_glyph (it
, object
, width
, height
, ascent
)
20451 Lisp_Object object
;
20455 struct glyph
*glyph
;
20456 enum glyph_row_area area
= it
->area
;
20458 xassert (ascent
>= 0 && ascent
<= height
);
20460 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20461 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20463 glyph
->charpos
= CHARPOS (it
->position
);
20464 glyph
->object
= object
;
20465 glyph
->pixel_width
= width
;
20466 glyph
->ascent
= ascent
;
20467 glyph
->descent
= height
- ascent
;
20468 glyph
->voffset
= it
->voffset
;
20469 glyph
->type
= STRETCH_GLYPH
;
20470 glyph
->multibyte_p
= it
->multibyte_p
;
20471 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20472 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20473 glyph
->overlaps_vertically_p
= 0;
20474 glyph
->padding_p
= 0;
20475 glyph
->glyph_not_available_p
= 0;
20476 glyph
->face_id
= it
->face_id
;
20477 glyph
->u
.stretch
.ascent
= ascent
;
20478 glyph
->u
.stretch
.height
= height
;
20479 glyph
->slice
= null_glyph_slice
;
20480 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20481 ++it
->glyph_row
->used
[area
];
20484 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20488 /* Produce a stretch glyph for iterator IT. IT->object is the value
20489 of the glyph property displayed. The value must be a list
20490 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
20493 1. `:width WIDTH' specifies that the space should be WIDTH *
20494 canonical char width wide. WIDTH may be an integer or floating
20497 2. `:relative-width FACTOR' specifies that the width of the stretch
20498 should be computed from the width of the first character having the
20499 `glyph' property, and should be FACTOR times that width.
20501 3. `:align-to HPOS' specifies that the space should be wide enough
20502 to reach HPOS, a value in canonical character units.
20504 Exactly one of the above pairs must be present.
20506 4. `:height HEIGHT' specifies that the height of the stretch produced
20507 should be HEIGHT, measured in canonical character units.
20509 5. `:relative-height FACTOR' specifies that the height of the
20510 stretch should be FACTOR times the height of the characters having
20511 the glyph property.
20513 Either none or exactly one of 4 or 5 must be present.
20515 6. `:ascent ASCENT' specifies that ASCENT percent of the height
20516 of the stretch should be used for the ascent of the stretch.
20517 ASCENT must be in the range 0 <= ASCENT <= 100. */
20520 produce_stretch_glyph (it
)
20523 /* (space :width WIDTH :height HEIGHT ...) */
20524 Lisp_Object prop
, plist
;
20525 int width
= 0, height
= 0, align_to
= -1;
20526 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
20529 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20530 XFontStruct
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
20532 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
20534 /* List should start with `space'. */
20535 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
20536 plist
= XCDR (it
->object
);
20538 /* Compute the width of the stretch. */
20539 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
20540 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
20542 /* Absolute width `:width WIDTH' specified and valid. */
20543 zero_width_ok_p
= 1;
20546 else if (prop
= Fplist_get (plist
, QCrelative_width
),
20549 /* Relative width `:relative-width FACTOR' specified and valid.
20550 Compute the width of the characters having the `glyph'
20553 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
20556 if (it
->multibyte_p
)
20558 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
20559 - IT_BYTEPOS (*it
));
20560 it2
.c
= STRING_CHAR_AND_LENGTH (p
, maxlen
, it2
.len
);
20563 it2
.c
= *p
, it2
.len
= 1;
20565 it2
.glyph_row
= NULL
;
20566 it2
.what
= IT_CHARACTER
;
20567 x_produce_glyphs (&it2
);
20568 width
= NUMVAL (prop
) * it2
.pixel_width
;
20570 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
20571 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
20573 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
20574 align_to
= (align_to
< 0
20576 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
20577 else if (align_to
< 0)
20578 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
20579 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
20580 zero_width_ok_p
= 1;
20583 /* Nothing specified -> width defaults to canonical char width. */
20584 width
= FRAME_COLUMN_WIDTH (it
->f
);
20586 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
20589 /* Compute height. */
20590 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
20591 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
20594 zero_height_ok_p
= 1;
20596 else if (prop
= Fplist_get (plist
, QCrelative_height
),
20598 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
20600 height
= FONT_HEIGHT (font
);
20602 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
20605 /* Compute percentage of height used for ascent. If
20606 `:ascent ASCENT' is present and valid, use that. Otherwise,
20607 derive the ascent from the font in use. */
20608 if (prop
= Fplist_get (plist
, QCascent
),
20609 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
20610 ascent
= height
* NUMVAL (prop
) / 100.0;
20611 else if (!NILP (prop
)
20612 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
20613 ascent
= min (max (0, (int)tem
), height
);
20615 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
20617 if (width
> 0 && !it
->truncate_lines_p
20618 && it
->current_x
+ width
> it
->last_visible_x
)
20619 width
= it
->last_visible_x
- it
->current_x
- 1;
20621 if (width
> 0 && height
> 0 && it
->glyph_row
)
20623 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
20624 if (!STRINGP (object
))
20625 object
= it
->w
->buffer
;
20626 append_stretch_glyph (it
, object
, width
, height
, ascent
);
20629 it
->pixel_width
= width
;
20630 it
->ascent
= it
->phys_ascent
= ascent
;
20631 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
20632 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
20634 take_vertical_position_into_account (it
);
20637 /* Get line-height and line-spacing property at point.
20638 If line-height has format (HEIGHT TOTAL), return TOTAL
20639 in TOTAL_HEIGHT. */
20642 get_line_height_property (it
, prop
)
20646 Lisp_Object position
;
20648 if (STRINGP (it
->object
))
20649 position
= make_number (IT_STRING_CHARPOS (*it
));
20650 else if (BUFFERP (it
->object
))
20651 position
= make_number (IT_CHARPOS (*it
));
20655 return Fget_char_property (position
, prop
, it
->object
);
20658 /* Calculate line-height and line-spacing properties.
20659 An integer value specifies explicit pixel value.
20660 A float value specifies relative value to current face height.
20661 A cons (float . face-name) specifies relative value to
20662 height of specified face font.
20664 Returns height in pixels, or nil. */
20668 calc_line_height_property (it
, val
, font
, boff
, override
)
20672 int boff
, override
;
20674 Lisp_Object face_name
= Qnil
;
20675 int ascent
, descent
, height
;
20677 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
20682 face_name
= XCAR (val
);
20684 if (!NUMBERP (val
))
20685 val
= make_number (1);
20686 if (NILP (face_name
))
20688 height
= it
->ascent
+ it
->descent
;
20693 if (NILP (face_name
))
20695 font
= FRAME_FONT (it
->f
);
20696 boff
= FRAME_BASELINE_OFFSET (it
->f
);
20698 else if (EQ (face_name
, Qt
))
20706 struct font_info
*font_info
;
20708 face_id
= lookup_named_face (it
->f
, face_name
, 0);
20710 return make_number (-1);
20712 face
= FACE_FROM_ID (it
->f
, face_id
);
20715 return make_number (-1);
20717 font_info
= FONT_INFO_FROM_FACE (it
->f
, face
);
20718 boff
= font_info
->baseline_offset
;
20719 if (font_info
->vertical_centering
)
20720 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
20723 ascent
= FONT_BASE (font
) + boff
;
20724 descent
= FONT_DESCENT (font
) - boff
;
20728 it
->override_ascent
= ascent
;
20729 it
->override_descent
= descent
;
20730 it
->override_boff
= boff
;
20733 height
= ascent
+ descent
;
20737 height
= (int)(XFLOAT_DATA (val
) * height
);
20738 else if (INTEGERP (val
))
20739 height
*= XINT (val
);
20741 return make_number (height
);
20746 Produce glyphs/get display metrics for the display element IT is
20747 loaded with. See the description of struct it in dispextern.h
20748 for an overview of struct it. */
20751 x_produce_glyphs (it
)
20754 int extra_line_spacing
= it
->extra_line_spacing
;
20756 it
->glyph_not_available_p
= 0;
20758 if (it
->what
== IT_CHARACTER
)
20762 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20764 int font_not_found_p
;
20765 struct font_info
*font_info
;
20766 int boff
; /* baseline offset */
20767 /* We may change it->multibyte_p upon unibyte<->multibyte
20768 conversion. So, save the current value now and restore it
20771 Note: It seems that we don't have to record multibyte_p in
20772 struct glyph because the character code itself tells if or
20773 not the character is multibyte. Thus, in the future, we must
20774 consider eliminating the field `multibyte_p' in the struct
20776 int saved_multibyte_p
= it
->multibyte_p
;
20778 /* Maybe translate single-byte characters to multibyte, or the
20780 it
->char_to_display
= it
->c
;
20781 if (!ASCII_BYTE_P (it
->c
)
20782 && ! it
->multibyte_p
)
20784 if (SINGLE_BYTE_CHAR_P (it
->c
)
20785 && unibyte_display_via_language_environment
)
20786 it
->char_to_display
= unibyte_char_to_multibyte (it
->c
);
20787 if (! SINGLE_BYTE_CHAR_P (it
->char_to_display
))
20789 it
->multibyte_p
= 1;
20790 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
,
20792 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20796 /* Get font to use. Encode IT->char_to_display. */
20797 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
20798 &char2b
, it
->multibyte_p
, 0);
20801 /* When no suitable font found, use the default font. */
20802 font_not_found_p
= font
== NULL
;
20803 if (font_not_found_p
)
20805 font
= FRAME_FONT (it
->f
);
20806 boff
= FRAME_BASELINE_OFFSET (it
->f
);
20811 font_info
= FONT_INFO_FROM_FACE (it
->f
, face
);
20812 boff
= font_info
->baseline_offset
;
20813 if (font_info
->vertical_centering
)
20814 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
20817 if (it
->char_to_display
>= ' '
20818 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
20820 /* Either unibyte or ASCII. */
20825 pcm
= get_per_char_metric (it
->f
, font
, font_info
, &char2b
,
20826 FONT_TYPE_FOR_UNIBYTE (font
, it
->char_to_display
));
20828 if (it
->override_ascent
>= 0)
20830 it
->ascent
= it
->override_ascent
;
20831 it
->descent
= it
->override_descent
;
20832 boff
= it
->override_boff
;
20836 it
->ascent
= FONT_BASE (font
) + boff
;
20837 it
->descent
= FONT_DESCENT (font
) - boff
;
20842 it
->phys_ascent
= pcm
->ascent
+ boff
;
20843 it
->phys_descent
= pcm
->descent
- boff
;
20844 it
->pixel_width
= pcm
->width
;
20848 it
->glyph_not_available_p
= 1;
20849 it
->phys_ascent
= it
->ascent
;
20850 it
->phys_descent
= it
->descent
;
20851 it
->pixel_width
= FONT_WIDTH (font
);
20854 if (it
->constrain_row_ascent_descent_p
)
20856 if (it
->descent
> it
->max_descent
)
20858 it
->ascent
+= it
->descent
- it
->max_descent
;
20859 it
->descent
= it
->max_descent
;
20861 if (it
->ascent
> it
->max_ascent
)
20863 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
20864 it
->ascent
= it
->max_ascent
;
20866 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
20867 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
20868 extra_line_spacing
= 0;
20871 /* If this is a space inside a region of text with
20872 `space-width' property, change its width. */
20873 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
20875 it
->pixel_width
*= XFLOATINT (it
->space_width
);
20877 /* If face has a box, add the box thickness to the character
20878 height. If character has a box line to the left and/or
20879 right, add the box line width to the character's width. */
20880 if (face
->box
!= FACE_NO_BOX
)
20882 int thick
= face
->box_line_width
;
20886 it
->ascent
+= thick
;
20887 it
->descent
+= thick
;
20892 if (it
->start_of_box_run_p
)
20893 it
->pixel_width
+= thick
;
20894 if (it
->end_of_box_run_p
)
20895 it
->pixel_width
+= thick
;
20898 /* If face has an overline, add the height of the overline
20899 (1 pixel) and a 1 pixel margin to the character height. */
20900 if (face
->overline_p
)
20901 it
->ascent
+= overline_margin
;
20903 if (it
->constrain_row_ascent_descent_p
)
20905 if (it
->ascent
> it
->max_ascent
)
20906 it
->ascent
= it
->max_ascent
;
20907 if (it
->descent
> it
->max_descent
)
20908 it
->descent
= it
->max_descent
;
20911 take_vertical_position_into_account (it
);
20913 /* If we have to actually produce glyphs, do it. */
20918 /* Translate a space with a `space-width' property
20919 into a stretch glyph. */
20920 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
20921 / FONT_HEIGHT (font
));
20922 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
20923 it
->ascent
+ it
->descent
, ascent
);
20928 /* If characters with lbearing or rbearing are displayed
20929 in this line, record that fact in a flag of the
20930 glyph row. This is used to optimize X output code. */
20931 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
20932 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
20934 if (! stretched_p
&& it
->pixel_width
== 0)
20935 /* We assure that all visible glyphs have at least 1-pixel
20937 it
->pixel_width
= 1;
20939 else if (it
->char_to_display
== '\n')
20941 /* A newline has no width but we need the height of the line.
20942 But if previous part of the line set a height, don't
20943 increase that height */
20945 Lisp_Object height
;
20946 Lisp_Object total_height
= Qnil
;
20948 it
->override_ascent
= -1;
20949 it
->pixel_width
= 0;
20952 height
= get_line_height_property(it
, Qline_height
);
20953 /* Split (line-height total-height) list */
20955 && CONSP (XCDR (height
))
20956 && NILP (XCDR (XCDR (height
))))
20958 total_height
= XCAR (XCDR (height
));
20959 height
= XCAR (height
);
20961 height
= calc_line_height_property(it
, height
, font
, boff
, 1);
20963 if (it
->override_ascent
>= 0)
20965 it
->ascent
= it
->override_ascent
;
20966 it
->descent
= it
->override_descent
;
20967 boff
= it
->override_boff
;
20971 it
->ascent
= FONT_BASE (font
) + boff
;
20972 it
->descent
= FONT_DESCENT (font
) - boff
;
20975 if (EQ (height
, Qt
))
20977 if (it
->descent
> it
->max_descent
)
20979 it
->ascent
+= it
->descent
- it
->max_descent
;
20980 it
->descent
= it
->max_descent
;
20982 if (it
->ascent
> it
->max_ascent
)
20984 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
20985 it
->ascent
= it
->max_ascent
;
20987 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
20988 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
20989 it
->constrain_row_ascent_descent_p
= 1;
20990 extra_line_spacing
= 0;
20994 Lisp_Object spacing
;
20996 it
->phys_ascent
= it
->ascent
;
20997 it
->phys_descent
= it
->descent
;
20999 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
21000 && face
->box
!= FACE_NO_BOX
21001 && face
->box_line_width
> 0)
21003 it
->ascent
+= face
->box_line_width
;
21004 it
->descent
+= face
->box_line_width
;
21007 && XINT (height
) > it
->ascent
+ it
->descent
)
21008 it
->ascent
= XINT (height
) - it
->descent
;
21010 if (!NILP (total_height
))
21011 spacing
= calc_line_height_property(it
, total_height
, font
, boff
, 0);
21014 spacing
= get_line_height_property(it
, Qline_spacing
);
21015 spacing
= calc_line_height_property(it
, spacing
, font
, boff
, 0);
21017 if (INTEGERP (spacing
))
21019 extra_line_spacing
= XINT (spacing
);
21020 if (!NILP (total_height
))
21021 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
21025 else if (it
->char_to_display
== '\t')
21027 int tab_width
= it
->tab_width
* FRAME_SPACE_WIDTH (it
->f
);
21028 int x
= it
->current_x
+ it
->continuation_lines_width
;
21029 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
21031 /* If the distance from the current position to the next tab
21032 stop is less than a space character width, use the
21033 tab stop after that. */
21034 if (next_tab_x
- x
< FRAME_SPACE_WIDTH (it
->f
))
21035 next_tab_x
+= tab_width
;
21037 it
->pixel_width
= next_tab_x
- x
;
21039 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
21040 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
21044 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
21045 it
->ascent
+ it
->descent
, it
->ascent
);
21050 /* A multi-byte character. Assume that the display width of the
21051 character is the width of the character multiplied by the
21052 width of the font. */
21054 /* If we found a font, this font should give us the right
21055 metrics. If we didn't find a font, use the frame's
21056 default font and calculate the width of the character by
21057 multiplying the width of font by the width of the
21060 pcm
= get_per_char_metric (it
->f
, font
, font_info
, &char2b
,
21061 FONT_TYPE_FOR_MULTIBYTE (font
, it
->c
));
21063 if (font_not_found_p
|| !pcm
)
21065 int char_width
= CHAR_WIDTH (it
->char_to_display
);
21067 if (char_width
== 0)
21068 /* This is a non spacing character. But, as we are
21069 going to display an empty box, the box must occupy
21070 at least one column. */
21072 it
->glyph_not_available_p
= 1;
21073 it
->pixel_width
= FRAME_COLUMN_WIDTH (it
->f
) * char_width
;
21074 it
->phys_ascent
= FONT_BASE (font
) + boff
;
21075 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
21079 it
->pixel_width
= pcm
->width
;
21080 it
->phys_ascent
= pcm
->ascent
+ boff
;
21081 it
->phys_descent
= pcm
->descent
- boff
;
21083 && (pcm
->lbearing
< 0
21084 || pcm
->rbearing
> pcm
->width
))
21085 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21088 it
->ascent
= FONT_BASE (font
) + boff
;
21089 it
->descent
= FONT_DESCENT (font
) - boff
;
21090 if (face
->box
!= FACE_NO_BOX
)
21092 int thick
= face
->box_line_width
;
21096 it
->ascent
+= thick
;
21097 it
->descent
+= thick
;
21102 if (it
->start_of_box_run_p
)
21103 it
->pixel_width
+= thick
;
21104 if (it
->end_of_box_run_p
)
21105 it
->pixel_width
+= thick
;
21108 /* If face has an overline, add the height of the overline
21109 (1 pixel) and a 1 pixel margin to the character height. */
21110 if (face
->overline_p
)
21111 it
->ascent
+= overline_margin
;
21113 take_vertical_position_into_account (it
);
21115 if (it
->ascent
< 0)
21117 if (it
->descent
< 0)
21122 if (it
->pixel_width
== 0)
21123 /* We assure that all visible glyphs have at least 1-pixel
21125 it
->pixel_width
= 1;
21127 it
->multibyte_p
= saved_multibyte_p
;
21129 else if (it
->what
== IT_COMPOSITION
)
21131 /* Note: A composition is represented as one glyph in the
21132 glyph matrix. There are no padding glyphs.
21134 Important is that pixel_width, ascent, and descent are the
21135 values of what is drawn by draw_glyphs (i.e. the values of
21136 the overall glyphs composed). */
21137 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21138 int boff
; /* baseline offset */
21139 struct composition
*cmp
= composition_table
[it
->cmp_id
];
21140 int glyph_len
= cmp
->glyph_len
;
21141 XFontStruct
*font
= face
->font
;
21145 #ifdef USE_FONT_BACKEND
21146 if (cmp
->method
== COMPOSITION_WITH_GLYPH_STRING
)
21148 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21149 font_prepare_composition (cmp
, it
->f
);
21152 #endif /* USE_FONT_BACKEND */
21153 /* If we have not yet calculated pixel size data of glyphs of
21154 the composition for the current face font, calculate them
21155 now. Theoretically, we have to check all fonts for the
21156 glyphs, but that requires much time and memory space. So,
21157 here we check only the font of the first glyph. This leads
21158 to incorrect display, but it's very rare, and C-l (recenter)
21159 can correct the display anyway. */
21160 if (! cmp
->font
|| cmp
->font
!= font
)
21162 /* Ascent and descent of the font of the first character
21163 of this composition (adjusted by baseline offset).
21164 Ascent and descent of overall glyphs should not be less
21165 than them respectively. */
21166 int font_ascent
, font_descent
, font_height
;
21167 /* Bounding box of the overall glyphs. */
21168 int leftmost
, rightmost
, lowest
, highest
;
21169 int lbearing
, rbearing
;
21170 int i
, width
, ascent
, descent
;
21171 int left_padded
= 0, right_padded
= 0;
21176 int font_not_found_p
;
21177 struct font_info
*font_info
;
21180 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
21181 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
21183 if (glyph_len
< cmp
->glyph_len
)
21185 for (i
= 0; i
< glyph_len
; i
++)
21187 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
21189 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
21194 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
21195 : IT_CHARPOS (*it
));
21196 /* When no suitable font found, use the default font. */
21197 font_not_found_p
= font
== NULL
;
21198 if (font_not_found_p
)
21200 face
= face
->ascii_face
;
21203 font_info
= FONT_INFO_FROM_FACE (it
->f
, face
);
21204 boff
= font_info
->baseline_offset
;
21205 if (font_info
->vertical_centering
)
21206 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21207 font_ascent
= FONT_BASE (font
) + boff
;
21208 font_descent
= FONT_DESCENT (font
) - boff
;
21209 font_height
= FONT_HEIGHT (font
);
21211 cmp
->font
= (void *) font
;
21214 if (! font_not_found_p
)
21216 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
21217 &char2b
, it
->multibyte_p
, 0);
21218 pcm
= get_per_char_metric (it
->f
, font
, font_info
, &char2b
,
21219 FONT_TYPE_FOR_MULTIBYTE (font
, c
));
21222 /* Initialize the bounding box. */
21225 width
= pcm
->width
;
21226 ascent
= pcm
->ascent
;
21227 descent
= pcm
->descent
;
21228 lbearing
= pcm
->lbearing
;
21229 rbearing
= pcm
->rbearing
;
21233 width
= FONT_WIDTH (font
);
21234 ascent
= FONT_BASE (font
);
21235 descent
= FONT_DESCENT (font
);
21242 lowest
= - descent
+ boff
;
21243 highest
= ascent
+ boff
;
21245 if (! font_not_found_p
21246 && font_info
->default_ascent
21247 && CHAR_TABLE_P (Vuse_default_ascent
)
21248 && !NILP (Faref (Vuse_default_ascent
,
21249 make_number (it
->char_to_display
))))
21250 highest
= font_info
->default_ascent
+ boff
;
21252 /* Draw the first glyph at the normal position. It may be
21253 shifted to right later if some other glyphs are drawn
21255 cmp
->offsets
[i
* 2] = 0;
21256 cmp
->offsets
[i
* 2 + 1] = boff
;
21257 cmp
->lbearing
= lbearing
;
21258 cmp
->rbearing
= rbearing
;
21260 /* Set cmp->offsets for the remaining glyphs. */
21261 for (i
++; i
< glyph_len
; i
++)
21263 int left
, right
, btm
, top
;
21264 int ch
= COMPOSITION_GLYPH (cmp
, i
);
21266 struct face
*this_face
;
21271 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
21272 this_face
= FACE_FROM_ID (it
->f
, face_id
);
21273 font
= this_face
->font
;
21279 font_info
= FONT_INFO_FROM_FACE (it
->f
, this_face
);
21280 this_boff
= font_info
->baseline_offset
;
21281 if (font_info
->vertical_centering
)
21282 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21283 get_char_face_and_encoding (it
->f
, ch
, face_id
,
21284 &char2b
, it
->multibyte_p
, 0);
21285 pcm
= get_per_char_metric (it
->f
, font
, font_info
, &char2b
,
21286 FONT_TYPE_FOR_MULTIBYTE (font
,
21290 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
21293 width
= pcm
->width
;
21294 ascent
= pcm
->ascent
;
21295 descent
= pcm
->descent
;
21296 lbearing
= pcm
->lbearing
;
21297 rbearing
= pcm
->rbearing
;
21298 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
21300 /* Relative composition with or without
21301 alternate chars. */
21302 left
= (leftmost
+ rightmost
- width
) / 2;
21303 btm
= - descent
+ boff
;
21304 if (font_info
->relative_compose
21305 && (! CHAR_TABLE_P (Vignore_relative_composition
)
21306 || NILP (Faref (Vignore_relative_composition
,
21307 make_number (ch
)))))
21310 if (- descent
>= font_info
->relative_compose
)
21311 /* One extra pixel between two glyphs. */
21313 else if (ascent
<= 0)
21314 /* One extra pixel between two glyphs. */
21315 btm
= lowest
- 1 - ascent
- descent
;
21320 /* A composition rule is specified by an integer
21321 value that encodes global and new reference
21322 points (GREF and NREF). GREF and NREF are
21323 specified by numbers as below:
21325 0---1---2 -- ascent
21329 9--10--11 -- center
21331 ---3---4---5--- baseline
21333 6---7---8 -- descent
21335 int rule
= COMPOSITION_RULE (cmp
, i
);
21336 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
21338 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
21339 grefx
= gref
% 3, nrefx
= nref
% 3;
21340 grefy
= gref
/ 3, nrefy
= nref
/ 3;
21342 xoff
= font_height
* (xoff
- 128) / 256;
21344 yoff
= font_height
* (yoff
- 128) / 256;
21347 + grefx
* (rightmost
- leftmost
) / 2
21348 - nrefx
* width
/ 2
21351 btm
= ((grefy
== 0 ? highest
21353 : grefy
== 2 ? lowest
21354 : (highest
+ lowest
) / 2)
21355 - (nrefy
== 0 ? ascent
+ descent
21356 : nrefy
== 1 ? descent
- boff
21358 : (ascent
+ descent
) / 2)
21362 cmp
->offsets
[i
* 2] = left
;
21363 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
21365 /* Update the bounding box of the overall glyphs. */
21368 right
= left
+ width
;
21369 if (left
< leftmost
)
21371 if (right
> rightmost
)
21374 top
= btm
+ descent
+ ascent
;
21380 if (cmp
->lbearing
> left
+ lbearing
)
21381 cmp
->lbearing
= left
+ lbearing
;
21382 if (cmp
->rbearing
< left
+ rbearing
)
21383 cmp
->rbearing
= left
+ rbearing
;
21387 /* If there are glyphs whose x-offsets are negative,
21388 shift all glyphs to the right and make all x-offsets
21392 for (i
= 0; i
< cmp
->glyph_len
; i
++)
21393 cmp
->offsets
[i
* 2] -= leftmost
;
21394 rightmost
-= leftmost
;
21395 cmp
->lbearing
-= leftmost
;
21396 cmp
->rbearing
-= leftmost
;
21399 if (left_padded
&& cmp
->lbearing
< 0)
21401 for (i
= 0; i
< cmp
->glyph_len
; i
++)
21402 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
21403 rightmost
-= cmp
->lbearing
;
21404 cmp
->rbearing
-= cmp
->lbearing
;
21407 if (right_padded
&& rightmost
< cmp
->rbearing
)
21409 rightmost
= cmp
->rbearing
;
21412 cmp
->pixel_width
= rightmost
;
21413 cmp
->ascent
= highest
;
21414 cmp
->descent
= - lowest
;
21415 if (cmp
->ascent
< font_ascent
)
21416 cmp
->ascent
= font_ascent
;
21417 if (cmp
->descent
< font_descent
)
21418 cmp
->descent
= font_descent
;
21422 && (cmp
->lbearing
< 0
21423 || cmp
->rbearing
> cmp
->pixel_width
))
21424 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21426 it
->pixel_width
= cmp
->pixel_width
;
21427 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
21428 it
->descent
= it
->phys_descent
= cmp
->descent
;
21429 if (face
->box
!= FACE_NO_BOX
)
21431 int thick
= face
->box_line_width
;
21435 it
->ascent
+= thick
;
21436 it
->descent
+= thick
;
21441 if (it
->start_of_box_run_p
)
21442 it
->pixel_width
+= thick
;
21443 if (it
->end_of_box_run_p
)
21444 it
->pixel_width
+= thick
;
21447 /* If face has an overline, add the height of the overline
21448 (1 pixel) and a 1 pixel margin to the character height. */
21449 if (face
->overline_p
)
21450 it
->ascent
+= overline_margin
;
21452 take_vertical_position_into_account (it
);
21453 if (it
->ascent
< 0)
21455 if (it
->descent
< 0)
21459 append_composite_glyph (it
);
21461 else if (it
->what
== IT_IMAGE
)
21462 produce_image_glyph (it
);
21463 else if (it
->what
== IT_STRETCH
)
21464 produce_stretch_glyph (it
);
21466 /* Accumulate dimensions. Note: can't assume that it->descent > 0
21467 because this isn't true for images with `:ascent 100'. */
21468 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
21469 if (it
->area
== TEXT_AREA
)
21470 it
->current_x
+= it
->pixel_width
;
21472 if (extra_line_spacing
> 0)
21474 it
->descent
+= extra_line_spacing
;
21475 if (extra_line_spacing
> it
->max_extra_line_spacing
)
21476 it
->max_extra_line_spacing
= extra_line_spacing
;
21479 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
21480 it
->max_descent
= max (it
->max_descent
, it
->descent
);
21481 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
21482 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
21486 Output LEN glyphs starting at START at the nominal cursor position.
21487 Advance the nominal cursor over the text. The global variable
21488 updated_window contains the window being updated, updated_row is
21489 the glyph row being updated, and updated_area is the area of that
21490 row being updated. */
21493 x_write_glyphs (start
, len
)
21494 struct glyph
*start
;
21499 xassert (updated_window
&& updated_row
);
21502 /* Write glyphs. */
21504 hpos
= start
- updated_row
->glyphs
[updated_area
];
21505 x
= draw_glyphs (updated_window
, output_cursor
.x
,
21506 updated_row
, updated_area
,
21508 DRAW_NORMAL_TEXT
, 0);
21510 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
21511 if (updated_area
== TEXT_AREA
21512 && updated_window
->phys_cursor_on_p
21513 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
21514 && updated_window
->phys_cursor
.hpos
>= hpos
21515 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
21516 updated_window
->phys_cursor_on_p
= 0;
21520 /* Advance the output cursor. */
21521 output_cursor
.hpos
+= len
;
21522 output_cursor
.x
= x
;
21527 Insert LEN glyphs from START at the nominal cursor position. */
21530 x_insert_glyphs (start
, len
)
21531 struct glyph
*start
;
21536 int line_height
, shift_by_width
, shifted_region_width
;
21537 struct glyph_row
*row
;
21538 struct glyph
*glyph
;
21539 int frame_x
, frame_y
;
21542 xassert (updated_window
&& updated_row
);
21544 w
= updated_window
;
21545 f
= XFRAME (WINDOW_FRAME (w
));
21547 /* Get the height of the line we are in. */
21549 line_height
= row
->height
;
21551 /* Get the width of the glyphs to insert. */
21552 shift_by_width
= 0;
21553 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
21554 shift_by_width
+= glyph
->pixel_width
;
21556 /* Get the width of the region to shift right. */
21557 shifted_region_width
= (window_box_width (w
, updated_area
)
21562 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
21563 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
21565 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
21566 line_height
, shift_by_width
);
21568 /* Write the glyphs. */
21569 hpos
= start
- row
->glyphs
[updated_area
];
21570 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
21572 DRAW_NORMAL_TEXT
, 0);
21574 /* Advance the output cursor. */
21575 output_cursor
.hpos
+= len
;
21576 output_cursor
.x
+= shift_by_width
;
21582 Erase the current text line from the nominal cursor position
21583 (inclusive) to pixel column TO_X (exclusive). The idea is that
21584 everything from TO_X onward is already erased.
21586 TO_X is a pixel position relative to updated_area of
21587 updated_window. TO_X == -1 means clear to the end of this area. */
21590 x_clear_end_of_line (to_x
)
21594 struct window
*w
= updated_window
;
21595 int max_x
, min_y
, max_y
;
21596 int from_x
, from_y
, to_y
;
21598 xassert (updated_window
&& updated_row
);
21599 f
= XFRAME (w
->frame
);
21601 if (updated_row
->full_width_p
)
21602 max_x
= WINDOW_TOTAL_WIDTH (w
);
21604 max_x
= window_box_width (w
, updated_area
);
21605 max_y
= window_text_bottom_y (w
);
21607 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
21608 of window. For TO_X > 0, truncate to end of drawing area. */
21614 to_x
= min (to_x
, max_x
);
21616 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
21618 /* Notice if the cursor will be cleared by this operation. */
21619 if (!updated_row
->full_width_p
)
21620 notice_overwritten_cursor (w
, updated_area
,
21621 output_cursor
.x
, -1,
21623 MATRIX_ROW_BOTTOM_Y (updated_row
));
21625 from_x
= output_cursor
.x
;
21627 /* Translate to frame coordinates. */
21628 if (updated_row
->full_width_p
)
21630 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
21631 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
21635 int area_left
= window_box_left (w
, updated_area
);
21636 from_x
+= area_left
;
21640 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
21641 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
21642 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
21644 /* Prevent inadvertently clearing to end of the X window. */
21645 if (to_x
> from_x
&& to_y
> from_y
)
21648 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
21649 to_x
- from_x
, to_y
- from_y
);
21654 #endif /* HAVE_WINDOW_SYSTEM */
21658 /***********************************************************************
21660 ***********************************************************************/
21662 /* Value is the internal representation of the specified cursor type
21663 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
21664 of the bar cursor. */
21666 static enum text_cursor_kinds
21667 get_specified_cursor_type (arg
, width
)
21671 enum text_cursor_kinds type
;
21676 if (EQ (arg
, Qbox
))
21677 return FILLED_BOX_CURSOR
;
21679 if (EQ (arg
, Qhollow
))
21680 return HOLLOW_BOX_CURSOR
;
21682 if (EQ (arg
, Qbar
))
21689 && EQ (XCAR (arg
), Qbar
)
21690 && INTEGERP (XCDR (arg
))
21691 && XINT (XCDR (arg
)) >= 0)
21693 *width
= XINT (XCDR (arg
));
21697 if (EQ (arg
, Qhbar
))
21700 return HBAR_CURSOR
;
21704 && EQ (XCAR (arg
), Qhbar
)
21705 && INTEGERP (XCDR (arg
))
21706 && XINT (XCDR (arg
)) >= 0)
21708 *width
= XINT (XCDR (arg
));
21709 return HBAR_CURSOR
;
21712 /* Treat anything unknown as "hollow box cursor".
21713 It was bad to signal an error; people have trouble fixing
21714 .Xdefaults with Emacs, when it has something bad in it. */
21715 type
= HOLLOW_BOX_CURSOR
;
21720 /* Set the default cursor types for specified frame. */
21722 set_frame_cursor_types (f
, arg
)
21729 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
21730 FRAME_CURSOR_WIDTH (f
) = width
;
21732 /* By default, set up the blink-off state depending on the on-state. */
21734 tem
= Fassoc (arg
, Vblink_cursor_alist
);
21737 FRAME_BLINK_OFF_CURSOR (f
)
21738 = get_specified_cursor_type (XCDR (tem
), &width
);
21739 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
21742 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
21746 /* Return the cursor we want to be displayed in window W. Return
21747 width of bar/hbar cursor through WIDTH arg. Return with
21748 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
21749 (i.e. if the `system caret' should track this cursor).
21751 In a mini-buffer window, we want the cursor only to appear if we
21752 are reading input from this window. For the selected window, we
21753 want the cursor type given by the frame parameter or buffer local
21754 setting of cursor-type. If explicitly marked off, draw no cursor.
21755 In all other cases, we want a hollow box cursor. */
21757 static enum text_cursor_kinds
21758 get_window_cursor_type (w
, glyph
, width
, active_cursor
)
21760 struct glyph
*glyph
;
21762 int *active_cursor
;
21764 struct frame
*f
= XFRAME (w
->frame
);
21765 struct buffer
*b
= XBUFFER (w
->buffer
);
21766 int cursor_type
= DEFAULT_CURSOR
;
21767 Lisp_Object alt_cursor
;
21768 int non_selected
= 0;
21770 *active_cursor
= 1;
21773 if (cursor_in_echo_area
21774 && FRAME_HAS_MINIBUF_P (f
)
21775 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
21777 if (w
== XWINDOW (echo_area_window
))
21779 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
21781 *width
= FRAME_CURSOR_WIDTH (f
);
21782 return FRAME_DESIRED_CURSOR (f
);
21785 return get_specified_cursor_type (b
->cursor_type
, width
);
21788 *active_cursor
= 0;
21792 /* Detect a nonselected window or nonselected frame. */
21793 else if (w
!= XWINDOW (f
->selected_window
)
21794 #ifdef HAVE_WINDOW_SYSTEM
21795 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
21799 *active_cursor
= 0;
21801 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
21807 /* Never display a cursor in a window in which cursor-type is nil. */
21808 if (NILP (b
->cursor_type
))
21811 /* Get the normal cursor type for this window. */
21812 if (EQ (b
->cursor_type
, Qt
))
21814 cursor_type
= FRAME_DESIRED_CURSOR (f
);
21815 *width
= FRAME_CURSOR_WIDTH (f
);
21818 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
21820 /* Use cursor-in-non-selected-windows instead
21821 for non-selected window or frame. */
21824 alt_cursor
= b
->cursor_in_non_selected_windows
;
21825 if (!EQ (Qt
, alt_cursor
))
21826 return get_specified_cursor_type (alt_cursor
, width
);
21827 /* t means modify the normal cursor type. */
21828 if (cursor_type
== FILLED_BOX_CURSOR
)
21829 cursor_type
= HOLLOW_BOX_CURSOR
;
21830 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
21832 return cursor_type
;
21835 /* Use normal cursor if not blinked off. */
21836 if (!w
->cursor_off_p
)
21838 #ifdef HAVE_WINDOW_SYSTEM
21839 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
21841 if (cursor_type
== FILLED_BOX_CURSOR
)
21843 /* Using a block cursor on large images can be very annoying.
21844 So use a hollow cursor for "large" images.
21845 If image is not transparent (no mask), also use hollow cursor. */
21846 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
21847 if (img
!= NULL
&& IMAGEP (img
->spec
))
21849 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
21850 where N = size of default frame font size.
21851 This should cover most of the "tiny" icons people may use. */
21853 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
21854 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
21855 cursor_type
= HOLLOW_BOX_CURSOR
;
21858 else if (cursor_type
!= NO_CURSOR
)
21860 /* Display current only supports BOX and HOLLOW cursors for images.
21861 So for now, unconditionally use a HOLLOW cursor when cursor is
21862 not a solid box cursor. */
21863 cursor_type
= HOLLOW_BOX_CURSOR
;
21867 return cursor_type
;
21870 /* Cursor is blinked off, so determine how to "toggle" it. */
21872 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
21873 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
21874 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
21876 /* Then see if frame has specified a specific blink off cursor type. */
21877 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
21879 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
21880 return FRAME_BLINK_OFF_CURSOR (f
);
21884 /* Some people liked having a permanently visible blinking cursor,
21885 while others had very strong opinions against it. So it was
21886 decided to remove it. KFS 2003-09-03 */
21888 /* Finally perform built-in cursor blinking:
21889 filled box <-> hollow box
21890 wide [h]bar <-> narrow [h]bar
21891 narrow [h]bar <-> no cursor
21892 other type <-> no cursor */
21894 if (cursor_type
== FILLED_BOX_CURSOR
)
21895 return HOLLOW_BOX_CURSOR
;
21897 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
21900 return cursor_type
;
21908 #ifdef HAVE_WINDOW_SYSTEM
21910 /* Notice when the text cursor of window W has been completely
21911 overwritten by a drawing operation that outputs glyphs in AREA
21912 starting at X0 and ending at X1 in the line starting at Y0 and
21913 ending at Y1. X coordinates are area-relative. X1 < 0 means all
21914 the rest of the line after X0 has been written. Y coordinates
21915 are window-relative. */
21918 notice_overwritten_cursor (w
, area
, x0
, x1
, y0
, y1
)
21920 enum glyph_row_area area
;
21921 int x0
, y0
, x1
, y1
;
21923 int cx0
, cx1
, cy0
, cy1
;
21924 struct glyph_row
*row
;
21926 if (!w
->phys_cursor_on_p
)
21928 if (area
!= TEXT_AREA
)
21931 if (w
->phys_cursor
.vpos
< 0
21932 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
21933 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
21934 !(row
->enabled_p
&& row
->displays_text_p
)))
21937 if (row
->cursor_in_fringe_p
)
21939 row
->cursor_in_fringe_p
= 0;
21940 draw_fringe_bitmap (w
, row
, 0);
21941 w
->phys_cursor_on_p
= 0;
21945 cx0
= w
->phys_cursor
.x
;
21946 cx1
= cx0
+ w
->phys_cursor_width
;
21947 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
21950 /* The cursor image will be completely removed from the
21951 screen if the output area intersects the cursor area in
21952 y-direction. When we draw in [y0 y1[, and some part of
21953 the cursor is at y < y0, that part must have been drawn
21954 before. When scrolling, the cursor is erased before
21955 actually scrolling, so we don't come here. When not
21956 scrolling, the rows above the old cursor row must have
21957 changed, and in this case these rows must have written
21958 over the cursor image.
21960 Likewise if part of the cursor is below y1, with the
21961 exception of the cursor being in the first blank row at
21962 the buffer and window end because update_text_area
21963 doesn't draw that row. (Except when it does, but
21964 that's handled in update_text_area.) */
21966 cy0
= w
->phys_cursor
.y
;
21967 cy1
= cy0
+ w
->phys_cursor_height
;
21968 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
21971 w
->phys_cursor_on_p
= 0;
21974 #endif /* HAVE_WINDOW_SYSTEM */
21977 /************************************************************************
21979 ************************************************************************/
21981 #ifdef HAVE_WINDOW_SYSTEM
21984 Fix the display of area AREA of overlapping row ROW in window W
21985 with respect to the overlapping part OVERLAPS. */
21988 x_fix_overlapping_area (w
, row
, area
, overlaps
)
21990 struct glyph_row
*row
;
21991 enum glyph_row_area area
;
21999 for (i
= 0; i
< row
->used
[area
];)
22001 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
22003 int start
= i
, start_x
= x
;
22007 x
+= row
->glyphs
[area
][i
].pixel_width
;
22010 while (i
< row
->used
[area
]
22011 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
22013 draw_glyphs (w
, start_x
, row
, area
,
22015 DRAW_NORMAL_TEXT
, overlaps
);
22019 x
+= row
->glyphs
[area
][i
].pixel_width
;
22029 Draw the cursor glyph of window W in glyph row ROW. See the
22030 comment of draw_glyphs for the meaning of HL. */
22033 draw_phys_cursor_glyph (w
, row
, hl
)
22035 struct glyph_row
*row
;
22036 enum draw_glyphs_face hl
;
22038 /* If cursor hpos is out of bounds, don't draw garbage. This can
22039 happen in mini-buffer windows when switching between echo area
22040 glyphs and mini-buffer. */
22041 if (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])
22043 int on_p
= w
->phys_cursor_on_p
;
22045 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
22046 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
22048 w
->phys_cursor_on_p
= on_p
;
22050 if (hl
== DRAW_CURSOR
)
22051 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
22052 /* When we erase the cursor, and ROW is overlapped by other
22053 rows, make sure that these overlapping parts of other rows
22055 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
22057 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
22059 if (row
> w
->current_matrix
->rows
22060 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
22061 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
22062 OVERLAPS_ERASED_CURSOR
);
22064 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
22065 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
22066 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
22067 OVERLAPS_ERASED_CURSOR
);
22074 Erase the image of a cursor of window W from the screen. */
22077 erase_phys_cursor (w
)
22080 struct frame
*f
= XFRAME (w
->frame
);
22081 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
22082 int hpos
= w
->phys_cursor
.hpos
;
22083 int vpos
= w
->phys_cursor
.vpos
;
22084 int mouse_face_here_p
= 0;
22085 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
22086 struct glyph_row
*cursor_row
;
22087 struct glyph
*cursor_glyph
;
22088 enum draw_glyphs_face hl
;
22090 /* No cursor displayed or row invalidated => nothing to do on the
22092 if (w
->phys_cursor_type
== NO_CURSOR
)
22093 goto mark_cursor_off
;
22095 /* VPOS >= active_glyphs->nrows means that window has been resized.
22096 Don't bother to erase the cursor. */
22097 if (vpos
>= active_glyphs
->nrows
)
22098 goto mark_cursor_off
;
22100 /* If row containing cursor is marked invalid, there is nothing we
22102 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
22103 if (!cursor_row
->enabled_p
)
22104 goto mark_cursor_off
;
22106 /* If line spacing is > 0, old cursor may only be partially visible in
22107 window after split-window. So adjust visible height. */
22108 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
22109 window_text_bottom_y (w
) - cursor_row
->y
);
22111 /* If row is completely invisible, don't attempt to delete a cursor which
22112 isn't there. This can happen if cursor is at top of a window, and
22113 we switch to a buffer with a header line in that window. */
22114 if (cursor_row
->visible_height
<= 0)
22115 goto mark_cursor_off
;
22117 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
22118 if (cursor_row
->cursor_in_fringe_p
)
22120 cursor_row
->cursor_in_fringe_p
= 0;
22121 draw_fringe_bitmap (w
, cursor_row
, 0);
22122 goto mark_cursor_off
;
22125 /* This can happen when the new row is shorter than the old one.
22126 In this case, either draw_glyphs or clear_end_of_line
22127 should have cleared the cursor. Note that we wouldn't be
22128 able to erase the cursor in this case because we don't have a
22129 cursor glyph at hand. */
22130 if (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])
22131 goto mark_cursor_off
;
22133 /* If the cursor is in the mouse face area, redisplay that when
22134 we clear the cursor. */
22135 if (! NILP (dpyinfo
->mouse_face_window
)
22136 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
22137 && (vpos
> dpyinfo
->mouse_face_beg_row
22138 || (vpos
== dpyinfo
->mouse_face_beg_row
22139 && hpos
>= dpyinfo
->mouse_face_beg_col
))
22140 && (vpos
< dpyinfo
->mouse_face_end_row
22141 || (vpos
== dpyinfo
->mouse_face_end_row
22142 && hpos
< dpyinfo
->mouse_face_end_col
))
22143 /* Don't redraw the cursor's spot in mouse face if it is at the
22144 end of a line (on a newline). The cursor appears there, but
22145 mouse highlighting does not. */
22146 && cursor_row
->used
[TEXT_AREA
] > hpos
)
22147 mouse_face_here_p
= 1;
22149 /* Maybe clear the display under the cursor. */
22150 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
22153 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
22156 cursor_glyph
= get_phys_cursor_glyph (w
);
22157 if (cursor_glyph
== NULL
)
22158 goto mark_cursor_off
;
22160 width
= cursor_glyph
->pixel_width
;
22161 left_x
= window_box_left_offset (w
, TEXT_AREA
);
22162 x
= w
->phys_cursor
.x
;
22164 width
-= left_x
- x
;
22165 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
22166 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
22167 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
22170 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
22173 /* Erase the cursor by redrawing the character underneath it. */
22174 if (mouse_face_here_p
)
22175 hl
= DRAW_MOUSE_FACE
;
22177 hl
= DRAW_NORMAL_TEXT
;
22178 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
22181 w
->phys_cursor_on_p
= 0;
22182 w
->phys_cursor_type
= NO_CURSOR
;
22187 Display or clear cursor of window W. If ON is zero, clear the
22188 cursor. If it is non-zero, display the cursor. If ON is nonzero,
22189 where to put the cursor is specified by HPOS, VPOS, X and Y. */
22192 display_and_set_cursor (w
, on
, hpos
, vpos
, x
, y
)
22194 int on
, hpos
, vpos
, x
, y
;
22196 struct frame
*f
= XFRAME (w
->frame
);
22197 int new_cursor_type
;
22198 int new_cursor_width
;
22200 struct glyph_row
*glyph_row
;
22201 struct glyph
*glyph
;
22203 /* This is pointless on invisible frames, and dangerous on garbaged
22204 windows and frames; in the latter case, the frame or window may
22205 be in the midst of changing its size, and x and y may be off the
22207 if (! FRAME_VISIBLE_P (f
)
22208 || FRAME_GARBAGED_P (f
)
22209 || vpos
>= w
->current_matrix
->nrows
22210 || hpos
>= w
->current_matrix
->matrix_w
)
22213 /* If cursor is off and we want it off, return quickly. */
22214 if (!on
&& !w
->phys_cursor_on_p
)
22217 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
22218 /* If cursor row is not enabled, we don't really know where to
22219 display the cursor. */
22220 if (!glyph_row
->enabled_p
)
22222 w
->phys_cursor_on_p
= 0;
22227 if (!glyph_row
->exact_window_width_line_p
22228 || hpos
< glyph_row
->used
[TEXT_AREA
])
22229 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
22231 xassert (interrupt_input_blocked
);
22233 /* Set new_cursor_type to the cursor we want to be displayed. */
22234 new_cursor_type
= get_window_cursor_type (w
, glyph
,
22235 &new_cursor_width
, &active_cursor
);
22237 /* If cursor is currently being shown and we don't want it to be or
22238 it is in the wrong place, or the cursor type is not what we want,
22240 if (w
->phys_cursor_on_p
22242 || w
->phys_cursor
.x
!= x
22243 || w
->phys_cursor
.y
!= y
22244 || new_cursor_type
!= w
->phys_cursor_type
22245 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
22246 && new_cursor_width
!= w
->phys_cursor_width
)))
22247 erase_phys_cursor (w
);
22249 /* Don't check phys_cursor_on_p here because that flag is only set
22250 to zero in some cases where we know that the cursor has been
22251 completely erased, to avoid the extra work of erasing the cursor
22252 twice. In other words, phys_cursor_on_p can be 1 and the cursor
22253 still not be visible, or it has only been partly erased. */
22256 w
->phys_cursor_ascent
= glyph_row
->ascent
;
22257 w
->phys_cursor_height
= glyph_row
->height
;
22259 /* Set phys_cursor_.* before x_draw_.* is called because some
22260 of them may need the information. */
22261 w
->phys_cursor
.x
= x
;
22262 w
->phys_cursor
.y
= glyph_row
->y
;
22263 w
->phys_cursor
.hpos
= hpos
;
22264 w
->phys_cursor
.vpos
= vpos
;
22267 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
22268 new_cursor_type
, new_cursor_width
,
22269 on
, active_cursor
);
22273 /* Switch the display of W's cursor on or off, according to the value
22277 update_window_cursor (w
, on
)
22281 /* Don't update cursor in windows whose frame is in the process
22282 of being deleted. */
22283 if (w
->current_matrix
)
22286 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
22287 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
22293 /* Call update_window_cursor with parameter ON_P on all leaf windows
22294 in the window tree rooted at W. */
22297 update_cursor_in_window_tree (w
, on_p
)
22303 if (!NILP (w
->hchild
))
22304 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
22305 else if (!NILP (w
->vchild
))
22306 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
22308 update_window_cursor (w
, on_p
);
22310 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
22316 Display the cursor on window W, or clear it, according to ON_P.
22317 Don't change the cursor's position. */
22320 x_update_cursor (f
, on_p
)
22324 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
22329 Clear the cursor of window W to background color, and mark the
22330 cursor as not shown. This is used when the text where the cursor
22331 is is about to be rewritten. */
22337 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
22338 update_window_cursor (w
, 0);
22343 Display the active region described by mouse_face_* according to DRAW. */
22346 show_mouse_face (dpyinfo
, draw
)
22347 Display_Info
*dpyinfo
;
22348 enum draw_glyphs_face draw
;
22350 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
22351 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22353 if (/* If window is in the process of being destroyed, don't bother
22355 w
->current_matrix
!= NULL
22356 /* Don't update mouse highlight if hidden */
22357 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
22358 /* Recognize when we are called to operate on rows that don't exist
22359 anymore. This can happen when a window is split. */
22360 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
22362 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
22363 struct glyph_row
*row
, *first
, *last
;
22365 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
22366 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
22368 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
22370 int start_hpos
, end_hpos
, start_x
;
22372 /* For all but the first row, the highlight starts at column 0. */
22375 start_hpos
= dpyinfo
->mouse_face_beg_col
;
22376 start_x
= dpyinfo
->mouse_face_beg_x
;
22385 end_hpos
= dpyinfo
->mouse_face_end_col
;
22388 end_hpos
= row
->used
[TEXT_AREA
];
22389 if (draw
== DRAW_NORMAL_TEXT
)
22390 row
->fill_line_p
= 1; /* Clear to end of line */
22393 if (end_hpos
> start_hpos
)
22395 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
22396 start_hpos
, end_hpos
,
22400 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
22404 /* When we've written over the cursor, arrange for it to
22405 be displayed again. */
22406 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
22409 display_and_set_cursor (w
, 1,
22410 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
22411 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
22416 /* Change the mouse cursor. */
22417 if (draw
== DRAW_NORMAL_TEXT
&& !EQ (dpyinfo
->mouse_face_window
, f
->tool_bar_window
))
22418 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
22419 else if (draw
== DRAW_MOUSE_FACE
)
22420 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
22422 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
22426 Clear out the mouse-highlighted active region.
22427 Redraw it un-highlighted first. Value is non-zero if mouse
22428 face was actually drawn unhighlighted. */
22431 clear_mouse_face (dpyinfo
)
22432 Display_Info
*dpyinfo
;
22436 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
22438 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
22442 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
22443 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
22444 dpyinfo
->mouse_face_window
= Qnil
;
22445 dpyinfo
->mouse_face_overlay
= Qnil
;
22451 Non-zero if physical cursor of window W is within mouse face. */
22454 cursor_in_mouse_face_p (w
)
22457 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
22458 int in_mouse_face
= 0;
22460 if (WINDOWP (dpyinfo
->mouse_face_window
)
22461 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
22463 int hpos
= w
->phys_cursor
.hpos
;
22464 int vpos
= w
->phys_cursor
.vpos
;
22466 if (vpos
>= dpyinfo
->mouse_face_beg_row
22467 && vpos
<= dpyinfo
->mouse_face_end_row
22468 && (vpos
> dpyinfo
->mouse_face_beg_row
22469 || hpos
>= dpyinfo
->mouse_face_beg_col
)
22470 && (vpos
< dpyinfo
->mouse_face_end_row
22471 || hpos
< dpyinfo
->mouse_face_end_col
22472 || dpyinfo
->mouse_face_past_end
))
22476 return in_mouse_face
;
22482 /* Find the glyph matrix position of buffer position CHARPOS in window
22483 *W. HPOS, *VPOS, *X, and *Y are set to the positions found. W's
22484 current glyphs must be up to date. If CHARPOS is above window
22485 start return (0, 0, 0, 0). If CHARPOS is after end of W, return end
22486 of last line in W. In the row containing CHARPOS, stop before glyphs
22487 having STOP as object. */
22489 #if 1 /* This is a version of fast_find_position that's more correct
22490 in the presence of hscrolling, for example. I didn't install
22491 it right away because the problem fixed is minor, it failed
22492 in 20.x as well, and I think it's too risky to install
22493 so near the release of 21.1. 2001-09-25 gerd. */
22496 fast_find_position (w
, charpos
, hpos
, vpos
, x
, y
, stop
)
22499 int *hpos
, *vpos
, *x
, *y
;
22502 struct glyph_row
*row
, *first
;
22503 struct glyph
*glyph
, *end
;
22506 first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22507 if (charpos
< MATRIX_ROW_START_CHARPOS (first
))
22512 *vpos
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
22516 row
= row_containing_pos (w
, charpos
, first
, NULL
, 0);
22519 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
22523 /* If whole rows or last part of a row came from a display overlay,
22524 row_containing_pos will skip over such rows because their end pos
22525 equals the start pos of the overlay or interval.
22527 Move back if we have a STOP object and previous row's
22528 end glyph came from STOP. */
22531 struct glyph_row
*prev
;
22532 while ((prev
= row
- 1, prev
>= first
)
22533 && MATRIX_ROW_END_CHARPOS (prev
) == charpos
22534 && prev
->used
[TEXT_AREA
] > 0)
22536 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
22537 glyph
= beg
+ prev
->used
[TEXT_AREA
];
22538 while (--glyph
>= beg
22539 && INTEGERP (glyph
->object
));
22541 || !EQ (stop
, glyph
->object
))
22549 *vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
22551 glyph
= row
->glyphs
[TEXT_AREA
];
22552 end
= glyph
+ row
->used
[TEXT_AREA
];
22554 /* Skip over glyphs not having an object at the start of the row.
22555 These are special glyphs like truncation marks on terminal
22557 if (row
->displays_text_p
)
22559 && INTEGERP (glyph
->object
)
22560 && !EQ (stop
, glyph
->object
)
22561 && glyph
->charpos
< 0)
22563 *x
+= glyph
->pixel_width
;
22568 && !INTEGERP (glyph
->object
)
22569 && !EQ (stop
, glyph
->object
)
22570 && (!BUFFERP (glyph
->object
)
22571 || glyph
->charpos
< charpos
))
22573 *x
+= glyph
->pixel_width
;
22577 *hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
22584 fast_find_position (w
, pos
, hpos
, vpos
, x
, y
, stop
)
22587 int *hpos
, *vpos
, *x
, *y
;
22592 int maybe_next_line_p
= 0;
22593 int line_start_position
;
22594 int yb
= window_text_bottom_y (w
);
22595 struct glyph_row
*row
, *best_row
;
22596 int row_vpos
, best_row_vpos
;
22599 row
= best_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22600 row_vpos
= best_row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
22602 while (row
->y
< yb
)
22604 if (row
->used
[TEXT_AREA
])
22605 line_start_position
= row
->glyphs
[TEXT_AREA
]->charpos
;
22607 line_start_position
= 0;
22609 if (line_start_position
> pos
)
22611 /* If the position sought is the end of the buffer,
22612 don't include the blank lines at the bottom of the window. */
22613 else if (line_start_position
== pos
22614 && pos
== BUF_ZV (XBUFFER (w
->buffer
)))
22616 maybe_next_line_p
= 1;
22619 else if (line_start_position
> 0)
22622 best_row_vpos
= row_vpos
;
22625 if (row
->y
+ row
->height
>= yb
)
22632 /* Find the right column within BEST_ROW. */
22634 current_x
= best_row
->x
;
22635 for (i
= 0; i
< best_row
->used
[TEXT_AREA
]; i
++)
22637 struct glyph
*glyph
= best_row
->glyphs
[TEXT_AREA
] + i
;
22638 int charpos
= glyph
->charpos
;
22640 if (BUFFERP (glyph
->object
))
22642 if (charpos
== pos
)
22645 *vpos
= best_row_vpos
;
22650 else if (charpos
> pos
)
22653 else if (EQ (glyph
->object
, stop
))
22658 current_x
+= glyph
->pixel_width
;
22661 /* If we're looking for the end of the buffer,
22662 and we didn't find it in the line we scanned,
22663 use the start of the following line. */
22664 if (maybe_next_line_p
)
22669 current_x
= best_row
->x
;
22672 *vpos
= best_row_vpos
;
22673 *hpos
= lastcol
+ 1;
22682 /* Find the position of the glyph for position POS in OBJECT in
22683 window W's current matrix, and return in *X, *Y the pixel
22684 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
22686 RIGHT_P non-zero means return the position of the right edge of the
22687 glyph, RIGHT_P zero means return the left edge position.
22689 If no glyph for POS exists in the matrix, return the position of
22690 the glyph with the next smaller position that is in the matrix, if
22691 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
22692 exists in the matrix, return the position of the glyph with the
22693 next larger position in OBJECT.
22695 Value is non-zero if a glyph was found. */
22698 fast_find_string_pos (w
, pos
, object
, hpos
, vpos
, x
, y
, right_p
)
22701 Lisp_Object object
;
22702 int *hpos
, *vpos
, *x
, *y
;
22705 int yb
= window_text_bottom_y (w
);
22706 struct glyph_row
*r
;
22707 struct glyph
*best_glyph
= NULL
;
22708 struct glyph_row
*best_row
= NULL
;
22711 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22712 r
->enabled_p
&& r
->y
< yb
;
22715 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
22716 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
22719 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
22720 if (EQ (g
->object
, object
))
22722 if (g
->charpos
== pos
)
22729 else if (best_glyph
== NULL
22730 || ((eabs (g
->charpos
- pos
)
22731 < eabs (best_glyph
->charpos
- pos
))
22734 : g
->charpos
> pos
)))
22748 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
22752 *x
+= best_glyph
->pixel_width
;
22757 *vpos
= best_row
- w
->current_matrix
->rows
;
22760 return best_glyph
!= NULL
;
22764 /* See if position X, Y is within a hot-spot of an image. */
22767 on_hot_spot_p (hot_spot
, x
, y
)
22768 Lisp_Object hot_spot
;
22771 if (!CONSP (hot_spot
))
22774 if (EQ (XCAR (hot_spot
), Qrect
))
22776 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
22777 Lisp_Object rect
= XCDR (hot_spot
);
22781 if (!CONSP (XCAR (rect
)))
22783 if (!CONSP (XCDR (rect
)))
22785 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
22787 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
22789 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
22791 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
22795 else if (EQ (XCAR (hot_spot
), Qcircle
))
22797 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
22798 Lisp_Object circ
= XCDR (hot_spot
);
22799 Lisp_Object lr
, lx0
, ly0
;
22801 && CONSP (XCAR (circ
))
22802 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
22803 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
22804 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
22806 double r
= XFLOATINT (lr
);
22807 double dx
= XINT (lx0
) - x
;
22808 double dy
= XINT (ly0
) - y
;
22809 return (dx
* dx
+ dy
* dy
<= r
* r
);
22812 else if (EQ (XCAR (hot_spot
), Qpoly
))
22814 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
22815 if (VECTORP (XCDR (hot_spot
)))
22817 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
22818 Lisp_Object
*poly
= v
->contents
;
22822 Lisp_Object lx
, ly
;
22825 /* Need an even number of coordinates, and at least 3 edges. */
22826 if (n
< 6 || n
& 1)
22829 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
22830 If count is odd, we are inside polygon. Pixels on edges
22831 may or may not be included depending on actual geometry of the
22833 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
22834 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
22836 x0
= XINT (lx
), y0
= XINT (ly
);
22837 for (i
= 0; i
< n
; i
+= 2)
22839 int x1
= x0
, y1
= y0
;
22840 if ((lx
= poly
[i
], !INTEGERP (lx
))
22841 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
22843 x0
= XINT (lx
), y0
= XINT (ly
);
22845 /* Does this segment cross the X line? */
22853 if (y
> y0
&& y
> y1
)
22855 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
22865 find_hot_spot (map
, x
, y
)
22869 while (CONSP (map
))
22871 if (CONSP (XCAR (map
))
22872 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
22880 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
22882 doc
: /* Lookup in image map MAP coordinates X and Y.
22883 An image map is an alist where each element has the format (AREA ID PLIST).
22884 An AREA is specified as either a rectangle, a circle, or a polygon:
22885 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
22886 pixel coordinates of the upper left and bottom right corners.
22887 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
22888 and the radius of the circle; r may be a float or integer.
22889 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
22890 vector describes one corner in the polygon.
22891 Returns the alist element for the first matching AREA in MAP. */)
22902 return find_hot_spot (map
, XINT (x
), XINT (y
));
22906 /* Display frame CURSOR, optionally using shape defined by POINTER. */
22908 define_frame_cursor1 (f
, cursor
, pointer
)
22911 Lisp_Object pointer
;
22913 /* Do not change cursor shape while dragging mouse. */
22914 if (!NILP (do_mouse_tracking
))
22917 if (!NILP (pointer
))
22919 if (EQ (pointer
, Qarrow
))
22920 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
22921 else if (EQ (pointer
, Qhand
))
22922 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
22923 else if (EQ (pointer
, Qtext
))
22924 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
22925 else if (EQ (pointer
, intern ("hdrag")))
22926 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
22927 #ifdef HAVE_X_WINDOWS
22928 else if (EQ (pointer
, intern ("vdrag")))
22929 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
22931 else if (EQ (pointer
, intern ("hourglass")))
22932 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
22933 else if (EQ (pointer
, Qmodeline
))
22934 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
22936 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
22939 if (cursor
!= No_Cursor
)
22940 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
22943 /* Take proper action when mouse has moved to the mode or header line
22944 or marginal area AREA of window W, x-position X and y-position Y.
22945 X is relative to the start of the text display area of W, so the
22946 width of bitmap areas and scroll bars must be subtracted to get a
22947 position relative to the start of the mode line. */
22950 note_mode_line_or_margin_highlight (window
, x
, y
, area
)
22951 Lisp_Object window
;
22953 enum window_part area
;
22955 struct window
*w
= XWINDOW (window
);
22956 struct frame
*f
= XFRAME (w
->frame
);
22957 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
22958 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
22959 Lisp_Object pointer
= Qnil
;
22960 int charpos
, dx
, dy
, width
, height
;
22961 Lisp_Object string
, object
= Qnil
;
22962 Lisp_Object pos
, help
;
22964 Lisp_Object mouse_face
;
22965 int original_x_pixel
= x
;
22966 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
22967 struct glyph_row
*row
;
22969 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
22974 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
22975 &object
, &dx
, &dy
, &width
, &height
);
22977 row
= (area
== ON_MODE_LINE
22978 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
22979 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
22982 if (row
->mode_line_p
&& row
->enabled_p
)
22984 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
22985 end
= glyph
+ row
->used
[TEXT_AREA
];
22987 for (x0
= original_x_pixel
;
22988 glyph
< end
&& x0
>= glyph
->pixel_width
;
22990 x0
-= glyph
->pixel_width
;
22998 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
22999 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
23000 &object
, &dx
, &dy
, &width
, &height
);
23005 if (IMAGEP (object
))
23007 Lisp_Object image_map
, hotspot
;
23008 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
23010 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
23012 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
23014 Lisp_Object area_id
, plist
;
23016 area_id
= XCAR (hotspot
);
23017 /* Could check AREA_ID to see if we enter/leave this hot-spot.
23018 If so, we could look for mouse-enter, mouse-leave
23019 properties in PLIST (and do something...). */
23020 hotspot
= XCDR (hotspot
);
23021 if (CONSP (hotspot
)
23022 && (plist
= XCAR (hotspot
), CONSP (plist
)))
23024 pointer
= Fplist_get (plist
, Qpointer
);
23025 if (NILP (pointer
))
23027 help
= Fplist_get (plist
, Qhelp_echo
);
23030 help_echo_string
= help
;
23031 /* Is this correct? ++kfs */
23032 XSETWINDOW (help_echo_window
, w
);
23033 help_echo_object
= w
->buffer
;
23034 help_echo_pos
= charpos
;
23038 if (NILP (pointer
))
23039 pointer
= Fplist_get (XCDR (object
), QCpointer
);
23042 if (STRINGP (string
))
23044 pos
= make_number (charpos
);
23045 /* If we're on a string with `help-echo' text property, arrange
23046 for the help to be displayed. This is done by setting the
23047 global variable help_echo_string to the help string. */
23050 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
23053 help_echo_string
= help
;
23054 XSETWINDOW (help_echo_window
, w
);
23055 help_echo_object
= string
;
23056 help_echo_pos
= charpos
;
23060 if (NILP (pointer
))
23061 pointer
= Fget_text_property (pos
, Qpointer
, string
);
23063 /* Change the mouse pointer according to what is under X/Y. */
23064 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
23067 map
= Fget_text_property (pos
, Qlocal_map
, string
);
23068 if (!KEYMAPP (map
))
23069 map
= Fget_text_property (pos
, Qkeymap
, string
);
23070 if (!KEYMAPP (map
))
23071 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
23074 /* Change the mouse face according to what is under X/Y. */
23075 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
23076 if (!NILP (mouse_face
)
23077 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
23082 struct glyph
* tmp_glyph
;
23086 int total_pixel_width
;
23091 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
23092 Qmouse_face
, string
, Qnil
);
23094 b
= make_number (0);
23096 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
23098 e
= make_number (SCHARS (string
));
23100 /* Calculate the position(glyph position: GPOS) of GLYPH in
23101 displayed string. GPOS is different from CHARPOS.
23103 CHARPOS is the position of glyph in internal string
23104 object. A mode line string format has structures which
23105 is converted to a flatten by emacs lisp interpreter.
23106 The internal string is an element of the structures.
23107 The displayed string is the flatten string. */
23109 if (glyph
> row_start_glyph
)
23111 tmp_glyph
= glyph
- 1;
23112 while (tmp_glyph
>= row_start_glyph
23113 && tmp_glyph
->charpos
>= XINT (b
)
23114 && EQ (tmp_glyph
->object
, glyph
->object
))
23121 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
23122 displayed string holding GLYPH.
23124 GSEQ_LENGTH is different from SCHARS (STRING).
23125 SCHARS (STRING) returns the length of the internal string. */
23126 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
23127 tmp_glyph
->charpos
< XINT (e
);
23128 tmp_glyph
++, gseq_length
++)
23130 if (!EQ (tmp_glyph
->object
, glyph
->object
))
23134 total_pixel_width
= 0;
23135 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
23136 total_pixel_width
+= tmp_glyph
->pixel_width
;
23138 /* Pre calculation of re-rendering position */
23140 hpos
= (area
== ON_MODE_LINE
23141 ? (w
->current_matrix
)->nrows
- 1
23144 /* If the re-rendering position is included in the last
23145 re-rendering area, we should do nothing. */
23146 if ( EQ (window
, dpyinfo
->mouse_face_window
)
23147 && dpyinfo
->mouse_face_beg_col
<= vpos
23148 && vpos
< dpyinfo
->mouse_face_end_col
23149 && dpyinfo
->mouse_face_beg_row
== hpos
)
23152 if (clear_mouse_face (dpyinfo
))
23153 cursor
= No_Cursor
;
23155 dpyinfo
->mouse_face_beg_col
= vpos
;
23156 dpyinfo
->mouse_face_beg_row
= hpos
;
23158 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
23159 dpyinfo
->mouse_face_beg_y
= 0;
23161 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
23162 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
23164 dpyinfo
->mouse_face_end_x
= 0;
23165 dpyinfo
->mouse_face_end_y
= 0;
23167 dpyinfo
->mouse_face_past_end
= 0;
23168 dpyinfo
->mouse_face_window
= window
;
23170 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
23173 glyph
->face_id
, 1);
23174 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23176 if (NILP (pointer
))
23179 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
23180 clear_mouse_face (dpyinfo
);
23182 define_frame_cursor1 (f
, cursor
, pointer
);
23187 Take proper action when the mouse has moved to position X, Y on
23188 frame F as regards highlighting characters that have mouse-face
23189 properties. Also de-highlighting chars where the mouse was before.
23190 X and Y can be negative or out of range. */
23193 note_mouse_highlight (f
, x
, y
)
23197 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23198 enum window_part part
;
23199 Lisp_Object window
;
23201 Cursor cursor
= No_Cursor
;
23202 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
23205 /* When a menu is active, don't highlight because this looks odd. */
23206 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (MAC_OS)
23207 if (popup_activated ())
23211 if (NILP (Vmouse_highlight
)
23212 || !f
->glyphs_initialized_p
)
23215 dpyinfo
->mouse_face_mouse_x
= x
;
23216 dpyinfo
->mouse_face_mouse_y
= y
;
23217 dpyinfo
->mouse_face_mouse_frame
= f
;
23219 if (dpyinfo
->mouse_face_defer
)
23222 if (gc_in_progress
)
23224 dpyinfo
->mouse_face_deferred_gc
= 1;
23228 /* Which window is that in? */
23229 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
23231 /* If we were displaying active text in another window, clear that.
23232 Also clear if we move out of text area in same window. */
23233 if (! EQ (window
, dpyinfo
->mouse_face_window
)
23234 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
23235 && !NILP (dpyinfo
->mouse_face_window
)))
23236 clear_mouse_face (dpyinfo
);
23238 /* Not on a window -> return. */
23239 if (!WINDOWP (window
))
23242 /* Reset help_echo_string. It will get recomputed below. */
23243 help_echo_string
= Qnil
;
23245 /* Convert to window-relative pixel coordinates. */
23246 w
= XWINDOW (window
);
23247 frame_to_window_pixel_xy (w
, &x
, &y
);
23249 /* Handle tool-bar window differently since it doesn't display a
23251 if (EQ (window
, f
->tool_bar_window
))
23253 note_tool_bar_highlight (f
, x
, y
);
23257 /* Mouse is on the mode, header line or margin? */
23258 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
23259 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
23261 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
23265 if (part
== ON_VERTICAL_BORDER
)
23267 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
23268 help_echo_string
= build_string ("drag-mouse-1: resize");
23270 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
23271 || part
== ON_SCROLL_BAR
)
23272 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23274 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
23276 /* Are we in a window whose display is up to date?
23277 And verify the buffer's text has not changed. */
23278 b
= XBUFFER (w
->buffer
);
23279 if (part
== ON_TEXT
23280 && EQ (w
->window_end_valid
, w
->buffer
)
23281 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
23282 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
23284 int hpos
, vpos
, pos
, i
, dx
, dy
, area
;
23285 struct glyph
*glyph
;
23286 Lisp_Object object
;
23287 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
23288 Lisp_Object
*overlay_vec
= NULL
;
23290 struct buffer
*obuf
;
23291 int obegv
, ozv
, same_region
;
23293 /* Find the glyph under X/Y. */
23294 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
23296 /* Look for :pointer property on image. */
23297 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23299 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23300 if (img
!= NULL
&& IMAGEP (img
->spec
))
23302 Lisp_Object image_map
, hotspot
;
23303 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
23305 && (hotspot
= find_hot_spot (image_map
,
23306 glyph
->slice
.x
+ dx
,
23307 glyph
->slice
.y
+ dy
),
23309 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
23311 Lisp_Object area_id
, plist
;
23313 area_id
= XCAR (hotspot
);
23314 /* Could check AREA_ID to see if we enter/leave this hot-spot.
23315 If so, we could look for mouse-enter, mouse-leave
23316 properties in PLIST (and do something...). */
23317 hotspot
= XCDR (hotspot
);
23318 if (CONSP (hotspot
)
23319 && (plist
= XCAR (hotspot
), CONSP (plist
)))
23321 pointer
= Fplist_get (plist
, Qpointer
);
23322 if (NILP (pointer
))
23324 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
23325 if (!NILP (help_echo_string
))
23327 help_echo_window
= window
;
23328 help_echo_object
= glyph
->object
;
23329 help_echo_pos
= glyph
->charpos
;
23333 if (NILP (pointer
))
23334 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
23338 /* Clear mouse face if X/Y not over text. */
23340 || area
!= TEXT_AREA
23341 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
23343 if (clear_mouse_face (dpyinfo
))
23344 cursor
= No_Cursor
;
23345 if (NILP (pointer
))
23347 if (area
!= TEXT_AREA
)
23348 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23350 pointer
= Vvoid_text_area_pointer
;
23355 pos
= glyph
->charpos
;
23356 object
= glyph
->object
;
23357 if (!STRINGP (object
) && !BUFFERP (object
))
23360 /* If we get an out-of-range value, return now; avoid an error. */
23361 if (BUFFERP (object
) && pos
> BUF_Z (b
))
23364 /* Make the window's buffer temporarily current for
23365 overlays_at and compute_char_face. */
23366 obuf
= current_buffer
;
23367 current_buffer
= b
;
23373 /* Is this char mouse-active or does it have help-echo? */
23374 position
= make_number (pos
);
23376 if (BUFFERP (object
))
23378 /* Put all the overlays we want in a vector in overlay_vec. */
23379 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
23380 /* Sort overlays into increasing priority order. */
23381 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
23386 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
23387 && vpos
>= dpyinfo
->mouse_face_beg_row
23388 && vpos
<= dpyinfo
->mouse_face_end_row
23389 && (vpos
> dpyinfo
->mouse_face_beg_row
23390 || hpos
>= dpyinfo
->mouse_face_beg_col
)
23391 && (vpos
< dpyinfo
->mouse_face_end_row
23392 || hpos
< dpyinfo
->mouse_face_end_col
23393 || dpyinfo
->mouse_face_past_end
));
23396 cursor
= No_Cursor
;
23398 /* Check mouse-face highlighting. */
23400 /* If there exists an overlay with mouse-face overlapping
23401 the one we are currently highlighting, we have to
23402 check if we enter the overlapping overlay, and then
23403 highlight only that. */
23404 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
23405 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
23407 /* Find the highest priority overlay that has a mouse-face
23410 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
23412 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
23413 if (!NILP (mouse_face
))
23414 overlay
= overlay_vec
[i
];
23417 /* If we're actually highlighting the same overlay as
23418 before, there's no need to do that again. */
23419 if (!NILP (overlay
)
23420 && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
23421 goto check_help_echo
;
23423 dpyinfo
->mouse_face_overlay
= overlay
;
23425 /* Clear the display of the old active region, if any. */
23426 if (clear_mouse_face (dpyinfo
))
23427 cursor
= No_Cursor
;
23429 /* If no overlay applies, get a text property. */
23430 if (NILP (overlay
))
23431 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
23433 /* Handle the overlay case. */
23434 if (!NILP (overlay
))
23436 /* Find the range of text around this char that
23437 should be active. */
23438 Lisp_Object before
, after
;
23441 before
= Foverlay_start (overlay
);
23442 after
= Foverlay_end (overlay
);
23443 /* Record this as the current active region. */
23444 fast_find_position (w
, XFASTINT (before
),
23445 &dpyinfo
->mouse_face_beg_col
,
23446 &dpyinfo
->mouse_face_beg_row
,
23447 &dpyinfo
->mouse_face_beg_x
,
23448 &dpyinfo
->mouse_face_beg_y
, Qnil
);
23450 dpyinfo
->mouse_face_past_end
23451 = !fast_find_position (w
, XFASTINT (after
),
23452 &dpyinfo
->mouse_face_end_col
,
23453 &dpyinfo
->mouse_face_end_row
,
23454 &dpyinfo
->mouse_face_end_x
,
23455 &dpyinfo
->mouse_face_end_y
, Qnil
);
23456 dpyinfo
->mouse_face_window
= window
;
23458 dpyinfo
->mouse_face_face_id
23459 = face_at_buffer_position (w
, pos
, 0, 0,
23461 !dpyinfo
->mouse_face_hidden
);
23463 /* Display it as active. */
23464 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23465 cursor
= No_Cursor
;
23467 /* Handle the text property case. */
23468 else if (!NILP (mouse_face
) && BUFFERP (object
))
23470 /* Find the range of text around this char that
23471 should be active. */
23472 Lisp_Object before
, after
, beginning
, end
;
23475 beginning
= Fmarker_position (w
->start
);
23476 end
= make_number (BUF_Z (XBUFFER (object
))
23477 - XFASTINT (w
->window_end_pos
));
23479 = Fprevious_single_property_change (make_number (pos
+ 1),
23481 object
, beginning
);
23483 = Fnext_single_property_change (position
, Qmouse_face
,
23486 /* Record this as the current active region. */
23487 fast_find_position (w
, XFASTINT (before
),
23488 &dpyinfo
->mouse_face_beg_col
,
23489 &dpyinfo
->mouse_face_beg_row
,
23490 &dpyinfo
->mouse_face_beg_x
,
23491 &dpyinfo
->mouse_face_beg_y
, Qnil
);
23492 dpyinfo
->mouse_face_past_end
23493 = !fast_find_position (w
, XFASTINT (after
),
23494 &dpyinfo
->mouse_face_end_col
,
23495 &dpyinfo
->mouse_face_end_row
,
23496 &dpyinfo
->mouse_face_end_x
,
23497 &dpyinfo
->mouse_face_end_y
, Qnil
);
23498 dpyinfo
->mouse_face_window
= window
;
23500 if (BUFFERP (object
))
23501 dpyinfo
->mouse_face_face_id
23502 = face_at_buffer_position (w
, pos
, 0, 0,
23504 !dpyinfo
->mouse_face_hidden
);
23506 /* Display it as active. */
23507 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23508 cursor
= No_Cursor
;
23510 else if (!NILP (mouse_face
) && STRINGP (object
))
23515 b
= Fprevious_single_property_change (make_number (pos
+ 1),
23518 e
= Fnext_single_property_change (position
, Qmouse_face
,
23521 b
= make_number (0);
23523 e
= make_number (SCHARS (object
) - 1);
23525 fast_find_string_pos (w
, XINT (b
), object
,
23526 &dpyinfo
->mouse_face_beg_col
,
23527 &dpyinfo
->mouse_face_beg_row
,
23528 &dpyinfo
->mouse_face_beg_x
,
23529 &dpyinfo
->mouse_face_beg_y
, 0);
23530 fast_find_string_pos (w
, XINT (e
), object
,
23531 &dpyinfo
->mouse_face_end_col
,
23532 &dpyinfo
->mouse_face_end_row
,
23533 &dpyinfo
->mouse_face_end_x
,
23534 &dpyinfo
->mouse_face_end_y
, 1);
23535 dpyinfo
->mouse_face_past_end
= 0;
23536 dpyinfo
->mouse_face_window
= window
;
23537 dpyinfo
->mouse_face_face_id
23538 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
23539 glyph
->face_id
, 1);
23540 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23541 cursor
= No_Cursor
;
23543 else if (STRINGP (object
) && NILP (mouse_face
))
23545 /* A string which doesn't have mouse-face, but
23546 the text ``under'' it might have. */
23547 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
23548 int start
= MATRIX_ROW_START_CHARPOS (r
);
23550 pos
= string_buffer_position (w
, object
, start
);
23552 mouse_face
= get_char_property_and_overlay (make_number (pos
),
23556 if (!NILP (mouse_face
) && !NILP (overlay
))
23558 Lisp_Object before
= Foverlay_start (overlay
);
23559 Lisp_Object after
= Foverlay_end (overlay
);
23562 /* Note that we might not be able to find position
23563 BEFORE in the glyph matrix if the overlay is
23564 entirely covered by a `display' property. In
23565 this case, we overshoot. So let's stop in
23566 the glyph matrix before glyphs for OBJECT. */
23567 fast_find_position (w
, XFASTINT (before
),
23568 &dpyinfo
->mouse_face_beg_col
,
23569 &dpyinfo
->mouse_face_beg_row
,
23570 &dpyinfo
->mouse_face_beg_x
,
23571 &dpyinfo
->mouse_face_beg_y
,
23574 dpyinfo
->mouse_face_past_end
23575 = !fast_find_position (w
, XFASTINT (after
),
23576 &dpyinfo
->mouse_face_end_col
,
23577 &dpyinfo
->mouse_face_end_row
,
23578 &dpyinfo
->mouse_face_end_x
,
23579 &dpyinfo
->mouse_face_end_y
,
23581 dpyinfo
->mouse_face_window
= window
;
23582 dpyinfo
->mouse_face_face_id
23583 = face_at_buffer_position (w
, pos
, 0, 0,
23585 !dpyinfo
->mouse_face_hidden
);
23587 /* Display it as active. */
23588 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23589 cursor
= No_Cursor
;
23596 /* Look for a `help-echo' property. */
23597 if (NILP (help_echo_string
)) {
23598 Lisp_Object help
, overlay
;
23600 /* Check overlays first. */
23601 help
= overlay
= Qnil
;
23602 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
23604 overlay
= overlay_vec
[i
];
23605 help
= Foverlay_get (overlay
, Qhelp_echo
);
23610 help_echo_string
= help
;
23611 help_echo_window
= window
;
23612 help_echo_object
= overlay
;
23613 help_echo_pos
= pos
;
23617 Lisp_Object object
= glyph
->object
;
23618 int charpos
= glyph
->charpos
;
23620 /* Try text properties. */
23621 if (STRINGP (object
)
23623 && charpos
< SCHARS (object
))
23625 help
= Fget_text_property (make_number (charpos
),
23626 Qhelp_echo
, object
);
23629 /* If the string itself doesn't specify a help-echo,
23630 see if the buffer text ``under'' it does. */
23631 struct glyph_row
*r
23632 = MATRIX_ROW (w
->current_matrix
, vpos
);
23633 int start
= MATRIX_ROW_START_CHARPOS (r
);
23634 int pos
= string_buffer_position (w
, object
, start
);
23637 help
= Fget_char_property (make_number (pos
),
23638 Qhelp_echo
, w
->buffer
);
23642 object
= w
->buffer
;
23647 else if (BUFFERP (object
)
23650 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
23655 help_echo_string
= help
;
23656 help_echo_window
= window
;
23657 help_echo_object
= object
;
23658 help_echo_pos
= charpos
;
23663 /* Look for a `pointer' property. */
23664 if (NILP (pointer
))
23666 /* Check overlays first. */
23667 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
23668 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
23670 if (NILP (pointer
))
23672 Lisp_Object object
= glyph
->object
;
23673 int charpos
= glyph
->charpos
;
23675 /* Try text properties. */
23676 if (STRINGP (object
)
23678 && charpos
< SCHARS (object
))
23680 pointer
= Fget_text_property (make_number (charpos
),
23682 if (NILP (pointer
))
23684 /* If the string itself doesn't specify a pointer,
23685 see if the buffer text ``under'' it does. */
23686 struct glyph_row
*r
23687 = MATRIX_ROW (w
->current_matrix
, vpos
);
23688 int start
= MATRIX_ROW_START_CHARPOS (r
);
23689 int pos
= string_buffer_position (w
, object
, start
);
23691 pointer
= Fget_char_property (make_number (pos
),
23692 Qpointer
, w
->buffer
);
23695 else if (BUFFERP (object
)
23698 pointer
= Fget_text_property (make_number (charpos
),
23705 current_buffer
= obuf
;
23710 define_frame_cursor1 (f
, cursor
, pointer
);
23715 Clear any mouse-face on window W. This function is part of the
23716 redisplay interface, and is called from try_window_id and similar
23717 functions to ensure the mouse-highlight is off. */
23720 x_clear_window_mouse_face (w
)
23723 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
23724 Lisp_Object window
;
23727 XSETWINDOW (window
, w
);
23728 if (EQ (window
, dpyinfo
->mouse_face_window
))
23729 clear_mouse_face (dpyinfo
);
23735 Just discard the mouse face information for frame F, if any.
23736 This is used when the size of F is changed. */
23739 cancel_mouse_face (f
)
23742 Lisp_Object window
;
23743 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23745 window
= dpyinfo
->mouse_face_window
;
23746 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
23748 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
23749 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
23750 dpyinfo
->mouse_face_window
= Qnil
;
23755 #endif /* HAVE_WINDOW_SYSTEM */
23758 /***********************************************************************
23760 ***********************************************************************/
23762 #ifdef HAVE_WINDOW_SYSTEM
23764 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
23765 which intersects rectangle R. R is in window-relative coordinates. */
23768 expose_area (w
, row
, r
, area
)
23770 struct glyph_row
*row
;
23772 enum glyph_row_area area
;
23774 struct glyph
*first
= row
->glyphs
[area
];
23775 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
23776 struct glyph
*last
;
23777 int first_x
, start_x
, x
;
23779 if (area
== TEXT_AREA
&& row
->fill_line_p
)
23780 /* If row extends face to end of line write the whole line. */
23781 draw_glyphs (w
, 0, row
, area
,
23782 0, row
->used
[area
],
23783 DRAW_NORMAL_TEXT
, 0);
23786 /* Set START_X to the window-relative start position for drawing glyphs of
23787 AREA. The first glyph of the text area can be partially visible.
23788 The first glyphs of other areas cannot. */
23789 start_x
= window_box_left_offset (w
, area
);
23791 if (area
== TEXT_AREA
)
23794 /* Find the first glyph that must be redrawn. */
23796 && x
+ first
->pixel_width
< r
->x
)
23798 x
+= first
->pixel_width
;
23802 /* Find the last one. */
23806 && x
< r
->x
+ r
->width
)
23808 x
+= last
->pixel_width
;
23814 draw_glyphs (w
, first_x
- start_x
, row
, area
,
23815 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
23816 DRAW_NORMAL_TEXT
, 0);
23821 /* Redraw the parts of the glyph row ROW on window W intersecting
23822 rectangle R. R is in window-relative coordinates. Value is
23823 non-zero if mouse-face was overwritten. */
23826 expose_line (w
, row
, r
)
23828 struct glyph_row
*row
;
23831 xassert (row
->enabled_p
);
23833 if (row
->mode_line_p
|| w
->pseudo_window_p
)
23834 draw_glyphs (w
, 0, row
, TEXT_AREA
,
23835 0, row
->used
[TEXT_AREA
],
23836 DRAW_NORMAL_TEXT
, 0);
23839 if (row
->used
[LEFT_MARGIN_AREA
])
23840 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
23841 if (row
->used
[TEXT_AREA
])
23842 expose_area (w
, row
, r
, TEXT_AREA
);
23843 if (row
->used
[RIGHT_MARGIN_AREA
])
23844 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
23845 draw_row_fringe_bitmaps (w
, row
);
23848 return row
->mouse_face_p
;
23852 /* Redraw those parts of glyphs rows during expose event handling that
23853 overlap other rows. Redrawing of an exposed line writes over parts
23854 of lines overlapping that exposed line; this function fixes that.
23856 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
23857 row in W's current matrix that is exposed and overlaps other rows.
23858 LAST_OVERLAPPING_ROW is the last such row. */
23861 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
, r
)
23863 struct glyph_row
*first_overlapping_row
;
23864 struct glyph_row
*last_overlapping_row
;
23867 struct glyph_row
*row
;
23869 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
23870 if (row
->overlapping_p
)
23872 xassert (row
->enabled_p
&& !row
->mode_line_p
);
23875 if (row
->used
[LEFT_MARGIN_AREA
])
23876 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
23878 if (row
->used
[TEXT_AREA
])
23879 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
23881 if (row
->used
[RIGHT_MARGIN_AREA
])
23882 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
23888 /* Return non-zero if W's cursor intersects rectangle R. */
23891 phys_cursor_in_rect_p (w
, r
)
23895 XRectangle cr
, result
;
23896 struct glyph
*cursor_glyph
;
23897 struct glyph_row
*row
;
23899 if (w
->phys_cursor
.vpos
>= 0
23900 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
23901 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
23903 && row
->cursor_in_fringe_p
)
23905 /* Cursor is in the fringe. */
23906 cr
.x
= window_box_right_offset (w
,
23907 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
23908 ? RIGHT_MARGIN_AREA
23911 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
23912 cr
.height
= row
->height
;
23913 return x_intersect_rectangles (&cr
, r
, &result
);
23916 cursor_glyph
= get_phys_cursor_glyph (w
);
23919 /* r is relative to W's box, but w->phys_cursor.x is relative
23920 to left edge of W's TEXT area. Adjust it. */
23921 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
23922 cr
.y
= w
->phys_cursor
.y
;
23923 cr
.width
= cursor_glyph
->pixel_width
;
23924 cr
.height
= w
->phys_cursor_height
;
23925 /* ++KFS: W32 version used W32-specific IntersectRect here, but
23926 I assume the effect is the same -- and this is portable. */
23927 return x_intersect_rectangles (&cr
, r
, &result
);
23929 /* If we don't understand the format, pretend we're not in the hot-spot. */
23935 Draw a vertical window border to the right of window W if W doesn't
23936 have vertical scroll bars. */
23939 x_draw_vertical_border (w
)
23942 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23944 /* We could do better, if we knew what type of scroll-bar the adjacent
23945 windows (on either side) have... But we don't :-(
23946 However, I think this works ok. ++KFS 2003-04-25 */
23948 /* Redraw borders between horizontally adjacent windows. Don't
23949 do it for frames with vertical scroll bars because either the
23950 right scroll bar of a window, or the left scroll bar of its
23951 neighbor will suffice as a border. */
23952 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
23955 if (!WINDOW_RIGHTMOST_P (w
)
23956 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
23958 int x0
, x1
, y0
, y1
;
23960 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
23963 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
23966 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
23968 else if (!WINDOW_LEFTMOST_P (w
)
23969 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
23971 int x0
, x1
, y0
, y1
;
23973 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
23976 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
23979 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
23984 /* Redraw the part of window W intersection rectangle FR. Pixel
23985 coordinates in FR are frame-relative. Call this function with
23986 input blocked. Value is non-zero if the exposure overwrites
23990 expose_window (w
, fr
)
23994 struct frame
*f
= XFRAME (w
->frame
);
23996 int mouse_face_overwritten_p
= 0;
23998 /* If window is not yet fully initialized, do nothing. This can
23999 happen when toolkit scroll bars are used and a window is split.
24000 Reconfiguring the scroll bar will generate an expose for a newly
24002 if (w
->current_matrix
== NULL
)
24005 /* When we're currently updating the window, display and current
24006 matrix usually don't agree. Arrange for a thorough display
24008 if (w
== updated_window
)
24010 SET_FRAME_GARBAGED (f
);
24014 /* Frame-relative pixel rectangle of W. */
24015 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
24016 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
24017 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
24018 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
24020 if (x_intersect_rectangles (fr
, &wr
, &r
))
24022 int yb
= window_text_bottom_y (w
);
24023 struct glyph_row
*row
;
24024 int cursor_cleared_p
;
24025 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
24027 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
24028 r
.x
, r
.y
, r
.width
, r
.height
));
24030 /* Convert to window coordinates. */
24031 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
24032 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
24034 /* Turn off the cursor. */
24035 if (!w
->pseudo_window_p
24036 && phys_cursor_in_rect_p (w
, &r
))
24038 x_clear_cursor (w
);
24039 cursor_cleared_p
= 1;
24042 cursor_cleared_p
= 0;
24044 /* Update lines intersecting rectangle R. */
24045 first_overlapping_row
= last_overlapping_row
= NULL
;
24046 for (row
= w
->current_matrix
->rows
;
24051 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
24053 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
24054 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
24055 || (r
.y
>= y0
&& r
.y
< y1
)
24056 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
24058 /* A header line may be overlapping, but there is no need
24059 to fix overlapping areas for them. KFS 2005-02-12 */
24060 if (row
->overlapping_p
&& !row
->mode_line_p
)
24062 if (first_overlapping_row
== NULL
)
24063 first_overlapping_row
= row
;
24064 last_overlapping_row
= row
;
24068 if (expose_line (w
, row
, &r
))
24069 mouse_face_overwritten_p
= 1;
24072 else if (row
->overlapping_p
)
24074 /* We must redraw a row overlapping the exposed area. */
24076 ? y0
+ row
->phys_height
> r
.y
24077 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
24079 if (first_overlapping_row
== NULL
)
24080 first_overlapping_row
= row
;
24081 last_overlapping_row
= row
;
24089 /* Display the mode line if there is one. */
24090 if (WINDOW_WANTS_MODELINE_P (w
)
24091 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
24093 && row
->y
< r
.y
+ r
.height
)
24095 if (expose_line (w
, row
, &r
))
24096 mouse_face_overwritten_p
= 1;
24099 if (!w
->pseudo_window_p
)
24101 /* Fix the display of overlapping rows. */
24102 if (first_overlapping_row
)
24103 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
24106 /* Draw border between windows. */
24107 x_draw_vertical_border (w
);
24109 /* Turn the cursor on again. */
24110 if (cursor_cleared_p
)
24111 update_window_cursor (w
, 1);
24115 return mouse_face_overwritten_p
;
24120 /* Redraw (parts) of all windows in the window tree rooted at W that
24121 intersect R. R contains frame pixel coordinates. Value is
24122 non-zero if the exposure overwrites mouse-face. */
24125 expose_window_tree (w
, r
)
24129 struct frame
*f
= XFRAME (w
->frame
);
24130 int mouse_face_overwritten_p
= 0;
24132 while (w
&& !FRAME_GARBAGED_P (f
))
24134 if (!NILP (w
->hchild
))
24135 mouse_face_overwritten_p
24136 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
24137 else if (!NILP (w
->vchild
))
24138 mouse_face_overwritten_p
24139 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
24141 mouse_face_overwritten_p
|= expose_window (w
, r
);
24143 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
24146 return mouse_face_overwritten_p
;
24151 Redisplay an exposed area of frame F. X and Y are the upper-left
24152 corner of the exposed rectangle. W and H are width and height of
24153 the exposed area. All are pixel values. W or H zero means redraw
24154 the entire frame. */
24157 expose_frame (f
, x
, y
, w
, h
)
24162 int mouse_face_overwritten_p
= 0;
24164 TRACE ((stderr
, "expose_frame "));
24166 /* No need to redraw if frame will be redrawn soon. */
24167 if (FRAME_GARBAGED_P (f
))
24169 TRACE ((stderr
, " garbaged\n"));
24173 /* If basic faces haven't been realized yet, there is no point in
24174 trying to redraw anything. This can happen when we get an expose
24175 event while Emacs is starting, e.g. by moving another window. */
24176 if (FRAME_FACE_CACHE (f
) == NULL
24177 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
24179 TRACE ((stderr
, " no faces\n"));
24183 if (w
== 0 || h
== 0)
24186 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
24187 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
24197 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
24198 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
24200 if (WINDOWP (f
->tool_bar_window
))
24201 mouse_face_overwritten_p
24202 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
24204 #ifdef HAVE_X_WINDOWS
24206 #ifndef USE_X_TOOLKIT
24207 if (WINDOWP (f
->menu_bar_window
))
24208 mouse_face_overwritten_p
24209 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
24210 #endif /* not USE_X_TOOLKIT */
24214 /* Some window managers support a focus-follows-mouse style with
24215 delayed raising of frames. Imagine a partially obscured frame,
24216 and moving the mouse into partially obscured mouse-face on that
24217 frame. The visible part of the mouse-face will be highlighted,
24218 then the WM raises the obscured frame. With at least one WM, KDE
24219 2.1, Emacs is not getting any event for the raising of the frame
24220 (even tried with SubstructureRedirectMask), only Expose events.
24221 These expose events will draw text normally, i.e. not
24222 highlighted. Which means we must redo the highlight here.
24223 Subsume it under ``we love X''. --gerd 2001-08-15 */
24224 /* Included in Windows version because Windows most likely does not
24225 do the right thing if any third party tool offers
24226 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
24227 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
24229 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24230 if (f
== dpyinfo
->mouse_face_mouse_frame
)
24232 int x
= dpyinfo
->mouse_face_mouse_x
;
24233 int y
= dpyinfo
->mouse_face_mouse_y
;
24234 clear_mouse_face (dpyinfo
);
24235 note_mouse_highlight (f
, x
, y
);
24242 Determine the intersection of two rectangles R1 and R2. Return
24243 the intersection in *RESULT. Value is non-zero if RESULT is not
24247 x_intersect_rectangles (r1
, r2
, result
)
24248 XRectangle
*r1
, *r2
, *result
;
24250 XRectangle
*left
, *right
;
24251 XRectangle
*upper
, *lower
;
24252 int intersection_p
= 0;
24254 /* Rearrange so that R1 is the left-most rectangle. */
24256 left
= r1
, right
= r2
;
24258 left
= r2
, right
= r1
;
24260 /* X0 of the intersection is right.x0, if this is inside R1,
24261 otherwise there is no intersection. */
24262 if (right
->x
<= left
->x
+ left
->width
)
24264 result
->x
= right
->x
;
24266 /* The right end of the intersection is the minimum of the
24267 the right ends of left and right. */
24268 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
24271 /* Same game for Y. */
24273 upper
= r1
, lower
= r2
;
24275 upper
= r2
, lower
= r1
;
24277 /* The upper end of the intersection is lower.y0, if this is inside
24278 of upper. Otherwise, there is no intersection. */
24279 if (lower
->y
<= upper
->y
+ upper
->height
)
24281 result
->y
= lower
->y
;
24283 /* The lower end of the intersection is the minimum of the lower
24284 ends of upper and lower. */
24285 result
->height
= (min (lower
->y
+ lower
->height
,
24286 upper
->y
+ upper
->height
)
24288 intersection_p
= 1;
24292 return intersection_p
;
24295 #endif /* HAVE_WINDOW_SYSTEM */
24298 /***********************************************************************
24300 ***********************************************************************/
24305 Vwith_echo_area_save_vector
= Qnil
;
24306 staticpro (&Vwith_echo_area_save_vector
);
24308 Vmessage_stack
= Qnil
;
24309 staticpro (&Vmessage_stack
);
24311 Qinhibit_redisplay
= intern ("inhibit-redisplay");
24312 staticpro (&Qinhibit_redisplay
);
24314 message_dolog_marker1
= Fmake_marker ();
24315 staticpro (&message_dolog_marker1
);
24316 message_dolog_marker2
= Fmake_marker ();
24317 staticpro (&message_dolog_marker2
);
24318 message_dolog_marker3
= Fmake_marker ();
24319 staticpro (&message_dolog_marker3
);
24322 defsubr (&Sdump_frame_glyph_matrix
);
24323 defsubr (&Sdump_glyph_matrix
);
24324 defsubr (&Sdump_glyph_row
);
24325 defsubr (&Sdump_tool_bar_row
);
24326 defsubr (&Strace_redisplay
);
24327 defsubr (&Strace_to_stderr
);
24329 #ifdef HAVE_WINDOW_SYSTEM
24330 defsubr (&Stool_bar_lines_needed
);
24331 defsubr (&Slookup_image_map
);
24333 defsubr (&Sformat_mode_line
);
24334 defsubr (&Sinvisible_p
);
24336 staticpro (&Qmenu_bar_update_hook
);
24337 Qmenu_bar_update_hook
= intern ("menu-bar-update-hook");
24339 staticpro (&Qoverriding_terminal_local_map
);
24340 Qoverriding_terminal_local_map
= intern ("overriding-terminal-local-map");
24342 staticpro (&Qoverriding_local_map
);
24343 Qoverriding_local_map
= intern ("overriding-local-map");
24345 staticpro (&Qwindow_scroll_functions
);
24346 Qwindow_scroll_functions
= intern ("window-scroll-functions");
24348 staticpro (&Qwindow_text_change_functions
);
24349 Qwindow_text_change_functions
= intern ("window-text-change-functions");
24351 staticpro (&Qredisplay_end_trigger_functions
);
24352 Qredisplay_end_trigger_functions
= intern ("redisplay-end-trigger-functions");
24354 staticpro (&Qinhibit_point_motion_hooks
);
24355 Qinhibit_point_motion_hooks
= intern ("inhibit-point-motion-hooks");
24357 Qeval
= intern ("eval");
24358 staticpro (&Qeval
);
24360 QCdata
= intern (":data");
24361 staticpro (&QCdata
);
24362 Qdisplay
= intern ("display");
24363 staticpro (&Qdisplay
);
24364 Qspace_width
= intern ("space-width");
24365 staticpro (&Qspace_width
);
24366 Qraise
= intern ("raise");
24367 staticpro (&Qraise
);
24368 Qslice
= intern ("slice");
24369 staticpro (&Qslice
);
24370 Qspace
= intern ("space");
24371 staticpro (&Qspace
);
24372 Qmargin
= intern ("margin");
24373 staticpro (&Qmargin
);
24374 Qpointer
= intern ("pointer");
24375 staticpro (&Qpointer
);
24376 Qleft_margin
= intern ("left-margin");
24377 staticpro (&Qleft_margin
);
24378 Qright_margin
= intern ("right-margin");
24379 staticpro (&Qright_margin
);
24380 Qcenter
= intern ("center");
24381 staticpro (&Qcenter
);
24382 Qline_height
= intern ("line-height");
24383 staticpro (&Qline_height
);
24384 QCalign_to
= intern (":align-to");
24385 staticpro (&QCalign_to
);
24386 QCrelative_width
= intern (":relative-width");
24387 staticpro (&QCrelative_width
);
24388 QCrelative_height
= intern (":relative-height");
24389 staticpro (&QCrelative_height
);
24390 QCeval
= intern (":eval");
24391 staticpro (&QCeval
);
24392 QCpropertize
= intern (":propertize");
24393 staticpro (&QCpropertize
);
24394 QCfile
= intern (":file");
24395 staticpro (&QCfile
);
24396 Qfontified
= intern ("fontified");
24397 staticpro (&Qfontified
);
24398 Qfontification_functions
= intern ("fontification-functions");
24399 staticpro (&Qfontification_functions
);
24400 Qtrailing_whitespace
= intern ("trailing-whitespace");
24401 staticpro (&Qtrailing_whitespace
);
24402 Qescape_glyph
= intern ("escape-glyph");
24403 staticpro (&Qescape_glyph
);
24404 Qnobreak_space
= intern ("nobreak-space");
24405 staticpro (&Qnobreak_space
);
24406 Qimage
= intern ("image");
24407 staticpro (&Qimage
);
24408 QCmap
= intern (":map");
24409 staticpro (&QCmap
);
24410 QCpointer
= intern (":pointer");
24411 staticpro (&QCpointer
);
24412 Qrect
= intern ("rect");
24413 staticpro (&Qrect
);
24414 Qcircle
= intern ("circle");
24415 staticpro (&Qcircle
);
24416 Qpoly
= intern ("poly");
24417 staticpro (&Qpoly
);
24418 Qmessage_truncate_lines
= intern ("message-truncate-lines");
24419 staticpro (&Qmessage_truncate_lines
);
24420 Qgrow_only
= intern ("grow-only");
24421 staticpro (&Qgrow_only
);
24422 Qinhibit_menubar_update
= intern ("inhibit-menubar-update");
24423 staticpro (&Qinhibit_menubar_update
);
24424 Qinhibit_eval_during_redisplay
= intern ("inhibit-eval-during-redisplay");
24425 staticpro (&Qinhibit_eval_during_redisplay
);
24426 Qposition
= intern ("position");
24427 staticpro (&Qposition
);
24428 Qbuffer_position
= intern ("buffer-position");
24429 staticpro (&Qbuffer_position
);
24430 Qobject
= intern ("object");
24431 staticpro (&Qobject
);
24432 Qbar
= intern ("bar");
24434 Qhbar
= intern ("hbar");
24435 staticpro (&Qhbar
);
24436 Qbox
= intern ("box");
24438 Qhollow
= intern ("hollow");
24439 staticpro (&Qhollow
);
24440 Qhand
= intern ("hand");
24441 staticpro (&Qhand
);
24442 Qarrow
= intern ("arrow");
24443 staticpro (&Qarrow
);
24444 Qtext
= intern ("text");
24445 staticpro (&Qtext
);
24446 Qrisky_local_variable
= intern ("risky-local-variable");
24447 staticpro (&Qrisky_local_variable
);
24448 Qinhibit_free_realized_faces
= intern ("inhibit-free-realized-faces");
24449 staticpro (&Qinhibit_free_realized_faces
);
24451 list_of_error
= Fcons (Fcons (intern ("error"),
24452 Fcons (intern ("void-variable"), Qnil
)),
24454 staticpro (&list_of_error
);
24456 Qlast_arrow_position
= intern ("last-arrow-position");
24457 staticpro (&Qlast_arrow_position
);
24458 Qlast_arrow_string
= intern ("last-arrow-string");
24459 staticpro (&Qlast_arrow_string
);
24461 Qoverlay_arrow_string
= intern ("overlay-arrow-string");
24462 staticpro (&Qoverlay_arrow_string
);
24463 Qoverlay_arrow_bitmap
= intern ("overlay-arrow-bitmap");
24464 staticpro (&Qoverlay_arrow_bitmap
);
24466 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
24467 staticpro (&echo_buffer
[0]);
24468 staticpro (&echo_buffer
[1]);
24470 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
24471 staticpro (&echo_area_buffer
[0]);
24472 staticpro (&echo_area_buffer
[1]);
24474 Vmessages_buffer_name
= build_string ("*Messages*");
24475 staticpro (&Vmessages_buffer_name
);
24477 mode_line_proptrans_alist
= Qnil
;
24478 staticpro (&mode_line_proptrans_alist
);
24479 mode_line_string_list
= Qnil
;
24480 staticpro (&mode_line_string_list
);
24481 mode_line_string_face
= Qnil
;
24482 staticpro (&mode_line_string_face
);
24483 mode_line_string_face_prop
= Qnil
;
24484 staticpro (&mode_line_string_face_prop
);
24485 Vmode_line_unwind_vector
= Qnil
;
24486 staticpro (&Vmode_line_unwind_vector
);
24488 help_echo_string
= Qnil
;
24489 staticpro (&help_echo_string
);
24490 help_echo_object
= Qnil
;
24491 staticpro (&help_echo_object
);
24492 help_echo_window
= Qnil
;
24493 staticpro (&help_echo_window
);
24494 previous_help_echo_string
= Qnil
;
24495 staticpro (&previous_help_echo_string
);
24496 help_echo_pos
= -1;
24498 #ifdef HAVE_WINDOW_SYSTEM
24499 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
24500 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
24501 For example, if a block cursor is over a tab, it will be drawn as
24502 wide as that tab on the display. */);
24503 x_stretch_cursor_p
= 0;
24506 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
24507 doc
: /* *Non-nil means highlight trailing whitespace.
24508 The face used for trailing whitespace is `trailing-whitespace'. */);
24509 Vshow_trailing_whitespace
= Qnil
;
24511 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
24512 doc
: /* *Control highlighting of nobreak space and soft hyphen.
24513 A value of t means highlight the character itself (for nobreak space,
24514 use face `nobreak-space').
24515 A value of nil means no highlighting.
24516 Other values mean display the escape glyph followed by an ordinary
24517 space or ordinary hyphen. */);
24518 Vnobreak_char_display
= Qt
;
24520 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
24521 doc
: /* *The pointer shape to show in void text areas.
24522 A value of nil means to show the text pointer. Other options are `arrow',
24523 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
24524 Vvoid_text_area_pointer
= Qarrow
;
24526 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
24527 doc
: /* Non-nil means don't actually do any redisplay.
24528 This is used for internal purposes. */);
24529 Vinhibit_redisplay
= Qnil
;
24531 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
24532 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
24533 Vglobal_mode_string
= Qnil
;
24535 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
24536 doc
: /* Marker for where to display an arrow on top of the buffer text.
24537 This must be the beginning of a line in order to work.
24538 See also `overlay-arrow-string'. */);
24539 Voverlay_arrow_position
= Qnil
;
24541 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
24542 doc
: /* String to display as an arrow in non-window frames.
24543 See also `overlay-arrow-position'. */);
24544 Voverlay_arrow_string
= build_string ("=>");
24546 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
24547 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
24548 The symbols on this list are examined during redisplay to determine
24549 where to display overlay arrows. */);
24550 Voverlay_arrow_variable_list
24551 = Fcons (intern ("overlay-arrow-position"), Qnil
);
24553 DEFVAR_INT ("scroll-step", &scroll_step
,
24554 doc
: /* *The number of lines to try scrolling a window by when point moves out.
24555 If that fails to bring point back on frame, point is centered instead.
24556 If this is zero, point is always centered after it moves off frame.
24557 If you want scrolling to always be a line at a time, you should set
24558 `scroll-conservatively' to a large value rather than set this to 1. */);
24560 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
24561 doc
: /* *Scroll up to this many lines, to bring point back on screen.
24562 If point moves off-screen, redisplay will scroll by up to
24563 `scroll-conservatively' lines in order to bring point just barely
24564 onto the screen again. If that cannot be done, then redisplay
24565 recenters point as usual.
24567 A value of zero means always recenter point if it moves off screen. */);
24568 scroll_conservatively
= 0;
24570 DEFVAR_INT ("scroll-margin", &scroll_margin
,
24571 doc
: /* *Number of lines of margin at the top and bottom of a window.
24572 Recenter the window whenever point gets within this many lines
24573 of the top or bottom of the window. */);
24576 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
24577 doc
: /* Pixels per inch value for non-window system displays.
24578 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
24579 Vdisplay_pixels_per_inch
= make_float (72.0);
24582 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
24585 DEFVAR_BOOL ("truncate-partial-width-windows",
24586 &truncate_partial_width_windows
,
24587 doc
: /* *Non-nil means truncate lines in all windows less than full frame wide. */);
24588 truncate_partial_width_windows
= 1;
24590 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
24591 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
24592 Any other value means to use the appropriate face, `mode-line',
24593 `header-line', or `menu' respectively. */);
24594 mode_line_inverse_video
= 1;
24596 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
24597 doc
: /* *Maximum buffer size for which line number should be displayed.
24598 If the buffer is bigger than this, the line number does not appear
24599 in the mode line. A value of nil means no limit. */);
24600 Vline_number_display_limit
= Qnil
;
24602 DEFVAR_INT ("line-number-display-limit-width",
24603 &line_number_display_limit_width
,
24604 doc
: /* *Maximum line width (in characters) for line number display.
24605 If the average length of the lines near point is bigger than this, then the
24606 line number may be omitted from the mode line. */);
24607 line_number_display_limit_width
= 200;
24609 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
24610 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
24611 highlight_nonselected_windows
= 0;
24613 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
24614 doc
: /* Non-nil if more than one frame is visible on this display.
24615 Minibuffer-only frames don't count, but iconified frames do.
24616 This variable is not guaranteed to be accurate except while processing
24617 `frame-title-format' and `icon-title-format'. */);
24619 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
24620 doc
: /* Template for displaying the title bar of visible frames.
24621 \(Assuming the window manager supports this feature.)
24623 This variable has the same structure as `mode-line-format', except that
24624 the %c and %l constructs are ignored. It is used only on frames for
24625 which no explicit name has been set \(see `modify-frame-parameters'). */);
24627 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
24628 doc
: /* Template for displaying the title bar of an iconified frame.
24629 \(Assuming the window manager supports this feature.)
24630 This variable has the same structure as `mode-line-format' (which see),
24631 and is used only on frames for which no explicit name has been set
24632 \(see `modify-frame-parameters'). */);
24634 = Vframe_title_format
24635 = Fcons (intern ("multiple-frames"),
24636 Fcons (build_string ("%b"),
24637 Fcons (Fcons (empty_unibyte_string
,
24638 Fcons (intern ("invocation-name"),
24639 Fcons (build_string ("@"),
24640 Fcons (intern ("system-name"),
24644 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
24645 doc
: /* Maximum number of lines to keep in the message log buffer.
24646 If nil, disable message logging. If t, log messages but don't truncate
24647 the buffer when it becomes large. */);
24648 Vmessage_log_max
= make_number (100);
24650 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
24651 doc
: /* Functions called before redisplay, if window sizes have changed.
24652 The value should be a list of functions that take one argument.
24653 Just before redisplay, for each frame, if any of its windows have changed
24654 size since the last redisplay, or have been split or deleted,
24655 all the functions in the list are called, with the frame as argument. */);
24656 Vwindow_size_change_functions
= Qnil
;
24658 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
24659 doc
: /* List of functions to call before redisplaying a window with scrolling.
24660 Each function is called with two arguments, the window
24661 and its new display-start position. Note that the value of `window-end'
24662 is not valid when these functions are called. */);
24663 Vwindow_scroll_functions
= Qnil
;
24665 DEFVAR_LISP ("window-text-change-functions",
24666 &Vwindow_text_change_functions
,
24667 doc
: /* Functions to call in redisplay when text in the window might change. */);
24668 Vwindow_text_change_functions
= Qnil
;
24670 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
24671 doc
: /* Functions called when redisplay of a window reaches the end trigger.
24672 Each function is called with two arguments, the window and the end trigger value.
24673 See `set-window-redisplay-end-trigger'. */);
24674 Vredisplay_end_trigger_functions
= Qnil
;
24676 DEFVAR_LISP ("mouse-autoselect-window", &Vmouse_autoselect_window
,
24677 doc
: /* *Non-nil means autoselect window with mouse pointer.
24678 If nil, do not autoselect windows.
24679 A positive number means delay autoselection by that many seconds: a
24680 window is autoselected only after the mouse has remained in that
24681 window for the duration of the delay.
24682 A negative number has a similar effect, but causes windows to be
24683 autoselected only after the mouse has stopped moving. \(Because of
24684 the way Emacs compares mouse events, you will occasionally wait twice
24685 that time before the window gets selected.\)
24686 Any other value means to autoselect window instantaneously when the
24687 mouse pointer enters it.
24689 Autoselection selects the minibuffer only if it is active, and never
24690 unselects the minibuffer if it is active.
24692 When customizing this variable make sure that the actual value of
24693 `focus-follows-mouse' matches the behavior of your window manager. */);
24694 Vmouse_autoselect_window
= Qnil
;
24696 DEFVAR_LISP ("auto-resize-tool-bars", &Vauto_resize_tool_bars
,
24697 doc
: /* *Non-nil means automatically resize tool-bars.
24698 This dynamically changes the tool-bar's height to the minimum height
24699 that is needed to make all tool-bar items visible.
24700 If value is `grow-only', the tool-bar's height is only increased
24701 automatically; to decrease the tool-bar height, use \\[recenter]. */);
24702 Vauto_resize_tool_bars
= Qt
;
24704 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
24705 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
24706 auto_raise_tool_bar_buttons_p
= 1;
24708 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
24709 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
24710 make_cursor_line_fully_visible_p
= 1;
24712 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
24713 doc
: /* *Border below tool-bar in pixels.
24714 If an integer, use it as the height of the border.
24715 If it is one of `internal-border-width' or `border-width', use the
24716 value of the corresponding frame parameter.
24717 Otherwise, no border is added below the tool-bar. */);
24718 Vtool_bar_border
= Qinternal_border_width
;
24720 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
24721 doc
: /* *Margin around tool-bar buttons in pixels.
24722 If an integer, use that for both horizontal and vertical margins.
24723 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
24724 HORZ specifying the horizontal margin, and VERT specifying the
24725 vertical margin. */);
24726 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
24728 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
24729 doc
: /* *Relief thickness of tool-bar buttons. */);
24730 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
24732 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
24733 doc
: /* List of functions to call to fontify regions of text.
24734 Each function is called with one argument POS. Functions must
24735 fontify a region starting at POS in the current buffer, and give
24736 fontified regions the property `fontified'. */);
24737 Vfontification_functions
= Qnil
;
24738 Fmake_variable_buffer_local (Qfontification_functions
);
24740 DEFVAR_BOOL ("unibyte-display-via-language-environment",
24741 &unibyte_display_via_language_environment
,
24742 doc
: /* *Non-nil means display unibyte text according to language environment.
24743 Specifically this means that unibyte non-ASCII characters
24744 are displayed by converting them to the equivalent multibyte characters
24745 according to the current language environment. As a result, they are
24746 displayed according to the current fontset. */);
24747 unibyte_display_via_language_environment
= 0;
24749 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
24750 doc
: /* *Maximum height for resizing mini-windows.
24751 If a float, it specifies a fraction of the mini-window frame's height.
24752 If an integer, it specifies a number of lines. */);
24753 Vmax_mini_window_height
= make_float (0.25);
24755 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
24756 doc
: /* *How to resize mini-windows.
24757 A value of nil means don't automatically resize mini-windows.
24758 A value of t means resize them to fit the text displayed in them.
24759 A value of `grow-only', the default, means let mini-windows grow
24760 only, until their display becomes empty, at which point the windows
24761 go back to their normal size. */);
24762 Vresize_mini_windows
= Qgrow_only
;
24764 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
24765 doc
: /* Alist specifying how to blink the cursor off.
24766 Each element has the form (ON-STATE . OFF-STATE). Whenever the
24767 `cursor-type' frame-parameter or variable equals ON-STATE,
24768 comparing using `equal', Emacs uses OFF-STATE to specify
24769 how to blink it off. ON-STATE and OFF-STATE are values for
24770 the `cursor-type' frame parameter.
24772 If a frame's ON-STATE has no entry in this list,
24773 the frame's other specifications determine how to blink the cursor off. */);
24774 Vblink_cursor_alist
= Qnil
;
24776 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
24777 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
24778 automatic_hscrolling_p
= 1;
24779 Qauto_hscroll_mode
= intern ("auto-hscroll-mode");
24780 staticpro (&Qauto_hscroll_mode
);
24782 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
24783 doc
: /* *How many columns away from the window edge point is allowed to get
24784 before automatic hscrolling will horizontally scroll the window. */);
24785 hscroll_margin
= 5;
24787 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
24788 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
24789 When point is less than `hscroll-margin' columns from the window
24790 edge, automatic hscrolling will scroll the window by the amount of columns
24791 determined by this variable. If its value is a positive integer, scroll that
24792 many columns. If it's a positive floating-point number, it specifies the
24793 fraction of the window's width to scroll. If it's nil or zero, point will be
24794 centered horizontally after the scroll. Any other value, including negative
24795 numbers, are treated as if the value were zero.
24797 Automatic hscrolling always moves point outside the scroll margin, so if
24798 point was more than scroll step columns inside the margin, the window will
24799 scroll more than the value given by the scroll step.
24801 Note that the lower bound for automatic hscrolling specified by `scroll-left'
24802 and `scroll-right' overrides this variable's effect. */);
24803 Vhscroll_step
= make_number (0);
24805 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
24806 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
24807 Bind this around calls to `message' to let it take effect. */);
24808 message_truncate_lines
= 0;
24810 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
24811 doc
: /* Normal hook run to update the menu bar definitions.
24812 Redisplay runs this hook before it redisplays the menu bar.
24813 This is used to update submenus such as Buffers,
24814 whose contents depend on various data. */);
24815 Vmenu_bar_update_hook
= Qnil
;
24817 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
24818 doc
: /* Frame for which we are updating a menu.
24819 The enable predicate for a menu binding should check this variable. */);
24820 Vmenu_updating_frame
= Qnil
;
24822 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
24823 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
24824 inhibit_menubar_update
= 0;
24826 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
24827 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
24828 inhibit_eval_during_redisplay
= 0;
24830 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
24831 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
24832 inhibit_free_realized_faces
= 0;
24835 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
24836 doc
: /* Inhibit try_window_id display optimization. */);
24837 inhibit_try_window_id
= 0;
24839 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
24840 doc
: /* Inhibit try_window_reusing display optimization. */);
24841 inhibit_try_window_reusing
= 0;
24843 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
24844 doc
: /* Inhibit try_cursor_movement display optimization. */);
24845 inhibit_try_cursor_movement
= 0;
24846 #endif /* GLYPH_DEBUG */
24848 DEFVAR_INT ("overline-margin", &overline_margin
,
24849 doc
: /* *Space between overline and text, in pixels.
24850 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
24851 margin to the caracter height. */);
24852 overline_margin
= 2;
24856 /* Initialize this module when Emacs starts. */
24861 Lisp_Object root_window
;
24862 struct window
*mini_w
;
24864 current_header_line_height
= current_mode_line_height
= -1;
24866 CHARPOS (this_line_start_pos
) = 0;
24868 mini_w
= XWINDOW (minibuf_window
);
24869 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
24871 if (!noninteractive
)
24873 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
24876 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
24877 set_window_height (root_window
,
24878 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
24880 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
24881 set_window_height (minibuf_window
, 1, 0);
24883 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
24884 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
24886 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
24887 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
24888 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
24890 /* The default ellipsis glyphs `...'. */
24891 for (i
= 0; i
< 3; ++i
)
24892 default_invis_vector
[i
] = make_number ('.');
24896 /* Allocate the buffer for frame titles.
24897 Also used for `format-mode-line'. */
24899 mode_line_noprop_buf
= (char *) xmalloc (size
);
24900 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
24901 mode_line_noprop_ptr
= mode_line_noprop_buf
;
24902 mode_line_target
= MODE_LINE_DISPLAY
;
24905 help_echo_showing_p
= 0;
24909 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
24910 (do not change this comment) */